include/linux/crypto.h

1 /* SPDX-License-Identifier: GPL-2.0-or-later */
27  * This uses __MODULE_INFO directly instead of MODULE_ALIAS because pre-4.3
34 		__MODULE_INFO(alias, alias_crypto, "crypto-" name)
69  * Set if the algorithm has passed automated run-time testing.  Note that
70  * if there is no run-time testing for a given algorithm it is considered
93  * Set if the algorithm has a ->setkey() method but can be used without
115  *	- The IV buffer and all scatterlist elements must be aligned to the
117  *	- If the data were to be divided into chunks of size
121  *	- The IV buffer and all scatterlist elements must be aligned to the
123  *	- The first scatterlist element must contain all the associated data,
125  *	- If the plaintext/ciphertext were to be divided into chunks of size
129  *	- The result buffer must be aligned to the algorithm's alignmask.
130  *	- crypto_ahash_finup() must not be used unless the algorithm implements
131  *	  ->finup() natively.
155  * as arm where pointers are 32-bit aligned but there are data types such as
156  * u64 which require 64-bit alignment.
193  * struct cipher_alg - single-block symmetric ciphers definition
196  *		     algorithm. This must be set to one of the pre-defined
202  *		    algorithm. This must be set to one of the pre-defined values
222  *		 API will re-align the buffers. The re-alignment means that a
230  *		 transformation context, the key might need to be re-programmed
237  * All fields are mandatory and must be filled.
249  * struct compress_alg - compression/decompression algorithm
268  * struct crypto_istat_aead - statistics for AEAD algorithm
284  * struct crypto_istat_akcipher - statistics for akcipher algorithm
304  * struct crypto_istat_cipher - statistics for cipher algorithm
320  * struct crypto_istat_compress - statistics for compress algorithm
336  * struct crypto_istat_hash - statistics for has algorithm
348  * struct crypto_istat_kpp - statistics for KPP algorithm
380  * struct crypto_alg - definition of a cryptograpic cipher algorithm
383  *	       used for fine-tuning the description of the transformation
400  *		   the Crypto API will do the re-alignment in software, but
402  *		   The re-alignment happens at these occasions for different
403  *		   @cra_u types: cipher -- For both input data and output data
404  *		   buffer; ahash -- For output hash destination buf; shash --
430  *	   filled with callbacks. This field might be empty. This is the case
443  * @cra_u.cipher: Union member which contains a single-block symmetric cipher
591 	case -EINPROGRESS:  in crypto_wait_req()
592 	case -EBUSY:  in crypto_wait_req()
593 		wait_for_completion(&wait->completion);  in crypto_wait_req()
594 		reinit_completion(&wait->completion);  in crypto_wait_req()
595 		err = wait->err;  in crypto_wait_req()
604 	init_completion(&wait->completion);  in crypto_init_wait()
621  * Transforms: user-instantiated objects which encapsulate algorithms
655 #define CRYPTOA_MAX (__CRYPTOA_MAX - 1)
692 	return tfm->__crt_alg->cra_name;  in crypto_tfm_alg_name()
697 	return tfm->__crt_alg->cra_driver_name;  in crypto_tfm_alg_driver_name()
702 	return tfm->__crt_alg->cra_priority;  in crypto_tfm_alg_priority()
707 	return tfm->__crt_alg->cra_flags & CRYPTO_ALG_TYPE_MASK;  in crypto_tfm_alg_type()
712 	return tfm->__crt_alg->cra_blocksize;  in crypto_tfm_alg_blocksize()
717 	return tfm->__crt_alg->cra_alignmask;  in crypto_tfm_alg_alignmask()
722 	return tfm->crt_flags;  in crypto_tfm_get_flags()
727 	tfm->crt_flags |= flags;  in crypto_tfm_set_flags()
732 	tfm->crt_flags &= ~flags;  in crypto_tfm_clear_flags()
737 	return tfm->__crt_ctx;  in crypto_tfm_ctx()
743 	return __alignof__(tfm->__crt_ctx);  in crypto_tfm_ctx_alignment()
759  * block-wise and process either the input or the output data of these cipher
769  * crypto_alloc_cipher() - allocate single block cipher handle
794 	return &tfm->base;  in crypto_cipher_tfm()
798  * crypto_free_cipher() - zeroize and free the single block cipher handle
807  * crypto_has_cipher() - Search for the availability of a single block cipher
826  * crypto_cipher_blocksize() - obtain block size for cipher
863  * crypto_cipher_setkey() - set key for cipher
872  * different cipher modes depending on the key size, such as AES-128 vs AES-192
873  * vs. AES-256. When providing a 16 byte key for an AES cipher handle, AES-128
882  * crypto_cipher_encrypt_one() - encrypt one block of plaintext
884  * @dst: points to the buffer that will be filled with the ciphertext
894  * crypto_cipher_decrypt_one() - decrypt one block of ciphertext
896  * @dst: points to the buffer that will be filled with the plaintext
922 	return &tfm->base;  in crypto_comp_tfm()