crypto/internal/cipher.h

23  * The single block cipher API is used with the ciphers of type
24  * CRYPTO_ALG_TYPE_CIPHER (listed as type "cipher" in /proc/crypto).
26  * Using the single block cipher API calls, operations with the basic cipher
27  * primitive can be implemented. These cipher primitives exclude any block
30  * The purpose of this single block cipher API is to support the implementation
31  * of templates or other concepts that only need to perform the cipher operation
32  * on one block at a time. Templates invoke the underlying cipher primitive
33  * block-wise and process either the input or the output data of these cipher
43  * crypto_alloc_cipher() - allocate single block cipher handle
45  *	     single block cipher
46  * @type: specifies the type of the cipher
47  * @mask: specifies the mask for the cipher
49  * Allocate a cipher handle for a single block cipher. The returned struct
50  * crypto_cipher is the cipher handle that is required for any subsequent API
51  * invocation for that single block cipher.
53  * Return: allocated cipher handle in case of success; IS_ERR() is true in case
72  * crypto_free_cipher() - zeroize and free the single block cipher handle
73  * @tfm: cipher handle to be freed
81  * crypto_has_cipher() - Search for the availability of a single block cipher
83  *	     single block cipher
84  * @type: specifies the type of the cipher
85  * @mask: specifies the mask for the cipher
87  * Return: true when the single block cipher is known to the kernel crypto API;
100  * crypto_cipher_blocksize() - obtain block size for cipher
101  * @tfm: cipher handle
103  * The block size for the single block cipher referenced with the cipher handle
107  * Return: block size of cipher
137  * crypto_cipher_setkey() - set key for cipher
138  * @tfm: cipher handle
142  * The caller provided key is set for the single block cipher referenced by the
143  * cipher handle.
145  * Note, the key length determines the cipher type. Many block ciphers implement
146  * different cipher modes depending on the key size, such as AES-128 vs AES-192
147  * vs. AES-256. When providing a 16 byte key for an AES cipher handle, AES-128
157  * @tfm: cipher handle
169  * @tfm: cipher handle
179 struct crypto_cipher *crypto_clone_cipher(struct crypto_cipher *cipher);