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_GIVCIPHER 0x00000006
51 #define CRYPTO_ALG_TYPE_DIGEST 0x00000008
52 #define CRYPTO_ALG_TYPE_HASH 0x00000008
53 #define CRYPTO_ALG_TYPE_SHASH 0x00000009
54 #define CRYPTO_ALG_TYPE_AHASH 0x0000000a
55 #define CRYPTO_ALG_TYPE_RNG 0x0000000c
56 #define CRYPTO_ALG_TYPE_AKCIPHER 0x0000000d
57 #define CRYPTO_ALG_TYPE_PCOMPRESS 0x0000000f
59 #define CRYPTO_ALG_TYPE_HASH_MASK 0x0000000e
60 #define CRYPTO_ALG_TYPE_AHASH_MASK 0x0000000c
61 #define CRYPTO_ALG_TYPE_BLKCIPHER_MASK 0x0000000c
63 #define CRYPTO_ALG_LARVAL 0x00000010
64 #define CRYPTO_ALG_DEAD 0x00000020
65 #define CRYPTO_ALG_DYING 0x00000040
66 #define CRYPTO_ALG_ASYNC 0x00000080
69 * Set this bit if and only if the algorithm requires another algorithm of
70 * the same type to handle corner cases.
72 #define CRYPTO_ALG_NEED_FALLBACK 0x00000100
75 * This bit is set for symmetric key ciphers that have already been wrapped
76 * with a generic IV generator to prevent them from being wrapped again.
78 #define CRYPTO_ALG_GENIV 0x00000200
81 * Set if the algorithm has passed automated run-time testing. Note that
82 * if there is no run-time testing for a given algorithm it is considered
86 #define CRYPTO_ALG_TESTED 0x00000400
89 * Set if the algorithm is an instance that is build from templates.
91 #define CRYPTO_ALG_INSTANCE 0x00000800
93 /* Set this bit if the algorithm provided is hardware accelerated but
94 * not available to userspace via instruction set or so.
96 #define CRYPTO_ALG_KERN_DRIVER_ONLY 0x00001000
99 * Mark a cipher as a service implementation only usable by another
100 * cipher and never by a normal user of the kernel crypto API
102 #define CRYPTO_ALG_INTERNAL 0x00002000
105 * Temporary flag used to prevent legacy AEAD implementations from
106 * being used by user-space.
108 #define CRYPTO_ALG_AEAD_NEW 0x00004000
111 * Transform masks and values (for crt_flags).
113 #define CRYPTO_TFM_REQ_MASK 0x000fff00
114 #define CRYPTO_TFM_RES_MASK 0xfff00000
116 #define CRYPTO_TFM_REQ_WEAK_KEY 0x00000100
117 #define CRYPTO_TFM_REQ_MAY_SLEEP 0x00000200
118 #define CRYPTO_TFM_REQ_MAY_BACKLOG 0x00000400
119 #define CRYPTO_TFM_RES_WEAK_KEY 0x00100000
120 #define CRYPTO_TFM_RES_BAD_KEY_LEN 0x00200000
121 #define CRYPTO_TFM_RES_BAD_KEY_SCHED 0x00400000
122 #define CRYPTO_TFM_RES_BAD_BLOCK_LEN 0x00800000
123 #define CRYPTO_TFM_RES_BAD_FLAGS 0x01000000
126 * Miscellaneous stuff.
128 #define CRYPTO_MAX_ALG_NAME 64
131 * The macro CRYPTO_MINALIGN_ATTR (along with the void * type in the actual
132 * declaration) is used to ensure that the crypto_tfm context structure is
133 * aligned correctly for the given architecture so that there are no alignment
134 * faults for C data types. In particular, this is required on platforms such
135 * as arm where pointers are 32-bit aligned but there are data types such as
136 * u64 which require 64-bit alignment.
138 #define CRYPTO_MINALIGN ARCH_KMALLOC_MINALIGN
140 #define CRYPTO_MINALIGN_ATTR __attribute__ ((__aligned__(CRYPTO_MINALIGN)))
143 struct crypto_ablkcipher
;
144 struct crypto_async_request
;
146 struct crypto_blkcipher
;
151 struct aead_givcrypt_request
;
152 struct skcipher_givcrypt_request
;
154 typedef void (*crypto_completion_t
)(struct crypto_async_request
*req
, int err
);
157 * DOC: Block Cipher Context Data Structures
159 * These data structures define the operating context for each block cipher
163 struct crypto_async_request
{
164 struct list_head list
;
165 crypto_completion_t complete
;
167 struct crypto_tfm
*tfm
;
172 struct ablkcipher_request
{
173 struct crypto_async_request base
;
179 struct scatterlist
*src
;
180 struct scatterlist
*dst
;
182 void *__ctx
[] CRYPTO_MINALIGN_ATTR
;
185 struct blkcipher_desc
{
186 struct crypto_blkcipher
*tfm
;
192 struct crypto_tfm
*tfm
;
193 void (*crfn
)(struct crypto_tfm
*tfm
, u8
*dst
, const u8
*src
);
194 unsigned int (*prfn
)(const struct cipher_desc
*desc
, u8
*dst
,
195 const u8
*src
, unsigned int nbytes
);
200 struct crypto_hash
*tfm
;
205 * DOC: Block Cipher Algorithm Definitions
207 * These data structures define modular crypto algorithm implementations,
208 * managed via crypto_register_alg() and crypto_unregister_alg().
212 * struct ablkcipher_alg - asynchronous block cipher definition
213 * @min_keysize: Minimum key size supported by the transformation. This is the
214 * smallest key length supported by this transformation algorithm.
215 * This must be set to one of the pre-defined values as this is
216 * not hardware specific. Possible values for this field can be
217 * found via git grep "_MIN_KEY_SIZE" include/crypto/
218 * @max_keysize: Maximum key size supported by the transformation. This is the
219 * largest key length supported by this transformation algorithm.
220 * This must be set to one of the pre-defined values as this is
221 * not hardware specific. Possible values for this field can be
222 * found via git grep "_MAX_KEY_SIZE" include/crypto/
223 * @setkey: Set key for the transformation. This function is used to either
224 * program a supplied key into the hardware or store the key in the
225 * transformation context for programming it later. Note that this
226 * function does modify the transformation context. This function can
227 * be called multiple times during the existence of the transformation
228 * object, so one must make sure the key is properly reprogrammed into
229 * the hardware. This function is also responsible for checking the key
230 * length for validity. In case a software fallback was put in place in
231 * the @cra_init call, this function might need to use the fallback if
232 * the algorithm doesn't support all of the key sizes.
233 * @encrypt: Encrypt a scatterlist of blocks. This function is used to encrypt
234 * the supplied scatterlist containing the blocks of data. The crypto
235 * API consumer is responsible for aligning the entries of the
236 * scatterlist properly and making sure the chunks are correctly
237 * sized. In case a software fallback was put in place in the
238 * @cra_init call, this function might need to use the fallback if
239 * the algorithm doesn't support all of the key sizes. In case the
240 * key was stored in transformation context, the key might need to be
241 * re-programmed into the hardware in this function. This function
242 * shall not modify the transformation context, as this function may
243 * be called in parallel with the same transformation object.
244 * @decrypt: Decrypt a single block. This is a reverse counterpart to @encrypt
245 * and the conditions are exactly the same.
246 * @givencrypt: Update the IV for encryption. With this function, a cipher
247 * implementation may provide the function on how to update the IV
249 * @givdecrypt: Update the IV for decryption. This is the reverse of
251 * @geniv: The transformation implementation may use an "IV generator" provided
252 * by the kernel crypto API. Several use cases have a predefined
253 * approach how IVs are to be updated. For such use cases, the kernel
254 * crypto API provides ready-to-use implementations that can be
255 * referenced with this variable.
256 * @ivsize: IV size applicable for transformation. The consumer must provide an
257 * IV of exactly that size to perform the encrypt or decrypt operation.
259 * All fields except @givencrypt , @givdecrypt , @geniv and @ivsize are
260 * mandatory and must be filled.
262 struct ablkcipher_alg
{
263 int (*setkey
)(struct crypto_ablkcipher
*tfm
, const u8
*key
,
264 unsigned int keylen
);
265 int (*encrypt
)(struct ablkcipher_request
*req
);
266 int (*decrypt
)(struct ablkcipher_request
*req
);
267 int (*givencrypt
)(struct skcipher_givcrypt_request
*req
);
268 int (*givdecrypt
)(struct skcipher_givcrypt_request
*req
);
272 unsigned int min_keysize
;
273 unsigned int max_keysize
;
278 * struct old_aead_alg - AEAD cipher definition
279 * @maxauthsize: Set the maximum authentication tag size supported by the
280 * transformation. A transformation may support smaller tag sizes.
281 * As the authentication tag is a message digest to ensure the
282 * integrity of the encrypted data, a consumer typically wants the
283 * largest authentication tag possible as defined by this
285 * @setauthsize: Set authentication size for the AEAD transformation. This
286 * function is used to specify the consumer requested size of the
287 * authentication tag to be either generated by the transformation
288 * during encryption or the size of the authentication tag to be
289 * supplied during the decryption operation. This function is also
290 * responsible for checking the authentication tag size for
292 * @setkey: see struct ablkcipher_alg
293 * @encrypt: see struct ablkcipher_alg
294 * @decrypt: see struct ablkcipher_alg
295 * @givencrypt: see struct ablkcipher_alg
296 * @givdecrypt: see struct ablkcipher_alg
297 * @geniv: see struct ablkcipher_alg
298 * @ivsize: see struct ablkcipher_alg
300 * All fields except @givencrypt , @givdecrypt , @geniv and @ivsize are
301 * mandatory and must be filled.
303 struct old_aead_alg
{
304 int (*setkey
)(struct crypto_aead
*tfm
, const u8
*key
,
305 unsigned int keylen
);
306 int (*setauthsize
)(struct crypto_aead
*tfm
, unsigned int authsize
);
307 int (*encrypt
)(struct aead_request
*req
);
308 int (*decrypt
)(struct aead_request
*req
);
309 int (*givencrypt
)(struct aead_givcrypt_request
*req
);
310 int (*givdecrypt
)(struct aead_givcrypt_request
*req
);
315 unsigned int maxauthsize
;
319 * struct blkcipher_alg - synchronous block cipher definition
320 * @min_keysize: see struct ablkcipher_alg
321 * @max_keysize: see struct ablkcipher_alg
322 * @setkey: see struct ablkcipher_alg
323 * @encrypt: see struct ablkcipher_alg
324 * @decrypt: see struct ablkcipher_alg
325 * @geniv: see struct ablkcipher_alg
326 * @ivsize: see struct ablkcipher_alg
328 * All fields except @geniv and @ivsize are mandatory and must be filled.
330 struct blkcipher_alg
{
331 int (*setkey
)(struct crypto_tfm
*tfm
, const u8
*key
,
332 unsigned int keylen
);
333 int (*encrypt
)(struct blkcipher_desc
*desc
,
334 struct scatterlist
*dst
, struct scatterlist
*src
,
335 unsigned int nbytes
);
336 int (*decrypt
)(struct blkcipher_desc
*desc
,
337 struct scatterlist
*dst
, struct scatterlist
*src
,
338 unsigned int nbytes
);
342 unsigned int min_keysize
;
343 unsigned int max_keysize
;
348 * struct cipher_alg - single-block symmetric ciphers definition
349 * @cia_min_keysize: Minimum key size supported by the transformation. This is
350 * the smallest key length supported by this transformation
351 * algorithm. This must be set to one of the pre-defined
352 * values as this is not hardware specific. Possible values
353 * for this field can be found via git grep "_MIN_KEY_SIZE"
355 * @cia_max_keysize: Maximum key size supported by the transformation. This is
356 * the largest key length supported by this transformation
357 * algorithm. This must be set to one of the pre-defined values
358 * as this is not hardware specific. Possible values for this
359 * field can be found via git grep "_MAX_KEY_SIZE"
361 * @cia_setkey: Set key for the transformation. This function is used to either
362 * program a supplied key into the hardware or store the key in the
363 * transformation context for programming it later. Note that this
364 * function does modify the transformation context. This function
365 * can be called multiple times during the existence of the
366 * transformation object, so one must make sure the key is properly
367 * reprogrammed into the hardware. This function is also
368 * responsible for checking the key length for validity.
369 * @cia_encrypt: Encrypt a single block. This function is used to encrypt a
370 * single block of data, which must be @cra_blocksize big. This
371 * always operates on a full @cra_blocksize and it is not possible
372 * to encrypt a block of smaller size. The supplied buffers must
373 * therefore also be at least of @cra_blocksize size. Both the
374 * input and output buffers are always aligned to @cra_alignmask.
375 * In case either of the input or output buffer supplied by user
376 * of the crypto API is not aligned to @cra_alignmask, the crypto
377 * API will re-align the buffers. The re-alignment means that a
378 * new buffer will be allocated, the data will be copied into the
379 * new buffer, then the processing will happen on the new buffer,
380 * then the data will be copied back into the original buffer and
381 * finally the new buffer will be freed. In case a software
382 * fallback was put in place in the @cra_init call, this function
383 * might need to use the fallback if the algorithm doesn't support
384 * all of the key sizes. In case the key was stored in
385 * transformation context, the key might need to be re-programmed
386 * into the hardware in this function. This function shall not
387 * modify the transformation context, as this function may be
388 * called in parallel with the same transformation object.
389 * @cia_decrypt: Decrypt a single block. This is a reverse counterpart to
390 * @cia_encrypt, and the conditions are exactly the same.
392 * All fields are mandatory and must be filled.
395 unsigned int cia_min_keysize
;
396 unsigned int cia_max_keysize
;
397 int (*cia_setkey
)(struct crypto_tfm
*tfm
, const u8
*key
,
398 unsigned int keylen
);
399 void (*cia_encrypt
)(struct crypto_tfm
*tfm
, u8
*dst
, const u8
*src
);
400 void (*cia_decrypt
)(struct crypto_tfm
*tfm
, u8
*dst
, const u8
*src
);
403 struct compress_alg
{
404 int (*coa_compress
)(struct crypto_tfm
*tfm
, const u8
*src
,
405 unsigned int slen
, u8
*dst
, unsigned int *dlen
);
406 int (*coa_decompress
)(struct crypto_tfm
*tfm
, const u8
*src
,
407 unsigned int slen
, u8
*dst
, unsigned int *dlen
);
411 #define cra_ablkcipher cra_u.ablkcipher
412 #define cra_aead cra_u.aead
413 #define cra_blkcipher cra_u.blkcipher
414 #define cra_cipher cra_u.cipher
415 #define cra_compress cra_u.compress
418 * struct crypto_alg - definition of a cryptograpic cipher algorithm
419 * @cra_flags: Flags describing this transformation. See include/linux/crypto.h
420 * CRYPTO_ALG_* flags for the flags which go in here. Those are
421 * used for fine-tuning the description of the transformation
423 * @cra_blocksize: Minimum block size of this transformation. The size in bytes
424 * of the smallest possible unit which can be transformed with
425 * this algorithm. The users must respect this value.
426 * In case of HASH transformation, it is possible for a smaller
427 * block than @cra_blocksize to be passed to the crypto API for
428 * transformation, in case of any other transformation type, an
429 * error will be returned upon any attempt to transform smaller
430 * than @cra_blocksize chunks.
431 * @cra_ctxsize: Size of the operational context of the transformation. This
432 * value informs the kernel crypto API about the memory size
433 * needed to be allocated for the transformation context.
434 * @cra_alignmask: Alignment mask for the input and output data buffer. The data
435 * buffer containing the input data for the algorithm must be
436 * aligned to this alignment mask. The data buffer for the
437 * output data must be aligned to this alignment mask. Note that
438 * the Crypto API will do the re-alignment in software, but
439 * only under special conditions and there is a performance hit.
440 * The re-alignment happens at these occasions for different
441 * @cra_u types: cipher -- For both input data and output data
442 * buffer; ahash -- For output hash destination buf; shash --
443 * For output hash destination buf.
444 * This is needed on hardware which is flawed by design and
445 * cannot pick data from arbitrary addresses.
446 * @cra_priority: Priority of this transformation implementation. In case
447 * multiple transformations with same @cra_name are available to
448 * the Crypto API, the kernel will use the one with highest
450 * @cra_name: Generic name (usable by multiple implementations) of the
451 * transformation algorithm. This is the name of the transformation
452 * itself. This field is used by the kernel when looking up the
453 * providers of particular transformation.
454 * @cra_driver_name: Unique name of the transformation provider. This is the
455 * name of the provider of the transformation. This can be any
456 * arbitrary value, but in the usual case, this contains the
457 * name of the chip or provider and the name of the
458 * transformation algorithm.
459 * @cra_type: Type of the cryptographic transformation. This is a pointer to
460 * struct crypto_type, which implements callbacks common for all
461 * transformation types. There are multiple options:
462 * &crypto_blkcipher_type, &crypto_ablkcipher_type,
463 * &crypto_ahash_type, &crypto_aead_type, &crypto_rng_type.
464 * This field might be empty. In that case, there are no common
465 * callbacks. This is the case for: cipher, compress, shash.
466 * @cra_u: Callbacks implementing the transformation. This is a union of
467 * multiple structures. Depending on the type of transformation selected
468 * by @cra_type and @cra_flags above, the associated structure must be
469 * filled with callbacks. This field might be empty. This is the case
471 * @cra_init: Initialize the cryptographic transformation object. This function
472 * is used to initialize the cryptographic transformation object.
473 * This function is called only once at the instantiation time, right
474 * after the transformation context was allocated. In case the
475 * cryptographic hardware has some special requirements which need to
476 * be handled by software, this function shall check for the precise
477 * requirement of the transformation and put any software fallbacks
479 * @cra_exit: Deinitialize the cryptographic transformation object. This is a
480 * counterpart to @cra_init, used to remove various changes set in
482 * @cra_module: Owner of this transformation implementation. Set to THIS_MODULE
483 * @cra_list: internally used
484 * @cra_users: internally used
485 * @cra_refcnt: internally used
486 * @cra_destroy: internally used
488 * The struct crypto_alg describes a generic Crypto API algorithm and is common
489 * for all of the transformations. Any variable not documented here shall not
490 * be used by a cipher implementation as it is internal to the Crypto API.
493 struct list_head cra_list
;
494 struct list_head cra_users
;
497 unsigned int cra_blocksize
;
498 unsigned int cra_ctxsize
;
499 unsigned int cra_alignmask
;
504 char cra_name
[CRYPTO_MAX_ALG_NAME
];
505 char cra_driver_name
[CRYPTO_MAX_ALG_NAME
];
507 const struct crypto_type
*cra_type
;
510 struct ablkcipher_alg ablkcipher
;
511 struct old_aead_alg aead
;
512 struct blkcipher_alg blkcipher
;
513 struct cipher_alg cipher
;
514 struct compress_alg compress
;
517 int (*cra_init
)(struct crypto_tfm
*tfm
);
518 void (*cra_exit
)(struct crypto_tfm
*tfm
);
519 void (*cra_destroy
)(struct crypto_alg
*alg
);
521 struct module
*cra_module
;
522 } CRYPTO_MINALIGN_ATTR
;
525 * Algorithm registration interface.
527 int crypto_register_alg(struct crypto_alg
*alg
);
528 int crypto_unregister_alg(struct crypto_alg
*alg
);
529 int crypto_register_algs(struct crypto_alg
*algs
, int count
);
530 int crypto_unregister_algs(struct crypto_alg
*algs
, int count
);
533 * Algorithm query interface.
535 int crypto_has_alg(const char *name
, u32 type
, u32 mask
);
538 * Transforms: user-instantiated objects which encapsulate algorithms
539 * and core processing logic. Managed via crypto_alloc_*() and
540 * crypto_free_*(), as well as the various helpers below.
543 struct ablkcipher_tfm
{
544 int (*setkey
)(struct crypto_ablkcipher
*tfm
, const u8
*key
,
545 unsigned int keylen
);
546 int (*encrypt
)(struct ablkcipher_request
*req
);
547 int (*decrypt
)(struct ablkcipher_request
*req
);
548 int (*givencrypt
)(struct skcipher_givcrypt_request
*req
);
549 int (*givdecrypt
)(struct skcipher_givcrypt_request
*req
);
551 struct crypto_ablkcipher
*base
;
554 unsigned int reqsize
;
557 struct blkcipher_tfm
{
559 int (*setkey
)(struct crypto_tfm
*tfm
, const u8
*key
,
560 unsigned int keylen
);
561 int (*encrypt
)(struct blkcipher_desc
*desc
, struct scatterlist
*dst
,
562 struct scatterlist
*src
, unsigned int nbytes
);
563 int (*decrypt
)(struct blkcipher_desc
*desc
, struct scatterlist
*dst
,
564 struct scatterlist
*src
, unsigned int nbytes
);
568 int (*cit_setkey
)(struct crypto_tfm
*tfm
,
569 const u8
*key
, unsigned int keylen
);
570 void (*cit_encrypt_one
)(struct crypto_tfm
*tfm
, u8
*dst
, const u8
*src
);
571 void (*cit_decrypt_one
)(struct crypto_tfm
*tfm
, u8
*dst
, const u8
*src
);
575 int (*init
)(struct hash_desc
*desc
);
576 int (*update
)(struct hash_desc
*desc
,
577 struct scatterlist
*sg
, unsigned int nsg
);
578 int (*final
)(struct hash_desc
*desc
, u8
*out
);
579 int (*digest
)(struct hash_desc
*desc
, struct scatterlist
*sg
,
580 unsigned int nsg
, u8
*out
);
581 int (*setkey
)(struct crypto_hash
*tfm
, const u8
*key
,
582 unsigned int keylen
);
583 unsigned int digestsize
;
586 struct compress_tfm
{
587 int (*cot_compress
)(struct crypto_tfm
*tfm
,
588 const u8
*src
, unsigned int slen
,
589 u8
*dst
, unsigned int *dlen
);
590 int (*cot_decompress
)(struct crypto_tfm
*tfm
,
591 const u8
*src
, unsigned int slen
,
592 u8
*dst
, unsigned int *dlen
);
595 #define crt_ablkcipher crt_u.ablkcipher
596 #define crt_blkcipher crt_u.blkcipher
597 #define crt_cipher crt_u.cipher
598 #define crt_hash crt_u.hash
599 #define crt_compress crt_u.compress
606 struct ablkcipher_tfm ablkcipher
;
607 struct blkcipher_tfm blkcipher
;
608 struct cipher_tfm cipher
;
609 struct hash_tfm hash
;
610 struct compress_tfm compress
;
613 void (*exit
)(struct crypto_tfm
*tfm
);
615 struct crypto_alg
*__crt_alg
;
617 void *__crt_ctx
[] CRYPTO_MINALIGN_ATTR
;
620 struct crypto_ablkcipher
{
621 struct crypto_tfm base
;
624 struct crypto_blkcipher
{
625 struct crypto_tfm base
;
628 struct crypto_cipher
{
629 struct crypto_tfm base
;
633 struct crypto_tfm base
;
637 struct crypto_tfm base
;
648 #define CRYPTOA_MAX (__CRYPTOA_MAX - 1)
650 /* Maximum number of (rtattr) parameters for each template. */
651 #define CRYPTO_MAX_ATTRS 32
653 struct crypto_attr_alg
{
654 char name
[CRYPTO_MAX_ALG_NAME
];
657 struct crypto_attr_type
{
662 struct crypto_attr_u32
{
667 * Transform user interface.
670 struct crypto_tfm
*crypto_alloc_base(const char *alg_name
, u32 type
, u32 mask
);
671 void crypto_destroy_tfm(void *mem
, struct crypto_tfm
*tfm
);
673 static inline void crypto_free_tfm(struct crypto_tfm
*tfm
)
675 return crypto_destroy_tfm(tfm
, tfm
);
678 int alg_test(const char *driver
, const char *alg
, u32 type
, u32 mask
);
681 * Transform helpers which query the underlying algorithm.
683 static inline const char *crypto_tfm_alg_name(struct crypto_tfm
*tfm
)
685 return tfm
->__crt_alg
->cra_name
;
688 static inline const char *crypto_tfm_alg_driver_name(struct crypto_tfm
*tfm
)
690 return tfm
->__crt_alg
->cra_driver_name
;
693 static inline int crypto_tfm_alg_priority(struct crypto_tfm
*tfm
)
695 return tfm
->__crt_alg
->cra_priority
;
698 static inline u32
crypto_tfm_alg_type(struct crypto_tfm
*tfm
)
700 return tfm
->__crt_alg
->cra_flags
& CRYPTO_ALG_TYPE_MASK
;
703 static inline unsigned int crypto_tfm_alg_blocksize(struct crypto_tfm
*tfm
)
705 return tfm
->__crt_alg
->cra_blocksize
;
708 static inline unsigned int crypto_tfm_alg_alignmask(struct crypto_tfm
*tfm
)
710 return tfm
->__crt_alg
->cra_alignmask
;
713 static inline u32
crypto_tfm_get_flags(struct crypto_tfm
*tfm
)
715 return tfm
->crt_flags
;
718 static inline void crypto_tfm_set_flags(struct crypto_tfm
*tfm
, u32 flags
)
720 tfm
->crt_flags
|= flags
;
723 static inline void crypto_tfm_clear_flags(struct crypto_tfm
*tfm
, u32 flags
)
725 tfm
->crt_flags
&= ~flags
;
728 static inline void *crypto_tfm_ctx(struct crypto_tfm
*tfm
)
730 return tfm
->__crt_ctx
;
733 static inline unsigned int crypto_tfm_ctx_alignment(void)
735 struct crypto_tfm
*tfm
;
736 return __alignof__(tfm
->__crt_ctx
);
742 static inline struct crypto_ablkcipher
*__crypto_ablkcipher_cast(
743 struct crypto_tfm
*tfm
)
745 return (struct crypto_ablkcipher
*)tfm
;
748 static inline u32
crypto_skcipher_type(u32 type
)
750 type
&= ~(CRYPTO_ALG_TYPE_MASK
| CRYPTO_ALG_GENIV
);
751 type
|= CRYPTO_ALG_TYPE_BLKCIPHER
;
755 static inline u32
crypto_skcipher_mask(u32 mask
)
757 mask
&= ~(CRYPTO_ALG_TYPE_MASK
| CRYPTO_ALG_GENIV
);
758 mask
|= CRYPTO_ALG_TYPE_BLKCIPHER_MASK
;
763 * DOC: Asynchronous Block Cipher API
765 * Asynchronous block cipher API is used with the ciphers of type
766 * CRYPTO_ALG_TYPE_ABLKCIPHER (listed as type "ablkcipher" in /proc/crypto).
768 * Asynchronous cipher operations imply that the function invocation for a
769 * cipher request returns immediately before the completion of the operation.
770 * The cipher request is scheduled as a separate kernel thread and therefore
771 * load-balanced on the different CPUs via the process scheduler. To allow
772 * the kernel crypto API to inform the caller about the completion of a cipher
773 * request, the caller must provide a callback function. That function is
774 * invoked with the cipher handle when the request completes.
776 * To support the asynchronous operation, additional information than just the
777 * cipher handle must be supplied to the kernel crypto API. That additional
778 * information is given by filling in the ablkcipher_request data structure.
780 * For the asynchronous block cipher API, the state is maintained with the tfm
781 * cipher handle. A single tfm can be used across multiple calls and in
782 * parallel. For asynchronous block cipher calls, context data supplied and
783 * only used by the caller can be referenced the request data structure in
784 * addition to the IV used for the cipher request. The maintenance of such
785 * state information would be important for a crypto driver implementer to
786 * have, because when calling the callback function upon completion of the
787 * cipher operation, that callback function may need some information about
788 * which operation just finished if it invoked multiple in parallel. This
789 * state information is unused by the kernel crypto API.
793 * crypto_alloc_ablkcipher() - allocate asynchronous block cipher handle
794 * @alg_name: is the cra_name / name or cra_driver_name / driver name of the
796 * @type: specifies the type of the cipher
797 * @mask: specifies the mask for the cipher
799 * Allocate a cipher handle for an ablkcipher. The returned struct
800 * crypto_ablkcipher is the cipher handle that is required for any subsequent
801 * API invocation for that ablkcipher.
803 * Return: allocated cipher handle in case of success; IS_ERR() is true in case
804 * of an error, PTR_ERR() returns the error code.
806 struct crypto_ablkcipher
*crypto_alloc_ablkcipher(const char *alg_name
,
809 static inline struct crypto_tfm
*crypto_ablkcipher_tfm(
810 struct crypto_ablkcipher
*tfm
)
816 * crypto_free_ablkcipher() - zeroize and free cipher handle
817 * @tfm: cipher handle to be freed
819 static inline void crypto_free_ablkcipher(struct crypto_ablkcipher
*tfm
)
821 crypto_free_tfm(crypto_ablkcipher_tfm(tfm
));
825 * crypto_has_ablkcipher() - Search for the availability of an ablkcipher.
826 * @alg_name: is the cra_name / name or cra_driver_name / driver name of the
828 * @type: specifies the type of the cipher
829 * @mask: specifies the mask for the cipher
831 * Return: true when the ablkcipher is known to the kernel crypto API; false
834 static inline int crypto_has_ablkcipher(const char *alg_name
, u32 type
,
837 return crypto_has_alg(alg_name
, crypto_skcipher_type(type
),
838 crypto_skcipher_mask(mask
));
841 static inline struct ablkcipher_tfm
*crypto_ablkcipher_crt(
842 struct crypto_ablkcipher
*tfm
)
844 return &crypto_ablkcipher_tfm(tfm
)->crt_ablkcipher
;
848 * crypto_ablkcipher_ivsize() - obtain IV size
849 * @tfm: cipher handle
851 * The size of the IV for the ablkcipher referenced by the cipher handle is
852 * returned. This IV size may be zero if the cipher does not need an IV.
854 * Return: IV size in bytes
856 static inline unsigned int crypto_ablkcipher_ivsize(
857 struct crypto_ablkcipher
*tfm
)
859 return crypto_ablkcipher_crt(tfm
)->ivsize
;
863 * crypto_ablkcipher_blocksize() - obtain block size of cipher
864 * @tfm: cipher handle
866 * The block size for the ablkcipher referenced with the cipher handle is
867 * returned. The caller may use that information to allocate appropriate
868 * memory for the data returned by the encryption or decryption operation
870 * Return: block size of cipher
872 static inline unsigned int crypto_ablkcipher_blocksize(
873 struct crypto_ablkcipher
*tfm
)
875 return crypto_tfm_alg_blocksize(crypto_ablkcipher_tfm(tfm
));
878 static inline unsigned int crypto_ablkcipher_alignmask(
879 struct crypto_ablkcipher
*tfm
)
881 return crypto_tfm_alg_alignmask(crypto_ablkcipher_tfm(tfm
));
884 static inline u32
crypto_ablkcipher_get_flags(struct crypto_ablkcipher
*tfm
)
886 return crypto_tfm_get_flags(crypto_ablkcipher_tfm(tfm
));
889 static inline void crypto_ablkcipher_set_flags(struct crypto_ablkcipher
*tfm
,
892 crypto_tfm_set_flags(crypto_ablkcipher_tfm(tfm
), flags
);
895 static inline void crypto_ablkcipher_clear_flags(struct crypto_ablkcipher
*tfm
,
898 crypto_tfm_clear_flags(crypto_ablkcipher_tfm(tfm
), flags
);
902 * crypto_ablkcipher_setkey() - set key for cipher
903 * @tfm: cipher handle
904 * @key: buffer holding the key
905 * @keylen: length of the key in bytes
907 * The caller provided key is set for the ablkcipher referenced by the cipher
910 * Note, the key length determines the cipher type. Many block ciphers implement
911 * different cipher modes depending on the key size, such as AES-128 vs AES-192
912 * vs. AES-256. When providing a 16 byte key for an AES cipher handle, AES-128
915 * Return: 0 if the setting of the key was successful; < 0 if an error occurred
917 static inline int crypto_ablkcipher_setkey(struct crypto_ablkcipher
*tfm
,
918 const u8
*key
, unsigned int keylen
)
920 struct ablkcipher_tfm
*crt
= crypto_ablkcipher_crt(tfm
);
922 return crt
->setkey(crt
->base
, key
, keylen
);
926 * crypto_ablkcipher_reqtfm() - obtain cipher handle from request
927 * @req: ablkcipher_request out of which the cipher handle is to be obtained
929 * Return the crypto_ablkcipher handle when furnishing an ablkcipher_request
932 * Return: crypto_ablkcipher handle
934 static inline struct crypto_ablkcipher
*crypto_ablkcipher_reqtfm(
935 struct ablkcipher_request
*req
)
937 return __crypto_ablkcipher_cast(req
->base
.tfm
);
941 * crypto_ablkcipher_encrypt() - encrypt plaintext
942 * @req: reference to the ablkcipher_request handle that holds all information
943 * needed to perform the cipher operation
945 * Encrypt plaintext data using the ablkcipher_request handle. That data
946 * structure and how it is filled with data is discussed with the
947 * ablkcipher_request_* functions.
949 * Return: 0 if the cipher operation was successful; < 0 if an error occurred
951 static inline int crypto_ablkcipher_encrypt(struct ablkcipher_request
*req
)
953 struct ablkcipher_tfm
*crt
=
954 crypto_ablkcipher_crt(crypto_ablkcipher_reqtfm(req
));
955 return crt
->encrypt(req
);
959 * crypto_ablkcipher_decrypt() - decrypt ciphertext
960 * @req: reference to the ablkcipher_request handle that holds all information
961 * needed to perform the cipher operation
963 * Decrypt ciphertext data using the ablkcipher_request handle. That data
964 * structure and how it is filled with data is discussed with the
965 * ablkcipher_request_* functions.
967 * Return: 0 if the cipher operation was successful; < 0 if an error occurred
969 static inline int crypto_ablkcipher_decrypt(struct ablkcipher_request
*req
)
971 struct ablkcipher_tfm
*crt
=
972 crypto_ablkcipher_crt(crypto_ablkcipher_reqtfm(req
));
973 return crt
->decrypt(req
);
977 * DOC: Asynchronous Cipher Request Handle
979 * The ablkcipher_request data structure contains all pointers to data
980 * required for the asynchronous cipher operation. This includes the cipher
981 * handle (which can be used by multiple ablkcipher_request instances), pointer
982 * to plaintext and ciphertext, asynchronous callback function, etc. It acts
983 * as a handle to the ablkcipher_request_* API calls in a similar way as
984 * ablkcipher handle to the crypto_ablkcipher_* API calls.
988 * crypto_ablkcipher_reqsize() - obtain size of the request data structure
989 * @tfm: cipher handle
991 * Return: number of bytes
993 static inline unsigned int crypto_ablkcipher_reqsize(
994 struct crypto_ablkcipher
*tfm
)
996 return crypto_ablkcipher_crt(tfm
)->reqsize
;
1000 * ablkcipher_request_set_tfm() - update cipher handle reference in request
1001 * @req: request handle to be modified
1002 * @tfm: cipher handle that shall be added to the request handle
1004 * Allow the caller to replace the existing ablkcipher handle in the request
1005 * data structure with a different one.
1007 static inline void ablkcipher_request_set_tfm(
1008 struct ablkcipher_request
*req
, struct crypto_ablkcipher
*tfm
)
1010 req
->base
.tfm
= crypto_ablkcipher_tfm(crypto_ablkcipher_crt(tfm
)->base
);
1013 static inline struct ablkcipher_request
*ablkcipher_request_cast(
1014 struct crypto_async_request
*req
)
1016 return container_of(req
, struct ablkcipher_request
, base
);
1020 * ablkcipher_request_alloc() - allocate request data structure
1021 * @tfm: cipher handle to be registered with the request
1022 * @gfp: memory allocation flag that is handed to kmalloc by the API call.
1024 * Allocate the request data structure that must be used with the ablkcipher
1025 * encrypt and decrypt API calls. During the allocation, the provided ablkcipher
1026 * handle is registered in the request data structure.
1028 * Return: allocated request handle in case of success; IS_ERR() is true in case
1029 * of an error, PTR_ERR() returns the error code.
1031 static inline struct ablkcipher_request
*ablkcipher_request_alloc(
1032 struct crypto_ablkcipher
*tfm
, gfp_t gfp
)
1034 struct ablkcipher_request
*req
;
1036 req
= kmalloc(sizeof(struct ablkcipher_request
) +
1037 crypto_ablkcipher_reqsize(tfm
), gfp
);
1040 ablkcipher_request_set_tfm(req
, tfm
);
1046 * ablkcipher_request_free() - zeroize and free request data structure
1047 * @req: request data structure cipher handle to be freed
1049 static inline void ablkcipher_request_free(struct ablkcipher_request
*req
)
1055 * ablkcipher_request_set_callback() - set asynchronous callback function
1056 * @req: request handle
1057 * @flags: specify zero or an ORing of the flags
1058 * CRYPTO_TFM_REQ_MAY_BACKLOG the request queue may back log and
1059 * increase the wait queue beyond the initial maximum size;
1060 * CRYPTO_TFM_REQ_MAY_SLEEP the request processing may sleep
1061 * @compl: callback function pointer to be registered with the request handle
1062 * @data: The data pointer refers to memory that is not used by the kernel
1063 * crypto API, but provided to the callback function for it to use. Here,
1064 * the caller can provide a reference to memory the callback function can
1065 * operate on. As the callback function is invoked asynchronously to the
1066 * related functionality, it may need to access data structures of the
1067 * related functionality which can be referenced using this pointer. The
1068 * callback function can access the memory via the "data" field in the
1069 * crypto_async_request data structure provided to the callback function.
1071 * This function allows setting the callback function that is triggered once the
1072 * cipher operation completes.
1074 * The callback function is registered with the ablkcipher_request handle and
1075 * must comply with the following template
1077 * void callback_function(struct crypto_async_request *req, int error)
1079 static inline void ablkcipher_request_set_callback(
1080 struct ablkcipher_request
*req
,
1081 u32 flags
, crypto_completion_t
compl, void *data
)
1083 req
->base
.complete
= compl;
1084 req
->base
.data
= data
;
1085 req
->base
.flags
= flags
;
1089 * ablkcipher_request_set_crypt() - set data buffers
1090 * @req: request handle
1091 * @src: source scatter / gather list
1092 * @dst: destination scatter / gather list
1093 * @nbytes: number of bytes to process from @src
1094 * @iv: IV for the cipher operation which must comply with the IV size defined
1095 * by crypto_ablkcipher_ivsize
1097 * This function allows setting of the source data and destination data
1098 * scatter / gather lists.
1100 * For encryption, the source is treated as the plaintext and the
1101 * destination is the ciphertext. For a decryption operation, the use is
1102 * reversed - the source is the ciphertext and the destination is the plaintext.
1104 static inline void ablkcipher_request_set_crypt(
1105 struct ablkcipher_request
*req
,
1106 struct scatterlist
*src
, struct scatterlist
*dst
,
1107 unsigned int nbytes
, void *iv
)
1111 req
->nbytes
= nbytes
;
1116 * DOC: Synchronous Block Cipher API
1118 * The synchronous block cipher API is used with the ciphers of type
1119 * CRYPTO_ALG_TYPE_BLKCIPHER (listed as type "blkcipher" in /proc/crypto)
1121 * Synchronous calls, have a context in the tfm. But since a single tfm can be
1122 * used in multiple calls and in parallel, this info should not be changeable
1123 * (unless a lock is used). This applies, for example, to the symmetric key.
1124 * However, the IV is changeable, so there is an iv field in blkcipher_tfm
1125 * structure for synchronous blkcipher api. So, its the only state info that can
1126 * be kept for synchronous calls without using a big lock across a tfm.
1128 * The block cipher API allows the use of a complete cipher, i.e. a cipher
1129 * consisting of a template (a block chaining mode) and a single block cipher
1130 * primitive (e.g. AES).
1132 * The plaintext data buffer and the ciphertext data buffer are pointed to
1133 * by using scatter/gather lists. The cipher operation is performed
1134 * on all segments of the provided scatter/gather lists.
1136 * The kernel crypto API supports a cipher operation "in-place" which means that
1137 * the caller may provide the same scatter/gather list for the plaintext and
1138 * cipher text. After the completion of the cipher operation, the plaintext
1139 * data is replaced with the ciphertext data in case of an encryption and vice
1140 * versa for a decryption. The caller must ensure that the scatter/gather lists
1141 * for the output data point to sufficiently large buffers, i.e. multiples of
1142 * the block size of the cipher.
1145 static inline struct crypto_blkcipher
*__crypto_blkcipher_cast(
1146 struct crypto_tfm
*tfm
)
1148 return (struct crypto_blkcipher
*)tfm
;
1151 static inline struct crypto_blkcipher
*crypto_blkcipher_cast(
1152 struct crypto_tfm
*tfm
)
1154 BUG_ON(crypto_tfm_alg_type(tfm
) != CRYPTO_ALG_TYPE_BLKCIPHER
);
1155 return __crypto_blkcipher_cast(tfm
);
1159 * crypto_alloc_blkcipher() - allocate synchronous block cipher handle
1160 * @alg_name: is the cra_name / name or cra_driver_name / driver name of the
1162 * @type: specifies the type of the cipher
1163 * @mask: specifies the mask for the cipher
1165 * Allocate a cipher handle for a block cipher. The returned struct
1166 * crypto_blkcipher is the cipher handle that is required for any subsequent
1167 * API invocation for that block cipher.
1169 * Return: allocated cipher handle in case of success; IS_ERR() is true in case
1170 * of an error, PTR_ERR() returns the error code.
1172 static inline struct crypto_blkcipher
*crypto_alloc_blkcipher(
1173 const char *alg_name
, u32 type
, u32 mask
)
1175 type
&= ~CRYPTO_ALG_TYPE_MASK
;
1176 type
|= CRYPTO_ALG_TYPE_BLKCIPHER
;
1177 mask
|= CRYPTO_ALG_TYPE_MASK
;
1179 return __crypto_blkcipher_cast(crypto_alloc_base(alg_name
, type
, mask
));
1182 static inline struct crypto_tfm
*crypto_blkcipher_tfm(
1183 struct crypto_blkcipher
*tfm
)
1189 * crypto_free_blkcipher() - zeroize and free the block cipher handle
1190 * @tfm: cipher handle to be freed
1192 static inline void crypto_free_blkcipher(struct crypto_blkcipher
*tfm
)
1194 crypto_free_tfm(crypto_blkcipher_tfm(tfm
));
1198 * crypto_has_blkcipher() - Search for the availability of a block cipher
1199 * @alg_name: is the cra_name / name or cra_driver_name / driver name of the
1201 * @type: specifies the type of the cipher
1202 * @mask: specifies the mask for the cipher
1204 * Return: true when the block cipher is known to the kernel crypto API; false
1207 static inline int crypto_has_blkcipher(const char *alg_name
, u32 type
, u32 mask
)
1209 type
&= ~CRYPTO_ALG_TYPE_MASK
;
1210 type
|= CRYPTO_ALG_TYPE_BLKCIPHER
;
1211 mask
|= CRYPTO_ALG_TYPE_MASK
;
1213 return crypto_has_alg(alg_name
, type
, mask
);
1217 * crypto_blkcipher_name() - return the name / cra_name from the cipher handle
1218 * @tfm: cipher handle
1220 * Return: The character string holding the name of the cipher
1222 static inline const char *crypto_blkcipher_name(struct crypto_blkcipher
*tfm
)
1224 return crypto_tfm_alg_name(crypto_blkcipher_tfm(tfm
));
1227 static inline struct blkcipher_tfm
*crypto_blkcipher_crt(
1228 struct crypto_blkcipher
*tfm
)
1230 return &crypto_blkcipher_tfm(tfm
)->crt_blkcipher
;
1233 static inline struct blkcipher_alg
*crypto_blkcipher_alg(
1234 struct crypto_blkcipher
*tfm
)
1236 return &crypto_blkcipher_tfm(tfm
)->__crt_alg
->cra_blkcipher
;
1240 * crypto_blkcipher_ivsize() - obtain IV size
1241 * @tfm: cipher handle
1243 * The size of the IV for the block cipher referenced by the cipher handle is
1244 * returned. This IV size may be zero if the cipher does not need an IV.
1246 * Return: IV size in bytes
1248 static inline unsigned int crypto_blkcipher_ivsize(struct crypto_blkcipher
*tfm
)
1250 return crypto_blkcipher_alg(tfm
)->ivsize
;
1254 * crypto_blkcipher_blocksize() - obtain block size of cipher
1255 * @tfm: cipher handle
1257 * The block size for the block cipher referenced with the cipher handle is
1258 * returned. The caller may use that information to allocate appropriate
1259 * memory for the data returned by the encryption or decryption operation.
1261 * Return: block size of cipher
1263 static inline unsigned int crypto_blkcipher_blocksize(
1264 struct crypto_blkcipher
*tfm
)
1266 return crypto_tfm_alg_blocksize(crypto_blkcipher_tfm(tfm
));
1269 static inline unsigned int crypto_blkcipher_alignmask(
1270 struct crypto_blkcipher
*tfm
)
1272 return crypto_tfm_alg_alignmask(crypto_blkcipher_tfm(tfm
));
1275 static inline u32
crypto_blkcipher_get_flags(struct crypto_blkcipher
*tfm
)
1277 return crypto_tfm_get_flags(crypto_blkcipher_tfm(tfm
));
1280 static inline void crypto_blkcipher_set_flags(struct crypto_blkcipher
*tfm
,
1283 crypto_tfm_set_flags(crypto_blkcipher_tfm(tfm
), flags
);
1286 static inline void crypto_blkcipher_clear_flags(struct crypto_blkcipher
*tfm
,
1289 crypto_tfm_clear_flags(crypto_blkcipher_tfm(tfm
), flags
);
1293 * crypto_blkcipher_setkey() - set key for cipher
1294 * @tfm: cipher handle
1295 * @key: buffer holding the key
1296 * @keylen: length of the key in bytes
1298 * The caller provided key is set for the block cipher referenced by the cipher
1301 * Note, the key length determines the cipher type. Many block ciphers implement
1302 * different cipher modes depending on the key size, such as AES-128 vs AES-192
1303 * vs. AES-256. When providing a 16 byte key for an AES cipher handle, AES-128
1306 * Return: 0 if the setting of the key was successful; < 0 if an error occurred
1308 static inline int crypto_blkcipher_setkey(struct crypto_blkcipher
*tfm
,
1309 const u8
*key
, unsigned int keylen
)
1311 return crypto_blkcipher_crt(tfm
)->setkey(crypto_blkcipher_tfm(tfm
),
1316 * crypto_blkcipher_encrypt() - encrypt plaintext
1317 * @desc: reference to the block cipher handle with meta data
1318 * @dst: scatter/gather list that is filled by the cipher operation with the
1320 * @src: scatter/gather list that holds the plaintext
1321 * @nbytes: number of bytes of the plaintext to encrypt.
1323 * Encrypt plaintext data using the IV set by the caller with a preceding
1324 * call of crypto_blkcipher_set_iv.
1326 * The blkcipher_desc data structure must be filled by the caller and can
1327 * reside on the stack. The caller must fill desc as follows: desc.tfm is filled
1328 * with the block cipher handle; desc.flags is filled with either
1329 * CRYPTO_TFM_REQ_MAY_SLEEP or 0.
1331 * Return: 0 if the cipher operation was successful; < 0 if an error occurred
1333 static inline int crypto_blkcipher_encrypt(struct blkcipher_desc
*desc
,
1334 struct scatterlist
*dst
,
1335 struct scatterlist
*src
,
1336 unsigned int nbytes
)
1338 desc
->info
= crypto_blkcipher_crt(desc
->tfm
)->iv
;
1339 return crypto_blkcipher_crt(desc
->tfm
)->encrypt(desc
, dst
, src
, nbytes
);
1343 * crypto_blkcipher_encrypt_iv() - encrypt plaintext with dedicated IV
1344 * @desc: reference to the block cipher handle with meta data
1345 * @dst: scatter/gather list that is filled by the cipher operation with the
1347 * @src: scatter/gather list that holds the plaintext
1348 * @nbytes: number of bytes of the plaintext to encrypt.
1350 * Encrypt plaintext data with the use of an IV that is solely used for this
1351 * cipher operation. Any previously set IV is not used.
1353 * The blkcipher_desc data structure must be filled by the caller and can
1354 * reside on the stack. The caller must fill desc as follows: desc.tfm is filled
1355 * with the block cipher handle; desc.info is filled with the IV to be used for
1356 * the current operation; desc.flags is filled with either
1357 * CRYPTO_TFM_REQ_MAY_SLEEP or 0.
1359 * Return: 0 if the cipher operation was successful; < 0 if an error occurred
1361 static inline int crypto_blkcipher_encrypt_iv(struct blkcipher_desc
*desc
,
1362 struct scatterlist
*dst
,
1363 struct scatterlist
*src
,
1364 unsigned int nbytes
)
1366 return crypto_blkcipher_crt(desc
->tfm
)->encrypt(desc
, dst
, src
, nbytes
);
1370 * crypto_blkcipher_decrypt() - decrypt ciphertext
1371 * @desc: reference to the block cipher handle with meta data
1372 * @dst: scatter/gather list that is filled by the cipher operation with the
1374 * @src: scatter/gather list that holds the ciphertext
1375 * @nbytes: number of bytes of the ciphertext to decrypt.
1377 * Decrypt ciphertext data using the IV set by the caller with a preceding
1378 * call of crypto_blkcipher_set_iv.
1380 * The blkcipher_desc data structure must be filled by the caller as documented
1381 * for the crypto_blkcipher_encrypt call above.
1383 * Return: 0 if the cipher operation was successful; < 0 if an error occurred
1386 static inline int crypto_blkcipher_decrypt(struct blkcipher_desc
*desc
,
1387 struct scatterlist
*dst
,
1388 struct scatterlist
*src
,
1389 unsigned int nbytes
)
1391 desc
->info
= crypto_blkcipher_crt(desc
->tfm
)->iv
;
1392 return crypto_blkcipher_crt(desc
->tfm
)->decrypt(desc
, dst
, src
, nbytes
);
1396 * crypto_blkcipher_decrypt_iv() - decrypt ciphertext with dedicated IV
1397 * @desc: reference to the block cipher handle with meta data
1398 * @dst: scatter/gather list that is filled by the cipher operation with the
1400 * @src: scatter/gather list that holds the ciphertext
1401 * @nbytes: number of bytes of the ciphertext to decrypt.
1403 * Decrypt ciphertext data with the use of an IV that is solely used for this
1404 * cipher operation. Any previously set IV is not used.
1406 * The blkcipher_desc data structure must be filled by the caller as documented
1407 * for the crypto_blkcipher_encrypt_iv call above.
1409 * Return: 0 if the cipher operation was successful; < 0 if an error occurred
1411 static inline int crypto_blkcipher_decrypt_iv(struct blkcipher_desc
*desc
,
1412 struct scatterlist
*dst
,
1413 struct scatterlist
*src
,
1414 unsigned int nbytes
)
1416 return crypto_blkcipher_crt(desc
->tfm
)->decrypt(desc
, dst
, src
, nbytes
);
1420 * crypto_blkcipher_set_iv() - set IV for cipher
1421 * @tfm: cipher handle
1422 * @src: buffer holding the IV
1423 * @len: length of the IV in bytes
1425 * The caller provided IV is set for the block cipher referenced by the cipher
1428 static inline void crypto_blkcipher_set_iv(struct crypto_blkcipher
*tfm
,
1429 const u8
*src
, unsigned int len
)
1431 memcpy(crypto_blkcipher_crt(tfm
)->iv
, src
, len
);
1435 * crypto_blkcipher_get_iv() - obtain IV from cipher
1436 * @tfm: cipher handle
1437 * @dst: buffer filled with the IV
1438 * @len: length of the buffer dst
1440 * The caller can obtain the IV set for the block cipher referenced by the
1441 * cipher handle and store it into the user-provided buffer. If the buffer
1442 * has an insufficient space, the IV is truncated to fit the buffer.
1444 static inline void crypto_blkcipher_get_iv(struct crypto_blkcipher
*tfm
,
1445 u8
*dst
, unsigned int len
)
1447 memcpy(dst
, crypto_blkcipher_crt(tfm
)->iv
, len
);
1451 * DOC: Single Block Cipher API
1453 * The single block cipher API is used with the ciphers of type
1454 * CRYPTO_ALG_TYPE_CIPHER (listed as type "cipher" in /proc/crypto).
1456 * Using the single block cipher API calls, operations with the basic cipher
1457 * primitive can be implemented. These cipher primitives exclude any block
1458 * chaining operations including IV handling.
1460 * The purpose of this single block cipher API is to support the implementation
1461 * of templates or other concepts that only need to perform the cipher operation
1462 * on one block at a time. Templates invoke the underlying cipher primitive
1463 * block-wise and process either the input or the output data of these cipher
1467 static inline struct crypto_cipher
*__crypto_cipher_cast(struct crypto_tfm
*tfm
)
1469 return (struct crypto_cipher
*)tfm
;
1472 static inline struct crypto_cipher
*crypto_cipher_cast(struct crypto_tfm
*tfm
)
1474 BUG_ON(crypto_tfm_alg_type(tfm
) != CRYPTO_ALG_TYPE_CIPHER
);
1475 return __crypto_cipher_cast(tfm
);
1479 * crypto_alloc_cipher() - allocate single block cipher handle
1480 * @alg_name: is the cra_name / name or cra_driver_name / driver name of the
1481 * single block cipher
1482 * @type: specifies the type of the cipher
1483 * @mask: specifies the mask for the cipher
1485 * Allocate a cipher handle for a single block cipher. The returned struct
1486 * crypto_cipher is the cipher handle that is required for any subsequent API
1487 * invocation for that single block cipher.
1489 * Return: allocated cipher handle in case of success; IS_ERR() is true in case
1490 * of an error, PTR_ERR() returns the error code.
1492 static inline struct crypto_cipher
*crypto_alloc_cipher(const char *alg_name
,
1495 type
&= ~CRYPTO_ALG_TYPE_MASK
;
1496 type
|= CRYPTO_ALG_TYPE_CIPHER
;
1497 mask
|= CRYPTO_ALG_TYPE_MASK
;
1499 return __crypto_cipher_cast(crypto_alloc_base(alg_name
, type
, mask
));
1502 static inline struct crypto_tfm
*crypto_cipher_tfm(struct crypto_cipher
*tfm
)
1508 * crypto_free_cipher() - zeroize and free the single block cipher handle
1509 * @tfm: cipher handle to be freed
1511 static inline void crypto_free_cipher(struct crypto_cipher
*tfm
)
1513 crypto_free_tfm(crypto_cipher_tfm(tfm
));
1517 * crypto_has_cipher() - Search for the availability of a single block cipher
1518 * @alg_name: is the cra_name / name or cra_driver_name / driver name of the
1519 * single block cipher
1520 * @type: specifies the type of the cipher
1521 * @mask: specifies the mask for the cipher
1523 * Return: true when the single block cipher is known to the kernel crypto API;
1526 static inline int crypto_has_cipher(const char *alg_name
, u32 type
, u32 mask
)
1528 type
&= ~CRYPTO_ALG_TYPE_MASK
;
1529 type
|= CRYPTO_ALG_TYPE_CIPHER
;
1530 mask
|= CRYPTO_ALG_TYPE_MASK
;
1532 return crypto_has_alg(alg_name
, type
, mask
);
1535 static inline struct cipher_tfm
*crypto_cipher_crt(struct crypto_cipher
*tfm
)
1537 return &crypto_cipher_tfm(tfm
)->crt_cipher
;
1541 * crypto_cipher_blocksize() - obtain block size for cipher
1542 * @tfm: cipher handle
1544 * The block size for the single block cipher referenced with the cipher handle
1545 * tfm is returned. The caller may use that information to allocate appropriate
1546 * memory for the data returned by the encryption or decryption operation
1548 * Return: block size of cipher
1550 static inline unsigned int crypto_cipher_blocksize(struct crypto_cipher
*tfm
)
1552 return crypto_tfm_alg_blocksize(crypto_cipher_tfm(tfm
));
1555 static inline unsigned int crypto_cipher_alignmask(struct crypto_cipher
*tfm
)
1557 return crypto_tfm_alg_alignmask(crypto_cipher_tfm(tfm
));
1560 static inline u32
crypto_cipher_get_flags(struct crypto_cipher
*tfm
)
1562 return crypto_tfm_get_flags(crypto_cipher_tfm(tfm
));
1565 static inline void crypto_cipher_set_flags(struct crypto_cipher
*tfm
,
1568 crypto_tfm_set_flags(crypto_cipher_tfm(tfm
), flags
);
1571 static inline void crypto_cipher_clear_flags(struct crypto_cipher
*tfm
,
1574 crypto_tfm_clear_flags(crypto_cipher_tfm(tfm
), flags
);
1578 * crypto_cipher_setkey() - set key for cipher
1579 * @tfm: cipher handle
1580 * @key: buffer holding the key
1581 * @keylen: length of the key in bytes
1583 * The caller provided key is set for the single block cipher referenced by the
1586 * Note, the key length determines the cipher type. Many block ciphers implement
1587 * different cipher modes depending on the key size, such as AES-128 vs AES-192
1588 * vs. AES-256. When providing a 16 byte key for an AES cipher handle, AES-128
1591 * Return: 0 if the setting of the key was successful; < 0 if an error occurred
1593 static inline int crypto_cipher_setkey(struct crypto_cipher
*tfm
,
1594 const u8
*key
, unsigned int keylen
)
1596 return crypto_cipher_crt(tfm
)->cit_setkey(crypto_cipher_tfm(tfm
),
1601 * crypto_cipher_encrypt_one() - encrypt one block of plaintext
1602 * @tfm: cipher handle
1603 * @dst: points to the buffer that will be filled with the ciphertext
1604 * @src: buffer holding the plaintext to be encrypted
1606 * Invoke the encryption operation of one block. The caller must ensure that
1607 * the plaintext and ciphertext buffers are at least one block in size.
1609 static inline void crypto_cipher_encrypt_one(struct crypto_cipher
*tfm
,
1610 u8
*dst
, const u8
*src
)
1612 crypto_cipher_crt(tfm
)->cit_encrypt_one(crypto_cipher_tfm(tfm
),
1617 * crypto_cipher_decrypt_one() - decrypt one block of ciphertext
1618 * @tfm: cipher handle
1619 * @dst: points to the buffer that will be filled with the plaintext
1620 * @src: buffer holding the ciphertext to be decrypted
1622 * Invoke the decryption operation of one block. The caller must ensure that
1623 * the plaintext and ciphertext buffers are at least one block in size.
1625 static inline void crypto_cipher_decrypt_one(struct crypto_cipher
*tfm
,
1626 u8
*dst
, const u8
*src
)
1628 crypto_cipher_crt(tfm
)->cit_decrypt_one(crypto_cipher_tfm(tfm
),
1633 * DOC: Synchronous Message Digest API
1635 * The synchronous message digest API is used with the ciphers of type
1636 * CRYPTO_ALG_TYPE_HASH (listed as type "hash" in /proc/crypto)
1639 static inline struct crypto_hash
*__crypto_hash_cast(struct crypto_tfm
*tfm
)
1641 return (struct crypto_hash
*)tfm
;
1644 static inline struct crypto_hash
*crypto_hash_cast(struct crypto_tfm
*tfm
)
1646 BUG_ON((crypto_tfm_alg_type(tfm
) ^ CRYPTO_ALG_TYPE_HASH
) &
1647 CRYPTO_ALG_TYPE_HASH_MASK
);
1648 return __crypto_hash_cast(tfm
);
1652 * crypto_alloc_hash() - allocate synchronous message digest handle
1653 * @alg_name: is the cra_name / name or cra_driver_name / driver name of the
1654 * message digest cipher
1655 * @type: specifies the type of the cipher
1656 * @mask: specifies the mask for the cipher
1658 * Allocate a cipher handle for a message digest. The returned struct
1659 * crypto_hash is the cipher handle that is required for any subsequent
1660 * API invocation for that message digest.
1662 * Return: allocated cipher handle in case of success; IS_ERR() is true in case
1663 * of an error, PTR_ERR() returns the error code.
1665 static inline struct crypto_hash
*crypto_alloc_hash(const char *alg_name
,
1668 type
&= ~CRYPTO_ALG_TYPE_MASK
;
1669 mask
&= ~CRYPTO_ALG_TYPE_MASK
;
1670 type
|= CRYPTO_ALG_TYPE_HASH
;
1671 mask
|= CRYPTO_ALG_TYPE_HASH_MASK
;
1673 return __crypto_hash_cast(crypto_alloc_base(alg_name
, type
, mask
));
1676 static inline struct crypto_tfm
*crypto_hash_tfm(struct crypto_hash
*tfm
)
1682 * crypto_free_hash() - zeroize and free message digest handle
1683 * @tfm: cipher handle to be freed
1685 static inline void crypto_free_hash(struct crypto_hash
*tfm
)
1687 crypto_free_tfm(crypto_hash_tfm(tfm
));
1691 * crypto_has_hash() - Search for the availability of a message digest
1692 * @alg_name: is the cra_name / name or cra_driver_name / driver name of the
1693 * message digest cipher
1694 * @type: specifies the type of the cipher
1695 * @mask: specifies the mask for the cipher
1697 * Return: true when the message digest cipher is known to the kernel crypto
1698 * API; false otherwise
1700 static inline int crypto_has_hash(const char *alg_name
, u32 type
, u32 mask
)
1702 type
&= ~CRYPTO_ALG_TYPE_MASK
;
1703 mask
&= ~CRYPTO_ALG_TYPE_MASK
;
1704 type
|= CRYPTO_ALG_TYPE_HASH
;
1705 mask
|= CRYPTO_ALG_TYPE_HASH_MASK
;
1707 return crypto_has_alg(alg_name
, type
, mask
);
1710 static inline struct hash_tfm
*crypto_hash_crt(struct crypto_hash
*tfm
)
1712 return &crypto_hash_tfm(tfm
)->crt_hash
;
1716 * crypto_hash_blocksize() - obtain block size for message digest
1717 * @tfm: cipher handle
1719 * The block size for the message digest cipher referenced with the cipher
1720 * handle is returned.
1722 * Return: block size of cipher
1724 static inline unsigned int crypto_hash_blocksize(struct crypto_hash
*tfm
)
1726 return crypto_tfm_alg_blocksize(crypto_hash_tfm(tfm
));
1729 static inline unsigned int crypto_hash_alignmask(struct crypto_hash
*tfm
)
1731 return crypto_tfm_alg_alignmask(crypto_hash_tfm(tfm
));
1735 * crypto_hash_digestsize() - obtain message digest size
1736 * @tfm: cipher handle
1738 * The size for the message digest created by the message digest cipher
1739 * referenced with the cipher handle is returned.
1741 * Return: message digest size
1743 static inline unsigned int crypto_hash_digestsize(struct crypto_hash
*tfm
)
1745 return crypto_hash_crt(tfm
)->digestsize
;
1748 static inline u32
crypto_hash_get_flags(struct crypto_hash
*tfm
)
1750 return crypto_tfm_get_flags(crypto_hash_tfm(tfm
));
1753 static inline void crypto_hash_set_flags(struct crypto_hash
*tfm
, u32 flags
)
1755 crypto_tfm_set_flags(crypto_hash_tfm(tfm
), flags
);
1758 static inline void crypto_hash_clear_flags(struct crypto_hash
*tfm
, u32 flags
)
1760 crypto_tfm_clear_flags(crypto_hash_tfm(tfm
), flags
);
1764 * crypto_hash_init() - (re)initialize message digest handle
1765 * @desc: cipher request handle that to be filled by caller --
1766 * desc.tfm is filled with the hash cipher handle;
1767 * desc.flags is filled with either CRYPTO_TFM_REQ_MAY_SLEEP or 0.
1769 * The call (re-)initializes the message digest referenced by the hash cipher
1770 * request handle. Any potentially existing state created by previous
1771 * operations is discarded.
1773 * Return: 0 if the message digest initialization was successful; < 0 if an
1776 static inline int crypto_hash_init(struct hash_desc
*desc
)
1778 return crypto_hash_crt(desc
->tfm
)->init(desc
);
1782 * crypto_hash_update() - add data to message digest for processing
1783 * @desc: cipher request handle
1784 * @sg: scatter / gather list pointing to the data to be added to the message
1786 * @nbytes: number of bytes to be processed from @sg
1788 * Updates the message digest state of the cipher handle pointed to by the
1789 * hash cipher request handle with the input data pointed to by the
1790 * scatter/gather list.
1792 * Return: 0 if the message digest update was successful; < 0 if an error
1795 static inline int crypto_hash_update(struct hash_desc
*desc
,
1796 struct scatterlist
*sg
,
1797 unsigned int nbytes
)
1799 return crypto_hash_crt(desc
->tfm
)->update(desc
, sg
, nbytes
);
1803 * crypto_hash_final() - calculate message digest
1804 * @desc: cipher request handle
1805 * @out: message digest output buffer -- The caller must ensure that the out
1806 * buffer has a sufficient size (e.g. by using the crypto_hash_digestsize
1809 * Finalize the message digest operation and create the message digest
1810 * based on all data added to the cipher handle. The message digest is placed
1811 * into the output buffer.
1813 * Return: 0 if the message digest creation was successful; < 0 if an error
1816 static inline int crypto_hash_final(struct hash_desc
*desc
, u8
*out
)
1818 return crypto_hash_crt(desc
->tfm
)->final(desc
, out
);
1822 * crypto_hash_digest() - calculate message digest for a buffer
1823 * @desc: see crypto_hash_final()
1824 * @sg: see crypto_hash_update()
1825 * @nbytes: see crypto_hash_update()
1826 * @out: see crypto_hash_final()
1828 * This function is a "short-hand" for the function calls of crypto_hash_init,
1829 * crypto_hash_update and crypto_hash_final. The parameters have the same
1830 * meaning as discussed for those separate three functions.
1832 * Return: 0 if the message digest creation was successful; < 0 if an error
1835 static inline int crypto_hash_digest(struct hash_desc
*desc
,
1836 struct scatterlist
*sg
,
1837 unsigned int nbytes
, u8
*out
)
1839 return crypto_hash_crt(desc
->tfm
)->digest(desc
, sg
, nbytes
, out
);
1843 * crypto_hash_setkey() - set key for message digest
1844 * @hash: cipher handle
1845 * @key: buffer holding the key
1846 * @keylen: length of the key in bytes
1848 * The caller provided key is set for the message digest cipher. The cipher
1849 * handle must point to a keyed hash in order for this function to succeed.
1851 * Return: 0 if the setting of the key was successful; < 0 if an error occurred
1853 static inline int crypto_hash_setkey(struct crypto_hash
*hash
,
1854 const u8
*key
, unsigned int keylen
)
1856 return crypto_hash_crt(hash
)->setkey(hash
, key
, keylen
);
1859 static inline struct crypto_comp
*__crypto_comp_cast(struct crypto_tfm
*tfm
)
1861 return (struct crypto_comp
*)tfm
;
1864 static inline struct crypto_comp
*crypto_comp_cast(struct crypto_tfm
*tfm
)
1866 BUG_ON((crypto_tfm_alg_type(tfm
) ^ CRYPTO_ALG_TYPE_COMPRESS
) &
1867 CRYPTO_ALG_TYPE_MASK
);
1868 return __crypto_comp_cast(tfm
);
1871 static inline struct crypto_comp
*crypto_alloc_comp(const char *alg_name
,
1874 type
&= ~CRYPTO_ALG_TYPE_MASK
;
1875 type
|= CRYPTO_ALG_TYPE_COMPRESS
;
1876 mask
|= CRYPTO_ALG_TYPE_MASK
;
1878 return __crypto_comp_cast(crypto_alloc_base(alg_name
, type
, mask
));
1881 static inline struct crypto_tfm
*crypto_comp_tfm(struct crypto_comp
*tfm
)
1886 static inline void crypto_free_comp(struct crypto_comp
*tfm
)
1888 crypto_free_tfm(crypto_comp_tfm(tfm
));
1891 static inline int crypto_has_comp(const char *alg_name
, u32 type
, u32 mask
)
1893 type
&= ~CRYPTO_ALG_TYPE_MASK
;
1894 type
|= CRYPTO_ALG_TYPE_COMPRESS
;
1895 mask
|= CRYPTO_ALG_TYPE_MASK
;
1897 return crypto_has_alg(alg_name
, type
, mask
);
1900 static inline const char *crypto_comp_name(struct crypto_comp
*tfm
)
1902 return crypto_tfm_alg_name(crypto_comp_tfm(tfm
));
1905 static inline struct compress_tfm
*crypto_comp_crt(struct crypto_comp
*tfm
)
1907 return &crypto_comp_tfm(tfm
)->crt_compress
;
1910 static inline int crypto_comp_compress(struct crypto_comp
*tfm
,
1911 const u8
*src
, unsigned int slen
,
1912 u8
*dst
, unsigned int *dlen
)
1914 return crypto_comp_crt(tfm
)->cot_compress(crypto_comp_tfm(tfm
),
1915 src
, slen
, dst
, dlen
);
1918 static inline int crypto_comp_decompress(struct crypto_comp
*tfm
,
1919 const u8
*src
, unsigned int slen
,
1920 u8
*dst
, unsigned int *dlen
)
1922 return crypto_comp_crt(tfm
)->cot_decompress(crypto_comp_tfm(tfm
),
1923 src
, slen
, dst
, dlen
);
1926 #endif /* _LINUX_CRYPTO_H */