Merge git://git.kernel.org/pub/scm/linux/kernel/git/davem/sparc-2.6
[linux-2.6/verdex.git] / crypto / api.c
blob9975a7bd246c21d4d7e3152249ffefdb38812ee5
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.h>
25 #include <linux/slab.h>
26 #include <linux/string.h>
27 #include "internal.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 inline struct crypto_alg *crypto_alg_get(struct crypto_alg *alg)
39 atomic_inc(&alg->cra_refcnt);
40 return alg;
43 struct crypto_alg *crypto_mod_get(struct crypto_alg *alg)
45 return try_module_get(alg->cra_module) ? crypto_alg_get(alg) : NULL;
47 EXPORT_SYMBOL_GPL(crypto_mod_get);
49 void crypto_mod_put(struct crypto_alg *alg)
51 struct module *module = alg->cra_module;
53 crypto_alg_put(alg);
54 module_put(module);
56 EXPORT_SYMBOL_GPL(crypto_mod_put);
58 static inline int crypto_is_test_larval(struct crypto_larval *larval)
60 return larval->alg.cra_driver_name[0];
63 static struct crypto_alg *__crypto_alg_lookup(const char *name, u32 type,
64 u32 mask)
66 struct crypto_alg *q, *alg = NULL;
67 int best = -2;
69 list_for_each_entry(q, &crypto_alg_list, cra_list) {
70 int exact, fuzzy;
72 if (crypto_is_moribund(q))
73 continue;
75 if ((q->cra_flags ^ type) & mask)
76 continue;
78 if (crypto_is_larval(q) &&
79 !crypto_is_test_larval((struct crypto_larval *)q) &&
80 ((struct crypto_larval *)q)->mask != mask)
81 continue;
83 exact = !strcmp(q->cra_driver_name, name);
84 fuzzy = !strcmp(q->cra_name, name);
85 if (!exact && !(fuzzy && q->cra_priority > best))
86 continue;
88 if (unlikely(!crypto_mod_get(q)))
89 continue;
91 best = q->cra_priority;
92 if (alg)
93 crypto_mod_put(alg);
94 alg = q;
96 if (exact)
97 break;
100 return alg;
103 static void crypto_larval_destroy(struct crypto_alg *alg)
105 struct crypto_larval *larval = (void *)alg;
107 BUG_ON(!crypto_is_larval(alg));
108 if (larval->adult)
109 crypto_mod_put(larval->adult);
110 kfree(larval);
113 struct crypto_larval *crypto_larval_alloc(const char *name, u32 type, u32 mask)
115 struct crypto_larval *larval;
117 larval = kzalloc(sizeof(*larval), GFP_KERNEL);
118 if (!larval)
119 return ERR_PTR(-ENOMEM);
121 larval->mask = mask;
122 larval->alg.cra_flags = CRYPTO_ALG_LARVAL | type;
123 larval->alg.cra_priority = -1;
124 larval->alg.cra_destroy = crypto_larval_destroy;
126 strlcpy(larval->alg.cra_name, name, CRYPTO_MAX_ALG_NAME);
127 init_completion(&larval->completion);
129 return larval;
131 EXPORT_SYMBOL_GPL(crypto_larval_alloc);
133 static struct crypto_alg *crypto_larval_add(const char *name, u32 type,
134 u32 mask)
136 struct crypto_alg *alg;
137 struct crypto_larval *larval;
139 larval = crypto_larval_alloc(name, type, mask);
140 if (IS_ERR(larval))
141 return ERR_CAST(larval);
143 atomic_set(&larval->alg.cra_refcnt, 2);
145 down_write(&crypto_alg_sem);
146 alg = __crypto_alg_lookup(name, type, mask);
147 if (!alg) {
148 alg = &larval->alg;
149 list_add(&alg->cra_list, &crypto_alg_list);
151 up_write(&crypto_alg_sem);
153 if (alg != &larval->alg)
154 kfree(larval);
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_interruptible_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 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);
204 return alg;
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;
212 if (!name)
213 return ERR_PTR(-ENOENT);
215 mask &= ~(CRYPTO_ALG_LARVAL | CRYPTO_ALG_DEAD);
216 type &= mask;
218 alg = try_then_request_module(crypto_alg_lookup(name, type, mask),
219 name);
220 if (alg)
221 return crypto_is_larval(alg) ? crypto_larval_wait(alg) : alg;
223 return crypto_larval_add(name, type, mask);
225 EXPORT_SYMBOL_GPL(crypto_larval_lookup);
227 int crypto_probing_notify(unsigned long val, void *v)
229 int ok;
231 ok = blocking_notifier_call_chain(&crypto_chain, val, v);
232 if (ok == NOTIFY_DONE) {
233 request_module("cryptomgr");
234 ok = blocking_notifier_call_chain(&crypto_chain, val, v);
237 return ok;
239 EXPORT_SYMBOL_GPL(crypto_probing_notify);
241 struct crypto_alg *crypto_alg_mod_lookup(const char *name, u32 type, u32 mask)
243 struct crypto_alg *alg;
244 struct crypto_alg *larval;
245 int ok;
247 if (!(mask & CRYPTO_ALG_TESTED)) {
248 type |= CRYPTO_ALG_TESTED;
249 mask |= CRYPTO_ALG_TESTED;
252 larval = crypto_larval_lookup(name, type, mask);
253 if (IS_ERR(larval) || !crypto_is_larval(larval))
254 return larval;
256 ok = crypto_probing_notify(CRYPTO_MSG_ALG_REQUEST, larval);
258 if (ok == NOTIFY_STOP)
259 alg = crypto_larval_wait(larval);
260 else {
261 crypto_mod_put(larval);
262 alg = ERR_PTR(-ENOENT);
264 crypto_larval_kill(larval);
265 return alg;
267 EXPORT_SYMBOL_GPL(crypto_alg_mod_lookup);
269 static int crypto_init_ops(struct crypto_tfm *tfm, u32 type, u32 mask)
271 const struct crypto_type *type_obj = tfm->__crt_alg->cra_type;
273 if (type_obj)
274 return type_obj->init(tfm, type, mask);
276 switch (crypto_tfm_alg_type(tfm)) {
277 case CRYPTO_ALG_TYPE_CIPHER:
278 return crypto_init_cipher_ops(tfm);
280 case CRYPTO_ALG_TYPE_DIGEST:
281 if ((mask & CRYPTO_ALG_TYPE_HASH_MASK) !=
282 CRYPTO_ALG_TYPE_HASH_MASK)
283 return crypto_init_digest_ops_async(tfm);
284 else
285 return crypto_init_digest_ops(tfm);
287 case CRYPTO_ALG_TYPE_COMPRESS:
288 return crypto_init_compress_ops(tfm);
290 default:
291 break;
294 BUG();
295 return -EINVAL;
298 static void crypto_exit_ops(struct crypto_tfm *tfm)
300 const struct crypto_type *type = tfm->__crt_alg->cra_type;
302 if (type) {
303 if (tfm->exit)
304 tfm->exit(tfm);
305 return;
308 switch (crypto_tfm_alg_type(tfm)) {
309 case CRYPTO_ALG_TYPE_CIPHER:
310 crypto_exit_cipher_ops(tfm);
311 break;
313 case CRYPTO_ALG_TYPE_DIGEST:
314 crypto_exit_digest_ops(tfm);
315 break;
317 case CRYPTO_ALG_TYPE_COMPRESS:
318 crypto_exit_compress_ops(tfm);
319 break;
321 default:
322 BUG();
327 static unsigned int crypto_ctxsize(struct crypto_alg *alg, u32 type, u32 mask)
329 const struct crypto_type *type_obj = alg->cra_type;
330 unsigned int len;
332 len = alg->cra_alignmask & ~(crypto_tfm_ctx_alignment() - 1);
333 if (type_obj)
334 return len + type_obj->ctxsize(alg, type, mask);
336 switch (alg->cra_flags & CRYPTO_ALG_TYPE_MASK) {
337 default:
338 BUG();
340 case CRYPTO_ALG_TYPE_CIPHER:
341 len += crypto_cipher_ctxsize(alg);
342 break;
344 case CRYPTO_ALG_TYPE_DIGEST:
345 len += crypto_digest_ctxsize(alg);
346 break;
348 case CRYPTO_ALG_TYPE_COMPRESS:
349 len += crypto_compress_ctxsize(alg);
350 break;
353 return len;
356 void crypto_shoot_alg(struct crypto_alg *alg)
358 down_write(&crypto_alg_sem);
359 alg->cra_flags |= CRYPTO_ALG_DYING;
360 up_write(&crypto_alg_sem);
362 EXPORT_SYMBOL_GPL(crypto_shoot_alg);
364 struct crypto_tfm *__crypto_alloc_tfm(struct crypto_alg *alg, u32 type,
365 u32 mask)
367 struct crypto_tfm *tfm = NULL;
368 unsigned int tfm_size;
369 int err = -ENOMEM;
371 tfm_size = sizeof(*tfm) + crypto_ctxsize(alg, type, mask);
372 tfm = kzalloc(tfm_size, GFP_KERNEL);
373 if (tfm == NULL)
374 goto out_err;
376 tfm->__crt_alg = alg;
378 err = crypto_init_ops(tfm, type, mask);
379 if (err)
380 goto out_free_tfm;
382 if (!tfm->exit && alg->cra_init && (err = alg->cra_init(tfm)))
383 goto cra_init_failed;
385 goto out;
387 cra_init_failed:
388 crypto_exit_ops(tfm);
389 out_free_tfm:
390 if (err == -EAGAIN)
391 crypto_shoot_alg(alg);
392 kfree(tfm);
393 out_err:
394 tfm = ERR_PTR(err);
395 out:
396 return tfm;
398 EXPORT_SYMBOL_GPL(__crypto_alloc_tfm);
401 * crypto_alloc_base - Locate algorithm and allocate transform
402 * @alg_name: Name of algorithm
403 * @type: Type of algorithm
404 * @mask: Mask for type comparison
406 * This function should not be used by new algorithm types.
407 * Plesae use crypto_alloc_tfm instead.
409 * crypto_alloc_base() will first attempt to locate an already loaded
410 * algorithm. If that fails and the kernel supports dynamically loadable
411 * modules, it will then attempt to load a module of the same name or
412 * alias. If that fails it will send a query to any loaded crypto manager
413 * to construct an algorithm on the fly. A refcount is grabbed on the
414 * algorithm which is then associated with the new transform.
416 * The returned transform is of a non-determinate type. Most people
417 * should use one of the more specific allocation functions such as
418 * crypto_alloc_blkcipher.
420 * In case of error the return value is an error pointer.
422 struct crypto_tfm *crypto_alloc_base(const char *alg_name, u32 type, u32 mask)
424 struct crypto_tfm *tfm;
425 int err;
427 for (;;) {
428 struct crypto_alg *alg;
430 alg = crypto_alg_mod_lookup(alg_name, type, mask);
431 if (IS_ERR(alg)) {
432 err = PTR_ERR(alg);
433 goto err;
436 tfm = __crypto_alloc_tfm(alg, type, mask);
437 if (!IS_ERR(tfm))
438 return tfm;
440 crypto_mod_put(alg);
441 err = PTR_ERR(tfm);
443 err:
444 if (err != -EAGAIN)
445 break;
446 if (signal_pending(current)) {
447 err = -EINTR;
448 break;
452 return ERR_PTR(err);
454 EXPORT_SYMBOL_GPL(crypto_alloc_base);
456 struct crypto_tfm *crypto_create_tfm(struct crypto_alg *alg,
457 const struct crypto_type *frontend)
459 char *mem;
460 struct crypto_tfm *tfm = NULL;
461 unsigned int tfmsize;
462 unsigned int total;
463 int err = -ENOMEM;
465 tfmsize = frontend->tfmsize;
466 total = tfmsize + sizeof(*tfm) + frontend->extsize(alg, frontend);
468 mem = kzalloc(total, GFP_KERNEL);
469 if (mem == NULL)
470 goto out_err;
472 tfm = (struct crypto_tfm *)(mem + tfmsize);
473 tfm->__crt_alg = alg;
475 err = frontend->init_tfm(tfm, frontend);
476 if (err)
477 goto out_free_tfm;
479 if (!tfm->exit && alg->cra_init && (err = alg->cra_init(tfm)))
480 goto cra_init_failed;
482 goto out;
484 cra_init_failed:
485 crypto_exit_ops(tfm);
486 out_free_tfm:
487 if (err == -EAGAIN)
488 crypto_shoot_alg(alg);
489 kfree(mem);
490 out_err:
491 tfm = ERR_PTR(err);
492 out:
493 return tfm;
495 EXPORT_SYMBOL_GPL(crypto_create_tfm);
498 * crypto_alloc_tfm - Locate algorithm and allocate transform
499 * @alg_name: Name of algorithm
500 * @frontend: Frontend algorithm type
501 * @type: Type of algorithm
502 * @mask: Mask for type comparison
504 * crypto_alloc_tfm() will first attempt to locate an already loaded
505 * algorithm. If that fails and the kernel supports dynamically loadable
506 * modules, it will then attempt to load a module of the same name or
507 * alias. If that fails it will send a query to any loaded crypto manager
508 * to construct an algorithm on the fly. A refcount is grabbed on the
509 * algorithm which is then associated with the new transform.
511 * The returned transform is of a non-determinate type. Most people
512 * should use one of the more specific allocation functions such as
513 * crypto_alloc_blkcipher.
515 * In case of error the return value is an error pointer.
517 struct crypto_tfm *crypto_alloc_tfm(const char *alg_name,
518 const struct crypto_type *frontend,
519 u32 type, u32 mask)
521 struct crypto_alg *(*lookup)(const char *name, u32 type, u32 mask);
522 struct crypto_tfm *tfm;
523 int err;
525 type &= frontend->maskclear;
526 mask &= frontend->maskclear;
527 type |= frontend->type;
528 mask |= frontend->maskset;
530 lookup = frontend->lookup ?: crypto_alg_mod_lookup;
532 for (;;) {
533 struct crypto_alg *alg;
535 alg = lookup(alg_name, type, mask);
536 if (IS_ERR(alg)) {
537 err = PTR_ERR(alg);
538 goto err;
541 tfm = crypto_create_tfm(alg, frontend);
542 if (!IS_ERR(tfm))
543 return tfm;
545 crypto_mod_put(alg);
546 err = PTR_ERR(tfm);
548 err:
549 if (err != -EAGAIN)
550 break;
551 if (signal_pending(current)) {
552 err = -EINTR;
553 break;
557 return ERR_PTR(err);
559 EXPORT_SYMBOL_GPL(crypto_alloc_tfm);
562 * crypto_free_tfm - Free crypto transform
563 * @tfm: Transform to free
565 * crypto_free_tfm() frees up the transform and any associated resources,
566 * then drops the refcount on the associated algorithm.
568 void crypto_free_tfm(struct crypto_tfm *tfm)
570 struct crypto_alg *alg;
571 int size;
573 if (unlikely(!tfm))
574 return;
576 alg = tfm->__crt_alg;
577 size = sizeof(*tfm) + alg->cra_ctxsize;
579 if (!tfm->exit && alg->cra_exit)
580 alg->cra_exit(tfm);
581 crypto_exit_ops(tfm);
582 crypto_mod_put(alg);
583 memset(tfm, 0, size);
584 kfree(tfm);
587 EXPORT_SYMBOL_GPL(crypto_free_tfm);
589 int crypto_has_alg(const char *name, u32 type, u32 mask)
591 int ret = 0;
592 struct crypto_alg *alg = crypto_alg_mod_lookup(name, type, mask);
594 if (!IS_ERR(alg)) {
595 crypto_mod_put(alg);
596 ret = 1;
599 return ret;
601 EXPORT_SYMBOL_GPL(crypto_has_alg);
603 MODULE_DESCRIPTION("Cryptographic core API");
604 MODULE_LICENSE("GPL");