sodium_crypto_secretbox_open

(PHP 7 >= 7.2.0, PHP 8)

sodium_crypto_secretbox_open — Descriptografia de chave compartilhada autenticada

Descrição

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

Descriptografa uma mensagem criptografada com uma chave simétrica (compartilhada).

Parâmetros

ciphertext: Precisa estar no formato fornecido por sodium_crypto_secretbox() (texto cifrado e tag, concatenados).
nonce: Um número que deve ser usado apenas uma vez por mensagem. 24 bytes de comprimento. Este é um limite grande o suficiente para ser gerado aleatoriamente (por exemplo, random_bytes()).
key: Chave de criptografia (256-bit).

Valor Retornado

A string descriptografada em caso de sucesso ou false em caso de falha.

Erros/Exceções

Se nonce tiver um comprimento de bytes diferente de SODIUM_CRYPTO_SECRETBOX_NONCEBYTES (24 bytes), uma SodiumException será lançada.
Se key tiver um comprimento de bytes diferente de SODIUM_CRYPTO_SECRETBOX_KEYBYTES (32 bytes), uma SodiumException será lançada.

Exemplos

Exemplo #1 Exemplo de sodium_crypto_secretbox_open()

<?php
// A chave $key deve ser mantida confidencial
$key = random_bytes(SODIUM_CRYPTO_SECRETBOX_KEYBYTES);
// Não reutilize $nonce com a mesma chave
$nonce = random_bytes(SODIUM_CRYPTO_SECRETBOX_NONCEBYTES);
$ciphertext = sodium_crypto_secretbox('mensagem a ser criptografada', $nonce, $key);

// O mesmo nonce e chave são necessários para descriptografar o $ciphertext
$plaintext = sodium_crypto_secretbox_open($ciphertext, $nonce, $key);
if ($plaintext !== false) {
    echo $plaintext . PHP_EOL;
}
?>

O exemplo acima produzirá:

mensagem a ser criptografada

Veja Também

sodium_crypto_secretbox() - Criptografia de chave compartilhada autenticada
sodium_crypto_secretbox_keygen() - Gera chave aleatória para sodium_crypto_secretbox
random_bytes() - Obtém bytes aleatórios criptograficamente seguros