ParagonIE_Sodium_Compat::crypto_aead_chacha20poly1305_ietf_encrypt( string $plaintext = '', 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

$plaintextstringoptional

Message to be encryptedDefault: ''

$assocDatastringoptional

Authenticated Associated Data (unencrypted)Default: ''

$noncestringoptional

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

$keystringoptional

Encryption keyDefault: ''

Return value

string

Ciphertext with a 16-byte Poly1305 message authentication code appended

Performance profile

How much work a call to ParagonIE_Sodium_Compat::crypto_aead_chacha20poly1305_ietf_encrypt() 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

31–53

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

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 · 9 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_encrypt() can have, taken from its control-flow graph on PHP 8.5.

Uses · 8

• sodium_crypto_aead_chacha20poly1305_ietf_encrypt()
• 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_encrypt()AEAD Encryption with ChaCha20-Poly1305, IETF mode (96-bit nonce)
• ParagonIE_Sodium_Crypto::aead_chacha20poly1305_ietf_encrypt()AEAD Encryption with ChaCha20-Poly1305, IETF mode (96-bit nonce)

Used by · 2

• crypto_aead_chacha20poly1305_ietf_encrypt()
• sodium_crypto_aead_chacha20poly1305_ietf_encrypt()

Source code

View on Trac ↗View on GitHub ↗

989    public static function crypto_aead_chacha20poly1305_ietf_encrypt(990        #[\SensitiveParameter]991        $plaintext = '',992        $assocData = '',993        $nonce = '',994        #[\SensitiveParameter]995        $key = ''996    ) {997        /* Type checks: */998        ParagonIE_Sodium_Core_Util::declareScalarType($plaintext, 'string', 1);999        if (!is_null($assocData)) {1000            ParagonIE_Sodium_Core_Util::declareScalarType($assocData, 'string', 2);1001        }1002        ParagonIE_Sodium_Core_Util::declareScalarType($nonce, 'string', 3);1003        ParagonIE_Sodium_Core_Util::declareScalarType($key, 'string', 4);1004 1005        /* Input validation: */1006        if (ParagonIE_Sodium_Core_Util::strlen($nonce) !== self::CRYPTO_AEAD_CHACHA20POLY1305_IETF_NPUBBYTES) {1007            throw new SodiumException('Nonce must be CRYPTO_AEAD_CHACHA20POLY1305_IETF_NPUBBYTES long');1008        }1009        if (ParagonIE_Sodium_Core_Util::strlen($key) !== self::CRYPTO_AEAD_CHACHA20POLY1305_KEYBYTES) {1010            throw new SodiumException('Key must be CRYPTO_AEAD_CHACHA20POLY1305_KEYBYTES long');1011        }1012 1013        if (self::useNewSodiumAPI()) {1014            return (string) sodium_crypto_aead_chacha20poly1305_ietf_encrypt(1015                $plaintext,1016                $assocData,1017                $nonce,1018                $key1019            );1020        }1021        if (self::use_fallback('crypto_aead_chacha20poly1305_ietf_encrypt')) {1022            return (string) call_user_func(1023                '\\Sodium\\crypto_aead_chacha20poly1305_ietf_encrypt',1024                $plaintext,1025                $assocData,1026                $nonce,1027                $key1028            );1029        }1030        if (PHP_INT_SIZE === 4) {1031            return ParagonIE_Sodium_Crypto32::aead_chacha20poly1305_ietf_encrypt(1032                $plaintext,1033                $assocData,1034                $nonce,1035                $key1036            );1037        }1038        return ParagonIE_Sodium_Crypto::aead_chacha20poly1305_ietf_encrypt(1039            $plaintext,1040            $assocData,1041            $nonce,1042            $key1043        );1044    }

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.