ParagonIE_Sodium_Core32_Poly1305_State::__construct( string $key = '' )

Compatibility

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

Parameters

$keystringoptional

Default: ''

Performance profile

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

10–185

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

Plugin surface

None

Nothing here hands control to plugin code.

Called by

12

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

What one call costs · 2 distinct outcomes

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

Uses · 27

• ParagonIE_Sodium_Core32_Poly1305_State::strlen()
• InvalidArgumentException::__construct()
• ParagonIE_Sodium_Core32_Int32::fromReverseString(self::substr($key, 0, 4))->setUnsignedInt(\true)::mask()
• ParagonIE_Sodium_Core32_Int32::fromReverseString(self::substr($key, 0, 4))::setUnsignedInt()
• ParagonIE_Sodium_Core32_Int32::fromReverseString()
• ParagonIE_Sodium_Core32_Poly1305_State::substr()
• ParagonIE_Sodium_Core32_Int32::fromReverseString(self::substr($key, 3, 4))->setUnsignedInt(\true)->shiftRight(2)::mask()
• ParagonIE_Sodium_Core32_Int32::fromReverseString(self::substr($key, 3, 4))->setUnsignedInt(\true)::shiftRight()
• ParagonIE_Sodium_Core32_Int32::fromReverseString(self::substr($key, 3, 4))::setUnsignedInt()
• ParagonIE_Sodium_Core32_Int32::fromReverseString(self::substr($key, 6, 4))->setUnsignedInt(\true)->shiftRight(4)::mask()
• ParagonIE_Sodium_Core32_Int32::fromReverseString(self::substr($key, 6, 4))->setUnsignedInt(\true)::shiftRight()
• ParagonIE_Sodium_Core32_Int32::fromReverseString(self::substr($key, 6, 4))::setUnsignedInt()

Used by · 12

• ParagonIE_Sodium_Core32_Poly1305::onetimeauth()
• ParagonIE_Sodium_Core32_Poly1305::onetimeauth_verify()
• ParagonIE_Sodium_Crypto32::aead_chacha20poly1305_decrypt()AEAD Decryption with ChaCha20-Poly1305
• ParagonIE_Sodium_Crypto32::aead_chacha20poly1305_encrypt()AEAD Encryption with ChaCha20-Poly1305
• ParagonIE_Sodium_Crypto32::aead_chacha20poly1305_ietf_decrypt()AEAD Decryption with ChaCha20-Poly1305, IETF mode (96-bit nonce)
• ParagonIE_Sodium_Crypto32::aead_chacha20poly1305_ietf_encrypt()AEAD Encryption with ChaCha20-Poly1305, IETF mode (96-bit nonce)
• ParagonIE_Sodium_Crypto32::secretbox()XSalsa20-Poly1305 authenticated symmetric-key encryption.
• ParagonIE_Sodium_Crypto32::secretbox_xchacha20poly1305()XChaCha20-Poly1305 authenticated symmetric-key encryption.
• ParagonIE_Sodium_Crypto32::secretstream_xchacha20poly1305_pull()
• ParagonIE_Sodium_Crypto32::secretstream_xchacha20poly1305_push()
• ParagonIE_Sodium_File::secretbox_decrypt_core32()Decrypt a file (32-bit)
• ParagonIE_Sodium_File::secretbox_encrypt_core32()Encrypt a file (32-bit)

Source code

View on Trac ↗View on GitHub ↗

52    public function __construct($key = '')53    {54        if (self::strlen($key) < 32) {55            throw new InvalidArgumentException(56                'Poly1305 requires a 32-byte key'57            );58        }59        /* r &= 0xffffffc0ffffffc0ffffffc0fffffff */60        $this->r = array(61            // st->r[0] = ...62            ParagonIE_Sodium_Core32_Int32::fromReverseString(self::substr($key, 0, 4))63                ->setUnsignedInt(true)64                ->mask(0x3ffffff),65            // st->r[1] = ...66            ParagonIE_Sodium_Core32_Int32::fromReverseString(self::substr($key, 3, 4))67                ->setUnsignedInt(true)68                ->shiftRight(2)69                ->mask(0x3ffff03),70            // st->r[2] = ...71            ParagonIE_Sodium_Core32_Int32::fromReverseString(self::substr($key, 6, 4))72                ->setUnsignedInt(true)73                ->shiftRight(4)74                ->mask(0x3ffc0ff),75            // st->r[3] = ...76            ParagonIE_Sodium_Core32_Int32::fromReverseString(self::substr($key, 9, 4))77                ->setUnsignedInt(true)78                ->shiftRight(6)79                ->mask(0x3f03fff),80            // st->r[4] = ...81            ParagonIE_Sodium_Core32_Int32::fromReverseString(self::substr($key, 12, 4))82                ->setUnsignedInt(true)83                ->shiftRight(8)84                ->mask(0x00fffff)85        );86 87        /* h = 0 */88        $this->h = array(89            new ParagonIE_Sodium_Core32_Int32(array(0, 0), true),90            new ParagonIE_Sodium_Core32_Int32(array(0, 0), true),91            new ParagonIE_Sodium_Core32_Int32(array(0, 0), true),92            new ParagonIE_Sodium_Core32_Int32(array(0, 0), true),93            new ParagonIE_Sodium_Core32_Int32(array(0, 0), true)94        );95 96        /* save pad for later */97        $this->pad = array(98            ParagonIE_Sodium_Core32_Int32::fromReverseString(self::substr($key, 16, 4))99                ->setUnsignedInt(true)->toInt64(),100            ParagonIE_Sodium_Core32_Int32::fromReverseString(self::substr($key, 20, 4))101                ->setUnsignedInt(true)->toInt64(),102            ParagonIE_Sodium_Core32_Int32::fromReverseString(self::substr($key, 24, 4))103                ->setUnsignedInt(true)->toInt64(),104            ParagonIE_Sodium_Core32_Int32::fromReverseString(self::substr($key, 28, 4))105                ->setUnsignedInt(true)->toInt64(),106        );107 108        $this->leftover = 0;109        $this->final = false;110    }

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/Core32/Poly1305/State.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.