ParagonIE_Sodium_Crypto32::secretstream_xchacha20poly1305_push( string $state, string $msg, string $aad = '', int $tag = 0 ): 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

$statestring

$msgstring

$aadstringoptional

Default: ''

$tagintoptional

Default: 0

Return value

string

Performance profile

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

Heavy

Reaches the database via ->update().

Scaling

Constant

No loop in the body: the same number of instructions runs whatever you pass in.

Instructions

24–134

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

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 it touches

• sqldatabase query->update()called directly

What one call costs · 4 distinct outcomes

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

Uses · 9

• ParagonIE_Sodium_Core32_SecretStream_State::fromString()
• ParagonIE_Sodium_Core32_Util::strlen()
• SodiumException::__construct()
• ParagonIE_Sodium_Core32_Poly1305_State::__construct()ParagonIE_Sodium_Core32_Poly1305_State constructor.
• ParagonIE_Sodium_Core32_ChaCha20::ietfStream()
• ParagonIE_Sodium_Core32_ChaCha20::ietfStreamXorIc()
• ParagonIE_Sodium_Core32_Util::intToChr()
• ParagonIE_Sodium_Core32_Util::store64_le()
• ParagonIE_Sodium_Crypto32::secretstream_xchacha20poly1305_rekey()

Used by · 1

• ParagonIE_Sodium_Compat::crypto_secretstream_xchacha20poly1305_push()

Source code

View on Trac ↗View on GitHub ↗

1297    public static function secretstream_xchacha20poly1305_push(&$state, $msg, $aad = '', $tag = 0)1298    {1299        $st = ParagonIE_Sodium_Core32_SecretStream_State::fromString($state);1300        # crypto_onetimeauth_poly1305_state poly1305_state;1301        # unsigned char                     block[64U];1302        # unsigned char                     slen[8U];1303        # unsigned char                    *c;1304        # unsigned char                    *mac;1305 1306        $msglen = ParagonIE_Sodium_Core32_Util::strlen($msg);1307        $aadlen = ParagonIE_Sodium_Core32_Util::strlen($aad);1308 1309        if ((($msglen + 63) >> 6) > 0xfffffffe) {1310            throw new SodiumException(1311                'message cannot be larger than SODIUM_CRYPTO_SECRETSTREAM_XCHACHA20POLY1305_MESSAGEBYTES_MAX bytes'1312            );1313        }1314 1315        # if (outlen_p != NULL) {1316        #     *outlen_p = 0U;1317        # }1318        # if (mlen > crypto_secretstream_xchacha20poly1305_MESSAGEBYTES_MAX) {1319        #     sodium_misuse();1320        # }1321 1322        # crypto_stream_chacha20_ietf(block, sizeof block, state->nonce, state->k);1323        # crypto_onetimeauth_poly1305_init(&poly1305_state, block);1324        # sodium_memzero(block, sizeof block);1325        $auth = new ParagonIE_Sodium_Core32_Poly1305_State(1326            ParagonIE_Sodium_Core32_ChaCha20::ietfStream(32, $st->getCombinedNonce(), $st->getKey())1327        );1328 1329        # crypto_onetimeauth_poly1305_update(&poly1305_state, ad, adlen);1330        $auth->update($aad);1331 1332        # crypto_onetimeauth_poly1305_update(&poly1305_state, _pad0,1333        #     (0x10 - adlen) & 0xf);1334        $auth->update(str_repeat("\0", ((0x10 - $aadlen) & 0xf)));1335 1336        # memset(block, 0, sizeof block);1337        # block[0] = tag;1338        # crypto_stream_chacha20_ietf_xor_ic(block, block, sizeof block,1339        #                                    state->nonce, 1U, state->k);1340        $block = ParagonIE_Sodium_Core32_ChaCha20::ietfStreamXorIc(1341            ParagonIE_Sodium_Core32_Util::intToChr($tag) . str_repeat("\0", 63),1342            $st->getCombinedNonce(),1343            $st->getKey(),1344            ParagonIE_Sodium_Core32_Util::store64_le(1)1345        );1346 1347        # crypto_onetimeauth_poly1305_update(&poly1305_state, block, sizeof block);1348        $auth->update($block);1349 1350        # out[0] = block[0];1351        $out = $block[0];1352        # c = out + (sizeof tag);1353        # crypto_stream_chacha20_ietf_xor_ic(c, m, mlen, state->nonce, 2U, state->k);1354        $cipher = ParagonIE_Sodium_Core32_ChaCha20::ietfStreamXorIc(1355            $msg,1356            $st->getCombinedNonce(),1357            $st->getKey(),1358            ParagonIE_Sodium_Core32_Util::store64_le(2)1359        );1360 1361        # crypto_onetimeauth_poly1305_update(&poly1305_state, c, mlen);1362        $auth->update($cipher);1363 1364        $out .= $cipher;1365        unset($cipher);1366 1367        # crypto_onetimeauth_poly1305_update1368        # (&poly1305_state, _pad0, (0x10 - (sizeof block) + mlen) & 0xf);1369        $auth->update(str_repeat("\0", ((0x10 - 64 + $msglen) & 0xf)));1370 1371        # STORE64_LE(slen, (uint64_t) adlen);1372        $slen = ParagonIE_Sodium_Core32_Util::store64_le($aadlen);1373 1374        # crypto_onetimeauth_poly1305_update(&poly1305_state, slen, sizeof slen);1375        $auth->update($slen);1376

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