afs: Make it possible to get the data version in readpage
[linux/fpc-iii.git] / crypto / api.c
blob1d5290c67108316f6495f33674094b5a476e2e14
1 /*
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)
14 * any later version.
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>
28 #include "internal.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;
50 crypto_alg_put(alg);
51 module_put(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,
61 u32 mask)
63 struct crypto_alg *q, *alg = NULL;
64 int best = -2;
66 list_for_each_entry(q, &crypto_alg_list, cra_list) {
67 int exact, fuzzy;
69 if (crypto_is_moribund(q))
70 continue;
72 if ((q->cra_flags ^ type) & mask)
73 continue;
75 if (crypto_is_larval(q) &&
76 !crypto_is_test_larval((struct crypto_larval *)q) &&
77 ((struct crypto_larval *)q)->mask != mask)
78 continue;
80 exact = !strcmp(q->cra_driver_name, name);
81 fuzzy = !strcmp(q->cra_name, name);
82 if (!exact && !(fuzzy && q->cra_priority > best))
83 continue;
85 if (unlikely(!crypto_mod_get(q)))
86 continue;
88 best = q->cra_priority;
89 if (alg)
90 crypto_mod_put(alg);
91 alg = q;
93 if (exact)
94 break;
97 return alg;
100 static void crypto_larval_destroy(struct crypto_alg *alg)
102 struct crypto_larval *larval = (void *)alg;
104 BUG_ON(!crypto_is_larval(alg));
105 if (larval->adult)
106 crypto_mod_put(larval->adult);
107 kfree(larval);
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);
115 if (!larval)
116 return ERR_PTR(-ENOMEM);
118 larval->mask = mask;
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);
126 return larval;
128 EXPORT_SYMBOL_GPL(crypto_larval_alloc);
130 static struct crypto_alg *crypto_larval_add(const char *name, u32 type,
131 u32 mask)
133 struct crypto_alg *alg;
134 struct crypto_larval *larval;
136 larval = crypto_larval_alloc(name, type, mask);
137 if (IS_ERR(larval))
138 return ERR_CAST(larval);
140 refcount_set(&larval->alg.cra_refcnt, 2);
142 down_write(&crypto_alg_sem);
143 alg = __crypto_alg_lookup(name, type, mask);
144 if (!alg) {
145 alg = &larval->alg;
146 list_add(&alg->cra_list, &crypto_alg_list);
148 up_write(&crypto_alg_sem);
150 if (alg != &larval->alg) {
151 kfree(larval);
152 if (crypto_is_larval(alg))
153 alg = crypto_larval_wait(alg);
156 return 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);
167 crypto_alg_put(alg);
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;
174 long timeout;
176 timeout = wait_for_completion_killable_timeout(
177 &larval->completion, 60 * HZ);
179 alg = larval->adult;
180 if (timeout < 0)
181 alg = ERR_PTR(-EINTR);
182 else if (!timeout)
183 alg = ERR_PTR(-ETIMEDOUT);
184 else if (!alg)
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);
193 return alg;
196 static struct crypto_alg *crypto_alg_lookup(const char *name, u32 type,
197 u32 mask)
199 struct crypto_alg *alg;
200 u32 test = 0;
202 if (!((type | mask) & CRYPTO_ALG_TESTED))
203 test |= CRYPTO_ALG_TESTED;
205 down_read(&crypto_alg_sem);
206 alg = __crypto_alg_lookup(name, type | test, mask | test);
207 if (!alg && test)
208 alg = __crypto_alg_lookup(name, type, mask) ?
209 ERR_PTR(-ELIBBAD) : NULL;
210 up_read(&crypto_alg_sem);
212 return alg;
215 static struct crypto_alg *crypto_larval_lookup(const char *name, u32 type,
216 u32 mask)
218 struct crypto_alg *alg;
220 if (!name)
221 return ERR_PTR(-ENOENT);
223 type &= ~(CRYPTO_ALG_LARVAL | CRYPTO_ALG_DEAD);
224 mask &= ~(CRYPTO_ALG_LARVAL | CRYPTO_ALG_DEAD);
226 alg = crypto_alg_lookup(name, type, mask);
227 if (!alg) {
228 request_module("crypto-%s", name);
230 if (!((type ^ CRYPTO_ALG_NEED_FALLBACK) & mask &
231 CRYPTO_ALG_NEED_FALLBACK))
232 request_module("crypto-%s-all", name);
234 alg = crypto_alg_lookup(name, type, mask);
237 if (!IS_ERR_OR_NULL(alg) && crypto_is_larval(alg))
238 alg = crypto_larval_wait(alg);
239 else if (!alg)
240 alg = crypto_larval_add(name, type, mask);
242 return alg;
245 int crypto_probing_notify(unsigned long val, void *v)
247 int ok;
249 ok = blocking_notifier_call_chain(&crypto_chain, val, v);
250 if (ok == NOTIFY_DONE) {
251 request_module("cryptomgr");
252 ok = blocking_notifier_call_chain(&crypto_chain, val, v);
255 return ok;
257 EXPORT_SYMBOL_GPL(crypto_probing_notify);
259 struct crypto_alg *crypto_alg_mod_lookup(const char *name, u32 type, u32 mask)
261 struct crypto_alg *alg;
262 struct crypto_alg *larval;
263 int ok;
266 * If the internal flag is set for a cipher, require a caller to
267 * to invoke the cipher with the internal flag to use that cipher.
268 * Also, if a caller wants to allocate a cipher that may or may
269 * not be an internal cipher, use type | CRYPTO_ALG_INTERNAL and
270 * !(mask & CRYPTO_ALG_INTERNAL).
272 if (!((type | mask) & CRYPTO_ALG_INTERNAL))
273 mask |= CRYPTO_ALG_INTERNAL;
275 larval = crypto_larval_lookup(name, type, mask);
276 if (IS_ERR(larval) || !crypto_is_larval(larval))
277 return larval;
279 ok = crypto_probing_notify(CRYPTO_MSG_ALG_REQUEST, larval);
281 if (ok == NOTIFY_STOP)
282 alg = crypto_larval_wait(larval);
283 else {
284 crypto_mod_put(larval);
285 alg = ERR_PTR(-ENOENT);
287 crypto_larval_kill(larval);
288 return alg;
290 EXPORT_SYMBOL_GPL(crypto_alg_mod_lookup);
292 static int crypto_init_ops(struct crypto_tfm *tfm, u32 type, u32 mask)
294 const struct crypto_type *type_obj = tfm->__crt_alg->cra_type;
296 if (type_obj)
297 return type_obj->init(tfm, type, mask);
299 switch (crypto_tfm_alg_type(tfm)) {
300 case CRYPTO_ALG_TYPE_CIPHER:
301 return crypto_init_cipher_ops(tfm);
303 case CRYPTO_ALG_TYPE_COMPRESS:
304 return crypto_init_compress_ops(tfm);
306 default:
307 break;
310 BUG();
311 return -EINVAL;
314 static void crypto_exit_ops(struct crypto_tfm *tfm)
316 const struct crypto_type *type = tfm->__crt_alg->cra_type;
318 if (type && tfm->exit)
319 tfm->exit(tfm);
322 static unsigned int crypto_ctxsize(struct crypto_alg *alg, u32 type, u32 mask)
324 const struct crypto_type *type_obj = alg->cra_type;
325 unsigned int len;
327 len = alg->cra_alignmask & ~(crypto_tfm_ctx_alignment() - 1);
328 if (type_obj)
329 return len + type_obj->ctxsize(alg, type, mask);
331 switch (alg->cra_flags & CRYPTO_ALG_TYPE_MASK) {
332 default:
333 BUG();
335 case CRYPTO_ALG_TYPE_CIPHER:
336 len += crypto_cipher_ctxsize(alg);
337 break;
339 case CRYPTO_ALG_TYPE_COMPRESS:
340 len += crypto_compress_ctxsize(alg);
341 break;
344 return len;
347 void crypto_shoot_alg(struct crypto_alg *alg)
349 down_write(&crypto_alg_sem);
350 alg->cra_flags |= CRYPTO_ALG_DYING;
351 up_write(&crypto_alg_sem);
353 EXPORT_SYMBOL_GPL(crypto_shoot_alg);
355 struct crypto_tfm *__crypto_alloc_tfm(struct crypto_alg *alg, u32 type,
356 u32 mask)
358 struct crypto_tfm *tfm = NULL;
359 unsigned int tfm_size;
360 int err = -ENOMEM;
362 tfm_size = sizeof(*tfm) + crypto_ctxsize(alg, type, mask);
363 tfm = kzalloc(tfm_size, GFP_KERNEL);
364 if (tfm == NULL)
365 goto out_err;
367 tfm->__crt_alg = alg;
369 err = crypto_init_ops(tfm, type, mask);
370 if (err)
371 goto out_free_tfm;
373 if (!tfm->exit && alg->cra_init && (err = alg->cra_init(tfm)))
374 goto cra_init_failed;
376 goto out;
378 cra_init_failed:
379 crypto_exit_ops(tfm);
380 out_free_tfm:
381 if (err == -EAGAIN)
382 crypto_shoot_alg(alg);
383 kfree(tfm);
384 out_err:
385 tfm = ERR_PTR(err);
386 out:
387 return tfm;
389 EXPORT_SYMBOL_GPL(__crypto_alloc_tfm);
392 * crypto_alloc_base - Locate algorithm and allocate transform
393 * @alg_name: Name of algorithm
394 * @type: Type of algorithm
395 * @mask: Mask for type comparison
397 * This function should not be used by new algorithm types.
398 * Please use crypto_alloc_tfm instead.
400 * crypto_alloc_base() will first attempt to locate an already loaded
401 * algorithm. If that fails and the kernel supports dynamically loadable
402 * modules, it will then attempt to load a module of the same name or
403 * alias. If that fails it will send a query to any loaded crypto manager
404 * to construct an algorithm on the fly. A refcount is grabbed on the
405 * algorithm which is then associated with the new transform.
407 * The returned transform is of a non-determinate type. Most people
408 * should use one of the more specific allocation functions such as
409 * crypto_alloc_blkcipher.
411 * In case of error the return value is an error pointer.
413 struct crypto_tfm *crypto_alloc_base(const char *alg_name, u32 type, u32 mask)
415 struct crypto_tfm *tfm;
416 int err;
418 for (;;) {
419 struct crypto_alg *alg;
421 alg = crypto_alg_mod_lookup(alg_name, type, mask);
422 if (IS_ERR(alg)) {
423 err = PTR_ERR(alg);
424 goto err;
427 tfm = __crypto_alloc_tfm(alg, type, mask);
428 if (!IS_ERR(tfm))
429 return tfm;
431 crypto_mod_put(alg);
432 err = PTR_ERR(tfm);
434 err:
435 if (err != -EAGAIN)
436 break;
437 if (fatal_signal_pending(current)) {
438 err = -EINTR;
439 break;
443 return ERR_PTR(err);
445 EXPORT_SYMBOL_GPL(crypto_alloc_base);
447 void *crypto_create_tfm(struct crypto_alg *alg,
448 const struct crypto_type *frontend)
450 char *mem;
451 struct crypto_tfm *tfm = NULL;
452 unsigned int tfmsize;
453 unsigned int total;
454 int err = -ENOMEM;
456 tfmsize = frontend->tfmsize;
457 total = tfmsize + sizeof(*tfm) + frontend->extsize(alg);
459 mem = kzalloc(total, GFP_KERNEL);
460 if (mem == NULL)
461 goto out_err;
463 tfm = (struct crypto_tfm *)(mem + tfmsize);
464 tfm->__crt_alg = alg;
466 err = frontend->init_tfm(tfm);
467 if (err)
468 goto out_free_tfm;
470 if (!tfm->exit && alg->cra_init && (err = alg->cra_init(tfm)))
471 goto cra_init_failed;
473 goto out;
475 cra_init_failed:
476 crypto_exit_ops(tfm);
477 out_free_tfm:
478 if (err == -EAGAIN)
479 crypto_shoot_alg(alg);
480 kfree(mem);
481 out_err:
482 mem = ERR_PTR(err);
483 out:
484 return mem;
486 EXPORT_SYMBOL_GPL(crypto_create_tfm);
488 struct crypto_alg *crypto_find_alg(const char *alg_name,
489 const struct crypto_type *frontend,
490 u32 type, u32 mask)
492 if (frontend) {
493 type &= frontend->maskclear;
494 mask &= frontend->maskclear;
495 type |= frontend->type;
496 mask |= frontend->maskset;
499 return crypto_alg_mod_lookup(alg_name, type, mask);
501 EXPORT_SYMBOL_GPL(crypto_find_alg);
504 * crypto_alloc_tfm - Locate algorithm and allocate transform
505 * @alg_name: Name of algorithm
506 * @frontend: Frontend algorithm type
507 * @type: Type of algorithm
508 * @mask: Mask for type comparison
510 * crypto_alloc_tfm() will first attempt to locate an already loaded
511 * algorithm. If that fails and the kernel supports dynamically loadable
512 * modules, it will then attempt to load a module of the same name or
513 * alias. If that fails it will send a query to any loaded crypto manager
514 * to construct an algorithm on the fly. A refcount is grabbed on the
515 * algorithm which is then associated with the new transform.
517 * The returned transform is of a non-determinate type. Most people
518 * should use one of the more specific allocation functions such as
519 * crypto_alloc_blkcipher.
521 * In case of error the return value is an error pointer.
523 void *crypto_alloc_tfm(const char *alg_name,
524 const struct crypto_type *frontend, u32 type, u32 mask)
526 void *tfm;
527 int err;
529 for (;;) {
530 struct crypto_alg *alg;
532 alg = crypto_find_alg(alg_name, frontend, type, mask);
533 if (IS_ERR(alg)) {
534 err = PTR_ERR(alg);
535 goto err;
538 tfm = crypto_create_tfm(alg, frontend);
539 if (!IS_ERR(tfm))
540 return tfm;
542 crypto_mod_put(alg);
543 err = PTR_ERR(tfm);
545 err:
546 if (err != -EAGAIN)
547 break;
548 if (fatal_signal_pending(current)) {
549 err = -EINTR;
550 break;
554 return ERR_PTR(err);
556 EXPORT_SYMBOL_GPL(crypto_alloc_tfm);
559 * crypto_destroy_tfm - Free crypto transform
560 * @mem: Start of tfm slab
561 * @tfm: Transform to free
563 * This function frees up the transform and any associated resources,
564 * then drops the refcount on the associated algorithm.
566 void crypto_destroy_tfm(void *mem, struct crypto_tfm *tfm)
568 struct crypto_alg *alg;
570 if (unlikely(!mem))
571 return;
573 alg = tfm->__crt_alg;
575 if (!tfm->exit && alg->cra_exit)
576 alg->cra_exit(tfm);
577 crypto_exit_ops(tfm);
578 crypto_mod_put(alg);
579 kzfree(mem);
581 EXPORT_SYMBOL_GPL(crypto_destroy_tfm);
583 int crypto_has_alg(const char *name, u32 type, u32 mask)
585 int ret = 0;
586 struct crypto_alg *alg = crypto_alg_mod_lookup(name, type, mask);
588 if (!IS_ERR(alg)) {
589 crypto_mod_put(alg);
590 ret = 1;
593 return ret;
595 EXPORT_SYMBOL_GPL(crypto_has_alg);
597 void crypto_req_done(struct crypto_async_request *req, int err)
599 struct crypto_wait *wait = req->data;
601 if (err == -EINPROGRESS)
602 return;
604 wait->err = err;
605 complete(&wait->completion);
607 EXPORT_SYMBOL_GPL(crypto_req_done);
609 MODULE_DESCRIPTION("Cryptographic core API");
610 MODULE_LICENSE("GPL");