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 static inline int crypto_set_driver_name(struct crypto_alg *alg)
29 static const char suffix[] = "-generic";
30 char *driver_name = alg->cra_driver_name;
36 len = strlcpy(driver_name, alg->cra_name, CRYPTO_MAX_ALG_NAME);
37 if (len + sizeof(suffix) > CRYPTO_MAX_ALG_NAME)
40 memcpy(driver_name + len, suffix, sizeof(suffix));
44 static inline void crypto_check_module_sig(struct module *mod)
46 if (fips_enabled && mod && !module_sig_ok(mod))
47 panic("Module %s signature verification failed in FIPS mode\n",
51 static int crypto_check_alg(struct crypto_alg *alg)
53 crypto_check_module_sig(alg->cra_module);
55 if (alg->cra_alignmask & (alg->cra_alignmask + 1))
58 if (alg->cra_blocksize > PAGE_SIZE / 8)
61 if (alg->cra_priority < 0)
64 atomic_set(&alg->cra_refcnt, 1);
66 return crypto_set_driver_name(alg);
69 static void crypto_destroy_instance(struct crypto_alg *alg)
71 struct crypto_instance *inst = (void *)alg;
72 struct crypto_template *tmpl = inst->tmpl;
75 crypto_tmpl_put(tmpl);
78 static struct list_head *crypto_more_spawns(struct crypto_alg *alg,
79 struct list_head *stack,
80 struct list_head *top,
81 struct list_head *secondary_spawns)
83 struct crypto_spawn *spawn, *n;
85 if (list_empty(stack))
88 spawn = list_first_entry(stack, struct crypto_spawn, list);
89 n = list_entry(spawn->list.next, struct crypto_spawn, list);
91 if (spawn->alg && &n->list != stack && !n->alg)
92 n->alg = (n->list.next == stack) ? alg :
93 &list_entry(n->list.next, struct crypto_spawn,
96 list_move(&spawn->list, secondary_spawns);
98 return &n->list == stack ? top : &n->inst->alg.cra_users;
101 static void crypto_remove_instance(struct crypto_instance *inst,
102 struct list_head *list)
104 struct crypto_template *tmpl = inst->tmpl;
106 if (crypto_is_dead(&inst->alg))
109 inst->alg.cra_flags |= CRYPTO_ALG_DEAD;
110 if (hlist_unhashed(&inst->list))
113 if (!tmpl || !crypto_tmpl_get(tmpl))
116 crypto_notify(CRYPTO_MSG_ALG_UNREGISTER, &inst->alg);
117 list_move(&inst->alg.cra_list, list);
118 hlist_del(&inst->list);
119 inst->alg.cra_destroy = crypto_destroy_instance;
121 BUG_ON(!list_empty(&inst->alg.cra_users));
124 void crypto_remove_spawns(struct crypto_alg *alg, struct list_head *list,
125 struct crypto_alg *nalg)
127 u32 new_type = (nalg ?: alg)->cra_flags;
128 struct crypto_spawn *spawn, *n;
129 LIST_HEAD(secondary_spawns);
130 struct list_head *spawns;
134 spawns = &alg->cra_users;
135 list_for_each_entry_safe(spawn, n, spawns, list) {
136 if ((spawn->alg->cra_flags ^ new_type) & spawn->mask)
139 list_move(&spawn->list, &top);
144 while (!list_empty(spawns)) {
145 struct crypto_instance *inst;
147 spawn = list_first_entry(spawns, struct crypto_spawn,
151 BUG_ON(&inst->alg == alg);
153 list_move(&spawn->list, &stack);
155 if (&inst->alg == nalg)
159 spawns = &inst->alg.cra_users;
161 } while ((spawns = crypto_more_spawns(alg, &stack, &top,
162 &secondary_spawns)));
164 list_for_each_entry_safe(spawn, n, &secondary_spawns, list) {
166 list_move(&spawn->list, &spawn->alg->cra_users);
168 crypto_remove_instance(spawn->inst, list);
171 EXPORT_SYMBOL_GPL(crypto_remove_spawns);
173 static struct crypto_larval *__crypto_register_alg(struct crypto_alg *alg)
175 struct crypto_alg *q;
176 struct crypto_larval *larval;
179 if (crypto_is_dead(alg))
182 INIT_LIST_HEAD(&alg->cra_users);
185 alg->cra_flags &= ~CRYPTO_ALG_TESTED;
189 list_for_each_entry(q, &crypto_alg_list, cra_list) {
193 if (crypto_is_moribund(q))
196 if (crypto_is_larval(q)) {
197 if (!strcmp(alg->cra_driver_name, q->cra_driver_name))
202 if (!strcmp(q->cra_driver_name, alg->cra_name) ||
203 !strcmp(q->cra_name, alg->cra_driver_name))
207 larval = crypto_larval_alloc(alg->cra_name,
208 alg->cra_flags | CRYPTO_ALG_TESTED, 0);
213 larval->adult = crypto_mod_get(alg);
217 atomic_set(&larval->alg.cra_refcnt, 1);
218 memcpy(larval->alg.cra_driver_name, alg->cra_driver_name,
219 CRYPTO_MAX_ALG_NAME);
220 larval->alg.cra_priority = alg->cra_priority;
222 list_add(&alg->cra_list, &crypto_alg_list);
223 list_add(&larval->alg.cra_list, &crypto_alg_list);
231 larval = ERR_PTR(ret);
235 void crypto_alg_tested(const char *name, int err)
237 struct crypto_larval *test;
238 struct crypto_alg *alg;
239 struct crypto_alg *q;
242 down_write(&crypto_alg_sem);
243 list_for_each_entry(q, &crypto_alg_list, cra_list) {
244 if (crypto_is_moribund(q) || !crypto_is_larval(q))
247 test = (struct crypto_larval *)q;
249 if (!strcmp(q->cra_driver_name, name))
253 printk(KERN_ERR "alg: Unexpected test result for %s: %d\n", name, err);
257 q->cra_flags |= CRYPTO_ALG_DEAD;
259 if (err || list_empty(&alg->cra_list))
262 alg->cra_flags |= CRYPTO_ALG_TESTED;
264 list_for_each_entry(q, &crypto_alg_list, cra_list) {
268 if (crypto_is_moribund(q))
271 if (crypto_is_larval(q)) {
272 struct crypto_larval *larval = (void *)q;
275 * Check to see if either our generic name or
276 * specific name can satisfy the name requested
277 * by the larval entry q.
279 if (strcmp(alg->cra_name, q->cra_name) &&
280 strcmp(alg->cra_driver_name, q->cra_name))
285 if ((q->cra_flags ^ alg->cra_flags) & larval->mask)
287 if (!crypto_mod_get(alg))
294 if (strcmp(alg->cra_name, q->cra_name))
297 if (strcmp(alg->cra_driver_name, q->cra_driver_name) &&
298 q->cra_priority > alg->cra_priority)
301 crypto_remove_spawns(q, &list, alg);
305 complete_all(&test->completion);
308 up_write(&crypto_alg_sem);
310 crypto_remove_final(&list);
312 EXPORT_SYMBOL_GPL(crypto_alg_tested);
314 void crypto_remove_final(struct list_head *list)
316 struct crypto_alg *alg;
317 struct crypto_alg *n;
319 list_for_each_entry_safe(alg, n, list, cra_list) {
320 list_del_init(&alg->cra_list);
324 EXPORT_SYMBOL_GPL(crypto_remove_final);
326 static void crypto_wait_for_test(struct crypto_larval *larval)
330 err = crypto_probing_notify(CRYPTO_MSG_ALG_REGISTER, larval->adult);
331 if (err != NOTIFY_STOP) {
332 if (WARN_ON(err != NOTIFY_DONE))
334 crypto_alg_tested(larval->alg.cra_driver_name, 0);
337 err = wait_for_completion_interruptible(&larval->completion);
341 crypto_larval_kill(&larval->alg);
344 int crypto_register_alg(struct crypto_alg *alg)
346 struct crypto_larval *larval;
349 err = crypto_check_alg(alg);
353 down_write(&crypto_alg_sem);
354 larval = __crypto_register_alg(alg);
355 up_write(&crypto_alg_sem);
358 return PTR_ERR(larval);
360 crypto_wait_for_test(larval);
363 EXPORT_SYMBOL_GPL(crypto_register_alg);
365 static int crypto_remove_alg(struct crypto_alg *alg, struct list_head *list)
367 if (unlikely(list_empty(&alg->cra_list)))
370 alg->cra_flags |= CRYPTO_ALG_DEAD;
372 crypto_notify(CRYPTO_MSG_ALG_UNREGISTER, alg);
373 list_del_init(&alg->cra_list);
374 crypto_remove_spawns(alg, list, NULL);
379 int crypto_unregister_alg(struct crypto_alg *alg)
384 down_write(&crypto_alg_sem);
385 ret = crypto_remove_alg(alg, &list);
386 up_write(&crypto_alg_sem);
391 BUG_ON(atomic_read(&alg->cra_refcnt) != 1);
392 if (alg->cra_destroy)
393 alg->cra_destroy(alg);
395 crypto_remove_final(&list);
398 EXPORT_SYMBOL_GPL(crypto_unregister_alg);
400 int crypto_register_algs(struct crypto_alg *algs, int count)
404 for (i = 0; i < count; i++) {
405 ret = crypto_register_alg(&algs[i]);
413 for (--i; i >= 0; --i)
414 crypto_unregister_alg(&algs[i]);
418 EXPORT_SYMBOL_GPL(crypto_register_algs);
420 int crypto_unregister_algs(struct crypto_alg *algs, int count)
424 for (i = 0; i < count; i++) {
425 ret = crypto_unregister_alg(&algs[i]);
427 pr_err("Failed to unregister %s %s: %d\n",
428 algs[i].cra_driver_name, algs[i].cra_name, ret);
433 EXPORT_SYMBOL_GPL(crypto_unregister_algs);
435 int crypto_register_template(struct crypto_template *tmpl)
437 struct crypto_template *q;
440 down_write(&crypto_alg_sem);
442 crypto_check_module_sig(tmpl->module);
444 list_for_each_entry(q, &crypto_template_list, list) {
449 list_add(&tmpl->list, &crypto_template_list);
450 crypto_notify(CRYPTO_MSG_TMPL_REGISTER, tmpl);
453 up_write(&crypto_alg_sem);
456 EXPORT_SYMBOL_GPL(crypto_register_template);
458 void crypto_unregister_template(struct crypto_template *tmpl)
460 struct crypto_instance *inst;
461 struct hlist_node *n;
462 struct hlist_head *list;
465 down_write(&crypto_alg_sem);
467 BUG_ON(list_empty(&tmpl->list));
468 list_del_init(&tmpl->list);
470 list = &tmpl->instances;
471 hlist_for_each_entry(inst, list, list) {
472 int err = crypto_remove_alg(&inst->alg, &users);
477 crypto_notify(CRYPTO_MSG_TMPL_UNREGISTER, tmpl);
479 up_write(&crypto_alg_sem);
481 hlist_for_each_entry_safe(inst, n, list, list) {
482 BUG_ON(atomic_read(&inst->alg.cra_refcnt) != 1);
485 crypto_remove_final(&users);
487 EXPORT_SYMBOL_GPL(crypto_unregister_template);
489 static struct crypto_template *__crypto_lookup_template(const char *name)
491 struct crypto_template *q, *tmpl = NULL;
493 down_read(&crypto_alg_sem);
494 list_for_each_entry(q, &crypto_template_list, list) {
495 if (strcmp(q->name, name))
497 if (unlikely(!crypto_tmpl_get(q)))
503 up_read(&crypto_alg_sem);
508 struct crypto_template *crypto_lookup_template(const char *name)
510 return try_then_request_module(__crypto_lookup_template(name),
513 EXPORT_SYMBOL_GPL(crypto_lookup_template);
515 int crypto_register_instance(struct crypto_template *tmpl,
516 struct crypto_instance *inst)
518 struct crypto_larval *larval;
521 err = crypto_check_alg(&inst->alg);
525 inst->alg.cra_module = tmpl->module;
526 inst->alg.cra_flags |= CRYPTO_ALG_INSTANCE;
528 if (unlikely(!crypto_mod_get(&inst->alg)))
531 down_write(&crypto_alg_sem);
533 larval = __crypto_register_alg(&inst->alg);
537 hlist_add_head(&inst->list, &tmpl->instances);
541 up_write(&crypto_alg_sem);
543 err = PTR_ERR(larval);
547 crypto_wait_for_test(larval);
549 /* Remove instance if test failed */
550 if (!(inst->alg.cra_flags & CRYPTO_ALG_TESTED))
551 crypto_unregister_instance(inst);
555 crypto_mod_put(&inst->alg);
558 EXPORT_SYMBOL_GPL(crypto_register_instance);
560 int crypto_unregister_instance(struct crypto_instance *inst)
564 down_write(&crypto_alg_sem);
566 crypto_remove_spawns(&inst->alg, &list, NULL);
567 crypto_remove_instance(inst, &list);
569 up_write(&crypto_alg_sem);
571 crypto_remove_final(&list);
575 EXPORT_SYMBOL_GPL(crypto_unregister_instance);
577 int crypto_init_spawn(struct crypto_spawn *spawn, struct crypto_alg *alg,
578 struct crypto_instance *inst, u32 mask)
585 down_write(&crypto_alg_sem);
586 if (!crypto_is_moribund(alg)) {
587 list_add(&spawn->list, &alg->cra_users);
591 up_write(&crypto_alg_sem);
595 EXPORT_SYMBOL_GPL(crypto_init_spawn);
597 int crypto_init_spawn2(struct crypto_spawn *spawn, struct crypto_alg *alg,
598 struct crypto_instance *inst,
599 const struct crypto_type *frontend)
603 if ((alg->cra_flags ^ frontend->type) & frontend->maskset)
606 spawn->frontend = frontend;
607 err = crypto_init_spawn(spawn, alg, inst, frontend->maskset);
612 EXPORT_SYMBOL_GPL(crypto_init_spawn2);
614 void crypto_drop_spawn(struct crypto_spawn *spawn)
619 down_write(&crypto_alg_sem);
620 list_del(&spawn->list);
621 up_write(&crypto_alg_sem);
623 EXPORT_SYMBOL_GPL(crypto_drop_spawn);
625 static struct crypto_alg *crypto_spawn_alg(struct crypto_spawn *spawn)
627 struct crypto_alg *alg;
628 struct crypto_alg *alg2;
630 down_read(&crypto_alg_sem);
634 alg2 = crypto_mod_get(alg2);
635 up_read(&crypto_alg_sem);
639 crypto_shoot_alg(alg);
640 return ERR_PTR(-EAGAIN);
646 struct crypto_tfm *crypto_spawn_tfm(struct crypto_spawn *spawn, u32 type,
649 struct crypto_alg *alg;
650 struct crypto_tfm *tfm;
652 alg = crypto_spawn_alg(spawn);
654 return ERR_CAST(alg);
656 tfm = ERR_PTR(-EINVAL);
657 if (unlikely((alg->cra_flags ^ type) & mask))
660 tfm = __crypto_alloc_tfm(alg, type, mask);
670 EXPORT_SYMBOL_GPL(crypto_spawn_tfm);
672 void *crypto_spawn_tfm2(struct crypto_spawn *spawn)
674 struct crypto_alg *alg;
675 struct crypto_tfm *tfm;
677 alg = crypto_spawn_alg(spawn);
679 return ERR_CAST(alg);
681 tfm = crypto_create_tfm(alg, spawn->frontend);
691 EXPORT_SYMBOL_GPL(crypto_spawn_tfm2);
693 int crypto_register_notifier(struct notifier_block *nb)
695 return blocking_notifier_chain_register(&crypto_chain, nb);
697 EXPORT_SYMBOL_GPL(crypto_register_notifier);
699 int crypto_unregister_notifier(struct notifier_block *nb)
701 return blocking_notifier_chain_unregister(&crypto_chain, nb);
703 EXPORT_SYMBOL_GPL(crypto_unregister_notifier);
705 struct crypto_attr_type *crypto_get_attr_type(struct rtattr **tb)
707 struct rtattr *rta = tb[0];
708 struct crypto_attr_type *algt;
711 return ERR_PTR(-ENOENT);
712 if (RTA_PAYLOAD(rta) < sizeof(*algt))
713 return ERR_PTR(-EINVAL);
714 if (rta->rta_type != CRYPTOA_TYPE)
715 return ERR_PTR(-EINVAL);
717 algt = RTA_DATA(rta);
721 EXPORT_SYMBOL_GPL(crypto_get_attr_type);
723 int crypto_check_attr_type(struct rtattr **tb, u32 type)
725 struct crypto_attr_type *algt;
727 algt = crypto_get_attr_type(tb);
729 return PTR_ERR(algt);
731 if ((algt->type ^ type) & algt->mask)
736 EXPORT_SYMBOL_GPL(crypto_check_attr_type);
738 const char *crypto_attr_alg_name(struct rtattr *rta)
740 struct crypto_attr_alg *alga;
743 return ERR_PTR(-ENOENT);
744 if (RTA_PAYLOAD(rta) < sizeof(*alga))
745 return ERR_PTR(-EINVAL);
746 if (rta->rta_type != CRYPTOA_ALG)
747 return ERR_PTR(-EINVAL);
749 alga = RTA_DATA(rta);
750 alga->name[CRYPTO_MAX_ALG_NAME - 1] = 0;
754 EXPORT_SYMBOL_GPL(crypto_attr_alg_name);
756 struct crypto_alg *crypto_attr_alg2(struct rtattr *rta,
757 const struct crypto_type *frontend,
762 name = crypto_attr_alg_name(rta);
764 return ERR_CAST(name);
766 return crypto_find_alg(name, frontend, type, mask);
768 EXPORT_SYMBOL_GPL(crypto_attr_alg2);
770 int crypto_attr_u32(struct rtattr *rta, u32 *num)
772 struct crypto_attr_u32 *nu32;
776 if (RTA_PAYLOAD(rta) < sizeof(*nu32))
778 if (rta->rta_type != CRYPTOA_U32)
781 nu32 = RTA_DATA(rta);
786 EXPORT_SYMBOL_GPL(crypto_attr_u32);
788 void *crypto_alloc_instance2(const char *name, struct crypto_alg *alg,
791 struct crypto_instance *inst;
795 p = kzalloc(head + sizeof(*inst) + sizeof(struct crypto_spawn),
798 return ERR_PTR(-ENOMEM);
800 inst = (void *)(p + head);
803 if (snprintf(inst->alg.cra_name, CRYPTO_MAX_ALG_NAME, "%s(%s)", name,
804 alg->cra_name) >= CRYPTO_MAX_ALG_NAME)
807 if (snprintf(inst->alg.cra_driver_name, CRYPTO_MAX_ALG_NAME, "%s(%s)",
808 name, alg->cra_driver_name) >= CRYPTO_MAX_ALG_NAME)
817 EXPORT_SYMBOL_GPL(crypto_alloc_instance2);
819 struct crypto_instance *crypto_alloc_instance(const char *name,
820 struct crypto_alg *alg)
822 struct crypto_instance *inst;
823 struct crypto_spawn *spawn;
826 inst = crypto_alloc_instance2(name, alg, 0);
830 spawn = crypto_instance_ctx(inst);
831 err = crypto_init_spawn(spawn, alg, inst,
832 CRYPTO_ALG_TYPE_MASK | CRYPTO_ALG_ASYNC);
846 EXPORT_SYMBOL_GPL(crypto_alloc_instance);
848 void crypto_init_queue(struct crypto_queue *queue, unsigned int max_qlen)
850 INIT_LIST_HEAD(&queue->list);
851 queue->backlog = &queue->list;
853 queue->max_qlen = max_qlen;
855 EXPORT_SYMBOL_GPL(crypto_init_queue);
857 int crypto_enqueue_request(struct crypto_queue *queue,
858 struct crypto_async_request *request)
860 int err = -EINPROGRESS;
862 if (unlikely(queue->qlen >= queue->max_qlen)) {
864 if (!(request->flags & CRYPTO_TFM_REQ_MAY_BACKLOG))
866 if (queue->backlog == &queue->list)
867 queue->backlog = &request->list;
871 list_add_tail(&request->list, &queue->list);
876 EXPORT_SYMBOL_GPL(crypto_enqueue_request);
878 void *__crypto_dequeue_request(struct crypto_queue *queue, unsigned int offset)
880 struct list_head *request;
882 if (unlikely(!queue->qlen))
887 if (queue->backlog != &queue->list)
888 queue->backlog = queue->backlog->next;
890 request = queue->list.next;
893 return (char *)list_entry(request, struct crypto_async_request, list) -
896 EXPORT_SYMBOL_GPL(__crypto_dequeue_request);
898 struct crypto_async_request *crypto_dequeue_request(struct crypto_queue *queue)
900 return __crypto_dequeue_request(queue, 0);
902 EXPORT_SYMBOL_GPL(crypto_dequeue_request);
904 int crypto_tfm_in_queue(struct crypto_queue *queue, struct crypto_tfm *tfm)
906 struct crypto_async_request *req;
908 list_for_each_entry(req, &queue->list, list) {
915 EXPORT_SYMBOL_GPL(crypto_tfm_in_queue);
917 static inline void crypto_inc_byte(u8 *a, unsigned int size)
922 for (; size; size--) {
930 void crypto_inc(u8 *a, unsigned int size)
932 __be32 *b = (__be32 *)(a + size);
935 for (; size >= 4; size -= 4) {
936 c = be32_to_cpu(*--b) + 1;
942 crypto_inc_byte(a, size);
944 EXPORT_SYMBOL_GPL(crypto_inc);
946 static inline void crypto_xor_byte(u8 *a, const u8 *b, unsigned int size)
952 void crypto_xor(u8 *dst, const u8 *src, unsigned int size)
957 for (; size >= 4; size -= 4)
960 crypto_xor_byte((u8 *)a, (u8 *)b, size);
962 EXPORT_SYMBOL_GPL(crypto_xor);
964 unsigned int crypto_alg_extsize(struct crypto_alg *alg)
966 return alg->cra_ctxsize;
968 EXPORT_SYMBOL_GPL(crypto_alg_extsize);
970 static int __init crypto_algapi_init(void)
976 static void __exit crypto_algapi_exit(void)
981 module_init(crypto_algapi_init);
982 module_exit(crypto_algapi_exit);
984 MODULE_LICENSE("GPL");
985 MODULE_DESCRIPTION("Cryptographic algorithms API");