ParagonIE_Sodium_Compat::crypto_aead_chacha20poly1305_ietf_decrypt( string $ciphertext = '', string $assocData = '', string $nonce = '', string $key = '' ): string

Description

Compatibility

Present in every tracked release (6.7.7 to 7.1.0), and compiles on PHP 7.4 through 8.6-dev.

Parameters

$ciphertextstringoptional

Encrypted message (with Poly1305 MAC appended)Default: ''

$assocDatastringoptional

Authenticated Associated Data (unencrypted)Default: ''

$noncestringoptional

Number to be used only Once; must be 12 bytesDefault: ''

$keystringoptional

Encryption keyDefault: ''

Return value

string

The original plaintext message

Performance profile

How much work a call to ParagonIE_Sodium_Compat::crypto_aead_chacha20poly1305_ietf_decrypt() does, and what it touches: the algorithmic scaling, the Zend instruction count per call across PHP versions, the hooks it hands control to, and the core code that calls it. Measured from the compiled opcodes, not a stopwatch, so every number is identical on any machine running the same PHP version, and every function in core is ranked by cost.

Cost class

Trivial

Touches nothing outside its own arguments.

Scaling

Constant

No loop in the body: the same number of instructions runs whatever you pass in.

Instructions

34–56

Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 82.

Plugin surface

None

Nothing here hands control to plugin code.

Called by

2

2 places in core call this, so the cost is paid more often than your own code shows.

What one call costs · 6 distinct outcomes

One number would be a lie: the work depends on which branch runs. These are every distinct cost ParagonIE_Sodium_Compat::crypto_aead_chacha20poly1305_ietf_decrypt() can have, taken from its control-flow graph on PHP 8.5.

Uses · 8

• sodium_crypto_aead_chacha20poly1305_ietf_decrypt()
• ParagonIE_Sodium_Core_Util::declareScalarType()If a variable does not match a given type, throw a TypeError.
• ParagonIE_Sodium_Core_Util::strlen()Safe string length
• SodiumException::__construct()
• ParagonIE_Sodium_Compat::useNewSodiumAPI()Libsodium as implemented in PHP 7.2 and/or ext/sodium (via PECL)
• ParagonIE_Sodium_Compat::use_fallback()Should we use the libsodium core function instead? This is always a good idea, if it's available. (Unless we're in the middle of running our unit test suite.)
• ParagonIE_Sodium_Crypto32::aead_chacha20poly1305_ietf_decrypt()AEAD Decryption with ChaCha20-Poly1305, IETF mode (96-bit nonce)
• ParagonIE_Sodium_Crypto::aead_chacha20poly1305_ietf_decrypt()AEAD Decryption with ChaCha20-Poly1305, IETF mode (96-bit nonce)

Used by · 2

• crypto_aead_chacha20poly1305_ietf_decrypt()
• sodium_crypto_aead_chacha20poly1305_ietf_decrypt()

Source code

View on Trac ↗View on GitHub ↗

895    public static function crypto_aead_chacha20poly1305_ietf_decrypt(896        $ciphertext = '',897        $assocData = '',898        $nonce = '',899        #[\SensitiveParameter]900        $key = ''901    ) {902        /* Type checks: */903        ParagonIE_Sodium_Core_Util::declareScalarType($ciphertext, 'string', 1);904        ParagonIE_Sodium_Core_Util::declareScalarType($assocData, 'string', 2);905        ParagonIE_Sodium_Core_Util::declareScalarType($nonce, 'string', 3);906        ParagonIE_Sodium_Core_Util::declareScalarType($key, 'string', 4);907 908        /* Input validation: */909        if (ParagonIE_Sodium_Core_Util::strlen($nonce) !== self::CRYPTO_AEAD_CHACHA20POLY1305_IETF_NPUBBYTES) {910            throw new SodiumException('Nonce must be CRYPTO_AEAD_CHACHA20POLY1305_IETF_NPUBBYTES long');911        }912        if (ParagonIE_Sodium_Core_Util::strlen($key) !== self::CRYPTO_AEAD_CHACHA20POLY1305_KEYBYTES) {913            throw new SodiumException('Key must be CRYPTO_AEAD_CHACHA20POLY1305_IETF_KEYBYTES long');914        }915        if (ParagonIE_Sodium_Core_Util::strlen($ciphertext) < self::CRYPTO_AEAD_CHACHA20POLY1305_ABYTES) {916            throw new SodiumException('Message must be at least CRYPTO_AEAD_CHACHA20POLY1305_IETF_ABYTES long');917        }918 919        if (self::useNewSodiumAPI()) {920            /**921             * @psalm-suppress InvalidReturnStatement922             * @psalm-suppress FalsableReturnStatement923             */924            return sodium_crypto_aead_chacha20poly1305_ietf_decrypt(925                $ciphertext,926                $assocData,927                $nonce,928                $key929            );930        }931        if (self::use_fallback('crypto_aead_chacha20poly1305_ietf_decrypt')) {932            return call_user_func(933                '\\Sodium\\crypto_aead_chacha20poly1305_ietf_decrypt',934                $ciphertext,935                $assocData,936                $nonce,937                $key938            );939        }940        if (PHP_INT_SIZE === 4) {941            return ParagonIE_Sodium_Crypto32::aead_chacha20poly1305_ietf_decrypt(942                $ciphertext,943                $assocData,944                $nonce,945                $key946            );947        }948        return ParagonIE_Sodium_Crypto::aead_chacha20poly1305_ietf_decrypt(949            $ciphertext,950            $assocData,951            $nonce,952            $key953        );954    }

Changelog

Unchanged from 6.7.7 through 7.1.0.

1. 6.7.7
2. 6.8.8
3. 6.9.7
4. 7.0.4
5. 7.1.0

Signature, return type and hooks compared across 5 parsed releases.

About this page

Parsed data

Generated from the wordpress-develop 7.1.0 tag, from src/wp-includes/sodium_compat/src/Compat.php, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it.

Corrections

Something wrong on this page? Report it and it gets fixed in the next regeneration.