sodium_crypto_secretbox_open
PHP 7 >= 7.2.0, PHP 8
sodium_crypto_secretbox_open - Authenticated shared-key decryption
Manual
sodium_crypto_secretbox_open(
string$ciphertext,
string$nonce,
string$key ): string|false
Decrypt an encrypted message with a symmetric (shared) key.
Parameters
- ciphertext
-
Must be in the format provided by sodium_crypto_secretbox (ciphertext and tag, concatenated).
- nonce
-
A number that must be only used once, per message. 24 bytes long. This is a large enough bound to generate randomly (i.e. random_bytes).
- key
-
Encryption key (256-bit).
Return Values
The decrypted string on success or false on failure.
Exceptions and Errors
If nonce has a length of bytes different than SODIUM_CRYPTO_SECRETBOX_NONCEBYTES (24 bytes), a SodiumException will be thrown.
If key has a length of bytes different than SODIUM_CRYPTO_SECRETBOX_KEYBYTES (32 bytes), a SodiumException will be thrown.