ParagonIE_Sodium_Compat::crypto_aead_aes256gcm_decrypt( string $ciphertext = '', string $assocData = '', string $nonce = '', string $key = '' ): string|bool

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

$ciphertextstringoptional

Encrypted message (with Poly1305 MAC appended)Default: ''

$assocDatastringoptional

Authenticated Associated Data (unencrypted)Default: ''

$noncestringoptional

Number to be used only Once; must be 8 bytesDefault: ''

$keystringoptional

Encryption keyDefault: ''

Return value

string|bool

The original plaintext message

Performance profile

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

11–71

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

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

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

Uses · 5

• ParagonIE_Sodium_Compat::crypto_aead_aes256gcm_is_available()Is AES-256-GCM even available to use?
• SodiumException::__construct()
• 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
• ParagonIE_Sodium_Core_Util::substr()Safe substring

Used by · 2

• crypto_aead_aes256gcm_decrypt()
• sodium_crypto_aead_aes256gcm_decrypt()

Source code

View on Trac ↗View on GitHub ↗

596    public static function crypto_aead_aes256gcm_decrypt(597        $ciphertext = '',598        $assocData = '',599        $nonce = '',600        #[\SensitiveParameter]601        $key = ''602    ) {603        if (!self::crypto_aead_aes256gcm_is_available()) {604            throw new SodiumException('AES-256-GCM is not available');605        }606        ParagonIE_Sodium_Core_Util::declareScalarType($ciphertext, 'string', 1);607        ParagonIE_Sodium_Core_Util::declareScalarType($assocData, 'string', 2);608        ParagonIE_Sodium_Core_Util::declareScalarType($nonce, 'string', 3);609        ParagonIE_Sodium_Core_Util::declareScalarType($key, 'string', 4);610 611        /* Input validation: */612        if (ParagonIE_Sodium_Core_Util::strlen($nonce) !== self::CRYPTO_AEAD_AES256GCM_NPUBBYTES) {613            throw new SodiumException('Nonce must be CRYPTO_AEAD_AES256GCM_NPUBBYTES long');614        }615        if (ParagonIE_Sodium_Core_Util::strlen($key) !== self::CRYPTO_AEAD_AES256GCM_KEYBYTES) {616            throw new SodiumException('Key must be CRYPTO_AEAD_AES256GCM_KEYBYTES long');617        }618        if (ParagonIE_Sodium_Core_Util::strlen($ciphertext) < self::CRYPTO_AEAD_AES256GCM_ABYTES) {619            throw new SodiumException('Message must be at least CRYPTO_AEAD_AES256GCM_ABYTES long');620        }621        if (!extension_loaded('openssl')) {622            throw new SodiumException('The OpenSSL extension is not installed');623        }624        if (!is_callable('openssl_decrypt')) {625            throw new SodiumException('The OpenSSL extension is not installed, or openssl_decrypt() is not available');626        }627 628        /** @var string $ctext */629        $ctext = ParagonIE_Sodium_Core_Util::substr($ciphertext, 0, -self::CRYPTO_AEAD_AES256GCM_ABYTES);630        /** @var string $authTag */631        $authTag = ParagonIE_Sodium_Core_Util::substr($ciphertext, -self::CRYPTO_AEAD_AES256GCM_ABYTES, 16);632        return openssl_decrypt(633            $ctext,634            'aes-256-gcm',635            $key,636            OPENSSL_RAW_DATA,637            $nonce,638            $authTag,639            $assocData640        );641    }

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.