include/crypto/aead.h

18  * DOC: Authenticated Encryption With Associated Data (AEAD) Cipher API
20  * The AEAD cipher API is used with the ciphers of type CRYPTO_ALG_TYPE_AEAD
25  * with the following cipher string:
27  *	authenc(keyed message digest, block cipher)
31  * The example code provided for the symmetric key cipher operation applies
36  * decryption operation. Another deviation from the asynchronous block cipher
40  * code is the key bonus an AEAD cipher has over "standard" block chaining
121  * struct aead_alg - AEAD cipher definition
152  * @base: Definition of a generic crypto cipher algorithm.
189  * crypto_alloc_aead() - allocate AEAD cipher handle
191  *	     AEAD cipher
192  * @type: specifies the type of the cipher
193  * @mask: specifies the mask for the cipher
195  * Allocate a cipher handle for an AEAD. The returned struct
196  * crypto_aead is the cipher handle that is required for any subsequent
199  * Return: allocated cipher handle in case of success; IS_ERR() is true in case
211  * @tfm: cipher handle to be freed
238  * @tfm: cipher handle
240  * The size of the IV for the aead referenced by the cipher handle is
241  * returned. This IV size may be zero if the cipher does not need an IV.
252  * @tfm: cipher handle
254  * The maximum size of the authentication data for the AEAD cipher referenced
255  * by the AEAD cipher handle is returned. The authentication data size may be
256  * zero if the cipher implements a hard-coded maximum.
278  * crypto_aead_blocksize() - obtain block size of cipher
279  * @tfm: cipher handle
281  * The block size for the AEAD referenced with the cipher handle is returned.
285  * Return: block size of cipher
313  * crypto_aead_setkey() - set key for cipher
314  * @tfm: cipher handle
318  * The caller provided key is set for the AEAD referenced by the cipher
321  * Note, the key length determines the cipher type. Many block ciphers implement
322  * different cipher modes depending on the key size, such as AES-128 vs AES-192
323  * vs. AES-256. When providing a 16 byte key for an AES cipher handle, AES-128
333  * @tfm: cipher handle
351  *	 needed to perform the cipher operation
360  *		  block cipher blocks + the size defined by the
365  * Return: 0 if the cipher operation was successful; < 0 if an error occurred
372  *	 needed to perform the cipher operation
384  * Return: 0 if the cipher operation was successful; -EBADMSG: The AEAD
385  *	   cipher operation performs the authentication of the data during the
397  * the AEAD cipher operation. This includes the cipher handle (which can be
406  * @tfm: cipher handle
416  * aead_request_set_tfm() - update cipher handle reference in request
418  * @tfm: cipher handle that shall be added to the request handle
431  * @tfm: cipher handle to be registered with the request
455  * @req: request data structure cipher handle to be freed
479  * Setting the callback function that is triggered once the cipher operation
503  * @iv: IV for the cipher operation which must comply with the IV size defined
514  * The memory structure for cipher operation has the following structure:
524  * use an in-place cipher operation (i.e. same memory location for