include/crypto/skcipher.h

32  *	struct skcipher_request - Symmetric key cipher request
98  * struct skcipher_alg - symmetric key cipher definition
170  * struct lskcipher_alg - linear symmetric key cipher definition
230  * DOC: Symmetric Key Cipher API
232  * Symmetric key cipher API is used with the ciphers of type
235  * Asynchronous cipher operations imply that the function invocation for a
236  * cipher request returns immediately before the completion of the operation.
237  * The cipher request is scheduled as a separate kernel thread and therefore
239  * the kernel crypto API to inform the caller about the completion of a cipher
241  * invoked with the cipher handle when the request completes.
244  * cipher handle must be supplied to the kernel crypto API. That additional
247  * For the symmetric key cipher API, the state is maintained with the tfm
248  * cipher handle. A single tfm can be used across multiple calls and in
249  * parallel. For asynchronous block cipher calls, context data supplied and
251  * addition to the IV used for the cipher request. The maintenance of such
254  * cipher operation, that callback function may need some information about
266  * crypto_alloc_skcipher() - allocate symmetric key cipher handle
268  *	      skcipher cipher
269  * @type: specifies the type of the cipher
270  * @mask: specifies the mask for the cipher
272  * Allocate a cipher handle for an skcipher. The returned struct
273  * crypto_skcipher is the cipher handle that is required for any subsequent
276  * Return: allocated cipher handle in case of success; IS_ERR() is true in case
287  * crypto_alloc_lskcipher() - allocate linear symmetric key cipher handle
290  * @type: specifies the type of the cipher
291  * @mask: specifies the mask for the cipher
293  * Allocate a cipher handle for an lskcipher. The returned struct
294  * crypto_lskcipher is the cipher handle that is required for any subsequent
297  * Return: allocated cipher handle in case of success; IS_ERR() is true in case
322  * crypto_free_skcipher() - zeroize and free cipher handle
323  * @tfm: cipher handle to be freed
338  * crypto_free_lskcipher() - zeroize and free cipher handle
339  * @tfm: cipher handle to be freed
395  * @tfm: cipher handle
397  * The size of the IV for the skcipher referenced by the cipher handle is
398  * returned. This IV size may be zero if the cipher does not need an IV.
415  * @tfm: cipher handle
417  * The size of the IV for the lskcipher referenced by the cipher handle is
418  * returned. This IV size may be zero if the cipher does not need an IV.
429  * crypto_skcipher_blocksize() - obtain block size of cipher
430  * @tfm: cipher handle
432  * The block size for the skcipher referenced with the cipher handle is
436  * Return: block size of cipher
445  * crypto_lskcipher_blocksize() - obtain block size of cipher
446  * @tfm: cipher handle
448  * The block size for the lskcipher referenced with the cipher handle is
452  * Return: block size of cipher
462  * @tfm: cipher handle
479  * @tfm: cipher handle
496  * @tfm: cipher handle
513  * @tfm: cipher handle
599  * crypto_skcipher_setkey() - set key for cipher
600  * @tfm: cipher handle
604  * The caller provided key is set for the skcipher referenced by the cipher
607  * Note, the key length determines the cipher type. Many block ciphers implement
608  * different cipher modes depending on the key size, such as AES-128 vs AES-192
609  * vs. AES-256. When providing a 16 byte key for an AES cipher handle, AES-128
624  * crypto_lskcipher_setkey() - set key for cipher
625  * @tfm: cipher handle
629  * The caller provided key is set for the lskcipher referenced by the cipher
632  * Note, the key length determines the cipher type. Many block ciphers implement
633  * different cipher modes depending on the key size, such as AES-128 vs AES-192
634  * vs. AES-256. When providing a 16 byte key for an AES cipher handle, AES-128
667  * crypto_skcipher_reqtfm() - obtain cipher handle from request
668  * @req: skcipher_request out of which the cipher handle is to be obtained
692  *	 needed to perform the cipher operation
698  * Return: 0 if the cipher operation was successful; < 0 if an error occurred
705  *	 needed to perform the cipher operation
711  * Return: 0 if the cipher operation was successful; < 0 if an error occurred
729  * Return: 0 if the cipher operation was successful; < 0 if an error occurred
744  * Return: 0 if the cipher operation was successful; < 0 if an error occurred
754  * @siv: IV + state for the cipher operation.  The length of the IV must
760  * Return: >=0 if the cipher operation was successful, if positive
773  * @siv: IV + state for the cipher operation.  The length of the IV must
780  * Return: >=0 if the cipher operation was successful, if positive
788  * DOC: Symmetric Key Cipher Request Handle
791  * required for the symmetric key cipher operation. This includes the cipher
800  * @tfm: cipher handle
810  * skcipher_request_set_tfm() - update cipher handle reference in request
812  * @tfm: cipher handle that shall be added to the request handle
837  * @tfm: cipher handle to be registered with the request
863  * @req: request data structure cipher handle to be freed
895  * cipher operation completes.
918  * @iv: IV for the cipher operation which must comply with the IV size defined