ParagonIE_Sodium_Compat::crypto_stream( int $len, string $nonce, string $key ): 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

XSalsa20 key

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() 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

28–44

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

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

Uses · 8

• sodium_crypto_stream()
• 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_Core32_XSalsa20::xsalsa20()Expand a key and nonce into an xsalsa20 keystream.
• ParagonIE_Sodium_Core_XSalsa20::xsalsa20()Expand a key and nonce into an xsalsa20 keystream.

Used by · 2

• crypto_stream()
• sodium_crypto_stream()

Source code

View on Trac ↗View on GitHub ↗

3408    public static function crypto_stream(3409        $len,3410        $nonce,3411        #[\SensitiveParameter]3412        $key3413    ) {3414        /* Type checks: */3415        ParagonIE_Sodium_Core_Util::declareScalarType($len, 'int', 1);3416        ParagonIE_Sodium_Core_Util::declareScalarType($nonce, 'string', 2);3417        ParagonIE_Sodium_Core_Util::declareScalarType($key, 'string', 3);3418 3419        /* Input validation: */3420        if (ParagonIE_Sodium_Core_Util::strlen($nonce) !== self::CRYPTO_STREAM_NONCEBYTES) {3421            throw new SodiumException('Argument 2 must be CRYPTO_SECRETBOX_NONCEBYTES long.');3422        }3423        if (ParagonIE_Sodium_Core_Util::strlen($key) !== self::CRYPTO_STREAM_KEYBYTES) {3424            throw new SodiumException('Argument 3 must be CRYPTO_STREAM_KEYBYTES long.');3425        }3426 3427        if (self::useNewSodiumAPI()) {3428            return sodium_crypto_stream($len, $nonce, $key);3429        }3430        if (self::use_fallback('crypto_stream')) {3431            return (string) call_user_func('\\Sodium\\crypto_stream', $len, $nonce, $key);3432        }3433        if (PHP_INT_SIZE === 4) {3434            return ParagonIE_Sodium_Core32_XSalsa20::xsalsa20($len, $nonce, $key);3435        }3436        return ParagonIE_Sodium_Core_XSalsa20::xsalsa20($len, $nonce, $key);3437    }

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.