2 * Cryptographic API for algorithms (i.e., low-level API).
4 * Copyright (c) 2006 Herbert Xu <herbert@gondor.apana.org.au>
6 * This program is free software; you can redistribute it and/or modify it
7 * under the terms of the GNU General Public License as published by the Free
8 * Software Foundation; either version 2 of the License, or (at your option)
13 #include <linux/err.h>
14 #include <linux/errno.h>
15 #include <linux/init.h>
16 #include <linux/kernel.h>
17 #include <linux/list.h>
18 #include <linux/module.h>
19 #include <linux/rtnetlink.h>
20 #include <linux/string.h>
24 static LIST_HEAD(crypto_template_list);
26 void crypto_larval_error(const char *name, u32 type, u32 mask)
28 struct crypto_alg *alg;
30 down_read(&crypto_alg_sem);
31 alg = __crypto_alg_lookup(name, type, mask);
32 up_read(&crypto_alg_sem);
35 if (crypto_is_larval(alg)) {
36 struct crypto_larval *larval = (void *)alg;
37 complete_all(&larval->completion);
42 EXPORT_SYMBOL_GPL(crypto_larval_error);
44 static inline int crypto_set_driver_name(struct crypto_alg *alg)
46 static const char suffix[] = "-generic";
47 char *driver_name = alg->cra_driver_name;
53 len = strlcpy(driver_name, alg->cra_name, CRYPTO_MAX_ALG_NAME);
54 if (len + sizeof(suffix) > CRYPTO_MAX_ALG_NAME)
57 memcpy(driver_name + len, suffix, sizeof(suffix));
61 static int crypto_check_alg(struct crypto_alg *alg)
63 if (alg->cra_alignmask & (alg->cra_alignmask + 1))
66 if (alg->cra_blocksize > PAGE_SIZE / 8)
69 if (alg->cra_priority < 0)
72 return crypto_set_driver_name(alg);
75 static void crypto_destroy_instance(struct crypto_alg *alg)
77 struct crypto_instance *inst = (void *)alg;
78 struct crypto_template *tmpl = inst->tmpl;
81 crypto_tmpl_put(tmpl);
84 static void crypto_remove_spawn(struct crypto_spawn *spawn,
85 struct list_head *list,
86 struct list_head *secondary_spawns)
88 struct crypto_instance *inst = spawn->inst;
89 struct crypto_template *tmpl = inst->tmpl;
91 list_del_init(&spawn->list);
94 if (crypto_is_dead(&inst->alg))
97 inst->alg.cra_flags |= CRYPTO_ALG_DEAD;
98 if (hlist_unhashed(&inst->list))
101 if (!tmpl || !crypto_tmpl_get(tmpl))
104 crypto_notify(CRYPTO_MSG_ALG_UNREGISTER, &inst->alg);
105 list_move(&inst->alg.cra_list, list);
106 hlist_del(&inst->list);
107 inst->alg.cra_destroy = crypto_destroy_instance;
109 list_splice(&inst->alg.cra_users, secondary_spawns);
112 static void crypto_remove_spawns(struct list_head *spawns,
113 struct list_head *list, u32 new_type)
115 struct crypto_spawn *spawn, *n;
116 LIST_HEAD(secondary_spawns);
118 list_for_each_entry_safe(spawn, n, spawns, list) {
119 if ((spawn->alg->cra_flags ^ new_type) & spawn->mask)
122 crypto_remove_spawn(spawn, list, &secondary_spawns);
125 while (!list_empty(&secondary_spawns)) {
126 list_for_each_entry_safe(spawn, n, &secondary_spawns, list)
127 crypto_remove_spawn(spawn, list, &secondary_spawns);
131 static int __crypto_register_alg(struct crypto_alg *alg,
132 struct list_head *list)
134 struct crypto_alg *q;
137 if (crypto_is_dead(alg))
140 INIT_LIST_HEAD(&alg->cra_users);
144 atomic_set(&alg->cra_refcnt, 1);
145 list_for_each_entry(q, &crypto_alg_list, cra_list) {
149 if (crypto_is_moribund(q))
152 if (crypto_is_larval(q)) {
153 struct crypto_larval *larval = (void *)q;
156 * Check to see if either our generic name or
157 * specific name can satisfy the name requested
158 * by the larval entry q.
160 if (strcmp(alg->cra_name, q->cra_name) &&
161 strcmp(alg->cra_driver_name, q->cra_name))
166 if ((q->cra_flags ^ alg->cra_flags) & larval->mask)
168 if (!crypto_mod_get(alg))
172 complete_all(&larval->completion);
176 if (strcmp(alg->cra_name, q->cra_name))
179 if (strcmp(alg->cra_driver_name, q->cra_driver_name) &&
180 q->cra_priority > alg->cra_priority)
183 crypto_remove_spawns(&q->cra_users, list, alg->cra_flags);
186 list_add(&alg->cra_list, &crypto_alg_list);
188 crypto_notify(CRYPTO_MSG_ALG_REGISTER, alg);
195 static void crypto_remove_final(struct list_head *list)
197 struct crypto_alg *alg;
198 struct crypto_alg *n;
200 list_for_each_entry_safe(alg, n, list, cra_list) {
201 list_del_init(&alg->cra_list);
206 int crypto_register_alg(struct crypto_alg *alg)
211 err = crypto_check_alg(alg);
215 down_write(&crypto_alg_sem);
216 err = __crypto_register_alg(alg, &list);
217 up_write(&crypto_alg_sem);
219 crypto_remove_final(&list);
222 EXPORT_SYMBOL_GPL(crypto_register_alg);
224 static int crypto_remove_alg(struct crypto_alg *alg, struct list_head *list)
226 if (unlikely(list_empty(&alg->cra_list)))
229 alg->cra_flags |= CRYPTO_ALG_DEAD;
231 crypto_notify(CRYPTO_MSG_ALG_UNREGISTER, alg);
232 list_del_init(&alg->cra_list);
233 crypto_remove_spawns(&alg->cra_users, list, alg->cra_flags);
238 int crypto_unregister_alg(struct crypto_alg *alg)
243 down_write(&crypto_alg_sem);
244 ret = crypto_remove_alg(alg, &list);
245 up_write(&crypto_alg_sem);
250 BUG_ON(atomic_read(&alg->cra_refcnt) != 1);
251 if (alg->cra_destroy)
252 alg->cra_destroy(alg);
254 crypto_remove_final(&list);
257 EXPORT_SYMBOL_GPL(crypto_unregister_alg);
259 int crypto_register_template(struct crypto_template *tmpl)
261 struct crypto_template *q;
264 down_write(&crypto_alg_sem);
266 list_for_each_entry(q, &crypto_template_list, list) {
271 list_add(&tmpl->list, &crypto_template_list);
272 crypto_notify(CRYPTO_MSG_TMPL_REGISTER, tmpl);
275 up_write(&crypto_alg_sem);
278 EXPORT_SYMBOL_GPL(crypto_register_template);
280 void crypto_unregister_template(struct crypto_template *tmpl)
282 struct crypto_instance *inst;
283 struct hlist_node *p, *n;
284 struct hlist_head *list;
287 down_write(&crypto_alg_sem);
289 BUG_ON(list_empty(&tmpl->list));
290 list_del_init(&tmpl->list);
292 list = &tmpl->instances;
293 hlist_for_each_entry(inst, p, list, list) {
294 int err = crypto_remove_alg(&inst->alg, &users);
298 crypto_notify(CRYPTO_MSG_TMPL_UNREGISTER, tmpl);
300 up_write(&crypto_alg_sem);
302 hlist_for_each_entry_safe(inst, p, n, list, list) {
303 BUG_ON(atomic_read(&inst->alg.cra_refcnt) != 1);
306 crypto_remove_final(&users);
308 EXPORT_SYMBOL_GPL(crypto_unregister_template);
310 static struct crypto_template *__crypto_lookup_template(const char *name)
312 struct crypto_template *q, *tmpl = NULL;
314 down_read(&crypto_alg_sem);
315 list_for_each_entry(q, &crypto_template_list, list) {
316 if (strcmp(q->name, name))
318 if (unlikely(!crypto_tmpl_get(q)))
324 up_read(&crypto_alg_sem);
329 struct crypto_template *crypto_lookup_template(const char *name)
331 return try_then_request_module(__crypto_lookup_template(name), name);
333 EXPORT_SYMBOL_GPL(crypto_lookup_template);
335 int crypto_register_instance(struct crypto_template *tmpl,
336 struct crypto_instance *inst)
341 err = crypto_check_alg(&inst->alg);
345 inst->alg.cra_module = tmpl->module;
347 down_write(&crypto_alg_sem);
349 err = __crypto_register_alg(&inst->alg, &list);
353 hlist_add_head(&inst->list, &tmpl->instances);
357 up_write(&crypto_alg_sem);
359 crypto_remove_final(&list);
364 EXPORT_SYMBOL_GPL(crypto_register_instance);
366 int crypto_init_spawn(struct crypto_spawn *spawn, struct crypto_alg *alg,
367 struct crypto_instance *inst, u32 mask)
374 down_write(&crypto_alg_sem);
375 if (!crypto_is_moribund(alg)) {
376 list_add(&spawn->list, &alg->cra_users);
380 up_write(&crypto_alg_sem);
384 EXPORT_SYMBOL_GPL(crypto_init_spawn);
386 void crypto_drop_spawn(struct crypto_spawn *spawn)
388 down_write(&crypto_alg_sem);
389 list_del(&spawn->list);
390 up_write(&crypto_alg_sem);
392 EXPORT_SYMBOL_GPL(crypto_drop_spawn);
394 struct crypto_tfm *crypto_spawn_tfm(struct crypto_spawn *spawn, u32 type,
397 struct crypto_alg *alg;
398 struct crypto_alg *alg2;
399 struct crypto_tfm *tfm;
401 down_read(&crypto_alg_sem);
405 alg2 = crypto_mod_get(alg2);
406 up_read(&crypto_alg_sem);
410 crypto_shoot_alg(alg);
411 return ERR_PTR(-EAGAIN);
414 tfm = ERR_PTR(-EINVAL);
415 if (unlikely((alg->cra_flags ^ type) & mask))
418 tfm = __crypto_alloc_tfm(alg, type, mask);
428 EXPORT_SYMBOL_GPL(crypto_spawn_tfm);
430 int crypto_register_notifier(struct notifier_block *nb)
432 return blocking_notifier_chain_register(&crypto_chain, nb);
434 EXPORT_SYMBOL_GPL(crypto_register_notifier);
436 int crypto_unregister_notifier(struct notifier_block *nb)
438 return blocking_notifier_chain_unregister(&crypto_chain, nb);
440 EXPORT_SYMBOL_GPL(crypto_unregister_notifier);
442 struct crypto_attr_type *crypto_get_attr_type(struct rtattr **tb)
444 struct rtattr *rta = tb[0];
445 struct crypto_attr_type *algt;
448 return ERR_PTR(-ENOENT);
449 if (RTA_PAYLOAD(rta) < sizeof(*algt))
450 return ERR_PTR(-EINVAL);
451 if (rta->rta_type != CRYPTOA_TYPE)
452 return ERR_PTR(-EINVAL);
454 algt = RTA_DATA(rta);
458 EXPORT_SYMBOL_GPL(crypto_get_attr_type);
460 int crypto_check_attr_type(struct rtattr **tb, u32 type)
462 struct crypto_attr_type *algt;
464 algt = crypto_get_attr_type(tb);
466 return PTR_ERR(algt);
468 if ((algt->type ^ type) & algt->mask)
473 EXPORT_SYMBOL_GPL(crypto_check_attr_type);
475 struct crypto_alg *crypto_attr_alg(struct rtattr *rta, u32 type, u32 mask)
477 struct crypto_attr_alg *alga;
480 return ERR_PTR(-ENOENT);
481 if (RTA_PAYLOAD(rta) < sizeof(*alga))
482 return ERR_PTR(-EINVAL);
483 if (rta->rta_type != CRYPTOA_ALG)
484 return ERR_PTR(-EINVAL);
486 alga = RTA_DATA(rta);
487 alga->name[CRYPTO_MAX_ALG_NAME - 1] = 0;
489 return crypto_alg_mod_lookup(alga->name, type, mask);
491 EXPORT_SYMBOL_GPL(crypto_attr_alg);
493 int crypto_attr_u32(struct rtattr *rta, u32 *num)
495 struct crypto_attr_u32 *nu32;
499 if (RTA_PAYLOAD(rta) < sizeof(*nu32))
501 if (rta->rta_type != CRYPTOA_U32)
504 nu32 = RTA_DATA(rta);
509 EXPORT_SYMBOL_GPL(crypto_attr_u32);
511 struct crypto_instance *crypto_alloc_instance(const char *name,
512 struct crypto_alg *alg)
514 struct crypto_instance *inst;
515 struct crypto_spawn *spawn;
518 inst = kzalloc(sizeof(*inst) + sizeof(*spawn), GFP_KERNEL);
520 return ERR_PTR(-ENOMEM);
523 if (snprintf(inst->alg.cra_name, CRYPTO_MAX_ALG_NAME, "%s(%s)", name,
524 alg->cra_name) >= CRYPTO_MAX_ALG_NAME)
527 if (snprintf(inst->alg.cra_driver_name, CRYPTO_MAX_ALG_NAME, "%s(%s)",
528 name, alg->cra_driver_name) >= CRYPTO_MAX_ALG_NAME)
531 spawn = crypto_instance_ctx(inst);
532 err = crypto_init_spawn(spawn, alg, inst,
533 CRYPTO_ALG_TYPE_MASK | CRYPTO_ALG_ASYNC);
544 EXPORT_SYMBOL_GPL(crypto_alloc_instance);
546 void crypto_init_queue(struct crypto_queue *queue, unsigned int max_qlen)
548 INIT_LIST_HEAD(&queue->list);
549 queue->backlog = &queue->list;
551 queue->max_qlen = max_qlen;
553 EXPORT_SYMBOL_GPL(crypto_init_queue);
555 int crypto_enqueue_request(struct crypto_queue *queue,
556 struct crypto_async_request *request)
558 int err = -EINPROGRESS;
560 if (unlikely(queue->qlen >= queue->max_qlen)) {
562 if (!(request->flags & CRYPTO_TFM_REQ_MAY_BACKLOG))
564 if (queue->backlog == &queue->list)
565 queue->backlog = &request->list;
569 list_add_tail(&request->list, &queue->list);
574 EXPORT_SYMBOL_GPL(crypto_enqueue_request);
576 struct crypto_async_request *crypto_dequeue_request(struct crypto_queue *queue)
578 struct list_head *request;
580 if (unlikely(!queue->qlen))
585 if (queue->backlog != &queue->list)
586 queue->backlog = queue->backlog->next;
588 request = queue->list.next;
591 return list_entry(request, struct crypto_async_request, list);
593 EXPORT_SYMBOL_GPL(crypto_dequeue_request);
595 int crypto_tfm_in_queue(struct crypto_queue *queue, struct crypto_tfm *tfm)
597 struct crypto_async_request *req;
599 list_for_each_entry(req, &queue->list, list) {
606 EXPORT_SYMBOL_GPL(crypto_tfm_in_queue);
608 static int __init crypto_algapi_init(void)
614 static void __exit crypto_algapi_exit(void)
619 module_init(crypto_algapi_init);
620 module_exit(crypto_algapi_exit);
622 MODULE_LICENSE("GPL");
623 MODULE_DESCRIPTION("Cryptographic algorithms API");