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;
173 * We may encounter an unregistered instance here, since
174 * an instance's spawns are set up prior to the instance
175 * being registered. An unregistered instance will have
176 * NULL ->cra_users.next, since ->cra_users isn't
177 * properly initialized until registration. But an
178 * unregistered instance cannot have any users, so treat
179 * it the same as ->cra_users being empty.
181 if (spawns->next == NULL)
184 } while ((spawns = crypto_more_spawns(alg, &stack, &top,
185 &secondary_spawns)));
187 list_for_each_entry_safe(spawn, n, &secondary_spawns, list) {
189 list_move(&spawn->list, &spawn->alg->cra_users);
191 crypto_remove_instance(spawn->inst, list);
194 EXPORT_SYMBOL_GPL(crypto_remove_spawns);
196 static struct crypto_larval *__crypto_register_alg(struct crypto_alg *alg)
198 struct crypto_alg *q;
199 struct crypto_larval *larval;
202 if (crypto_is_dead(alg))
205 INIT_LIST_HEAD(&alg->cra_users);
208 alg->cra_flags &= ~CRYPTO_ALG_TESTED;
212 list_for_each_entry(q, &crypto_alg_list, cra_list) {
216 if (crypto_is_moribund(q))
219 if (crypto_is_larval(q)) {
220 if (!strcmp(alg->cra_driver_name, q->cra_driver_name))
225 if (!strcmp(q->cra_driver_name, alg->cra_name) ||
226 !strcmp(q->cra_name, alg->cra_driver_name))
230 larval = crypto_larval_alloc(alg->cra_name,
231 alg->cra_flags | CRYPTO_ALG_TESTED, 0);
236 larval->adult = crypto_mod_get(alg);
240 atomic_set(&larval->alg.cra_refcnt, 1);
241 memcpy(larval->alg.cra_driver_name, alg->cra_driver_name,
242 CRYPTO_MAX_ALG_NAME);
243 larval->alg.cra_priority = alg->cra_priority;
245 list_add(&alg->cra_list, &crypto_alg_list);
246 list_add(&larval->alg.cra_list, &crypto_alg_list);
254 larval = ERR_PTR(ret);
258 void crypto_alg_tested(const char *name, int err)
260 struct crypto_larval *test;
261 struct crypto_alg *alg;
262 struct crypto_alg *q;
265 down_write(&crypto_alg_sem);
266 list_for_each_entry(q, &crypto_alg_list, cra_list) {
267 if (crypto_is_moribund(q) || !crypto_is_larval(q))
270 test = (struct crypto_larval *)q;
272 if (!strcmp(q->cra_driver_name, name))
276 printk(KERN_ERR "alg: Unexpected test result for %s: %d\n", name, err);
280 q->cra_flags |= CRYPTO_ALG_DEAD;
282 if (err || list_empty(&alg->cra_list))
285 alg->cra_flags |= CRYPTO_ALG_TESTED;
287 list_for_each_entry(q, &crypto_alg_list, cra_list) {
291 if (crypto_is_moribund(q))
294 if (crypto_is_larval(q)) {
295 struct crypto_larval *larval = (void *)q;
298 * Check to see if either our generic name or
299 * specific name can satisfy the name requested
300 * by the larval entry q.
302 if (strcmp(alg->cra_name, q->cra_name) &&
303 strcmp(alg->cra_driver_name, q->cra_name))
308 if ((q->cra_flags ^ alg->cra_flags) & larval->mask)
310 if (!crypto_mod_get(alg))
317 if (strcmp(alg->cra_name, q->cra_name))
320 if (strcmp(alg->cra_driver_name, q->cra_driver_name) &&
321 q->cra_priority > alg->cra_priority)
324 crypto_remove_spawns(q, &list, alg);
328 complete_all(&test->completion);
331 up_write(&crypto_alg_sem);
333 crypto_remove_final(&list);
335 EXPORT_SYMBOL_GPL(crypto_alg_tested);
337 void crypto_remove_final(struct list_head *list)
339 struct crypto_alg *alg;
340 struct crypto_alg *n;
342 list_for_each_entry_safe(alg, n, list, cra_list) {
343 list_del_init(&alg->cra_list);
347 EXPORT_SYMBOL_GPL(crypto_remove_final);
349 static void crypto_wait_for_test(struct crypto_larval *larval)
353 err = crypto_probing_notify(CRYPTO_MSG_ALG_REGISTER, larval->adult);
354 if (err != NOTIFY_STOP) {
355 if (WARN_ON(err != NOTIFY_DONE))
357 crypto_alg_tested(larval->alg.cra_driver_name, 0);
360 err = wait_for_completion_killable(&larval->completion);
364 crypto_larval_kill(&larval->alg);
367 int crypto_register_alg(struct crypto_alg *alg)
369 struct crypto_larval *larval;
372 alg->cra_flags &= ~CRYPTO_ALG_DEAD;
373 err = crypto_check_alg(alg);
377 down_write(&crypto_alg_sem);
378 larval = __crypto_register_alg(alg);
379 up_write(&crypto_alg_sem);
382 return PTR_ERR(larval);
384 crypto_wait_for_test(larval);
387 EXPORT_SYMBOL_GPL(crypto_register_alg);
389 static int crypto_remove_alg(struct crypto_alg *alg, struct list_head *list)
391 if (unlikely(list_empty(&alg->cra_list)))
394 alg->cra_flags |= CRYPTO_ALG_DEAD;
396 crypto_notify(CRYPTO_MSG_ALG_UNREGISTER, alg);
397 list_del_init(&alg->cra_list);
398 crypto_remove_spawns(alg, list, NULL);
403 int crypto_unregister_alg(struct crypto_alg *alg)
408 down_write(&crypto_alg_sem);
409 ret = crypto_remove_alg(alg, &list);
410 up_write(&crypto_alg_sem);
415 BUG_ON(atomic_read(&alg->cra_refcnt) != 1);
416 if (alg->cra_destroy)
417 alg->cra_destroy(alg);
419 crypto_remove_final(&list);
422 EXPORT_SYMBOL_GPL(crypto_unregister_alg);
424 int crypto_register_algs(struct crypto_alg *algs, int count)
428 for (i = 0; i < count; i++) {
429 ret = crypto_register_alg(&algs[i]);
437 for (--i; i >= 0; --i)
438 crypto_unregister_alg(&algs[i]);
442 EXPORT_SYMBOL_GPL(crypto_register_algs);
444 int crypto_unregister_algs(struct crypto_alg *algs, int count)
448 for (i = 0; i < count; i++) {
449 ret = crypto_unregister_alg(&algs[i]);
451 pr_err("Failed to unregister %s %s: %d\n",
452 algs[i].cra_driver_name, algs[i].cra_name, ret);
457 EXPORT_SYMBOL_GPL(crypto_unregister_algs);
459 int crypto_register_template(struct crypto_template *tmpl)
461 struct crypto_template *q;
464 down_write(&crypto_alg_sem);
466 crypto_check_module_sig(tmpl->module);
468 list_for_each_entry(q, &crypto_template_list, list) {
473 list_add(&tmpl->list, &crypto_template_list);
474 crypto_notify(CRYPTO_MSG_TMPL_REGISTER, tmpl);
477 up_write(&crypto_alg_sem);
480 EXPORT_SYMBOL_GPL(crypto_register_template);
482 void crypto_unregister_template(struct crypto_template *tmpl)
484 struct crypto_instance *inst;
485 struct hlist_node *n;
486 struct hlist_head *list;
489 down_write(&crypto_alg_sem);
491 BUG_ON(list_empty(&tmpl->list));
492 list_del_init(&tmpl->list);
494 list = &tmpl->instances;
495 hlist_for_each_entry(inst, list, list) {
496 int err = crypto_remove_alg(&inst->alg, &users);
501 crypto_notify(CRYPTO_MSG_TMPL_UNREGISTER, tmpl);
503 up_write(&crypto_alg_sem);
505 hlist_for_each_entry_safe(inst, n, list, list) {
506 BUG_ON(atomic_read(&inst->alg.cra_refcnt) != 1);
507 crypto_free_instance(inst);
509 crypto_remove_final(&users);
511 EXPORT_SYMBOL_GPL(crypto_unregister_template);
513 static struct crypto_template *__crypto_lookup_template(const char *name)
515 struct crypto_template *q, *tmpl = NULL;
517 down_read(&crypto_alg_sem);
518 list_for_each_entry(q, &crypto_template_list, list) {
519 if (strcmp(q->name, name))
521 if (unlikely(!crypto_tmpl_get(q)))
527 up_read(&crypto_alg_sem);
532 struct crypto_template *crypto_lookup_template(const char *name)
534 return try_then_request_module(__crypto_lookup_template(name),
537 EXPORT_SYMBOL_GPL(crypto_lookup_template);
539 int crypto_register_instance(struct crypto_template *tmpl,
540 struct crypto_instance *inst)
542 struct crypto_larval *larval;
545 err = crypto_check_alg(&inst->alg);
549 inst->alg.cra_module = tmpl->module;
550 inst->alg.cra_flags |= CRYPTO_ALG_INSTANCE;
552 if (unlikely(!crypto_mod_get(&inst->alg)))
555 down_write(&crypto_alg_sem);
557 larval = __crypto_register_alg(&inst->alg);
561 hlist_add_head(&inst->list, &tmpl->instances);
565 up_write(&crypto_alg_sem);
567 err = PTR_ERR(larval);
571 crypto_wait_for_test(larval);
573 /* Remove instance if test failed */
574 if (!(inst->alg.cra_flags & CRYPTO_ALG_TESTED))
575 crypto_unregister_instance(inst);
579 crypto_mod_put(&inst->alg);
582 EXPORT_SYMBOL_GPL(crypto_register_instance);
584 int crypto_unregister_instance(struct crypto_instance *inst)
588 down_write(&crypto_alg_sem);
590 crypto_remove_spawns(&inst->alg, &list, NULL);
591 crypto_remove_instance(inst, &list);
593 up_write(&crypto_alg_sem);
595 crypto_remove_final(&list);
599 EXPORT_SYMBOL_GPL(crypto_unregister_instance);
601 int crypto_init_spawn(struct crypto_spawn *spawn, struct crypto_alg *alg,
602 struct crypto_instance *inst, u32 mask)
609 down_write(&crypto_alg_sem);
610 if (!crypto_is_moribund(alg)) {
611 list_add(&spawn->list, &alg->cra_users);
615 up_write(&crypto_alg_sem);
619 EXPORT_SYMBOL_GPL(crypto_init_spawn);
621 int crypto_init_spawn2(struct crypto_spawn *spawn, struct crypto_alg *alg,
622 struct crypto_instance *inst,
623 const struct crypto_type *frontend)
627 if ((alg->cra_flags ^ frontend->type) & frontend->maskset)
630 spawn->frontend = frontend;
631 err = crypto_init_spawn(spawn, alg, inst, frontend->maskset);
636 EXPORT_SYMBOL_GPL(crypto_init_spawn2);
638 int crypto_grab_spawn(struct crypto_spawn *spawn, const char *name,
641 struct crypto_alg *alg;
644 alg = crypto_find_alg(name, spawn->frontend, type, mask);
648 err = crypto_init_spawn(spawn, alg, spawn->inst, mask);
652 EXPORT_SYMBOL_GPL(crypto_grab_spawn);
654 void crypto_drop_spawn(struct crypto_spawn *spawn)
656 down_write(&crypto_alg_sem);
658 list_del(&spawn->list);
659 up_write(&crypto_alg_sem);
661 EXPORT_SYMBOL_GPL(crypto_drop_spawn);
663 static struct crypto_alg *crypto_spawn_alg(struct crypto_spawn *spawn)
665 struct crypto_alg *alg;
667 down_read(&crypto_alg_sem);
669 if (alg && !crypto_mod_get(alg)) {
670 alg->cra_flags |= CRYPTO_ALG_DYING;
673 up_read(&crypto_alg_sem);
675 return alg ?: ERR_PTR(-EAGAIN);
678 struct crypto_tfm *crypto_spawn_tfm(struct crypto_spawn *spawn, u32 type,
681 struct crypto_alg *alg;
682 struct crypto_tfm *tfm;
684 alg = crypto_spawn_alg(spawn);
686 return ERR_CAST(alg);
688 tfm = ERR_PTR(-EINVAL);
689 if (unlikely((alg->cra_flags ^ type) & mask))
692 tfm = __crypto_alloc_tfm(alg, type, mask);
702 EXPORT_SYMBOL_GPL(crypto_spawn_tfm);
704 void *crypto_spawn_tfm2(struct crypto_spawn *spawn)
706 struct crypto_alg *alg;
707 struct crypto_tfm *tfm;
709 alg = crypto_spawn_alg(spawn);
711 return ERR_CAST(alg);
713 tfm = crypto_create_tfm(alg, spawn->frontend);
723 EXPORT_SYMBOL_GPL(crypto_spawn_tfm2);
725 int crypto_register_notifier(struct notifier_block *nb)
727 return blocking_notifier_chain_register(&crypto_chain, nb);
729 EXPORT_SYMBOL_GPL(crypto_register_notifier);
731 int crypto_unregister_notifier(struct notifier_block *nb)
733 return blocking_notifier_chain_unregister(&crypto_chain, nb);
735 EXPORT_SYMBOL_GPL(crypto_unregister_notifier);
737 struct crypto_attr_type *crypto_get_attr_type(struct rtattr **tb)
739 struct rtattr *rta = tb[0];
740 struct crypto_attr_type *algt;
743 return ERR_PTR(-ENOENT);
744 if (RTA_PAYLOAD(rta) < sizeof(*algt))
745 return ERR_PTR(-EINVAL);
746 if (rta->rta_type != CRYPTOA_TYPE)
747 return ERR_PTR(-EINVAL);
749 algt = RTA_DATA(rta);
753 EXPORT_SYMBOL_GPL(crypto_get_attr_type);
755 int crypto_check_attr_type(struct rtattr **tb, u32 type)
757 struct crypto_attr_type *algt;
759 algt = crypto_get_attr_type(tb);
761 return PTR_ERR(algt);
763 if ((algt->type ^ type) & algt->mask)
768 EXPORT_SYMBOL_GPL(crypto_check_attr_type);
770 const char *crypto_attr_alg_name(struct rtattr *rta)
772 struct crypto_attr_alg *alga;
775 return ERR_PTR(-ENOENT);
776 if (RTA_PAYLOAD(rta) < sizeof(*alga))
777 return ERR_PTR(-EINVAL);
778 if (rta->rta_type != CRYPTOA_ALG)
779 return ERR_PTR(-EINVAL);
781 alga = RTA_DATA(rta);
782 alga->name[CRYPTO_MAX_ALG_NAME - 1] = 0;
786 EXPORT_SYMBOL_GPL(crypto_attr_alg_name);
788 struct crypto_alg *crypto_attr_alg2(struct rtattr *rta,
789 const struct crypto_type *frontend,
794 name = crypto_attr_alg_name(rta);
796 return ERR_CAST(name);
798 return crypto_find_alg(name, frontend, type, mask);
800 EXPORT_SYMBOL_GPL(crypto_attr_alg2);
802 int crypto_attr_u32(struct rtattr *rta, u32 *num)
804 struct crypto_attr_u32 *nu32;
808 if (RTA_PAYLOAD(rta) < sizeof(*nu32))
810 if (rta->rta_type != CRYPTOA_U32)
813 nu32 = RTA_DATA(rta);
818 EXPORT_SYMBOL_GPL(crypto_attr_u32);
820 void *crypto_alloc_instance2(const char *name, struct crypto_alg *alg,
823 struct crypto_instance *inst;
827 p = kzalloc(head + sizeof(*inst) + sizeof(struct crypto_spawn),
830 return ERR_PTR(-ENOMEM);
832 inst = (void *)(p + head);
835 if (snprintf(inst->alg.cra_name, CRYPTO_MAX_ALG_NAME, "%s(%s)", name,
836 alg->cra_name) >= CRYPTO_MAX_ALG_NAME)
839 if (snprintf(inst->alg.cra_driver_name, CRYPTO_MAX_ALG_NAME, "%s(%s)",
840 name, alg->cra_driver_name) >= CRYPTO_MAX_ALG_NAME)
849 EXPORT_SYMBOL_GPL(crypto_alloc_instance2);
851 struct crypto_instance *crypto_alloc_instance(const char *name,
852 struct crypto_alg *alg)
854 struct crypto_instance *inst;
855 struct crypto_spawn *spawn;
858 inst = crypto_alloc_instance2(name, alg, 0);
862 spawn = crypto_instance_ctx(inst);
863 err = crypto_init_spawn(spawn, alg, inst,
864 CRYPTO_ALG_TYPE_MASK | CRYPTO_ALG_ASYNC);
878 EXPORT_SYMBOL_GPL(crypto_alloc_instance);
880 void crypto_init_queue(struct crypto_queue *queue, unsigned int max_qlen)
882 INIT_LIST_HEAD(&queue->list);
883 queue->backlog = &queue->list;
885 queue->max_qlen = max_qlen;
887 EXPORT_SYMBOL_GPL(crypto_init_queue);
889 int crypto_enqueue_request(struct crypto_queue *queue,
890 struct crypto_async_request *request)
892 int err = -EINPROGRESS;
894 if (unlikely(queue->qlen >= queue->max_qlen)) {
896 if (!(request->flags & CRYPTO_TFM_REQ_MAY_BACKLOG))
898 if (queue->backlog == &queue->list)
899 queue->backlog = &request->list;
903 list_add_tail(&request->list, &queue->list);
908 EXPORT_SYMBOL_GPL(crypto_enqueue_request);
910 struct crypto_async_request *crypto_dequeue_request(struct crypto_queue *queue)
912 struct list_head *request;
914 if (unlikely(!queue->qlen))
919 if (queue->backlog != &queue->list)
920 queue->backlog = queue->backlog->next;
922 request = queue->list.next;
925 return list_entry(request, struct crypto_async_request, list);
927 EXPORT_SYMBOL_GPL(crypto_dequeue_request);
929 int crypto_tfm_in_queue(struct crypto_queue *queue, struct crypto_tfm *tfm)
931 struct crypto_async_request *req;
933 list_for_each_entry(req, &queue->list, list) {
940 EXPORT_SYMBOL_GPL(crypto_tfm_in_queue);
942 static inline void crypto_inc_byte(u8 *a, unsigned int size)
947 for (; size; size--) {
955 void crypto_inc(u8 *a, unsigned int size)
957 __be32 *b = (__be32 *)(a + size);
960 for (; size >= 4; size -= 4) {
961 c = be32_to_cpu(*--b) + 1;
967 crypto_inc_byte(a, size);
969 EXPORT_SYMBOL_GPL(crypto_inc);
971 static inline void crypto_xor_byte(u8 *a, const u8 *b, unsigned int size)
977 void crypto_xor(u8 *dst, const u8 *src, unsigned int size)
982 for (; size >= 4; size -= 4)
985 crypto_xor_byte((u8 *)a, (u8 *)b, size);
987 EXPORT_SYMBOL_GPL(crypto_xor);
989 unsigned int crypto_alg_extsize(struct crypto_alg *alg)
991 return alg->cra_ctxsize +
992 (alg->cra_alignmask & ~(crypto_tfm_ctx_alignment() - 1));
994 EXPORT_SYMBOL_GPL(crypto_alg_extsize);
996 static int __init crypto_algapi_init(void)
1002 static void __exit crypto_algapi_exit(void)
1007 module_init(crypto_algapi_init);
1008 module_exit(crypto_algapi_exit);
1010 MODULE_LICENSE("GPL");
1011 MODULE_DESCRIPTION("Cryptographic algorithms API");