2 * Scatterlist Cryptographic API.
4 * Copyright (c) 2002 James Morris <jmorris@intercode.com.au>
5 * Copyright (c) 2002 David S. Miller (davem@redhat.com)
7 * Portions derived from Cryptoapi, by Alexander Kjeldaas <astor@fast.no>
8 * and Nettle, by Niels Mé°ˆler.
10 * This program is free software; you can redistribute it and/or modify it
11 * under the terms of the GNU General Public License as published by the Free
12 * Software Foundation; either version 2 of the License, or (at your option)
16 #ifndef _LINUX_CRYPTO_H
17 #define _LINUX_CRYPTO_H
19 #include <linux/module.h>
20 #include <linux/kernel.h>
21 #include <linux/types.h>
22 #include <linux/list.h>
23 #include <linux/string.h>
25 #include <asm/errno.h>
27 #define crypto_register_alg crypto_register_alg_rsl
28 #define crypto_unregister_alg crypto_unregister_alg_rsl
29 #define crypto_alloc_tfm crypto_alloc_tfm_rsl
30 #define crypto_free_tfm crypto_free_tfm_rsl
31 #define crypto_alg_available crypto_alg_available_rsl
34 * Algorithm masks and types.
36 #define CRYPTO_ALG_TYPE_MASK 0x000000ff
37 #define CRYPTO_ALG_TYPE_CIPHER 0x00000001
38 #define CRYPTO_ALG_TYPE_DIGEST 0x00000002
39 #define CRYPTO_ALG_TYPE_COMPRESS 0x00000004
42 * Transform masks and values (for crt_flags).
44 #define CRYPTO_TFM_MODE_MASK 0x000000ff
45 #define CRYPTO_TFM_REQ_MASK 0x000fff00
46 #define CRYPTO_TFM_RES_MASK 0xfff00000
48 #define CRYPTO_TFM_MODE_ECB 0x00000001
49 #define CRYPTO_TFM_MODE_CBC 0x00000002
50 #define CRYPTO_TFM_MODE_CFB 0x00000004
51 #define CRYPTO_TFM_MODE_CTR 0x00000008
53 #define CRYPTO_TFM_REQ_WEAK_KEY 0x00000100
54 #define CRYPTO_TFM_RES_WEAK_KEY 0x00100000
55 #define CRYPTO_TFM_RES_BAD_KEY_LEN 0x00200000
56 #define CRYPTO_TFM_RES_BAD_KEY_SCHED 0x00400000
57 #define CRYPTO_TFM_RES_BAD_BLOCK_LEN 0x00800000
58 #define CRYPTO_TFM_RES_BAD_FLAGS 0x01000000
61 * Miscellaneous stuff.
63 #define CRYPTO_UNSPEC 0
64 #define CRYPTO_MAX_ALG_NAME 64
69 * Algorithms: modular crypto algorithm implementations, managed
70 * via crypto_register_alg() and crypto_unregister_alg().
73 unsigned int cia_min_keysize
;
74 unsigned int cia_max_keysize
;
75 int (*cia_setkey
)(void *ctx
, const u8
*key
,
76 unsigned int keylen
, u32
*flags
);
77 void (*cia_encrypt
)(void *ctx
, u8
*dst
, const u8
*src
);
78 void (*cia_decrypt
)(void *ctx
, u8
*dst
, const u8
*src
);
82 unsigned int dia_digestsize
;
83 void (*dia_init
)(void *ctx
);
84 void (*dia_update
)(void *ctx
, const u8
*data
, unsigned int len
);
85 void (*dia_final
)(void *ctx
, u8
*out
);
86 int (*dia_setkey
)(void *ctx
, const u8
*key
,
87 unsigned int keylen
, u32
*flags
);
91 int (*coa_init
)(void *ctx
);
92 void (*coa_exit
)(void *ctx
);
93 int (*coa_compress
)(void *ctx
, const u8
*src
, unsigned int slen
,
94 u8
*dst
, unsigned int *dlen
);
95 int (*coa_decompress
)(void *ctx
, const u8
*src
, unsigned int slen
,
96 u8
*dst
, unsigned int *dlen
);
99 #define cra_cipher cra_u.cipher
100 #define cra_digest cra_u.digest
101 #define cra_compress cra_u.compress
104 struct list_head cra_list
;
106 unsigned int cra_blocksize
;
107 unsigned int cra_ctxsize
;
108 const char cra_name
[CRYPTO_MAX_ALG_NAME
];
111 struct cipher_alg cipher
;
112 struct digest_alg digest
;
113 struct compress_alg compress
;
116 struct module
*cra_module
;
120 * Algorithm registration interface.
122 int crypto_register_alg(struct crypto_alg
*alg
);
123 int crypto_unregister_alg(struct crypto_alg
*alg
);
126 * Algorithm query interface.
128 int crypto_alg_available(const char *name
, u32 flags
);
131 * Transforms: user-instantiated objects which encapsulate algorithms
132 * and core processing logic. Managed via crypto_alloc_tfm() and
133 * crypto_free_tfm(), as well as the various helpers below.
139 unsigned int cit_ivsize
;
141 int (*cit_setkey
)(struct crypto_tfm
*tfm
,
142 const u8
*key
, unsigned int keylen
);
143 int (*cit_encrypt
)(struct crypto_tfm
*tfm
,
144 struct scatterlist
*dst
,
145 struct scatterlist
*src
,
146 unsigned int nbytes
);
147 int (*cit_encrypt_iv
)(struct crypto_tfm
*tfm
,
148 struct scatterlist
*dst
,
149 struct scatterlist
*src
,
150 unsigned int nbytes
, u8
*iv
);
151 int (*cit_decrypt
)(struct crypto_tfm
*tfm
,
152 struct scatterlist
*dst
,
153 struct scatterlist
*src
,
154 unsigned int nbytes
);
155 int (*cit_decrypt_iv
)(struct crypto_tfm
*tfm
,
156 struct scatterlist
*dst
,
157 struct scatterlist
*src
,
158 unsigned int nbytes
, u8
*iv
);
159 void (*cit_xor_block
)(u8
*dst
, const u8
*src
);
163 void (*dit_init
)(struct crypto_tfm
*tfm
);
164 void (*dit_update
)(struct crypto_tfm
*tfm
,
165 struct scatterlist
*sg
, unsigned int nsg
);
166 void (*dit_final
)(struct crypto_tfm
*tfm
, u8
*out
);
167 void (*dit_digest
)(struct crypto_tfm
*tfm
, struct scatterlist
*sg
,
168 unsigned int nsg
, u8
*out
);
169 int (*dit_setkey
)(struct crypto_tfm
*tfm
,
170 const u8
*key
, unsigned int keylen
);
171 #ifdef CONFIG_CRYPTO_HMAC
172 void *dit_hmac_block
;
176 struct compress_tfm
{
177 int (*cot_compress
)(struct crypto_tfm
*tfm
,
178 const u8
*src
, unsigned int slen
,
179 u8
*dst
, unsigned int *dlen
);
180 int (*cot_decompress
)(struct crypto_tfm
*tfm
,
181 const u8
*src
, unsigned int slen
,
182 u8
*dst
, unsigned int *dlen
);
185 #define crt_cipher crt_u.cipher
186 #define crt_digest crt_u.digest
187 #define crt_compress crt_u.compress
194 struct cipher_tfm cipher
;
195 struct digest_tfm digest
;
196 struct compress_tfm compress
;
199 struct crypto_alg
*__crt_alg
;
203 * Transform user interface.
207 * crypto_alloc_tfm() will first attempt to locate an already loaded algorithm.
208 * If that fails and the kernel supports dynamically loadable modules, it
209 * will then attempt to load a module of the same name or alias. A refcount
210 * is grabbed on the algorithm which is then associated with the new transform.
212 * crypto_free_tfm() frees up the transform and any associated resources,
213 * then drops the refcount on the associated algorithm.
215 struct crypto_tfm
*crypto_alloc_tfm(const char *alg_name
, u32 tfm_flags
);
216 void crypto_free_tfm(struct crypto_tfm
*tfm
);
219 * Transform helpers which query the underlying algorithm.
221 static inline const char *crypto_tfm_alg_name(struct crypto_tfm
*tfm
)
223 return tfm
->__crt_alg
->cra_name
;
226 static inline const char *crypto_tfm_alg_modname(struct crypto_tfm
*tfm
)
228 struct crypto_alg
*alg
= tfm
->__crt_alg
;
231 return alg
->cra_module
->name
;
236 static inline u32
crypto_tfm_alg_type(struct crypto_tfm
*tfm
)
238 return tfm
->__crt_alg
->cra_flags
& CRYPTO_ALG_TYPE_MASK
;
241 static inline unsigned int crypto_tfm_alg_min_keysize(struct crypto_tfm
*tfm
)
243 BUG_ON(crypto_tfm_alg_type(tfm
) != CRYPTO_ALG_TYPE_CIPHER
);
244 return tfm
->__crt_alg
->cra_cipher
.cia_min_keysize
;
247 static inline unsigned int crypto_tfm_alg_max_keysize(struct crypto_tfm
*tfm
)
249 BUG_ON(crypto_tfm_alg_type(tfm
) != CRYPTO_ALG_TYPE_CIPHER
);
250 return tfm
->__crt_alg
->cra_cipher
.cia_max_keysize
;
253 static inline unsigned int crypto_tfm_alg_ivsize(struct crypto_tfm
*tfm
)
255 BUG_ON(crypto_tfm_alg_type(tfm
) != CRYPTO_ALG_TYPE_CIPHER
);
256 return tfm
->crt_cipher
.cit_ivsize
;
259 static inline unsigned int crypto_tfm_alg_blocksize(struct crypto_tfm
*tfm
)
261 return tfm
->__crt_alg
->cra_blocksize
;
264 static inline unsigned int crypto_tfm_alg_digestsize(struct crypto_tfm
*tfm
)
266 BUG_ON(crypto_tfm_alg_type(tfm
) != CRYPTO_ALG_TYPE_DIGEST
);
267 return tfm
->__crt_alg
->cra_digest
.dia_digestsize
;
273 static inline void crypto_digest_init(struct crypto_tfm
*tfm
)
275 BUG_ON(crypto_tfm_alg_type(tfm
) != CRYPTO_ALG_TYPE_DIGEST
);
276 tfm
->crt_digest
.dit_init(tfm
);
279 static inline void crypto_digest_update(struct crypto_tfm
*tfm
,
280 struct scatterlist
*sg
,
283 BUG_ON(crypto_tfm_alg_type(tfm
) != CRYPTO_ALG_TYPE_DIGEST
);
284 tfm
->crt_digest
.dit_update(tfm
, sg
, nsg
);
287 static inline void crypto_digest_final(struct crypto_tfm
*tfm
, u8
*out
)
289 BUG_ON(crypto_tfm_alg_type(tfm
) != CRYPTO_ALG_TYPE_DIGEST
);
290 tfm
->crt_digest
.dit_final(tfm
, out
);
293 static inline void crypto_digest_digest(struct crypto_tfm
*tfm
,
294 struct scatterlist
*sg
,
295 unsigned int nsg
, u8
*out
)
297 BUG_ON(crypto_tfm_alg_type(tfm
) != CRYPTO_ALG_TYPE_DIGEST
);
298 tfm
->crt_digest
.dit_digest(tfm
, sg
, nsg
, out
);
301 static inline int crypto_digest_setkey(struct crypto_tfm
*tfm
,
302 const u8
*key
, unsigned int keylen
)
304 BUG_ON(crypto_tfm_alg_type(tfm
) != CRYPTO_ALG_TYPE_DIGEST
);
305 if (tfm
->crt_digest
.dit_setkey
== NULL
)
307 return tfm
->crt_digest
.dit_setkey(tfm
, key
, keylen
);
310 static inline int crypto_cipher_setkey(struct crypto_tfm
*tfm
,
311 const u8
*key
, unsigned int keylen
)
313 BUG_ON(crypto_tfm_alg_type(tfm
) != CRYPTO_ALG_TYPE_CIPHER
);
314 return tfm
->crt_cipher
.cit_setkey(tfm
, key
, keylen
);
317 static inline int crypto_cipher_encrypt(struct crypto_tfm
*tfm
,
318 struct scatterlist
*dst
,
319 struct scatterlist
*src
,
322 BUG_ON(crypto_tfm_alg_type(tfm
) != CRYPTO_ALG_TYPE_CIPHER
);
323 return tfm
->crt_cipher
.cit_encrypt(tfm
, dst
, src
, nbytes
);
326 static inline int crypto_cipher_encrypt_iv(struct crypto_tfm
*tfm
,
327 struct scatterlist
*dst
,
328 struct scatterlist
*src
,
329 unsigned int nbytes
, u8
*iv
)
331 BUG_ON(crypto_tfm_alg_type(tfm
) != CRYPTO_ALG_TYPE_CIPHER
);
332 BUG_ON(tfm
->crt_cipher
.cit_mode
== CRYPTO_TFM_MODE_ECB
);
333 return tfm
->crt_cipher
.cit_encrypt_iv(tfm
, dst
, src
, nbytes
, iv
);
336 static inline int crypto_cipher_decrypt(struct crypto_tfm
*tfm
,
337 struct scatterlist
*dst
,
338 struct scatterlist
*src
,
341 BUG_ON(crypto_tfm_alg_type(tfm
) != CRYPTO_ALG_TYPE_CIPHER
);
342 return tfm
->crt_cipher
.cit_decrypt(tfm
, dst
, src
, nbytes
);
345 static inline int crypto_cipher_decrypt_iv(struct crypto_tfm
*tfm
,
346 struct scatterlist
*dst
,
347 struct scatterlist
*src
,
348 unsigned int nbytes
, u8
*iv
)
350 BUG_ON(crypto_tfm_alg_type(tfm
) != CRYPTO_ALG_TYPE_CIPHER
);
351 BUG_ON(tfm
->crt_cipher
.cit_mode
== CRYPTO_TFM_MODE_ECB
);
352 return tfm
->crt_cipher
.cit_decrypt_iv(tfm
, dst
, src
, nbytes
, iv
);
355 static inline void crypto_cipher_set_iv(struct crypto_tfm
*tfm
,
356 const u8
*src
, unsigned int len
)
358 BUG_ON(crypto_tfm_alg_type(tfm
) != CRYPTO_ALG_TYPE_CIPHER
);
359 memcpy(tfm
->crt_cipher
.cit_iv
, src
, len
);
362 static inline void crypto_cipher_get_iv(struct crypto_tfm
*tfm
,
363 u8
*dst
, unsigned int len
)
365 BUG_ON(crypto_tfm_alg_type(tfm
) != CRYPTO_ALG_TYPE_CIPHER
);
366 memcpy(dst
, tfm
->crt_cipher
.cit_iv
, len
);
369 static inline int crypto_comp_compress(struct crypto_tfm
*tfm
,
370 const u8
*src
, unsigned int slen
,
371 u8
*dst
, unsigned int *dlen
)
373 BUG_ON(crypto_tfm_alg_type(tfm
) != CRYPTO_ALG_TYPE_COMPRESS
);
374 return tfm
->crt_compress
.cot_compress(tfm
, src
, slen
, dst
, dlen
);
377 static inline int crypto_comp_decompress(struct crypto_tfm
*tfm
,
378 const u8
*src
, unsigned int slen
,
379 u8
*dst
, unsigned int *dlen
)
381 BUG_ON(crypto_tfm_alg_type(tfm
) != CRYPTO_ALG_TYPE_COMPRESS
);
382 return tfm
->crt_compress
.cot_decompress(tfm
, src
, slen
, dst
, dlen
);
388 #ifdef CONFIG_CRYPTO_HMAC
389 void crypto_hmac_init(struct crypto_tfm
*tfm
, u8
*key
, unsigned int *keylen
);
390 void crypto_hmac_update(struct crypto_tfm
*tfm
,
391 struct scatterlist
*sg
, unsigned int nsg
);
392 void crypto_hmac_final(struct crypto_tfm
*tfm
, u8
*key
,
393 unsigned int *keylen
, u8
*out
);
394 void crypto_hmac(struct crypto_tfm
*tfm
, u8
*key
, unsigned int *keylen
,
395 struct scatterlist
*sg
, unsigned int nsg
, u8
*out
);
396 #endif /* CONFIG_CRYPTO_HMAC */
398 #endif /* _LINUX_CRYPTO_H */