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 spawn = list_first_entry_or_null(stack, struct crypto_spawn, list);
100 n = list_next_entry(spawn, list);
102 if (spawn->alg && &n->list != stack && !n->alg)
103 n->alg = (n->list.next == stack) ? alg :
104 &list_next_entry(n, list)->inst->alg;
106 list_move(&spawn->list, secondary_spawns);
108 return &n->list == stack ? top : &n->inst->alg.cra_users;
111 static void crypto_remove_instance(struct crypto_instance *inst,
112 struct list_head *list)
114 struct crypto_template *tmpl = inst->tmpl;
116 if (crypto_is_dead(&inst->alg))
119 inst->alg.cra_flags |= CRYPTO_ALG_DEAD;
120 if (hlist_unhashed(&inst->list))
123 if (!tmpl || !crypto_tmpl_get(tmpl))
126 crypto_notify(CRYPTO_MSG_ALG_UNREGISTER, &inst->alg);
127 list_move(&inst->alg.cra_list, list);
128 hlist_del(&inst->list);
129 inst->alg.cra_destroy = crypto_destroy_instance;
131 BUG_ON(!list_empty(&inst->alg.cra_users));
134 void crypto_remove_spawns(struct crypto_alg *alg, struct list_head *list,
135 struct crypto_alg *nalg)
137 u32 new_type = (nalg ?: alg)->cra_flags;
138 struct crypto_spawn *spawn, *n;
139 LIST_HEAD(secondary_spawns);
140 struct list_head *spawns;
144 spawns = &alg->cra_users;
145 list_for_each_entry_safe(spawn, n, spawns, list) {
146 if ((spawn->alg->cra_flags ^ new_type) & spawn->mask)
149 list_move(&spawn->list, &top);
154 while (!list_empty(spawns)) {
155 struct crypto_instance *inst;
157 spawn = list_first_entry(spawns, struct crypto_spawn,
161 BUG_ON(&inst->alg == alg);
163 list_move(&spawn->list, &stack);
165 if (&inst->alg == nalg)
169 spawns = &inst->alg.cra_users;
171 } while ((spawns = crypto_more_spawns(alg, &stack, &top,
172 &secondary_spawns)));
174 list_for_each_entry_safe(spawn, n, &secondary_spawns, list) {
176 list_move(&spawn->list, &spawn->alg->cra_users);
178 crypto_remove_instance(spawn->inst, list);
181 EXPORT_SYMBOL_GPL(crypto_remove_spawns);
183 static struct crypto_larval *__crypto_register_alg(struct crypto_alg *alg)
185 struct crypto_alg *q;
186 struct crypto_larval *larval;
189 if (crypto_is_dead(alg))
192 INIT_LIST_HEAD(&alg->cra_users);
195 alg->cra_flags &= ~CRYPTO_ALG_TESTED;
199 list_for_each_entry(q, &crypto_alg_list, cra_list) {
203 if (crypto_is_moribund(q))
206 if (crypto_is_larval(q)) {
207 if (!strcmp(alg->cra_driver_name, q->cra_driver_name))
212 if (!strcmp(q->cra_driver_name, alg->cra_name) ||
213 !strcmp(q->cra_name, alg->cra_driver_name))
217 larval = crypto_larval_alloc(alg->cra_name,
218 alg->cra_flags | CRYPTO_ALG_TESTED, 0);
223 larval->adult = crypto_mod_get(alg);
227 atomic_set(&larval->alg.cra_refcnt, 1);
228 memcpy(larval->alg.cra_driver_name, alg->cra_driver_name,
229 CRYPTO_MAX_ALG_NAME);
230 larval->alg.cra_priority = alg->cra_priority;
232 list_add(&alg->cra_list, &crypto_alg_list);
233 list_add(&larval->alg.cra_list, &crypto_alg_list);
241 larval = ERR_PTR(ret);
245 void crypto_alg_tested(const char *name, int err)
247 struct crypto_larval *test;
248 struct crypto_alg *alg;
249 struct crypto_alg *q;
252 down_write(&crypto_alg_sem);
253 list_for_each_entry(q, &crypto_alg_list, cra_list) {
254 if (crypto_is_moribund(q) || !crypto_is_larval(q))
257 test = (struct crypto_larval *)q;
259 if (!strcmp(q->cra_driver_name, name))
263 printk(KERN_ERR "alg: Unexpected test result for %s: %d\n", name, err);
267 q->cra_flags |= CRYPTO_ALG_DEAD;
269 if (err || list_empty(&alg->cra_list))
272 alg->cra_flags |= CRYPTO_ALG_TESTED;
274 list_for_each_entry(q, &crypto_alg_list, cra_list) {
278 if (crypto_is_moribund(q))
281 if (crypto_is_larval(q)) {
282 struct crypto_larval *larval = (void *)q;
285 * Check to see if either our generic name or
286 * specific name can satisfy the name requested
287 * by the larval entry q.
289 if (strcmp(alg->cra_name, q->cra_name) &&
290 strcmp(alg->cra_driver_name, q->cra_name))
295 if ((q->cra_flags ^ alg->cra_flags) & larval->mask)
297 if (!crypto_mod_get(alg))
304 if (strcmp(alg->cra_name, q->cra_name))
307 if (strcmp(alg->cra_driver_name, q->cra_driver_name) &&
308 q->cra_priority > alg->cra_priority)
311 crypto_remove_spawns(q, &list, alg);
315 complete_all(&test->completion);
318 up_write(&crypto_alg_sem);
320 crypto_remove_final(&list);
322 EXPORT_SYMBOL_GPL(crypto_alg_tested);
324 void crypto_remove_final(struct list_head *list)
326 struct crypto_alg *alg;
327 struct crypto_alg *n;
329 list_for_each_entry_safe(alg, n, list, cra_list) {
330 list_del_init(&alg->cra_list);
334 EXPORT_SYMBOL_GPL(crypto_remove_final);
336 static void crypto_wait_for_test(struct crypto_larval *larval)
340 err = crypto_probing_notify(CRYPTO_MSG_ALG_REGISTER, larval->adult);
341 if (err != NOTIFY_STOP) {
342 if (WARN_ON(err != NOTIFY_DONE))
344 crypto_alg_tested(larval->alg.cra_driver_name, 0);
347 err = wait_for_completion_killable(&larval->completion);
351 crypto_larval_kill(&larval->alg);
354 int crypto_register_alg(struct crypto_alg *alg)
356 struct crypto_larval *larval;
359 err = crypto_check_alg(alg);
363 down_write(&crypto_alg_sem);
364 larval = __crypto_register_alg(alg);
365 up_write(&crypto_alg_sem);
368 return PTR_ERR(larval);
370 crypto_wait_for_test(larval);
373 EXPORT_SYMBOL_GPL(crypto_register_alg);
375 static int crypto_remove_alg(struct crypto_alg *alg, struct list_head *list)
377 if (unlikely(list_empty(&alg->cra_list)))
380 alg->cra_flags |= CRYPTO_ALG_DEAD;
382 crypto_notify(CRYPTO_MSG_ALG_UNREGISTER, alg);
383 list_del_init(&alg->cra_list);
384 crypto_remove_spawns(alg, list, NULL);
389 int crypto_unregister_alg(struct crypto_alg *alg)
394 down_write(&crypto_alg_sem);
395 ret = crypto_remove_alg(alg, &list);
396 up_write(&crypto_alg_sem);
401 BUG_ON(atomic_read(&alg->cra_refcnt) != 1);
402 if (alg->cra_destroy)
403 alg->cra_destroy(alg);
405 crypto_remove_final(&list);
408 EXPORT_SYMBOL_GPL(crypto_unregister_alg);
410 int crypto_register_algs(struct crypto_alg *algs, int count)
414 for (i = 0; i < count; i++) {
415 ret = crypto_register_alg(&algs[i]);
423 for (--i; i >= 0; --i)
424 crypto_unregister_alg(&algs[i]);
428 EXPORT_SYMBOL_GPL(crypto_register_algs);
430 int crypto_unregister_algs(struct crypto_alg *algs, int count)
434 for (i = 0; i < count; i++) {
435 ret = crypto_unregister_alg(&algs[i]);
437 pr_err("Failed to unregister %s %s: %d\n",
438 algs[i].cra_driver_name, algs[i].cra_name, ret);
443 EXPORT_SYMBOL_GPL(crypto_unregister_algs);
445 int crypto_register_template(struct crypto_template *tmpl)
447 struct crypto_template *q;
450 down_write(&crypto_alg_sem);
452 crypto_check_module_sig(tmpl->module);
454 list_for_each_entry(q, &crypto_template_list, list) {
459 list_add(&tmpl->list, &crypto_template_list);
460 crypto_notify(CRYPTO_MSG_TMPL_REGISTER, tmpl);
463 up_write(&crypto_alg_sem);
466 EXPORT_SYMBOL_GPL(crypto_register_template);
468 void crypto_unregister_template(struct crypto_template *tmpl)
470 struct crypto_instance *inst;
471 struct hlist_node *n;
472 struct hlist_head *list;
475 down_write(&crypto_alg_sem);
477 BUG_ON(list_empty(&tmpl->list));
478 list_del_init(&tmpl->list);
480 list = &tmpl->instances;
481 hlist_for_each_entry(inst, list, list) {
482 int err = crypto_remove_alg(&inst->alg, &users);
487 crypto_notify(CRYPTO_MSG_TMPL_UNREGISTER, tmpl);
489 up_write(&crypto_alg_sem);
491 hlist_for_each_entry_safe(inst, n, list, list) {
492 BUG_ON(atomic_read(&inst->alg.cra_refcnt) != 1);
493 crypto_free_instance(inst);
495 crypto_remove_final(&users);
497 EXPORT_SYMBOL_GPL(crypto_unregister_template);
499 static struct crypto_template *__crypto_lookup_template(const char *name)
501 struct crypto_template *q, *tmpl = NULL;
503 down_read(&crypto_alg_sem);
504 list_for_each_entry(q, &crypto_template_list, list) {
505 if (strcmp(q->name, name))
507 if (unlikely(!crypto_tmpl_get(q)))
513 up_read(&crypto_alg_sem);
518 struct crypto_template *crypto_lookup_template(const char *name)
520 return try_then_request_module(__crypto_lookup_template(name),
523 EXPORT_SYMBOL_GPL(crypto_lookup_template);
525 int crypto_register_instance(struct crypto_template *tmpl,
526 struct crypto_instance *inst)
528 struct crypto_larval *larval;
531 err = crypto_check_alg(&inst->alg);
535 inst->alg.cra_module = tmpl->module;
536 inst->alg.cra_flags |= CRYPTO_ALG_INSTANCE;
538 if (unlikely(!crypto_mod_get(&inst->alg)))
541 down_write(&crypto_alg_sem);
543 larval = __crypto_register_alg(&inst->alg);
547 hlist_add_head(&inst->list, &tmpl->instances);
551 up_write(&crypto_alg_sem);
553 err = PTR_ERR(larval);
557 crypto_wait_for_test(larval);
559 /* Remove instance if test failed */
560 if (!(inst->alg.cra_flags & CRYPTO_ALG_TESTED))
561 crypto_unregister_instance(inst);
565 crypto_mod_put(&inst->alg);
568 EXPORT_SYMBOL_GPL(crypto_register_instance);
570 int crypto_unregister_instance(struct crypto_instance *inst)
574 down_write(&crypto_alg_sem);
576 crypto_remove_spawns(&inst->alg, &list, NULL);
577 crypto_remove_instance(inst, &list);
579 up_write(&crypto_alg_sem);
581 crypto_remove_final(&list);
585 EXPORT_SYMBOL_GPL(crypto_unregister_instance);
587 int crypto_init_spawn(struct crypto_spawn *spawn, struct crypto_alg *alg,
588 struct crypto_instance *inst, u32 mask)
595 down_write(&crypto_alg_sem);
596 if (!crypto_is_moribund(alg)) {
597 list_add(&spawn->list, &alg->cra_users);
601 up_write(&crypto_alg_sem);
605 EXPORT_SYMBOL_GPL(crypto_init_spawn);
607 int crypto_init_spawn2(struct crypto_spawn *spawn, struct crypto_alg *alg,
608 struct crypto_instance *inst,
609 const struct crypto_type *frontend)
613 if ((alg->cra_flags ^ frontend->type) & frontend->maskset)
616 spawn->frontend = frontend;
617 err = crypto_init_spawn(spawn, alg, inst, frontend->maskset);
622 EXPORT_SYMBOL_GPL(crypto_init_spawn2);
624 int crypto_grab_spawn(struct crypto_spawn *spawn, const char *name,
627 struct crypto_alg *alg;
630 alg = crypto_find_alg(name, spawn->frontend, type, mask);
634 err = crypto_init_spawn(spawn, alg, spawn->inst, mask);
638 EXPORT_SYMBOL_GPL(crypto_grab_spawn);
640 void crypto_drop_spawn(struct crypto_spawn *spawn)
645 down_write(&crypto_alg_sem);
646 list_del(&spawn->list);
647 up_write(&crypto_alg_sem);
649 EXPORT_SYMBOL_GPL(crypto_drop_spawn);
651 static struct crypto_alg *crypto_spawn_alg(struct crypto_spawn *spawn)
653 struct crypto_alg *alg;
654 struct crypto_alg *alg2;
656 down_read(&crypto_alg_sem);
660 alg2 = crypto_mod_get(alg2);
661 up_read(&crypto_alg_sem);
665 crypto_shoot_alg(alg);
666 return ERR_PTR(-EAGAIN);
672 struct crypto_tfm *crypto_spawn_tfm(struct crypto_spawn *spawn, u32 type,
675 struct crypto_alg *alg;
676 struct crypto_tfm *tfm;
678 alg = crypto_spawn_alg(spawn);
680 return ERR_CAST(alg);
682 tfm = ERR_PTR(-EINVAL);
683 if (unlikely((alg->cra_flags ^ type) & mask))
686 tfm = __crypto_alloc_tfm(alg, type, mask);
696 EXPORT_SYMBOL_GPL(crypto_spawn_tfm);
698 void *crypto_spawn_tfm2(struct crypto_spawn *spawn)
700 struct crypto_alg *alg;
701 struct crypto_tfm *tfm;
703 alg = crypto_spawn_alg(spawn);
705 return ERR_CAST(alg);
707 tfm = crypto_create_tfm(alg, spawn->frontend);
717 EXPORT_SYMBOL_GPL(crypto_spawn_tfm2);
719 int crypto_register_notifier(struct notifier_block *nb)
721 return blocking_notifier_chain_register(&crypto_chain, nb);
723 EXPORT_SYMBOL_GPL(crypto_register_notifier);
725 int crypto_unregister_notifier(struct notifier_block *nb)
727 return blocking_notifier_chain_unregister(&crypto_chain, nb);
729 EXPORT_SYMBOL_GPL(crypto_unregister_notifier);
731 struct crypto_attr_type *crypto_get_attr_type(struct rtattr **tb)
733 struct rtattr *rta = tb[0];
734 struct crypto_attr_type *algt;
737 return ERR_PTR(-ENOENT);
738 if (RTA_PAYLOAD(rta) < sizeof(*algt))
739 return ERR_PTR(-EINVAL);
740 if (rta->rta_type != CRYPTOA_TYPE)
741 return ERR_PTR(-EINVAL);
743 algt = RTA_DATA(rta);
747 EXPORT_SYMBOL_GPL(crypto_get_attr_type);
749 int crypto_check_attr_type(struct rtattr **tb, u32 type)
751 struct crypto_attr_type *algt;
753 algt = crypto_get_attr_type(tb);
755 return PTR_ERR(algt);
757 if ((algt->type ^ type) & algt->mask)
762 EXPORT_SYMBOL_GPL(crypto_check_attr_type);
764 const char *crypto_attr_alg_name(struct rtattr *rta)
766 struct crypto_attr_alg *alga;
769 return ERR_PTR(-ENOENT);
770 if (RTA_PAYLOAD(rta) < sizeof(*alga))
771 return ERR_PTR(-EINVAL);
772 if (rta->rta_type != CRYPTOA_ALG)
773 return ERR_PTR(-EINVAL);
775 alga = RTA_DATA(rta);
776 alga->name[CRYPTO_MAX_ALG_NAME - 1] = 0;
780 EXPORT_SYMBOL_GPL(crypto_attr_alg_name);
782 struct crypto_alg *crypto_attr_alg2(struct rtattr *rta,
783 const struct crypto_type *frontend,
788 name = crypto_attr_alg_name(rta);
790 return ERR_CAST(name);
792 return crypto_find_alg(name, frontend, type, mask);
794 EXPORT_SYMBOL_GPL(crypto_attr_alg2);
796 int crypto_attr_u32(struct rtattr *rta, u32 *num)
798 struct crypto_attr_u32 *nu32;
802 if (RTA_PAYLOAD(rta) < sizeof(*nu32))
804 if (rta->rta_type != CRYPTOA_U32)
807 nu32 = RTA_DATA(rta);
812 EXPORT_SYMBOL_GPL(crypto_attr_u32);
814 void *crypto_alloc_instance2(const char *name, struct crypto_alg *alg,
817 struct crypto_instance *inst;
821 p = kzalloc(head + sizeof(*inst) + sizeof(struct crypto_spawn),
824 return ERR_PTR(-ENOMEM);
826 inst = (void *)(p + head);
829 if (snprintf(inst->alg.cra_name, CRYPTO_MAX_ALG_NAME, "%s(%s)", name,
830 alg->cra_name) >= CRYPTO_MAX_ALG_NAME)
833 if (snprintf(inst->alg.cra_driver_name, CRYPTO_MAX_ALG_NAME, "%s(%s)",
834 name, alg->cra_driver_name) >= CRYPTO_MAX_ALG_NAME)
843 EXPORT_SYMBOL_GPL(crypto_alloc_instance2);
845 struct crypto_instance *crypto_alloc_instance(const char *name,
846 struct crypto_alg *alg)
848 struct crypto_instance *inst;
849 struct crypto_spawn *spawn;
852 inst = crypto_alloc_instance2(name, alg, 0);
856 spawn = crypto_instance_ctx(inst);
857 err = crypto_init_spawn(spawn, alg, inst,
858 CRYPTO_ALG_TYPE_MASK | CRYPTO_ALG_ASYNC);
872 EXPORT_SYMBOL_GPL(crypto_alloc_instance);
874 void crypto_init_queue(struct crypto_queue *queue, unsigned int max_qlen)
876 INIT_LIST_HEAD(&queue->list);
877 queue->backlog = &queue->list;
879 queue->max_qlen = max_qlen;
881 EXPORT_SYMBOL_GPL(crypto_init_queue);
883 int crypto_enqueue_request(struct crypto_queue *queue,
884 struct crypto_async_request *request)
886 int err = -EINPROGRESS;
888 if (unlikely(queue->qlen >= queue->max_qlen)) {
890 if (!(request->flags & CRYPTO_TFM_REQ_MAY_BACKLOG))
892 if (queue->backlog == &queue->list)
893 queue->backlog = &request->list;
897 list_add_tail(&request->list, &queue->list);
902 EXPORT_SYMBOL_GPL(crypto_enqueue_request);
904 struct crypto_async_request *crypto_dequeue_request(struct crypto_queue *queue)
906 struct list_head *request;
908 if (unlikely(!queue->qlen))
913 if (queue->backlog != &queue->list)
914 queue->backlog = queue->backlog->next;
916 request = queue->list.next;
919 return list_entry(request, struct crypto_async_request, list);
921 EXPORT_SYMBOL_GPL(crypto_dequeue_request);
923 int crypto_tfm_in_queue(struct crypto_queue *queue, struct crypto_tfm *tfm)
925 struct crypto_async_request *req;
927 list_for_each_entry(req, &queue->list, list) {
934 EXPORT_SYMBOL_GPL(crypto_tfm_in_queue);
936 static inline void crypto_inc_byte(u8 *a, unsigned int size)
941 for (; size; size--) {
949 void crypto_inc(u8 *a, unsigned int size)
951 __be32 *b = (__be32 *)(a + size);
954 for (; size >= 4; size -= 4) {
955 c = be32_to_cpu(*--b) + 1;
961 crypto_inc_byte(a, size);
963 EXPORT_SYMBOL_GPL(crypto_inc);
965 static inline void crypto_xor_byte(u8 *a, const u8 *b, unsigned int size)
971 void crypto_xor(u8 *dst, const u8 *src, unsigned int size)
976 for (; size >= 4; size -= 4)
979 crypto_xor_byte((u8 *)a, (u8 *)b, size);
981 EXPORT_SYMBOL_GPL(crypto_xor);
983 unsigned int crypto_alg_extsize(struct crypto_alg *alg)
985 return alg->cra_ctxsize +
986 (alg->cra_alignmask & ~(crypto_tfm_ctx_alignment() - 1));
988 EXPORT_SYMBOL_GPL(crypto_alg_extsize);
990 static int __init crypto_algapi_init(void)
996 static void __exit crypto_algapi_exit(void)
1001 module_init(crypto_algapi_init);
1002 module_exit(crypto_algapi_exit);
1004 MODULE_LICENSE("GPL");
1005 MODULE_DESCRIPTION("Cryptographic algorithms API");