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/slab.h>
21 #include <linux/string.h>
25 static LIST_HEAD(crypto_template_list);
27 void crypto_larval_error(const char *name, u32 type, u32 mask)
29 struct crypto_alg *alg;
31 alg = crypto_alg_lookup(name, type, mask);
34 if (crypto_is_larval(alg)) {
35 struct crypto_larval *larval = (void *)alg;
36 complete_all(&larval->completion);
41 EXPORT_SYMBOL_GPL(crypto_larval_error);
43 static inline int crypto_set_driver_name(struct crypto_alg *alg)
45 static const char suffix[] = "-generic";
46 char *driver_name = alg->cra_driver_name;
52 len = strlcpy(driver_name, alg->cra_name, CRYPTO_MAX_ALG_NAME);
53 if (len + sizeof(suffix) > CRYPTO_MAX_ALG_NAME)
56 memcpy(driver_name + len, suffix, sizeof(suffix));
60 static int crypto_check_alg(struct crypto_alg *alg)
62 if (alg->cra_alignmask & (alg->cra_alignmask + 1))
65 if (alg->cra_blocksize > PAGE_SIZE / 8)
68 if (alg->cra_priority < 0)
71 return crypto_set_driver_name(alg);
74 static void crypto_destroy_instance(struct crypto_alg *alg)
76 struct crypto_instance *inst = (void *)alg;
77 struct crypto_template *tmpl = inst->tmpl;
80 crypto_tmpl_put(tmpl);
83 static struct list_head *crypto_more_spawns(struct crypto_alg *alg,
84 struct list_head *stack,
85 struct list_head *top,
86 struct list_head *secondary_spawns)
88 struct crypto_spawn *spawn, *n;
90 if (list_empty(stack))
93 spawn = list_first_entry(stack, struct crypto_spawn, list);
94 n = list_entry(spawn->list.next, struct crypto_spawn, list);
96 if (spawn->alg && &n->list != stack && !n->alg)
97 n->alg = (n->list.next == stack) ? alg :
98 &list_entry(n->list.next, struct crypto_spawn,
101 list_move(&spawn->list, secondary_spawns);
103 return &n->list == stack ? top : &n->inst->alg.cra_users;
106 static void crypto_remove_spawn(struct crypto_spawn *spawn,
107 struct list_head *list)
109 struct crypto_instance *inst = spawn->inst;
110 struct crypto_template *tmpl = inst->tmpl;
112 if (crypto_is_dead(&inst->alg))
115 inst->alg.cra_flags |= CRYPTO_ALG_DEAD;
116 if (hlist_unhashed(&inst->list))
119 if (!tmpl || !crypto_tmpl_get(tmpl))
122 crypto_notify(CRYPTO_MSG_ALG_UNREGISTER, &inst->alg);
123 list_move(&inst->alg.cra_list, list);
124 hlist_del(&inst->list);
125 inst->alg.cra_destroy = crypto_destroy_instance;
127 BUG_ON(!list_empty(&inst->alg.cra_users));
130 void crypto_remove_spawns(struct crypto_alg *alg, struct list_head *list,
131 struct crypto_alg *nalg)
133 u32 new_type = (nalg ?: alg)->cra_flags;
134 struct crypto_spawn *spawn, *n;
135 LIST_HEAD(secondary_spawns);
136 struct list_head *spawns;
140 spawns = &alg->cra_users;
141 list_for_each_entry_safe(spawn, n, spawns, list) {
142 if ((spawn->alg->cra_flags ^ new_type) & spawn->mask)
145 list_move(&spawn->list, &top);
150 while (!list_empty(spawns)) {
151 struct crypto_instance *inst;
153 spawn = list_first_entry(spawns, struct crypto_spawn,
157 BUG_ON(&inst->alg == alg);
159 list_move(&spawn->list, &stack);
161 if (&inst->alg == nalg)
165 spawns = &inst->alg.cra_users;
167 } while ((spawns = crypto_more_spawns(alg, &stack, &top,
168 &secondary_spawns)));
170 list_for_each_entry_safe(spawn, n, &secondary_spawns, list) {
172 list_move(&spawn->list, &spawn->alg->cra_users);
174 crypto_remove_spawn(spawn, list);
177 EXPORT_SYMBOL_GPL(crypto_remove_spawns);
179 static struct crypto_larval *__crypto_register_alg(struct crypto_alg *alg)
181 struct crypto_alg *q;
182 struct crypto_larval *larval;
185 if (crypto_is_dead(alg))
188 INIT_LIST_HEAD(&alg->cra_users);
191 alg->cra_flags &= ~CRYPTO_ALG_TESTED;
195 atomic_set(&alg->cra_refcnt, 1);
196 list_for_each_entry(q, &crypto_alg_list, cra_list) {
200 if (crypto_is_moribund(q))
203 if (crypto_is_larval(q)) {
204 if (!strcmp(alg->cra_driver_name, q->cra_driver_name))
209 if (!strcmp(q->cra_driver_name, alg->cra_name) ||
210 !strcmp(q->cra_name, alg->cra_driver_name))
214 larval = crypto_larval_alloc(alg->cra_name,
215 alg->cra_flags | CRYPTO_ALG_TESTED, 0);
220 larval->adult = crypto_mod_get(alg);
224 atomic_set(&larval->alg.cra_refcnt, 1);
225 memcpy(larval->alg.cra_driver_name, alg->cra_driver_name,
226 CRYPTO_MAX_ALG_NAME);
227 larval->alg.cra_priority = alg->cra_priority;
229 list_add(&alg->cra_list, &crypto_alg_list);
230 list_add(&larval->alg.cra_list, &crypto_alg_list);
238 larval = ERR_PTR(ret);
242 void crypto_alg_tested(const char *name, int err)
244 struct crypto_larval *test;
245 struct crypto_alg *alg;
246 struct crypto_alg *q;
249 down_write(&crypto_alg_sem);
250 list_for_each_entry(q, &crypto_alg_list, cra_list) {
251 if (crypto_is_moribund(q) || !crypto_is_larval(q))
254 test = (struct crypto_larval *)q;
256 if (!strcmp(q->cra_driver_name, name))
260 printk(KERN_ERR "alg: Unexpected test result for %s: %d\n", name, err);
264 q->cra_flags |= CRYPTO_ALG_DEAD;
266 if (err || list_empty(&alg->cra_list))
269 alg->cra_flags |= CRYPTO_ALG_TESTED;
271 list_for_each_entry(q, &crypto_alg_list, cra_list) {
275 if (crypto_is_moribund(q))
278 if (crypto_is_larval(q)) {
279 struct crypto_larval *larval = (void *)q;
282 * Check to see if either our generic name or
283 * specific name can satisfy the name requested
284 * by the larval entry q.
286 if (strcmp(alg->cra_name, q->cra_name) &&
287 strcmp(alg->cra_driver_name, q->cra_name))
292 if ((q->cra_flags ^ alg->cra_flags) & larval->mask)
294 if (!crypto_mod_get(alg))
298 complete_all(&larval->completion);
302 if (strcmp(alg->cra_name, q->cra_name))
305 if (strcmp(alg->cra_driver_name, q->cra_driver_name) &&
306 q->cra_priority > alg->cra_priority)
309 crypto_remove_spawns(q, &list, alg);
313 complete_all(&test->completion);
316 up_write(&crypto_alg_sem);
318 crypto_remove_final(&list);
320 EXPORT_SYMBOL_GPL(crypto_alg_tested);
322 void crypto_remove_final(struct list_head *list)
324 struct crypto_alg *alg;
325 struct crypto_alg *n;
327 list_for_each_entry_safe(alg, n, list, cra_list) {
328 list_del_init(&alg->cra_list);
332 EXPORT_SYMBOL_GPL(crypto_remove_final);
334 static void crypto_wait_for_test(struct crypto_larval *larval)
338 err = crypto_probing_notify(CRYPTO_MSG_ALG_REGISTER, larval->adult);
339 if (err != NOTIFY_STOP) {
340 if (WARN_ON(err != NOTIFY_DONE))
342 crypto_alg_tested(larval->alg.cra_driver_name, 0);
345 err = wait_for_completion_interruptible(&larval->completion);
349 crypto_larval_kill(&larval->alg);
352 int crypto_register_alg(struct crypto_alg *alg)
354 struct crypto_larval *larval;
357 err = crypto_check_alg(alg);
361 down_write(&crypto_alg_sem);
362 larval = __crypto_register_alg(alg);
363 up_write(&crypto_alg_sem);
366 return PTR_ERR(larval);
368 crypto_wait_for_test(larval);
371 EXPORT_SYMBOL_GPL(crypto_register_alg);
373 static int crypto_remove_alg(struct crypto_alg *alg, struct list_head *list)
375 if (unlikely(list_empty(&alg->cra_list)))
378 alg->cra_flags |= CRYPTO_ALG_DEAD;
380 crypto_notify(CRYPTO_MSG_ALG_UNREGISTER, alg);
381 list_del_init(&alg->cra_list);
382 crypto_remove_spawns(alg, list, NULL);
387 int crypto_unregister_alg(struct crypto_alg *alg)
392 down_write(&crypto_alg_sem);
393 ret = crypto_remove_alg(alg, &list);
394 up_write(&crypto_alg_sem);
399 BUG_ON(atomic_read(&alg->cra_refcnt) != 1);
400 if (alg->cra_destroy)
401 alg->cra_destroy(alg);
403 crypto_remove_final(&list);
406 EXPORT_SYMBOL_GPL(crypto_unregister_alg);
408 int crypto_register_algs(struct crypto_alg *algs, int count)
412 for (i = 0; i < count; i++) {
413 ret = crypto_register_alg(&algs[i]);
421 for (--i; i >= 0; --i)
422 crypto_unregister_alg(&algs[i]);
426 EXPORT_SYMBOL_GPL(crypto_register_algs);
428 int crypto_unregister_algs(struct crypto_alg *algs, int count)
432 for (i = 0; i < count; i++) {
433 ret = crypto_unregister_alg(&algs[i]);
435 pr_err("Failed to unregister %s %s: %d\n",
436 algs[i].cra_driver_name, algs[i].cra_name, ret);
441 EXPORT_SYMBOL_GPL(crypto_unregister_algs);
443 int crypto_register_template(struct crypto_template *tmpl)
445 struct crypto_template *q;
448 down_write(&crypto_alg_sem);
450 list_for_each_entry(q, &crypto_template_list, list) {
455 list_add(&tmpl->list, &crypto_template_list);
456 crypto_notify(CRYPTO_MSG_TMPL_REGISTER, tmpl);
459 up_write(&crypto_alg_sem);
462 EXPORT_SYMBOL_GPL(crypto_register_template);
464 void crypto_unregister_template(struct crypto_template *tmpl)
466 struct crypto_instance *inst;
467 struct hlist_node *p, *n;
468 struct hlist_head *list;
471 down_write(&crypto_alg_sem);
473 BUG_ON(list_empty(&tmpl->list));
474 list_del_init(&tmpl->list);
476 list = &tmpl->instances;
477 hlist_for_each_entry(inst, p, list, list) {
478 int err = crypto_remove_alg(&inst->alg, &users);
482 crypto_notify(CRYPTO_MSG_TMPL_UNREGISTER, tmpl);
484 up_write(&crypto_alg_sem);
486 hlist_for_each_entry_safe(inst, p, n, list, list) {
487 BUG_ON(atomic_read(&inst->alg.cra_refcnt) != 1);
490 crypto_remove_final(&users);
492 EXPORT_SYMBOL_GPL(crypto_unregister_template);
494 static struct crypto_template *__crypto_lookup_template(const char *name)
496 struct crypto_template *q, *tmpl = NULL;
498 down_read(&crypto_alg_sem);
499 list_for_each_entry(q, &crypto_template_list, list) {
500 if (strcmp(q->name, name))
502 if (unlikely(!crypto_tmpl_get(q)))
508 up_read(&crypto_alg_sem);
513 struct crypto_template *crypto_lookup_template(const char *name)
515 return try_then_request_module(__crypto_lookup_template(name), name);
517 EXPORT_SYMBOL_GPL(crypto_lookup_template);
519 int crypto_register_instance(struct crypto_template *tmpl,
520 struct crypto_instance *inst)
522 struct crypto_larval *larval;
525 err = crypto_check_alg(&inst->alg);
529 inst->alg.cra_module = tmpl->module;
530 inst->alg.cra_flags |= CRYPTO_ALG_INSTANCE;
532 down_write(&crypto_alg_sem);
534 larval = __crypto_register_alg(&inst->alg);
538 hlist_add_head(&inst->list, &tmpl->instances);
542 up_write(&crypto_alg_sem);
544 err = PTR_ERR(larval);
548 crypto_wait_for_test(larval);
554 EXPORT_SYMBOL_GPL(crypto_register_instance);
556 int crypto_unregister_instance(struct crypto_alg *alg)
559 struct crypto_instance *inst = (void *)alg;
560 struct crypto_template *tmpl = inst->tmpl;
563 if (!(alg->cra_flags & CRYPTO_ALG_INSTANCE))
566 BUG_ON(atomic_read(&alg->cra_refcnt) != 1);
568 down_write(&crypto_alg_sem);
570 hlist_del_init(&inst->list);
571 err = crypto_remove_alg(alg, &users);
573 up_write(&crypto_alg_sem);
579 crypto_remove_final(&users);
583 EXPORT_SYMBOL_GPL(crypto_unregister_instance);
585 int crypto_init_spawn(struct crypto_spawn *spawn, struct crypto_alg *alg,
586 struct crypto_instance *inst, u32 mask)
593 down_write(&crypto_alg_sem);
594 if (!crypto_is_moribund(alg)) {
595 list_add(&spawn->list, &alg->cra_users);
599 up_write(&crypto_alg_sem);
603 EXPORT_SYMBOL_GPL(crypto_init_spawn);
605 int crypto_init_spawn2(struct crypto_spawn *spawn, struct crypto_alg *alg,
606 struct crypto_instance *inst,
607 const struct crypto_type *frontend)
611 if ((alg->cra_flags ^ frontend->type) & frontend->maskset)
614 spawn->frontend = frontend;
615 err = crypto_init_spawn(spawn, alg, inst, frontend->maskset);
620 EXPORT_SYMBOL_GPL(crypto_init_spawn2);
622 void crypto_drop_spawn(struct crypto_spawn *spawn)
627 down_write(&crypto_alg_sem);
628 list_del(&spawn->list);
629 up_write(&crypto_alg_sem);
631 EXPORT_SYMBOL_GPL(crypto_drop_spawn);
633 static struct crypto_alg *crypto_spawn_alg(struct crypto_spawn *spawn)
635 struct crypto_alg *alg;
636 struct crypto_alg *alg2;
638 down_read(&crypto_alg_sem);
642 alg2 = crypto_mod_get(alg2);
643 up_read(&crypto_alg_sem);
647 crypto_shoot_alg(alg);
648 return ERR_PTR(-EAGAIN);
654 struct crypto_tfm *crypto_spawn_tfm(struct crypto_spawn *spawn, u32 type,
657 struct crypto_alg *alg;
658 struct crypto_tfm *tfm;
660 alg = crypto_spawn_alg(spawn);
662 return ERR_CAST(alg);
664 tfm = ERR_PTR(-EINVAL);
665 if (unlikely((alg->cra_flags ^ type) & mask))
668 tfm = __crypto_alloc_tfm(alg, type, mask);
678 EXPORT_SYMBOL_GPL(crypto_spawn_tfm);
680 void *crypto_spawn_tfm2(struct crypto_spawn *spawn)
682 struct crypto_alg *alg;
683 struct crypto_tfm *tfm;
685 alg = crypto_spawn_alg(spawn);
687 return ERR_CAST(alg);
689 tfm = crypto_create_tfm(alg, spawn->frontend);
699 EXPORT_SYMBOL_GPL(crypto_spawn_tfm2);
701 int crypto_register_notifier(struct notifier_block *nb)
703 return blocking_notifier_chain_register(&crypto_chain, nb);
705 EXPORT_SYMBOL_GPL(crypto_register_notifier);
707 int crypto_unregister_notifier(struct notifier_block *nb)
709 return blocking_notifier_chain_unregister(&crypto_chain, nb);
711 EXPORT_SYMBOL_GPL(crypto_unregister_notifier);
713 struct crypto_attr_type *crypto_get_attr_type(struct rtattr **tb)
715 struct rtattr *rta = tb[0];
716 struct crypto_attr_type *algt;
719 return ERR_PTR(-ENOENT);
720 if (RTA_PAYLOAD(rta) < sizeof(*algt))
721 return ERR_PTR(-EINVAL);
722 if (rta->rta_type != CRYPTOA_TYPE)
723 return ERR_PTR(-EINVAL);
725 algt = RTA_DATA(rta);
729 EXPORT_SYMBOL_GPL(crypto_get_attr_type);
731 int crypto_check_attr_type(struct rtattr **tb, u32 type)
733 struct crypto_attr_type *algt;
735 algt = crypto_get_attr_type(tb);
737 return PTR_ERR(algt);
739 if ((algt->type ^ type) & algt->mask)
744 EXPORT_SYMBOL_GPL(crypto_check_attr_type);
746 const char *crypto_attr_alg_name(struct rtattr *rta)
748 struct crypto_attr_alg *alga;
751 return ERR_PTR(-ENOENT);
752 if (RTA_PAYLOAD(rta) < sizeof(*alga))
753 return ERR_PTR(-EINVAL);
754 if (rta->rta_type != CRYPTOA_ALG)
755 return ERR_PTR(-EINVAL);
757 alga = RTA_DATA(rta);
758 alga->name[CRYPTO_MAX_ALG_NAME - 1] = 0;
762 EXPORT_SYMBOL_GPL(crypto_attr_alg_name);
764 struct crypto_alg *crypto_attr_alg2(struct rtattr *rta,
765 const struct crypto_type *frontend,
771 name = crypto_attr_alg_name(rta);
776 return crypto_find_alg(name, frontend, type, mask);
778 EXPORT_SYMBOL_GPL(crypto_attr_alg2);
780 int crypto_attr_u32(struct rtattr *rta, u32 *num)
782 struct crypto_attr_u32 *nu32;
786 if (RTA_PAYLOAD(rta) < sizeof(*nu32))
788 if (rta->rta_type != CRYPTOA_U32)
791 nu32 = RTA_DATA(rta);
796 EXPORT_SYMBOL_GPL(crypto_attr_u32);
798 void *crypto_alloc_instance2(const char *name, struct crypto_alg *alg,
801 struct crypto_instance *inst;
805 p = kzalloc(head + sizeof(*inst) + sizeof(struct crypto_spawn),
808 return ERR_PTR(-ENOMEM);
810 inst = (void *)(p + head);
813 if (snprintf(inst->alg.cra_name, CRYPTO_MAX_ALG_NAME, "%s(%s)", name,
814 alg->cra_name) >= CRYPTO_MAX_ALG_NAME)
817 if (snprintf(inst->alg.cra_driver_name, CRYPTO_MAX_ALG_NAME, "%s(%s)",
818 name, alg->cra_driver_name) >= CRYPTO_MAX_ALG_NAME)
827 EXPORT_SYMBOL_GPL(crypto_alloc_instance2);
829 struct crypto_instance *crypto_alloc_instance(const char *name,
830 struct crypto_alg *alg)
832 struct crypto_instance *inst;
833 struct crypto_spawn *spawn;
836 inst = crypto_alloc_instance2(name, alg, 0);
840 spawn = crypto_instance_ctx(inst);
841 err = crypto_init_spawn(spawn, alg, inst,
842 CRYPTO_ALG_TYPE_MASK | CRYPTO_ALG_ASYNC);
856 EXPORT_SYMBOL_GPL(crypto_alloc_instance);
858 void crypto_init_queue(struct crypto_queue *queue, unsigned int max_qlen)
860 INIT_LIST_HEAD(&queue->list);
861 queue->backlog = &queue->list;
863 queue->max_qlen = max_qlen;
865 EXPORT_SYMBOL_GPL(crypto_init_queue);
867 int crypto_enqueue_request(struct crypto_queue *queue,
868 struct crypto_async_request *request)
870 int err = -EINPROGRESS;
872 if (unlikely(queue->qlen >= queue->max_qlen)) {
874 if (!(request->flags & CRYPTO_TFM_REQ_MAY_BACKLOG))
876 if (queue->backlog == &queue->list)
877 queue->backlog = &request->list;
881 list_add_tail(&request->list, &queue->list);
886 EXPORT_SYMBOL_GPL(crypto_enqueue_request);
888 void *__crypto_dequeue_request(struct crypto_queue *queue, unsigned int offset)
890 struct list_head *request;
892 if (unlikely(!queue->qlen))
897 if (queue->backlog != &queue->list)
898 queue->backlog = queue->backlog->next;
900 request = queue->list.next;
903 return (char *)list_entry(request, struct crypto_async_request, list) -
906 EXPORT_SYMBOL_GPL(__crypto_dequeue_request);
908 struct crypto_async_request *crypto_dequeue_request(struct crypto_queue *queue)
910 return __crypto_dequeue_request(queue, 0);
912 EXPORT_SYMBOL_GPL(crypto_dequeue_request);
914 int crypto_tfm_in_queue(struct crypto_queue *queue, struct crypto_tfm *tfm)
916 struct crypto_async_request *req;
918 list_for_each_entry(req, &queue->list, list) {
925 EXPORT_SYMBOL_GPL(crypto_tfm_in_queue);
927 static inline void crypto_inc_byte(u8 *a, unsigned int size)
932 for (; size; size--) {
940 void crypto_inc(u8 *a, unsigned int size)
942 __be32 *b = (__be32 *)(a + size);
945 for (; size >= 4; size -= 4) {
946 c = be32_to_cpu(*--b) + 1;
952 crypto_inc_byte(a, size);
954 EXPORT_SYMBOL_GPL(crypto_inc);
956 static inline void crypto_xor_byte(u8 *a, const u8 *b, unsigned int size)
962 void crypto_xor(u8 *dst, const u8 *src, unsigned int size)
967 for (; size >= 4; size -= 4)
970 crypto_xor_byte((u8 *)a, (u8 *)b, size);
972 EXPORT_SYMBOL_GPL(crypto_xor);
974 static int __init crypto_algapi_init(void)
980 static void __exit crypto_algapi_exit(void)
985 module_init(crypto_algapi_init);
986 module_exit(crypto_algapi_exit);
988 MODULE_LICENSE("GPL");
989 MODULE_DESCRIPTION("Cryptographic algorithms API");