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 void crypto_larval_error(const char *name
, u32 type
, u32 mask
)
29 struct crypto_alg
*alg
;
31 alg
= crypto_alg_lookup(name
, type
, mask
);
34 if (crypto_is_larval(alg
)) {
35 struct crypto_larval
*larval
= (void *)alg
;
36 complete_all(&larval
->completion
);
41 EXPORT_SYMBOL_GPL(crypto_larval_error
);
43 static inline int crypto_set_driver_name(struct crypto_alg
*alg
)
45 static const char suffix
[] = "-generic";
46 char *driver_name
= alg
->cra_driver_name
;
52 len
= strlcpy(driver_name
, alg
->cra_name
, CRYPTO_MAX_ALG_NAME
);
53 if (len
+ sizeof(suffix
) > CRYPTO_MAX_ALG_NAME
)
56 memcpy(driver_name
+ len
, suffix
, sizeof(suffix
));
60 static int crypto_check_alg(struct crypto_alg
*alg
)
62 if (alg
->cra_alignmask
& (alg
->cra_alignmask
+ 1))
65 if (alg
->cra_blocksize
> PAGE_SIZE
/ 8)
68 if (alg
->cra_priority
< 0)
71 return crypto_set_driver_name(alg
);
74 static void crypto_destroy_instance(struct crypto_alg
*alg
)
76 struct crypto_instance
*inst
= (void *)alg
;
77 struct crypto_template
*tmpl
= inst
->tmpl
;
80 crypto_tmpl_put(tmpl
);
83 static struct list_head
*crypto_more_spawns(struct crypto_alg
*alg
,
84 struct list_head
*stack
,
85 struct list_head
*top
,
86 struct list_head
*secondary_spawns
)
88 struct crypto_spawn
*spawn
, *n
;
90 if (list_empty(stack
))
93 spawn
= list_first_entry(stack
, struct crypto_spawn
, list
);
94 n
= list_entry(spawn
->list
.next
, struct crypto_spawn
, list
);
96 if (spawn
->alg
&& &n
->list
!= stack
&& !n
->alg
)
97 n
->alg
= (n
->list
.next
== stack
) ? alg
:
98 &list_entry(n
->list
.next
, struct crypto_spawn
,
101 list_move(&spawn
->list
, secondary_spawns
);
103 return &n
->list
== stack
? top
: &n
->inst
->alg
.cra_users
;
106 static void crypto_remove_spawn(struct crypto_spawn
*spawn
,
107 struct list_head
*list
)
109 struct crypto_instance
*inst
= spawn
->inst
;
110 struct crypto_template
*tmpl
= inst
->tmpl
;
112 if (crypto_is_dead(&inst
->alg
))
115 inst
->alg
.cra_flags
|= CRYPTO_ALG_DEAD
;
116 if (hlist_unhashed(&inst
->list
))
119 if (!tmpl
|| !crypto_tmpl_get(tmpl
))
122 crypto_notify(CRYPTO_MSG_ALG_UNREGISTER
, &inst
->alg
);
123 list_move(&inst
->alg
.cra_list
, list
);
124 hlist_del(&inst
->list
);
125 inst
->alg
.cra_destroy
= crypto_destroy_instance
;
127 BUG_ON(!list_empty(&inst
->alg
.cra_users
));
130 void crypto_remove_spawns(struct crypto_alg
*alg
, struct list_head
*list
,
131 struct crypto_alg
*nalg
)
133 u32 new_type
= (nalg
?: alg
)->cra_flags
;
134 struct crypto_spawn
*spawn
, *n
;
135 LIST_HEAD(secondary_spawns
);
136 struct list_head
*spawns
;
140 spawns
= &alg
->cra_users
;
141 list_for_each_entry_safe(spawn
, n
, spawns
, list
) {
142 if ((spawn
->alg
->cra_flags
^ new_type
) & spawn
->mask
)
145 list_move(&spawn
->list
, &top
);
150 while (!list_empty(spawns
)) {
151 struct crypto_instance
*inst
;
153 spawn
= list_first_entry(spawns
, struct crypto_spawn
,
157 BUG_ON(&inst
->alg
== alg
);
159 list_move(&spawn
->list
, &stack
);
161 if (&inst
->alg
== nalg
)
165 spawns
= &inst
->alg
.cra_users
;
167 } while ((spawns
= crypto_more_spawns(alg
, &stack
, &top
,
168 &secondary_spawns
)));
170 list_for_each_entry_safe(spawn
, n
, &secondary_spawns
, list
) {
172 list_move(&spawn
->list
, &spawn
->alg
->cra_users
);
174 crypto_remove_spawn(spawn
, list
);
177 EXPORT_SYMBOL_GPL(crypto_remove_spawns
);
179 static struct crypto_larval
*__crypto_register_alg(struct crypto_alg
*alg
)
181 struct crypto_alg
*q
;
182 struct crypto_larval
*larval
;
185 if (crypto_is_dead(alg
))
188 INIT_LIST_HEAD(&alg
->cra_users
);
191 alg
->cra_flags
&= ~CRYPTO_ALG_TESTED
;
195 atomic_set(&alg
->cra_refcnt
, 1);
196 list_for_each_entry(q
, &crypto_alg_list
, cra_list
) {
200 if (crypto_is_moribund(q
))
203 if (crypto_is_larval(q
)) {
204 if (!strcmp(alg
->cra_driver_name
, q
->cra_driver_name
))
209 if (!strcmp(q
->cra_driver_name
, alg
->cra_name
) ||
210 !strcmp(q
->cra_name
, alg
->cra_driver_name
))
214 larval
= crypto_larval_alloc(alg
->cra_name
,
215 alg
->cra_flags
| CRYPTO_ALG_TESTED
, 0);
220 larval
->adult
= crypto_mod_get(alg
);
224 atomic_set(&larval
->alg
.cra_refcnt
, 1);
225 memcpy(larval
->alg
.cra_driver_name
, alg
->cra_driver_name
,
226 CRYPTO_MAX_ALG_NAME
);
227 larval
->alg
.cra_priority
= alg
->cra_priority
;
229 list_add(&alg
->cra_list
, &crypto_alg_list
);
230 list_add(&larval
->alg
.cra_list
, &crypto_alg_list
);
238 larval
= ERR_PTR(ret
);
242 void crypto_alg_tested(const char *name
, int err
)
244 struct crypto_larval
*test
;
245 struct crypto_alg
*alg
;
246 struct crypto_alg
*q
;
249 down_write(&crypto_alg_sem
);
250 list_for_each_entry(q
, &crypto_alg_list
, cra_list
) {
251 if (crypto_is_moribund(q
) || !crypto_is_larval(q
))
254 test
= (struct crypto_larval
*)q
;
256 if (!strcmp(q
->cra_driver_name
, name
))
260 printk(KERN_ERR
"alg: Unexpected test result for %s: %d\n", name
, err
);
264 q
->cra_flags
|= CRYPTO_ALG_DEAD
;
266 if (err
|| list_empty(&alg
->cra_list
))
269 alg
->cra_flags
|= CRYPTO_ALG_TESTED
;
271 list_for_each_entry(q
, &crypto_alg_list
, cra_list
) {
275 if (crypto_is_moribund(q
))
278 if (crypto_is_larval(q
)) {
279 struct crypto_larval
*larval
= (void *)q
;
282 * Check to see if either our generic name or
283 * specific name can satisfy the name requested
284 * by the larval entry q.
286 if (strcmp(alg
->cra_name
, q
->cra_name
) &&
287 strcmp(alg
->cra_driver_name
, q
->cra_name
))
292 if ((q
->cra_flags
^ alg
->cra_flags
) & larval
->mask
)
294 if (!crypto_mod_get(alg
))
298 complete_all(&larval
->completion
);
302 if (strcmp(alg
->cra_name
, q
->cra_name
))
305 if (strcmp(alg
->cra_driver_name
, q
->cra_driver_name
) &&
306 q
->cra_priority
> alg
->cra_priority
)
309 crypto_remove_spawns(q
, &list
, alg
);
313 complete_all(&test
->completion
);
316 up_write(&crypto_alg_sem
);
318 crypto_remove_final(&list
);
320 EXPORT_SYMBOL_GPL(crypto_alg_tested
);
322 void crypto_remove_final(struct list_head
*list
)
324 struct crypto_alg
*alg
;
325 struct crypto_alg
*n
;
327 list_for_each_entry_safe(alg
, n
, list
, cra_list
) {
328 list_del_init(&alg
->cra_list
);
332 EXPORT_SYMBOL_GPL(crypto_remove_final
);
334 static void crypto_wait_for_test(struct crypto_larval
*larval
)
338 err
= crypto_probing_notify(CRYPTO_MSG_ALG_REGISTER
, larval
->adult
);
339 if (err
!= NOTIFY_STOP
) {
340 if (WARN_ON(err
!= NOTIFY_DONE
))
342 crypto_alg_tested(larval
->alg
.cra_driver_name
, 0);
345 err
= wait_for_completion_interruptible(&larval
->completion
);
349 crypto_larval_kill(&larval
->alg
);
352 int crypto_register_alg(struct crypto_alg
*alg
)
354 struct crypto_larval
*larval
;
357 err
= crypto_check_alg(alg
);
361 down_write(&crypto_alg_sem
);
362 larval
= __crypto_register_alg(alg
);
363 up_write(&crypto_alg_sem
);
366 return PTR_ERR(larval
);
368 crypto_wait_for_test(larval
);
371 EXPORT_SYMBOL_GPL(crypto_register_alg
);
373 static int crypto_remove_alg(struct crypto_alg
*alg
, struct list_head
*list
)
375 if (unlikely(list_empty(&alg
->cra_list
)))
378 alg
->cra_flags
|= CRYPTO_ALG_DEAD
;
380 crypto_notify(CRYPTO_MSG_ALG_UNREGISTER
, alg
);
381 list_del_init(&alg
->cra_list
);
382 crypto_remove_spawns(alg
, list
, NULL
);
387 int crypto_unregister_alg(struct crypto_alg
*alg
)
392 down_write(&crypto_alg_sem
);
393 ret
= crypto_remove_alg(alg
, &list
);
394 up_write(&crypto_alg_sem
);
399 BUG_ON(atomic_read(&alg
->cra_refcnt
) != 1);
400 if (alg
->cra_destroy
)
401 alg
->cra_destroy(alg
);
403 crypto_remove_final(&list
);
406 EXPORT_SYMBOL_GPL(crypto_unregister_alg
);
408 int crypto_register_template(struct crypto_template
*tmpl
)
410 struct crypto_template
*q
;
413 down_write(&crypto_alg_sem
);
415 list_for_each_entry(q
, &crypto_template_list
, list
) {
420 list_add(&tmpl
->list
, &crypto_template_list
);
421 crypto_notify(CRYPTO_MSG_TMPL_REGISTER
, tmpl
);
424 up_write(&crypto_alg_sem
);
427 EXPORT_SYMBOL_GPL(crypto_register_template
);
429 void crypto_unregister_template(struct crypto_template
*tmpl
)
431 struct crypto_instance
*inst
;
432 struct hlist_node
*p
, *n
;
433 struct hlist_head
*list
;
436 down_write(&crypto_alg_sem
);
438 BUG_ON(list_empty(&tmpl
->list
));
439 list_del_init(&tmpl
->list
);
441 list
= &tmpl
->instances
;
442 hlist_for_each_entry(inst
, p
, list
, list
) {
443 int err
= crypto_remove_alg(&inst
->alg
, &users
);
447 crypto_notify(CRYPTO_MSG_TMPL_UNREGISTER
, tmpl
);
449 up_write(&crypto_alg_sem
);
451 hlist_for_each_entry_safe(inst
, p
, n
, list
, list
) {
452 BUG_ON(atomic_read(&inst
->alg
.cra_refcnt
) != 1);
455 crypto_remove_final(&users
);
457 EXPORT_SYMBOL_GPL(crypto_unregister_template
);
459 static struct crypto_template
*__crypto_lookup_template(const char *name
)
461 struct crypto_template
*q
, *tmpl
= NULL
;
463 down_read(&crypto_alg_sem
);
464 list_for_each_entry(q
, &crypto_template_list
, list
) {
465 if (strcmp(q
->name
, name
))
467 if (unlikely(!crypto_tmpl_get(q
)))
473 up_read(&crypto_alg_sem
);
478 struct crypto_template
*crypto_lookup_template(const char *name
)
480 return try_then_request_module(__crypto_lookup_template(name
), name
);
482 EXPORT_SYMBOL_GPL(crypto_lookup_template
);
484 int crypto_register_instance(struct crypto_template
*tmpl
,
485 struct crypto_instance
*inst
)
487 struct crypto_larval
*larval
;
490 err
= crypto_check_alg(&inst
->alg
);
494 inst
->alg
.cra_module
= tmpl
->module
;
495 inst
->alg
.cra_flags
|= CRYPTO_ALG_INSTANCE
;
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_unregister_instance(struct crypto_alg
*alg
)
524 struct crypto_instance
*inst
= (void *)alg
;
525 struct crypto_template
*tmpl
= inst
->tmpl
;
528 if (!(alg
->cra_flags
& CRYPTO_ALG_INSTANCE
))
531 BUG_ON(atomic_read(&alg
->cra_refcnt
) != 1);
533 down_write(&crypto_alg_sem
);
535 hlist_del_init(&inst
->list
);
536 err
= crypto_remove_alg(alg
, &users
);
538 up_write(&crypto_alg_sem
);
544 crypto_remove_final(&users
);
548 EXPORT_SYMBOL_GPL(crypto_unregister_instance
);
550 int crypto_init_spawn(struct crypto_spawn
*spawn
, struct crypto_alg
*alg
,
551 struct crypto_instance
*inst
, u32 mask
)
558 down_write(&crypto_alg_sem
);
559 if (!crypto_is_moribund(alg
)) {
560 list_add(&spawn
->list
, &alg
->cra_users
);
564 up_write(&crypto_alg_sem
);
568 EXPORT_SYMBOL_GPL(crypto_init_spawn
);
570 int crypto_init_spawn2(struct crypto_spawn
*spawn
, struct crypto_alg
*alg
,
571 struct crypto_instance
*inst
,
572 const struct crypto_type
*frontend
)
576 if ((alg
->cra_flags
^ frontend
->type
) & frontend
->maskset
)
579 spawn
->frontend
= frontend
;
580 err
= crypto_init_spawn(spawn
, alg
, inst
, frontend
->maskset
);
585 EXPORT_SYMBOL_GPL(crypto_init_spawn2
);
587 void crypto_drop_spawn(struct crypto_spawn
*spawn
)
592 down_write(&crypto_alg_sem
);
593 list_del(&spawn
->list
);
594 up_write(&crypto_alg_sem
);
596 EXPORT_SYMBOL_GPL(crypto_drop_spawn
);
598 static struct crypto_alg
*crypto_spawn_alg(struct crypto_spawn
*spawn
)
600 struct crypto_alg
*alg
;
601 struct crypto_alg
*alg2
;
603 down_read(&crypto_alg_sem
);
607 alg2
= crypto_mod_get(alg2
);
608 up_read(&crypto_alg_sem
);
612 crypto_shoot_alg(alg
);
613 return ERR_PTR(-EAGAIN
);
619 struct crypto_tfm
*crypto_spawn_tfm(struct crypto_spawn
*spawn
, u32 type
,
622 struct crypto_alg
*alg
;
623 struct crypto_tfm
*tfm
;
625 alg
= crypto_spawn_alg(spawn
);
627 return ERR_CAST(alg
);
629 tfm
= ERR_PTR(-EINVAL
);
630 if (unlikely((alg
->cra_flags
^ type
) & mask
))
633 tfm
= __crypto_alloc_tfm(alg
, type
, mask
);
643 EXPORT_SYMBOL_GPL(crypto_spawn_tfm
);
645 void *crypto_spawn_tfm2(struct crypto_spawn
*spawn
)
647 struct crypto_alg
*alg
;
648 struct crypto_tfm
*tfm
;
650 alg
= crypto_spawn_alg(spawn
);
652 return ERR_CAST(alg
);
654 tfm
= crypto_create_tfm(alg
, spawn
->frontend
);
664 EXPORT_SYMBOL_GPL(crypto_spawn_tfm2
);
666 int crypto_register_notifier(struct notifier_block
*nb
)
668 return blocking_notifier_chain_register(&crypto_chain
, nb
);
670 EXPORT_SYMBOL_GPL(crypto_register_notifier
);
672 int crypto_unregister_notifier(struct notifier_block
*nb
)
674 return blocking_notifier_chain_unregister(&crypto_chain
, nb
);
676 EXPORT_SYMBOL_GPL(crypto_unregister_notifier
);
678 struct crypto_attr_type
*crypto_get_attr_type(struct rtattr
**tb
)
680 struct rtattr
*rta
= tb
[0];
681 struct crypto_attr_type
*algt
;
684 return ERR_PTR(-ENOENT
);
685 if (RTA_PAYLOAD(rta
) < sizeof(*algt
))
686 return ERR_PTR(-EINVAL
);
687 if (rta
->rta_type
!= CRYPTOA_TYPE
)
688 return ERR_PTR(-EINVAL
);
690 algt
= RTA_DATA(rta
);
694 EXPORT_SYMBOL_GPL(crypto_get_attr_type
);
696 int crypto_check_attr_type(struct rtattr
**tb
, u32 type
)
698 struct crypto_attr_type
*algt
;
700 algt
= crypto_get_attr_type(tb
);
702 return PTR_ERR(algt
);
704 if ((algt
->type
^ type
) & algt
->mask
)
709 EXPORT_SYMBOL_GPL(crypto_check_attr_type
);
711 const char *crypto_attr_alg_name(struct rtattr
*rta
)
713 struct crypto_attr_alg
*alga
;
716 return ERR_PTR(-ENOENT
);
717 if (RTA_PAYLOAD(rta
) < sizeof(*alga
))
718 return ERR_PTR(-EINVAL
);
719 if (rta
->rta_type
!= CRYPTOA_ALG
)
720 return ERR_PTR(-EINVAL
);
722 alga
= RTA_DATA(rta
);
723 alga
->name
[CRYPTO_MAX_ALG_NAME
- 1] = 0;
727 EXPORT_SYMBOL_GPL(crypto_attr_alg_name
);
729 struct crypto_alg
*crypto_attr_alg2(struct rtattr
*rta
,
730 const struct crypto_type
*frontend
,
736 name
= crypto_attr_alg_name(rta
);
741 return crypto_find_alg(name
, frontend
, type
, mask
);
743 EXPORT_SYMBOL_GPL(crypto_attr_alg2
);
745 int crypto_attr_u32(struct rtattr
*rta
, u32
*num
)
747 struct crypto_attr_u32
*nu32
;
751 if (RTA_PAYLOAD(rta
) < sizeof(*nu32
))
753 if (rta
->rta_type
!= CRYPTOA_U32
)
756 nu32
= RTA_DATA(rta
);
761 EXPORT_SYMBOL_GPL(crypto_attr_u32
);
763 void *crypto_alloc_instance2(const char *name
, struct crypto_alg
*alg
,
766 struct crypto_instance
*inst
;
770 p
= kzalloc(head
+ sizeof(*inst
) + sizeof(struct crypto_spawn
),
773 return ERR_PTR(-ENOMEM
);
775 inst
= (void *)(p
+ head
);
778 if (snprintf(inst
->alg
.cra_name
, CRYPTO_MAX_ALG_NAME
, "%s(%s)", name
,
779 alg
->cra_name
) >= CRYPTO_MAX_ALG_NAME
)
782 if (snprintf(inst
->alg
.cra_driver_name
, CRYPTO_MAX_ALG_NAME
, "%s(%s)",
783 name
, alg
->cra_driver_name
) >= CRYPTO_MAX_ALG_NAME
)
792 EXPORT_SYMBOL_GPL(crypto_alloc_instance2
);
794 struct crypto_instance
*crypto_alloc_instance(const char *name
,
795 struct crypto_alg
*alg
)
797 struct crypto_instance
*inst
;
798 struct crypto_spawn
*spawn
;
801 inst
= crypto_alloc_instance2(name
, alg
, 0);
805 spawn
= crypto_instance_ctx(inst
);
806 err
= crypto_init_spawn(spawn
, alg
, inst
,
807 CRYPTO_ALG_TYPE_MASK
| CRYPTO_ALG_ASYNC
);
821 EXPORT_SYMBOL_GPL(crypto_alloc_instance
);
823 void crypto_init_queue(struct crypto_queue
*queue
, unsigned int max_qlen
)
825 INIT_LIST_HEAD(&queue
->list
);
826 queue
->backlog
= &queue
->list
;
828 queue
->max_qlen
= max_qlen
;
830 EXPORT_SYMBOL_GPL(crypto_init_queue
);
832 int crypto_enqueue_request(struct crypto_queue
*queue
,
833 struct crypto_async_request
*request
)
835 int err
= -EINPROGRESS
;
837 if (unlikely(queue
->qlen
>= queue
->max_qlen
)) {
839 if (!(request
->flags
& CRYPTO_TFM_REQ_MAY_BACKLOG
))
841 if (queue
->backlog
== &queue
->list
)
842 queue
->backlog
= &request
->list
;
846 list_add_tail(&request
->list
, &queue
->list
);
851 EXPORT_SYMBOL_GPL(crypto_enqueue_request
);
853 void *__crypto_dequeue_request(struct crypto_queue
*queue
, unsigned int offset
)
855 struct list_head
*request
;
857 if (unlikely(!queue
->qlen
))
862 if (queue
->backlog
!= &queue
->list
)
863 queue
->backlog
= queue
->backlog
->next
;
865 request
= queue
->list
.next
;
868 return (char *)list_entry(request
, struct crypto_async_request
, list
) -
871 EXPORT_SYMBOL_GPL(__crypto_dequeue_request
);
873 struct crypto_async_request
*crypto_dequeue_request(struct crypto_queue
*queue
)
875 return __crypto_dequeue_request(queue
, 0);
877 EXPORT_SYMBOL_GPL(crypto_dequeue_request
);
879 int crypto_tfm_in_queue(struct crypto_queue
*queue
, struct crypto_tfm
*tfm
)
881 struct crypto_async_request
*req
;
883 list_for_each_entry(req
, &queue
->list
, list
) {
890 EXPORT_SYMBOL_GPL(crypto_tfm_in_queue
);
892 static inline void crypto_inc_byte(u8
*a
, unsigned int size
)
897 for (; size
; size
--) {
905 void crypto_inc(u8
*a
, unsigned int size
)
907 __be32
*b
= (__be32
*)(a
+ size
);
910 for (; size
>= 4; size
-= 4) {
911 c
= be32_to_cpu(*--b
) + 1;
917 crypto_inc_byte(a
, size
);
919 EXPORT_SYMBOL_GPL(crypto_inc
);
921 static inline void crypto_xor_byte(u8
*a
, const u8
*b
, unsigned int size
)
927 void crypto_xor(u8
*dst
, const u8
*src
, unsigned int size
)
932 for (; size
>= 4; size
-= 4)
935 crypto_xor_byte((u8
*)a
, (u8
*)b
, size
);
937 EXPORT_SYMBOL_GPL(crypto_xor
);
939 static int __init
crypto_algapi_init(void)
945 static void __exit
crypto_algapi_exit(void)
950 module_init(crypto_algapi_init
);
951 module_exit(crypto_algapi_exit
);
953 MODULE_LICENSE("GPL");
954 MODULE_DESCRIPTION("Cryptographic algorithms API");