sphinx.addnodesdocument)}( rawsourcechildren]( translations LanguagesNode)}(hhh](h pending_xref)}(hhh]docutils.nodesTextChinese (Simplified)}parenthsba attributes}(ids]classes]names]dupnames]backrefs] refdomainstdreftypedoc reftarget#/translations/zh_CN/crypto/api-aeadmodnameN classnameN refexplicitutagnamehhh ubh)}(hhh]hChinese (Traditional)}hh2sbah}(h]h ]h"]h$]h&] refdomainh)reftypeh+ reftarget#/translations/zh_TW/crypto/api-aeadmodnameN classnameN refexplicituh1hhh ubh)}(hhh]hItalian}hhFsbah}(h]h ]h"]h$]h&] refdomainh)reftypeh+ reftarget#/translations/it_IT/crypto/api-aeadmodnameN classnameN refexplicituh1hhh ubh)}(hhh]hJapanese}hhZsbah}(h]h ]h"]h$]h&] refdomainh)reftypeh+ reftarget#/translations/ja_JP/crypto/api-aeadmodnameN classnameN refexplicituh1hhh ubh)}(hhh]hKorean}hhnsbah}(h]h ]h"]h$]h&] refdomainh)reftypeh+ reftarget#/translations/ko_KR/crypto/api-aeadmodnameN classnameN refexplicituh1hhh ubh)}(hhh]hPortuguese (Brazilian)}hhsbah}(h]h ]h"]h$]h&] refdomainh)reftypeh+ reftarget#/translations/pt_BR/crypto/api-aeadmodnameN classnameN refexplicituh1hhh ubh)}(hhh]hSpanish}hhsbah}(h]h ]h"]h$]h&] refdomainh)reftypeh+ reftarget#/translations/sp_SP/crypto/api-aeadmodnameN classnameN refexplicituh1hhh ubeh}(h]h ]h"]h$]h&]current_languageEnglishuh1h hh _documenthsourceNlineNubhsection)}(hhh](htitle)}(h4Authenticated Encryption With Associated Data (AEAD)h]h4Authenticated Encryption With Associated Data (AEAD)}(hhhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhhh=/var/lib/git/docbuild/linux/Documentation/crypto/api-aead.rsthKubh)}(hhh](h)}(hJAuthenticated Encryption With Associated Data (AEAD) Algorithm Definitionsh]hJAuthenticated Encryption With Associated Data (AEAD) Algorithm Definitions}(hhhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhhhhhKubh paragraph)}(hqThe AEAD cipher API is used with the ciphers of type CRYPTO_ALG_TYPE_AEAD (listed as type "aead" in /proc/crypto)h]huThe AEAD cipher API is used with the ciphers of type CRYPTO_ALG_TYPE_AEAD (listed as type “aead” in /proc/crypto)}(hhhhhNhNubah}(h]h ]h"]h$]h&]uh1hhT/var/lib/git/docbuild/linux/Documentation/crypto/api-aead:7: ./include/crypto/aead.hhKhhhhubh)}(hThe most prominent examples for this type of encryption is GCM and CCM. However, the kernel supports other types of AEAD ciphers which are defined with the following cipher string:h]hThe most prominent examples for this type of encryption is GCM and CCM. However, the kernel supports other types of AEAD ciphers which are defined with the following cipher string:}(hhhhhNhNubah}(h]h ]h"]h$]h&]uh1hhT/var/lib/git/docbuild/linux/Documentation/crypto/api-aead:7: ./include/crypto/aead.hhKhhhhubh block_quote)}(h,authenc(keyed message digest, block cipher) h]h)}(h+authenc(keyed message digest, block cipher)h]h+authenc(keyed message digest, block cipher)}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhT/var/lib/git/docbuild/linux/Documentation/crypto/api-aead:7: ./include/crypto/aead.hhKhhubah}(h]h ]h"]h$]h&]uh1hhjhKhhhhubh)}(h,For example: authenc(hmac(sha256), cbc(aes))h]h,For example: authenc(hmac(sha256), cbc(aes))}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhT/var/lib/git/docbuild/linux/Documentation/crypto/api-aead:7: ./include/crypto/aead.hhKhhhhubh)}(hXThe 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_ad function must be used to set the pointer to the associated data memory location before performing the encryption or decryption operation. Another deviation from the asynchronous block cipher operation is that the caller should explicitly check for -EBADMSG of the crypto_aead_decrypt. That error indicates an authentication error, i.e. 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.h](heThe example code provided for the symmetric key cipher operation applies here as well. Naturally all }(hj&hhhNhNubhemphasis)}(h *skcipher*h]hskcipher}(hj0hhhNhNubah}(h]h ]h"]h$]h&]uh1j.hj&ubh symbols must be exchanged the }(hj&hhhNhNubj/)}(h*aead*h]haead}(hjBhhhNhNubah}(h]h ]h"]h$]h&]uh1j.hj&ubhXO pendants discussed in the following. In addition, for the AEAD 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. Another deviation from the asynchronous block cipher operation is that the caller should explicitly check for -EBADMSG of the crypto_aead_decrypt. That error indicates an authentication error, i.e. 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.}(hj&hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhT/var/lib/git/docbuild/linux/Documentation/crypto/api-aead:7: ./include/crypto/aead.hhKhhhhubh)}(hMemory Structure:h]hMemory Structure:}(hj[hhhNhNubah}(h]h ]h"]h$]h&]uh1hhT/var/lib/git/docbuild/linux/Documentation/crypto/api-aead:7: ./include/crypto/aead.hhK)hhhhubh)}(hdThe source scatterlist must contain the concatenation of associated data || plaintext or ciphertext.h]hdThe source scatterlist must contain the concatenation of associated data || plaintext or ciphertext.}(hjjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhT/var/lib/git/docbuild/linux/Documentation/crypto/api-aead:7: ./include/crypto/aead.hhK+hhhhubh)}(hXThe destination scatterlist has the same layout, except that the plaintext (resp. ciphertext) will grow (resp. shrink) by the authentication tag size during encryption (resp. decryption). The authentication tag is generated during the encryption operation and appended to the ciphertext. During decryption, the authentication tag is consumed along with the ciphertext and used to verify the integrity of the plaintext and the associated data.h]hXThe destination scatterlist has the same layout, except that the plaintext (resp. ciphertext) will grow (resp. shrink) by the authentication tag size during encryption (resp. decryption). The authentication tag is generated during the encryption operation and appended to the ciphertext. During decryption, the authentication tag is consumed along with the ciphertext and used to verify the integrity of the plaintext and the associated data.}(hjyhhhNhNubah}(h]h ]h"]h$]h&]uh1hhT/var/lib/git/docbuild/linux/Documentation/crypto/api-aead:7: ./include/crypto/aead.hhK.hhhhubh)}(htIn-place encryption/decryption is enabled by using the same scatterlist pointer for both the source and destination.h]htIn-place encryption/decryption is enabled by using the same scatterlist pointer for both the source and destination.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhT/var/lib/git/docbuild/linux/Documentation/crypto/api-aead:7: ./include/crypto/aead.hhK5hhhhubh)}(hX&Even in the out-of-place case, space must be reserved in the destination for the associated data, even though it won't be written to. This makes the in-place and out-of-place cases more consistent. It is permissible for the "destination" associated data to alias the "source" associated data.h]hX0Even in the out-of-place case, space must be reserved in the destination for the associated data, even though it won’t be written to. This makes the in-place and out-of-place cases more consistent. It is permissible for the “destination” associated data to alias the “source” associated data.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhT/var/lib/git/docbuild/linux/Documentation/crypto/api-aead:7: ./include/crypto/aead.hhK8hhhhubh)}(hAs with the other scatterlist crypto APIs, zero-length scatterlist elements are not allowed in the used part of the scatterlist. Thus, if there is no associated data, the first element must point to the plaintext/ciphertext.h]hAs with the other scatterlist crypto APIs, zero-length scatterlist elements are not allowed in the used part of the scatterlist. Thus, if there is no associated data, the first element must point to the plaintext/ciphertext.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhT/var/lib/git/docbuild/linux/Documentation/crypto/api-aead:7: ./include/crypto/aead.hhK=hhhhubh)}(hX0To meet the needs of IPsec, a special quirk applies to rfc4106, rfc4309, rfc4543, and rfc7539esp ciphers. For these ciphers, the final 'ivsize' bytes of the associated data buffer must contain a second copy of the IV. This is in addition to the copy passed to aead_request_set_crypt(). These two IV copies must not differ; different implementations of the same algorithm may behave differently in that case. Note that the algorithm might not actually treat the IV as associated data; nevertheless the length passed to aead_request_set_ad() must include it.h]hX4To meet the needs of IPsec, a special quirk applies to rfc4106, rfc4309, rfc4543, and rfc7539esp ciphers. For these ciphers, the final ‘ivsize’ bytes of the associated data buffer must contain a second copy of the IV. This is in addition to the copy passed to aead_request_set_crypt(). These two IV copies must not differ; different implementations of the same algorithm may behave differently in that case. Note that the algorithm might not actually treat the IV as associated data; nevertheless the length passed to aead_request_set_ad() must include it.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhT/var/lib/git/docbuild/linux/Documentation/crypto/api-aead:7: ./include/crypto/aead.hhKAhhhhubhindex)}(hhh]h}(h]h ]h"]h$]h&]entries](singleaead_request (C struct)c.aead_requesthNtauh1jhhhhhU/var/lib/git/docbuild/linux/Documentation/crypto/api-aead:10: ./include/crypto/aead.hhNubhdesc)}(hhh](hdesc_signature)}(h aead_requesth]hdesc_signature_line)}(hstruct aead_requesth](hdesc_sig_keyword)}(hstructh]hstruct}(hjhhhNhNubah}(h]h ]kah"]h$]h&]uh1jhjhhhU/var/lib/git/docbuild/linux/Documentation/crypto/api-aead:10: ./include/crypto/aead.hhKubhdesc_sig_space)}(h h]h }(hjhhhNhNubah}(h]h ]wah"]h$]h&]uh1jhjhhhjhKubh desc_name)}(h aead_requesth]h desc_sig_name)}(hjh]h aead_request}(hjhhhNhNubah}(h]h ]nah"]h$]h&]uh1jhj ubah}(h]h ](sig-namedescnameeh"]h$]h&] xml:spacepreserveuh1j hjhhhjhKubeh}(h]h ]h"]h$]h&]j(j) add_permalinkuh1jsphinx_line_type declaratorhjhhhjhKubah}(h]jah ](sig sig-objecteh"]h$]h&] is_multiline _toc_parts) _toc_namehuh1jhjhKhjhhubh desc_content)}(hhh]h)}(h AEAD requesth]h AEAD request}(hjChhhNhNubah}(h]h ]h"]h$]h&]uh1hhU/var/lib/git/docbuild/linux/Documentation/crypto/api-aead:10: ./include/crypto/aead.hhKQhj@hhubah}(h]h ]h"]h$]h&]uh1j>hjhhhjhKubeh}(h]h ](cstructeh"]h$]h&]domainj[objtypej\desctypej\noindex noindexentrynocontentsentryuh1jhhhhhjhNubh container)}(hX6**Definition**:: struct aead_request { struct crypto_async_request base; unsigned int assoclen; unsigned int cryptlen; u8 *iv; struct scatterlist *src; struct scatterlist *dst; void *__ctx[]; }; **Members** ``base`` Common attributes for async crypto requests ``assoclen`` Length in bytes of associated data for authentication ``cryptlen`` Length of data to be encrypted or decrypted ``iv`` Initialisation vector ``src`` Source data ``dst`` Destination data ``__ctx`` Start of private context datah](h)}(h**Definition**::h](hstrong)}(h**Definition**h]h Definition}(hjrhhhNhNubah}(h]h ]h"]h$]h&]uh1jphjlubh:}(hjlhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhU/var/lib/git/docbuild/linux/Documentation/crypto/api-aead:10: ./include/crypto/aead.hhKUhjhubh literal_block)}(hstruct aead_request { struct crypto_async_request base; unsigned int assoclen; unsigned int cryptlen; u8 *iv; struct scatterlist *src; struct scatterlist *dst; void *__ctx[]; };h]hstruct aead_request { struct crypto_async_request base; unsigned int assoclen; unsigned int cryptlen; u8 *iv; struct scatterlist *src; struct scatterlist *dst; void *__ctx[]; };}hjsbah}(h]h ]h"]h$]h&]j(j)uh1jhU/var/lib/git/docbuild/linux/Documentation/crypto/api-aead:10: ./include/crypto/aead.hhKWhjhubh)}(h **Members**h]jq)}(hjh]hMembers}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jphjubah}(h]h ]h"]h$]h&]uh1hhU/var/lib/git/docbuild/linux/Documentation/crypto/api-aead:10: ./include/crypto/aead.hhKahjhubhdefinition_list)}(hhh](hdefinition_list_item)}(h5``base`` Common attributes for async crypto requests h](hterm)}(h``base``h]hliteral)}(hjh]hbase}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]uh1jhU/var/lib/git/docbuild/linux/Documentation/crypto/api-aead:10: ./include/crypto/aead.hhKShjubh definition)}(hhh]h)}(h+Common attributes for async crypto requestsh]h+Common attributes for async crypto requests}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhKShjubah}(h]h ]h"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]uh1jhjhKShjubj)}(hC``assoclen`` Length in bytes of associated data for authentication h](j)}(h ``assoclen``h]j)}(hjh]hassoclen}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]uh1jhU/var/lib/git/docbuild/linux/Documentation/crypto/api-aead:10: ./include/crypto/aead.hhKThjubj)}(hhh]h)}(h5Length in bytes of associated data for authenticationh]h5Length in bytes of associated data for authentication}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhKThjubah}(h]h ]h"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]uh1jhjhKThjubj)}(h9``cryptlen`` Length of data to be encrypted or decrypted h](j)}(h ``cryptlen``h]j)}(hj9h]hcryptlen}(hj;hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj7ubah}(h]h ]h"]h$]h&]uh1jhU/var/lib/git/docbuild/linux/Documentation/crypto/api-aead:10: ./include/crypto/aead.hhKUhj3ubj)}(hhh]h)}(h+Length of data to be encrypted or decryptedh]h+Length of data to be encrypted or decrypted}(hjRhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjNhKUhjOubah}(h]h ]h"]h$]h&]uh1jhj3ubeh}(h]h ]h"]h$]h&]uh1jhjNhKUhjubj)}(h``iv`` Initialisation vector h](j)}(h``iv``h]j)}(hjrh]hiv}(hjthhhNhNubah}(h]h ]h"]h$]h&]uh1jhjpubah}(h]h ]h"]h$]h&]uh1jhU/var/lib/git/docbuild/linux/Documentation/crypto/api-aead:10: ./include/crypto/aead.hhKVhjlubj)}(hhh]h)}(hInitialisation vectorh]hInitialisation vector}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhKVhjubah}(h]h ]h"]h$]h&]uh1jhjlubeh}(h]h ]h"]h$]h&]uh1jhjhKVhjubj)}(h``src`` Source data h](j)}(h``src``h]j)}(hjh]hsrc}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]uh1jhU/var/lib/git/docbuild/linux/Documentation/crypto/api-aead:10: ./include/crypto/aead.hhKWhjubj)}(hhh]h)}(h Source datah]h Source data}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhKWhjubah}(h]h ]h"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]uh1jhjhKWhjubj)}(h``dst`` Destination data h](j)}(h``dst``h]j)}(hjh]hdst}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]uh1jhU/var/lib/git/docbuild/linux/Documentation/crypto/api-aead:10: ./include/crypto/aead.hhKXhjubj)}(hhh]h)}(hDestination datah]hDestination data}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhKXhjubah}(h]h ]h"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]uh1jhjhKXhjubj)}(h'``__ctx`` Start of private context datah](j)}(h ``__ctx``h]j)}(hjh]h__ctx}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]uh1jhU/var/lib/git/docbuild/linux/Documentation/crypto/api-aead:10: ./include/crypto/aead.hhKXhjubj)}(hhh]h)}(hStart of private context datah]hStart of private context data}(hj6hhhNhNubah}(h]h ]h"]h$]h&]uh1hhU/var/lib/git/docbuild/linux/Documentation/crypto/api-aead:10: ./include/crypto/aead.hhKYhj3ubah}(h]h ]h"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]uh1jhj2hKXhjubeh}(h]h ]h"]h$]h&]uh1jhjhubeh}(h]h ] kernelindentah"]h$]h&]uh1jfhhhhhjhNubj)}(hhh]h}(h]h ]h"]h$]h&]entries](jaead_alg (C struct) c.aead_alghNtauh1jhhhhhjhNubj)}(hhh](j)}(haead_algh]j)}(hstruct aead_algh](j)}(hjh]hstruct}(hjwhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjshhhU/var/lib/git/docbuild/linux/Documentation/crypto/api-aead:10: ./include/crypto/aead.hhK_ubj)}(h h]h }(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjshhhjhK_ubj )}(haead_algh]j)}(hjqh]haead_alg}(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjubah}(h]h ](j#j$eh"]h$]h&]j(j)uh1j hjshhhjhK_ubeh}(h]h ]h"]h$]h&]j(j)j0uh1jj1j2hjohhhjhK_ubah}(h]jjah ](j6j7eh"]h$]h&]j;j<)j=huh1jhjhK_hjlhhubj?)}(hhh]h)}(hAEAD cipher definitionh]hAEAD cipher definition}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhU/var/lib/git/docbuild/linux/Documentation/crypto/api-aead:10: ./include/crypto/aead.hhKihjhhubah}(h]h ]h"]h$]h&]uh1j>hjlhhhjhK_ubeh}(h]h ](j[structeh"]h$]h&]j`j[jajjbjjcjdjeuh1jhhhhhjhNubjg)}(hXr**Definition**:: struct aead_alg { int (*setkey)(struct crypto_aead *tfm, const u8 *key, unsigned int keylen); int (*setauthsize)(struct crypto_aead *tfm, unsigned int authsize); int (*encrypt)(struct aead_request *req); int (*decrypt)(struct aead_request *req); int (*init)(struct crypto_aead *tfm); void (*exit)(struct crypto_aead *tfm); unsigned int ivsize; unsigned int maxauthsize; unsigned int chunksize; struct crypto_alg base; }; **Members** ``setkey`` see struct skcipher_alg ``setauthsize`` Set authentication size for the AEAD transformation. This function is used to specify the consumer requested size of the authentication tag to be either generated by the transformation during encryption or the size of the authentication tag to be supplied during the decryption operation. This function is also responsible for checking the authentication tag size for validity. ``encrypt`` see struct skcipher_alg ``decrypt`` see struct skcipher_alg ``init`` Initialize the cryptographic transformation object. This function is used to initialize the cryptographic transformation object. This function is called only once at the instantiation time, right after the transformation context was allocated. In case the cryptographic hardware has some special requirements which need to be handled by software, this function shall check for the precise requirement of the transformation and put any software fallbacks in place. ``exit`` Deinitialize the cryptographic transformation object. This is a counterpart to **init**, used to remove various changes set in **init**. ``ivsize`` see struct skcipher_alg ``maxauthsize`` Set the maximum authentication tag size supported by the transformation. A transformation may support smaller tag sizes. As the authentication tag is a message digest to ensure the integrity of the encrypted data, a consumer typically wants the largest authentication tag possible as defined by this variable. ``chunksize`` see struct skcipher_alg ``base`` Definition of a generic crypto cipher algorithm.h](h)}(h**Definition**::h](jq)}(h**Definition**h]h Definition}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jphjubh:}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhU/var/lib/git/docbuild/linux/Documentation/crypto/api-aead:10: ./include/crypto/aead.hhKmhjubj)}(hXstruct aead_alg { int (*setkey)(struct crypto_aead *tfm, const u8 *key, unsigned int keylen); int (*setauthsize)(struct crypto_aead *tfm, unsigned int authsize); int (*encrypt)(struct aead_request *req); int (*decrypt)(struct aead_request *req); int (*init)(struct crypto_aead *tfm); void (*exit)(struct crypto_aead *tfm); unsigned int ivsize; unsigned int maxauthsize; unsigned int chunksize; struct crypto_alg base; };h]hXstruct aead_alg { int (*setkey)(struct crypto_aead *tfm, const u8 *key, unsigned int keylen); int (*setauthsize)(struct crypto_aead *tfm, unsigned int authsize); int (*encrypt)(struct aead_request *req); int (*decrypt)(struct aead_request *req); int (*init)(struct crypto_aead *tfm); void (*exit)(struct crypto_aead *tfm); unsigned int ivsize; unsigned int maxauthsize; unsigned int chunksize; struct crypto_alg base; };}hjsbah}(h]h ]h"]h$]h&]j(j)uh1jhU/var/lib/git/docbuild/linux/Documentation/crypto/api-aead:10: ./include/crypto/aead.hhKohjubh)}(h **Members**h]jq)}(hjh]hMembers}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1jphjubah}(h]h ]h"]h$]h&]uh1hhU/var/lib/git/docbuild/linux/Documentation/crypto/api-aead:10: ./include/crypto/aead.hhK|hjubj)}(hhh](j)}(h#``setkey`` see struct skcipher_alg h](j)}(h ``setkey``h]j)}(hj&h]hsetkey}(hj(hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj$ubah}(h]h ]h"]h$]h&]uh1jhU/var/lib/git/docbuild/linux/Documentation/crypto/api-aead:10: ./include/crypto/aead.hhKxhj ubj)}(hhh]h)}(hsee struct skcipher_algh]hsee struct skcipher_alg}(hj?hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj;hKxhj<ubah}(h]h ]h"]h$]h&]uh1jhj ubeh}(h]h ]h"]h$]h&]uh1jhj;hKxhjubj)}(hX``setauthsize`` Set authentication size for the AEAD transformation. This function is used to specify the consumer requested size of the authentication tag to be either generated by the transformation during encryption or the size of the authentication tag to be supplied during the decryption operation. This function is also responsible for checking the authentication tag size for validity. h](j)}(h``setauthsize``h]j)}(hj_h]h setauthsize}(hjahhhNhNubah}(h]h ]h"]h$]h&]uh1jhj]ubah}(h]h ]h"]h$]h&]uh1jhU/var/lib/git/docbuild/linux/Documentation/crypto/api-aead:10: ./include/crypto/aead.hhKwhjYubj)}(hhh]h)}(hXySet authentication size for the AEAD transformation. This function is used to specify the consumer requested size of the authentication tag to be either generated by the transformation during encryption or the size of the authentication tag to be supplied during the decryption operation. This function is also responsible for checking the authentication tag size for validity.h]hXySet authentication size for the AEAD transformation. This function is used to specify the consumer requested size of the authentication tag to be either generated by the transformation during encryption or the size of the authentication tag to be supplied during the decryption operation. This function is also responsible for checking the authentication tag size for validity.}(hjxhhhNhNubah}(h]h ]h"]h$]h&]uh1hhU/var/lib/git/docbuild/linux/Documentation/crypto/api-aead:10: ./include/crypto/aead.hhKqhjuubah}(h]h ]h"]h$]h&]uh1jhjYubeh}(h]h ]h"]h$]h&]uh1jhjthKwhjubj)}(h$``encrypt`` see struct skcipher_alg h](j)}(h ``encrypt``h]j)}(hjh]hencrypt}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]uh1jhU/var/lib/git/docbuild/linux/Documentation/crypto/api-aead:10: ./include/crypto/aead.hhKyhjubj)}(hhh]h)}(hsee struct skcipher_algh]hsee struct skcipher_alg}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhKyhjubah}(h]h ]h"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]uh1jhjhKyhjubj)}(h$``decrypt`` see struct skcipher_alg h](j)}(h ``decrypt``h]j)}(hjh]hdecrypt}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]uh1jhU/var/lib/git/docbuild/linux/Documentation/crypto/api-aead:10: ./include/crypto/aead.hhKzhjubj)}(hhh]h)}(hsee struct skcipher_algh]hsee struct skcipher_alg}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhKzhjubah}(h]h ]h"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]uh1jhjhKzhjubj)}(hX``init`` Initialize the cryptographic transformation object. This function is used to initialize the cryptographic transformation object. This function is called only once at the instantiation time, right after the transformation context was allocated. In case the cryptographic hardware has some special requirements which need to be handled by software, this function shall check for the precise requirement of the transformation and put any software fallbacks in place. h](j)}(h``init``h]j)}(hj h]hinit}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj ubah}(h]h ]h"]h$]h&]uh1jhU/var/lib/git/docbuild/linux/Documentation/crypto/api-aead:10: ./include/crypto/aead.hhKhjubj)}(hhh]h)}(hXInitialize the cryptographic transformation object. This function is used to initialize the cryptographic transformation object. This function is called only once at the instantiation time, right after the transformation context was allocated. In case the cryptographic hardware has some special requirements which need to be handled by software, this function shall check for the precise requirement of the transformation and put any software fallbacks in place.h]hXInitialize the cryptographic transformation object. This function is used to initialize the cryptographic transformation object. This function is called only once at the instantiation time, right after the transformation context was allocated. In case the cryptographic hardware has some special requirements which need to be handled by software, this function shall check for the precise requirement of the transformation and put any software fallbacks in place.}(hj$hhhNhNubah}(h]h ]h"]h$]h&]uh1hhU/var/lib/git/docbuild/linux/Documentation/crypto/api-aead:10: ./include/crypto/aead.hhK}hj!ubah}(h]h ]h"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]uh1jhj hKhjubj)}(h``exit`` Deinitialize the cryptographic transformation object. This is a counterpart to **init**, used to remove various changes set in **init**. h](j)}(h``exit``h]j)}(hjEh]hexit}(hjGhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjCubah}(h]h ]h"]h$]h&]uh1jhU/var/lib/git/docbuild/linux/Documentation/crypto/api-aead:10: ./include/crypto/aead.hhKhj?ubj)}(hhh]h)}(hDeinitialize the cryptographic transformation object. This is a counterpart to **init**, used to remove various changes set in **init**.h](hODeinitialize the cryptographic transformation object. This is a counterpart to }(hj^hhhNhNubjq)}(h**init**h]hinit}(hjfhhhNhNubah}(h]h ]h"]h$]h&]uh1jphj^ubh(, used to remove various changes set in }(hj^hhhNhNubjq)}(h**init**h]hinit}(hjxhhhNhNubah}(h]h ]h"]h$]h&]uh1jphj^ubh.}(hj^hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhU/var/lib/git/docbuild/linux/Documentation/crypto/api-aead:10: ./include/crypto/aead.hhKhj[ubah}(h]h ]h"]h$]h&]uh1jhj?ubeh}(h]h ]h"]h$]h&]uh1jhjZhKhjubj)}(h#``ivsize`` see struct skcipher_alg h](j)}(h ``ivsize``h]j)}(hjh]hivsize}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]uh1jhU/var/lib/git/docbuild/linux/Documentation/crypto/api-aead:10: ./include/crypto/aead.hhK{hjubj)}(hhh]h)}(hsee struct skcipher_algh]hsee struct skcipher_alg}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhK{hjubah}(h]h ]h"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]uh1jhjhK{hjubj)}(hXF``maxauthsize`` Set the maximum authentication tag size supported by the transformation. A transformation may support smaller tag sizes. As the authentication tag is a message digest to ensure the integrity of the encrypted data, a consumer typically wants the largest authentication tag possible as defined by this variable. h](j)}(h``maxauthsize``h]j)}(hjh]h maxauthsize}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]uh1jhU/var/lib/git/docbuild/linux/Documentation/crypto/api-aead:10: ./include/crypto/aead.hhKphjubj)}(hhh]h)}(hX5Set the maximum authentication tag size supported by the transformation. A transformation may support smaller tag sizes. As the authentication tag is a message digest to ensure the integrity of the encrypted data, a consumer typically wants the largest authentication tag possible as defined by this variable.h]hX5Set the maximum authentication tag size supported by the transformation. A transformation may support smaller tag sizes. As the authentication tag is a message digest to ensure the integrity of the encrypted data, a consumer typically wants the largest authentication tag possible as defined by this variable.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhU/var/lib/git/docbuild/linux/Documentation/crypto/api-aead:10: ./include/crypto/aead.hhKkhjubah}(h]h ]h"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]uh1jhjhKphjubj)}(h&``chunksize`` see struct skcipher_alg h](j)}(h ``chunksize``h]j)}(hjh]h chunksize}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]uh1jhU/var/lib/git/docbuild/linux/Documentation/crypto/api-aead:10: ./include/crypto/aead.hhK|hjubj)}(hhh]h)}(hsee struct skcipher_algh]hsee struct skcipher_alg}(hj/hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj+hK|hj,ubah}(h]h ]h"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]uh1jhj+hK|hjubj)}(h9``base`` Definition of a generic crypto cipher algorithm.h](j)}(h``base``h]j)}(hjOh]hbase}(hjQhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjMubah}(h]h ]h"]h$]h&]uh1jhU/var/lib/git/docbuild/linux/Documentation/crypto/api-aead:10: ./include/crypto/aead.hhKhjIubj)}(hhh]h)}(h0Definition of a generic crypto cipher algorithm.h]h0Definition of a generic crypto cipher algorithm.}(hjhhhhNhNubah}(h]h ]h"]h$]h&]uh1hhU/var/lib/git/docbuild/linux/Documentation/crypto/api-aead:10: ./include/crypto/aead.hhKhjeubah}(h]h ]h"]h$]h&]uh1jhjIubeh}(h]h ]h"]h$]h&]uh1jhjdhKhjubeh}(h]h ]h"]h$]h&]uh1jhjubeh}(h]h ] kernelindentah"]h$]h&]uh1jfhhhhhjhNubh)}(h**Description**h]jq)}(hjh]h Description}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jphjubah}(h]h ]h"]h$]h&]uh1hhU/var/lib/git/docbuild/linux/Documentation/crypto/api-aead:10: ./include/crypto/aead.hhKhhhhubh)}(h=All fields except **ivsize** is mandatory and must be filled.h](hAll fields except }(hjhhhNhNubjq)}(h **ivsize**h]hivsize}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jphjubh! is mandatory and must be filled.}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhU/var/lib/git/docbuild/linux/Documentation/crypto/api-aead:10: ./include/crypto/aead.hhKhhhhubeh}(h]Hauthenticated-encryption-with-associated-data-aead-algorithm-definitionsah ]h"]Jauthenticated encryption with associated data (aead) algorithm definitionsah$]h&]uh1hhhhhhhhKubh)}(hhh](h)}(h?Authenticated Encryption With Associated Data (AEAD) Cipher APIh]h?Authenticated Encryption With Associated Data (AEAD) Cipher API}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhhhhhKubj)}(hhh]h}(h]h ]h"]h$]h&]entries](jcrypto_alloc_aead (C function)c.crypto_alloc_aeadhNtauh1jhjhhhNhNubj)}(hhh](j)}(hQstruct crypto_aead * crypto_alloc_aead (const char *alg_name, u32 type, u32 mask)h]j)}(hOstruct crypto_aead *crypto_alloc_aead(const char *alg_name, u32 type, u32 mask)h](j)}(hjh]hstruct}(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjhhhU/var/lib/git/docbuild/linux/Documentation/crypto/api-aead:16: ./include/crypto/aead.hhKubj)}(h h]h }(hj hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjhhhjhKubh)}(hhh]j)}(h crypto_aeadh]h crypto_aead}(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&] refdomainj[reftype identifier reftargetjmodnameN classnameN c:parent_keysphinx.domains.c LookupKey)}data]j5 ASTIdentifier)}j0crypto_alloc_aeadsbc.crypto_alloc_aeadasbuh1hhjhhhjhKubj)}(h h]h }(hjChhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjhhhjhKubhdesc_sig_punctuation)}(h*h]h*}(hjShhhNhNubah}(h]h ]pah"]h$]h&]uh1jQhjhhhjhKubj )}(hcrypto_alloc_aeadh]j)}(hj@h]hcrypto_alloc_aead}(hjfhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjbubah}(h]h ](j#j$eh"]h$]h&]j(j)uh1j hjhhhjhKubhdesc_parameterlist)}(h*(const char *alg_name, u32 type, u32 mask)h](hdesc_parameter)}(hconst char *alg_nameh](j)}(hconsth]hconst}(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjubj)}(h h]h }(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjubhdesc_sig_keyword_type)}(hcharh]hchar}(hjhhhNhNubah}(h]h ]ktah"]h$]h&]uh1jhjubj)}(h h]h }(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjubjR)}(hjUh]h*}(hjhhhNhNubah}(h]h ]j^ah"]h$]h&]uh1jQhjubj)}(halg_nameh]halg_name}(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]noemphj(j)uh1jhj{ubj)}(hu32 typeh](h)}(hhh]j)}(hu32h]hu32}(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&] refdomainj[reftypej0 reftargetjmodnameN classnameNj4j7)}j:]j>c.crypto_alloc_aeadasbuh1hhjubj)}(h h]h }(hj hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjubj)}(htypeh]htype}(hj hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]noemphj(j)uh1jhj{ubj)}(hu32 maskh](h)}(hhh]j)}(hu32h]hu32}(hj1 hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj. ubah}(h]h ]h"]h$]h&] refdomainj[reftypej0 reftargetj3 modnameN classnameNj4j7)}j:]j>c.crypto_alloc_aeadasbuh1hhj* ubj)}(h h]h }(hjO hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj* ubj)}(hmaskh]hmask}(hj] hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj* ubeh}(h]h ]h"]h$]h&]noemphj(j)uh1jhj{ubeh}(h]h ]h"]h$]h&]j(j)uh1jyhjhhhjhKubeh}(h]h ]h"]h$]h&]j(j)j0uh1jj1j2hjhhhjhKubah}(h]jah ](j6j7eh"]h$]h&]j;j<)j=huh1jhjhKhjhhubj?)}(hhh]h)}(hallocate AEAD cipher handleh]hallocate AEAD cipher handle}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhU/var/lib/git/docbuild/linux/Documentation/crypto/api-aead:16: ./include/crypto/aead.hhKhj hhubah}(h]h ]h"]h$]h&]uh1j>hjhhhjhKubeh}(h]h ](j[functioneh"]h$]h&]j`j[jaj jbj jcjdjeuh1jhhhjhNhNubjg)}(hX **Parameters** ``const char *alg_name`` is the cra_name / name or cra_driver_name / driver name of the AEAD cipher ``u32 type`` specifies the type of the cipher ``u32 mask`` specifies the mask for the cipher **Description** Allocate a cipher handle for an AEAD. The returned struct crypto_aead is the cipher handle that is required for any subsequent API invocation for that AEAD. **Return** allocated cipher handle in case of success; IS_ERR() is true in case of an error, PTR_ERR() returns the error code.h](h)}(h**Parameters**h]jq)}(hj h]h Parameters}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1jphj ubah}(h]h ]h"]h$]h&]uh1hhU/var/lib/git/docbuild/linux/Documentation/crypto/api-aead:16: ./include/crypto/aead.hhKhj ubj)}(hhh](j)}(hd``const char *alg_name`` is the cra_name / name or cra_driver_name / driver name of the AEAD cipher h](j)}(h``const char *alg_name``h]j)}(hj h]hconst char *alg_name}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj ubah}(h]h ]h"]h$]h&]uh1jhU/var/lib/git/docbuild/linux/Documentation/crypto/api-aead:16: ./include/crypto/aead.hhKhj ubj)}(hhh]h)}(hJis the cra_name / name or cra_driver_name / driver name of the AEAD cipherh]hJis the cra_name / name or cra_driver_name / driver name of the AEAD cipher}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhU/var/lib/git/docbuild/linux/Documentation/crypto/api-aead:16: ./include/crypto/aead.hhKhj ubah}(h]h ]h"]h$]h&]uh1jhj ubeh}(h]h ]h"]h$]h&]uh1jhj hKhj ubj)}(h.``u32 type`` specifies the type of the cipher h](j)}(h ``u32 type``h]j)}(hj h]hu32 type}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj ubah}(h]h ]h"]h$]h&]uh1jhU/var/lib/git/docbuild/linux/Documentation/crypto/api-aead:16: ./include/crypto/aead.hhKhj ubj)}(hhh]h)}(h specifies the type of the cipherh]h specifies the type of the cipher}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj hKhj ubah}(h]h ]h"]h$]h&]uh1jhj ubeh}(h]h ]h"]h$]h&]uh1jhj hKhj ubj)}(h/``u32 mask`` specifies the mask for the cipher h](j)}(h ``u32 mask``h]j)}(hj; h]hu32 mask}(hj= hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj9 ubah}(h]h ]h"]h$]h&]uh1jhU/var/lib/git/docbuild/linux/Documentation/crypto/api-aead:16: ./include/crypto/aead.hhKhj5 ubj)}(hhh]h)}(h!specifies the mask for the cipherh]h!specifies the mask for the cipher}(hjT hhhNhNubah}(h]h ]h"]h$]h&]uh1hhjP hKhjQ ubah}(h]h ]h"]h$]h&]uh1jhj5 ubeh}(h]h ]h"]h$]h&]uh1jhjP hKhj ubeh}(h]h ]h"]h$]h&]uh1jhj ubh)}(h**Description**h]jq)}(hjv h]h Description}(hjx hhhNhNubah}(h]h ]h"]h$]h&]uh1jphjt ubah}(h]h ]h"]h$]h&]uh1hhU/var/lib/git/docbuild/linux/Documentation/crypto/api-aead:16: ./include/crypto/aead.hhKhj ubh)}(hAllocate a cipher handle for an AEAD. The returned struct crypto_aead is the cipher handle that is required for any subsequent API invocation for that AEAD.h]hAllocate a cipher handle for an AEAD. The returned struct crypto_aead is the cipher handle that is required for any subsequent API invocation for that AEAD.}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhU/var/lib/git/docbuild/linux/Documentation/crypto/api-aead:16: ./include/crypto/aead.hhKhj ubh)}(h **Return**h]jq)}(hj h]hReturn}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1jphj ubah}(h]h ]h"]h$]h&]uh1hhU/var/lib/git/docbuild/linux/Documentation/crypto/api-aead:16: ./include/crypto/aead.hhKhj ubh)}(hsallocated cipher handle in case of success; IS_ERR() is true in case of an error, PTR_ERR() returns the error code.h]hsallocated cipher handle in case of success; IS_ERR() is true in case of an error, PTR_ERR() returns the error code.}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhU/var/lib/git/docbuild/linux/Documentation/crypto/api-aead:16: ./include/crypto/aead.hhKhj ubeh}(h]h ] kernelindentah"]h$]h&]uh1jfhjhhhNhNubj)}(hhh]h}(h]h ]h"]h$]h&]entries](jcrypto_free_aead (C function)c.crypto_free_aeadhNtauh1jhjhhhNhNubj)}(hhh](j)}(h/void crypto_free_aead (struct crypto_aead *tfm)h]j)}(h.void crypto_free_aead(struct crypto_aead *tfm)h](j)}(hvoidh]hvoid}(hj hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj hhhU/var/lib/git/docbuild/linux/Documentation/crypto/api-aead:16: ./include/crypto/aead.hhKubj)}(h h]h }(hj hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj hhhj hKubj )}(hcrypto_free_aeadh]j)}(hcrypto_free_aeadh]hcrypto_free_aead}(hj hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj ubah}(h]h ](j#j$eh"]h$]h&]j(j)uh1j hj hhhj hKubjz)}(h(struct crypto_aead *tfm)h]j)}(hstruct crypto_aead *tfmh](j)}(hjh]hstruct}(hj hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj ubj)}(h h]h }(hj, hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj ubh)}(hhh]j)}(h crypto_aeadh]h crypto_aead}(hj= hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj: ubah}(h]h ]h"]h$]h&] refdomainj[reftypej0 reftargetj? modnameN classnameNj4j7)}j:]j=)}j0j sbc.crypto_free_aeadasbuh1hhj ubj)}(h h]h }(hj] hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj ubjR)}(hjUh]h*}(hjk hhhNhNubah}(h]h ]j^ah"]h$]h&]uh1jQhj ubj)}(htfmh]htfm}(hjx hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj ubeh}(h]h ]h"]h$]h&]noemphj(j)uh1jhj ubah}(h]h ]h"]h$]h&]j(j)uh1jyhj hhhj hKubeh}(h]h ]h"]h$]h&]j(j)j0uh1jj1j2hj hhhj hKubah}(h]j ah ](j6j7eh"]h$]h&]j;j<)j=huh1jhj hKhj hhubj?)}(hhh]h)}(hzeroize and free aead handleh]hzeroize and free aead handle}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhU/var/lib/git/docbuild/linux/Documentation/crypto/api-aead:16: ./include/crypto/aead.hhKhj hhubah}(h]h ]h"]h$]h&]uh1j>hj hhhj hKubeh}(h]h ](j[functioneh"]h$]h&]j`j[jaj jbj jcjdjeuh1jhhhjhNhNubjg)}(h**Parameters** ``struct crypto_aead *tfm`` cipher handle to be freed **Description** If **tfm** is a NULL or error pointer, this function does nothing.h](h)}(h**Parameters**h]jq)}(hj h]h Parameters}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1jphj ubah}(h]h ]h"]h$]h&]uh1hhU/var/lib/git/docbuild/linux/Documentation/crypto/api-aead:16: ./include/crypto/aead.hhKhj ubj)}(hhh]j)}(h6``struct crypto_aead *tfm`` cipher handle to be freed h](j)}(h``struct crypto_aead *tfm``h]j)}(hj h]hstruct crypto_aead *tfm}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj ubah}(h]h ]h"]h$]h&]uh1jhU/var/lib/git/docbuild/linux/Documentation/crypto/api-aead:16: ./include/crypto/aead.hhKhj ubj)}(hhh]h)}(hcipher handle to be freedh]hcipher handle to be freed}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj hKhj ubah}(h]h ]h"]h$]h&]uh1jhj ubeh}(h]h ]h"]h$]h&]uh1jhj hKhj ubah}(h]h ]h"]h$]h&]uh1jhj ubh)}(h**Description**h]jq)}(hj h]h Description}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1jphj ubah}(h]h ]h"]h$]h&]uh1hhU/var/lib/git/docbuild/linux/Documentation/crypto/api-aead:16: ./include/crypto/aead.hhKhj ubh)}(hBIf **tfm** is a NULL or error pointer, this function does nothing.h](hIf }(hj4 hhhNhNubjq)}(h**tfm**h]htfm}(hj< hhhNhNubah}(h]h ]h"]h$]h&]uh1jphj4 ubh8 is a NULL or error pointer, this function does nothing.}(hj4 hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhU/var/lib/git/docbuild/linux/Documentation/crypto/api-aead:16: ./include/crypto/aead.hhKhj ubeh}(h]h ] kernelindentah"]h$]h&]uh1jfhjhhhNhNubj)}(hhh]h}(h]h ]h"]h$]h&]entries](jcrypto_aead_ivsize (C function)c.crypto_aead_ivsizehNtauh1jhjhhhNhNubj)}(hhh](j)}(h9unsigned int crypto_aead_ivsize (struct crypto_aead *tfm)h]j)}(h8unsigned int crypto_aead_ivsize(struct crypto_aead *tfm)h](j)}(hunsignedh]hunsigned}(hju hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjq hhhU/var/lib/git/docbuild/linux/Documentation/crypto/api-aead:16: ./include/crypto/aead.hhKubj)}(h h]h }(hj hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjq hhhj hKubj)}(hinth]hint}(hj hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjq hhhj hKubj)}(h h]h }(hj hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjq hhhj hKubj )}(hcrypto_aead_ivsizeh]j)}(hcrypto_aead_ivsizeh]hcrypto_aead_ivsize}(hj hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj ubah}(h]h ](j#j$eh"]h$]h&]j(j)uh1j hjq hhhj hKubjz)}(h(struct crypto_aead *tfm)h]j)}(hstruct crypto_aead *tfmh](j)}(hjh]hstruct}(hj hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj ubj)}(h h]h }(hj hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj ubh)}(hhh]j)}(h crypto_aeadh]h crypto_aead}(hj hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj ubah}(h]h ]h"]h$]h&] refdomainj[reftypej0 reftargetj modnameN classnameNj4j7)}j:]j=)}j0j sbc.crypto_aead_ivsizeasbuh1hhj ubj)}(h h]h }(hj hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj ubjR)}(hjUh]h*}(hj hhhNhNubah}(h]h ]j^ah"]h$]h&]uh1jQhj ubj)}(htfmh]htfm}(hj' hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj ubeh}(h]h ]h"]h$]h&]noemphj(j)uh1jhj ubah}(h]h ]h"]h$]h&]j(j)uh1jyhjq hhhj hKubeh}(h]h ]h"]h$]h&]j(j)j0uh1jj1j2hjm hhhj hKubah}(h]jh ah ](j6j7eh"]h$]h&]j;j<)j=huh1jhj hKhjj hhubj?)}(hhh]h)}(hobtain IV sizeh]hobtain IV size}(hjQ hhhNhNubah}(h]h ]h"]h$]h&]uh1hhU/var/lib/git/docbuild/linux/Documentation/crypto/api-aead:16: ./include/crypto/aead.hhKhjN hhubah}(h]h ]h"]h$]h&]uh1j>hjj hhhj hKubeh}(h]h ](j[functioneh"]h$]h&]j`j[jaji jbji jcjdjeuh1jhhhjhNhNubjg)}(h**Parameters** ``struct crypto_aead *tfm`` cipher handle **Description** The size of the IV for the aead referenced by the cipher handle is returned. This IV size may be zero if the cipher does not need an IV. **Return** IV size in bytesh](h)}(h**Parameters**h]jq)}(hjs h]h Parameters}(hju hhhNhNubah}(h]h ]h"]h$]h&]uh1jphjq ubah}(h]h ]h"]h$]h&]uh1hhU/var/lib/git/docbuild/linux/Documentation/crypto/api-aead:16: ./include/crypto/aead.hhMhjm ubj)}(hhh]j)}(h*``struct crypto_aead *tfm`` cipher handle h](j)}(h``struct crypto_aead *tfm``h]j)}(hj h]hstruct crypto_aead *tfm}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj ubah}(h]h ]h"]h$]h&]uh1jhU/var/lib/git/docbuild/linux/Documentation/crypto/api-aead:16: ./include/crypto/aead.hhMhj ubj)}(hhh]h)}(h cipher handleh]h cipher handle}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj hMhj ubah}(h]h ]h"]h$]h&]uh1jhj ubeh}(h]h ]h"]h$]h&]uh1jhj hMhj ubah}(h]h ]h"]h$]h&]uh1jhjm ubh)}(h**Description**h]jq)}(hj h]h Description}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1jphj ubah}(h]h ]h"]h$]h&]uh1hhU/var/lib/git/docbuild/linux/Documentation/crypto/api-aead:16: ./include/crypto/aead.hhMhjm ubh)}(hThe size of the IV for the aead referenced by the cipher handle is returned. This IV size may be zero if the cipher does not need an IV.h]hThe size of the IV for the aead referenced by the cipher handle is returned. This IV size may be zero if the cipher does not need an IV.}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhU/var/lib/git/docbuild/linux/Documentation/crypto/api-aead:16: ./include/crypto/aead.hhMhjm ubh)}(h **Return**h]jq)}(hj h]hReturn}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1jphj ubah}(h]h ]h"]h$]h&]uh1hhU/var/lib/git/docbuild/linux/Documentation/crypto/api-aead:16: ./include/crypto/aead.hhMhjm ubh)}(hIV size in bytesh]hIV size in bytes}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhU/var/lib/git/docbuild/linux/Documentation/crypto/api-aead:16: ./include/crypto/aead.hhMhjm ubeh}(h]h ] kernelindentah"]h$]h&]uh1jfhjhhhNhNubj)}(hhh]h}(h]h ]h"]h$]h&]entries](j!crypto_aead_authsize (C function)c.crypto_aead_authsizehNtauh1jhjhhhNhNubj)}(hhh](j)}(h;unsigned int crypto_aead_authsize (struct crypto_aead *tfm)h]j)}(h:unsigned int crypto_aead_authsize(struct crypto_aead *tfm)h](j)}(hunsignedh]hunsigned}(hj9hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj5hhhU/var/lib/git/docbuild/linux/Documentation/crypto/api-aead:16: ./include/crypto/aead.hhMubj)}(h h]h }(hjHhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj5hhhjGhMubj)}(hinth]hint}(hjVhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj5hhhjGhMubj)}(h h]h }(hjdhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj5hhhjGhMubj )}(hcrypto_aead_authsizeh]j)}(hcrypto_aead_authsizeh]hcrypto_aead_authsize}(hjvhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjrubah}(h]h ](j#j$eh"]h$]h&]j(j)uh1j hj5hhhjGhMubjz)}(h(struct crypto_aead *tfm)h]j)}(hstruct crypto_aead *tfmh](j)}(hjh]hstruct}(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjubj)}(h h]h }(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjubh)}(hhh]j)}(h crypto_aeadh]h crypto_aead}(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&] refdomainj[reftypej0 reftargetjmodnameN classnameNj4j7)}j:]j=)}j0jxsbc.crypto_aead_authsizeasbuh1hhjubj)}(h h]h }(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjubjR)}(hjUh]h*}(hjhhhNhNubah}(h]h ]j^ah"]h$]h&]uh1jQhjubj)}(htfmh]htfm}(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]noemphj(j)uh1jhjubah}(h]h ]h"]h$]h&]j(j)uh1jyhj5hhhjGhMubeh}(h]h ]h"]h$]h&]j(j)j0uh1jj1j2hj1hhhjGhMubah}(h]j,ah ](j6j7eh"]h$]h&]j;j<)j=huh1jhjGhMhj.hhubj?)}(hhh]h)}(h'obtain maximum authentication data sizeh]h'obtain maximum authentication data size}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhU/var/lib/git/docbuild/linux/Documentation/crypto/api-aead:16: ./include/crypto/aead.hhMhjhhubah}(h]h ]h"]h$]h&]uh1j>hj.hhhjGhMubeh}(h]h ](j[functioneh"]h$]h&]j`j[jaj-jbj-jcjdjeuh1jhhhjhNhNubjg)}(hX**Parameters** ``struct crypto_aead *tfm`` cipher handle **Description** The maximum size of the authentication data for the AEAD cipher referenced by the AEAD cipher handle is returned. The authentication data size may be zero if the cipher implements a hard-coded maximum. The authentication data may also be known as "tag value". **Return** authentication data size / tag size in bytesh](h)}(h**Parameters**h]jq)}(hj7h]h Parameters}(hj9hhhNhNubah}(h]h ]h"]h$]h&]uh1jphj5ubah}(h]h ]h"]h$]h&]uh1hhU/var/lib/git/docbuild/linux/Documentation/crypto/api-aead:16: ./include/crypto/aead.hhMhj1ubj)}(hhh]j)}(h*``struct crypto_aead *tfm`` cipher handle h](j)}(h``struct crypto_aead *tfm``h]j)}(hjVh]hstruct crypto_aead *tfm}(hjXhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjTubah}(h]h ]h"]h$]h&]uh1jhU/var/lib/git/docbuild/linux/Documentation/crypto/api-aead:16: ./include/crypto/aead.hhMhjPubj)}(hhh]h)}(h cipher handleh]h cipher handle}(hjohhhNhNubah}(h]h ]h"]h$]h&]uh1hhjkhMhjlubah}(h]h ]h"]h$]h&]uh1jhjPubeh}(h]h ]h"]h$]h&]uh1jhjkhMhjMubah}(h]h ]h"]h$]h&]uh1jhj1ubh)}(h**Description**h]jq)}(hjh]h Description}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jphjubah}(h]h ]h"]h$]h&]uh1hhU/var/lib/git/docbuild/linux/Documentation/crypto/api-aead:16: ./include/crypto/aead.hhMhj1ubh)}(hThe maximum size of the authentication data for the AEAD cipher referenced by the AEAD cipher handle is returned. The authentication data size may be zero if the cipher implements a hard-coded maximum.h]hThe maximum size of the authentication data for the AEAD cipher referenced by the AEAD cipher handle is returned. The authentication data size may be zero if the cipher implements a hard-coded maximum.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhU/var/lib/git/docbuild/linux/Documentation/crypto/api-aead:16: ./include/crypto/aead.hhMhj1ubh)}(h9The authentication data may also be known as "tag value".h]h=The authentication data may also be known as “tag value”.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhU/var/lib/git/docbuild/linux/Documentation/crypto/api-aead:16: ./include/crypto/aead.hhMhj1ubh)}(h **Return**h]jq)}(hjh]hReturn}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jphjubah}(h]h ]h"]h$]h&]uh1hhU/var/lib/git/docbuild/linux/Documentation/crypto/api-aead:16: ./include/crypto/aead.hhMhj1ubh)}(h,authentication data size / tag size in bytesh]h,authentication data size / tag size in bytes}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhU/var/lib/git/docbuild/linux/Documentation/crypto/api-aead:16: ./include/crypto/aead.hhMhj1ubeh}(h]h ] kernelindentah"]h$]h&]uh1jfhjhhhNhNubj)}(hhh]h}(h]h ]h"]h$]h&]entries](j"crypto_aead_blocksize (C function)c.crypto_aead_blocksizehNtauh1jhjhhhNhNubj)}(hhh](j)}(hhjhhhjhM7ubeh}(h]h ](j[functioneh"]h$]h&]j`j[jajjbjjcjdjeuh1jhhhjhNhNubjg)}(hX=**Parameters** ``struct crypto_aead *tfm`` cipher handle **Description** The block size for the AEAD referenced with the cipher handle is returned. The caller may use that information to allocate appropriate memory for the data returned by the encryption or decryption operation **Return** block size of cipherh](h)}(h**Parameters**h]jq)}(hj h]h Parameters}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1jphjubah}(h]h ]h"]h$]h&]uh1hhU/var/lib/git/docbuild/linux/Documentation/crypto/api-aead:16: ./include/crypto/aead.hhM;hjubj)}(hhh]j)}(h*``struct crypto_aead *tfm`` cipher handle h](j)}(h``struct crypto_aead *tfm``h]j)}(hj)h]hstruct crypto_aead *tfm}(hj+hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj'ubah}(h]h ]h"]h$]h&]uh1jhU/var/lib/git/docbuild/linux/Documentation/crypto/api-aead:16: ./include/crypto/aead.hhM8hj#ubj)}(hhh]h)}(h cipher handleh]h cipher handle}(hjBhhhNhNubah}(h]h ]h"]h$]h&]uh1hhj>hM8hj?ubah}(h]h ]h"]h$]h&]uh1jhj#ubeh}(h]h ]h"]h$]h&]uh1jhj>hM8hj ubah}(h]h ]h"]h$]h&]uh1jhjubh)}(h**Description**h]jq)}(hjdh]h Description}(hjfhhhNhNubah}(h]h ]h"]h$]h&]uh1jphjbubah}(h]h ]h"]h$]h&]uh1hhU/var/lib/git/docbuild/linux/Documentation/crypto/api-aead:16: ./include/crypto/aead.hhM:hjubh)}(hThe block size for the AEAD referenced with the cipher handle is returned. The caller may use that information to allocate appropriate memory for the data returned by the encryption or decryption operationh]hThe block size for the AEAD referenced with the cipher handle is returned. The caller may use that information to allocate appropriate memory for the data returned by the encryption or decryption operation}(hjzhhhNhNubah}(h]h ]h"]h$]h&]uh1hhU/var/lib/git/docbuild/linux/Documentation/crypto/api-aead:16: ./include/crypto/aead.hhM9hjubh)}(h **Return**h]jq)}(hjh]hReturn}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jphjubah}(h]h ]h"]h$]h&]uh1hhU/var/lib/git/docbuild/linux/Documentation/crypto/api-aead:16: ./include/crypto/aead.hhM=hjubh)}(hblock size of cipherh]hblock size of cipher}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhU/var/lib/git/docbuild/linux/Documentation/crypto/api-aead:16: ./include/crypto/aead.hhM>hjubeh}(h]h ] kernelindentah"]h$]h&]uh1jfhjhhhNhNubj)}(hhh]h}(h]h ]h"]h$]h&]entries](jcrypto_aead_setkey (C function)c.crypto_aead_setkeyhNtauh1jhjhhhNhNubj)}(hhh](j)}(hTint crypto_aead_setkey (struct crypto_aead *tfm, const u8 *key, unsigned int keylen)h]j)}(hSint crypto_aead_setkey(struct crypto_aead *tfm, const u8 *key, unsigned int keylen)h](j)}(hinth]hint}(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjhhhU/var/lib/git/docbuild/linux/Documentation/crypto/api-aead:16: ./include/crypto/aead.hhMnubj)}(h h]h }(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjhhhjhMnubj )}(hcrypto_aead_setkeyh]j)}(hcrypto_aead_setkeyh]hcrypto_aead_setkey}(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjubah}(h]h ](j#j$eh"]h$]h&]j(j)uh1j hjhhhjhMnubjz)}(h=(struct crypto_aead *tfm, const u8 *key, unsigned int keylen)h](j)}(hstruct crypto_aead *tfmh](j)}(hjh]hstruct}(hj hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj ubj)}(h h]h }(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj ubh)}(hhh]j)}(h crypto_aeadh]h crypto_aead}(hj+hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj(ubah}(h]h ]h"]h$]h&] refdomainj[reftypej0 reftargetj-modnameN classnameNj4j7)}j:]j=)}j0jsbc.crypto_aead_setkeyasbuh1hhj ubj)}(h h]h }(hjKhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj ubjR)}(hjUh]h*}(hjYhhhNhNubah}(h]h ]j^ah"]h$]h&]uh1jQhj ubj)}(htfmh]htfm}(hjfhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj ubeh}(h]h ]h"]h$]h&]noemphj(j)uh1jhjubj)}(h const u8 *keyh](j)}(hjh]hconst}(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj{ubj)}(h h]h }(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj{ubh)}(hhh]j)}(hu8h]hu8}(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&] refdomainj[reftypej0 reftargetjmodnameN classnameNj4j7)}j:]jGc.crypto_aead_setkeyasbuh1hhj{ubj)}(h h]h }(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj{ubjR)}(hjUh]h*}(hjhhhNhNubah}(h]h ]j^ah"]h$]h&]uh1jQhj{ubj)}(hkeyh]hkey}(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj{ubeh}(h]h ]h"]h$]h&]noemphj(j)uh1jhjubj)}(hunsigned int keylenh](j)}(hunsignedh]hunsigned}(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjubj)}(h h]h }(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjubj)}(hinth]hint}(hj hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjubj)}(h h]h }(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjubj)}(hkeylenh]hkeylen}(hj'hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]noemphj(j)uh1jhjubeh}(h]h ]h"]h$]h&]j(j)uh1jyhjhhhjhMnubeh}(h]h ]h"]h$]h&]j(j)j0uh1jj1j2hjhhhjhMnubah}(h]jah ](j6j7eh"]h$]h&]j;j<)j=huh1jhjhMnhjhhubj?)}(hhh]h)}(hset key for cipherh]hset key for cipher}(hjQhhhNhNubah}(h]h ]h"]h$]h&]uh1hhU/var/lib/git/docbuild/linux/Documentation/crypto/api-aead:16: ./include/crypto/aead.hhMnhjNhhubah}(h]h ]h"]h$]h&]uh1j>hjhhhjhMnubeh}(h]h ](j[functioneh"]h$]h&]j`j[jajijbjijcjdjeuh1jhhhjhNhNubjg)}(hXD**Parameters** ``struct crypto_aead *tfm`` cipher handle ``const u8 *key`` buffer holding the key ``unsigned int keylen`` length of the key in bytes **Description** The caller provided key is set for the AEAD referenced by the cipher handle. Note, the key length determines the cipher type. Many block ciphers implement different cipher modes depending on the key size, such as AES-128 vs AES-192 vs. AES-256. When providing a 16 byte key for an AES cipher handle, AES-128 is performed. **Return** 0 if the setting of the key was successful; < 0 if an error occurredh](h)}(h**Parameters**h]jq)}(hjsh]h Parameters}(hjuhhhNhNubah}(h]h ]h"]h$]h&]uh1jphjqubah}(h]h ]h"]h$]h&]uh1hhU/var/lib/git/docbuild/linux/Documentation/crypto/api-aead:16: ./include/crypto/aead.hhMrhjmubj)}(hhh](j)}(h*``struct crypto_aead *tfm`` cipher handle h](j)}(h``struct crypto_aead *tfm``h]j)}(hjh]hstruct crypto_aead *tfm}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]uh1jhU/var/lib/git/docbuild/linux/Documentation/crypto/api-aead:16: ./include/crypto/aead.hhMohjubj)}(hhh]h)}(h cipher handleh]h cipher handle}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhMohjubah}(h]h ]h"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]uh1jhjhMohjubj)}(h)``const u8 *key`` buffer holding the key h](j)}(h``const u8 *key``h]j)}(hjh]h const u8 *key}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]uh1jhU/var/lib/git/docbuild/linux/Documentation/crypto/api-aead:16: ./include/crypto/aead.hhMphjubj)}(hhh]h)}(hbuffer holding the keyh]hbuffer holding the key}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhMphjubah}(h]h ]h"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]uh1jhjhMphjubj)}(h3``unsigned int keylen`` length of the key in bytes h](j)}(h``unsigned int keylen``h]j)}(hjh]hunsigned int keylen}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]uh1jhU/var/lib/git/docbuild/linux/Documentation/crypto/api-aead:16: ./include/crypto/aead.hhMqhjubj)}(hhh]h)}(hlength of the key in bytesh]hlength of the key in bytes}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhMqhjubah}(h]h ]h"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]uh1jhjhMqhjubeh}(h]h ]h"]h$]h&]uh1jhjmubh)}(h**Description**h]jq)}(hj?h]h Description}(hjAhhhNhNubah}(h]h ]h"]h$]h&]uh1jphj=ubah}(h]h ]h"]h$]h&]uh1hhU/var/lib/git/docbuild/linux/Documentation/crypto/api-aead:16: ./include/crypto/aead.hhMshjmubh)}(hLThe caller provided key is set for the AEAD referenced by the cipher handle.h]hLThe caller provided key is set for the AEAD referenced by the cipher handle.}(hjUhhhNhNubah}(h]h ]h"]h$]h&]uh1hhU/var/lib/git/docbuild/linux/Documentation/crypto/api-aead:16: ./include/crypto/aead.hhMrhjmubh)}(hNote, the key length determines the cipher type. Many block ciphers implement different cipher modes depending on the key size, such as AES-128 vs AES-192 vs. AES-256. When providing a 16 byte key for an AES cipher handle, AES-128 is performed.h]hNote, the key length determines the cipher type. Many block ciphers implement different cipher modes depending on the key size, such as AES-128 vs AES-192 vs. AES-256. When providing a 16 byte key for an AES cipher handle, AES-128 is performed.}(hjdhhhNhNubah}(h]h ]h"]h$]h&]uh1hhU/var/lib/git/docbuild/linux/Documentation/crypto/api-aead:16: ./include/crypto/aead.hhMuhjmubh)}(h **Return**h]jq)}(hjuh]hReturn}(hjwhhhNhNubah}(h]h ]h"]h$]h&]uh1jphjsubah}(h]h ]h"]h$]h&]uh1hhU/var/lib/git/docbuild/linux/Documentation/crypto/api-aead:16: ./include/crypto/aead.hhMzhjmubh)}(hD0 if the setting of the key was successful; < 0 if an error occurredh]hD0 if the setting of the key was successful; < 0 if an error occurred}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhU/var/lib/git/docbuild/linux/Documentation/crypto/api-aead:16: ./include/crypto/aead.hhM{hjmubeh}(h]h ] kernelindentah"]h$]h&]uh1jfhjhhhNhNubj)}(hhh]h}(h]h ]h"]h$]h&]entries](j$crypto_aead_setauthsize (C function)c.crypto_aead_setauthsizehNtauh1jhjhhhNhNubj)}(hhh](j)}(hLint crypto_aead_setauthsize (struct crypto_aead *tfm, unsigned int authsize)h]j)}(hKint crypto_aead_setauthsize(struct crypto_aead *tfm, unsigned int authsize)h](j)}(hinth]hint}(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjhhhU/var/lib/git/docbuild/linux/Documentation/crypto/api-aead:16: ./include/crypto/aead.hhMubj)}(h h]h }(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjhhhjhMubj )}(hcrypto_aead_setauthsizeh]j)}(hcrypto_aead_setauthsizeh]hcrypto_aead_setauthsize}(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjubah}(h]h ](j#j$eh"]h$]h&]j(j)uh1j hjhhhjhMubjz)}(h0(struct crypto_aead *tfm, unsigned int authsize)h](j)}(hstruct crypto_aead *tfmh](j)}(hjh]hstruct}(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjubj)}(h h]h }(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjubh)}(hhh]j)}(h crypto_aeadh]h crypto_aead}(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&] refdomainj[reftypej0 reftargetjmodnameN classnameNj4j7)}j:]j=)}j0jsbc.crypto_aead_setauthsizeasbuh1hhjubj)}(h h]h }(hj5hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjubjR)}(hjUh]h*}(hjChhhNhNubah}(h]h ]j^ah"]h$]h&]uh1jQhjubj)}(htfmh]htfm}(hjPhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]noemphj(j)uh1jhjubj)}(hunsigned int authsizeh](j)}(hunsignedh]hunsigned}(hjihhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjeubj)}(h h]h }(hjwhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjeubj)}(hinth]hint}(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjeubj)}(h h]h }(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjeubj)}(hauthsizeh]hauthsize}(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjeubeh}(h]h ]h"]h$]h&]noemphj(j)uh1jhjubeh}(h]h ]h"]h$]h&]j(j)uh1jyhjhhhjhMubeh}(h]h ]h"]h$]h&]j(j)j0uh1jj1j2hjhhhjhMubah}(h]jah ](j6j7eh"]h$]h&]j;j<)j=huh1jhjhMhjhhubj?)}(hhh]h)}(hset authentication data sizeh]hset authentication data size}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhU/var/lib/git/docbuild/linux/Documentation/crypto/api-aead:16: ./include/crypto/aead.hhMhjhhubah}(h]h ]h"]h$]h&]uh1j>hjhhhjhMubeh}(h]h ](j[functioneh"]h$]h&]j`j[jajjbjjcjdjeuh1jhhhjhNhNubjg)}(hXi**Parameters** ``struct crypto_aead *tfm`` cipher handle ``unsigned int authsize`` size of the authentication data / tag in bytes **Description** Set the authentication data size / tag size. AEAD requires an authentication tag (or MAC) in addition to the associated data. **Return** 0 if the setting of the key was successful; < 0 if an error occurredh](h)}(h**Parameters**h]jq)}(hjh]h Parameters}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jphjubah}(h]h ]h"]h$]h&]uh1hhU/var/lib/git/docbuild/linux/Documentation/crypto/api-aead:16: ./include/crypto/aead.hhMhjubj)}(hhh](j)}(h*``struct crypto_aead *tfm`` cipher handle h](j)}(h``struct crypto_aead *tfm``h]j)}(hj h]hstruct crypto_aead *tfm}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhj ubah}(h]h ]h"]h$]h&]uh1jhU/var/lib/git/docbuild/linux/Documentation/crypto/api-aead:16: ./include/crypto/aead.hhMhjubj)}(hhh]h)}(h cipher handleh]h cipher handle}(hj%hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj!hMhj"ubah}(h]h ]h"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]uh1jhj!hMhjubj)}(hI``unsigned int authsize`` size of the authentication data / tag in bytes h](j)}(h``unsigned int authsize``h]j)}(hjEh]hunsigned int authsize}(hjGhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjCubah}(h]h ]h"]h$]h&]uh1jhU/var/lib/git/docbuild/linux/Documentation/crypto/api-aead:16: ./include/crypto/aead.hhMhj?ubj)}(hhh]h)}(h.size of the authentication data / tag in bytesh]h.size of the authentication data / tag in bytes}(hj^hhhNhNubah}(h]h ]h"]h$]h&]uh1hhjZhMhj[ubah}(h]h ]h"]h$]h&]uh1jhj?ubeh}(h]h ]h"]h$]h&]uh1jhjZhMhjubeh}(h]h ]h"]h$]h&]uh1jhjubh)}(h**Description**h]jq)}(hjh]h Description}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jphj~ubah}(h]h ]h"]h$]h&]uh1hhU/var/lib/git/docbuild/linux/Documentation/crypto/api-aead:16: ./include/crypto/aead.hhMhjubh)}(h}Set the authentication data size / tag size. AEAD requires an authentication tag (or MAC) in addition to the associated data.h]h}Set the authentication data size / tag size. AEAD requires an authentication tag (or MAC) in addition to the associated data.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhU/var/lib/git/docbuild/linux/Documentation/crypto/api-aead:16: ./include/crypto/aead.hhMhjubh)}(h **Return**h]jq)}(hjh]hReturn}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jphjubah}(h]h ]h"]h$]h&]uh1hhU/var/lib/git/docbuild/linux/Documentation/crypto/api-aead:16: ./include/crypto/aead.hhMhjubh)}(hD0 if the setting of the key was successful; < 0 if an error occurredh]hD0 if the setting of the key was successful; < 0 if an error occurred}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhU/var/lib/git/docbuild/linux/Documentation/crypto/api-aead:16: ./include/crypto/aead.hhMhjubeh}(h]h ] kernelindentah"]h$]h&]uh1jfhjhhhNhNubj)}(hhh]h}(h]h ]h"]h$]h&]entries](j crypto_aead_encrypt (C function)c.crypto_aead_encrypthNtauh1jhjhhhNhNubj)}(hhh](j)}(h2int crypto_aead_encrypt (struct aead_request *req)h]j)}(h1int crypto_aead_encrypt(struct aead_request *req)h](j)}(hinth]hint}(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjhhhU/var/lib/git/docbuild/linux/Documentation/crypto/api-aead:16: ./include/crypto/aead.hhMubj)}(h h]h }(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjhhhjhMubj )}(hcrypto_aead_encrypth]j)}(hcrypto_aead_encrypth]hcrypto_aead_encrypt}(hj hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj ubah}(h]h ](j#j$eh"]h$]h&]j(j)uh1j hjhhhjhMubjz)}(h(struct aead_request *req)h]j)}(hstruct aead_request *reqh](j)}(hjh]hstruct}(hj)hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj%ubj)}(h h]h }(hj6hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj%ubh)}(hhh]j)}(h aead_requesth]h aead_request}(hjGhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjDubah}(h]h ]h"]h$]h&] refdomainj[reftypej0 reftargetjImodnameN classnameNj4j7)}j:]j=)}j0jsbc.crypto_aead_encryptasbuh1hhj%ubj)}(h h]h }(hjghhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj%ubjR)}(hjUh]h*}(hjuhhhNhNubah}(h]h ]j^ah"]h$]h&]uh1jQhj%ubj)}(hreqh]hreq}(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj%ubeh}(h]h ]h"]h$]h&]noemphj(j)uh1jhj!ubah}(h]h ]h"]h$]h&]j(j)uh1jyhjhhhjhMubeh}(h]h ]h"]h$]h&]j(j)j0uh1jj1j2hjhhhjhMubah}(h]jah ](j6j7eh"]h$]h&]j;j<)j=huh1jhjhMhjhhubj?)}(hhh]h)}(hencrypt plaintexth]hencrypt plaintext}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhU/var/lib/git/docbuild/linux/Documentation/crypto/api-aead:16: ./include/crypto/aead.hhMhjhhubah}(h]h ]h"]h$]h&]uh1j>hjhhhjhMubeh}(h]h ](j[functioneh"]h$]h&]j`j[jajjbjjcjdjeuh1jhhhjhNhNubjg)}(hXk**Parameters** ``struct aead_request *req`` reference to the aead_request handle that holds all information needed to perform the cipher operation **Description** Encrypt plaintext data using the aead_request handle. That data structure and how it is filled with data is discussed with the aead_request_* functions. IMPORTANT NOTE The encryption operation creates the authentication data / tag. That data is concatenated with the created ciphertext. The ciphertext memory size is therefore the given number of block cipher blocks + the size defined by the crypto_aead_setauthsize invocation. The caller must ensure that sufficient memory is available for the ciphertext and the authentication tag. **Return** 0 if the cipher operation was successful; < 0 if an error occurredh](h)}(h**Parameters**h]jq)}(hjh]h Parameters}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jphjubah}(h]h ]h"]h$]h&]uh1hhU/var/lib/git/docbuild/linux/Documentation/crypto/api-aead:16: ./include/crypto/aead.hhMhjubj)}(hhh]j)}(h``struct aead_request *req`` reference to the aead_request handle that holds all information needed to perform the cipher operation h](j)}(h``struct aead_request *req``h]j)}(hjh]hstruct aead_request *req}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]uh1jhU/var/lib/git/docbuild/linux/Documentation/crypto/api-aead:16: ./include/crypto/aead.hhMhjubj)}(hhh]h)}(hfreference to the aead_request handle that holds all information needed to perform the cipher operationh]hfreference to the aead_request handle that holds all information needed to perform the cipher operation}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhU/var/lib/git/docbuild/linux/Documentation/crypto/api-aead:16: ./include/crypto/aead.hhMhjubah}(h]h ]h"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]uh1jhjhMhjubah}(h]h ]h"]h$]h&]uh1jhjubh)}(h**Description**h]jq)}(hj)h]h Description}(hj+hhhNhNubah}(h]h ]h"]h$]h&]uh1jphj'ubah}(h]h ]h"]h$]h&]uh1hhU/var/lib/git/docbuild/linux/Documentation/crypto/api-aead:16: ./include/crypto/aead.hhMhjubh)}(hEncrypt plaintext data using the aead_request handle. That data structure and how it is filled with data is discussed with the aead_request_* functions.h]hEncrypt plaintext data using the aead_request handle. That data structure and how it is filled with data is discussed with the aead_request_* functions.}(hj?hhhNhNubah}(h]h ]h"]h$]h&]uh1hhU/var/lib/git/docbuild/linux/Documentation/crypto/api-aead:16: ./include/crypto/aead.hhMhjubj)}(hhh]j)}(hX~IMPORTANT NOTE The encryption operation creates the authentication data / tag. That data is concatenated with the created ciphertext. The ciphertext memory size is therefore the given number of block cipher blocks + the size defined by the crypto_aead_setauthsize invocation. The caller must ensure that sufficient memory is available for the ciphertext and the authentication tag. h](j)}(hIIMPORTANT NOTE The encryption operation creates the authentication data /h]hIIMPORTANT NOTE The encryption operation creates the authentication data /}(hjUhhhNhNubah}(h]h ]h"]h$]h&]uh1jhU/var/lib/git/docbuild/linux/Documentation/crypto/api-aead:16: ./include/crypto/aead.hhMhjQubj)}(hhh]h)}(hX3tag. That data is concatenated with the created ciphertext. The ciphertext memory size is therefore the given number of block cipher blocks + the size defined by the crypto_aead_setauthsize invocation. The caller must ensure that sufficient memory is available for the ciphertext and the authentication tag.h]hX3tag. That data is concatenated with the created ciphertext. The ciphertext memory size is therefore the given number of block cipher blocks + the size defined by the crypto_aead_setauthsize invocation. The caller must ensure that sufficient memory is available for the ciphertext and the authentication tag.}(hjghhhNhNubah}(h]h ]h"]h$]h&]uh1hhU/var/lib/git/docbuild/linux/Documentation/crypto/api-aead:16: ./include/crypto/aead.hhMhjdubah}(h]h ]h"]h$]h&]uh1jhjQubeh}(h]h ]h"]h$]h&]uh1jhjchMhjNubah}(h]h ]h"]h$]h&]uh1jhjubh)}(h **Return**h]jq)}(hjh]hReturn}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jphjubah}(h]h ]h"]h$]h&]uh1hhU/var/lib/git/docbuild/linux/Documentation/crypto/api-aead:16: ./include/crypto/aead.hhMhjubh)}(hB0 if the cipher operation was successful; < 0 if an error occurredh]hB0 if the cipher operation was successful; < 0 if an error occurred}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhU/var/lib/git/docbuild/linux/Documentation/crypto/api-aead:16: ./include/crypto/aead.hhMhjubeh}(h]h ] kernelindentah"]h$]h&]uh1jfhjhhhNhNubj)}(hhh]h}(h]h ]h"]h$]h&]entries](j crypto_aead_decrypt (C function)c.crypto_aead_decrypthNtauh1jhjhhhNhNubj)}(hhh](j)}(h2int crypto_aead_decrypt (struct aead_request *req)h]j)}(h1int crypto_aead_decrypt(struct aead_request *req)h](j)}(hinth]hint}(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjhhhU/var/lib/git/docbuild/linux/Documentation/crypto/api-aead:16: ./include/crypto/aead.hhMubj)}(h h]h }(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjhhhjhMubj )}(hcrypto_aead_decrypth]j)}(hcrypto_aead_decrypth]hcrypto_aead_decrypt}(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjubah}(h]h ](j#j$eh"]h$]h&]j(j)uh1j hjhhhjhMubjz)}(h(struct aead_request *req)h]j)}(hstruct aead_request *reqh](j)}(hjh]hstruct}(hj hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjubj)}(h h]h }(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjubh)}(hhh]j)}(h aead_requesth]h aead_request}(hj*hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj'ubah}(h]h ]h"]h$]h&] refdomainj[reftypej0 reftargetj,modnameN classnameNj4j7)}j:]j=)}j0jsbc.crypto_aead_decryptasbuh1hhjubj)}(h h]h }(hjJhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjubjR)}(hjUh]h*}(hjXhhhNhNubah}(h]h ]j^ah"]h$]h&]uh1jQhjubj)}(hreqh]hreq}(hjehhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]noemphj(j)uh1jhjubah}(h]h ]h"]h$]h&]j(j)uh1jyhjhhhjhMubeh}(h]h ]h"]h$]h&]j(j)j0uh1jj1j2hjhhhjhMubah}(h]jah ](j6j7eh"]h$]h&]j;j<)j=huh1jhjhMhjhhubj?)}(hhh]h)}(hdecrypt ciphertexth]hdecrypt ciphertext}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhU/var/lib/git/docbuild/linux/Documentation/crypto/api-aead:16: ./include/crypto/aead.hhMhjhhubah}(h]h ]h"]h$]h&]uh1j>hjhhhjhMubeh}(h]h ](j[functioneh"]h$]h&]j`j[jajjbjjcjdjeuh1jhhhjhNhNubjg)}(hX**Parameters** ``struct aead_request *req`` reference to the aead_request handle that holds all information needed to perform the cipher operation **Description** Decrypt ciphertext data using the aead_request handle. That data structure and how it is filled with data is discussed with the aead_request_* functions. IMPORTANT NOTE The caller must concatenate the ciphertext followed by the authentication data / tag. That authentication data / tag must have the size defined by the crypto_aead_setauthsize invocation. **Return** 0 if the cipher operation was successful; -EBADMSG: The AEAD cipher operation performs the authentication of the data during the decryption operation. Therefore, the function returns this error if the authentication of the ciphertext was unsuccessful (i.e. the integrity of the ciphertext or the associated data was violated); < 0 if an error occurred.h](h)}(h**Parameters**h]jq)}(hjh]h Parameters}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jphjubah}(h]h ]h"]h$]h&]uh1hhU/var/lib/git/docbuild/linux/Documentation/crypto/api-aead:16: ./include/crypto/aead.hhMhjubj)}(hhh]j)}(h``struct aead_request *req`` reference to the aead_request handle that holds all information needed to perform the cipher operation h](j)}(h``struct aead_request *req``h]j)}(hjh]hstruct aead_request *req}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]uh1jhU/var/lib/git/docbuild/linux/Documentation/crypto/api-aead:16: ./include/crypto/aead.hhMhjubj)}(hhh]h)}(hfreference to the aead_request handle that holds all information needed to perform the cipher operationh]hfreference to the aead_request handle that holds all information needed to perform the cipher operation}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhU/var/lib/git/docbuild/linux/Documentation/crypto/api-aead:16: ./include/crypto/aead.hhMhjubah}(h]h ]h"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]uh1jhjhMhjubah}(h]h ]h"]h$]h&]uh1jhjubh)}(h**Description**h]jq)}(hj h]h Description}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jphj ubah}(h]h ]h"]h$]h&]uh1hhU/var/lib/git/docbuild/linux/Documentation/crypto/api-aead:16: ./include/crypto/aead.hhMhjubh)}(hDecrypt ciphertext data using the aead_request handle. That data structure and how it is filled with data is discussed with the aead_request_* functions.h]hDecrypt ciphertext data using the aead_request handle. That data structure and how it is filled with data is discussed with the aead_request_* functions.}(hj"hhhNhNubah}(h]h ]h"]h$]h&]uh1hhU/var/lib/git/docbuild/linux/Documentation/crypto/api-aead:16: ./include/crypto/aead.hhMhjubj)}(hhh]j)}(hIMPORTANT NOTE The caller must concatenate the ciphertext followed by the authentication data / tag. That authentication data / tag must have the size defined by the crypto_aead_setauthsize invocation. h](j)}(hIIMPORTANT NOTE The caller must concatenate the ciphertext followed by theh]hIIMPORTANT NOTE The caller must concatenate the ciphertext followed by the}(hj8hhhNhNubah}(h]h ]h"]h$]h&]uh1jhU/var/lib/git/docbuild/linux/Documentation/crypto/api-aead:16: ./include/crypto/aead.hhMhj4ubj)}(hhh]h)}(hauthentication data / tag. That authentication data / tag must have the size defined by the crypto_aead_setauthsize invocation.h]hauthentication data / tag. That authentication data / tag must have the size defined by the crypto_aead_setauthsize invocation.}(hjJhhhNhNubah}(h]h ]h"]h$]h&]uh1hhU/var/lib/git/docbuild/linux/Documentation/crypto/api-aead:16: ./include/crypto/aead.hhMhjGubah}(h]h ]h"]h$]h&]uh1jhj4ubeh}(h]h ]h"]h$]h&]uh1jhjFhMhj1ubah}(h]h ]h"]h$]h&]uh1jhjubh)}(h **Return**h]jq)}(hjmh]hReturn}(hjohhhNhNubah}(h]h ]h"]h$]h&]uh1jphjkubah}(h]h ]h"]h$]h&]uh1hhU/var/lib/git/docbuild/linux/Documentation/crypto/api-aead:16: ./include/crypto/aead.hhMhjubh)}(hX`0 if the cipher operation was successful; -EBADMSG: The AEAD cipher operation performs the authentication of the data during the decryption operation. Therefore, the function returns this error if the authentication of the ciphertext was unsuccessful (i.e. the integrity of the ciphertext or the associated data was violated); < 0 if an error occurred.h]hX`0 if the cipher operation was successful; -EBADMSG: The AEAD cipher operation performs the authentication of the data during the decryption operation. Therefore, the function returns this error if the authentication of the ciphertext was unsuccessful (i.e. the integrity of the ciphertext or the associated data was violated); < 0 if an error occurred.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhU/var/lib/git/docbuild/linux/Documentation/crypto/api-aead:16: ./include/crypto/aead.hhMhjubeh}(h]h ] kernelindentah"]h$]h&]uh1jfhjhhhNhNubeh}(h]=authenticated-encryption-with-associated-data-aead-cipher-apiah ]h"]?authenticated encryption with associated data (aead) cipher apiah$]h&]uh1hhhhhhhhKubh)}(hhh](h)}(h Asynchronous AEAD Request Handleh]h Asynchronous AEAD Request Handle}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhhhhhKubh)}(hX{The aead_request data structure contains all pointers to data required for the AEAD cipher operation. This includes the cipher handle (which can be used by multiple aead_request instances), pointer to plaintext and ciphertext, asynchronous callback function, etc. It acts as a handle to the aead_request_* API calls in a similar way as AEAD handle to the crypto_aead_* API calls.h]hX{The aead_request data structure contains all pointers to data required for the AEAD cipher operation. This includes the cipher handle (which can be used by multiple aead_request instances), pointer to plaintext and ciphertext, asynchronous callback function, etc. It acts as a handle to the aead_request_* API calls in a similar way as AEAD handle to the crypto_aead_* API calls.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhU/var/lib/git/docbuild/linux/Documentation/crypto/api-aead:22: ./include/crypto/aead.hhMhjhhubj)}(hhh]h}(h]h ]h"]h$]h&]entries](j crypto_aead_reqsize (C function)c.crypto_aead_reqsizehNtauh1jhjhhhNhNubj)}(hhh](j)}(h:unsigned int crypto_aead_reqsize (struct crypto_aead *tfm)h]j)}(h9unsigned int crypto_aead_reqsize(struct crypto_aead *tfm)h](j)}(hunsignedh]hunsigned}(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjhhhU/var/lib/git/docbuild/linux/Documentation/crypto/api-aead:25: ./include/crypto/aead.hhMubj)}(h h]h }(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjhhhjhMubj)}(hinth]hint}(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjhhhjhMubj)}(h h]h }(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjhhhjhMubj )}(hcrypto_aead_reqsizeh]j)}(hcrypto_aead_reqsizeh]hcrypto_aead_reqsize}(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjubah}(h]h ](j#j$eh"]h$]h&]j(j)uh1j hjhhhjhMubjz)}(h(struct crypto_aead *tfm)h]j)}(hstruct crypto_aead *tfmh](j)}(hjh]hstruct}(hj3hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj/ubj)}(h h]h }(hj@hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj/ubh)}(hhh]j)}(h crypto_aeadh]h crypto_aead}(hjQhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjNubah}(h]h ]h"]h$]h&] refdomainj[reftypej0 reftargetjSmodnameN classnameNj4j7)}j:]j=)}j0jsbc.crypto_aead_reqsizeasbuh1hhj/ubj)}(h h]h }(hjqhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj/ubjR)}(hjUh]h*}(hjhhhNhNubah}(h]h ]j^ah"]h$]h&]uh1jQhj/ubj)}(htfmh]htfm}(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj/ubeh}(h]h ]h"]h$]h&]noemphj(j)uh1jhj+ubah}(h]h ]h"]h$]h&]j(j)uh1jyhjhhhjhMubeh}(h]h ]h"]h$]h&]j(j)j0uh1jj1j2hjhhhjhMubah}(h]jah ](j6j7eh"]h$]h&]j;j<)j=huh1jhjhMhjhhubj?)}(hhh]h)}(h)obtain size of the request data structureh]h)obtain size of the request data structure}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhU/var/lib/git/docbuild/linux/Documentation/crypto/api-aead:25: ./include/crypto/aead.hhMhjhhubah}(h]h ]h"]h$]h&]uh1j>hjhhhjhMubeh}(h]h ](j[functioneh"]h$]h&]j`j[jajjbjjcjdjeuh1jhhhjhNhNubjg)}(hX**Parameters** ``struct crypto_aead *tfm`` cipher handle **Return** number of bytesh](h)}(h**Parameters**h]jq)}(hjh]h Parameters}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jphjubah}(h]h ]h"]h$]h&]uh1hhU/var/lib/git/docbuild/linux/Documentation/crypto/api-aead:25: ./include/crypto/aead.hhMhjubj)}(hhh]j)}(h*``struct crypto_aead *tfm`` cipher handle h](j)}(h``struct crypto_aead *tfm``h]j)}(hjh]hstruct crypto_aead *tfm}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]uh1jhU/var/lib/git/docbuild/linux/Documentation/crypto/api-aead:25: ./include/crypto/aead.hhMhjubj)}(hhh]h)}(h cipher handleh]h cipher handle}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhj hMhj ubah}(h]h ]h"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]uh1jhj hMhjubah}(h]h ]h"]h$]h&]uh1jhjubh)}(h **Return**h]jq)}(hj2h]hReturn}(hj4hhhNhNubah}(h]h ]h"]h$]h&]uh1jphj0ubah}(h]h ]h"]h$]h&]uh1hhU/var/lib/git/docbuild/linux/Documentation/crypto/api-aead:25: ./include/crypto/aead.hhMhjubh)}(hnumber of bytesh]hnumber of bytes}(hjHhhhNhNubah}(h]h ]h"]h$]h&]uh1hhU/var/lib/git/docbuild/linux/Documentation/crypto/api-aead:25: ./include/crypto/aead.hhMhjubeh}(h]h ] kernelindentah"]h$]h&]uh1jfhjhhhNhNubj)}(hhh]h}(h]h ]h"]h$]h&]entries](j!aead_request_set_tfm (C function)c.aead_request_set_tfmhNtauh1jhjhhhNhNubj)}(hhh](j)}(hMvoid aead_request_set_tfm (struct aead_request *req, struct crypto_aead *tfm)h]j)}(hLvoid aead_request_set_tfm(struct aead_request *req, struct crypto_aead *tfm)h](j)}(hvoidh]hvoid}(hjwhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjshhhU/var/lib/git/docbuild/linux/Documentation/crypto/api-aead:25: ./include/crypto/aead.hhMubj)}(h h]h }(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjshhhjhMubj )}(haead_request_set_tfmh]j)}(haead_request_set_tfmh]haead_request_set_tfm}(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjubah}(h]h ](j#j$eh"]h$]h&]j(j)uh1j hjshhhjhMubjz)}(h3(struct aead_request *req, struct crypto_aead *tfm)h](j)}(hstruct aead_request *reqh](j)}(hjh]hstruct}(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjubj)}(h h]h }(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjubh)}(hhh]j)}(h aead_requesth]h aead_request}(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&] refdomainj[reftypej0 reftargetjmodnameN classnameNj4j7)}j:]j=)}j0jsbc.aead_request_set_tfmasbuh1hhjubj)}(h h]h }(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjubjR)}(hjUh]h*}(hjhhhNhNubah}(h]h ]j^ah"]h$]h&]uh1jQhjubj)}(hreqh]hreq}(hj hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]noemphj(j)uh1jhjubj)}(hstruct crypto_aead *tfmh](j)}(hjh]hstruct}(hj&hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj"ubj)}(h h]h }(hj3hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj"ubh)}(hhh]j)}(h crypto_aeadh]h crypto_aead}(hjDhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjAubah}(h]h ]h"]h$]h&] refdomainj[reftypej0 reftargetjFmodnameN classnameNj4j7)}j:]jc.aead_request_set_tfmasbuh1hhj"ubj)}(h h]h }(hjbhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj"ubjR)}(hjUh]h*}(hjphhhNhNubah}(h]h ]j^ah"]h$]h&]uh1jQhj"ubj)}(htfmh]htfm}(hj}hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj"ubeh}(h]h ]h"]h$]h&]noemphj(j)uh1jhjubeh}(h]h ]h"]h$]h&]j(j)uh1jyhjshhhjhMubeh}(h]h ]h"]h$]h&]j(j)j0uh1jj1j2hjohhhjhMubah}(h]jjah ](j6j7eh"]h$]h&]j;j<)j=huh1jhjhMhjlhhubj?)}(hhh]h)}(h)update cipher handle reference in requesth]h)update cipher handle reference in request}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhU/var/lib/git/docbuild/linux/Documentation/crypto/api-aead:25: ./include/crypto/aead.hhMhjhhubah}(h]h ]h"]h$]h&]uh1j>hjlhhhjhMubeh}(h]h ](j[functioneh"]h$]h&]j`j[jajjbjjcjdjeuh1jhhhjhNhNubjg)}(hX**Parameters** ``struct aead_request *req`` request handle to be modified ``struct crypto_aead *tfm`` cipher handle that shall be added to the request handle **Description** Allow the caller to replace the existing aead handle in the request data structure with a different one.h](h)}(h**Parameters**h]jq)}(hjh]h Parameters}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jphjubah}(h]h ]h"]h$]h&]uh1hhU/var/lib/git/docbuild/linux/Documentation/crypto/api-aead:25: ./include/crypto/aead.hhMhjubj)}(hhh](j)}(h;``struct aead_request *req`` request handle to be modified h](j)}(h``struct aead_request *req``h]j)}(hjh]hstruct aead_request *req}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]uh1jhU/var/lib/git/docbuild/linux/Documentation/crypto/api-aead:25: ./include/crypto/aead.hhMhjubj)}(hhh]h)}(hrequest handle to be modifiedh]hrequest handle to be modified}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhMhjubah}(h]h ]h"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]uh1jhjhMhjubj)}(hT``struct crypto_aead *tfm`` cipher handle that shall be added to the request handle h](j)}(h``struct crypto_aead *tfm``h]j)}(hj!h]hstruct crypto_aead *tfm}(hj#hhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]uh1jhU/var/lib/git/docbuild/linux/Documentation/crypto/api-aead:25: ./include/crypto/aead.hhMhjubj)}(hhh]h)}(h7cipher handle that shall be added to the request handleh]h7cipher handle that shall be added to the request handle}(hj:hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj6hMhj7ubah}(h]h ]h"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]uh1jhj6hMhjubeh}(h]h ]h"]h$]h&]uh1jhjubh)}(h**Description**h]jq)}(hj\h]h Description}(hj^hhhNhNubah}(h]h ]h"]h$]h&]uh1jphjZubah}(h]h ]h"]h$]h&]uh1hhU/var/lib/git/docbuild/linux/Documentation/crypto/api-aead:25: ./include/crypto/aead.hhMhjubh)}(hhAllow the caller to replace the existing aead handle in the request data structure with a different one.h]hhAllow the caller to replace the existing aead handle in the request data structure with a different one.}(hjrhhhNhNubah}(h]h ]h"]h$]h&]uh1hhU/var/lib/git/docbuild/linux/Documentation/crypto/api-aead:25: ./include/crypto/aead.hhMhjubeh}(h]h ] kernelindentah"]h$]h&]uh1jfhjhhhNhNubj)}(hhh]h}(h]h ]h"]h$]h&]entries](jaead_request_alloc (C function)c.aead_request_allochNtauh1jhjhhhNhNubj)}(hhh](j)}(hMstruct aead_request * aead_request_alloc (struct crypto_aead *tfm, gfp_t gfp)h]j)}(hKstruct aead_request *aead_request_alloc(struct crypto_aead *tfm, gfp_t gfp)h](j)}(hjh]hstruct}(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjhhhU/var/lib/git/docbuild/linux/Documentation/crypto/api-aead:25: ./include/crypto/aead.hhMubj)}(h h]h }(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjhhhjhMubh)}(hhh]j)}(h aead_requesth]h aead_request}(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&] refdomainj[reftypej0 reftargetjmodnameN classnameNj4j7)}j:]j=)}j0aead_request_allocsbc.aead_request_allocasbuh1hhjhhhjhMubj)}(h h]h }(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjhhhjhMubjR)}(hjUh]h*}(hjhhhNhNubah}(h]h ]j^ah"]h$]h&]uh1jQhjhhhjhMubj )}(haead_request_alloch]j)}(hjh]haead_request_alloc}(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjubah}(h]h ](j#j$eh"]h$]h&]j(j)uh1j hjhhhjhMubjz)}(h$(struct crypto_aead *tfm, gfp_t gfp)h](j)}(hstruct crypto_aead *tfmh](j)}(hjh]hstruct}(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjubj)}(h h]h }(hj(hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjubh)}(hhh]j)}(h crypto_aeadh]h crypto_aead}(hj9hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj6ubah}(h]h ]h"]h$]h&] refdomainj[reftypej0 reftargetj;modnameN classnameNj4j7)}j:]jc.aead_request_allocasbuh1hhjubj)}(h h]h }(hjWhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjubjR)}(hjUh]h*}(hjehhhNhNubah}(h]h ]j^ah"]h$]h&]uh1jQhjubj)}(htfmh]htfm}(hjrhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]noemphj(j)uh1jhjubj)}(h gfp_t gfph](h)}(hhh]j)}(hgfp_th]hgfp_t}(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&] refdomainj[reftypej0 reftargetjmodnameN classnameNj4j7)}j:]jc.aead_request_allocasbuh1hhjubj)}(h h]h }(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjubj)}(hgfph]hgfp}(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]noemphj(j)uh1jhjubeh}(h]h ]h"]h$]h&]j(j)uh1jyhjhhhjhMubeh}(h]h ]h"]h$]h&]j(j)j0uh1jj1j2hjhhhjhMubah}(h]jah ](j6j7eh"]h$]h&]j;j<)j=huh1jhjhMhjhhubj?)}(hhh]h)}(hallocate request data structureh]hallocate request data structure}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhU/var/lib/git/docbuild/linux/Documentation/crypto/api-aead:25: ./include/crypto/aead.hhMhjhhubah}(h]h ]h"]h$]h&]uh1j>hjhhhjhMubeh}(h]h ](j[functioneh"]h$]h&]j`j[jajjbjjcjdjeuh1jhhhjhNhNubjg)}(hX**Parameters** ``struct crypto_aead *tfm`` cipher handle to be registered with the request ``gfp_t gfp`` memory allocation flag that is handed to kmalloc by the API call. **Description** Allocate the request data structure that must be used with the AEAD encrypt and decrypt API calls. During the allocation, the provided aead handle is registered in the request data structure. **Return** allocated request handle in case of success, or NULL if out of memoryh](h)}(h**Parameters**h]jq)}(hj h]h Parameters}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1jphj ubah}(h]h ]h"]h$]h&]uh1hhU/var/lib/git/docbuild/linux/Documentation/crypto/api-aead:25: ./include/crypto/aead.hhMhj ubj)}(hhh](j)}(hL``struct crypto_aead *tfm`` cipher handle to be registered with the request h](j)}(h``struct crypto_aead *tfm``h]j)}(hj% h]hstruct crypto_aead *tfm}(hj' hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj# ubah}(h]h ]h"]h$]h&]uh1jhU/var/lib/git/docbuild/linux/Documentation/crypto/api-aead:25: ./include/crypto/aead.hhMhj ubj)}(hhh]h)}(h/cipher handle to be registered with the requesth]h/cipher handle to be registered with the request}(hj> hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj: hMhj; ubah}(h]h ]h"]h$]h&]uh1jhj ubeh}(h]h ]h"]h$]h&]uh1jhj: hMhj ubj)}(hP``gfp_t gfp`` memory allocation flag that is handed to kmalloc by the API call. h](j)}(h ``gfp_t gfp``h]j)}(hj^ h]h gfp_t gfp}(hj` hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj\ ubah}(h]h ]h"]h$]h&]uh1jhU/var/lib/git/docbuild/linux/Documentation/crypto/api-aead:25: ./include/crypto/aead.hhMhjX ubj)}(hhh]h)}(hAmemory allocation flag that is handed to kmalloc by the API call.h]hAmemory allocation flag that is handed to kmalloc by the API call.}(hjw hhhNhNubah}(h]h ]h"]h$]h&]uh1hhjs hMhjt ubah}(h]h ]h"]h$]h&]uh1jhjX ubeh}(h]h ]h"]h$]h&]uh1jhjs hMhj ubeh}(h]h ]h"]h$]h&]uh1jhj ubh)}(h**Description**h]jq)}(hj h]h Description}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1jphj ubah}(h]h ]h"]h$]h&]uh1hhU/var/lib/git/docbuild/linux/Documentation/crypto/api-aead:25: ./include/crypto/aead.hhMhj ubh)}(hAllocate the request data structure that must be used with the AEAD encrypt and decrypt API calls. During the allocation, the provided aead handle is registered in the request data structure.h]hAllocate the request data structure that must be used with the AEAD encrypt and decrypt API calls. During the allocation, the provided aead handle is registered in the request data structure.}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhU/var/lib/git/docbuild/linux/Documentation/crypto/api-aead:25: ./include/crypto/aead.hhMhj ubh)}(h **Return**h]jq)}(hj h]hReturn}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1jphj ubah}(h]h ]h"]h$]h&]uh1hhU/var/lib/git/docbuild/linux/Documentation/crypto/api-aead:25: ./include/crypto/aead.hhMhj ubh)}(hEallocated request handle in case of success, or NULL if out of memoryh]hEallocated request handle in case of success, or NULL if out of memory}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhU/var/lib/git/docbuild/linux/Documentation/crypto/api-aead:25: ./include/crypto/aead.hhMhj ubeh}(h]h ] kernelindentah"]h$]h&]uh1jfhjhhhNhNubj)}(hhh]h}(h]h ]h"]h$]h&]entries](jaead_request_free (C function)c.aead_request_freehNtauh1jhjhhhNhNubj)}(hhh](j)}(h1void aead_request_free (struct aead_request *req)h]j)}(h0void aead_request_free(struct aead_request *req)h](j)}(hvoidh]hvoid}(hj!hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj!hhhU/var/lib/git/docbuild/linux/Documentation/crypto/api-aead:25: ./include/crypto/aead.hhMubj)}(h h]h }(hj!hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj!hhhj!hMubj )}(haead_request_freeh]j)}(haead_request_freeh]haead_request_free}(hj&!hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj"!ubah}(h]h ](j#j$eh"]h$]h&]j(j)uh1j hj!hhhj!hMubjz)}(h(struct aead_request *req)h]j)}(hstruct aead_request *reqh](j)}(hjh]hstruct}(hjB!hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj>!ubj)}(h h]h }(hjO!hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj>!ubh)}(hhh]j)}(h aead_requesth]h aead_request}(hj`!hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj]!ubah}(h]h ]h"]h$]h&] refdomainj[reftypej0 reftargetjb!modnameN classnameNj4j7)}j:]j=)}j0j(!sbc.aead_request_freeasbuh1hhj>!ubj)}(h h]h }(hj!hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj>!ubjR)}(hjUh]h*}(hj!hhhNhNubah}(h]h ]j^ah"]h$]h&]uh1jQhj>!ubj)}(hreqh]hreq}(hj!hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj>!ubeh}(h]h ]h"]h$]h&]noemphj(j)uh1jhj:!ubah}(h]h ]h"]h$]h&]j(j)uh1jyhj!hhhj!hMubeh}(h]h ]h"]h$]h&]j(j)j0uh1jj1j2hj hhhj!hMubah}(h]j ah ](j6j7eh"]h$]h&]j;j<)j=huh1jhj!hMhj hhubj?)}(hhh]h)}(h'zeroize and free request data structureh]h'zeroize and free request data structure}(hj!hhhNhNubah}(h]h ]h"]h$]h&]uh1hhU/var/lib/git/docbuild/linux/Documentation/crypto/api-aead:25: ./include/crypto/aead.hhMhj!hhubah}(h]h ]h"]h$]h&]uh1j>hj hhhj!hMubeh}(h]h ](j[functioneh"]h$]h&]j`j[jaj!jbj!jcjdjeuh1jhhhjhNhNubjg)}(h_**Parameters** ``struct aead_request *req`` request data structure cipher handle to be freedh](h)}(h**Parameters**h]jq)}(hj!h]h Parameters}(hj!hhhNhNubah}(h]h ]h"]h$]h&]uh1jphj!ubah}(h]h ]h"]h$]h&]uh1hhU/var/lib/git/docbuild/linux/Documentation/crypto/api-aead:25: ./include/crypto/aead.hhMhj!ubj)}(hhh]j)}(hM``struct aead_request *req`` request data structure cipher handle to be freedh](j)}(h``struct aead_request *req``h]j)}(hj"h]hstruct aead_request *req}(hj"hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj"ubah}(h]h ]h"]h$]h&]uh1jhU/var/lib/git/docbuild/linux/Documentation/crypto/api-aead:25: ./include/crypto/aead.hhMhj"ubj)}(hhh]h)}(h0request data structure cipher handle to be freedh]h0request data structure cipher handle to be freed}(hj"hhhNhNubah}(h]h ]h"]h$]h&]uh1hhU/var/lib/git/docbuild/linux/Documentation/crypto/api-aead:25: ./include/crypto/aead.hhMhj"ubah}(h]h ]h"]h$]h&]uh1jhj"ubeh}(h]h ]h"]h$]h&]uh1jhj"hMhj!ubah}(h]h ]h"]h$]h&]uh1jhj!ubeh}(h]h ] kernelindentah"]h$]h&]uh1jfhjhhhNhNubj)}(hhh]h}(h]h ]h"]h$]h&]entries](j&aead_request_set_callback (C function)c.aead_request_set_callbackhNtauh1jhjhhhNhNubj)}(hhh](j)}(hkvoid aead_request_set_callback (struct aead_request *req, u32 flags, crypto_completion_t compl, void *data)h]j)}(hjvoid aead_request_set_callback(struct aead_request *req, u32 flags, crypto_completion_t compl, void *data)h](j)}(hvoidh]hvoid}(hj`"hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj\"hhhU/var/lib/git/docbuild/linux/Documentation/crypto/api-aead:25: ./include/crypto/aead.hhMubj)}(h h]h }(hjo"hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj\"hhhjn"hMubj )}(haead_request_set_callbackh]j)}(haead_request_set_callbackh]haead_request_set_callback}(hj"hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj}"ubah}(h]h ](j#j$eh"]h$]h&]j(j)uh1j hj\"hhhjn"hMubjz)}(hL(struct aead_request *req, u32 flags, crypto_completion_t compl, void *data)h](j)}(hstruct aead_request *reqh](j)}(hjh]hstruct}(hj"hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj"ubj)}(h h]h }(hj"hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj"ubh)}(hhh]j)}(h aead_requesth]h aead_request}(hj"hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj"ubah}(h]h ]h"]h$]h&] refdomainj[reftypej0 reftargetj"modnameN classnameNj4j7)}j:]j=)}j0j"sbc.aead_request_set_callbackasbuh1hhj"ubj)}(h h]h }(hj"hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj"ubjR)}(hjUh]h*}(hj"hhhNhNubah}(h]h ]j^ah"]h$]h&]uh1jQhj"ubj)}(hreqh]hreq}(hj"hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj"ubeh}(h]h ]h"]h$]h&]noemphj(j)uh1jhj"ubj)}(h u32 flagsh](h)}(hhh]j)}(hu32h]hu32}(hj#hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj#ubah}(h]h ]h"]h$]h&] refdomainj[reftypej0 reftargetj#modnameN classnameNj4j7)}j:]j"c.aead_request_set_callbackasbuh1hhj #ubj)}(h h]h }(hj0#hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj #ubj)}(hflagsh]hflags}(hj>#hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj #ubeh}(h]h ]h"]h$]h&]noemphj(j)uh1jhj"ubj)}(hcrypto_completion_t complh](h)}(hhh]j)}(hcrypto_completion_th]hcrypto_completion_t}(hjZ#hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjW#ubah}(h]h ]h"]h$]h&] refdomainj[reftypej0 reftargetj\#modnameN classnameNj4j7)}j:]j"c.aead_request_set_callbackasbuh1hhjS#ubj)}(h h]h }(hjx#hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjS#ubj)}(hcomplh]hcompl}(hj#hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjS#ubeh}(h]h ]h"]h$]h&]noemphj(j)uh1jhj"ubj)}(h void *datah](j)}(hvoidh]hvoid}(hj#hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj#ubj)}(h h]h }(hj#hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj#ubjR)}(hjUh]h*}(hj#hhhNhNubah}(h]h ]j^ah"]h$]h&]uh1jQhj#ubj)}(hdatah]hdata}(hj#hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj#ubeh}(h]h ]h"]h$]h&]noemphj(j)uh1jhj"ubeh}(h]h ]h"]h$]h&]j(j)uh1jyhj\"hhhjn"hMubeh}(h]h ]h"]h$]h&]j(j)j0uh1jj1j2hjX"hhhjn"hMubah}(h]jS"ah ](j6j7eh"]h$]h&]j;j<)j=huh1jhjn"hMhjU"hhubj?)}(hhh]h)}(h"set asynchronous callback functionh]h"set asynchronous callback function}(hj#hhhNhNubah}(h]h ]h"]h$]h&]uh1hhU/var/lib/git/docbuild/linux/Documentation/crypto/api-aead:25: ./include/crypto/aead.hhMhj#hhubah}(h]h ]h"]h$]h&]uh1j>hjU"hhhjn"hMubeh}(h]h ](j[functioneh"]h$]h&]j`j[jaj $jbj $jcjdjeuh1jhhhjhNhNubjg)}(hX**Parameters** ``struct aead_request *req`` request handle ``u32 flags`` specify zero or an ORing of the flags CRYPTO_TFM_REQ_MAY_BACKLOG the request queue may back log and increase the wait queue beyond the initial maximum size; CRYPTO_TFM_REQ_MAY_SLEEP the request processing may sleep ``crypto_completion_t compl`` callback function pointer to be registered with the request handle ``void *data`` The data pointer refers to memory that is not used by the kernel crypto API, but provided to the callback function for it to use. Here, the caller can provide a reference to memory the callback function can operate on. As the callback function is invoked asynchronously to the related functionality, it may need to access data structures of the related functionality which can be referenced using this pointer. The callback function can access the memory via the "data" field in the crypto_async_request data structure provided to the callback function. **Description** Setting the callback function that is triggered once the cipher operation completes The callback function is registered with the aead_request handle and must comply with the following template:: void callback_function(struct crypto_async_request *req, int error)h](h)}(h**Parameters**h]jq)}(hj$h]h Parameters}(hj$hhhNhNubah}(h]h ]h"]h$]h&]uh1jphj$ubah}(h]h ]h"]h$]h&]uh1hhU/var/lib/git/docbuild/linux/Documentation/crypto/api-aead:25: ./include/crypto/aead.hhM!hj$ubj)}(hhh](j)}(h,``struct aead_request *req`` request handle h](j)}(h``struct aead_request *req``h]j)}(hj3$h]hstruct aead_request *req}(hj5$hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj1$ubah}(h]h ]h"]h$]h&]uh1jhU/var/lib/git/docbuild/linux/Documentation/crypto/api-aead:25: ./include/crypto/aead.hhMhj-$ubj)}(hhh]h)}(hrequest handleh]hrequest handle}(hjL$hhhNhNubah}(h]h ]h"]h$]h&]uh1hhjH$hMhjI$ubah}(h]h ]h"]h$]h&]uh1jhj-$ubeh}(h]h ]h"]h$]h&]uh1jhjH$hMhj*$ubj)}(h``u32 flags`` specify zero or an ORing of the flags CRYPTO_TFM_REQ_MAY_BACKLOG the request queue may back log and increase the wait queue beyond the initial maximum size; CRYPTO_TFM_REQ_MAY_SLEEP the request processing may sleep h](j)}(h ``u32 flags``h]j)}(hjl$h]h u32 flags}(hjn$hhhNhNubah}(h]h ]h"]h$]h&]uh1jhjj$ubah}(h]h ]h"]h$]h&]uh1jhU/var/lib/git/docbuild/linux/Documentation/crypto/api-aead:25: ./include/crypto/aead.hhM"hjf$ubj)}(hhh]h)}(hspecify zero or an ORing of the flags CRYPTO_TFM_REQ_MAY_BACKLOG the request queue may back log and increase the wait queue beyond the initial maximum size; CRYPTO_TFM_REQ_MAY_SLEEP the request processing may sleeph]hspecify zero or an ORing of the flags CRYPTO_TFM_REQ_MAY_BACKLOG the request queue may back log and increase the wait queue beyond the initial maximum size; CRYPTO_TFM_REQ_MAY_SLEEP the request processing may sleep}(hj$hhhNhNubah}(h]h ]h"]h$]h&]uh1hhU/var/lib/git/docbuild/linux/Documentation/crypto/api-aead:25: ./include/crypto/aead.hhMhj$ubah}(h]h ]h"]h$]h&]uh1jhjf$ubeh}(h]h ]h"]h$]h&]uh1jhj$hM"hj*$ubj)}(ha``crypto_completion_t compl`` callback function pointer to be registered with the request handle h](j)}(h``crypto_completion_t compl``h]j)}(hj$h]hcrypto_completion_t compl}(hj$hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj$ubah}(h]h ]h"]h$]h&]uh1jhU/var/lib/git/docbuild/linux/Documentation/crypto/api-aead:25: ./include/crypto/aead.hhM#hj$ubj)}(hhh]h)}(hBcallback function pointer to be registered with the request handleh]hBcallback function pointer to be registered with the request handle}(hj$hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj$hM#hj$ubah}(h]h ]h"]h$]h&]uh1jhj$ubeh}(h]h ]h"]h$]h&]uh1jhj$hM#hj*$ubj)}(hX9``void *data`` The data pointer refers to memory that is not used by the kernel crypto API, but provided to the callback function for it to use. Here, the caller can provide a reference to memory the callback function can operate on. As the callback function is invoked asynchronously to the related functionality, it may need to access data structures of the related functionality which can be referenced using this pointer. The callback function can access the memory via the "data" field in the crypto_async_request data structure provided to the callback function. h](j)}(h``void *data``h]j)}(hj$h]h void *data}(hj$hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj$ubah}(h]h ]h"]h$]h&]uh1jhU/var/lib/git/docbuild/linux/Documentation/crypto/api-aead:25: ./include/crypto/aead.hhM+hj$ubj)}(hhh]h)}(hX)The data pointer refers to memory that is not used by the kernel crypto API, but provided to the callback function for it to use. Here, the caller can provide a reference to memory the callback function can operate on. As the callback function is invoked asynchronously to the related functionality, it may need to access data structures of the related functionality which can be referenced using this pointer. The callback function can access the memory via the "data" field in the crypto_async_request data structure provided to the callback function.}fh]hX-The data pointer refers to memory that is not used by the kernel crypto API, but provided to the callback function for it to use. Here, the caller can provide a reference to memory the callback function can operate on. As the callback function is invoked asynchronously to the related functionality, it may need to access data structures of the related functionality which can be referenced using this pointer. The callback function can access the memory via the “data” field in the crypto_async_request data structure provided to the callback function.}(hj$hhhNhNubah}(h]h ]h"]h$]h&]uh1hhU/var/lib/git/docbuild/linux/Documentation/crypto/api-aead:25: ./include/crypto/aead.hhM$hj$ubah}(h]h ]h"]h$]h&]uh1jhj$ubeh}(h]h ]h"]h$]h&]uh1jhj$hM+hj*$ubeh}(h]h ]h"]h$]h&]uh1jhj$ubh)}(h**Description**h]jq)}(hj%h]h Description}(hj%hhhNhNubah}(h]h ]h"]h$]h&]uh1jphj%ubah}(h]h ]h"]h$]h&]uh1hhU/var/lib/git/docbuild/linux/Documentation/crypto/api-aead:25: ./include/crypto/aead.hhM-hj$ubh)}(hSSetting the callback function that is triggered once the cipher operation completesh]hSSetting the callback function that is triggered once the cipher operation completes}(hj1%hhhNhNubah}(h]h ]h"]h$]h&]uh1hhU/var/lib/git/docbuild/linux/Documentation/crypto/api-aead:25: ./include/crypto/aead.hhM,hj$ubh)}(hnThe callback function is registered with the aead_request handle and must comply with the following template::h]hmThe callback function is registered with the aead_request handle and must comply with the following template:}(hj@%hhhNhNubah}(h]h ]h"]h$]h&]uh1hhU/var/lib/git/docbuild/linux/Documentation/crypto/api-aead:25: ./include/crypto/aead.hhM/hj$ubj)}(hCvoid callback_function(struct crypto_async_request *req, int error)h]hCvoid callback_function(struct crypto_async_request *req, int error)}hjO%sbah}(h]h ]h"]h$]h&]j(j)uh1jhU/var/lib/git/docbuild/linux/Documentation/crypto/api-aead:25: ./include/crypto/aead.hhM2hj$ubeh}(h]h ] kernelindentah"]h$]h&]uh1jfhjhhhNhNubj)}(hhh]h}(h]h ]h"]h$]h&]entries](j#aead_request_set_crypt (C function)c.aead_request_set_crypthNtauh1jhjhhhNhNubj)}(hhh](j)}(hvoid aead_request_set_crypt (struct aead_request *req, struct scatterlist *src, struct scatterlist *dst, unsigned int cryptlen, u8 *iv)h]j)}(hvoid aead_request_set_crypt(struct aead_request *req, struct scatterlist *src, struct scatterlist *dst, unsigned int cryptlen, u8 *iv)h](j)}(hvoidh]hvoid}(hj~%hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjz%hhhU/var/lib/git/docbuild/linux/Documentation/crypto/api-aead:25: ./include/crypto/aead.hhM@ubj)}(h h]h }(hj%hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjz%hhhj%hM@ubj )}(haead_request_set_crypth]j)}(haead_request_set_crypth]haead_request_set_crypt}(hj%hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj%ubah}(h]h ](j#j$eh"]h$]h&]j(j)uh1j hjz%hhhj%hM@ubjz)}(hk(struct aead_request *req, struct scatterlist *src, struct scatterlist *dst, unsigned int cryptlen, u8 *iv)h](j)}(hstruct aead_request *reqh](j)}(hjh]hstruct}(hj%hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj%ubj)}(h h]h }(hj%hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj%ubh)}(hhh]j)}(h aead_requesth]h aead_request}(hj%hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj%ubah}(h]h ]h"]h$]h&] refdomainj[reftypej0 reftargetj%modnameN classnameNj4j7)}j:]j=)}j0j%sbc.aead_request_set_cryptasbuh1hhj%ubj)}(h h]h }(hj%hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj%ubjR)}(hjUh]h*}(hj&hhhNhNubah}(h]h ]j^ah"]h$]h&]uh1jQhj%ubj)}(hreqh]hreq}(hj&hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj%ubeh}(h]h ]h"]h$]h&]noemphj(j)uh1jhj%ubj)}(hstruct scatterlist *srch](j)}(hjh]hstruct}(hj-&hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj)&ubj)}(h h]h }(hj:&hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj)&ubh)}(hhh]j)}(h scatterlisth]h scatterlist}(hjK&hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjH&ubah}(h]h ]h"]h$]h&] refdomainj[reftypej0 reftargetjM&modnameN classnameNj4j7)}j:]j%c.aead_request_set_cryptasbuh1hhj)&ubj)}(h h]h }(hji&hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj)&ubjR)}(hjUh]h*}(hjw&hhhNhNubah}(h]h ]j^ah"]h$]h&]uh1jQhj)&ubj)}(hsrch]hsrc}(hj&hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj)&ubeh}(h]h ]h"]h$]h&]noemphj(j)uh1jhj%ubj)}(hstruct scatterlist *dsth](j)}(hjh]hstruct}(hj&hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj&ubj)}(h h]h }(hj&hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj&ubh)}(hhh]j)}(h scatterlisth]h scatterlist}(hj&hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj&ubah}(h]h ]h"]h$]h&] refdomainj[reftypej0 reftargetj&modnameN classnameNj4j7)}j:]j%c.aead_request_set_cryptasbuh1hhj&ubj)}(h h]h }(hj&hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj&ubjR)}(hjUh]h*}(hj&hhhNhNubah}(h]h ]j^ah"]h$]h&]uh1jQhj&ubj)}(hdsth]hdst}(hj&hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj&ubeh}(h]h ]h"]h$]h&]noemphj(j)uh1jhj%ubj)}(hunsigned int cryptlenh](j)}(hunsignedh]hunsigned}(hj 'hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj 'ubj)}(h h]h }(hj'hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj 'ubj)}(hinth]hint}(hj)'hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj 'ubj)}(h h]h }(hj7'hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj 'ubj)}(hcryptlenh]hcryptlen}(hjE'hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj 'ubeh}(h]h ]h"]h$]h&]noemphj(j)uh1jhj%ubj)}(hu8 *ivh](h)}(hhh]j)}(hu8h]hu8}(hja'hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj^'ubah}(h]h ]h"]h$]h&] refdomainj[reftypej0 reftargetjc'modnameN classnameNj4j7)}j:]j%c.aead_request_set_cryptasbuh1hhjZ'ubj)}(h h]h }(hj'hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjZ'ubjR)}(hjUh]h*}(hj'hhhNhNubah}(h]h ]j^ah"]h$]h&]uh1jQhjZ'ubj)}(hivh]hiv}(hj'hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjZ'ubeh}(h]h ]h"]h$]h&]noemphj(j)uh1jhj%ubeh}(h]h ]h"]h$]h&]j(j)uh1jyhjz%hhhj%hM@ubeh}(h]h ]h"]h$]h&]j(j)j0uh1jj1j2hjv%hhhj%hM@ubah}(h]jq%ah ](j6j7eh"]h$]h&]j;j<)j=huh1jhj%hM@hjs%hhubj?)}(hhh]h)}(hset data buffersh]hset data buffers}(hj'hhhNhNubah}(h]h ]h"]h$]h&]uh1hhU/var/lib/git/docbuild/linux/Documentation/crypto/api-aead:25: ./include/crypto/aead.hhM@hj'hhubah}(h]h ]h"]h$]h&]uh1j>hjs%hhhj%hM@ubeh}(h]h ](j[functioneh"]h$]h&]j`j[jaj'jbj'jcjdjeuh1jhhhjhNhNubjg)}(hXc**Parameters** ``struct aead_request *req`` request handle ``struct scatterlist *src`` source scatter / gather list ``struct scatterlist *dst`` destination scatter / gather list ``unsigned int cryptlen`` number of bytes to process from **src** ``u8 *iv`` IV for the cipher operation which must comply with the IV size defined by crypto_aead_ivsize() **Description** Setting the source data and destination data scatter / gather lists which hold the associated data concatenated with the plaintext or ciphertext. See below for the authentication tag. For encryption, the source is treated as the plaintext and the destination is the ciphertext. For a decryption operation, the use is reversed - the source is the ciphertext and the destination is the plaintext. The memory structure for cipher operation has the following structure: - AEAD encryption input: assoc data || plaintext - AEAD encryption output: assoc data || ciphertext || auth tag - AEAD decryption input: assoc data || ciphertext || auth tag - AEAD decryption output: assoc data || plaintext Albeit the kernel requires the presence of the AAD buffer, however, the kernel does not fill the AAD buffer in the output case. If the caller wants to have that data buffer filled, the caller must either use an in-place cipher operation (i.e. same memory location for input/output memory location).h](h)}(h**Parameters**h]jq)}(hj'h]h Parameters}(hj'hhhNhNubah}(h]h ]h"]h$]h&]uh1jphj'ubah}(h]h ]h"]h$]h&]uh1hhU/var/lib/git/docbuild/linux/Documentation/crypto/api-aead:25: ./include/crypto/aead.hhMDhj'ubj)}(hhh](j)}(h,``struct aead_request *req`` request handle h](j)}(h``struct aead_request *req``h]j)}(hj(h]hstruct aead_request *req}(hj(hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj(ubah}(h]h ]h"]h$]h&]uh1jhU/var/lib/git/docbuild/linux/Documentation/crypto/api-aead:25: ./include/crypto/aead.hhMAhj'ubj)}(hhh]h)}(hrequest handleh]hrequest handle}(hj(hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj(hMAhj(ubah}(h]h ]h"]h$]h&]uh1jhj'ubeh}(h]h ]h"]h$]h&]uh1jhj(hMAhj'ubj)}(h9``struct scatterlist *src`` source scatter / gather list h](j)}(h``struct scatterlist *src``h]j)}(hj>(h]hstruct scatterlist *src}(hj@(hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj<(ubah}(h]h ]h"]h$]h&]uh1jhU/var/lib/git/docbuild/linux/Documentation/crypto/api-aead:25: ./include/crypto/aead.hhMBhj8(ubj)}(hhh]h)}(hsource scatter / gather listh]hsource scatter / gather list}(hjW(hhhNhNubah}(h]h ]h"]h$]h&]uh1hhjS(hMBhjT(ubah}(h]h ]h"]h$]h&]uh1jhj8(ubeh}(h]h ]h"]h$]h&]uh1jhjS(hMBhj'ubj)}(h>``struct scatterlist *dst`` destination scatter / gather list h](j)}(h``struct scatterlist *dst``h]j)}(hjw(h]hstruct scatterlist *dst}(hjy(hhhNhNubah}(h]h ]h"]h$]h&]uh1jhju(ubah}(h]h ]h"]h$]h&]uh1jhU/var/lib/git/docbuild/linux/Documentation/crypto/api-aead:25: ./include/crypto/aead.hhMChjq(ubj)}(hhh]h)}(h!destination scatter / gather listh]h!destination scatter / gather list}(hj(hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj(hMChj(ubah}(h]h ]h"]h$]h&]uh1jhjq(ubeh}(h]h ]h"]h$]h&]uh1jhj(hMChj'ubj)}(hB``unsigned int cryptlen`` number of bytes to process from **src** h](j)}(h``unsigned int cryptlen``h]j)}(hj(h]hunsigned int cryptlen}(hj(hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj(ubah}(h]h ]h"]h$]h&]uh1jhU/var/lib/git/docbuild/linux/Documentation/crypto/api-aead:25: ./include/crypto/aead.hhMDhj(ubj)}(hhh]h)}(h'number of bytes to process from **src**h](h number of bytes to process from }(hj(hhhNhNubjq)}(h**src**h]hsrc}(hj(hhhNhNubah}(h]h ]h"]h$]h&]uh1jphj(ubeh}(h]h ]h"]h$]h&]uh1hhj(hMDhj(ubah}(h]h ]h"]h$]h&]uh1jhj(ubeh}(h]h ]h"]h$]h&]uh1jhj(hMDhj'ubj)}(hj``u8 *iv`` IV for the cipher operation which must comply with the IV size defined by crypto_aead_ivsize() h](j)}(h ``u8 *iv``h]j)}(hj(h]hu8 *iv}(hj(hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj(ubah}(h]h ]h"]h$]h&]uh1jhU/var/lib/git/docbuild/linux/Documentation/crypto/api-aead:25: ./include/crypto/aead.hhMFhj(ubj)}(hhh]h)}(h^IV for the cipher operation which must comply with the IV size defined by crypto_aead_ivsize()h]h^IV for the cipher operation which must comply with the IV size defined by crypto_aead_ivsize()}(hj)hhhNhNubah}(h]h ]h"]h$]h&]uh1hhU/var/lib/git/docbuild/linux/Documentation/crypto/api-aead:25: ./include/crypto/aead.hhMEhj )ubah}(h]h ]h"]h$]h&]uh1jhj(ubeh}(h]h ]h"]h$]h&]uh1jhj )hMFhj'ubeh}(h]h ]h"]h$]h&]uh1jhj'ubh)}(h**Description**h]jq)}(hj3)h]h Description}(hj5)hhhNhNubah}(h]h ]h"]h$]h&]uh1jphj1)ubah}(h]h ]h"]h$]h&]uh1hhU/var/lib/git/docbuild/linux/Documentation/crypto/api-aead:25: ./include/crypto/aead.hhMHhj'ubh)}(hSetting the source data and destination data scatter / gather lists which hold the associated data concatenated with the plaintext or ciphertext. See below for the authentication tag.h]hSetting the source data and destination data scatter / gather lists which hold the associated data concatenated with the plaintext or ciphertext. See below for the authentication tag.}(hjI)hhhNhNubah}(h]h ]h"]h$]h&]uh1hhU/var/lib/git/docbuild/linux/Documentation/crypto/api-aead:25: ./include/crypto/aead.hhMGhj'ubh)}(hFor encryption, the source is treated as the plaintext and the destination is the ciphertext. For a decryption operation, the use is reversed - the source is the ciphertext and the destination is the plaintext.h]hFor encryption, the source is treated as the plaintext and the destination is the ciphertext. For a decryption operation, the use is reversed - the source is the ciphertext and the destination is the plaintext.}(hjX)hhhNhNubah}(h]h ]h"]h$]h&]uh1hhU/var/lib/git/docbuild/linux/Documentation/crypto/api-aead:25: ./include/crypto/aead.hhMKhj'ubh)}(hFThe memory structure for cipher operation has the following structure:h]hFThe memory structure for cipher operation has the following structure:}(hjg)hhhNhNubah}(h]h ]h"]h$]h&]uh1hhU/var/lib/git/docbuild/linux/Documentation/crypto/api-aead:25: ./include/crypto/aead.hhMOhj'ubh bullet_list)}(hhh](h list_item)}(h/AEAD encryption input: assoc data || plaintexth]h)}(hj)h]h/AEAD encryption input: assoc data || plaintext}(hj)hhhNhNubah}(h]h ]h"]h$]h&]uh1hhU/var/lib/git/docbuild/linux/Documentation/crypto/api-aead:25: ./include/crypto/aead.hhMQhj})ubah}(h]h ]h"]h$]h&]uh1j{)hjx)ubj|))}(hhj *hhhj#*hMiubeh}(h]h ](j[functioneh"]h$]h&]j`j[jaj>+jbj>+jcjdjeuh1jhhhjhNhNubjg)}(h**Parameters** ``struct aead_request *req`` request handle ``unsigned int assoclen`` number of bytes in associated data **Description** Setting the AD information. This function sets the length of the associated data.h](h)}(h**Parameters**h]jq)}(hjH+h]h Parameters}(hjJ+hhhNhNubah}(h]h ]h"]h$]h&]uh1jphjF+ubah}(h]h ]h"]h$]h&]uh1hhU/var/lib/git/docbuild/linux/Documentation/crypto/api-aead:25: ./include/crypto/aead.hhMmhjB+ubj)}(hhh](j)}(h,``struct aead_request *req`` request handle h](j)}(h``struct aead_request *req``h]j)}(hjg+h]hstruct aead_request *req}(hji+hhhNhNubah}(h]h ]h"]h$]h&]uh1jhje+ubah}(h]h ]h"]h$]h&]uh1jhU/var/lib/git/docbuild/linux/Documentation/crypto/api-aead:25: ./include/crypto/aead.hhMjhja+ubj)}(hhh]h)}(hrequest handleh]hrequest handle}(hj+hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj|+hMjhj}+ubah}(h]h ]h"]h$]h&]uh1jhja+ubeh}(h]h ]h"]h$]h&]uh1jhj|+hMjhj^+ubj)}(h=``unsigned int assoclen`` number of bytes in associated data h](j)}(h``unsigned int assoclen``h]j)}(hj+h]hunsigned int assoclen}(hj+hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj+ubah}(h]h ]h"]h$]h&]uh1jhU/var/lib/git/docbuild/linux/Documentation/crypto/api-aead:25: ./include/crypto/aead.hhMkhj+ubj)}(hhh]h)}(h"number of bytes in associated datah]h"number of bytes in associated data}(hj+hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj+hMkhj+ubah}(h]h ]h"]h$]h&]uh1jhj+ubeh}(h]h ]h"]h$]h&]uh1jhj+hMkhj^+ubeh}(h]h ]h"]h$]h&]uh1jhjB+ubh)}(h**Description**h]jq)}(hj+h]h Description}(hj+hhhNhNubah}(h]h ]h"]h$]h&]uh1jphj+ubah}(h]h ]h"]h$]h&]uh1hhU/var/lib/git/docbuild/linux/Documentation/crypto/api-aead:25: ./include/crypto/aead.hhMmhjB+ubh)}(hRSetting the AD information. This function sets the length of the associated data.h]hRSetting the AD information. This function sets the length of the associated data.}(hj+hhhNhNubah}(h]h ]h"]h$]h&]uh1hhU/var/lib/git/docbuild/linux/Documentation/crypto/api-aead:25: ./include/crypto/aead.hhMlhjB+ubeh}(h]h ] kernelindentah"]h$]h&]uh1jfhjhhhNhNubeh}(h] asynchronous-aead-request-handleah ]h"] asynchronous aead request handleah$]h&]uh1hhhhhhhhKubeh}(h]2authenticated-encryption-with-associated-data-aeadah ]h"]4authenticated encryption with associated data (aead)ah$]h&]uh1hhhhhhhhKubeh}(h]h ]h"]h$]h&]sourcehuh1hcurrent_sourceN current_lineNsettingsdocutils.frontendValues)}(hN generatorN datestampN source_linkN source_urlN toc_backlinksentryfootnote_backlinksK sectnum_xformKstrip_commentsNstrip_elements_with_classesN strip_classesN report_levelK halt_levelKexit_status_levelKdebugNwarning_streamN tracebackinput_encoding utf-8-siginput_encoding_error_handlerstrictoutput_encodingutf-8output_encoding_error_handlerj:,error_encodingutf-8error_encoding_error_handlerbackslashreplace language_codeenrecord_dependenciesNconfigN id_prefixhauto_id_prefixid dump_settingsNdump_internalsNdump_transformsNdump_pseudo_xmlNexpose_internalsNstrict_visitorN_disable_configN_sourcehʌ _destinationN _config_files]7/var/lib/git/docbuild/linux/Documentation/docutils.confafile_insertion_enabled raw_enabledKline_length_limitM'pep_referencesN pep_base_urlhttps://peps.python.org/pep_file_url_templatepep-%04drfc_referencesN rfc_base_url&https://datatracker.ietf.org/doc/html/ tab_widthKtrim_footnote_reference_spacesyntax_highlightlong smart_quotessmartquotes_locales]character_level_inline_markupdoctitle_xform docinfo_xformKsectsubtitle_xform image_loadinglinkembed_stylesheetcloak_email_addressessection_self_linkenvNubreporterNindirect_targets]substitution_defs}substitution_names}refnames}refids}nameids}(j,j,jjjjj ,j ,u nametypes}(j,jjj ,uh}(j,hjhjjjjjojjjjj j jh jm j,j1jjjjjjjjjjj ,jjjjjjojjj j jS"jX"jq%jv%j*j *u footnote_refs} citation_refs} autofootnotes]autofootnote_refs]symbol_footnotes]symbol_footnote_refs] footnotes] citations]autofootnote_startKsymbol_footnote_startK id_counter collectionsCounter}Rparse_messages]transform_messages] transformerN include_log] decorationNhhub.