ParagonIE_Sodium_Compat::crypto_secretbox_xchacha20poly1305_open

Advertisement

Summery Summery

Decrypts a message previously encrypted with crypto_secretbox_xchacha20poly1305().

Syntax Syntax

ParagonIE_Sodium_Compat::crypto_secretbox_xchacha20poly1305_open( string $ciphertext, string $nonce, string $key )

Parameters Parameters

$ciphertext

(string) (Required) Ciphertext with Poly1305 MAC

$nonce

(string) (Required) A Number to be used Once; must be 24 bytes

$key

(string) (Required) Symmetric encryption key

Return Return

(string) Original plaintext message

Source Source

File: wp-includes/sodium_compat/src/Compat.php

    public static function crypto_secretbox_xchacha20poly1305_open($ciphertext, $nonce, $key)
    {
        /* Type checks: */
        ParagonIE_Sodium_Core_Util::declareScalarType($ciphertext, 'string', 1);
        ParagonIE_Sodium_Core_Util::declareScalarType($nonce, 'string', 2);
        ParagonIE_Sodium_Core_Util::declareScalarType($key, 'string', 3);

        /* Input validation: */
        if (ParagonIE_Sodium_Core_Util::strlen($nonce) !== self::CRYPTO_SECRETBOX_NONCEBYTES) {
            throw new SodiumException('Argument 2 must be CRYPTO_SECRETBOX_NONCEBYTES long.');
        }
        if (ParagonIE_Sodium_Core_Util::strlen($key) !== self::CRYPTO_SECRETBOX_KEYBYTES) {
            throw new SodiumException('Argument 3 must be CRYPTO_SECRETBOX_KEYBYTES long.');
        }

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

Advertisement

Advertisement

Leave a Reply

This site uses Akismet to reduce spam. Learn how your comment data is processed.