ParagonIE_Sodium_Compat::crypto_auth( string $message, 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

$messagestring

Message to be authenticated

$keystring

Symmetric authentication key

Return value

string

Message authentication code

Performance profile

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

22–31

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

Plugin surface

None

Nothing here hands control to plugin code.

Called by

2

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

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

Uses · 8

• sodium_crypto_auth()
• 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::useNewSodiumAPI()Libsodium as implemented in PHP 7.2 and/or ext/sodium (via PECL)
• ParagonIE_Sodium_Compat::use_fallback()Should we use the libsodium core function instead? This is always a good idea, if it's available. (Unless we're in the middle of running our unit test suite.)
• ParagonIE_Sodium_Crypto32::auth()HMAC-SHA-512-256 (a.k.a. the leftmost 256 bits of HMAC-SHA-512)
• ParagonIE_Sodium_Crypto::auth()HMAC-SHA-512-256 (a.k.a. the leftmost 256 bits of HMAC-SHA-512)

Used by · 2

• crypto_auth()
• sodium_crypto_auth()

Source code

View on Trac ↗View on GitHub ↗

1238    public static function crypto_auth(1239        $message,1240        #[\SensitiveParameter]1241        $key1242    ) {1243        /* Type checks: */1244        ParagonIE_Sodium_Core_Util::declareScalarType($message, 'string', 1);1245        ParagonIE_Sodium_Core_Util::declareScalarType($key, 'string', 2);1246 1247        /* Input validation: */1248        if (ParagonIE_Sodium_Core_Util::strlen($key) !== self::CRYPTO_AUTH_KEYBYTES) {1249            throw new SodiumException('Argument 2 must be CRYPTO_AUTH_KEYBYTES long.');1250        }1251 1252        if (self::useNewSodiumAPI()) {1253            return (string) sodium_crypto_auth($message, $key);1254        }1255        if (self::use_fallback('crypto_auth')) {1256            return (string) call_user_func('\\Sodium\\crypto_auth', $message, $key);1257        }1258        if (PHP_INT_SIZE === 4) {1259            return ParagonIE_Sodium_Crypto32::auth($message, $key);1260        }1261        return ParagonIE_Sodium_Crypto::auth($message, $key);1262    }

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.