diff --git a/reference/sodium/constants.xml b/reference/sodium/constants.xml index 5b49cb868c90..df97a9f07c0b 100644 --- a/reference/sodium/constants.xml +++ b/reference/sodium/constants.xml @@ -76,6 +76,94 @@ + + + SODIUM_CRYPTO_AEAD_AEGIS128L_KEYBYTES + (int) + + + + Available as of PHP 8.4.0. + + + + + + SODIUM_CRYPTO_AEAD_AEGIS128L_NSECBYTES + (int) + + + + Available as of PHP 8.4.0. + + + + + + SODIUM_CRYPTO_AEAD_AEGIS128L_NPUBBYTES + (int) + + + + Available as of PHP 8.4.0. + + + + + + SODIUM_CRYPTO_AEAD_AEGIS128L_ABYTES + (int) + + + + Available as of PHP 8.4.0. + + + + + + SODIUM_CRYPTO_AEAD_AEGIS256_KEYBYTES + (int) + + + + Available as of PHP 8.4.0. + + + + + + SODIUM_CRYPTO_AEAD_AEGIS256_NSECBYTES + (int) + + + + Available as of PHP 8.4.0. + + + + + + SODIUM_CRYPTO_AEAD_AEGIS256_NPUBBYTES + (int) + + + + Available as of PHP 8.4.0. + + + + + + SODIUM_CRYPTO_AEAD_AEGIS256_ABYTES + (int) + + + + Available as of PHP 8.4.0. + + + SODIUM_CRYPTO_AEAD_AES256GCM_KEYBYTES diff --git a/reference/sodium/functions/sodium-crypto-aead-aegis128l-decrypt.xml b/reference/sodium/functions/sodium-crypto-aead-aegis128l-decrypt.xml new file mode 100644 index 000000000000..452584225c96 --- /dev/null +++ b/reference/sodium/functions/sodium-crypto-aead-aegis128l-decrypt.xml @@ -0,0 +1,96 @@ + + + + + sodium_crypto_aead_aegis128l_decrypt + Verify then decrypt a message with AEGIS-128L + + + + &reftitle.description; + + stringfalsesodium_crypto_aead_aegis128l_decrypt + stringciphertext + stringadditional_data + stringnonce + #[\SensitiveParameter]stringkey + + + Verify then decrypt a message with AEGIS-128L. + + + + + &reftitle.parameters; + + + ciphertext + + + Must be in the format provided by sodium_crypto_aead_aegis128l_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 (128-bit). + + + + + + + + &reftitle.returnvalues; + + Returns the plaintext on success, &return.falseforfailure;. + + + + + &reftitle.seealso; + + sodium_crypto_aead_aegis128l_encrypt + sodium_crypto_aead_aegis128l_keygen + + + + diff --git a/reference/sodium/functions/sodium-crypto-aead-aegis128l-encrypt.xml b/reference/sodium/functions/sodium-crypto-aead-aegis128l-encrypt.xml new file mode 100644 index 000000000000..0b33f7d352b6 --- /dev/null +++ b/reference/sodium/functions/sodium-crypto-aead-aegis128l-encrypt.xml @@ -0,0 +1,96 @@ + + + + + sodium_crypto_aead_aegis128l_encrypt + Encrypt then authenticate a message with AEGIS-128L + + + + &reftitle.description; + + stringsodium_crypto_aead_aegis128l_encrypt + #[\SensitiveParameter]stringmessage + stringadditional_data + stringnonce + #[\SensitiveParameter]stringkey + + + Encrypt then authenticate a message with AEGIS-128L. + + + + + &reftitle.parameters; + + + message + + + The plaintext message to 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 (128-bit). + + + + + + + + &reftitle.returnvalues; + + Returns the ciphertext and authentication tag as a string of raw binary bytes. + + + + + &reftitle.seealso; + + sodium_crypto_aead_aegis128l_decrypt + sodium_crypto_aead_aegis128l_keygen + + + + diff --git a/reference/sodium/functions/sodium-crypto-aead-aegis128l-keygen.xml b/reference/sodium/functions/sodium-crypto-aead-aegis128l-keygen.xml new file mode 100644 index 000000000000..d5e0644d7974 --- /dev/null +++ b/reference/sodium/functions/sodium-crypto-aead-aegis128l-keygen.xml @@ -0,0 +1,60 @@ + + + + + sodium_crypto_aead_aegis128l_keygen + Generate a random AEGIS-128L key + + + + &reftitle.description; + + stringsodium_crypto_aead_aegis128l_keygen + + + + Generate a random key for use with sodium_crypto_aead_aegis128l_encrypt and + sodium_crypto_aead_aegis128l_decrypt. + + + + + &reftitle.parameters; + &no.function.parameters; + + + + &reftitle.returnvalues; + + Returns a 128-bit random key. + + + + + &reftitle.seealso; + + sodium_crypto_aead_aegis128l_decrypt + sodium_crypto_aead_aegis128l_encrypt + + + + diff --git a/reference/sodium/functions/sodium-crypto-aead-aegis256-decrypt.xml b/reference/sodium/functions/sodium-crypto-aead-aegis256-decrypt.xml new file mode 100644 index 000000000000..37f21f0659e7 --- /dev/null +++ b/reference/sodium/functions/sodium-crypto-aead-aegis256-decrypt.xml @@ -0,0 +1,96 @@ + + + + + sodium_crypto_aead_aegis256_decrypt + Verify then decrypt a message with AEGIS-256 + + + + &reftitle.description; + + stringfalsesodium_crypto_aead_aegis256_decrypt + stringciphertext + stringadditional_data + stringnonce + #[\SensitiveParameter]stringkey + + + Verify then decrypt a message with AEGIS-256. + + + + + &reftitle.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). + + + + + + + + &reftitle.returnvalues; + + Returns the plaintext on success, &return.falseforfailure;. + + + + + &reftitle.seealso; + + sodium_crypto_aead_aegis256_encrypt + sodium_crypto_aead_aegis256_keygen + + + + diff --git a/reference/sodium/functions/sodium-crypto-aead-aegis256-encrypt.xml b/reference/sodium/functions/sodium-crypto-aead-aegis256-encrypt.xml new file mode 100644 index 000000000000..cf3c13f6c29b --- /dev/null +++ b/reference/sodium/functions/sodium-crypto-aead-aegis256-encrypt.xml @@ -0,0 +1,96 @@ + + + + + sodium_crypto_aead_aegis256_encrypt + Encrypt then authenticate a message with AEGIS-256 + + + + &reftitle.description; + + stringsodium_crypto_aead_aegis256_encrypt + #[\SensitiveParameter]stringmessage + stringadditional_data + stringnonce + #[\SensitiveParameter]stringkey + + + Encrypt then authenticate a message with AEGIS-256. + + + + + &reftitle.parameters; + + + message + + + The plaintext message to 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). + + + + + + + + &reftitle.returnvalues; + + Returns the ciphertext and authentication tag as a string of raw binary bytes. + + + + + &reftitle.seealso; + + sodium_crypto_aead_aegis256_decrypt + sodium_crypto_aead_aegis256_keygen + + + + diff --git a/reference/sodium/functions/sodium-crypto-aead-aegis256-keygen.xml b/reference/sodium/functions/sodium-crypto-aead-aegis256-keygen.xml new file mode 100644 index 000000000000..0953540a5867 --- /dev/null +++ b/reference/sodium/functions/sodium-crypto-aead-aegis256-keygen.xml @@ -0,0 +1,60 @@ + + + + + sodium_crypto_aead_aegis256_keygen + Generate a random AEGIS-256 key + + + + &reftitle.description; + + stringsodium_crypto_aead_aegis256_keygen + + + + Generate a random key for use with sodium_crypto_aead_aegis256_encrypt and + sodium_crypto_aead_aegis256_decrypt. + + + + + &reftitle.parameters; + &no.function.parameters; + + + + &reftitle.returnvalues; + + Returns a 256-bit random key. + + + + + &reftitle.seealso; + + sodium_crypto_aead_aegis256_decrypt + sodium_crypto_aead_aegis256_encrypt + + + + diff --git a/reference/sodium/versions.xml b/reference/sodium/versions.xml index 589be141ac1e..19d33f4906a3 100644 --- a/reference/sodium/versions.xml +++ b/reference/sodium/versions.xml @@ -8,6 +8,12 @@ + + + + + +