2 * Scatterlist Cryptographic API.
4 * Copyright (c) 2002 James Morris <jmorris@intercode.com.au>
5 * Copyright (c) 2002 David S. Miller (davem@redhat.com)
6 * Copyright (c) 2005 Herbert Xu <herbert@gondor.apana.org.au>
8 * Portions derived from Cryptoapi, by Alexander Kjeldaas <astor@fast.no>
9 * and Nettle, by Niels Möller.
11 * This program is free software; you can redistribute it and/or modify it
12 * under the terms of the GNU General Public License as published by the Free
13 * Software Foundation; either version 2 of the License, or (at your option)
17 #ifndef _LINUX_CRYPTO_H
18 #define _LINUX_CRYPTO_H
20 #include <linux/atomic.h>
21 #include <linux/kernel.h>
22 #include <linux/list.h>
23 #include <linux/bug.h>
24 #include <linux/slab.h>
25 #include <linux/string.h>
26 #include <linux/uaccess.h>
29 * Autoloaded crypto modules should only use a prefixed name to avoid allowing
30 * arbitrary modules to be loaded. Loading from userspace may still need the
31 * unprefixed names, so retains those aliases as well.
32 * This uses __MODULE_INFO directly instead of MODULE_ALIAS because pre-4.3
33 * gcc (e.g. avr32 toolchain) uses __LINE__ for uniqueness, and this macro
34 * expands twice on the same line. Instead, use a separate base name for the
37 #define MODULE_ALIAS_CRYPTO(name) \
38 __MODULE_INFO(alias, alias_userspace, name); \
39 __MODULE_INFO(alias, alias_crypto, "crypto-" name)
42 * Algorithm masks and types.
44 #define CRYPTO_ALG_TYPE_MASK 0x0000000f
45 #define CRYPTO_ALG_TYPE_CIPHER 0x00000001
46 #define CRYPTO_ALG_TYPE_COMPRESS 0x00000002
47 #define CRYPTO_ALG_TYPE_AEAD 0x00000003
48 #define CRYPTO_ALG_TYPE_BLKCIPHER 0x00000004
49 #define CRYPTO_ALG_TYPE_ABLKCIPHER 0x00000005
50 #define CRYPTO_ALG_TYPE_SKCIPHER 0x00000005
51 #define CRYPTO_ALG_TYPE_GIVCIPHER 0x00000006
52 #define CRYPTO_ALG_TYPE_KPP 0x00000008
53 #define CRYPTO_ALG_TYPE_RNG 0x0000000c
54 #define CRYPTO_ALG_TYPE_AKCIPHER 0x0000000d
55 #define CRYPTO_ALG_TYPE_DIGEST 0x0000000e
56 #define CRYPTO_ALG_TYPE_HASH 0x0000000e
57 #define CRYPTO_ALG_TYPE_SHASH 0x0000000e
58 #define CRYPTO_ALG_TYPE_AHASH 0x0000000f
60 #define CRYPTO_ALG_TYPE_HASH_MASK 0x0000000e
61 #define CRYPTO_ALG_TYPE_AHASH_MASK 0x0000000e
62 #define CRYPTO_ALG_TYPE_BLKCIPHER_MASK 0x0000000c
64 #define CRYPTO_ALG_LARVAL 0x00000010
65 #define CRYPTO_ALG_DEAD 0x00000020
66 #define CRYPTO_ALG_DYING 0x00000040
67 #define CRYPTO_ALG_ASYNC 0x00000080
70 * Set this bit if and only if the algorithm requires another algorithm of
71 * the same type to handle corner cases.
73 #define CRYPTO_ALG_NEED_FALLBACK 0x00000100
76 * This bit is set for symmetric key ciphers that have already been wrapped
77 * with a generic IV generator to prevent them from being wrapped again.
79 #define CRYPTO_ALG_GENIV 0x00000200
82 * Set if the algorithm has passed automated run-time testing. Note that
83 * if there is no run-time testing for a given algorithm it is considered
87 #define CRYPTO_ALG_TESTED 0x00000400
90 * Set if the algorithm is an instance that is build from templates.
92 #define CRYPTO_ALG_INSTANCE 0x00000800
94 /* Set this bit if the algorithm provided is hardware accelerated but
95 * not available to userspace via instruction set or so.
97 #define CRYPTO_ALG_KERN_DRIVER_ONLY 0x00001000
100 * Mark a cipher as a service implementation only usable by another
101 * cipher and never by a normal user of the kernel crypto API
103 #define CRYPTO_ALG_INTERNAL 0x00002000
106 * Transform masks and values (for crt_flags).
108 #define CRYPTO_TFM_REQ_MASK 0x000fff00
109 #define CRYPTO_TFM_RES_MASK 0xfff00000
111 #define CRYPTO_TFM_REQ_WEAK_KEY 0x00000100
112 #define CRYPTO_TFM_REQ_MAY_SLEEP 0x00000200
113 #define CRYPTO_TFM_REQ_MAY_BACKLOG 0x00000400
114 #define CRYPTO_TFM_RES_WEAK_KEY 0x00100000
115 #define CRYPTO_TFM_RES_BAD_KEY_LEN 0x00200000
116 #define CRYPTO_TFM_RES_BAD_KEY_SCHED 0x00400000
117 #define CRYPTO_TFM_RES_BAD_BLOCK_LEN 0x00800000
118 #define CRYPTO_TFM_RES_BAD_FLAGS 0x01000000
121 * Miscellaneous stuff.
123 #define CRYPTO_MAX_ALG_NAME 64
126 * The macro CRYPTO_MINALIGN_ATTR (along with the void * type in the actual
127 * declaration) is used to ensure that the crypto_tfm context structure is
128 * aligned correctly for the given architecture so that there are no alignment
129 * faults for C data types. In particular, this is required on platforms such
130 * as arm where pointers are 32-bit aligned but there are data types such as
131 * u64 which require 64-bit alignment.
133 #define CRYPTO_MINALIGN ARCH_KMALLOC_MINALIGN
135 #define CRYPTO_MINALIGN_ATTR __attribute__ ((__aligned__(CRYPTO_MINALIGN)))
138 struct crypto_ablkcipher;
139 struct crypto_async_request;
140 struct crypto_blkcipher;
143 struct skcipher_givcrypt_request;
145 typedef void (*crypto_completion_t)(struct crypto_async_request *req, int err);
148 * DOC: Block Cipher Context Data Structures
150 * These data structures define the operating context for each block cipher
154 struct crypto_async_request {
155 struct list_head list;
156 crypto_completion_t complete;
158 struct crypto_tfm *tfm;
163 struct ablkcipher_request {
164 struct crypto_async_request base;
170 struct scatterlist *src;
171 struct scatterlist *dst;
173 void *__ctx[] CRYPTO_MINALIGN_ATTR;
176 struct blkcipher_desc {
177 struct crypto_blkcipher *tfm;
183 struct crypto_tfm *tfm;
184 void (*crfn)(struct crypto_tfm *tfm, u8 *dst, const u8 *src);
185 unsigned int (*prfn)(const struct cipher_desc *desc, u8 *dst,
186 const u8 *src, unsigned int nbytes);
191 * DOC: Block Cipher Algorithm Definitions
193 * These data structures define modular crypto algorithm implementations,
194 * managed via crypto_register_alg() and crypto_unregister_alg().
198 * struct ablkcipher_alg - asynchronous block cipher definition
199 * @min_keysize: Minimum key size supported by the transformation. This is the
200 * smallest key length supported by this transformation algorithm.
201 * This must be set to one of the pre-defined values as this is
202 * not hardware specific. Possible values for this field can be
203 * found via git grep "_MIN_KEY_SIZE" include/crypto/
204 * @max_keysize: Maximum key size supported by the transformation. This is the
205 * largest key length supported by this transformation algorithm.
206 * This must be set to one of the pre-defined values as this is
207 * not hardware specific. Possible values for this field can be
208 * found via git grep "_MAX_KEY_SIZE" include/crypto/
209 * @setkey: Set key for the transformation. This function is used to either
210 * program a supplied key into the hardware or store the key in the
211 * transformation context for programming it later. Note that this
212 * function does modify the transformation context. This function can
213 * be called multiple times during the existence of the transformation
214 * object, so one must make sure the key is properly reprogrammed into
215 * the hardware. This function is also responsible for checking the key
216 * length for validity. In case a software fallback was put in place in
217 * the @cra_init call, this function might need to use the fallback if
218 * the algorithm doesn't support all of the key sizes.
219 * @encrypt: Encrypt a scatterlist of blocks. This function is used to encrypt
220 * the supplied scatterlist containing the blocks of data. The crypto
221 * API consumer is responsible for aligning the entries of the
222 * scatterlist properly and making sure the chunks are correctly
223 * sized. In case a software fallback was put in place in the
224 * @cra_init call, this function might need to use the fallback if
225 * the algorithm doesn't support all of the key sizes. In case the
226 * key was stored in transformation context, the key might need to be
227 * re-programmed into the hardware in this function. This function
228 * shall not modify the transformation context, as this function may
229 * be called in parallel with the same transformation object.
230 * @decrypt: Decrypt a single block. This is a reverse counterpart to @encrypt
231 * and the conditions are exactly the same.
232 * @givencrypt: Update the IV for encryption. With this function, a cipher
233 * implementation may provide the function on how to update the IV
235 * @givdecrypt: Update the IV for decryption. This is the reverse of
237 * @geniv: The transformation implementation may use an "IV generator" provided
238 * by the kernel crypto API. Several use cases have a predefined
239 * approach how IVs are to be updated. For such use cases, the kernel
240 * crypto API provides ready-to-use implementations that can be
241 * referenced with this variable.
242 * @ivsize: IV size applicable for transformation. The consumer must provide an
243 * IV of exactly that size to perform the encrypt or decrypt operation.
245 * All fields except @givencrypt , @givdecrypt , @geniv and @ivsize are
246 * mandatory and must be filled.
248 struct ablkcipher_alg {
249 int (*setkey)(struct crypto_ablkcipher *tfm, const u8 *key,
250 unsigned int keylen);
251 int (*encrypt)(struct ablkcipher_request *req);
252 int (*decrypt)(struct ablkcipher_request *req);
253 int (*givencrypt)(struct skcipher_givcrypt_request *req);
254 int (*givdecrypt)(struct skcipher_givcrypt_request *req);
258 unsigned int min_keysize;
259 unsigned int max_keysize;
264 * struct blkcipher_alg - synchronous block cipher definition
265 * @min_keysize: see struct ablkcipher_alg
266 * @max_keysize: see struct ablkcipher_alg
267 * @setkey: see struct ablkcipher_alg
268 * @encrypt: see struct ablkcipher_alg
269 * @decrypt: see struct ablkcipher_alg
270 * @geniv: see struct ablkcipher_alg
271 * @ivsize: see struct ablkcipher_alg
273 * All fields except @geniv and @ivsize are mandatory and must be filled.
275 struct blkcipher_alg {
276 int (*setkey)(struct crypto_tfm *tfm, const u8 *key,
277 unsigned int keylen);
278 int (*encrypt)(struct blkcipher_desc *desc,
279 struct scatterlist *dst, struct scatterlist *src,
280 unsigned int nbytes);
281 int (*decrypt)(struct blkcipher_desc *desc,
282 struct scatterlist *dst, struct scatterlist *src,
283 unsigned int nbytes);
287 unsigned int min_keysize;
288 unsigned int max_keysize;
293 * struct cipher_alg - single-block symmetric ciphers definition
294 * @cia_min_keysize: Minimum key size supported by the transformation. This is
295 * the smallest key length supported by this transformation
296 * algorithm. This must be set to one of the pre-defined
297 * values as this is not hardware specific. Possible values
298 * for this field can be found via git grep "_MIN_KEY_SIZE"
300 * @cia_max_keysize: Maximum key size supported by the transformation. This is
301 * the largest key length supported by this transformation
302 * algorithm. This must be set to one of the pre-defined values
303 * as this is not hardware specific. Possible values for this
304 * field can be found via git grep "_MAX_KEY_SIZE"
306 * @cia_setkey: Set key for the transformation. This function is used to either
307 * program a supplied key into the hardware or store the key in the
308 * transformation context for programming it later. Note that this
309 * function does modify the transformation context. This function
310 * can be called multiple times during the existence of the
311 * transformation object, so one must make sure the key is properly
312 * reprogrammed into the hardware. This function is also
313 * responsible for checking the key length for validity.
314 * @cia_encrypt: Encrypt a single block. This function is used to encrypt a
315 * single block of data, which must be @cra_blocksize big. This
316 * always operates on a full @cra_blocksize and it is not possible
317 * to encrypt a block of smaller size. The supplied buffers must
318 * therefore also be at least of @cra_blocksize size. Both the
319 * input and output buffers are always aligned to @cra_alignmask.
320 * In case either of the input or output buffer supplied by user
321 * of the crypto API is not aligned to @cra_alignmask, the crypto
322 * API will re-align the buffers. The re-alignment means that a
323 * new buffer will be allocated, the data will be copied into the
324 * new buffer, then the processing will happen on the new buffer,
325 * then the data will be copied back into the original buffer and
326 * finally the new buffer will be freed. In case a software
327 * fallback was put in place in the @cra_init call, this function
328 * might need to use the fallback if the algorithm doesn't support
329 * all of the key sizes. In case the key was stored in
330 * transformation context, the key might need to be re-programmed
331 * into the hardware in this function. This function shall not
332 * modify the transformation context, as this function may be
333 * called in parallel with the same transformation object.
334 * @cia_decrypt: Decrypt a single block. This is a reverse counterpart to
335 * @cia_encrypt, and the conditions are exactly the same.
337 * All fields are mandatory and must be filled.
340 unsigned int cia_min_keysize;
341 unsigned int cia_max_keysize;
342 int (*cia_setkey)(struct crypto_tfm *tfm, const u8 *key,
343 unsigned int keylen);
344 void (*cia_encrypt)(struct crypto_tfm *tfm, u8 *dst, const u8 *src);
345 void (*cia_decrypt)(struct crypto_tfm *tfm, u8 *dst, const u8 *src);
348 struct compress_alg {
349 int (*coa_compress)(struct crypto_tfm *tfm, const u8 *src,
350 unsigned int slen, u8 *dst, unsigned int *dlen);
351 int (*coa_decompress)(struct crypto_tfm *tfm, const u8 *src,
352 unsigned int slen, u8 *dst, unsigned int *dlen);
356 #define cra_ablkcipher cra_u.ablkcipher
357 #define cra_blkcipher cra_u.blkcipher
358 #define cra_cipher cra_u.cipher
359 #define cra_compress cra_u.compress
362 * struct crypto_alg - definition of a cryptograpic cipher algorithm
363 * @cra_flags: Flags describing this transformation. See include/linux/crypto.h
364 * CRYPTO_ALG_* flags for the flags which go in here. Those are
365 * used for fine-tuning the description of the transformation
367 * @cra_blocksize: Minimum block size of this transformation. The size in bytes
368 * of the smallest possible unit which can be transformed with
369 * this algorithm. The users must respect this value.
370 * In case of HASH transformation, it is possible for a smaller
371 * block than @cra_blocksize to be passed to the crypto API for
372 * transformation, in case of any other transformation type, an
373 * error will be returned upon any attempt to transform smaller
374 * than @cra_blocksize chunks.
375 * @cra_ctxsize: Size of the operational context of the transformation. This
376 * value informs the kernel crypto API about the memory size
377 * needed to be allocated for the transformation context.
378 * @cra_alignmask: Alignment mask for the input and output data buffer. The data
379 * buffer containing the input data for the algorithm must be
380 * aligned to this alignment mask. The data buffer for the
381 * output data must be aligned to this alignment mask. Note that
382 * the Crypto API will do the re-alignment in software, but
383 * only under special conditions and there is a performance hit.
384 * The re-alignment happens at these occasions for different
385 * @cra_u types: cipher -- For both input data and output data
386 * buffer; ahash -- For output hash destination buf; shash --
387 * For output hash destination buf.
388 * This is needed on hardware which is flawed by design and
389 * cannot pick data from arbitrary addresses.
390 * @cra_priority: Priority of this transformation implementation. In case
391 * multiple transformations with same @cra_name are available to
392 * the Crypto API, the kernel will use the one with highest
394 * @cra_name: Generic name (usable by multiple implementations) of the
395 * transformation algorithm. This is the name of the transformation
396 * itself. This field is used by the kernel when looking up the
397 * providers of particular transformation.
398 * @cra_driver_name: Unique name of the transformation provider. This is the
399 * name of the provider of the transformation. This can be any
400 * arbitrary value, but in the usual case, this contains the
401 * name of the chip or provider and the name of the
402 * transformation algorithm.
403 * @cra_type: Type of the cryptographic transformation. This is a pointer to
404 * struct crypto_type, which implements callbacks common for all
405 * transformation types. There are multiple options:
406 * &crypto_blkcipher_type, &crypto_ablkcipher_type,
407 * &crypto_ahash_type, &crypto_rng_type.
408 * This field might be empty. In that case, there are no common
409 * callbacks. This is the case for: cipher, compress, shash.
410 * @cra_u: Callbacks implementing the transformation. This is a union of
411 * multiple structures. Depending on the type of transformation selected
412 * by @cra_type and @cra_flags above, the associated structure must be
413 * filled with callbacks. This field might be empty. This is the case
415 * @cra_init: Initialize the cryptographic transformation object. This function
416 * is used to initialize the cryptographic transformation object.
417 * This function is called only once at the instantiation time, right
418 * after the transformation context was allocated. In case the
419 * cryptographic hardware has some special requirements which need to
420 * be handled by software, this function shall check for the precise
421 * requirement of the transformation and put any software fallbacks
423 * @cra_exit: Deinitialize the cryptographic transformation object. This is a
424 * counterpart to @cra_init, used to remove various changes set in
426 * @cra_module: Owner of this transformation implementation. Set to THIS_MODULE
427 * @cra_list: internally used
428 * @cra_users: internally used
429 * @cra_refcnt: internally used
430 * @cra_destroy: internally used
432 * The struct crypto_alg describes a generic Crypto API algorithm and is common
433 * for all of the transformations. Any variable not documented here shall not
434 * be used by a cipher implementation as it is internal to the Crypto API.
437 struct list_head cra_list;
438 struct list_head cra_users;
441 unsigned int cra_blocksize;
442 unsigned int cra_ctxsize;
443 unsigned int cra_alignmask;
448 char cra_name[CRYPTO_MAX_ALG_NAME];
449 char cra_driver_name[CRYPTO_MAX_ALG_NAME];
451 const struct crypto_type *cra_type;
454 struct ablkcipher_alg ablkcipher;
455 struct blkcipher_alg blkcipher;
456 struct cipher_alg cipher;
457 struct compress_alg compress;
460 int (*cra_init)(struct crypto_tfm *tfm);
461 void (*cra_exit)(struct crypto_tfm *tfm);
462 void (*cra_destroy)(struct crypto_alg *alg);
464 struct module *cra_module;
465 } CRYPTO_MINALIGN_ATTR;
468 * Algorithm registration interface.
470 int crypto_register_alg(struct crypto_alg *alg);
471 int crypto_unregister_alg(struct crypto_alg *alg);
472 int crypto_register_algs(struct crypto_alg *algs, int count);
473 int crypto_unregister_algs(struct crypto_alg *algs, int count);
476 * Algorithm query interface.
478 int crypto_has_alg(const char *name, u32 type, u32 mask);
481 * Transforms: user-instantiated objects which encapsulate algorithms
482 * and core processing logic. Managed via crypto_alloc_*() and
483 * crypto_free_*(), as well as the various helpers below.
486 struct ablkcipher_tfm {
487 int (*setkey)(struct crypto_ablkcipher *tfm, const u8 *key,
488 unsigned int keylen);
489 int (*encrypt)(struct ablkcipher_request *req);
490 int (*decrypt)(struct ablkcipher_request *req);
491 int (*givencrypt)(struct skcipher_givcrypt_request *req);
492 int (*givdecrypt)(struct skcipher_givcrypt_request *req);
494 struct crypto_ablkcipher *base;
497 unsigned int reqsize;
500 struct blkcipher_tfm {
502 int (*setkey)(struct crypto_tfm *tfm, const u8 *key,
503 unsigned int keylen);
504 int (*encrypt)(struct blkcipher_desc *desc, struct scatterlist *dst,
505 struct scatterlist *src, unsigned int nbytes);
506 int (*decrypt)(struct blkcipher_desc *desc, struct scatterlist *dst,
507 struct scatterlist *src, unsigned int nbytes);
511 int (*cit_setkey)(struct crypto_tfm *tfm,
512 const u8 *key, unsigned int keylen);
513 void (*cit_encrypt_one)(struct crypto_tfm *tfm, u8 *dst, const u8 *src);
514 void (*cit_decrypt_one)(struct crypto_tfm *tfm, u8 *dst, const u8 *src);
517 struct compress_tfm {
518 int (*cot_compress)(struct crypto_tfm *tfm,
519 const u8 *src, unsigned int slen,
520 u8 *dst, unsigned int *dlen);
521 int (*cot_decompress)(struct crypto_tfm *tfm,
522 const u8 *src, unsigned int slen,
523 u8 *dst, unsigned int *dlen);
526 #define crt_ablkcipher crt_u.ablkcipher
527 #define crt_blkcipher crt_u.blkcipher
528 #define crt_cipher crt_u.cipher
529 #define crt_compress crt_u.compress
536 struct ablkcipher_tfm ablkcipher;
537 struct blkcipher_tfm blkcipher;
538 struct cipher_tfm cipher;
539 struct compress_tfm compress;
542 void (*exit)(struct crypto_tfm *tfm);
544 struct crypto_alg *__crt_alg;
546 void *__crt_ctx[] CRYPTO_MINALIGN_ATTR;
549 struct crypto_ablkcipher {
550 struct crypto_tfm base;
553 struct crypto_blkcipher {
554 struct crypto_tfm base;
557 struct crypto_cipher {
558 struct crypto_tfm base;
562 struct crypto_tfm base;
573 #define CRYPTOA_MAX (__CRYPTOA_MAX - 1)
575 /* Maximum number of (rtattr) parameters for each template. */
576 #define CRYPTO_MAX_ATTRS 32
578 struct crypto_attr_alg {
579 char name[CRYPTO_MAX_ALG_NAME];
582 struct crypto_attr_type {
587 struct crypto_attr_u32 {
592 * Transform user interface.
595 struct crypto_tfm *crypto_alloc_base(const char *alg_name, u32 type, u32 mask);
596 void crypto_destroy_tfm(void *mem, struct crypto_tfm *tfm);
598 static inline void crypto_free_tfm(struct crypto_tfm *tfm)
600 return crypto_destroy_tfm(tfm, tfm);
603 int alg_test(const char *driver, const char *alg, u32 type, u32 mask);
606 * Transform helpers which query the underlying algorithm.
608 static inline const char *crypto_tfm_alg_name(struct crypto_tfm *tfm)
610 return tfm->__crt_alg->cra_name;
613 static inline const char *crypto_tfm_alg_driver_name(struct crypto_tfm *tfm)
615 return tfm->__crt_alg->cra_driver_name;
618 static inline int crypto_tfm_alg_priority(struct crypto_tfm *tfm)
620 return tfm->__crt_alg->cra_priority;
623 static inline u32 crypto_tfm_alg_type(struct crypto_tfm *tfm)
625 return tfm->__crt_alg->cra_flags & CRYPTO_ALG_TYPE_MASK;
628 static inline unsigned int crypto_tfm_alg_blocksize(struct crypto_tfm *tfm)
630 return tfm->__crt_alg->cra_blocksize;
633 static inline unsigned int crypto_tfm_alg_alignmask(struct crypto_tfm *tfm)
635 return tfm->__crt_alg->cra_alignmask;
638 static inline u32 crypto_tfm_get_flags(struct crypto_tfm *tfm)
640 return tfm->crt_flags;
643 static inline void crypto_tfm_set_flags(struct crypto_tfm *tfm, u32 flags)
645 tfm->crt_flags |= flags;
648 static inline void crypto_tfm_clear_flags(struct crypto_tfm *tfm, u32 flags)
650 tfm->crt_flags &= ~flags;
653 static inline void *crypto_tfm_ctx(struct crypto_tfm *tfm)
655 return tfm->__crt_ctx;
658 static inline unsigned int crypto_tfm_ctx_alignment(void)
660 struct crypto_tfm *tfm;
661 return __alignof__(tfm->__crt_ctx);
667 static inline struct crypto_ablkcipher *__crypto_ablkcipher_cast(
668 struct crypto_tfm *tfm)
670 return (struct crypto_ablkcipher *)tfm;
673 static inline u32 crypto_skcipher_type(u32 type)
675 type &= ~(CRYPTO_ALG_TYPE_MASK | CRYPTO_ALG_GENIV);
676 type |= CRYPTO_ALG_TYPE_BLKCIPHER;
680 static inline u32 crypto_skcipher_mask(u32 mask)
682 mask &= ~(CRYPTO_ALG_TYPE_MASK | CRYPTO_ALG_GENIV);
683 mask |= CRYPTO_ALG_TYPE_BLKCIPHER_MASK;
688 * DOC: Asynchronous Block Cipher API
690 * Asynchronous block cipher API is used with the ciphers of type
691 * CRYPTO_ALG_TYPE_ABLKCIPHER (listed as type "ablkcipher" in /proc/crypto).
693 * Asynchronous cipher operations imply that the function invocation for a
694 * cipher request returns immediately before the completion of the operation.
695 * The cipher request is scheduled as a separate kernel thread and therefore
696 * load-balanced on the different CPUs via the process scheduler. To allow
697 * the kernel crypto API to inform the caller about the completion of a cipher
698 * request, the caller must provide a callback function. That function is
699 * invoked with the cipher handle when the request completes.
701 * To support the asynchronous operation, additional information than just the
702 * cipher handle must be supplied to the kernel crypto API. That additional
703 * information is given by filling in the ablkcipher_request data structure.
705 * For the asynchronous block cipher API, the state is maintained with the tfm
706 * cipher handle. A single tfm can be used across multiple calls and in
707 * parallel. For asynchronous block cipher calls, context data supplied and
708 * only used by the caller can be referenced the request data structure in
709 * addition to the IV used for the cipher request. The maintenance of such
710 * state information would be important for a crypto driver implementer to
711 * have, because when calling the callback function upon completion of the
712 * cipher operation, that callback function may need some information about
713 * which operation just finished if it invoked multiple in parallel. This
714 * state information is unused by the kernel crypto API.
718 * crypto_alloc_ablkcipher() - allocate asynchronous block cipher handle
719 * @alg_name: is the cra_name / name or cra_driver_name / driver name of the
721 * @type: specifies the type of the cipher
722 * @mask: specifies the mask for the cipher
724 * Allocate a cipher handle for an ablkcipher. The returned struct
725 * crypto_ablkcipher is the cipher handle that is required for any subsequent
726 * API invocation for that ablkcipher.
728 * Return: allocated cipher handle in case of success; IS_ERR() is true in case
729 * of an error, PTR_ERR() returns the error code.
731 struct crypto_ablkcipher *crypto_alloc_ablkcipher(const char *alg_name,
734 static inline struct crypto_tfm *crypto_ablkcipher_tfm(
735 struct crypto_ablkcipher *tfm)
741 * crypto_free_ablkcipher() - zeroize and free cipher handle
742 * @tfm: cipher handle to be freed
744 static inline void crypto_free_ablkcipher(struct crypto_ablkcipher *tfm)
746 crypto_free_tfm(crypto_ablkcipher_tfm(tfm));
750 * crypto_has_ablkcipher() - Search for the availability of an ablkcipher.
751 * @alg_name: is the cra_name / name or cra_driver_name / driver name of the
753 * @type: specifies the type of the cipher
754 * @mask: specifies the mask for the cipher
756 * Return: true when the ablkcipher is known to the kernel crypto API; false
759 static inline int crypto_has_ablkcipher(const char *alg_name, u32 type,
762 return crypto_has_alg(alg_name, crypto_skcipher_type(type),
763 crypto_skcipher_mask(mask));
766 static inline struct ablkcipher_tfm *crypto_ablkcipher_crt(
767 struct crypto_ablkcipher *tfm)
769 return &crypto_ablkcipher_tfm(tfm)->crt_ablkcipher;
773 * crypto_ablkcipher_ivsize() - obtain IV size
774 * @tfm: cipher handle
776 * The size of the IV for the ablkcipher referenced by the cipher handle is
777 * returned. This IV size may be zero if the cipher does not need an IV.
779 * Return: IV size in bytes
781 static inline unsigned int crypto_ablkcipher_ivsize(
782 struct crypto_ablkcipher *tfm)
784 return crypto_ablkcipher_crt(tfm)->ivsize;
788 * crypto_ablkcipher_blocksize() - obtain block size of cipher
789 * @tfm: cipher handle
791 * The block size for the ablkcipher referenced with the cipher handle is
792 * returned. The caller may use that information to allocate appropriate
793 * memory for the data returned by the encryption or decryption operation
795 * Return: block size of cipher
797 static inline unsigned int crypto_ablkcipher_blocksize(
798 struct crypto_ablkcipher *tfm)
800 return crypto_tfm_alg_blocksize(crypto_ablkcipher_tfm(tfm));
803 static inline unsigned int crypto_ablkcipher_alignmask(
804 struct crypto_ablkcipher *tfm)
806 return crypto_tfm_alg_alignmask(crypto_ablkcipher_tfm(tfm));
809 static inline u32 crypto_ablkcipher_get_flags(struct crypto_ablkcipher *tfm)
811 return crypto_tfm_get_flags(crypto_ablkcipher_tfm(tfm));
814 static inline void crypto_ablkcipher_set_flags(struct crypto_ablkcipher *tfm,
817 crypto_tfm_set_flags(crypto_ablkcipher_tfm(tfm), flags);
820 static inline void crypto_ablkcipher_clear_flags(struct crypto_ablkcipher *tfm,
823 crypto_tfm_clear_flags(crypto_ablkcipher_tfm(tfm), flags);
827 * crypto_ablkcipher_setkey() - set key for cipher
828 * @tfm: cipher handle
829 * @key: buffer holding the key
830 * @keylen: length of the key in bytes
832 * The caller provided key is set for the ablkcipher referenced by the cipher
835 * Note, the key length determines the cipher type. Many block ciphers implement
836 * different cipher modes depending on the key size, such as AES-128 vs AES-192
837 * vs. AES-256. When providing a 16 byte key for an AES cipher handle, AES-128
840 * Return: 0 if the setting of the key was successful; < 0 if an error occurred
842 static inline int crypto_ablkcipher_setkey(struct crypto_ablkcipher *tfm,
843 const u8 *key, unsigned int keylen)
845 struct ablkcipher_tfm *crt = crypto_ablkcipher_crt(tfm);
847 return crt->setkey(crt->base, key, keylen);
851 * crypto_ablkcipher_reqtfm() - obtain cipher handle from request
852 * @req: ablkcipher_request out of which the cipher handle is to be obtained
854 * Return the crypto_ablkcipher handle when furnishing an ablkcipher_request
857 * Return: crypto_ablkcipher handle
859 static inline struct crypto_ablkcipher *crypto_ablkcipher_reqtfm(
860 struct ablkcipher_request *req)
862 return __crypto_ablkcipher_cast(req->base.tfm);
866 * crypto_ablkcipher_encrypt() - encrypt plaintext
867 * @req: reference to the ablkcipher_request handle that holds all information
868 * needed to perform the cipher operation
870 * Encrypt plaintext data using the ablkcipher_request handle. That data
871 * structure and how it is filled with data is discussed with the
872 * ablkcipher_request_* functions.
874 * Return: 0 if the cipher operation was successful; < 0 if an error occurred
876 static inline int crypto_ablkcipher_encrypt(struct ablkcipher_request *req)
878 struct ablkcipher_tfm *crt =
879 crypto_ablkcipher_crt(crypto_ablkcipher_reqtfm(req));
880 return crt->encrypt(req);
884 * crypto_ablkcipher_decrypt() - decrypt ciphertext
885 * @req: reference to the ablkcipher_request handle that holds all information
886 * needed to perform the cipher operation
888 * Decrypt ciphertext data using the ablkcipher_request handle. That data
889 * structure and how it is filled with data is discussed with the
890 * ablkcipher_request_* functions.
892 * Return: 0 if the cipher operation was successful; < 0 if an error occurred
894 static inline int crypto_ablkcipher_decrypt(struct ablkcipher_request *req)
896 struct ablkcipher_tfm *crt =
897 crypto_ablkcipher_crt(crypto_ablkcipher_reqtfm(req));
898 return crt->decrypt(req);
902 * DOC: Asynchronous Cipher Request Handle
904 * The ablkcipher_request data structure contains all pointers to data
905 * required for the asynchronous cipher operation. This includes the cipher
906 * handle (which can be used by multiple ablkcipher_request instances), pointer
907 * to plaintext and ciphertext, asynchronous callback function, etc. It acts
908 * as a handle to the ablkcipher_request_* API calls in a similar way as
909 * ablkcipher handle to the crypto_ablkcipher_* API calls.
913 * crypto_ablkcipher_reqsize() - obtain size of the request data structure
914 * @tfm: cipher handle
916 * Return: number of bytes
918 static inline unsigned int crypto_ablkcipher_reqsize(
919 struct crypto_ablkcipher *tfm)
921 return crypto_ablkcipher_crt(tfm)->reqsize;
925 * ablkcipher_request_set_tfm() - update cipher handle reference in request
926 * @req: request handle to be modified
927 * @tfm: cipher handle that shall be added to the request handle
929 * Allow the caller to replace the existing ablkcipher handle in the request
930 * data structure with a different one.
932 static inline void ablkcipher_request_set_tfm(
933 struct ablkcipher_request *req, struct crypto_ablkcipher *tfm)
935 req->base.tfm = crypto_ablkcipher_tfm(crypto_ablkcipher_crt(tfm)->base);
938 static inline struct ablkcipher_request *ablkcipher_request_cast(
939 struct crypto_async_request *req)
941 return container_of(req, struct ablkcipher_request, base);
945 * ablkcipher_request_alloc() - allocate request data structure
946 * @tfm: cipher handle to be registered with the request
947 * @gfp: memory allocation flag that is handed to kmalloc by the API call.
949 * Allocate the request data structure that must be used with the ablkcipher
950 * encrypt and decrypt API calls. During the allocation, the provided ablkcipher
951 * handle is registered in the request data structure.
953 * Return: allocated request handle in case of success, or NULL if out of memory
955 static inline struct ablkcipher_request *ablkcipher_request_alloc(
956 struct crypto_ablkcipher *tfm, gfp_t gfp)
958 struct ablkcipher_request *req;
960 req = kmalloc(sizeof(struct ablkcipher_request) +
961 crypto_ablkcipher_reqsize(tfm), gfp);
964 ablkcipher_request_set_tfm(req, tfm);
970 * ablkcipher_request_free() - zeroize and free request data structure
971 * @req: request data structure cipher handle to be freed
973 static inline void ablkcipher_request_free(struct ablkcipher_request *req)
979 * ablkcipher_request_set_callback() - set asynchronous callback function
980 * @req: request handle
981 * @flags: specify zero or an ORing of the flags
982 * CRYPTO_TFM_REQ_MAY_BACKLOG the request queue may back log and
983 * increase the wait queue beyond the initial maximum size;
984 * CRYPTO_TFM_REQ_MAY_SLEEP the request processing may sleep
985 * @compl: callback function pointer to be registered with the request handle
986 * @data: The data pointer refers to memory that is not used by the kernel
987 * crypto API, but provided to the callback function for it to use. Here,
988 * the caller can provide a reference to memory the callback function can
989 * operate on. As the callback function is invoked asynchronously to the
990 * related functionality, it may need to access data structures of the
991 * related functionality which can be referenced using this pointer. The
992 * callback function can access the memory via the "data" field in the
993 * crypto_async_request data structure provided to the callback function.
995 * This function allows setting the callback function that is triggered once the
996 * cipher operation completes.
998 * The callback function is registered with the ablkcipher_request handle and
999 * must comply with the following template
1001 * void callback_function(struct crypto_async_request *req, int error)
1003 static inline void ablkcipher_request_set_callback(
1004 struct ablkcipher_request *req,
1005 u32 flags, crypto_completion_t compl, void *data)
1007 req->base.complete = compl;
1008 req->base.data = data;
1009 req->base.flags = flags;
1013 * ablkcipher_request_set_crypt() - set data buffers
1014 * @req: request handle
1015 * @src: source scatter / gather list
1016 * @dst: destination scatter / gather list
1017 * @nbytes: number of bytes to process from @src
1018 * @iv: IV for the cipher operation which must comply with the IV size defined
1019 * by crypto_ablkcipher_ivsize
1021 * This function allows setting of the source data and destination data
1022 * scatter / gather lists.
1024 * For encryption, the source is treated as the plaintext and the
1025 * destination is the ciphertext. For a decryption operation, the use is
1026 * reversed - the source is the ciphertext and the destination is the plaintext.
1028 static inline void ablkcipher_request_set_crypt(
1029 struct ablkcipher_request *req,
1030 struct scatterlist *src, struct scatterlist *dst,
1031 unsigned int nbytes, void *iv)
1035 req->nbytes = nbytes;
1040 * DOC: Synchronous Block Cipher API
1042 * The synchronous block cipher API is used with the ciphers of type
1043 * CRYPTO_ALG_TYPE_BLKCIPHER (listed as type "blkcipher" in /proc/crypto)
1045 * Synchronous calls, have a context in the tfm. But since a single tfm can be
1046 * used in multiple calls and in parallel, this info should not be changeable
1047 * (unless a lock is used). This applies, for example, to the symmetric key.
1048 * However, the IV is changeable, so there is an iv field in blkcipher_tfm
1049 * structure for synchronous blkcipher api. So, its the only state info that can
1050 * be kept for synchronous calls without using a big lock across a tfm.
1052 * The block cipher API allows the use of a complete cipher, i.e. a cipher
1053 * consisting of a template (a block chaining mode) and a single block cipher
1054 * primitive (e.g. AES).
1056 * The plaintext data buffer and the ciphertext data buffer are pointed to
1057 * by using scatter/gather lists. The cipher operation is performed
1058 * on all segments of the provided scatter/gather lists.
1060 * The kernel crypto API supports a cipher operation "in-place" which means that
1061 * the caller may provide the same scatter/gather list for the plaintext and
1062 * cipher text. After the completion of the cipher operation, the plaintext
1063 * data is replaced with the ciphertext data in case of an encryption and vice
1064 * versa for a decryption. The caller must ensure that the scatter/gather lists
1065 * for the output data point to sufficiently large buffers, i.e. multiples of
1066 * the block size of the cipher.
1069 static inline struct crypto_blkcipher *__crypto_blkcipher_cast(
1070 struct crypto_tfm *tfm)
1072 return (struct crypto_blkcipher *)tfm;
1075 static inline struct crypto_blkcipher *crypto_blkcipher_cast(
1076 struct crypto_tfm *tfm)
1078 BUG_ON(crypto_tfm_alg_type(tfm) != CRYPTO_ALG_TYPE_BLKCIPHER);
1079 return __crypto_blkcipher_cast(tfm);
1083 * crypto_alloc_blkcipher() - allocate synchronous block cipher handle
1084 * @alg_name: is the cra_name / name or cra_driver_name / driver name of the
1086 * @type: specifies the type of the cipher
1087 * @mask: specifies the mask for the cipher
1089 * Allocate a cipher handle for a block cipher. The returned struct
1090 * crypto_blkcipher is the cipher handle that is required for any subsequent
1091 * API invocation for that block cipher.
1093 * Return: allocated cipher handle in case of success; IS_ERR() is true in case
1094 * of an error, PTR_ERR() returns the error code.
1096 static inline struct crypto_blkcipher *crypto_alloc_blkcipher(
1097 const char *alg_name, u32 type, u32 mask)
1099 type &= ~CRYPTO_ALG_TYPE_MASK;
1100 type |= CRYPTO_ALG_TYPE_BLKCIPHER;
1101 mask |= CRYPTO_ALG_TYPE_MASK;
1103 return __crypto_blkcipher_cast(crypto_alloc_base(alg_name, type, mask));
1106 static inline struct crypto_tfm *crypto_blkcipher_tfm(
1107 struct crypto_blkcipher *tfm)
1113 * crypto_free_blkcipher() - zeroize and free the block cipher handle
1114 * @tfm: cipher handle to be freed
1116 static inline void crypto_free_blkcipher(struct crypto_blkcipher *tfm)
1118 crypto_free_tfm(crypto_blkcipher_tfm(tfm));
1122 * crypto_has_blkcipher() - Search for the availability of a block cipher
1123 * @alg_name: is the cra_name / name or cra_driver_name / driver name of the
1125 * @type: specifies the type of the cipher
1126 * @mask: specifies the mask for the cipher
1128 * Return: true when the block cipher is known to the kernel crypto API; false
1131 static inline int crypto_has_blkcipher(const char *alg_name, u32 type, u32 mask)
1133 type &= ~CRYPTO_ALG_TYPE_MASK;
1134 type |= CRYPTO_ALG_TYPE_BLKCIPHER;
1135 mask |= CRYPTO_ALG_TYPE_MASK;
1137 return crypto_has_alg(alg_name, type, mask);
1141 * crypto_blkcipher_name() - return the name / cra_name from the cipher handle
1142 * @tfm: cipher handle
1144 * Return: The character string holding the name of the cipher
1146 static inline const char *crypto_blkcipher_name(struct crypto_blkcipher *tfm)
1148 return crypto_tfm_alg_name(crypto_blkcipher_tfm(tfm));
1151 static inline struct blkcipher_tfm *crypto_blkcipher_crt(
1152 struct crypto_blkcipher *tfm)
1154 return &crypto_blkcipher_tfm(tfm)->crt_blkcipher;
1157 static inline struct blkcipher_alg *crypto_blkcipher_alg(
1158 struct crypto_blkcipher *tfm)
1160 return &crypto_blkcipher_tfm(tfm)->__crt_alg->cra_blkcipher;
1164 * crypto_blkcipher_ivsize() - obtain IV size
1165 * @tfm: cipher handle
1167 * The size of the IV for the block cipher referenced by the cipher handle is
1168 * returned. This IV size may be zero if the cipher does not need an IV.
1170 * Return: IV size in bytes
1172 static inline unsigned int crypto_blkcipher_ivsize(struct crypto_blkcipher *tfm)
1174 return crypto_blkcipher_alg(tfm)->ivsize;
1178 * crypto_blkcipher_blocksize() - obtain block size of cipher
1179 * @tfm: cipher handle
1181 * The block size for the block cipher referenced with the cipher handle is
1182 * returned. The caller may use that information to allocate appropriate
1183 * memory for the data returned by the encryption or decryption operation.
1185 * Return: block size of cipher
1187 static inline unsigned int crypto_blkcipher_blocksize(
1188 struct crypto_blkcipher *tfm)
1190 return crypto_tfm_alg_blocksize(crypto_blkcipher_tfm(tfm));
1193 static inline unsigned int crypto_blkcipher_alignmask(
1194 struct crypto_blkcipher *tfm)
1196 return crypto_tfm_alg_alignmask(crypto_blkcipher_tfm(tfm));
1199 static inline u32 crypto_blkcipher_get_flags(struct crypto_blkcipher *tfm)
1201 return crypto_tfm_get_flags(crypto_blkcipher_tfm(tfm));
1204 static inline void crypto_blkcipher_set_flags(struct crypto_blkcipher *tfm,
1207 crypto_tfm_set_flags(crypto_blkcipher_tfm(tfm), flags);
1210 static inline void crypto_blkcipher_clear_flags(struct crypto_blkcipher *tfm,
1213 crypto_tfm_clear_flags(crypto_blkcipher_tfm(tfm), flags);
1217 * crypto_blkcipher_setkey() - set key for cipher
1218 * @tfm: cipher handle
1219 * @key: buffer holding the key
1220 * @keylen: length of the key in bytes
1222 * The caller provided key is set for the block cipher referenced by the cipher
1225 * Note, the key length determines the cipher type. Many block ciphers implement
1226 * different cipher modes depending on the key size, such as AES-128 vs AES-192
1227 * vs. AES-256. When providing a 16 byte key for an AES cipher handle, AES-128
1230 * Return: 0 if the setting of the key was successful; < 0 if an error occurred
1232 static inline int crypto_blkcipher_setkey(struct crypto_blkcipher *tfm,
1233 const u8 *key, unsigned int keylen)
1235 return crypto_blkcipher_crt(tfm)->setkey(crypto_blkcipher_tfm(tfm),
1240 * crypto_blkcipher_encrypt() - encrypt plaintext
1241 * @desc: reference to the block cipher handle with meta data
1242 * @dst: scatter/gather list that is filled by the cipher operation with the
1244 * @src: scatter/gather list that holds the plaintext
1245 * @nbytes: number of bytes of the plaintext to encrypt.
1247 * Encrypt plaintext data using the IV set by the caller with a preceding
1248 * call of crypto_blkcipher_set_iv.
1250 * The blkcipher_desc data structure must be filled by the caller and can
1251 * reside on the stack. The caller must fill desc as follows: desc.tfm is filled
1252 * with the block cipher handle; desc.flags is filled with either
1253 * CRYPTO_TFM_REQ_MAY_SLEEP or 0.
1255 * Return: 0 if the cipher operation was successful; < 0 if an error occurred
1257 static inline int crypto_blkcipher_encrypt(struct blkcipher_desc *desc,
1258 struct scatterlist *dst,
1259 struct scatterlist *src,
1260 unsigned int nbytes)
1262 desc->info = crypto_blkcipher_crt(desc->tfm)->iv;
1263 return crypto_blkcipher_crt(desc->tfm)->encrypt(desc, dst, src, nbytes);
1267 * crypto_blkcipher_encrypt_iv() - encrypt plaintext with dedicated IV
1268 * @desc: reference to the block cipher handle with meta data
1269 * @dst: scatter/gather list that is filled by the cipher operation with the
1271 * @src: scatter/gather list that holds the plaintext
1272 * @nbytes: number of bytes of the plaintext to encrypt.
1274 * Encrypt plaintext data with the use of an IV that is solely used for this
1275 * cipher operation. Any previously set IV is not used.
1277 * The blkcipher_desc data structure must be filled by the caller and can
1278 * reside on the stack. The caller must fill desc as follows: desc.tfm is filled
1279 * with the block cipher handle; desc.info is filled with the IV to be used for
1280 * the current operation; desc.flags is filled with either
1281 * CRYPTO_TFM_REQ_MAY_SLEEP or 0.
1283 * Return: 0 if the cipher operation was successful; < 0 if an error occurred
1285 static inline int crypto_blkcipher_encrypt_iv(struct blkcipher_desc *desc,
1286 struct scatterlist *dst,
1287 struct scatterlist *src,
1288 unsigned int nbytes)
1290 return crypto_blkcipher_crt(desc->tfm)->encrypt(desc, dst, src, nbytes);
1294 * crypto_blkcipher_decrypt() - decrypt ciphertext
1295 * @desc: reference to the block cipher handle with meta data
1296 * @dst: scatter/gather list that is filled by the cipher operation with the
1298 * @src: scatter/gather list that holds the ciphertext
1299 * @nbytes: number of bytes of the ciphertext to decrypt.
1301 * Decrypt ciphertext data using the IV set by the caller with a preceding
1302 * call of crypto_blkcipher_set_iv.
1304 * The blkcipher_desc data structure must be filled by the caller as documented
1305 * for the crypto_blkcipher_encrypt call above.
1307 * Return: 0 if the cipher operation was successful; < 0 if an error occurred
1310 static inline int crypto_blkcipher_decrypt(struct blkcipher_desc *desc,
1311 struct scatterlist *dst,
1312 struct scatterlist *src,
1313 unsigned int nbytes)
1315 desc->info = crypto_blkcipher_crt(desc->tfm)->iv;
1316 return crypto_blkcipher_crt(desc->tfm)->decrypt(desc, dst, src, nbytes);
1320 * crypto_blkcipher_decrypt_iv() - decrypt ciphertext with dedicated IV
1321 * @desc: reference to the block cipher handle with meta data
1322 * @dst: scatter/gather list that is filled by the cipher operation with the
1324 * @src: scatter/gather list that holds the ciphertext
1325 * @nbytes: number of bytes of the ciphertext to decrypt.
1327 * Decrypt ciphertext data with the use of an IV that is solely used for this
1328 * cipher operation. Any previously set IV is not used.
1330 * The blkcipher_desc data structure must be filled by the caller as documented
1331 * for the crypto_blkcipher_encrypt_iv call above.
1333 * Return: 0 if the cipher operation was successful; < 0 if an error occurred
1335 static inline int crypto_blkcipher_decrypt_iv(struct blkcipher_desc *desc,
1336 struct scatterlist *dst,
1337 struct scatterlist *src,
1338 unsigned int nbytes)
1340 return crypto_blkcipher_crt(desc->tfm)->decrypt(desc, dst, src, nbytes);
1344 * crypto_blkcipher_set_iv() - set IV for cipher
1345 * @tfm: cipher handle
1346 * @src: buffer holding the IV
1347 * @len: length of the IV in bytes
1349 * The caller provided IV is set for the block cipher referenced by the cipher
1352 static inline void crypto_blkcipher_set_iv(struct crypto_blkcipher *tfm,
1353 const u8 *src, unsigned int len)
1355 memcpy(crypto_blkcipher_crt(tfm)->iv, src, len);
1359 * crypto_blkcipher_get_iv() - obtain IV from cipher
1360 * @tfm: cipher handle
1361 * @dst: buffer filled with the IV
1362 * @len: length of the buffer dst
1364 * The caller can obtain the IV set for the block cipher referenced by the
1365 * cipher handle and store it into the user-provided buffer. If the buffer
1366 * has an insufficient space, the IV is truncated to fit the buffer.
1368 static inline void crypto_blkcipher_get_iv(struct crypto_blkcipher *tfm,
1369 u8 *dst, unsigned int len)
1371 memcpy(dst, crypto_blkcipher_crt(tfm)->iv, len);
1375 * DOC: Single Block Cipher API
1377 * The single block cipher API is used with the ciphers of type
1378 * CRYPTO_ALG_TYPE_CIPHER (listed as type "cipher" in /proc/crypto).
1380 * Using the single block cipher API calls, operations with the basic cipher
1381 * primitive can be implemented. These cipher primitives exclude any block
1382 * chaining operations including IV handling.
1384 * The purpose of this single block cipher API is to support the implementation
1385 * of templates or other concepts that only need to perform the cipher operation
1386 * on one block at a time. Templates invoke the underlying cipher primitive
1387 * block-wise and process either the input or the output data of these cipher
1391 static inline struct crypto_cipher *__crypto_cipher_cast(struct crypto_tfm *tfm)
1393 return (struct crypto_cipher *)tfm;
1396 static inline struct crypto_cipher *crypto_cipher_cast(struct crypto_tfm *tfm)
1398 BUG_ON(crypto_tfm_alg_type(tfm) != CRYPTO_ALG_TYPE_CIPHER);
1399 return __crypto_cipher_cast(tfm);
1403 * crypto_alloc_cipher() - allocate single block cipher handle
1404 * @alg_name: is the cra_name / name or cra_driver_name / driver name of the
1405 * single block cipher
1406 * @type: specifies the type of the cipher
1407 * @mask: specifies the mask for the cipher
1409 * Allocate a cipher handle for a single block cipher. The returned struct
1410 * crypto_cipher is the cipher handle that is required for any subsequent API
1411 * invocation for that single block cipher.
1413 * Return: allocated cipher handle in case of success; IS_ERR() is true in case
1414 * of an error, PTR_ERR() returns the error code.
1416 static inline struct crypto_cipher *crypto_alloc_cipher(const char *alg_name,
1419 type &= ~CRYPTO_ALG_TYPE_MASK;
1420 type |= CRYPTO_ALG_TYPE_CIPHER;
1421 mask |= CRYPTO_ALG_TYPE_MASK;
1423 return __crypto_cipher_cast(crypto_alloc_base(alg_name, type, mask));
1426 static inline struct crypto_tfm *crypto_cipher_tfm(struct crypto_cipher *tfm)
1432 * crypto_free_cipher() - zeroize and free the single block cipher handle
1433 * @tfm: cipher handle to be freed
1435 static inline void crypto_free_cipher(struct crypto_cipher *tfm)
1437 crypto_free_tfm(crypto_cipher_tfm(tfm));
1441 * crypto_has_cipher() - Search for the availability of a single block cipher
1442 * @alg_name: is the cra_name / name or cra_driver_name / driver name of the
1443 * single block cipher
1444 * @type: specifies the type of the cipher
1445 * @mask: specifies the mask for the cipher
1447 * Return: true when the single block cipher is known to the kernel crypto API;
1450 static inline int crypto_has_cipher(const char *alg_name, u32 type, u32 mask)
1452 type &= ~CRYPTO_ALG_TYPE_MASK;
1453 type |= CRYPTO_ALG_TYPE_CIPHER;
1454 mask |= CRYPTO_ALG_TYPE_MASK;
1456 return crypto_has_alg(alg_name, type, mask);
1459 static inline struct cipher_tfm *crypto_cipher_crt(struct crypto_cipher *tfm)
1461 return &crypto_cipher_tfm(tfm)->crt_cipher;
1465 * crypto_cipher_blocksize() - obtain block size for cipher
1466 * @tfm: cipher handle
1468 * The block size for the single block cipher referenced with the cipher handle
1469 * tfm is returned. The caller may use that information to allocate appropriate
1470 * memory for the data returned by the encryption or decryption operation
1472 * Return: block size of cipher
1474 static inline unsigned int crypto_cipher_blocksize(struct crypto_cipher *tfm)
1476 return crypto_tfm_alg_blocksize(crypto_cipher_tfm(tfm));
1479 static inline unsigned int crypto_cipher_alignmask(struct crypto_cipher *tfm)
1481 return crypto_tfm_alg_alignmask(crypto_cipher_tfm(tfm));
1484 static inline u32 crypto_cipher_get_flags(struct crypto_cipher *tfm)
1486 return crypto_tfm_get_flags(crypto_cipher_tfm(tfm));
1489 static inline void crypto_cipher_set_flags(struct crypto_cipher *tfm,
1492 crypto_tfm_set_flags(crypto_cipher_tfm(tfm), flags);
1495 static inline void crypto_cipher_clear_flags(struct crypto_cipher *tfm,
1498 crypto_tfm_clear_flags(crypto_cipher_tfm(tfm), flags);
1502 * crypto_cipher_setkey() - set key for cipher
1503 * @tfm: cipher handle
1504 * @key: buffer holding the key
1505 * @keylen: length of the key in bytes
1507 * The caller provided key is set for the single block cipher referenced by the
1510 * Note, the key length determines the cipher type. Many block ciphers implement
1511 * different cipher modes depending on the key size, such as AES-128 vs AES-192
1512 * vs. AES-256. When providing a 16 byte key for an AES cipher handle, AES-128
1515 * Return: 0 if the setting of the key was successful; < 0 if an error occurred
1517 static inline int crypto_cipher_setkey(struct crypto_cipher *tfm,
1518 const u8 *key, unsigned int keylen)
1520 return crypto_cipher_crt(tfm)->cit_setkey(crypto_cipher_tfm(tfm),
1525 * crypto_cipher_encrypt_one() - encrypt one block of plaintext
1526 * @tfm: cipher handle
1527 * @dst: points to the buffer that will be filled with the ciphertext
1528 * @src: buffer holding the plaintext to be encrypted
1530 * Invoke the encryption operation of one block. The caller must ensure that
1531 * the plaintext and ciphertext buffers are at least one block in size.
1533 static inline void crypto_cipher_encrypt_one(struct crypto_cipher *tfm,
1534 u8 *dst, const u8 *src)
1536 crypto_cipher_crt(tfm)->cit_encrypt_one(crypto_cipher_tfm(tfm),
1541 * crypto_cipher_decrypt_one() - decrypt one block of ciphertext
1542 * @tfm: cipher handle
1543 * @dst: points to the buffer that will be filled with the plaintext
1544 * @src: buffer holding the ciphertext to be decrypted
1546 * Invoke the decryption operation of one block. The caller must ensure that
1547 * the plaintext and ciphertext buffers are at least one block in size.
1549 static inline void crypto_cipher_decrypt_one(struct crypto_cipher *tfm,
1550 u8 *dst, const u8 *src)
1552 crypto_cipher_crt(tfm)->cit_decrypt_one(crypto_cipher_tfm(tfm),
1556 static inline struct crypto_comp *__crypto_comp_cast(struct crypto_tfm *tfm)
1558 return (struct crypto_comp *)tfm;
1561 static inline struct crypto_comp *crypto_comp_cast(struct crypto_tfm *tfm)
1563 BUG_ON((crypto_tfm_alg_type(tfm) ^ CRYPTO_ALG_TYPE_COMPRESS) &
1564 CRYPTO_ALG_TYPE_MASK);
1565 return __crypto_comp_cast(tfm);
1568 static inline struct crypto_comp *crypto_alloc_comp(const char *alg_name,
1571 type &= ~CRYPTO_ALG_TYPE_MASK;
1572 type |= CRYPTO_ALG_TYPE_COMPRESS;
1573 mask |= CRYPTO_ALG_TYPE_MASK;
1575 return __crypto_comp_cast(crypto_alloc_base(alg_name, type, mask));
1578 static inline struct crypto_tfm *crypto_comp_tfm(struct crypto_comp *tfm)
1583 static inline void crypto_free_comp(struct crypto_comp *tfm)
1585 crypto_free_tfm(crypto_comp_tfm(tfm));
1588 static inline int crypto_has_comp(const char *alg_name, u32 type, u32 mask)
1590 type &= ~CRYPTO_ALG_TYPE_MASK;
1591 type |= CRYPTO_ALG_TYPE_COMPRESS;
1592 mask |= CRYPTO_ALG_TYPE_MASK;
1594 return crypto_has_alg(alg_name, type, mask);
1597 static inline const char *crypto_comp_name(struct crypto_comp *tfm)
1599 return crypto_tfm_alg_name(crypto_comp_tfm(tfm));
1602 static inline struct compress_tfm *crypto_comp_crt(struct crypto_comp *tfm)
1604 return &crypto_comp_tfm(tfm)->crt_compress;
1607 static inline int crypto_comp_compress(struct crypto_comp *tfm,
1608 const u8 *src, unsigned int slen,
1609 u8 *dst, unsigned int *dlen)
1611 return crypto_comp_crt(tfm)->cot_compress(crypto_comp_tfm(tfm),
1612 src, slen, dst, dlen);
1615 static inline int crypto_comp_decompress(struct crypto_comp *tfm,
1616 const u8 *src, unsigned int slen,
1617 u8 *dst, unsigned int *dlen)
1619 return crypto_comp_crt(tfm)->cot_decompress(crypto_comp_tfm(tfm),
1620 src, slen, dst, dlen);
1623 #endif /* _LINUX_CRYPTO_H */