ParagonIE_Sodium_Core_SipHash::sipHash24( string $in, 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

$instring

$keystring

Return value

string

Performance profile

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

137–193

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

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

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

Uses · 6

• ParagonIE_Sodium_Core_SipHash::strlen()
• ParagonIE_Sodium_Core_SipHash::load_4()
• ParagonIE_Sodium_Core_SipHash::substr()
• ParagonIE_Sodium_Core_SipHash::sipRound()
• ParagonIE_Sodium_Core_SipHash::chrToInt()
• ParagonIE_Sodium_Core_SipHash::store32_le()

Used by · 1

• ParagonIE_Sodium_Compat::crypto_shorthash()Calculates a SipHash-2-4 hash of a message for a given key.

Source code

View on Trac ↗View on GitHub ↗

163    public static function sipHash24($in, $key)164    {165        $inlen = self::strlen($in);166 167        # /* "somepseudorandomlygeneratedbytes" */168        # u64 v0 = 0x736f6d6570736575ULL;169        # u64 v1 = 0x646f72616e646f6dULL;170        # u64 v2 = 0x6c7967656e657261ULL;171        # u64 v3 = 0x7465646279746573ULL;172        $v = array(173            0x736f6d65, // 0174            0x70736575, // 1175            0x646f7261, // 2176            0x6e646f6d, // 3177            0x6c796765, // 4178            0x6e657261, // 5179            0x74656462, // 6180            0x79746573  // 7181        );182        // v0 => $v[0], $v[1]183        // v1 => $v[2], $v[3]184        // v2 => $v[4], $v[5]185        // v3 => $v[6], $v[7]186 187        # u64 k0 = LOAD64_LE( k );188        # u64 k1 = LOAD64_LE( k + 8 );189        $k = array(190            self::load_4(self::substr($key, 4, 4)),191            self::load_4(self::substr($key, 0, 4)),192            self::load_4(self::substr($key, 12, 4)),193            self::load_4(self::substr($key, 8, 4))194        );195        // k0 => $k[0], $k[1]196        // k1 => $k[2], $k[3]197 198        # b = ( ( u64 )inlen ) << 56;199        $b = array(200            $inlen << 24,201            0202        );203        // See docblock for why the 0th index gets the higher bits.204 205        # v3 ^= k1;206        $v[6] ^= $k[2];207        $v[7] ^= $k[3];208        # v2 ^= k0;209        $v[4] ^= $k[0];210        $v[5] ^= $k[1];211        # v1 ^= k1;212        $v[2] ^= $k[2];213        $v[3] ^= $k[3];214        # v0 ^= k0;215        $v[0] ^= $k[0];216        $v[1] ^= $k[1];217 218        $left = $inlen;219        # for ( ; in != end; in += 8 )220        while ($left >= 8) {221            # m = LOAD64_LE( in );222            $m = array(223                self::load_4(self::substr($in, 4, 4)),224                self::load_4(self::substr($in, 0, 4))225            );226 227            # v3 ^= m;228            $v[6] ^= $m[0];229            $v[7] ^= $m[1];230 231            # SIPROUND;232            # SIPROUND;233            $v = self::sipRound($v);234            $v = self::sipRound($v);235 236            # v0 ^= m;237            $v[0] ^= $m[0];238            $v[1] ^= $m[1];239 240            $in = self::substr($in, 8);241            $left -= 8;242        }

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/SipHash.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.