ParagonIE_Sodium_Compat::crypto_kx_server_session_keys( string $keypair, string $clientPublicKey ): array{0:

Compatibility

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

Parameters

$keypairstring

$clientPublicKeystring

Return value

array{0:

string, 1: string}

Performance profile

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

26–82

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

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 · 3 distinct outcomes

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

Uses · 10

• 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::crypto_kx_secretkey()
• ParagonIE_Sodium_Compat::crypto_kx_publickey()
• ParagonIE_Sodium_Compat::crypto_generichash_init()Initialize a BLAKE2b hashing context, for use in a streaming interface.
• ParagonIE_Sodium_Compat::crypto_generichash_update()Update a BLAKE2b hashing context with additional data.
• ParagonIE_Sodium_Compat::crypto_scalarmult()Calculate the shared secret between your secret key and your recipient's public key.
• ParagonIE_Sodium_Compat::crypto_generichash_final()Get the final BLAKE2b hash output for a given context.
• ParagonIE_Sodium_Core_Util::substr()Safe substring

Used by · 1

• sodium_crypto_kx_server_session_keys()

Source code

View on Trac ↗View on GitHub ↗

2173    public static function crypto_kx_server_session_keys(2174        #[\SensitiveParameter]2175        $keypair,2176        $clientPublicKey2177    ) {2178        ParagonIE_Sodium_Core_Util::declareScalarType($keypair, 'string', 1);2179        ParagonIE_Sodium_Core_Util::declareScalarType($clientPublicKey, 'string', 2);2180 2181        $keypair = (string) $keypair;2182        $clientPublicKey = (string) $clientPublicKey;2183 2184        if (ParagonIE_Sodium_Core_Util::strlen($keypair) !== self::CRYPTO_KX_KEYPAIRBYTES) {2185            throw new SodiumException('keypair should be SODIUM_CRYPTO_KX_KEYPAIRBYTES bytes');2186        }2187        if (ParagonIE_Sodium_Core_Util::strlen($clientPublicKey) !== self::CRYPTO_KX_PUBLICKEYBYTES) {2188            throw new SodiumException('public keys must be SODIUM_CRYPTO_KX_PUBLICKEYBYTES bytes');2189        }2190 2191        $sk = self::crypto_kx_secretkey($keypair);2192        $pk = self::crypto_kx_publickey($keypair);2193        $h = self::crypto_generichash_init(null, self::CRYPTO_KX_SESSIONKEYBYTES * 2);2194        self::crypto_generichash_update($h, self::crypto_scalarmult($sk, $clientPublicKey));2195        self::crypto_generichash_update($h, $clientPublicKey);2196        self::crypto_generichash_update($h, $pk);2197        $sessionKeys = self::crypto_generichash_final($h, self::CRYPTO_KX_SESSIONKEYBYTES * 2);2198        return array(2199            ParagonIE_Sodium_Core_Util::substr(2200                $sessionKeys,2201                self::CRYPTO_KX_SESSIONKEYBYTES,2202                self::CRYPTO_KX_SESSIONKEYBYTES2203            ),2204            ParagonIE_Sodium_Core_Util::substr(2205                $sessionKeys,2206                0,2207                self::CRYPTO_KX_SESSIONKEYBYTES2208            )2209        );2210    }

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.