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)
18 #include <linux/err.h>
19 #include <linux/errno.h>
20 #include <linux/kernel.h>
21 #include <linux/kmod.h>
22 #include <linux/module.h>
23 #include <linux/param.h>
24 #include <linux/sched/signal.h>
25 #include <linux/slab.h>
26 #include <linux/string.h>
27 #include <linux/completion.h>
30 LIST_HEAD(crypto_alg_list
);
31 EXPORT_SYMBOL_GPL(crypto_alg_list
);
32 DECLARE_RWSEM(crypto_alg_sem
);
33 EXPORT_SYMBOL_GPL(crypto_alg_sem
);
35 BLOCKING_NOTIFIER_HEAD(crypto_chain
);
36 EXPORT_SYMBOL_GPL(crypto_chain
);
38 static struct crypto_alg
*crypto_larval_wait(struct crypto_alg
*alg
);
40 struct crypto_alg
*crypto_mod_get(struct crypto_alg
*alg
)
42 return try_module_get(alg
->cra_module
) ? crypto_alg_get(alg
) : NULL
;
44 EXPORT_SYMBOL_GPL(crypto_mod_get
);
46 void crypto_mod_put(struct crypto_alg
*alg
)
48 struct module
*module
= alg
->cra_module
;
53 EXPORT_SYMBOL_GPL(crypto_mod_put
);
55 static inline int crypto_is_test_larval(struct crypto_larval
*larval
)
57 return larval
->alg
.cra_driver_name
[0];
60 static struct crypto_alg
*__crypto_alg_lookup(const char *name
, u32 type
,
63 struct crypto_alg
*q
, *alg
= NULL
;
66 list_for_each_entry(q
, &crypto_alg_list
, cra_list
) {
69 if (crypto_is_moribund(q
))
72 if ((q
->cra_flags
^ type
) & mask
)
75 if (crypto_is_larval(q
) &&
76 !crypto_is_test_larval((struct crypto_larval
*)q
) &&
77 ((struct crypto_larval
*)q
)->mask
!= mask
)
80 exact
= !strcmp(q
->cra_driver_name
, name
);
81 fuzzy
= !strcmp(q
->cra_name
, name
);
82 if (!exact
&& !(fuzzy
&& q
->cra_priority
> best
))
85 if (unlikely(!crypto_mod_get(q
)))
88 best
= q
->cra_priority
;
100 static void crypto_larval_destroy(struct crypto_alg
*alg
)
102 struct crypto_larval
*larval
= (void *)alg
;
104 BUG_ON(!crypto_is_larval(alg
));
106 crypto_mod_put(larval
->adult
);
110 struct crypto_larval
*crypto_larval_alloc(const char *name
, u32 type
, u32 mask
)
112 struct crypto_larval
*larval
;
114 larval
= kzalloc(sizeof(*larval
), GFP_KERNEL
);
116 return ERR_PTR(-ENOMEM
);
119 larval
->alg
.cra_flags
= CRYPTO_ALG_LARVAL
| type
;
120 larval
->alg
.cra_priority
= -1;
121 larval
->alg
.cra_destroy
= crypto_larval_destroy
;
123 strlcpy(larval
->alg
.cra_name
, name
, CRYPTO_MAX_ALG_NAME
);
124 init_completion(&larval
->completion
);
128 EXPORT_SYMBOL_GPL(crypto_larval_alloc
);
130 static struct crypto_alg
*crypto_larval_add(const char *name
, u32 type
,
133 struct crypto_alg
*alg
;
134 struct crypto_larval
*larval
;
136 larval
= crypto_larval_alloc(name
, type
, mask
);
138 return ERR_CAST(larval
);
140 atomic_set(&larval
->alg
.cra_refcnt
, 2);
142 down_write(&crypto_alg_sem
);
143 alg
= __crypto_alg_lookup(name
, type
, mask
);
146 list_add(&alg
->cra_list
, &crypto_alg_list
);
148 up_write(&crypto_alg_sem
);
150 if (alg
!= &larval
->alg
) {
152 if (crypto_is_larval(alg
))
153 alg
= crypto_larval_wait(alg
);
159 void crypto_larval_kill(struct crypto_alg
*alg
)
161 struct crypto_larval
*larval
= (void *)alg
;
163 down_write(&crypto_alg_sem
);
164 list_del(&alg
->cra_list
);
165 up_write(&crypto_alg_sem
);
166 complete_all(&larval
->completion
);
169 EXPORT_SYMBOL_GPL(crypto_larval_kill
);
171 static struct crypto_alg
*crypto_larval_wait(struct crypto_alg
*alg
)
173 struct crypto_larval
*larval
= (void *)alg
;
176 timeout
= wait_for_completion_killable_timeout(
177 &larval
->completion
, 60 * HZ
);
181 alg
= ERR_PTR(-EINTR
);
183 alg
= ERR_PTR(-ETIMEDOUT
);
185 alg
= ERR_PTR(-ENOENT
);
186 else if (crypto_is_test_larval(larval
) &&
187 !(alg
->cra_flags
& CRYPTO_ALG_TESTED
))
188 alg
= ERR_PTR(-EAGAIN
);
189 else if (!crypto_mod_get(alg
))
190 alg
= ERR_PTR(-EAGAIN
);
191 crypto_mod_put(&larval
->alg
);
196 struct crypto_alg
*crypto_alg_lookup(const char *name
, u32 type
, u32 mask
)
198 struct crypto_alg
*alg
;
200 down_read(&crypto_alg_sem
);
201 alg
= __crypto_alg_lookup(name
, type
, mask
);
202 up_read(&crypto_alg_sem
);
206 EXPORT_SYMBOL_GPL(crypto_alg_lookup
);
208 struct crypto_alg
*crypto_larval_lookup(const char *name
, u32 type
, u32 mask
)
210 struct crypto_alg
*alg
;
213 return ERR_PTR(-ENOENT
);
215 type
&= ~(CRYPTO_ALG_LARVAL
| CRYPTO_ALG_DEAD
);
216 mask
&= ~(CRYPTO_ALG_LARVAL
| CRYPTO_ALG_DEAD
);
218 alg
= crypto_alg_lookup(name
, type
, mask
);
220 request_module("crypto-%s", name
);
222 if (!((type
^ CRYPTO_ALG_NEED_FALLBACK
) & mask
&
223 CRYPTO_ALG_NEED_FALLBACK
))
224 request_module("crypto-%s-all", name
);
226 alg
= crypto_alg_lookup(name
, type
, mask
);
230 return crypto_is_larval(alg
) ? crypto_larval_wait(alg
) : alg
;
232 return crypto_larval_add(name
, type
, mask
);
234 EXPORT_SYMBOL_GPL(crypto_larval_lookup
);
236 int crypto_probing_notify(unsigned long val
, void *v
)
240 ok
= blocking_notifier_call_chain(&crypto_chain
, val
, v
);
241 if (ok
== NOTIFY_DONE
) {
242 request_module("cryptomgr");
243 ok
= blocking_notifier_call_chain(&crypto_chain
, val
, v
);
248 EXPORT_SYMBOL_GPL(crypto_probing_notify
);
250 struct crypto_alg
*crypto_alg_mod_lookup(const char *name
, u32 type
, u32 mask
)
252 struct crypto_alg
*alg
;
253 struct crypto_alg
*larval
;
256 if (!((type
| mask
) & CRYPTO_ALG_TESTED
)) {
257 type
|= CRYPTO_ALG_TESTED
;
258 mask
|= CRYPTO_ALG_TESTED
;
262 * If the internal flag is set for a cipher, require a caller to
263 * to invoke the cipher with the internal flag to use that cipher.
264 * Also, if a caller wants to allocate a cipher that may or may
265 * not be an internal cipher, use type | CRYPTO_ALG_INTERNAL and
266 * !(mask & CRYPTO_ALG_INTERNAL).
268 if (!((type
| mask
) & CRYPTO_ALG_INTERNAL
))
269 mask
|= CRYPTO_ALG_INTERNAL
;
271 larval
= crypto_larval_lookup(name
, type
, mask
);
272 if (IS_ERR(larval
) || !crypto_is_larval(larval
))
275 ok
= crypto_probing_notify(CRYPTO_MSG_ALG_REQUEST
, larval
);
277 if (ok
== NOTIFY_STOP
)
278 alg
= crypto_larval_wait(larval
);
280 crypto_mod_put(larval
);
281 alg
= ERR_PTR(-ENOENT
);
283 crypto_larval_kill(larval
);
286 EXPORT_SYMBOL_GPL(crypto_alg_mod_lookup
);
288 static int crypto_init_ops(struct crypto_tfm
*tfm
, u32 type
, u32 mask
)
290 const struct crypto_type
*type_obj
= tfm
->__crt_alg
->cra_type
;
293 return type_obj
->init(tfm
, type
, mask
);
295 switch (crypto_tfm_alg_type(tfm
)) {
296 case CRYPTO_ALG_TYPE_CIPHER
:
297 return crypto_init_cipher_ops(tfm
);
299 case CRYPTO_ALG_TYPE_COMPRESS
:
300 return crypto_init_compress_ops(tfm
);
310 static void crypto_exit_ops(struct crypto_tfm
*tfm
)
312 const struct crypto_type
*type
= tfm
->__crt_alg
->cra_type
;
314 if (type
&& tfm
->exit
)
318 static unsigned int crypto_ctxsize(struct crypto_alg
*alg
, u32 type
, u32 mask
)
320 const struct crypto_type
*type_obj
= alg
->cra_type
;
323 len
= alg
->cra_alignmask
& ~(crypto_tfm_ctx_alignment() - 1);
325 return len
+ type_obj
->ctxsize(alg
, type
, mask
);
327 switch (alg
->cra_flags
& CRYPTO_ALG_TYPE_MASK
) {
331 case CRYPTO_ALG_TYPE_CIPHER
:
332 len
+= crypto_cipher_ctxsize(alg
);
335 case CRYPTO_ALG_TYPE_COMPRESS
:
336 len
+= crypto_compress_ctxsize(alg
);
343 void crypto_shoot_alg(struct crypto_alg
*alg
)
345 down_write(&crypto_alg_sem
);
346 alg
->cra_flags
|= CRYPTO_ALG_DYING
;
347 up_write(&crypto_alg_sem
);
349 EXPORT_SYMBOL_GPL(crypto_shoot_alg
);
351 struct crypto_tfm
*__crypto_alloc_tfm(struct crypto_alg
*alg
, u32 type
,
354 struct crypto_tfm
*tfm
= NULL
;
355 unsigned int tfm_size
;
358 tfm_size
= sizeof(*tfm
) + crypto_ctxsize(alg
, type
, mask
);
359 tfm
= kzalloc(tfm_size
, GFP_KERNEL
);
363 tfm
->__crt_alg
= alg
;
365 err
= crypto_init_ops(tfm
, type
, mask
);
369 if (!tfm
->exit
&& alg
->cra_init
&& (err
= alg
->cra_init(tfm
)))
370 goto cra_init_failed
;
375 crypto_exit_ops(tfm
);
378 crypto_shoot_alg(alg
);
385 EXPORT_SYMBOL_GPL(__crypto_alloc_tfm
);
388 * crypto_alloc_base - Locate algorithm and allocate transform
389 * @alg_name: Name of algorithm
390 * @type: Type of algorithm
391 * @mask: Mask for type comparison
393 * This function should not be used by new algorithm types.
394 * Please use crypto_alloc_tfm instead.
396 * crypto_alloc_base() will first attempt to locate an already loaded
397 * algorithm. If that fails and the kernel supports dynamically loadable
398 * modules, it will then attempt to load a module of the same name or
399 * alias. If that fails it will send a query to any loaded crypto manager
400 * to construct an algorithm on the fly. A refcount is grabbed on the
401 * algorithm which is then associated with the new transform.
403 * The returned transform is of a non-determinate type. Most people
404 * should use one of the more specific allocation functions such as
405 * crypto_alloc_blkcipher.
407 * In case of error the return value is an error pointer.
409 struct crypto_tfm
*crypto_alloc_base(const char *alg_name
, u32 type
, u32 mask
)
411 struct crypto_tfm
*tfm
;
415 struct crypto_alg
*alg
;
417 alg
= crypto_alg_mod_lookup(alg_name
, type
, mask
);
423 tfm
= __crypto_alloc_tfm(alg
, type
, mask
);
433 if (fatal_signal_pending(current
)) {
441 EXPORT_SYMBOL_GPL(crypto_alloc_base
);
443 void *crypto_create_tfm(struct crypto_alg
*alg
,
444 const struct crypto_type
*frontend
)
447 struct crypto_tfm
*tfm
= NULL
;
448 unsigned int tfmsize
;
452 tfmsize
= frontend
->tfmsize
;
453 total
= tfmsize
+ sizeof(*tfm
) + frontend
->extsize(alg
);
455 mem
= kzalloc(total
, GFP_KERNEL
);
459 tfm
= (struct crypto_tfm
*)(mem
+ tfmsize
);
460 tfm
->__crt_alg
= alg
;
462 err
= frontend
->init_tfm(tfm
);
466 if (!tfm
->exit
&& alg
->cra_init
&& (err
= alg
->cra_init(tfm
)))
467 goto cra_init_failed
;
472 crypto_exit_ops(tfm
);
475 crypto_shoot_alg(alg
);
482 EXPORT_SYMBOL_GPL(crypto_create_tfm
);
484 struct crypto_alg
*crypto_find_alg(const char *alg_name
,
485 const struct crypto_type
*frontend
,
488 struct crypto_alg
*(*lookup
)(const char *name
, u32 type
, u32 mask
) =
489 crypto_alg_mod_lookup
;
492 type
&= frontend
->maskclear
;
493 mask
&= frontend
->maskclear
;
494 type
|= frontend
->type
;
495 mask
|= frontend
->maskset
;
497 if (frontend
->lookup
)
498 lookup
= frontend
->lookup
;
501 return lookup(alg_name
, type
, mask
);
503 EXPORT_SYMBOL_GPL(crypto_find_alg
);
506 * crypto_alloc_tfm - Locate algorithm and allocate transform
507 * @alg_name: Name of algorithm
508 * @frontend: Frontend algorithm type
509 * @type: Type of algorithm
510 * @mask: Mask for type comparison
512 * crypto_alloc_tfm() will first attempt to locate an already loaded
513 * algorithm. If that fails and the kernel supports dynamically loadable
514 * modules, it will then attempt to load a module of the same name or
515 * alias. If that fails it will send a query to any loaded crypto manager
516 * to construct an algorithm on the fly. A refcount is grabbed on the
517 * algorithm which is then associated with the new transform.
519 * The returned transform is of a non-determinate type. Most people
520 * should use one of the more specific allocation functions such as
521 * crypto_alloc_blkcipher.
523 * In case of error the return value is an error pointer.
525 void *crypto_alloc_tfm(const char *alg_name
,
526 const struct crypto_type
*frontend
, u32 type
, u32 mask
)
532 struct crypto_alg
*alg
;
534 alg
= crypto_find_alg(alg_name
, frontend
, type
, mask
);
540 tfm
= crypto_create_tfm(alg
, frontend
);
550 if (fatal_signal_pending(current
)) {
558 EXPORT_SYMBOL_GPL(crypto_alloc_tfm
);
561 * crypto_destroy_tfm - Free crypto transform
562 * @mem: Start of tfm slab
563 * @tfm: Transform to free
565 * This function frees up the transform and any associated resources,
566 * then drops the refcount on the associated algorithm.
568 void crypto_destroy_tfm(void *mem
, struct crypto_tfm
*tfm
)
570 struct crypto_alg
*alg
;
575 alg
= tfm
->__crt_alg
;
577 if (!tfm
->exit
&& alg
->cra_exit
)
579 crypto_exit_ops(tfm
);
583 EXPORT_SYMBOL_GPL(crypto_destroy_tfm
);
585 int crypto_has_alg(const char *name
, u32 type
, u32 mask
)
588 struct crypto_alg
*alg
= crypto_alg_mod_lookup(name
, type
, mask
);
597 EXPORT_SYMBOL_GPL(crypto_has_alg
);
599 void crypto_req_done(struct crypto_async_request
*req
, int err
)
601 struct crypto_wait
*wait
= req
->data
;
603 if (err
== -EINPROGRESS
)
607 complete(&wait
->completion
);
609 EXPORT_SYMBOL_GPL(crypto_req_done
);
611 MODULE_DESCRIPTION("Cryptographic core API");
612 MODULE_LICENSE("GPL");