PHP 8.1.0 RC 4 available for testing

sodium_crypto_secretbox_open

(PHP 7 >= 7.2.0, PHP 8)

sodium_crypto_secretbox_openAuthenticated shared-key decryption

Descripción

sodium_crypto_secretbox_open(string $ciphertext, string $nonce, string $key): string|false

Decrypt an encrypted message with a symmetric (shared) key.

Parámetros

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).

Valores devueltos

The decrypted string on success o false en caso de error.

Errores/Excepciones

Ejemplos

Ejemplo #1 sodium_crypto_secretbox_open() example

<?php
// The $key must be kept confidential
$key random_bytes(SODIUM_CRYPTO_SECRETBOX_KEYBYTES);
// Do not reuse $nonce with the same key
$nonce random_bytes(SODIUM_CRYPTO_SECRETBOX_NONCEBYTES);
$ciphertext sodium_crypto_secretbox('message to be encrypted'$nonce$key);

// The same nouce and key are required to decrypt the $ciphertext
$plaintext sodium_crypto_secretbox_open($ciphertext$nonce$key);
if (
$plaintext !== false) {
    echo 
$plaintext PHP_EOL;
}
?>

El resultado del ejemplo sería:

message to be encrypted

Ver también

add a note add a note

User Contributed Notes 1 note

up
3
khalyomede at gmail dot com
2 years ago
This method will return a string, or false if the data failed to be decrypted.

$key = 'secret';
$data = 'binarydata';
$nonce = random_bytes(SODIUM_CRYPT_SECRETBOX_NONCEBYTES);

$decrypted = sodium_crypto_secretbox_open($data, $nonce, $key);

if ($decrypted === false) {
  throw new Exception('failed to decrypt data');
}
To Top