ParagonIE_Sodium_Compat::crypto_stream_xchacha20( int $len, string $nonce, string $key, bool $dontFallback = false ): string

Compatibility

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

Parameters

$lenint

Number of bytes desired

$noncestring

Number to be used Once; must be 24 bytes

$keystring

XChaCha20 key

$dontFallbackbooloptional

Default: false

Return value

string

Pseudorandom stream that can be XORed with messages to provide encryption (but not authentication; see Poly1305 or crypto_auth() for that, which is not optional for security)

Performance profile

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

29–41

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

Plugin surface

None

Nothing here hands control to plugin code.

Called by

1

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

What one call costs · 4 distinct outcomes

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

Uses · 7

• sodium_crypto_stream_xchacha20()
• 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_Core32_XChaCha20::stream()
• ParagonIE_Sodium_Core_XChaCha20::stream()

Used by · 1

• sodium_crypto_stream_xchacha20()

Source code

View on Trac ↗View on GitHub ↗

3519    public static function crypto_stream_xchacha20(3520        $len,3521        $nonce,3522        #[\SensitiveParameter]3523        $key,3524        $dontFallback = false3525    ) {3526        /* Type checks: */3527        ParagonIE_Sodium_Core_Util::declareScalarType($len, 'int', 1);3528        ParagonIE_Sodium_Core_Util::declareScalarType($nonce, 'string', 2);3529        ParagonIE_Sodium_Core_Util::declareScalarType($key, 'string', 3);3530 3531        /* Input validation: */3532        if (ParagonIE_Sodium_Core_Util::strlen($nonce) !== self::CRYPTO_STREAM_XCHACHA20_NONCEBYTES) {3533            throw new SodiumException('Argument 2 must be CRYPTO_SECRETBOX_XCHACHA20_NONCEBYTES long.');3534        }3535        if (ParagonIE_Sodium_Core_Util::strlen($key) !== self::CRYPTO_STREAM_XCHACHA20_KEYBYTES) {3536            throw new SodiumException('Argument 3 must be CRYPTO_STREAM_XCHACHA20_KEYBYTES long.');3537        }3538 3539        if (self::useNewSodiumAPI() && !$dontFallback) {3540            return sodium_crypto_stream_xchacha20($len, $nonce, $key);3541        }3542        if (PHP_INT_SIZE === 4) {3543            return ParagonIE_Sodium_Core32_XChaCha20::stream($len, $nonce, $key);3544        }3545        return ParagonIE_Sodium_Core_XChaCha20::stream($len, $nonce, $key);3546    }

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.