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 void crypto_remove_spawns(struct crypto_alg
*alg
, struct list_head
*list
,
133 struct crypto_alg
*nalg
)
135 u32 new_type
= (nalg
?: alg
)->cra_flags
;
136 struct crypto_spawn
*spawn
, *n
;
137 LIST_HEAD(secondary_spawns
);
138 struct list_head
*spawns
;
142 spawns
= &alg
->cra_users
;
143 list_for_each_entry_safe(spawn
, n
, spawns
, list
) {
144 if ((spawn
->alg
->cra_flags
^ new_type
) & spawn
->mask
)
147 list_move(&spawn
->list
, &top
);
152 while (!list_empty(spawns
)) {
153 struct crypto_instance
*inst
;
155 spawn
= list_first_entry(spawns
, struct crypto_spawn
,
159 BUG_ON(&inst
->alg
== alg
);
161 list_move(&spawn
->list
, &stack
);
163 if (&inst
->alg
== nalg
)
167 spawns
= &inst
->alg
.cra_users
;
169 } while ((spawns
= crypto_more_spawns(alg
, &stack
, &top
,
170 &secondary_spawns
)));
172 list_for_each_entry_safe(spawn
, n
, &secondary_spawns
, list
) {
174 list_move(&spawn
->list
, &spawn
->alg
->cra_users
);
176 crypto_remove_spawn(spawn
, list
);
179 EXPORT_SYMBOL_GPL(crypto_remove_spawns
);
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
;
496 inst
->alg
.cra_flags
|= CRYPTO_ALG_INSTANCE
;
498 down_write(&crypto_alg_sem
);
500 larval
= __crypto_register_alg(&inst
->alg
);
504 hlist_add_head(&inst
->list
, &tmpl
->instances
);
508 up_write(&crypto_alg_sem
);
510 err
= PTR_ERR(larval
);
514 crypto_wait_for_test(larval
);
520 EXPORT_SYMBOL_GPL(crypto_register_instance
);
522 int crypto_init_spawn(struct crypto_spawn
*spawn
, struct crypto_alg
*alg
,
523 struct crypto_instance
*inst
, u32 mask
)
530 down_write(&crypto_alg_sem
);
531 if (!crypto_is_moribund(alg
)) {
532 list_add(&spawn
->list
, &alg
->cra_users
);
536 up_write(&crypto_alg_sem
);
540 EXPORT_SYMBOL_GPL(crypto_init_spawn
);
542 int crypto_init_spawn2(struct crypto_spawn
*spawn
, struct crypto_alg
*alg
,
543 struct crypto_instance
*inst
,
544 const struct crypto_type
*frontend
)
548 if ((alg
->cra_flags
^ frontend
->type
) & frontend
->maskset
)
551 spawn
->frontend
= frontend
;
552 err
= crypto_init_spawn(spawn
, alg
, inst
, frontend
->maskset
);
557 EXPORT_SYMBOL_GPL(crypto_init_spawn2
);
559 void crypto_drop_spawn(struct crypto_spawn
*spawn
)
564 down_write(&crypto_alg_sem
);
565 list_del(&spawn
->list
);
566 up_write(&crypto_alg_sem
);
568 EXPORT_SYMBOL_GPL(crypto_drop_spawn
);
570 static struct crypto_alg
*crypto_spawn_alg(struct crypto_spawn
*spawn
)
572 struct crypto_alg
*alg
;
573 struct crypto_alg
*alg2
;
575 down_read(&crypto_alg_sem
);
579 alg2
= crypto_mod_get(alg2
);
580 up_read(&crypto_alg_sem
);
584 crypto_shoot_alg(alg
);
585 return ERR_PTR(-EAGAIN
);
591 struct crypto_tfm
*crypto_spawn_tfm(struct crypto_spawn
*spawn
, u32 type
,
594 struct crypto_alg
*alg
;
595 struct crypto_tfm
*tfm
;
597 alg
= crypto_spawn_alg(spawn
);
599 return ERR_CAST(alg
);
601 tfm
= ERR_PTR(-EINVAL
);
602 if (unlikely((alg
->cra_flags
^ type
) & mask
))
605 tfm
= __crypto_alloc_tfm(alg
, type
, mask
);
615 EXPORT_SYMBOL_GPL(crypto_spawn_tfm
);
617 void *crypto_spawn_tfm2(struct crypto_spawn
*spawn
)
619 struct crypto_alg
*alg
;
620 struct crypto_tfm
*tfm
;
622 alg
= crypto_spawn_alg(spawn
);
624 return ERR_CAST(alg
);
626 tfm
= crypto_create_tfm(alg
, spawn
->frontend
);
636 EXPORT_SYMBOL_GPL(crypto_spawn_tfm2
);
638 int crypto_register_notifier(struct notifier_block
*nb
)
640 return blocking_notifier_chain_register(&crypto_chain
, nb
);
642 EXPORT_SYMBOL_GPL(crypto_register_notifier
);
644 int crypto_unregister_notifier(struct notifier_block
*nb
)
646 return blocking_notifier_chain_unregister(&crypto_chain
, nb
);
648 EXPORT_SYMBOL_GPL(crypto_unregister_notifier
);
650 struct crypto_attr_type
*crypto_get_attr_type(struct rtattr
**tb
)
652 struct rtattr
*rta
= tb
[0];
653 struct crypto_attr_type
*algt
;
656 return ERR_PTR(-ENOENT
);
657 if (RTA_PAYLOAD(rta
) < sizeof(*algt
))
658 return ERR_PTR(-EINVAL
);
659 if (rta
->rta_type
!= CRYPTOA_TYPE
)
660 return ERR_PTR(-EINVAL
);
662 algt
= RTA_DATA(rta
);
666 EXPORT_SYMBOL_GPL(crypto_get_attr_type
);
668 int crypto_check_attr_type(struct rtattr
**tb
, u32 type
)
670 struct crypto_attr_type
*algt
;
672 algt
= crypto_get_attr_type(tb
);
674 return PTR_ERR(algt
);
676 if ((algt
->type
^ type
) & algt
->mask
)
681 EXPORT_SYMBOL_GPL(crypto_check_attr_type
);
683 const char *crypto_attr_alg_name(struct rtattr
*rta
)
685 struct crypto_attr_alg
*alga
;
688 return ERR_PTR(-ENOENT
);
689 if (RTA_PAYLOAD(rta
) < sizeof(*alga
))
690 return ERR_PTR(-EINVAL
);
691 if (rta
->rta_type
!= CRYPTOA_ALG
)
692 return ERR_PTR(-EINVAL
);
694 alga
= RTA_DATA(rta
);
695 alga
->name
[CRYPTO_MAX_ALG_NAME
- 1] = 0;
699 EXPORT_SYMBOL_GPL(crypto_attr_alg_name
);
701 struct crypto_alg
*crypto_attr_alg2(struct rtattr
*rta
,
702 const struct crypto_type
*frontend
,
708 name
= crypto_attr_alg_name(rta
);
713 return crypto_find_alg(name
, frontend
, type
, mask
);
715 EXPORT_SYMBOL_GPL(crypto_attr_alg2
);
717 int crypto_attr_u32(struct rtattr
*rta
, u32
*num
)
719 struct crypto_attr_u32
*nu32
;
723 if (RTA_PAYLOAD(rta
) < sizeof(*nu32
))
725 if (rta
->rta_type
!= CRYPTOA_U32
)
728 nu32
= RTA_DATA(rta
);
733 EXPORT_SYMBOL_GPL(crypto_attr_u32
);
735 void *crypto_alloc_instance2(const char *name
, struct crypto_alg
*alg
,
738 struct crypto_instance
*inst
;
742 p
= kzalloc(head
+ sizeof(*inst
) + sizeof(struct crypto_spawn
),
745 return ERR_PTR(-ENOMEM
);
747 inst
= (void *)(p
+ head
);
750 if (snprintf(inst
->alg
.cra_name
, CRYPTO_MAX_ALG_NAME
, "%s(%s)", name
,
751 alg
->cra_name
) >= CRYPTO_MAX_ALG_NAME
)
754 if (snprintf(inst
->alg
.cra_driver_name
, CRYPTO_MAX_ALG_NAME
, "%s(%s)",
755 name
, alg
->cra_driver_name
) >= CRYPTO_MAX_ALG_NAME
)
764 EXPORT_SYMBOL_GPL(crypto_alloc_instance2
);
766 struct crypto_instance
*crypto_alloc_instance(const char *name
,
767 struct crypto_alg
*alg
)
769 struct crypto_instance
*inst
;
770 struct crypto_spawn
*spawn
;
773 inst
= crypto_alloc_instance2(name
, alg
, 0);
777 spawn
= crypto_instance_ctx(inst
);
778 err
= crypto_init_spawn(spawn
, alg
, inst
,
779 CRYPTO_ALG_TYPE_MASK
| CRYPTO_ALG_ASYNC
);
793 EXPORT_SYMBOL_GPL(crypto_alloc_instance
);
795 void crypto_init_queue(struct crypto_queue
*queue
, unsigned int max_qlen
)
797 INIT_LIST_HEAD(&queue
->list
);
798 queue
->backlog
= &queue
->list
;
800 queue
->max_qlen
= max_qlen
;
802 EXPORT_SYMBOL_GPL(crypto_init_queue
);
804 int crypto_enqueue_request(struct crypto_queue
*queue
,
805 struct crypto_async_request
*request
)
807 int err
= -EINPROGRESS
;
809 if (unlikely(queue
->qlen
>= queue
->max_qlen
)) {
811 if (!(request
->flags
& CRYPTO_TFM_REQ_MAY_BACKLOG
))
813 if (queue
->backlog
== &queue
->list
)
814 queue
->backlog
= &request
->list
;
818 list_add_tail(&request
->list
, &queue
->list
);
823 EXPORT_SYMBOL_GPL(crypto_enqueue_request
);
825 void *__crypto_dequeue_request(struct crypto_queue
*queue
, unsigned int offset
)
827 struct list_head
*request
;
829 if (unlikely(!queue
->qlen
))
834 if (queue
->backlog
!= &queue
->list
)
835 queue
->backlog
= queue
->backlog
->next
;
837 request
= queue
->list
.next
;
840 return (char *)list_entry(request
, struct crypto_async_request
, list
) -
843 EXPORT_SYMBOL_GPL(__crypto_dequeue_request
);
845 struct crypto_async_request
*crypto_dequeue_request(struct crypto_queue
*queue
)
847 return __crypto_dequeue_request(queue
, 0);
849 EXPORT_SYMBOL_GPL(crypto_dequeue_request
);
851 int crypto_tfm_in_queue(struct crypto_queue
*queue
, struct crypto_tfm
*tfm
)
853 struct crypto_async_request
*req
;
855 list_for_each_entry(req
, &queue
->list
, list
) {
862 EXPORT_SYMBOL_GPL(crypto_tfm_in_queue
);
864 static inline void crypto_inc_byte(u8
*a
, unsigned int size
)
869 for (; size
; size
--) {
877 void crypto_inc(u8
*a
, unsigned int size
)
879 __be32
*b
= (__be32
*)(a
+ size
);
882 for (; size
>= 4; size
-= 4) {
883 c
= be32_to_cpu(*--b
) + 1;
889 crypto_inc_byte(a
, size
);
891 EXPORT_SYMBOL_GPL(crypto_inc
);
893 static inline void crypto_xor_byte(u8
*a
, const u8
*b
, unsigned int size
)
899 void crypto_xor(u8
*dst
, const u8
*src
, unsigned int size
)
904 for (; size
>= 4; size
-= 4)
907 crypto_xor_byte((u8
*)a
, (u8
*)b
, size
);
909 EXPORT_SYMBOL_GPL(crypto_xor
);
911 static int __init
crypto_algapi_init(void)
917 static void __exit
crypto_algapi_exit(void)
922 module_init(crypto_algapi_init
);
923 module_exit(crypto_algapi_exit
);
925 MODULE_LICENSE("GPL");
926 MODULE_DESCRIPTION("Cryptographic algorithms API");