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 void crypto_remove_final(struct list_head *list);
27 static LIST_HEAD(crypto_template_list);
29 void crypto_larval_error(const char *name, u32 type, u32 mask)
31 struct crypto_alg *alg;
33 alg = crypto_alg_lookup(name, type, mask);
36 if (crypto_is_larval(alg)) {
37 struct crypto_larval *larval = (void *)alg;
38 complete_all(&larval->completion);
43 EXPORT_SYMBOL_GPL(crypto_larval_error);
45 static inline int crypto_set_driver_name(struct crypto_alg *alg)
47 static const char suffix[] = "-generic";
48 char *driver_name = alg->cra_driver_name;
54 len = strlcpy(driver_name, alg->cra_name, CRYPTO_MAX_ALG_NAME);
55 if (len + sizeof(suffix) > CRYPTO_MAX_ALG_NAME)
58 memcpy(driver_name + len, suffix, sizeof(suffix));
62 static int crypto_check_alg(struct crypto_alg *alg)
64 if (alg->cra_alignmask & (alg->cra_alignmask + 1))
67 if (alg->cra_blocksize > PAGE_SIZE / 8)
70 if (alg->cra_priority < 0)
73 return crypto_set_driver_name(alg);
76 static void crypto_destroy_instance(struct crypto_alg *alg)
78 struct crypto_instance *inst = (void *)alg;
79 struct crypto_template *tmpl = inst->tmpl;
82 crypto_tmpl_put(tmpl);
85 static struct list_head *crypto_more_spawns(struct crypto_alg *alg,
86 struct list_head *stack,
87 struct list_head *top,
88 struct list_head *secondary_spawns)
90 struct crypto_spawn *spawn, *n;
92 if (list_empty(stack))
95 spawn = list_first_entry(stack, struct crypto_spawn, list);
96 n = list_entry(spawn->list.next, struct crypto_spawn, list);
98 if (spawn->alg && &n->list != stack && !n->alg)
99 n->alg = (n->list.next == stack) ? alg :
100 &list_entry(n->list.next, struct crypto_spawn,
103 list_move(&spawn->list, secondary_spawns);
105 return &n->list == stack ? top : &n->inst->alg.cra_users;
108 static void crypto_remove_spawn(struct crypto_spawn *spawn,
109 struct list_head *list)
111 struct crypto_instance *inst = spawn->inst;
112 struct crypto_template *tmpl = inst->tmpl;
114 if (crypto_is_dead(&inst->alg))
117 inst->alg.cra_flags |= CRYPTO_ALG_DEAD;
118 if (hlist_unhashed(&inst->list))
121 if (!tmpl || !crypto_tmpl_get(tmpl))
124 crypto_notify(CRYPTO_MSG_ALG_UNREGISTER, &inst->alg);
125 list_move(&inst->alg.cra_list, list);
126 hlist_del(&inst->list);
127 inst->alg.cra_destroy = crypto_destroy_instance;
129 BUG_ON(!list_empty(&inst->alg.cra_users));
132 static void crypto_remove_spawns(struct crypto_alg *alg,
133 struct list_head *list,
134 struct crypto_alg *nalg)
136 u32 new_type = (nalg ?: alg)->cra_flags;
137 struct crypto_spawn *spawn, *n;
138 LIST_HEAD(secondary_spawns);
139 struct list_head *spawns;
143 spawns = &alg->cra_users;
144 list_for_each_entry_safe(spawn, n, spawns, list) {
145 if ((spawn->alg->cra_flags ^ new_type) & spawn->mask)
148 list_move(&spawn->list, &top);
153 while (!list_empty(spawns)) {
154 struct crypto_instance *inst;
156 spawn = list_first_entry(spawns, struct crypto_spawn,
160 BUG_ON(&inst->alg == alg);
162 list_move(&spawn->list, &stack);
164 if (&inst->alg == nalg)
168 spawns = &inst->alg.cra_users;
170 } while ((spawns = crypto_more_spawns(alg, &stack, &top,
171 &secondary_spawns)));
173 list_for_each_entry_safe(spawn, n, &secondary_spawns, list) {
175 list_move(&spawn->list, &spawn->alg->cra_users);
177 crypto_remove_spawn(spawn, list);
181 static struct crypto_larval *__crypto_register_alg(struct crypto_alg *alg)
183 struct crypto_alg *q;
184 struct crypto_larval *larval;
187 if (crypto_is_dead(alg))
190 INIT_LIST_HEAD(&alg->cra_users);
193 alg->cra_flags &= ~CRYPTO_ALG_TESTED;
197 atomic_set(&alg->cra_refcnt, 1);
198 list_for_each_entry(q, &crypto_alg_list, cra_list) {
202 if (crypto_is_moribund(q))
205 if (crypto_is_larval(q)) {
206 if (!strcmp(alg->cra_driver_name, q->cra_driver_name))
211 if (!strcmp(q->cra_driver_name, alg->cra_name) ||
212 !strcmp(q->cra_name, alg->cra_driver_name))
216 larval = crypto_larval_alloc(alg->cra_name,
217 alg->cra_flags | CRYPTO_ALG_TESTED, 0);
222 larval->adult = crypto_mod_get(alg);
226 atomic_set(&larval->alg.cra_refcnt, 1);
227 memcpy(larval->alg.cra_driver_name, alg->cra_driver_name,
228 CRYPTO_MAX_ALG_NAME);
229 larval->alg.cra_priority = alg->cra_priority;
231 list_add(&alg->cra_list, &crypto_alg_list);
232 list_add(&larval->alg.cra_list, &crypto_alg_list);
240 larval = ERR_PTR(ret);
244 void crypto_alg_tested(const char *name, int err)
246 struct crypto_larval *test;
247 struct crypto_alg *alg;
248 struct crypto_alg *q;
251 down_write(&crypto_alg_sem);
252 list_for_each_entry(q, &crypto_alg_list, cra_list) {
253 if (crypto_is_moribund(q) || !crypto_is_larval(q))
256 test = (struct crypto_larval *)q;
258 if (!strcmp(q->cra_driver_name, name))
262 printk(KERN_ERR "alg: Unexpected test result for %s: %d\n", name, err);
266 q->cra_flags |= CRYPTO_ALG_DEAD;
268 if (err || list_empty(&alg->cra_list))
271 alg->cra_flags |= CRYPTO_ALG_TESTED;
273 list_for_each_entry(q, &crypto_alg_list, cra_list) {
277 if (crypto_is_moribund(q))
280 if (crypto_is_larval(q)) {
281 struct crypto_larval *larval = (void *)q;
284 * Check to see if either our generic name or
285 * specific name can satisfy the name requested
286 * by the larval entry q.
288 if (strcmp(alg->cra_name, q->cra_name) &&
289 strcmp(alg->cra_driver_name, q->cra_name))
294 if ((q->cra_flags ^ alg->cra_flags) & larval->mask)
296 if (!crypto_mod_get(alg))
300 complete_all(&larval->completion);
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 static 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);
335 static void crypto_wait_for_test(struct crypto_larval *larval)
339 err = crypto_probing_notify(CRYPTO_MSG_ALG_REGISTER, larval->adult);
340 if (err != NOTIFY_STOP) {
341 if (WARN_ON(err != NOTIFY_DONE))
343 crypto_alg_tested(larval->alg.cra_driver_name, 0);
346 err = wait_for_completion_interruptible(&larval->completion);
350 crypto_larval_kill(&larval->alg);
353 int crypto_register_alg(struct crypto_alg *alg)
355 struct crypto_larval *larval;
358 err = crypto_check_alg(alg);
362 down_write(&crypto_alg_sem);
363 larval = __crypto_register_alg(alg);
364 up_write(&crypto_alg_sem);
367 return PTR_ERR(larval);
369 crypto_wait_for_test(larval);
372 EXPORT_SYMBOL_GPL(crypto_register_alg);
374 static int crypto_remove_alg(struct crypto_alg *alg, struct list_head *list)
376 if (unlikely(list_empty(&alg->cra_list)))
379 alg->cra_flags |= CRYPTO_ALG_DEAD;
381 crypto_notify(CRYPTO_MSG_ALG_UNREGISTER, alg);
382 list_del_init(&alg->cra_list);
383 crypto_remove_spawns(alg, list, NULL);
388 int crypto_unregister_alg(struct crypto_alg *alg)
393 down_write(&crypto_alg_sem);
394 ret = crypto_remove_alg(alg, &list);
395 up_write(&crypto_alg_sem);
400 BUG_ON(atomic_read(&alg->cra_refcnt) != 1);
401 if (alg->cra_destroy)
402 alg->cra_destroy(alg);
404 crypto_remove_final(&list);
407 EXPORT_SYMBOL_GPL(crypto_unregister_alg);
409 int crypto_register_template(struct crypto_template *tmpl)
411 struct crypto_template *q;
414 down_write(&crypto_alg_sem);
416 list_for_each_entry(q, &crypto_template_list, list) {
421 list_add(&tmpl->list, &crypto_template_list);
422 crypto_notify(CRYPTO_MSG_TMPL_REGISTER, tmpl);
425 up_write(&crypto_alg_sem);
428 EXPORT_SYMBOL_GPL(crypto_register_template);
430 void crypto_unregister_template(struct crypto_template *tmpl)
432 struct crypto_instance *inst;
433 struct hlist_node *p, *n;
434 struct hlist_head *list;
437 down_write(&crypto_alg_sem);
439 BUG_ON(list_empty(&tmpl->list));
440 list_del_init(&tmpl->list);
442 list = &tmpl->instances;
443 hlist_for_each_entry(inst, p, list, list) {
444 int err = crypto_remove_alg(&inst->alg, &users);
448 crypto_notify(CRYPTO_MSG_TMPL_UNREGISTER, tmpl);
450 up_write(&crypto_alg_sem);
452 hlist_for_each_entry_safe(inst, p, n, list, list) {
453 BUG_ON(atomic_read(&inst->alg.cra_refcnt) != 1);
456 crypto_remove_final(&users);
458 EXPORT_SYMBOL_GPL(crypto_unregister_template);
460 static struct crypto_template *__crypto_lookup_template(const char *name)
462 struct crypto_template *q, *tmpl = NULL;
464 down_read(&crypto_alg_sem);
465 list_for_each_entry(q, &crypto_template_list, list) {
466 if (strcmp(q->name, name))
468 if (unlikely(!crypto_tmpl_get(q)))
474 up_read(&crypto_alg_sem);
479 struct crypto_template *crypto_lookup_template(const char *name)
481 return try_then_request_module(__crypto_lookup_template(name), name);
483 EXPORT_SYMBOL_GPL(crypto_lookup_template);
485 int crypto_register_instance(struct crypto_template *tmpl,
486 struct crypto_instance *inst)
488 struct crypto_larval *larval;
491 err = crypto_check_alg(&inst->alg);
495 inst->alg.cra_module = tmpl->module;
497 down_write(&crypto_alg_sem);
499 larval = __crypto_register_alg(&inst->alg);
503 hlist_add_head(&inst->list, &tmpl->instances);
507 up_write(&crypto_alg_sem);
509 err = PTR_ERR(larval);
513 crypto_wait_for_test(larval);
519 EXPORT_SYMBOL_GPL(crypto_register_instance);
521 int crypto_init_spawn(struct crypto_spawn *spawn, struct crypto_alg *alg,
522 struct crypto_instance *inst, u32 mask)
529 down_write(&crypto_alg_sem);
530 if (!crypto_is_moribund(alg)) {
531 list_add(&spawn->list, &alg->cra_users);
535 up_write(&crypto_alg_sem);
539 EXPORT_SYMBOL_GPL(crypto_init_spawn);
541 int crypto_init_spawn2(struct crypto_spawn *spawn, struct crypto_alg *alg,
542 struct crypto_instance *inst,
543 const struct crypto_type *frontend)
547 if ((alg->cra_flags ^ frontend->type) & frontend->maskset)
550 spawn->frontend = frontend;
551 err = crypto_init_spawn(spawn, alg, inst, frontend->maskset);
556 EXPORT_SYMBOL_GPL(crypto_init_spawn2);
558 void crypto_drop_spawn(struct crypto_spawn *spawn)
563 down_write(&crypto_alg_sem);
564 list_del(&spawn->list);
565 up_write(&crypto_alg_sem);
567 EXPORT_SYMBOL_GPL(crypto_drop_spawn);
569 static struct crypto_alg *crypto_spawn_alg(struct crypto_spawn *spawn)
571 struct crypto_alg *alg;
572 struct crypto_alg *alg2;
574 down_read(&crypto_alg_sem);
578 alg2 = crypto_mod_get(alg2);
579 up_read(&crypto_alg_sem);
583 crypto_shoot_alg(alg);
584 return ERR_PTR(-EAGAIN);
590 struct crypto_tfm *crypto_spawn_tfm(struct crypto_spawn *spawn, u32 type,
593 struct crypto_alg *alg;
594 struct crypto_tfm *tfm;
596 alg = crypto_spawn_alg(spawn);
598 return ERR_CAST(alg);
600 tfm = ERR_PTR(-EINVAL);
601 if (unlikely((alg->cra_flags ^ type) & mask))
604 tfm = __crypto_alloc_tfm(alg, type, mask);
614 EXPORT_SYMBOL_GPL(crypto_spawn_tfm);
616 void *crypto_spawn_tfm2(struct crypto_spawn *spawn)
618 struct crypto_alg *alg;
619 struct crypto_tfm *tfm;
621 alg = crypto_spawn_alg(spawn);
623 return ERR_CAST(alg);
625 tfm = crypto_create_tfm(alg, spawn->frontend);
635 EXPORT_SYMBOL_GPL(crypto_spawn_tfm2);
637 int crypto_register_notifier(struct notifier_block *nb)
639 return blocking_notifier_chain_register(&crypto_chain, nb);
641 EXPORT_SYMBOL_GPL(crypto_register_notifier);
643 int crypto_unregister_notifier(struct notifier_block *nb)
645 return blocking_notifier_chain_unregister(&crypto_chain, nb);
647 EXPORT_SYMBOL_GPL(crypto_unregister_notifier);
649 struct crypto_attr_type *crypto_get_attr_type(struct rtattr **tb)
651 struct rtattr *rta = tb[0];
652 struct crypto_attr_type *algt;
655 return ERR_PTR(-ENOENT);
656 if (RTA_PAYLOAD(rta) < sizeof(*algt))
657 return ERR_PTR(-EINVAL);
658 if (rta->rta_type != CRYPTOA_TYPE)
659 return ERR_PTR(-EINVAL);
661 algt = RTA_DATA(rta);
665 EXPORT_SYMBOL_GPL(crypto_get_attr_type);
667 int crypto_check_attr_type(struct rtattr **tb, u32 type)
669 struct crypto_attr_type *algt;
671 algt = crypto_get_attr_type(tb);
673 return PTR_ERR(algt);
675 if ((algt->type ^ type) & algt->mask)
680 EXPORT_SYMBOL_GPL(crypto_check_attr_type);
682 const char *crypto_attr_alg_name(struct rtattr *rta)
684 struct crypto_attr_alg *alga;
687 return ERR_PTR(-ENOENT);
688 if (RTA_PAYLOAD(rta) < sizeof(*alga))
689 return ERR_PTR(-EINVAL);
690 if (rta->rta_type != CRYPTOA_ALG)
691 return ERR_PTR(-EINVAL);
693 alga = RTA_DATA(rta);
694 alga->name[CRYPTO_MAX_ALG_NAME - 1] = 0;
698 EXPORT_SYMBOL_GPL(crypto_attr_alg_name);
700 struct crypto_alg *crypto_attr_alg2(struct rtattr *rta,
701 const struct crypto_type *frontend,
707 name = crypto_attr_alg_name(rta);
712 return crypto_find_alg(name, frontend, type, mask);
714 EXPORT_SYMBOL_GPL(crypto_attr_alg2);
716 int crypto_attr_u32(struct rtattr *rta, u32 *num)
718 struct crypto_attr_u32 *nu32;
722 if (RTA_PAYLOAD(rta) < sizeof(*nu32))
724 if (rta->rta_type != CRYPTOA_U32)
727 nu32 = RTA_DATA(rta);
732 EXPORT_SYMBOL_GPL(crypto_attr_u32);
734 void *crypto_alloc_instance2(const char *name, struct crypto_alg *alg,
737 struct crypto_instance *inst;
741 p = kzalloc(head + sizeof(*inst) + sizeof(struct crypto_spawn),
744 return ERR_PTR(-ENOMEM);
746 inst = (void *)(p + head);
749 if (snprintf(inst->alg.cra_name, CRYPTO_MAX_ALG_NAME, "%s(%s)", name,
750 alg->cra_name) >= CRYPTO_MAX_ALG_NAME)
753 if (snprintf(inst->alg.cra_driver_name, CRYPTO_MAX_ALG_NAME, "%s(%s)",
754 name, alg->cra_driver_name) >= CRYPTO_MAX_ALG_NAME)
763 EXPORT_SYMBOL_GPL(crypto_alloc_instance2);
765 struct crypto_instance *crypto_alloc_instance(const char *name,
766 struct crypto_alg *alg)
768 struct crypto_instance *inst;
769 struct crypto_spawn *spawn;
772 inst = crypto_alloc_instance2(name, alg, 0);
776 spawn = crypto_instance_ctx(inst);
777 err = crypto_init_spawn(spawn, alg, inst,
778 CRYPTO_ALG_TYPE_MASK | CRYPTO_ALG_ASYNC);
792 EXPORT_SYMBOL_GPL(crypto_alloc_instance);
794 void crypto_init_queue(struct crypto_queue *queue, unsigned int max_qlen)
796 INIT_LIST_HEAD(&queue->list);
797 queue->backlog = &queue->list;
799 queue->max_qlen = max_qlen;
801 EXPORT_SYMBOL_GPL(crypto_init_queue);
803 int crypto_enqueue_request(struct crypto_queue *queue,
804 struct crypto_async_request *request)
806 int err = -EINPROGRESS;
808 if (unlikely(queue->qlen >= queue->max_qlen)) {
810 if (!(request->flags & CRYPTO_TFM_REQ_MAY_BACKLOG))
812 if (queue->backlog == &queue->list)
813 queue->backlog = &request->list;
817 list_add_tail(&request->list, &queue->list);
822 EXPORT_SYMBOL_GPL(crypto_enqueue_request);
824 void *__crypto_dequeue_request(struct crypto_queue *queue, unsigned int offset)
826 struct list_head *request;
828 if (unlikely(!queue->qlen))
833 if (queue->backlog != &queue->list)
834 queue->backlog = queue->backlog->next;
836 request = queue->list.next;
839 return (char *)list_entry(request, struct crypto_async_request, list) -
842 EXPORT_SYMBOL_GPL(__crypto_dequeue_request);
844 struct crypto_async_request *crypto_dequeue_request(struct crypto_queue *queue)
846 return __crypto_dequeue_request(queue, 0);
848 EXPORT_SYMBOL_GPL(crypto_dequeue_request);
850 int crypto_tfm_in_queue(struct crypto_queue *queue, struct crypto_tfm *tfm)
852 struct crypto_async_request *req;
854 list_for_each_entry(req, &queue->list, list) {
861 EXPORT_SYMBOL_GPL(crypto_tfm_in_queue);
863 static inline void crypto_inc_byte(u8 *a, unsigned int size)
868 for (; size; size--) {
876 void crypto_inc(u8 *a, unsigned int size)
878 __be32 *b = (__be32 *)(a + size);
881 for (; size >= 4; size -= 4) {
882 c = be32_to_cpu(*--b) + 1;
888 crypto_inc_byte(a, size);
890 EXPORT_SYMBOL_GPL(crypto_inc);
892 static inline void crypto_xor_byte(u8 *a, const u8 *b, unsigned int size)
898 void crypto_xor(u8 *dst, const u8 *src, unsigned int size)
903 for (; size >= 4; size -= 4)
906 crypto_xor_byte((u8 *)a, (u8 *)b, size);
908 EXPORT_SYMBOL_GPL(crypto_xor);
910 static int __init crypto_algapi_init(void)
916 static void __exit crypto_algapi_exit(void)
921 module_init(crypto_algapi_init);
922 module_exit(crypto_algapi_exit);
924 MODULE_LICENSE("GPL");
925 MODULE_DESCRIPTION("Cryptographic algorithms API");