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.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 inline struct crypto_alg *crypto_alg_get(struct crypto_alg *alg)
39 atomic_inc(&alg->cra_refcnt);
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;
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,
66 struct crypto_alg *q, *alg = NULL;
69 list_for_each_entry(q, &crypto_alg_list, cra_list) {
72 if (crypto_is_moribund(q))
75 if ((q->cra_flags ^ type) & mask)
78 if (crypto_is_larval(q) &&
79 !crypto_is_test_larval((struct crypto_larval *)q) &&
80 ((struct crypto_larval *)q)->mask != mask)
83 exact = !strcmp(q->cra_driver_name, name);
84 fuzzy = !strcmp(q->cra_name, name);
85 if (!exact && !(fuzzy && q->cra_priority > best))
88 if (unlikely(!crypto_mod_get(q)))
91 best = q->cra_priority;
103 static void crypto_larval_destroy(struct crypto_alg *alg)
105 struct crypto_larval *larval = (void *)alg;
107 BUG_ON(!crypto_is_larval(alg));
109 crypto_mod_put(larval->adult);
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);
119 return ERR_PTR(-ENOMEM);
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);
131 EXPORT_SYMBOL_GPL(crypto_larval_alloc);
133 static struct crypto_alg *crypto_larval_add(const char *name, u32 type,
136 struct crypto_alg *alg;
137 struct crypto_larval *larval;
139 larval = crypto_larval_alloc(name, type, mask);
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);
149 list_add(&alg->cra_list, &crypto_alg_list);
151 up_write(&crypto_alg_sem);
153 if (alg != &larval->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_interruptible_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 mask &= ~(CRYPTO_ALG_LARVAL | CRYPTO_ALG_DEAD);
218 alg = try_then_request_module(crypto_alg_lookup(name, type, mask),
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)
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);
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;
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))
256 ok = crypto_probing_notify(CRYPTO_MSG_ALG_REQUEST, larval);
258 if (ok == NOTIFY_STOP)
259 alg = crypto_larval_wait(larval);
261 crypto_mod_put(larval);
262 alg = ERR_PTR(-ENOENT);
264 crypto_larval_kill(larval);
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;
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);
285 return crypto_init_digest_ops(tfm);
287 case CRYPTO_ALG_TYPE_COMPRESS:
288 return crypto_init_compress_ops(tfm);
298 static void crypto_exit_ops(struct crypto_tfm *tfm)
300 const struct crypto_type *type = tfm->__crt_alg->cra_type;
308 switch (crypto_tfm_alg_type(tfm)) {
309 case CRYPTO_ALG_TYPE_CIPHER:
310 crypto_exit_cipher_ops(tfm);
313 case CRYPTO_ALG_TYPE_DIGEST:
314 crypto_exit_digest_ops(tfm);
317 case CRYPTO_ALG_TYPE_COMPRESS:
318 crypto_exit_compress_ops(tfm);
327 static unsigned int crypto_ctxsize(struct crypto_alg *alg, u32 type, u32 mask)
329 const struct crypto_type *type_obj = alg->cra_type;
332 len = alg->cra_alignmask & ~(crypto_tfm_ctx_alignment() - 1);
334 return len + type_obj->ctxsize(alg, type, mask);
336 switch (alg->cra_flags & CRYPTO_ALG_TYPE_MASK) {
340 case CRYPTO_ALG_TYPE_CIPHER:
341 len += crypto_cipher_ctxsize(alg);
344 case CRYPTO_ALG_TYPE_DIGEST:
345 len += crypto_digest_ctxsize(alg);
348 case CRYPTO_ALG_TYPE_COMPRESS:
349 len += crypto_compress_ctxsize(alg);
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,
367 struct crypto_tfm *tfm = NULL;
368 unsigned int tfm_size;
371 tfm_size = sizeof(*tfm) + crypto_ctxsize(alg, type, mask);
372 tfm = kzalloc(tfm_size, GFP_KERNEL);
376 tfm->__crt_alg = alg;
378 err = crypto_init_ops(tfm, type, mask);
382 if (alg->cra_init && (err = alg->cra_init(tfm))) {
384 crypto_shoot_alg(alg);
385 goto cra_init_failed;
391 crypto_exit_ops(tfm);
399 EXPORT_SYMBOL_GPL(__crypto_alloc_tfm);
402 * crypto_alloc_base - Locate algorithm and allocate transform
403 * @alg_name: Name of algorithm
404 * @type: Type of algorithm
405 * @mask: Mask for type comparison
407 * crypto_alloc_base() will first attempt to locate an already loaded
408 * algorithm. If that fails and the kernel supports dynamically loadable
409 * modules, it will then attempt to load a module of the same name or
410 * alias. If that fails it will send a query to any loaded crypto manager
411 * to construct an algorithm on the fly. A refcount is grabbed on the
412 * algorithm which is then associated with the new transform.
414 * The returned transform is of a non-determinate type. Most people
415 * should use one of the more specific allocation functions such as
416 * crypto_alloc_blkcipher.
418 * In case of error the return value is an error pointer.
420 struct crypto_tfm *crypto_alloc_base(const char *alg_name, u32 type, u32 mask)
422 struct crypto_tfm *tfm;
426 struct crypto_alg *alg;
428 alg = crypto_alg_mod_lookup(alg_name, type, mask);
434 tfm = __crypto_alloc_tfm(alg, type, mask);
444 if (signal_pending(current)) {
452 EXPORT_SYMBOL_GPL(crypto_alloc_base);
455 * crypto_free_tfm - Free crypto transform
456 * @tfm: Transform to free
458 * crypto_free_tfm() frees up the transform and any associated resources,
459 * then drops the refcount on the associated algorithm.
461 void crypto_free_tfm(struct crypto_tfm *tfm)
463 struct crypto_alg *alg;
469 alg = tfm->__crt_alg;
470 size = sizeof(*tfm) + alg->cra_ctxsize;
474 crypto_exit_ops(tfm);
476 memset(tfm, 0, size);
480 EXPORT_SYMBOL_GPL(crypto_free_tfm);
482 int crypto_has_alg(const char *name, u32 type, u32 mask)
485 struct crypto_alg *alg = crypto_alg_mod_lookup(name, type, mask);
494 EXPORT_SYMBOL_GPL(crypto_has_alg);
496 MODULE_DESCRIPTION("Cryptographic core API");
497 MODULE_LICENSE("GPL");