Commit 3981d37f authored by Stephan Mueller's avatar Stephan Mueller Committed by Herbert Xu
Browse files

crypto: doc - update AEAD AD handling 



The associated data handling with the kernel crypto API has been
updated. This needs to be reflected in the documentation.

Signed-off-by: default avatarStephan Mueller <smueller@chronox.de>
Signed-off-by: default avatarHerbert Xu <herbert@gondor.apana.org.au>
parent 649e2007

Documentation/DocBook/crypto-API.tmpl

+0 −1
Original line number Diff line number Diff line
@@ -1736,7 +1736,6 @@ read(opfd, out, outlen); 
!Finclude/crypto/aead.h aead_request_free

!Finclude/crypto/aead.h aead_request_set_callback

!Finclude/crypto/aead.h aead_request_set_crypt

!Finclude/crypto/aead.h aead_request_set_assoc

!Finclude/crypto/aead.h aead_request_set_ad

   </sect1>

   <sect1><title>Synchronous Block Cipher API</title>

include/crypto/aead.h

+3 −3
Original line number Diff line number Diff line
@@ -31,10 +31,10 @@ 
 *

 * For example: authenc(hmac(sha256), cbc(aes))

 *

 * The example code provided for the asynchronous block cipher operation

 * applies here as well. Naturally all *ablkcipher* symbols must be exchanged

 * The example code provided for the symmetric key cipher operation

 * applies here as well. Naturally all *skcipher* symbols must be exchanged

 * the *aead* pendants discussed in the following. In addition, for the AEAD

 * operation, the aead_request_set_assoc function must be used to set the

 * operation, the aead_request_set_ad function must be used to set the

 * pointer to the associated data memory location before performing the

 * encryption or decryption operation. In case of an encryption, the associated

 * data memory is filled during the encryption operation. For decryption, the