ParagonIE_Sodium_Core_BLAKE2b::init( SplFixedArray|null $key = null, int $outlen = 64, SplFixedArray|null $salt = null, SplFixedArray|null $personal = null ): SplFixedArray

Compatibility

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

Parameters

$keySplFixedArray|nulloptional

Default: null

$outlenintoptional

Default: 64

$saltSplFixedArray|nulloptional

Default: null

$personalSplFixedArray|nulloptional

Default: null

Return value

SplFixedArray

Performance profile

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

Light

Touches nothing outside its own arguments.

Scaling

Scales with input

The body loops, so the work grows with what you pass in.

Instructions

15–92

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

Plugin surface

None

Nothing here hands control to plugin code.

Called by

3

3 places 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_Core_BLAKE2b::init() can have, taken from its control-flow graph on PHP 8.5.

Uses · 7

• ParagonIE_Sodium_Core_BLAKE2b::pseudoConstructor()This just sets the $iv static variable.
• SodiumException::__construct()
• ParagonIE_Sodium_Core_BLAKE2b::context()Returns a fresh BLAKE2 context.
• SplFixedArray::__construct()SplFixedArray constructor.
• ParagonIE_Sodium_Core_BLAKE2b::xor64()
• ParagonIE_Sodium_Core_BLAKE2b::load64()
• ParagonIE_Sodium_Core_BLAKE2b::update()

Used by · 3

• ParagonIE_Sodium_Crypto::generichash()Calculate a BLAKE2b hash.
• ParagonIE_Sodium_Crypto::generichash_init()Initialize a hashing context for BLAKE2b.
• ParagonIE_Sodium_Crypto::generichash_init_salt_personal()Initialize a hashing context for BLAKE2b.

Source code

View on Trac ↗View on GitHub ↗

572    public static function init(573        $key = null,574        $outlen = 64,575        $salt = null,576        $personal = null577    ) {578        self::pseudoConstructor();579        $klen = 0;580 581        if ($key !== null) {582            if (count($key) > 64) {583                throw new SodiumException('Invalid key size');584            }585            $klen = count($key);586        }587 588        if ($outlen > 64) {589            throw new SodiumException('Invalid output size');590        }591 592        $ctx = self::context();593 594        $p = new SplFixedArray(64);595        // Zero our param buffer...596        for ($i = 64; --$i;) {597            $p[$i] = 0;598        }599 600        $p[0] = $outlen; // digest_length601        $p[1] = $klen;   // key_length602        $p[2] = 1;       // fanout603        $p[3] = 1;       // depth604 605        if ($salt instanceof SplFixedArray) {606            // salt: [32] through [47]607            for ($i = 0; $i < 16; ++$i) {608                $p[32 + $i] = (int) $salt[$i];609            }610        }611        if ($personal instanceof SplFixedArray) {612            // personal: [48] through [63]613            for ($i = 0; $i < 16; ++$i) {614                $p[48 + $i] = (int) $personal[$i];615            }616        }617 618        $ctx[0][0] = self::xor64(619            $ctx[0][0],620            self::load64($p, 0)621        );622        if ($salt instanceof SplFixedArray || $personal instanceof SplFixedArray) {623            // We need to do what blake2b_init_param() does:624            for ($i = 1; $i < 8; ++$i) {625                $ctx[0][$i] = self::xor64(626                    $ctx[0][$i],627                    self::load64($p, $i << 3)628                );629            }630        }631 632        if ($klen > 0 && $key instanceof SplFixedArray) {633            $block = new SplFixedArray(128);634            for ($i = 128; $i--;) {635                $block[$i] = 0;636            }637            for ($i = $klen; $i--;) {638                $block[$i] = $key[$i];639            }640            self::update($ctx, $block, 128);641            $ctx[4] = 128;642        }643 644        return $ctx;645    }

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/Core/BLAKE2b.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.