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/fips.h>
16 #include <linux/init.h>
17 #include <linux/kernel.h>
18 #include <linux/list.h>
19 #include <linux/module.h>
20 #include <linux/rtnetlink.h>
21 #include <linux/slab.h>
22 #include <linux/string.h>
26 static LIST_HEAD(crypto_template_list);
28 static inline int crypto_set_driver_name(struct crypto_alg *alg)
30 static const char suffix[] = "-generic";
31 char *driver_name = alg->cra_driver_name;
37 len = strlcpy(driver_name, alg->cra_name, CRYPTO_MAX_ALG_NAME);
38 if (len + sizeof(suffix) > CRYPTO_MAX_ALG_NAME)
41 memcpy(driver_name + len, suffix, sizeof(suffix));
45 static inline void crypto_check_module_sig(struct module *mod)
47 if (fips_enabled && mod && !module_sig_ok(mod))
48 panic("Module %s signature verification failed in FIPS mode\n",
52 static int crypto_check_alg(struct crypto_alg *alg)
54 crypto_check_module_sig(alg->cra_module);
56 if (alg->cra_alignmask & (alg->cra_alignmask + 1))
59 if (alg->cra_blocksize > PAGE_SIZE / 8)
62 if (alg->cra_priority < 0)
65 atomic_set(&alg->cra_refcnt, 1);
67 return crypto_set_driver_name(alg);
70 static void crypto_free_instance(struct crypto_instance *inst)
72 if (!inst->alg.cra_type->free) {
73 inst->tmpl->free(inst);
77 inst->alg.cra_type->free(inst);
80 static void crypto_destroy_instance(struct crypto_alg *alg)
82 struct crypto_instance *inst = (void *)alg;
83 struct crypto_template *tmpl = inst->tmpl;
85 crypto_free_instance(inst);
86 crypto_tmpl_put(tmpl);
89 static struct list_head *crypto_more_spawns(struct crypto_alg *alg,
90 struct list_head *stack,
91 struct list_head *top,
92 struct list_head *secondary_spawns)
94 struct crypto_spawn *spawn, *n;
96 if (list_empty(stack))
99 spawn = list_first_entry(stack, struct crypto_spawn, list);
100 n = list_entry(spawn->list.next, struct crypto_spawn, list);
102 if (spawn->alg && &n->list != stack && !n->alg)
103 n->alg = (n->list.next == stack) ? alg :
104 &list_entry(n->list.next, struct crypto_spawn,
107 list_move(&spawn->list, secondary_spawns);
109 return &n->list == stack ? top : &n->inst->alg.cra_users;
112 static void crypto_remove_instance(struct crypto_instance *inst,
113 struct list_head *list)
115 struct crypto_template *tmpl = inst->tmpl;
117 if (crypto_is_dead(&inst->alg))
120 inst->alg.cra_flags |= CRYPTO_ALG_DEAD;
121 if (hlist_unhashed(&inst->list))
124 if (!tmpl || !crypto_tmpl_get(tmpl))
127 crypto_notify(CRYPTO_MSG_ALG_UNREGISTER, &inst->alg);
128 list_move(&inst->alg.cra_list, list);
129 hlist_del(&inst->list);
130 inst->alg.cra_destroy = crypto_destroy_instance;
132 BUG_ON(!list_empty(&inst->alg.cra_users));
135 void crypto_remove_spawns(struct crypto_alg *alg, struct list_head *list,
136 struct crypto_alg *nalg)
138 u32 new_type = (nalg ?: alg)->cra_flags;
139 struct crypto_spawn *spawn, *n;
140 LIST_HEAD(secondary_spawns);
141 struct list_head *spawns;
145 spawns = &alg->cra_users;
146 list_for_each_entry_safe(spawn, n, spawns, list) {
147 if ((spawn->alg->cra_flags ^ new_type) & spawn->mask)
150 list_move(&spawn->list, &top);
155 while (!list_empty(spawns)) {
156 struct crypto_instance *inst;
158 spawn = list_first_entry(spawns, struct crypto_spawn,
162 BUG_ON(&inst->alg == alg);
164 list_move(&spawn->list, &stack);
166 if (&inst->alg == nalg)
170 spawns = &inst->alg.cra_users;
172 } while ((spawns = crypto_more_spawns(alg, &stack, &top,
173 &secondary_spawns)));
175 list_for_each_entry_safe(spawn, n, &secondary_spawns, list) {
177 list_move(&spawn->list, &spawn->alg->cra_users);
179 crypto_remove_instance(spawn->inst, list);
182 EXPORT_SYMBOL_GPL(crypto_remove_spawns);
184 static struct crypto_larval *__crypto_register_alg(struct crypto_alg *alg)
186 struct crypto_alg *q;
187 struct crypto_larval *larval;
190 if (crypto_is_dead(alg))
193 INIT_LIST_HEAD(&alg->cra_users);
196 alg->cra_flags &= ~CRYPTO_ALG_TESTED;
200 list_for_each_entry(q, &crypto_alg_list, cra_list) {
204 if (crypto_is_moribund(q))
207 if (crypto_is_larval(q)) {
208 if (!strcmp(alg->cra_driver_name, q->cra_driver_name))
213 if (!strcmp(q->cra_driver_name, alg->cra_name) ||
214 !strcmp(q->cra_name, alg->cra_driver_name))
218 larval = crypto_larval_alloc(alg->cra_name,
219 alg->cra_flags | CRYPTO_ALG_TESTED, 0);
224 larval->adult = crypto_mod_get(alg);
228 atomic_set(&larval->alg.cra_refcnt, 1);
229 memcpy(larval->alg.cra_driver_name, alg->cra_driver_name,
230 CRYPTO_MAX_ALG_NAME);
231 larval->alg.cra_priority = alg->cra_priority;
233 list_add(&alg->cra_list, &crypto_alg_list);
234 list_add(&larval->alg.cra_list, &crypto_alg_list);
242 larval = ERR_PTR(ret);
246 void crypto_alg_tested(const char *name, int err)
248 struct crypto_larval *test;
249 struct crypto_alg *alg;
250 struct crypto_alg *q;
253 down_write(&crypto_alg_sem);
254 list_for_each_entry(q, &crypto_alg_list, cra_list) {
255 if (crypto_is_moribund(q) || !crypto_is_larval(q))
258 test = (struct crypto_larval *)q;
260 if (!strcmp(q->cra_driver_name, name))
264 printk(KERN_ERR "alg: Unexpected test result for %s: %d\n", name, err);
268 q->cra_flags |= CRYPTO_ALG_DEAD;
270 if (err || list_empty(&alg->cra_list))
273 alg->cra_flags |= CRYPTO_ALG_TESTED;
275 list_for_each_entry(q, &crypto_alg_list, cra_list) {
279 if (crypto_is_moribund(q))
282 if (crypto_is_larval(q)) {
283 struct crypto_larval *larval = (void *)q;
286 * Check to see if either our generic name or
287 * specific name can satisfy the name requested
288 * by the larval entry q.
290 if (strcmp(alg->cra_name, q->cra_name) &&
291 strcmp(alg->cra_driver_name, q->cra_name))
296 if ((q->cra_flags ^ alg->cra_flags) & larval->mask)
298 if (!crypto_mod_get(alg))
305 if (strcmp(alg->cra_name, q->cra_name))
308 if (strcmp(alg->cra_driver_name, q->cra_driver_name) &&
309 q->cra_priority > alg->cra_priority)
312 crypto_remove_spawns(q, &list, alg);
316 complete_all(&test->completion);
319 up_write(&crypto_alg_sem);
321 crypto_remove_final(&list);
323 EXPORT_SYMBOL_GPL(crypto_alg_tested);
325 void crypto_remove_final(struct list_head *list)
327 struct crypto_alg *alg;
328 struct crypto_alg *n;
330 list_for_each_entry_safe(alg, n, list, cra_list) {
331 list_del_init(&alg->cra_list);
335 EXPORT_SYMBOL_GPL(crypto_remove_final);
337 static void crypto_wait_for_test(struct crypto_larval *larval)
341 err = crypto_probing_notify(CRYPTO_MSG_ALG_REGISTER, larval->adult);
342 if (err != NOTIFY_STOP) {
343 if (WARN_ON(err != NOTIFY_DONE))
345 crypto_alg_tested(larval->alg.cra_driver_name, 0);
348 err = wait_for_completion_interruptible(&larval->completion);
352 crypto_larval_kill(&larval->alg);
355 int crypto_register_alg(struct crypto_alg *alg)
357 struct crypto_larval *larval;
360 err = crypto_check_alg(alg);
364 down_write(&crypto_alg_sem);
365 larval = __crypto_register_alg(alg);
366 up_write(&crypto_alg_sem);
369 return PTR_ERR(larval);
371 crypto_wait_for_test(larval);
374 EXPORT_SYMBOL_GPL(crypto_register_alg);
376 static int crypto_remove_alg(struct crypto_alg *alg, struct list_head *list)
378 if (unlikely(list_empty(&alg->cra_list)))
381 alg->cra_flags |= CRYPTO_ALG_DEAD;
383 crypto_notify(CRYPTO_MSG_ALG_UNREGISTER, alg);
384 list_del_init(&alg->cra_list);
385 crypto_remove_spawns(alg, list, NULL);
390 int crypto_unregister_alg(struct crypto_alg *alg)
395 down_write(&crypto_alg_sem);
396 ret = crypto_remove_alg(alg, &list);
397 up_write(&crypto_alg_sem);
402 BUG_ON(atomic_read(&alg->cra_refcnt) != 1);
403 if (alg->cra_destroy)
404 alg->cra_destroy(alg);
406 crypto_remove_final(&list);
409 EXPORT_SYMBOL_GPL(crypto_unregister_alg);
411 int crypto_register_algs(struct crypto_alg *algs, int count)
415 for (i = 0; i < count; i++) {
416 ret = crypto_register_alg(&algs[i]);
424 for (--i; i >= 0; --i)
425 crypto_unregister_alg(&algs[i]);
429 EXPORT_SYMBOL_GPL(crypto_register_algs);
431 int crypto_unregister_algs(struct crypto_alg *algs, int count)
435 for (i = 0; i < count; i++) {
436 ret = crypto_unregister_alg(&algs[i]);
438 pr_err("Failed to unregister %s %s: %d\n",
439 algs[i].cra_driver_name, algs[i].cra_name, ret);
444 EXPORT_SYMBOL_GPL(crypto_unregister_algs);
446 int crypto_register_template(struct crypto_template *tmpl)
448 struct crypto_template *q;
451 down_write(&crypto_alg_sem);
453 crypto_check_module_sig(tmpl->module);
455 list_for_each_entry(q, &crypto_template_list, list) {
460 list_add(&tmpl->list, &crypto_template_list);
461 crypto_notify(CRYPTO_MSG_TMPL_REGISTER, tmpl);
464 up_write(&crypto_alg_sem);
467 EXPORT_SYMBOL_GPL(crypto_register_template);
469 void crypto_unregister_template(struct crypto_template *tmpl)
471 struct crypto_instance *inst;
472 struct hlist_node *n;
473 struct hlist_head *list;
476 down_write(&crypto_alg_sem);
478 BUG_ON(list_empty(&tmpl->list));
479 list_del_init(&tmpl->list);
481 list = &tmpl->instances;
482 hlist_for_each_entry(inst, list, list) {
483 int err = crypto_remove_alg(&inst->alg, &users);
488 crypto_notify(CRYPTO_MSG_TMPL_UNREGISTER, tmpl);
490 up_write(&crypto_alg_sem);
492 hlist_for_each_entry_safe(inst, n, list, list) {
493 BUG_ON(atomic_read(&inst->alg.cra_refcnt) != 1);
494 crypto_free_instance(inst);
496 crypto_remove_final(&users);
498 EXPORT_SYMBOL_GPL(crypto_unregister_template);
500 static struct crypto_template *__crypto_lookup_template(const char *name)
502 struct crypto_template *q, *tmpl = NULL;
504 down_read(&crypto_alg_sem);
505 list_for_each_entry(q, &crypto_template_list, list) {
506 if (strcmp(q->name, name))
508 if (unlikely(!crypto_tmpl_get(q)))
514 up_read(&crypto_alg_sem);
519 struct crypto_template *crypto_lookup_template(const char *name)
521 return try_then_request_module(__crypto_lookup_template(name),
524 EXPORT_SYMBOL_GPL(crypto_lookup_template);
526 int crypto_register_instance(struct crypto_template *tmpl,
527 struct crypto_instance *inst)
529 struct crypto_larval *larval;
532 err = crypto_check_alg(&inst->alg);
536 inst->alg.cra_module = tmpl->module;
537 inst->alg.cra_flags |= CRYPTO_ALG_INSTANCE;
539 if (unlikely(!crypto_mod_get(&inst->alg)))
542 down_write(&crypto_alg_sem);
544 larval = __crypto_register_alg(&inst->alg);
548 hlist_add_head(&inst->list, &tmpl->instances);
552 up_write(&crypto_alg_sem);
554 err = PTR_ERR(larval);
558 crypto_wait_for_test(larval);
560 /* Remove instance if test failed */
561 if (!(inst->alg.cra_flags & CRYPTO_ALG_TESTED))
562 crypto_unregister_instance(inst);
566 crypto_mod_put(&inst->alg);
569 EXPORT_SYMBOL_GPL(crypto_register_instance);
571 int crypto_unregister_instance(struct crypto_instance *inst)
575 down_write(&crypto_alg_sem);
577 crypto_remove_spawns(&inst->alg, &list, NULL);
578 crypto_remove_instance(inst, &list);
580 up_write(&crypto_alg_sem);
582 crypto_remove_final(&list);
586 EXPORT_SYMBOL_GPL(crypto_unregister_instance);
588 int crypto_init_spawn(struct crypto_spawn *spawn, struct crypto_alg *alg,
589 struct crypto_instance *inst, u32 mask)
596 down_write(&crypto_alg_sem);
597 if (!crypto_is_moribund(alg)) {
598 list_add(&spawn->list, &alg->cra_users);
602 up_write(&crypto_alg_sem);
606 EXPORT_SYMBOL_GPL(crypto_init_spawn);
608 int crypto_init_spawn2(struct crypto_spawn *spawn, struct crypto_alg *alg,
609 struct crypto_instance *inst,
610 const struct crypto_type *frontend)
614 if ((alg->cra_flags ^ frontend->type) & frontend->maskset)
617 spawn->frontend = frontend;
618 err = crypto_init_spawn(spawn, alg, inst, frontend->maskset);
623 EXPORT_SYMBOL_GPL(crypto_init_spawn2);
625 int crypto_grab_spawn(struct crypto_spawn *spawn, const char *name,
628 struct crypto_alg *alg;
631 alg = crypto_find_alg(name, spawn->frontend, type, mask);
635 err = crypto_init_spawn(spawn, alg, spawn->inst, mask);
639 EXPORT_SYMBOL_GPL(crypto_grab_spawn);
641 void crypto_drop_spawn(struct crypto_spawn *spawn)
646 down_write(&crypto_alg_sem);
647 list_del(&spawn->list);
648 up_write(&crypto_alg_sem);
650 EXPORT_SYMBOL_GPL(crypto_drop_spawn);
652 static struct crypto_alg *crypto_spawn_alg(struct crypto_spawn *spawn)
654 struct crypto_alg *alg;
655 struct crypto_alg *alg2;
657 down_read(&crypto_alg_sem);
661 alg2 = crypto_mod_get(alg2);
662 up_read(&crypto_alg_sem);
666 crypto_shoot_alg(alg);
667 return ERR_PTR(-EAGAIN);
673 struct crypto_tfm *crypto_spawn_tfm(struct crypto_spawn *spawn, u32 type,
676 struct crypto_alg *alg;
677 struct crypto_tfm *tfm;
679 alg = crypto_spawn_alg(spawn);
681 return ERR_CAST(alg);
683 tfm = ERR_PTR(-EINVAL);
684 if (unlikely((alg->cra_flags ^ type) & mask))
687 tfm = __crypto_alloc_tfm(alg, type, mask);
697 EXPORT_SYMBOL_GPL(crypto_spawn_tfm);
699 void *crypto_spawn_tfm2(struct crypto_spawn *spawn)
701 struct crypto_alg *alg;
702 struct crypto_tfm *tfm;
704 alg = crypto_spawn_alg(spawn);
706 return ERR_CAST(alg);
708 tfm = crypto_create_tfm(alg, spawn->frontend);
718 EXPORT_SYMBOL_GPL(crypto_spawn_tfm2);
720 int crypto_register_notifier(struct notifier_block *nb)
722 return blocking_notifier_chain_register(&crypto_chain, nb);
724 EXPORT_SYMBOL_GPL(crypto_register_notifier);
726 int crypto_unregister_notifier(struct notifier_block *nb)
728 return blocking_notifier_chain_unregister(&crypto_chain, nb);
730 EXPORT_SYMBOL_GPL(crypto_unregister_notifier);
732 struct crypto_attr_type *crypto_get_attr_type(struct rtattr **tb)
734 struct rtattr *rta = tb[0];
735 struct crypto_attr_type *algt;
738 return ERR_PTR(-ENOENT);
739 if (RTA_PAYLOAD(rta) < sizeof(*algt))
740 return ERR_PTR(-EINVAL);
741 if (rta->rta_type != CRYPTOA_TYPE)
742 return ERR_PTR(-EINVAL);
744 algt = RTA_DATA(rta);
748 EXPORT_SYMBOL_GPL(crypto_get_attr_type);
750 int crypto_check_attr_type(struct rtattr **tb, u32 type)
752 struct crypto_attr_type *algt;
754 algt = crypto_get_attr_type(tb);
756 return PTR_ERR(algt);
758 if ((algt->type ^ type) & algt->mask)
763 EXPORT_SYMBOL_GPL(crypto_check_attr_type);
765 const char *crypto_attr_alg_name(struct rtattr *rta)
767 struct crypto_attr_alg *alga;
770 return ERR_PTR(-ENOENT);
771 if (RTA_PAYLOAD(rta) < sizeof(*alga))
772 return ERR_PTR(-EINVAL);
773 if (rta->rta_type != CRYPTOA_ALG)
774 return ERR_PTR(-EINVAL);
776 alga = RTA_DATA(rta);
777 alga->name[CRYPTO_MAX_ALG_NAME - 1] = 0;
781 EXPORT_SYMBOL_GPL(crypto_attr_alg_name);
783 struct crypto_alg *crypto_attr_alg2(struct rtattr *rta,
784 const struct crypto_type *frontend,
789 name = crypto_attr_alg_name(rta);
791 return ERR_CAST(name);
793 return crypto_find_alg(name, frontend, type, mask);
795 EXPORT_SYMBOL_GPL(crypto_attr_alg2);
797 int crypto_attr_u32(struct rtattr *rta, u32 *num)
799 struct crypto_attr_u32 *nu32;
803 if (RTA_PAYLOAD(rta) < sizeof(*nu32))
805 if (rta->rta_type != CRYPTOA_U32)
808 nu32 = RTA_DATA(rta);
813 EXPORT_SYMBOL_GPL(crypto_attr_u32);
815 void *crypto_alloc_instance2(const char *name, struct crypto_alg *alg,
818 struct crypto_instance *inst;
822 p = kzalloc(head + sizeof(*inst) + sizeof(struct crypto_spawn),
825 return ERR_PTR(-ENOMEM);
827 inst = (void *)(p + head);
830 if (snprintf(inst->alg.cra_name, CRYPTO_MAX_ALG_NAME, "%s(%s)", name,
831 alg->cra_name) >= CRYPTO_MAX_ALG_NAME)
834 if (snprintf(inst->alg.cra_driver_name, CRYPTO_MAX_ALG_NAME, "%s(%s)",
835 name, alg->cra_driver_name) >= CRYPTO_MAX_ALG_NAME)
844 EXPORT_SYMBOL_GPL(crypto_alloc_instance2);
846 struct crypto_instance *crypto_alloc_instance(const char *name,
847 struct crypto_alg *alg)
849 struct crypto_instance *inst;
850 struct crypto_spawn *spawn;
853 inst = crypto_alloc_instance2(name, alg, 0);
857 spawn = crypto_instance_ctx(inst);
858 err = crypto_init_spawn(spawn, alg, inst,
859 CRYPTO_ALG_TYPE_MASK | CRYPTO_ALG_ASYNC);
873 EXPORT_SYMBOL_GPL(crypto_alloc_instance);
875 void crypto_init_queue(struct crypto_queue *queue, unsigned int max_qlen)
877 INIT_LIST_HEAD(&queue->list);
878 queue->backlog = &queue->list;
880 queue->max_qlen = max_qlen;
882 EXPORT_SYMBOL_GPL(crypto_init_queue);
884 int crypto_enqueue_request(struct crypto_queue *queue,
885 struct crypto_async_request *request)
887 int err = -EINPROGRESS;
889 if (unlikely(queue->qlen >= queue->max_qlen)) {
891 if (!(request->flags & CRYPTO_TFM_REQ_MAY_BACKLOG))
893 if (queue->backlog == &queue->list)
894 queue->backlog = &request->list;
898 list_add_tail(&request->list, &queue->list);
903 EXPORT_SYMBOL_GPL(crypto_enqueue_request);
905 struct crypto_async_request *crypto_dequeue_request(struct crypto_queue *queue)
907 struct list_head *request;
909 if (unlikely(!queue->qlen))
914 if (queue->backlog != &queue->list)
915 queue->backlog = queue->backlog->next;
917 request = queue->list.next;
920 return list_entry(request, struct crypto_async_request, list);
922 EXPORT_SYMBOL_GPL(crypto_dequeue_request);
924 int crypto_tfm_in_queue(struct crypto_queue *queue, struct crypto_tfm *tfm)
926 struct crypto_async_request *req;
928 list_for_each_entry(req, &queue->list, list) {
935 EXPORT_SYMBOL_GPL(crypto_tfm_in_queue);
937 static inline void crypto_inc_byte(u8 *a, unsigned int size)
942 for (; size; size--) {
950 void crypto_inc(u8 *a, unsigned int size)
952 __be32 *b = (__be32 *)(a + size);
955 for (; size >= 4; size -= 4) {
956 c = be32_to_cpu(*--b) + 1;
962 crypto_inc_byte(a, size);
964 EXPORT_SYMBOL_GPL(crypto_inc);
966 static inline void crypto_xor_byte(u8 *a, const u8 *b, unsigned int size)
972 void crypto_xor(u8 *dst, const u8 *src, unsigned int size)
977 for (; size >= 4; size -= 4)
980 crypto_xor_byte((u8 *)a, (u8 *)b, size);
982 EXPORT_SYMBOL_GPL(crypto_xor);
984 unsigned int crypto_alg_extsize(struct crypto_alg *alg)
986 return alg->cra_ctxsize +
987 (alg->cra_alignmask & ~(crypto_tfm_ctx_alignment() - 1));
989 EXPORT_SYMBOL_GPL(crypto_alg_extsize);
991 static int __init crypto_algapi_init(void)
997 static void __exit crypto_algapi_exit(void)
1002 module_init(crypto_algapi_init);
1003 module_exit(crypto_algapi_exit);
1005 MODULE_LICENSE("GPL");
1006 MODULE_DESCRIPTION("Cryptographic algorithms API");