Cipher.DecryptAEAD(Byte[], Byte[], Byte[], Byte[], AeadAlgorithm, Cipher.Opts) Method
Decrypt data using the AES-GCM authenticated encryption algorithm with AAD and options.
Syntax
[C#]
public static byte[] DecryptAEAD(
byte[] input,
byte[] key,
byte[] iv,
byte[] aad,
AeadAlgorithm aeadAlg,
Cipher.Opts opts
)
[VB]
Public Shared Function DecryptAEAD (
input As Byte(),
key As Byte(),
iv As Byte(),
aad As Byte(),
aeadAlg As AeadAlgorithm,
opts As Cipher.Opts
) As Byte()
Parameters
- input Byte
- Input data to be decrypted.
- key Byte
- Key of exact length for algorithm (16, 24 or 32 bytes).
- iv Byte
- Initialization Vector (IV) (aka nonce) exactly 12 bytes long, if not provided in input.
- aad Byte
- Additional authenticated data (optional) - set as null to ignore.
- aeadAlg AeadAlgorithm
- Authenticated encryption algorithm.
- opts Cipher.Opts
- Advanced options. Use Cipher.Opts.PrefixIV to expect the IV to be prepended at the start of the input.
Return Value
BytePlaintext in a byte array, or empty array on error (an empty array may also be the correct result - check
General.ErrorCode for details).
Remarks
The input must include the 16-byte tag appended to the ciphertext and may include a 12-byte prefixed IV.
The output will either be exactly 16 bytes shorter than the input, or exactly 28 bytes shorter if the Cipher.Opts.PrefixIV option is used.
In all cases the IV must be exactly 12 bytes (96 bits) and the tag must be exactly 16 bytes (128 bits).
If additional authentication data (AAD) was provided during encryption then the exact same AAD data must be provided here.
See Also
VB6/C equivalent: CIPHER_DecryptAEAD
[Contents] [Index]