WordPress at Your Fingertips
function is not described

ParagonIE_Sodium_Compat::crypto_aead_xchacha20poly1305_ietf_decrypt() public WP 1.0

Authenticated Encryption with Associated Data: Decryption

Algorithm:

XChaCha20-Poly1305

This mode uses a 64-bit random nonce with a 64-bit counter. IETF mode uses a 96-bit random nonce with a 32-bit counter.

{} It's a method of the class: ParagonIE_Sodium_Compat{}

No Hooks.

Return

String|true|false. The original plaintext message

Usage

$result = ParagonIE_Sodium_Compat::crypto_aead_xchacha20poly1305_ietf_decrypt(;

Code of ParagonIE_Sodium_Compat::crypto_aead_xchacha20poly1305_ietf_decrypt() WP 5.8.2

public static function crypto_aead_xchacha20poly1305_ietf_decrypt(
    $ciphertext = '',
    $assocData = '',
    $nonce = '',
    $key = '',
    $dontFallback = false
) {
    /* Type checks: */
    ParagonIE_Sodium_Core_Util::declareScalarType($ciphertext, 'string', 1);
    if (!is_null($assocData)) {
        ParagonIE_Sodium_Core_Util::declareScalarType($assocData, 'string', 2);
    } else {
        $assocData = '';
    }
    ParagonIE_Sodium_Core_Util::declareScalarType($nonce, 'string', 3);
    ParagonIE_Sodium_Core_Util::declareScalarType($key, 'string', 4);

    /* Input validation: */
    if (ParagonIE_Sodium_Core_Util::strlen($nonce) !== self::CRYPTO_AEAD_XCHACHA20POLY1305_IETF_NPUBBYTES) {
        throw new SodiumException('Nonce must be CRYPTO_AEAD_XCHACHA20POLY1305_IETF_NPUBBYTES long');
    }
    if (ParagonIE_Sodium_Core_Util::strlen($key) !== self::CRYPTO_AEAD_XCHACHA20POLY1305_IETF_KEYBYTES) {
        throw new SodiumException('Key must be CRYPTO_AEAD_XCHACHA20POLY1305_IETF_KEYBYTES long');
    }
    if (ParagonIE_Sodium_Core_Util::strlen($ciphertext) < self::CRYPTO_AEAD_XCHACHA20POLY1305_IETF_ABYTES) {
        throw new SodiumException('Message must be at least CRYPTO_AEAD_XCHACHA20POLY1305_IETF_ABYTES long');
    }
    if (self::useNewSodiumAPI() && !$dontFallback) {
        if (is_callable('sodium_crypto_aead_xchacha20poly1305_ietf_decrypt')) {
            return sodium_crypto_aead_xchacha20poly1305_ietf_decrypt(
                $ciphertext,
                $assocData,
                $nonce,
                $key
            );
        }
    }

    if (PHP_INT_SIZE === 4) {
        return ParagonIE_Sodium_Crypto32::aead_xchacha20poly1305_ietf_decrypt(
            $ciphertext,
            $assocData,
            $nonce,
            $key
        );
    }
    return ParagonIE_Sodium_Crypto::aead_xchacha20poly1305_ietf_decrypt(
        $ciphertext,
        $assocData,
        $nonce,
        $key
    );
}