include/crypto/skcipher.h

21  *	struct skcipher_request - Symmetric key cipher request
53  * struct crypto_istat_cipher - statistics for cipher algorithm
58  * @err_cnt:		number of error for cipher requests
69  * struct skcipher_alg - symmetric key cipher definition
121  * @stat: Statistics for cipher algorithm
161  * DOC: Symmetric Key Cipher API
163  * Symmetric key cipher API is used with the ciphers of type
166  * Asynchronous cipher operations imply that the function invocation for a
167  * cipher request returns immediately before the completion of the operation.
168  * The cipher request is scheduled as a separate kernel thread and therefore
170  * the kernel crypto API to inform the caller about the completion of a cipher
172  * invoked with the cipher handle when the request completes.
175  * cipher handle must be supplied to the kernel crypto API. That additional
178  * For the symmetric key cipher API, the state is maintained with the tfm
179  * cipher handle. A single tfm can be used across multiple calls and in
180  * parallel. For asynchronous block cipher calls, context data supplied and
182  * addition to the IV used for the cipher request. The maintenance of such
185  * cipher operation, that callback function may need some information about
197  * crypto_alloc_skcipher() - allocate symmetric key cipher handle
199  *	      skcipher cipher
200  * @type: specifies the type of the cipher
201  * @mask: specifies the mask for the cipher
203  * Allocate a cipher handle for an skcipher. The returned struct
204  * crypto_skcipher is the cipher handle that is required for any subsequent
207  * Return: allocated cipher handle in case of success; IS_ERR() is true in case
223  * crypto_free_skcipher() - zeroize and free cipher handle
224  * @tfm: cipher handle to be freed
270  * @tfm: cipher handle
272  * The size of the IV for the skcipher referenced by the cipher handle is
273  * returned. This IV size may be zero if the cipher does not need an IV.
289  * crypto_skcipher_blocksize() - obtain block size of cipher
290  * @tfm: cipher handle
292  * The block size for the skcipher referenced with the cipher handle is
296  * Return: block size of cipher
312  * @tfm: cipher handle
375  * crypto_skcipher_setkey() - set key for cipher
376  * @tfm: cipher handle
380  * The caller provided key is set for the skcipher referenced by the cipher
383  * Note, the key length determines the cipher type. Many block ciphers implement
384  * different cipher modes depending on the key size, such as AES-128 vs AES-192
385  * vs. AES-256. When providing a 16 byte key for an AES cipher handle, AES-128
412  * crypto_skcipher_reqtfm() - obtain cipher handle from request
413  * @req: skcipher_request out of which the cipher handle is to be obtained
437  *	 needed to perform the cipher operation
443  * Return: 0 if the cipher operation was successful; < 0 if an error occurred
450  *	 needed to perform the cipher operation
456  * Return: 0 if the cipher operation was successful; < 0 if an error occurred
461  * DOC: Symmetric Key Cipher Request Handle
464  * required for the symmetric key cipher operation. This includes the cipher
473  * @tfm: cipher handle
483  * skcipher_request_set_tfm() - update cipher handle reference in request
485  * @tfm: cipher handle that shall be added to the request handle
510  * @tfm: cipher handle to be registered with the request
535  * @req: request data structure cipher handle to be freed
567  * cipher operation completes.
590  * @iv: IV for the cipher operation which must comply with the IV size defined