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 int crypto_check_alg(struct crypto_alg
*alg
)
46 if (alg
->cra_alignmask
& (alg
->cra_alignmask
+ 1))
49 if (alg
->cra_blocksize
> PAGE_SIZE
/ 8)
52 if (alg
->cra_priority
< 0)
55 return crypto_set_driver_name(alg
);
58 static void crypto_destroy_instance(struct crypto_alg
*alg
)
60 struct crypto_instance
*inst
= (void *)alg
;
61 struct crypto_template
*tmpl
= inst
->tmpl
;
64 crypto_tmpl_put(tmpl
);
67 static struct list_head
*crypto_more_spawns(struct crypto_alg
*alg
,
68 struct list_head
*stack
,
69 struct list_head
*top
,
70 struct list_head
*secondary_spawns
)
72 struct crypto_spawn
*spawn
, *n
;
74 if (list_empty(stack
))
77 spawn
= list_first_entry(stack
, struct crypto_spawn
, list
);
78 n
= list_entry(spawn
->list
.next
, struct crypto_spawn
, list
);
80 if (spawn
->alg
&& &n
->list
!= stack
&& !n
->alg
)
81 n
->alg
= (n
->list
.next
== stack
) ? alg
:
82 &list_entry(n
->list
.next
, struct crypto_spawn
,
85 list_move(&spawn
->list
, secondary_spawns
);
87 return &n
->list
== stack
? top
: &n
->inst
->alg
.cra_users
;
90 static void crypto_remove_spawn(struct crypto_spawn
*spawn
,
91 struct list_head
*list
)
93 struct crypto_instance
*inst
= spawn
->inst
;
94 struct crypto_template
*tmpl
= inst
->tmpl
;
96 if (crypto_is_dead(&inst
->alg
))
99 inst
->alg
.cra_flags
|= CRYPTO_ALG_DEAD
;
100 if (hlist_unhashed(&inst
->list
))
103 if (!tmpl
|| !crypto_tmpl_get(tmpl
))
106 crypto_notify(CRYPTO_MSG_ALG_UNREGISTER
, &inst
->alg
);
107 list_move(&inst
->alg
.cra_list
, list
);
108 hlist_del(&inst
->list
);
109 inst
->alg
.cra_destroy
= crypto_destroy_instance
;
111 BUG_ON(!list_empty(&inst
->alg
.cra_users
));
114 void crypto_remove_spawns(struct crypto_alg
*alg
, struct list_head
*list
,
115 struct crypto_alg
*nalg
)
117 u32 new_type
= (nalg
?: alg
)->cra_flags
;
118 struct crypto_spawn
*spawn
, *n
;
119 LIST_HEAD(secondary_spawns
);
120 struct list_head
*spawns
;
124 spawns
= &alg
->cra_users
;
125 list_for_each_entry_safe(spawn
, n
, spawns
, list
) {
126 if ((spawn
->alg
->cra_flags
^ new_type
) & spawn
->mask
)
129 list_move(&spawn
->list
, &top
);
134 while (!list_empty(spawns
)) {
135 struct crypto_instance
*inst
;
137 spawn
= list_first_entry(spawns
, struct crypto_spawn
,
141 BUG_ON(&inst
->alg
== alg
);
143 list_move(&spawn
->list
, &stack
);
145 if (&inst
->alg
== nalg
)
149 spawns
= &inst
->alg
.cra_users
;
151 } while ((spawns
= crypto_more_spawns(alg
, &stack
, &top
,
152 &secondary_spawns
)));
154 list_for_each_entry_safe(spawn
, n
, &secondary_spawns
, list
) {
156 list_move(&spawn
->list
, &spawn
->alg
->cra_users
);
158 crypto_remove_spawn(spawn
, list
);
161 EXPORT_SYMBOL_GPL(crypto_remove_spawns
);
163 static struct crypto_larval
*__crypto_register_alg(struct crypto_alg
*alg
)
165 struct crypto_alg
*q
;
166 struct crypto_larval
*larval
;
169 if (crypto_is_dead(alg
))
172 INIT_LIST_HEAD(&alg
->cra_users
);
175 alg
->cra_flags
&= ~CRYPTO_ALG_TESTED
;
179 atomic_set(&alg
->cra_refcnt
, 1);
180 list_for_each_entry(q
, &crypto_alg_list
, cra_list
) {
184 if (crypto_is_moribund(q
))
187 if (crypto_is_larval(q
)) {
188 if (!strcmp(alg
->cra_driver_name
, q
->cra_driver_name
))
193 if (!strcmp(q
->cra_driver_name
, alg
->cra_name
) ||
194 !strcmp(q
->cra_name
, alg
->cra_driver_name
))
198 larval
= crypto_larval_alloc(alg
->cra_name
,
199 alg
->cra_flags
| CRYPTO_ALG_TESTED
, 0);
204 larval
->adult
= crypto_mod_get(alg
);
208 atomic_set(&larval
->alg
.cra_refcnt
, 1);
209 memcpy(larval
->alg
.cra_driver_name
, alg
->cra_driver_name
,
210 CRYPTO_MAX_ALG_NAME
);
211 larval
->alg
.cra_priority
= alg
->cra_priority
;
213 list_add(&alg
->cra_list
, &crypto_alg_list
);
214 list_add(&larval
->alg
.cra_list
, &crypto_alg_list
);
222 larval
= ERR_PTR(ret
);
226 void crypto_alg_tested(const char *name
, int err
)
228 struct crypto_larval
*test
;
229 struct crypto_alg
*alg
;
230 struct crypto_alg
*q
;
233 down_write(&crypto_alg_sem
);
234 list_for_each_entry(q
, &crypto_alg_list
, cra_list
) {
235 if (crypto_is_moribund(q
) || !crypto_is_larval(q
))
238 test
= (struct crypto_larval
*)q
;
240 if (!strcmp(q
->cra_driver_name
, name
))
244 printk(KERN_ERR
"alg: Unexpected test result for %s: %d\n", name
, err
);
248 q
->cra_flags
|= CRYPTO_ALG_DEAD
;
250 if (err
|| list_empty(&alg
->cra_list
))
253 alg
->cra_flags
|= CRYPTO_ALG_TESTED
;
255 list_for_each_entry(q
, &crypto_alg_list
, cra_list
) {
259 if (crypto_is_moribund(q
))
262 if (crypto_is_larval(q
)) {
263 struct crypto_larval
*larval
= (void *)q
;
266 * Check to see if either our generic name or
267 * specific name can satisfy the name requested
268 * by the larval entry q.
270 if (strcmp(alg
->cra_name
, q
->cra_name
) &&
271 strcmp(alg
->cra_driver_name
, q
->cra_name
))
276 if ((q
->cra_flags
^ alg
->cra_flags
) & larval
->mask
)
278 if (!crypto_mod_get(alg
))
285 if (strcmp(alg
->cra_name
, q
->cra_name
))
288 if (strcmp(alg
->cra_driver_name
, q
->cra_driver_name
) &&
289 q
->cra_priority
> alg
->cra_priority
)
292 crypto_remove_spawns(q
, &list
, alg
);
296 complete_all(&test
->completion
);
299 up_write(&crypto_alg_sem
);
301 crypto_remove_final(&list
);
303 EXPORT_SYMBOL_GPL(crypto_alg_tested
);
305 void crypto_remove_final(struct list_head
*list
)
307 struct crypto_alg
*alg
;
308 struct crypto_alg
*n
;
310 list_for_each_entry_safe(alg
, n
, list
, cra_list
) {
311 list_del_init(&alg
->cra_list
);
315 EXPORT_SYMBOL_GPL(crypto_remove_final
);
317 static void crypto_wait_for_test(struct crypto_larval
*larval
)
321 err
= crypto_probing_notify(CRYPTO_MSG_ALG_REGISTER
, larval
->adult
);
322 if (err
!= NOTIFY_STOP
) {
323 if (WARN_ON(err
!= NOTIFY_DONE
))
325 crypto_alg_tested(larval
->alg
.cra_driver_name
, 0);
328 err
= wait_for_completion_interruptible(&larval
->completion
);
332 crypto_larval_kill(&larval
->alg
);
335 int crypto_register_alg(struct crypto_alg
*alg
)
337 struct crypto_larval
*larval
;
340 err
= crypto_check_alg(alg
);
344 down_write(&crypto_alg_sem
);
345 larval
= __crypto_register_alg(alg
);
346 up_write(&crypto_alg_sem
);
349 return PTR_ERR(larval
);
351 crypto_wait_for_test(larval
);
354 EXPORT_SYMBOL_GPL(crypto_register_alg
);
356 static int crypto_remove_alg(struct crypto_alg
*alg
, struct list_head
*list
)
358 if (unlikely(list_empty(&alg
->cra_list
)))
361 alg
->cra_flags
|= CRYPTO_ALG_DEAD
;
363 crypto_notify(CRYPTO_MSG_ALG_UNREGISTER
, alg
);
364 list_del_init(&alg
->cra_list
);
365 crypto_remove_spawns(alg
, list
, NULL
);
370 int crypto_unregister_alg(struct crypto_alg
*alg
)
375 down_write(&crypto_alg_sem
);
376 ret
= crypto_remove_alg(alg
, &list
);
377 up_write(&crypto_alg_sem
);
382 BUG_ON(atomic_read(&alg
->cra_refcnt
) != 1);
383 if (alg
->cra_destroy
)
384 alg
->cra_destroy(alg
);
386 crypto_remove_final(&list
);
389 EXPORT_SYMBOL_GPL(crypto_unregister_alg
);
391 int crypto_register_algs(struct crypto_alg
*algs
, int count
)
395 for (i
= 0; i
< count
; i
++) {
396 ret
= crypto_register_alg(&algs
[i
]);
404 for (--i
; i
>= 0; --i
)
405 crypto_unregister_alg(&algs
[i
]);
409 EXPORT_SYMBOL_GPL(crypto_register_algs
);
411 int crypto_unregister_algs(struct crypto_alg
*algs
, int count
)
415 for (i
= 0; i
< count
; i
++) {
416 ret
= crypto_unregister_alg(&algs
[i
]);
418 pr_err("Failed to unregister %s %s: %d\n",
419 algs
[i
].cra_driver_name
, algs
[i
].cra_name
, ret
);
424 EXPORT_SYMBOL_GPL(crypto_unregister_algs
);
426 int crypto_register_template(struct crypto_template
*tmpl
)
428 struct crypto_template
*q
;
431 down_write(&crypto_alg_sem
);
433 list_for_each_entry(q
, &crypto_template_list
, list
) {
438 list_add(&tmpl
->list
, &crypto_template_list
);
439 crypto_notify(CRYPTO_MSG_TMPL_REGISTER
, tmpl
);
442 up_write(&crypto_alg_sem
);
445 EXPORT_SYMBOL_GPL(crypto_register_template
);
447 void crypto_unregister_template(struct crypto_template
*tmpl
)
449 struct crypto_instance
*inst
;
450 struct hlist_node
*n
;
451 struct hlist_head
*list
;
454 down_write(&crypto_alg_sem
);
456 BUG_ON(list_empty(&tmpl
->list
));
457 list_del_init(&tmpl
->list
);
459 list
= &tmpl
->instances
;
460 hlist_for_each_entry(inst
, list
, list
) {
461 int err
= crypto_remove_alg(&inst
->alg
, &users
);
465 crypto_notify(CRYPTO_MSG_TMPL_UNREGISTER
, tmpl
);
467 up_write(&crypto_alg_sem
);
469 hlist_for_each_entry_safe(inst
, n
, list
, list
) {
470 BUG_ON(atomic_read(&inst
->alg
.cra_refcnt
) != 1);
473 crypto_remove_final(&users
);
475 EXPORT_SYMBOL_GPL(crypto_unregister_template
);
477 static struct crypto_template
*__crypto_lookup_template(const char *name
)
479 struct crypto_template
*q
, *tmpl
= NULL
;
481 down_read(&crypto_alg_sem
);
482 list_for_each_entry(q
, &crypto_template_list
, list
) {
483 if (strcmp(q
->name
, name
))
485 if (unlikely(!crypto_tmpl_get(q
)))
491 up_read(&crypto_alg_sem
);
496 struct crypto_template
*crypto_lookup_template(const char *name
)
498 return try_then_request_module(__crypto_lookup_template(name
),
501 EXPORT_SYMBOL_GPL(crypto_lookup_template
);
503 int crypto_register_instance(struct crypto_template
*tmpl
,
504 struct crypto_instance
*inst
)
506 struct crypto_larval
*larval
;
509 err
= crypto_check_alg(&inst
->alg
);
513 inst
->alg
.cra_module
= tmpl
->module
;
514 inst
->alg
.cra_flags
|= CRYPTO_ALG_INSTANCE
;
516 down_write(&crypto_alg_sem
);
518 larval
= __crypto_register_alg(&inst
->alg
);
522 hlist_add_head(&inst
->list
, &tmpl
->instances
);
526 up_write(&crypto_alg_sem
);
528 err
= PTR_ERR(larval
);
532 crypto_wait_for_test(larval
);
538 EXPORT_SYMBOL_GPL(crypto_register_instance
);
540 int crypto_unregister_instance(struct crypto_alg
*alg
)
543 struct crypto_instance
*inst
= (void *)alg
;
544 struct crypto_template
*tmpl
= inst
->tmpl
;
547 if (!(alg
->cra_flags
& CRYPTO_ALG_INSTANCE
))
550 BUG_ON(atomic_read(&alg
->cra_refcnt
) != 1);
552 down_write(&crypto_alg_sem
);
554 hlist_del_init(&inst
->list
);
555 err
= crypto_remove_alg(alg
, &users
);
557 up_write(&crypto_alg_sem
);
563 crypto_remove_final(&users
);
567 EXPORT_SYMBOL_GPL(crypto_unregister_instance
);
569 int crypto_init_spawn(struct crypto_spawn
*spawn
, struct crypto_alg
*alg
,
570 struct crypto_instance
*inst
, u32 mask
)
577 down_write(&crypto_alg_sem
);
578 if (!crypto_is_moribund(alg
)) {
579 list_add(&spawn
->list
, &alg
->cra_users
);
583 up_write(&crypto_alg_sem
);
587 EXPORT_SYMBOL_GPL(crypto_init_spawn
);
589 int crypto_init_spawn2(struct crypto_spawn
*spawn
, struct crypto_alg
*alg
,
590 struct crypto_instance
*inst
,
591 const struct crypto_type
*frontend
)
595 if ((alg
->cra_flags
^ frontend
->type
) & frontend
->maskset
)
598 spawn
->frontend
= frontend
;
599 err
= crypto_init_spawn(spawn
, alg
, inst
, frontend
->maskset
);
604 EXPORT_SYMBOL_GPL(crypto_init_spawn2
);
606 void crypto_drop_spawn(struct crypto_spawn
*spawn
)
611 down_write(&crypto_alg_sem
);
612 list_del(&spawn
->list
);
613 up_write(&crypto_alg_sem
);
615 EXPORT_SYMBOL_GPL(crypto_drop_spawn
);
617 static struct crypto_alg
*crypto_spawn_alg(struct crypto_spawn
*spawn
)
619 struct crypto_alg
*alg
;
620 struct crypto_alg
*alg2
;
622 down_read(&crypto_alg_sem
);
626 alg2
= crypto_mod_get(alg2
);
627 up_read(&crypto_alg_sem
);
631 crypto_shoot_alg(alg
);
632 return ERR_PTR(-EAGAIN
);
638 struct crypto_tfm
*crypto_spawn_tfm(struct crypto_spawn
*spawn
, u32 type
,
641 struct crypto_alg
*alg
;
642 struct crypto_tfm
*tfm
;
644 alg
= crypto_spawn_alg(spawn
);
646 return ERR_CAST(alg
);
648 tfm
= ERR_PTR(-EINVAL
);
649 if (unlikely((alg
->cra_flags
^ type
) & mask
))
652 tfm
= __crypto_alloc_tfm(alg
, type
, mask
);
662 EXPORT_SYMBOL_GPL(crypto_spawn_tfm
);
664 void *crypto_spawn_tfm2(struct crypto_spawn
*spawn
)
666 struct crypto_alg
*alg
;
667 struct crypto_tfm
*tfm
;
669 alg
= crypto_spawn_alg(spawn
);
671 return ERR_CAST(alg
);
673 tfm
= crypto_create_tfm(alg
, spawn
->frontend
);
683 EXPORT_SYMBOL_GPL(crypto_spawn_tfm2
);
685 int crypto_register_notifier(struct notifier_block
*nb
)
687 return blocking_notifier_chain_register(&crypto_chain
, nb
);
689 EXPORT_SYMBOL_GPL(crypto_register_notifier
);
691 int crypto_unregister_notifier(struct notifier_block
*nb
)
693 return blocking_notifier_chain_unregister(&crypto_chain
, nb
);
695 EXPORT_SYMBOL_GPL(crypto_unregister_notifier
);
697 struct crypto_attr_type
*crypto_get_attr_type(struct rtattr
**tb
)
699 struct rtattr
*rta
= tb
[0];
700 struct crypto_attr_type
*algt
;
703 return ERR_PTR(-ENOENT
);
704 if (RTA_PAYLOAD(rta
) < sizeof(*algt
))
705 return ERR_PTR(-EINVAL
);
706 if (rta
->rta_type
!= CRYPTOA_TYPE
)
707 return ERR_PTR(-EINVAL
);
709 algt
= RTA_DATA(rta
);
713 EXPORT_SYMBOL_GPL(crypto_get_attr_type
);
715 int crypto_check_attr_type(struct rtattr
**tb
, u32 type
)
717 struct crypto_attr_type
*algt
;
719 algt
= crypto_get_attr_type(tb
);
721 return PTR_ERR(algt
);
723 if ((algt
->type
^ type
) & algt
->mask
)
728 EXPORT_SYMBOL_GPL(crypto_check_attr_type
);
730 const char *crypto_attr_alg_name(struct rtattr
*rta
)
732 struct crypto_attr_alg
*alga
;
735 return ERR_PTR(-ENOENT
);
736 if (RTA_PAYLOAD(rta
) < sizeof(*alga
))
737 return ERR_PTR(-EINVAL
);
738 if (rta
->rta_type
!= CRYPTOA_ALG
)
739 return ERR_PTR(-EINVAL
);
741 alga
= RTA_DATA(rta
);
742 alga
->name
[CRYPTO_MAX_ALG_NAME
- 1] = 0;
746 EXPORT_SYMBOL_GPL(crypto_attr_alg_name
);
748 struct crypto_alg
*crypto_attr_alg2(struct rtattr
*rta
,
749 const struct crypto_type
*frontend
,
754 name
= crypto_attr_alg_name(rta
);
756 return ERR_CAST(name
);
758 return crypto_find_alg(name
, frontend
, type
, mask
);
760 EXPORT_SYMBOL_GPL(crypto_attr_alg2
);
762 int crypto_attr_u32(struct rtattr
*rta
, u32
*num
)
764 struct crypto_attr_u32
*nu32
;
768 if (RTA_PAYLOAD(rta
) < sizeof(*nu32
))
770 if (rta
->rta_type
!= CRYPTOA_U32
)
773 nu32
= RTA_DATA(rta
);
778 EXPORT_SYMBOL_GPL(crypto_attr_u32
);
780 void *crypto_alloc_instance2(const char *name
, struct crypto_alg
*alg
,
783 struct crypto_instance
*inst
;
787 p
= kzalloc(head
+ sizeof(*inst
) + sizeof(struct crypto_spawn
),
790 return ERR_PTR(-ENOMEM
);
792 inst
= (void *)(p
+ head
);
795 if (snprintf(inst
->alg
.cra_name
, CRYPTO_MAX_ALG_NAME
, "%s(%s)", name
,
796 alg
->cra_name
) >= CRYPTO_MAX_ALG_NAME
)
799 if (snprintf(inst
->alg
.cra_driver_name
, CRYPTO_MAX_ALG_NAME
, "%s(%s)",
800 name
, alg
->cra_driver_name
) >= CRYPTO_MAX_ALG_NAME
)
809 EXPORT_SYMBOL_GPL(crypto_alloc_instance2
);
811 struct crypto_instance
*crypto_alloc_instance(const char *name
,
812 struct crypto_alg
*alg
)
814 struct crypto_instance
*inst
;
815 struct crypto_spawn
*spawn
;
818 inst
= crypto_alloc_instance2(name
, alg
, 0);
822 spawn
= crypto_instance_ctx(inst
);
823 err
= crypto_init_spawn(spawn
, alg
, inst
,
824 CRYPTO_ALG_TYPE_MASK
| CRYPTO_ALG_ASYNC
);
838 EXPORT_SYMBOL_GPL(crypto_alloc_instance
);
840 void crypto_init_queue(struct crypto_queue
*queue
, unsigned int max_qlen
)
842 INIT_LIST_HEAD(&queue
->list
);
843 queue
->backlog
= &queue
->list
;
845 queue
->max_qlen
= max_qlen
;
847 EXPORT_SYMBOL_GPL(crypto_init_queue
);
849 int crypto_enqueue_request(struct crypto_queue
*queue
,
850 struct crypto_async_request
*request
)
852 int err
= -EINPROGRESS
;
854 if (unlikely(queue
->qlen
>= queue
->max_qlen
)) {
856 if (!(request
->flags
& CRYPTO_TFM_REQ_MAY_BACKLOG
))
858 if (queue
->backlog
== &queue
->list
)
859 queue
->backlog
= &request
->list
;
863 list_add_tail(&request
->list
, &queue
->list
);
868 EXPORT_SYMBOL_GPL(crypto_enqueue_request
);
870 void *__crypto_dequeue_request(struct crypto_queue
*queue
, unsigned int offset
)
872 struct list_head
*request
;
874 if (unlikely(!queue
->qlen
))
879 if (queue
->backlog
!= &queue
->list
)
880 queue
->backlog
= queue
->backlog
->next
;
882 request
= queue
->list
.next
;
885 return (char *)list_entry(request
, struct crypto_async_request
, list
) -
888 EXPORT_SYMBOL_GPL(__crypto_dequeue_request
);
890 struct crypto_async_request
*crypto_dequeue_request(struct crypto_queue
*queue
)
892 return __crypto_dequeue_request(queue
, 0);
894 EXPORT_SYMBOL_GPL(crypto_dequeue_request
);
896 int crypto_tfm_in_queue(struct crypto_queue
*queue
, struct crypto_tfm
*tfm
)
898 struct crypto_async_request
*req
;
900 list_for_each_entry(req
, &queue
->list
, list
) {
907 EXPORT_SYMBOL_GPL(crypto_tfm_in_queue
);
909 static inline void crypto_inc_byte(u8
*a
, unsigned int size
)
914 for (; size
; size
--) {
922 void crypto_inc(u8
*a
, unsigned int size
)
924 __be32
*b
= (__be32
*)(a
+ size
);
927 for (; size
>= 4; size
-= 4) {
928 c
= be32_to_cpu(*--b
) + 1;
934 crypto_inc_byte(a
, size
);
936 EXPORT_SYMBOL_GPL(crypto_inc
);
938 static inline void crypto_xor_byte(u8
*a
, const u8
*b
, unsigned int size
)
944 void crypto_xor(u8
*dst
, const u8
*src
, unsigned int size
)
949 for (; size
>= 4; size
-= 4)
952 crypto_xor_byte((u8
*)a
, (u8
*)b
, size
);
954 EXPORT_SYMBOL_GPL(crypto_xor
);
956 static int __init
crypto_algapi_init(void)
962 static void __exit
crypto_algapi_exit(void)
967 module_init(crypto_algapi_init
);
968 module_exit(crypto_algapi_exit
);
970 MODULE_LICENSE("GPL");
971 MODULE_DESCRIPTION("Cryptographic algorithms API");