W3cubDocs

/PHP

sodium_crypto_aead_aegis256_decrypt

(PHP 8 >= 8.4.0)

sodium_crypto_aead_aegis256_decrypt — Verify then decrypt a message with AEGIS-256

Description

sodium_crypto_aead_aegis256_decrypt(
 string $ciphertext,
 string $additional_data,
 string $nonce,
 #[\SensitiveParameter] string $key
): string|false

Verify then decrypt a message with AEGIS-256.

Parameters

ciphertext: Must be in the format provided by sodium_crypto_aead_aegis256_encrypt().
additional_data: Additional, authenticated data. This is used in the verification of the authentication tag appended to the ciphertext, but it is not encrypted or stored in the ciphertext.
nonce: A number that must be only used once, per message.
key: Encryption key (256-bit).

Return Values

Returns the plaintext on success, or false on failure.

See Also

sodium_crypto_aead_aegis256_encrypt() - Encrypt then authenticate a message with AEGIS-256
sodium_crypto_aead_aegis256_keygen() - Generate a random AEGIS-256 key

© 1997–2025 The PHP Documentation Group
Licensed under the Creative Commons Attribution License v3.0 or later.
https://www.php.net/manual/en/function.sodium-crypto-aead-aegis256-decrypt.php