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>
29 LIST_HEAD(crypto_alg_list
);
30 EXPORT_SYMBOL_GPL(crypto_alg_list
);
31 DECLARE_RWSEM(crypto_alg_sem
);
32 EXPORT_SYMBOL_GPL(crypto_alg_sem
);
34 BLOCKING_NOTIFIER_HEAD(crypto_chain
);
35 EXPORT_SYMBOL_GPL(crypto_chain
);
37 static struct crypto_alg
*crypto_larval_wait(struct crypto_alg
*alg
);
39 struct crypto_alg
*crypto_mod_get(struct crypto_alg
*alg
)
41 return try_module_get(alg
->cra_module
) ? crypto_alg_get(alg
) : NULL
;
43 EXPORT_SYMBOL_GPL(crypto_mod_get
);
45 void crypto_mod_put(struct crypto_alg
*alg
)
47 struct module
*module
= alg
->cra_module
;
52 EXPORT_SYMBOL_GPL(crypto_mod_put
);
54 static inline int crypto_is_test_larval(struct crypto_larval
*larval
)
56 return larval
->alg
.cra_driver_name
[0];
59 static struct crypto_alg
*__crypto_alg_lookup(const char *name
, u32 type
,
62 struct crypto_alg
*q
, *alg
= NULL
;
65 list_for_each_entry(q
, &crypto_alg_list
, cra_list
) {
68 if (crypto_is_moribund(q
))
71 if ((q
->cra_flags
^ type
) & mask
)
74 if (crypto_is_larval(q
) &&
75 !crypto_is_test_larval((struct crypto_larval
*)q
) &&
76 ((struct crypto_larval
*)q
)->mask
!= mask
)
79 exact
= !strcmp(q
->cra_driver_name
, name
);
80 fuzzy
= !strcmp(q
->cra_name
, name
);
81 if (!exact
&& !(fuzzy
&& q
->cra_priority
> best
))
84 if (unlikely(!crypto_mod_get(q
)))
87 best
= q
->cra_priority
;
99 static void crypto_larval_destroy(struct crypto_alg
*alg
)
101 struct crypto_larval
*larval
= (void *)alg
;
103 BUG_ON(!crypto_is_larval(alg
));
105 crypto_mod_put(larval
->adult
);
109 struct crypto_larval
*crypto_larval_alloc(const char *name
, u32 type
, u32 mask
)
111 struct crypto_larval
*larval
;
113 larval
= kzalloc(sizeof(*larval
), GFP_KERNEL
);
115 return ERR_PTR(-ENOMEM
);
118 larval
->alg
.cra_flags
= CRYPTO_ALG_LARVAL
| type
;
119 larval
->alg
.cra_priority
= -1;
120 larval
->alg
.cra_destroy
= crypto_larval_destroy
;
122 strlcpy(larval
->alg
.cra_name
, name
, CRYPTO_MAX_ALG_NAME
);
123 init_completion(&larval
->completion
);
127 EXPORT_SYMBOL_GPL(crypto_larval_alloc
);
129 static struct crypto_alg
*crypto_larval_add(const char *name
, u32 type
,
132 struct crypto_alg
*alg
;
133 struct crypto_larval
*larval
;
135 larval
= crypto_larval_alloc(name
, type
, mask
);
137 return ERR_CAST(larval
);
139 atomic_set(&larval
->alg
.cra_refcnt
, 2);
141 down_write(&crypto_alg_sem
);
142 alg
= __crypto_alg_lookup(name
, type
, mask
);
145 list_add(&alg
->cra_list
, &crypto_alg_list
);
147 up_write(&crypto_alg_sem
);
149 if (alg
!= &larval
->alg
) {
151 if (crypto_is_larval(alg
))
152 alg
= crypto_larval_wait(alg
);
158 void crypto_larval_kill(struct crypto_alg
*alg
)
160 struct crypto_larval
*larval
= (void *)alg
;
162 down_write(&crypto_alg_sem
);
163 list_del(&alg
->cra_list
);
164 up_write(&crypto_alg_sem
);
165 complete_all(&larval
->completion
);
168 EXPORT_SYMBOL_GPL(crypto_larval_kill
);
170 static struct crypto_alg
*crypto_larval_wait(struct crypto_alg
*alg
)
172 struct crypto_larval
*larval
= (void *)alg
;
175 timeout
= wait_for_completion_killable_timeout(
176 &larval
->completion
, 60 * HZ
);
180 alg
= ERR_PTR(-EINTR
);
182 alg
= ERR_PTR(-ETIMEDOUT
);
184 alg
= ERR_PTR(-ENOENT
);
185 else if (crypto_is_test_larval(larval
) &&
186 !(alg
->cra_flags
& CRYPTO_ALG_TESTED
))
187 alg
= ERR_PTR(-EAGAIN
);
188 else if (!crypto_mod_get(alg
))
189 alg
= ERR_PTR(-EAGAIN
);
190 crypto_mod_put(&larval
->alg
);
195 struct crypto_alg
*crypto_alg_lookup(const char *name
, u32 type
, u32 mask
)
197 struct crypto_alg
*alg
;
199 down_read(&crypto_alg_sem
);
200 alg
= __crypto_alg_lookup(name
, type
, mask
);
201 up_read(&crypto_alg_sem
);
205 EXPORT_SYMBOL_GPL(crypto_alg_lookup
);
207 struct crypto_alg
*crypto_larval_lookup(const char *name
, u32 type
, u32 mask
)
209 struct crypto_alg
*alg
;
212 return ERR_PTR(-ENOENT
);
214 type
&= ~(CRYPTO_ALG_LARVAL
| CRYPTO_ALG_DEAD
);
215 mask
&= ~(CRYPTO_ALG_LARVAL
| CRYPTO_ALG_DEAD
);
217 alg
= crypto_alg_lookup(name
, type
, mask
);
219 request_module("crypto-%s", name
);
221 if (!((type
^ CRYPTO_ALG_NEED_FALLBACK
) & mask
&
222 CRYPTO_ALG_NEED_FALLBACK
))
223 request_module("crypto-%s-all", name
);
225 alg
= crypto_alg_lookup(name
, type
, mask
);
229 return crypto_is_larval(alg
) ? crypto_larval_wait(alg
) : alg
;
231 return crypto_larval_add(name
, type
, mask
);
233 EXPORT_SYMBOL_GPL(crypto_larval_lookup
);
235 int crypto_probing_notify(unsigned long val
, void *v
)
239 ok
= blocking_notifier_call_chain(&crypto_chain
, val
, v
);
240 if (ok
== NOTIFY_DONE
) {
241 request_module("cryptomgr");
242 ok
= blocking_notifier_call_chain(&crypto_chain
, val
, v
);
247 EXPORT_SYMBOL_GPL(crypto_probing_notify
);
249 struct crypto_alg
*crypto_alg_mod_lookup(const char *name
, u32 type
, u32 mask
)
251 struct crypto_alg
*alg
;
252 struct crypto_alg
*larval
;
255 if (!((type
| mask
) & CRYPTO_ALG_TESTED
)) {
256 type
|= CRYPTO_ALG_TESTED
;
257 mask
|= CRYPTO_ALG_TESTED
;
261 * If the internal flag is set for a cipher, require a caller to
262 * to invoke the cipher with the internal flag to use that cipher.
263 * Also, if a caller wants to allocate a cipher that may or may
264 * not be an internal cipher, use type | CRYPTO_ALG_INTERNAL and
265 * !(mask & CRYPTO_ALG_INTERNAL).
267 if (!((type
| mask
) & CRYPTO_ALG_INTERNAL
))
268 mask
|= CRYPTO_ALG_INTERNAL
;
270 larval
= crypto_larval_lookup(name
, type
, mask
);
271 if (IS_ERR(larval
) || !crypto_is_larval(larval
))
274 ok
= crypto_probing_notify(CRYPTO_MSG_ALG_REQUEST
, larval
);
276 if (ok
== NOTIFY_STOP
)
277 alg
= crypto_larval_wait(larval
);
279 crypto_mod_put(larval
);
280 alg
= ERR_PTR(-ENOENT
);
282 crypto_larval_kill(larval
);
285 EXPORT_SYMBOL_GPL(crypto_alg_mod_lookup
);
287 static int crypto_init_ops(struct crypto_tfm
*tfm
, u32 type
, u32 mask
)
289 const struct crypto_type
*type_obj
= tfm
->__crt_alg
->cra_type
;
292 return type_obj
->init(tfm
, type
, mask
);
294 switch (crypto_tfm_alg_type(tfm
)) {
295 case CRYPTO_ALG_TYPE_CIPHER
:
296 return crypto_init_cipher_ops(tfm
);
298 case CRYPTO_ALG_TYPE_COMPRESS
:
299 return crypto_init_compress_ops(tfm
);
309 static void crypto_exit_ops(struct crypto_tfm
*tfm
)
311 const struct crypto_type
*type
= tfm
->__crt_alg
->cra_type
;
313 if (type
&& tfm
->exit
)
317 static unsigned int crypto_ctxsize(struct crypto_alg
*alg
, u32 type
, u32 mask
)
319 const struct crypto_type
*type_obj
= alg
->cra_type
;
322 len
= alg
->cra_alignmask
& ~(crypto_tfm_ctx_alignment() - 1);
324 return len
+ type_obj
->ctxsize(alg
, type
, mask
);
326 switch (alg
->cra_flags
& CRYPTO_ALG_TYPE_MASK
) {
330 case CRYPTO_ALG_TYPE_CIPHER
:
331 len
+= crypto_cipher_ctxsize(alg
);
334 case CRYPTO_ALG_TYPE_COMPRESS
:
335 len
+= crypto_compress_ctxsize(alg
);
342 void crypto_shoot_alg(struct crypto_alg
*alg
)
344 down_write(&crypto_alg_sem
);
345 alg
->cra_flags
|= CRYPTO_ALG_DYING
;
346 up_write(&crypto_alg_sem
);
348 EXPORT_SYMBOL_GPL(crypto_shoot_alg
);
350 struct crypto_tfm
*__crypto_alloc_tfm(struct crypto_alg
*alg
, u32 type
,
353 struct crypto_tfm
*tfm
= NULL
;
354 unsigned int tfm_size
;
357 tfm_size
= sizeof(*tfm
) + crypto_ctxsize(alg
, type
, mask
);
358 tfm
= kzalloc(tfm_size
, GFP_KERNEL
);
362 tfm
->__crt_alg
= alg
;
364 err
= crypto_init_ops(tfm
, type
, mask
);
368 if (!tfm
->exit
&& alg
->cra_init
&& (err
= alg
->cra_init(tfm
)))
369 goto cra_init_failed
;
374 crypto_exit_ops(tfm
);
377 crypto_shoot_alg(alg
);
384 EXPORT_SYMBOL_GPL(__crypto_alloc_tfm
);
387 * crypto_alloc_base - Locate algorithm and allocate transform
388 * @alg_name: Name of algorithm
389 * @type: Type of algorithm
390 * @mask: Mask for type comparison
392 * This function should not be used by new algorithm types.
393 * Please use crypto_alloc_tfm instead.
395 * crypto_alloc_base() will first attempt to locate an already loaded
396 * algorithm. If that fails and the kernel supports dynamically loadable
397 * modules, it will then attempt to load a module of the same name or
398 * alias. If that fails it will send a query to any loaded crypto manager
399 * to construct an algorithm on the fly. A refcount is grabbed on the
400 * algorithm which is then associated with the new transform.
402 * The returned transform is of a non-determinate type. Most people
403 * should use one of the more specific allocation functions such as
404 * crypto_alloc_blkcipher.
406 * In case of error the return value is an error pointer.
408 struct crypto_tfm
*crypto_alloc_base(const char *alg_name
, u32 type
, u32 mask
)
410 struct crypto_tfm
*tfm
;
414 struct crypto_alg
*alg
;
416 alg
= crypto_alg_mod_lookup(alg_name
, type
, mask
);
422 tfm
= __crypto_alloc_tfm(alg
, type
, mask
);
432 if (fatal_signal_pending(current
)) {
440 EXPORT_SYMBOL_GPL(crypto_alloc_base
);
442 void *crypto_create_tfm(struct crypto_alg
*alg
,
443 const struct crypto_type
*frontend
)
446 struct crypto_tfm
*tfm
= NULL
;
447 unsigned int tfmsize
;
451 tfmsize
= frontend
->tfmsize
;
452 total
= tfmsize
+ sizeof(*tfm
) + frontend
->extsize(alg
);
454 mem
= kzalloc(total
, GFP_KERNEL
);
458 tfm
= (struct crypto_tfm
*)(mem
+ tfmsize
);
459 tfm
->__crt_alg
= alg
;
461 err
= frontend
->init_tfm(tfm
);
465 if (!tfm
->exit
&& alg
->cra_init
&& (err
= alg
->cra_init(tfm
)))
466 goto cra_init_failed
;
471 crypto_exit_ops(tfm
);
474 crypto_shoot_alg(alg
);
481 EXPORT_SYMBOL_GPL(crypto_create_tfm
);
483 struct crypto_alg
*crypto_find_alg(const char *alg_name
,
484 const struct crypto_type
*frontend
,
487 struct crypto_alg
*(*lookup
)(const char *name
, u32 type
, u32 mask
) =
488 crypto_alg_mod_lookup
;
491 type
&= frontend
->maskclear
;
492 mask
&= frontend
->maskclear
;
493 type
|= frontend
->type
;
494 mask
|= frontend
->maskset
;
496 if (frontend
->lookup
)
497 lookup
= frontend
->lookup
;
500 return lookup(alg_name
, type
, mask
);
502 EXPORT_SYMBOL_GPL(crypto_find_alg
);
505 * crypto_alloc_tfm - Locate algorithm and allocate transform
506 * @alg_name: Name of algorithm
507 * @frontend: Frontend algorithm type
508 * @type: Type of algorithm
509 * @mask: Mask for type comparison
511 * crypto_alloc_tfm() will first attempt to locate an already loaded
512 * algorithm. If that fails and the kernel supports dynamically loadable
513 * modules, it will then attempt to load a module of the same name or
514 * alias. If that fails it will send a query to any loaded crypto manager
515 * to construct an algorithm on the fly. A refcount is grabbed on the
516 * algorithm which is then associated with the new transform.
518 * The returned transform is of a non-determinate type. Most people
519 * should use one of the more specific allocation functions such as
520 * crypto_alloc_blkcipher.
522 * In case of error the return value is an error pointer.
524 void *crypto_alloc_tfm(const char *alg_name
,
525 const struct crypto_type
*frontend
, u32 type
, u32 mask
)
531 struct crypto_alg
*alg
;
533 alg
= crypto_find_alg(alg_name
, frontend
, type
, mask
);
539 tfm
= crypto_create_tfm(alg
, frontend
);
549 if (fatal_signal_pending(current
)) {
557 EXPORT_SYMBOL_GPL(crypto_alloc_tfm
);
560 * crypto_destroy_tfm - Free crypto transform
561 * @mem: Start of tfm slab
562 * @tfm: Transform to free
564 * This function frees up the transform and any associated resources,
565 * then drops the refcount on the associated algorithm.
567 void crypto_destroy_tfm(void *mem
, struct crypto_tfm
*tfm
)
569 struct crypto_alg
*alg
;
574 alg
= tfm
->__crt_alg
;
576 if (!tfm
->exit
&& alg
->cra_exit
)
578 crypto_exit_ops(tfm
);
582 EXPORT_SYMBOL_GPL(crypto_destroy_tfm
);
584 int crypto_has_alg(const char *name
, u32 type
, u32 mask
)
587 struct crypto_alg
*alg
= crypto_alg_mod_lookup(name
, type
, mask
);
596 EXPORT_SYMBOL_GPL(crypto_has_alg
);
598 MODULE_DESCRIPTION("Cryptographic core API");
599 MODULE_LICENSE("GPL");