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 <asm/atomic.h>
21 #include <linux/module.h>
22 #include <linux/kernel.h>
23 #include <linux/types.h>
24 #include <linux/list.h>
25 #include <linux/slab.h>
26 #include <linux/string.h>
27 #include <linux/uaccess.h>
30 * Algorithm masks and types.
32 #define CRYPTO_ALG_TYPE_MASK 0x0000000f
33 #define CRYPTO_ALG_TYPE_CIPHER 0x00000001
34 #define CRYPTO_ALG_TYPE_DIGEST 0x00000002
35 #define CRYPTO_ALG_TYPE_COMPRESS 0x00000004
37 #define CRYPTO_ALG_LARVAL 0x00000010
38 #define CRYPTO_ALG_DEAD 0x00000020
39 #define CRYPTO_ALG_DYING 0x00000040
40 #define CRYPTO_ALG_ASYNC 0x00000080
43 * Transform masks and values (for crt_flags).
45 #define CRYPTO_TFM_MODE_MASK 0x000000ff
46 #define CRYPTO_TFM_REQ_MASK 0x000fff00
47 #define CRYPTO_TFM_RES_MASK 0xfff00000
49 #define CRYPTO_TFM_MODE_ECB 0x00000001
50 #define CRYPTO_TFM_MODE_CBC 0x00000002
51 #define CRYPTO_TFM_MODE_CFB 0x00000004
52 #define CRYPTO_TFM_MODE_CTR 0x00000008
54 #define CRYPTO_TFM_REQ_WEAK_KEY 0x00000100
55 #define CRYPTO_TFM_REQ_MAY_SLEEP 0x00000200
56 #define CRYPTO_TFM_RES_WEAK_KEY 0x00100000
57 #define CRYPTO_TFM_RES_BAD_KEY_LEN 0x00200000
58 #define CRYPTO_TFM_RES_BAD_KEY_SCHED 0x00400000
59 #define CRYPTO_TFM_RES_BAD_BLOCK_LEN 0x00800000
60 #define CRYPTO_TFM_RES_BAD_FLAGS 0x01000000
63 * Miscellaneous stuff.
65 #define CRYPTO_UNSPEC 0
66 #define CRYPTO_MAX_ALG_NAME 64
68 #define CRYPTO_DIR_ENCRYPT 1
69 #define CRYPTO_DIR_DECRYPT 0
72 * The macro CRYPTO_MINALIGN_ATTR (along with the void * type in the actual
73 * declaration) is used to ensure that the crypto_tfm context structure is
74 * aligned correctly for the given architecture so that there are no alignment
75 * faults for C data types. In particular, this is required on platforms such
76 * as arm where pointers are 32-bit aligned but there are data types such as
77 * u64 which require 64-bit alignment.
79 #if defined(ARCH_KMALLOC_MINALIGN)
80 #define CRYPTO_MINALIGN ARCH_KMALLOC_MINALIGN
81 #elif defined(ARCH_SLAB_MINALIGN)
82 #define CRYPTO_MINALIGN ARCH_SLAB_MINALIGN
85 #ifdef CRYPTO_MINALIGN
86 #define CRYPTO_MINALIGN_ATTR __attribute__ ((__aligned__(CRYPTO_MINALIGN)))
88 #define CRYPTO_MINALIGN_ATTR
95 struct crypto_tfm
*tfm
;
96 void (*crfn
)(struct crypto_tfm
*tfm
, u8
*dst
, const u8
*src
);
97 unsigned int (*prfn
)(const struct cipher_desc
*desc
, u8
*dst
,
98 const u8
*src
, unsigned int nbytes
);
103 * Algorithms: modular crypto algorithm implementations, managed
104 * via crypto_register_alg() and crypto_unregister_alg().
107 unsigned int cia_min_keysize
;
108 unsigned int cia_max_keysize
;
109 int (*cia_setkey
)(struct crypto_tfm
*tfm
, const u8
*key
,
110 unsigned int keylen
);
111 void (*cia_encrypt
)(struct crypto_tfm
*tfm
, u8
*dst
, const u8
*src
);
112 void (*cia_decrypt
)(struct crypto_tfm
*tfm
, u8
*dst
, const u8
*src
);
114 unsigned int (*cia_encrypt_ecb
)(const struct cipher_desc
*desc
,
115 u8
*dst
, const u8
*src
,
116 unsigned int nbytes
);
117 unsigned int (*cia_decrypt_ecb
)(const struct cipher_desc
*desc
,
118 u8
*dst
, const u8
*src
,
119 unsigned int nbytes
);
120 unsigned int (*cia_encrypt_cbc
)(const struct cipher_desc
*desc
,
121 u8
*dst
, const u8
*src
,
122 unsigned int nbytes
);
123 unsigned int (*cia_decrypt_cbc
)(const struct cipher_desc
*desc
,
124 u8
*dst
, const u8
*src
,
125 unsigned int nbytes
);
129 unsigned int dia_digestsize
;
130 void (*dia_init
)(struct crypto_tfm
*tfm
);
131 void (*dia_update
)(struct crypto_tfm
*tfm
, const u8
*data
,
133 void (*dia_final
)(struct crypto_tfm
*tfm
, u8
*out
);
134 int (*dia_setkey
)(struct crypto_tfm
*tfm
, const u8
*key
,
135 unsigned int keylen
);
138 struct compress_alg
{
139 int (*coa_compress
)(struct crypto_tfm
*tfm
, const u8
*src
,
140 unsigned int slen
, u8
*dst
, unsigned int *dlen
);
141 int (*coa_decompress
)(struct crypto_tfm
*tfm
, const u8
*src
,
142 unsigned int slen
, u8
*dst
, unsigned int *dlen
);
145 #define cra_cipher cra_u.cipher
146 #define cra_digest cra_u.digest
147 #define cra_compress cra_u.compress
150 struct list_head cra_list
;
151 struct list_head cra_users
;
154 unsigned int cra_blocksize
;
155 unsigned int cra_ctxsize
;
156 unsigned int cra_alignmask
;
161 char cra_name
[CRYPTO_MAX_ALG_NAME
];
162 char cra_driver_name
[CRYPTO_MAX_ALG_NAME
];
165 struct cipher_alg cipher
;
166 struct digest_alg digest
;
167 struct compress_alg compress
;
170 int (*cra_init
)(struct crypto_tfm
*tfm
);
171 void (*cra_exit
)(struct crypto_tfm
*tfm
);
172 void (*cra_destroy
)(struct crypto_alg
*alg
);
174 struct module
*cra_module
;
178 * Algorithm registration interface.
180 int crypto_register_alg(struct crypto_alg
*alg
);
181 int crypto_unregister_alg(struct crypto_alg
*alg
);
184 * Algorithm query interface.
187 int crypto_alg_available(const char *name
, u32 flags
);
189 static inline int crypto_alg_available(const char *name
, u32 flags
)
196 * Transforms: user-instantiated objects which encapsulate algorithms
197 * and core processing logic. Managed via crypto_alloc_*() and
198 * crypto_free_*(), as well as the various helpers below.
203 unsigned int cit_ivsize
;
205 int (*cit_setkey
)(struct crypto_tfm
*tfm
,
206 const u8
*key
, unsigned int keylen
);
207 int (*cit_encrypt
)(struct crypto_tfm
*tfm
,
208 struct scatterlist
*dst
,
209 struct scatterlist
*src
,
210 unsigned int nbytes
);
211 int (*cit_encrypt_iv
)(struct crypto_tfm
*tfm
,
212 struct scatterlist
*dst
,
213 struct scatterlist
*src
,
214 unsigned int nbytes
, u8
*iv
);
215 int (*cit_decrypt
)(struct crypto_tfm
*tfm
,
216 struct scatterlist
*dst
,
217 struct scatterlist
*src
,
218 unsigned int nbytes
);
219 int (*cit_decrypt_iv
)(struct crypto_tfm
*tfm
,
220 struct scatterlist
*dst
,
221 struct scatterlist
*src
,
222 unsigned int nbytes
, u8
*iv
);
223 void (*cit_xor_block
)(u8
*dst
, const u8
*src
);
227 void (*dit_init
)(struct crypto_tfm
*tfm
);
228 void (*dit_update
)(struct crypto_tfm
*tfm
,
229 struct scatterlist
*sg
, unsigned int nsg
);
230 void (*dit_final
)(struct crypto_tfm
*tfm
, u8
*out
);
231 void (*dit_digest
)(struct crypto_tfm
*tfm
, struct scatterlist
*sg
,
232 unsigned int nsg
, u8
*out
);
233 int (*dit_setkey
)(struct crypto_tfm
*tfm
,
234 const u8
*key
, unsigned int keylen
);
235 #ifdef CONFIG_CRYPTO_HMAC
236 void *dit_hmac_block
;
240 struct compress_tfm
{
241 int (*cot_compress
)(struct crypto_tfm
*tfm
,
242 const u8
*src
, unsigned int slen
,
243 u8
*dst
, unsigned int *dlen
);
244 int (*cot_decompress
)(struct crypto_tfm
*tfm
,
245 const u8
*src
, unsigned int slen
,
246 u8
*dst
, unsigned int *dlen
);
249 #define crt_cipher crt_u.cipher
250 #define crt_digest crt_u.digest
251 #define crt_compress crt_u.compress
258 struct cipher_tfm cipher
;
259 struct digest_tfm digest
;
260 struct compress_tfm compress
;
263 struct crypto_alg
*__crt_alg
;
265 void *__crt_ctx
[] CRYPTO_MINALIGN_ATTR
;
273 struct crypto_attr_alg
{
274 char name
[CRYPTO_MAX_ALG_NAME
];
278 * Transform user interface.
281 struct crypto_tfm
*crypto_alloc_tfm(const char *alg_name
, u32 tfm_flags
);
282 struct crypto_tfm
*crypto_alloc_base(const char *alg_name
, u32 type
, u32 mask
);
283 void crypto_free_tfm(struct crypto_tfm
*tfm
);
286 * Transform helpers which query the underlying algorithm.
288 static inline const char *crypto_tfm_alg_name(struct crypto_tfm
*tfm
)
290 return tfm
->__crt_alg
->cra_name
;
293 static inline const char *crypto_tfm_alg_driver_name(struct crypto_tfm
*tfm
)
295 return tfm
->__crt_alg
->cra_driver_name
;
298 static inline int crypto_tfm_alg_priority(struct crypto_tfm
*tfm
)
300 return tfm
->__crt_alg
->cra_priority
;
303 static inline const char *crypto_tfm_alg_modname(struct crypto_tfm
*tfm
)
305 return module_name(tfm
->__crt_alg
->cra_module
);
308 static inline u32
crypto_tfm_alg_type(struct crypto_tfm
*tfm
)
310 return tfm
->__crt_alg
->cra_flags
& CRYPTO_ALG_TYPE_MASK
;
313 static inline unsigned int crypto_tfm_alg_min_keysize(struct crypto_tfm
*tfm
)
315 BUG_ON(crypto_tfm_alg_type(tfm
) != CRYPTO_ALG_TYPE_CIPHER
);
316 return tfm
->__crt_alg
->cra_cipher
.cia_min_keysize
;
319 static inline unsigned int crypto_tfm_alg_max_keysize(struct crypto_tfm
*tfm
)
321 BUG_ON(crypto_tfm_alg_type(tfm
) != CRYPTO_ALG_TYPE_CIPHER
);
322 return tfm
->__crt_alg
->cra_cipher
.cia_max_keysize
;
325 static inline unsigned int crypto_tfm_alg_ivsize(struct crypto_tfm
*tfm
)
327 BUG_ON(crypto_tfm_alg_type(tfm
) != CRYPTO_ALG_TYPE_CIPHER
);
328 return tfm
->crt_cipher
.cit_ivsize
;
331 static inline unsigned int crypto_tfm_alg_blocksize(struct crypto_tfm
*tfm
)
333 return tfm
->__crt_alg
->cra_blocksize
;
336 static inline unsigned int crypto_tfm_alg_digestsize(struct crypto_tfm
*tfm
)
338 BUG_ON(crypto_tfm_alg_type(tfm
) != CRYPTO_ALG_TYPE_DIGEST
);
339 return tfm
->__crt_alg
->cra_digest
.dia_digestsize
;
342 static inline unsigned int crypto_tfm_alg_alignmask(struct crypto_tfm
*tfm
)
344 return tfm
->__crt_alg
->cra_alignmask
;
347 static inline void *crypto_tfm_ctx(struct crypto_tfm
*tfm
)
349 return tfm
->__crt_ctx
;
352 static inline unsigned int crypto_tfm_ctx_alignment(void)
354 struct crypto_tfm
*tfm
;
355 return __alignof__(tfm
->__crt_ctx
);
361 static inline void crypto_digest_init(struct crypto_tfm
*tfm
)
363 BUG_ON(crypto_tfm_alg_type(tfm
) != CRYPTO_ALG_TYPE_DIGEST
);
364 tfm
->crt_digest
.dit_init(tfm
);
367 static inline void crypto_digest_update(struct crypto_tfm
*tfm
,
368 struct scatterlist
*sg
,
371 BUG_ON(crypto_tfm_alg_type(tfm
) != CRYPTO_ALG_TYPE_DIGEST
);
372 tfm
->crt_digest
.dit_update(tfm
, sg
, nsg
);
375 static inline void crypto_digest_final(struct crypto_tfm
*tfm
, u8
*out
)
377 BUG_ON(crypto_tfm_alg_type(tfm
) != CRYPTO_ALG_TYPE_DIGEST
);
378 tfm
->crt_digest
.dit_final(tfm
, out
);
381 static inline void crypto_digest_digest(struct crypto_tfm
*tfm
,
382 struct scatterlist
*sg
,
383 unsigned int nsg
, u8
*out
)
385 BUG_ON(crypto_tfm_alg_type(tfm
) != CRYPTO_ALG_TYPE_DIGEST
);
386 tfm
->crt_digest
.dit_digest(tfm
, sg
, nsg
, out
);
389 static inline int crypto_digest_setkey(struct crypto_tfm
*tfm
,
390 const u8
*key
, unsigned int keylen
)
392 BUG_ON(crypto_tfm_alg_type(tfm
) != CRYPTO_ALG_TYPE_DIGEST
);
393 return tfm
->crt_digest
.dit_setkey(tfm
, key
, keylen
);
396 static inline int crypto_cipher_setkey(struct crypto_tfm
*tfm
,
397 const u8
*key
, unsigned int keylen
)
399 BUG_ON(crypto_tfm_alg_type(tfm
) != CRYPTO_ALG_TYPE_CIPHER
);
400 return tfm
->crt_cipher
.cit_setkey(tfm
, key
, keylen
);
403 static inline int crypto_cipher_encrypt(struct crypto_tfm
*tfm
,
404 struct scatterlist
*dst
,
405 struct scatterlist
*src
,
408 BUG_ON(crypto_tfm_alg_type(tfm
) != CRYPTO_ALG_TYPE_CIPHER
);
409 return tfm
->crt_cipher
.cit_encrypt(tfm
, dst
, src
, nbytes
);
412 static inline int crypto_cipher_encrypt_iv(struct crypto_tfm
*tfm
,
413 struct scatterlist
*dst
,
414 struct scatterlist
*src
,
415 unsigned int nbytes
, u8
*iv
)
417 BUG_ON(crypto_tfm_alg_type(tfm
) != CRYPTO_ALG_TYPE_CIPHER
);
418 return tfm
->crt_cipher
.cit_encrypt_iv(tfm
, dst
, src
, nbytes
, iv
);
421 static inline int crypto_cipher_decrypt(struct crypto_tfm
*tfm
,
422 struct scatterlist
*dst
,
423 struct scatterlist
*src
,
426 BUG_ON(crypto_tfm_alg_type(tfm
) != CRYPTO_ALG_TYPE_CIPHER
);
427 return tfm
->crt_cipher
.cit_decrypt(tfm
, dst
, src
, nbytes
);
430 static inline int crypto_cipher_decrypt_iv(struct crypto_tfm
*tfm
,
431 struct scatterlist
*dst
,
432 struct scatterlist
*src
,
433 unsigned int nbytes
, u8
*iv
)
435 BUG_ON(crypto_tfm_alg_type(tfm
) != CRYPTO_ALG_TYPE_CIPHER
);
436 return tfm
->crt_cipher
.cit_decrypt_iv(tfm
, dst
, src
, nbytes
, iv
);
439 static inline void crypto_cipher_set_iv(struct crypto_tfm
*tfm
,
440 const u8
*src
, unsigned int len
)
442 BUG_ON(crypto_tfm_alg_type(tfm
) != CRYPTO_ALG_TYPE_CIPHER
);
443 memcpy(tfm
->crt_cipher
.cit_iv
, src
, len
);
446 static inline void crypto_cipher_get_iv(struct crypto_tfm
*tfm
,
447 u8
*dst
, unsigned int len
)
449 BUG_ON(crypto_tfm_alg_type(tfm
) != CRYPTO_ALG_TYPE_CIPHER
);
450 memcpy(dst
, tfm
->crt_cipher
.cit_iv
, len
);
453 static inline int crypto_comp_compress(struct crypto_tfm
*tfm
,
454 const u8
*src
, unsigned int slen
,
455 u8
*dst
, unsigned int *dlen
)
457 BUG_ON(crypto_tfm_alg_type(tfm
) != CRYPTO_ALG_TYPE_COMPRESS
);
458 return tfm
->crt_compress
.cot_compress(tfm
, src
, slen
, dst
, dlen
);
461 static inline int crypto_comp_decompress(struct crypto_tfm
*tfm
,
462 const u8
*src
, unsigned int slen
,
463 u8
*dst
, unsigned int *dlen
)
465 BUG_ON(crypto_tfm_alg_type(tfm
) != CRYPTO_ALG_TYPE_COMPRESS
);
466 return tfm
->crt_compress
.cot_decompress(tfm
, src
, slen
, dst
, dlen
);
472 #ifdef CONFIG_CRYPTO_HMAC
473 void crypto_hmac_init(struct crypto_tfm
*tfm
, u8
*key
, unsigned int *keylen
);
474 void crypto_hmac_update(struct crypto_tfm
*tfm
,
475 struct scatterlist
*sg
, unsigned int nsg
);
476 void crypto_hmac_final(struct crypto_tfm
*tfm
, u8
*key
,
477 unsigned int *keylen
, u8
*out
);
478 void crypto_hmac(struct crypto_tfm
*tfm
, u8
*key
, unsigned int *keylen
,
479 struct scatterlist
*sg
, unsigned int nsg
, u8
*out
);
480 #endif /* CONFIG_CRYPTO_HMAC */
482 #endif /* _LINUX_CRYPTO_H */