diff options
author | Stephan Mueller <smueller@chronox.de> | 2015-08-03 09:08:05 +0200 |
---|---|---|
committer | Herbert Xu <herbert@gondor.apana.org.au> | 2015-08-04 17:41:33 +0800 |
commit | f6e45c24f401f3d0e648bfba304c83b64d763559 (patch) | |
tree | e7683ebfea775e14897211d9cfe96126f37761af /include/crypto | |
parent | 327cbbabfb77c321fb9f21068c18e6bb951d07a7 (diff) | |
download | op-kernel-dev-f6e45c24f401f3d0e648bfba304c83b64d763559.zip op-kernel-dev-f6e45c24f401f3d0e648bfba304c83b64d763559.tar.gz |
crypto: doc - AEAD API conversion
The AEAD API changes are now reflected in the crypto API doc book.
Signed-off-by: Stephan Mueller <smueller@chronox.de>
Signed-off-by: Herbert Xu <herbert@gondor.apana.org.au>
Diffstat (limited to 'include/crypto')
-rw-r--r-- | include/crypto/aead.h | 24 |
1 files changed, 24 insertions, 0 deletions
diff --git a/include/crypto/aead.h b/include/crypto/aead.h index 7169ad0..14e35364 100644 --- a/include/crypto/aead.h +++ b/include/crypto/aead.h @@ -45,6 +45,30 @@ * a breach in the integrity of the message. In essence, that -EBADMSG error * code is the key bonus an AEAD cipher has over "standard" block chaining * modes. + * + * Memory Structure: + * + * To support the needs of the most prominent user of AEAD ciphers, namely + * IPSEC, the AEAD ciphers have a special memory layout the caller must adhere + * to. + * + * The scatter list pointing to the input data must contain: + * + * * for RFC4106 ciphers, the concatenation of + * associated authentication data || IV || plaintext or ciphertext. Note, the + * same IV (buffer) is also set with the aead_request_set_crypt call. Note, + * the API call of aead_request_set_ad must provide the length of the AAD and + * the IV. The API call of aead_request_set_crypt only points to the size of + * the input plaintext or ciphertext. + * + * * for "normal" AEAD ciphers, the concatenation of + * associated authentication data || plaintext or ciphertext. + * + * It is important to note that if multiple scatter gather list entries form + * the input data mentioned above, the first entry must not point to a NULL + * buffer. If there is any potential where the AAD buffer can be NULL, the + * calling code must contain a precaution to ensure that this does not result + * in the first scatter gather list entry pointing to a NULL buffer. */ /** |