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/string.h>
24 static LIST_HEAD(crypto_template_list);
26 void crypto_larval_error(const char *name, u32 type, u32 mask)
28 struct crypto_alg *alg;
30 down_read(&crypto_alg_sem);
31 alg = __crypto_alg_lookup(name, type, mask);
32 up_read(&crypto_alg_sem);
35 if (crypto_is_larval(alg)) {
36 struct crypto_larval *larval = (void *)alg;
37 complete(&larval->completion);
42 EXPORT_SYMBOL_GPL(crypto_larval_error);
44 static inline int crypto_set_driver_name(struct crypto_alg *alg)
46 static const char suffix[] = "-generic";
47 char *driver_name = alg->cra_driver_name;
53 len = strlcpy(driver_name, alg->cra_name, CRYPTO_MAX_ALG_NAME);
54 if (len + sizeof(suffix) > CRYPTO_MAX_ALG_NAME)
57 memcpy(driver_name + len, suffix, sizeof(suffix));
61 static int crypto_check_alg(struct crypto_alg *alg)
63 if (alg->cra_alignmask & (alg->cra_alignmask + 1))
66 if (alg->cra_alignmask & alg->cra_blocksize)
69 if (alg->cra_blocksize > PAGE_SIZE / 8)
72 if (alg->cra_priority < 0)
75 return crypto_set_driver_name(alg);
78 static void crypto_destroy_instance(struct crypto_alg *alg)
80 struct crypto_instance *inst = (void *)alg;
81 struct crypto_template *tmpl = inst->tmpl;
84 crypto_tmpl_put(tmpl);
87 static void crypto_remove_spawn(struct crypto_spawn *spawn,
88 struct list_head *list,
89 struct list_head *secondary_spawns)
91 struct crypto_instance *inst = spawn->inst;
92 struct crypto_template *tmpl = inst->tmpl;
94 list_del_init(&spawn->list);
97 if (crypto_is_dead(&inst->alg))
100 inst->alg.cra_flags |= CRYPTO_ALG_DEAD;
101 if (!tmpl || !crypto_tmpl_get(tmpl))
104 crypto_notify(CRYPTO_MSG_ALG_UNREGISTER, &inst->alg);
105 list_move(&inst->alg.cra_list, list);
106 hlist_del(&inst->list);
107 inst->alg.cra_destroy = crypto_destroy_instance;
109 list_splice(&inst->alg.cra_users, secondary_spawns);
112 static void crypto_remove_spawns(struct list_head *spawns,
113 struct list_head *list, u32 new_type)
115 struct crypto_spawn *spawn, *n;
116 LIST_HEAD(secondary_spawns);
118 list_for_each_entry_safe(spawn, n, spawns, list) {
119 if ((spawn->alg->cra_flags ^ new_type) & spawn->mask)
122 crypto_remove_spawn(spawn, list, &secondary_spawns);
125 while (!list_empty(&secondary_spawns)) {
126 list_for_each_entry_safe(spawn, n, &secondary_spawns, list)
127 crypto_remove_spawn(spawn, list, &secondary_spawns);
131 static int __crypto_register_alg(struct crypto_alg *alg,
132 struct list_head *list)
134 struct crypto_alg *q;
137 if (crypto_is_dead(alg))
140 INIT_LIST_HEAD(&alg->cra_users);
144 atomic_set(&alg->cra_refcnt, 1);
145 list_for_each_entry(q, &crypto_alg_list, cra_list) {
149 if (crypto_is_moribund(q))
152 if (crypto_is_larval(q)) {
153 struct crypto_larval *larval = (void *)q;
155 if (strcmp(alg->cra_name, q->cra_name) &&
156 strcmp(alg->cra_driver_name, q->cra_name))
161 if ((q->cra_flags ^ alg->cra_flags) & larval->mask)
163 if (!crypto_mod_get(alg))
167 complete(&larval->completion);
171 if (strcmp(alg->cra_name, q->cra_name))
174 if (strcmp(alg->cra_driver_name, q->cra_driver_name) &&
175 q->cra_priority > alg->cra_priority)
178 crypto_remove_spawns(&q->cra_users, list, alg->cra_flags);
181 list_add(&alg->cra_list, &crypto_alg_list);
183 crypto_notify(CRYPTO_MSG_ALG_REGISTER, alg);
190 static void crypto_remove_final(struct list_head *list)
192 struct crypto_alg *alg;
193 struct crypto_alg *n;
195 list_for_each_entry_safe(alg, n, list, cra_list) {
196 list_del_init(&alg->cra_list);
201 int crypto_register_alg(struct crypto_alg *alg)
206 err = crypto_check_alg(alg);
210 down_write(&crypto_alg_sem);
211 err = __crypto_register_alg(alg, &list);
212 up_write(&crypto_alg_sem);
214 crypto_remove_final(&list);
217 EXPORT_SYMBOL_GPL(crypto_register_alg);
219 static int crypto_remove_alg(struct crypto_alg *alg, struct list_head *list)
221 if (unlikely(list_empty(&alg->cra_list)))
224 alg->cra_flags |= CRYPTO_ALG_DEAD;
226 crypto_notify(CRYPTO_MSG_ALG_UNREGISTER, alg);
227 list_del_init(&alg->cra_list);
228 crypto_remove_spawns(&alg->cra_users, list, alg->cra_flags);
233 int crypto_unregister_alg(struct crypto_alg *alg)
238 down_write(&crypto_alg_sem);
239 ret = crypto_remove_alg(alg, &list);
240 up_write(&crypto_alg_sem);
245 BUG_ON(atomic_read(&alg->cra_refcnt) != 1);
246 if (alg->cra_destroy)
247 alg->cra_destroy(alg);
249 crypto_remove_final(&list);
252 EXPORT_SYMBOL_GPL(crypto_unregister_alg);
254 int crypto_register_template(struct crypto_template *tmpl)
256 struct crypto_template *q;
259 down_write(&crypto_alg_sem);
261 list_for_each_entry(q, &crypto_template_list, list) {
266 list_add(&tmpl->list, &crypto_template_list);
267 crypto_notify(CRYPTO_MSG_TMPL_REGISTER, tmpl);
270 up_write(&crypto_alg_sem);
273 EXPORT_SYMBOL_GPL(crypto_register_template);
275 void crypto_unregister_template(struct crypto_template *tmpl)
277 struct crypto_instance *inst;
278 struct hlist_node *p, *n;
279 struct hlist_head *list;
282 down_write(&crypto_alg_sem);
284 BUG_ON(list_empty(&tmpl->list));
285 list_del_init(&tmpl->list);
287 list = &tmpl->instances;
288 hlist_for_each_entry(inst, p, list, list) {
289 int err = crypto_remove_alg(&inst->alg, &users);
293 crypto_notify(CRYPTO_MSG_TMPL_UNREGISTER, tmpl);
295 up_write(&crypto_alg_sem);
297 hlist_for_each_entry_safe(inst, p, n, list, list) {
298 BUG_ON(atomic_read(&inst->alg.cra_refcnt) != 1);
301 crypto_remove_final(&users);
303 EXPORT_SYMBOL_GPL(crypto_unregister_template);
305 static struct crypto_template *__crypto_lookup_template(const char *name)
307 struct crypto_template *q, *tmpl = NULL;
309 down_read(&crypto_alg_sem);
310 list_for_each_entry(q, &crypto_template_list, list) {
311 if (strcmp(q->name, name))
313 if (unlikely(!crypto_tmpl_get(q)))
319 up_read(&crypto_alg_sem);
324 struct crypto_template *crypto_lookup_template(const char *name)
326 return try_then_request_module(__crypto_lookup_template(name), name);
328 EXPORT_SYMBOL_GPL(crypto_lookup_template);
330 int crypto_register_instance(struct crypto_template *tmpl,
331 struct crypto_instance *inst)
336 if (inst->alg.cra_destroy)
339 err = crypto_check_alg(&inst->alg);
343 inst->alg.cra_module = tmpl->module;
345 down_write(&crypto_alg_sem);
347 err = __crypto_register_alg(&inst->alg, &list);
351 hlist_add_head(&inst->list, &tmpl->instances);
355 up_write(&crypto_alg_sem);
357 crypto_remove_final(&list);
362 EXPORT_SYMBOL_GPL(crypto_register_instance);
364 int crypto_init_spawn(struct crypto_spawn *spawn, struct crypto_alg *alg,
365 struct crypto_instance *inst, u32 mask)
372 down_write(&crypto_alg_sem);
373 if (!crypto_is_moribund(alg)) {
374 list_add(&spawn->list, &alg->cra_users);
378 up_write(&crypto_alg_sem);
382 EXPORT_SYMBOL_GPL(crypto_init_spawn);
384 void crypto_drop_spawn(struct crypto_spawn *spawn)
386 down_write(&crypto_alg_sem);
387 list_del(&spawn->list);
388 up_write(&crypto_alg_sem);
390 EXPORT_SYMBOL_GPL(crypto_drop_spawn);
392 struct crypto_tfm *crypto_spawn_tfm(struct crypto_spawn *spawn, u32 type,
395 struct crypto_alg *alg;
396 struct crypto_alg *alg2;
397 struct crypto_tfm *tfm;
399 down_read(&crypto_alg_sem);
403 alg2 = crypto_mod_get(alg2);
404 up_read(&crypto_alg_sem);
408 crypto_shoot_alg(alg);
409 return ERR_PTR(-EAGAIN);
412 tfm = ERR_PTR(-EINVAL);
413 if (unlikely((alg->cra_flags ^ type) & mask))
416 tfm = __crypto_alloc_tfm(alg, type, mask);
426 EXPORT_SYMBOL_GPL(crypto_spawn_tfm);
428 int crypto_register_notifier(struct notifier_block *nb)
430 return blocking_notifier_chain_register(&crypto_chain, nb);
432 EXPORT_SYMBOL_GPL(crypto_register_notifier);
434 int crypto_unregister_notifier(struct notifier_block *nb)
436 return blocking_notifier_chain_unregister(&crypto_chain, nb);
438 EXPORT_SYMBOL_GPL(crypto_unregister_notifier);
440 struct crypto_attr_type *crypto_get_attr_type(struct rtattr **tb)
442 struct rtattr *rta = tb[CRYPTOA_TYPE - 1];
443 struct crypto_attr_type *algt;
446 return ERR_PTR(-ENOENT);
447 if (RTA_PAYLOAD(rta) < sizeof(*algt))
448 return ERR_PTR(-EINVAL);
450 algt = RTA_DATA(rta);
454 EXPORT_SYMBOL_GPL(crypto_get_attr_type);
456 int crypto_check_attr_type(struct rtattr **tb, u32 type)
458 struct crypto_attr_type *algt;
460 algt = crypto_get_attr_type(tb);
462 return PTR_ERR(algt);
464 if ((algt->type ^ type) & algt->mask)
469 EXPORT_SYMBOL_GPL(crypto_check_attr_type);
471 struct crypto_alg *crypto_get_attr_alg(struct rtattr **tb, u32 type, u32 mask)
473 struct rtattr *rta = tb[CRYPTOA_ALG - 1];
474 struct crypto_attr_alg *alga;
477 return ERR_PTR(-ENOENT);
478 if (RTA_PAYLOAD(rta) < sizeof(*alga))
479 return ERR_PTR(-EINVAL);
481 alga = RTA_DATA(rta);
482 alga->name[CRYPTO_MAX_ALG_NAME - 1] = 0;
484 return crypto_alg_mod_lookup(alga->name, type, mask);
486 EXPORT_SYMBOL_GPL(crypto_get_attr_alg);
488 struct crypto_instance *crypto_alloc_instance(const char *name,
489 struct crypto_alg *alg)
491 struct crypto_instance *inst;
492 struct crypto_spawn *spawn;
495 inst = kzalloc(sizeof(*inst) + sizeof(*spawn), GFP_KERNEL);
497 return ERR_PTR(-ENOMEM);
500 if (snprintf(inst->alg.cra_name, CRYPTO_MAX_ALG_NAME, "%s(%s)", name,
501 alg->cra_name) >= CRYPTO_MAX_ALG_NAME)
504 if (snprintf(inst->alg.cra_driver_name, CRYPTO_MAX_ALG_NAME, "%s(%s)",
505 name, alg->cra_driver_name) >= CRYPTO_MAX_ALG_NAME)
508 spawn = crypto_instance_ctx(inst);
509 err = crypto_init_spawn(spawn, alg, inst,
510 CRYPTO_ALG_TYPE_MASK | CRYPTO_ALG_ASYNC);
521 EXPORT_SYMBOL_GPL(crypto_alloc_instance);
523 void crypto_init_queue(struct crypto_queue *queue, unsigned int max_qlen)
525 INIT_LIST_HEAD(&queue->list);
526 queue->backlog = &queue->list;
528 queue->max_qlen = max_qlen;
530 EXPORT_SYMBOL_GPL(crypto_init_queue);
532 int crypto_enqueue_request(struct crypto_queue *queue,
533 struct crypto_async_request *request)
535 int err = -EINPROGRESS;
537 if (unlikely(queue->qlen >= queue->max_qlen)) {
539 if (!(request->flags & CRYPTO_TFM_REQ_MAY_BACKLOG))
541 if (queue->backlog == &queue->list)
542 queue->backlog = &request->list;
546 list_add_tail(&request->list, &queue->list);
551 EXPORT_SYMBOL_GPL(crypto_enqueue_request);
553 struct crypto_async_request *crypto_dequeue_request(struct crypto_queue *queue)
555 struct list_head *request;
557 if (unlikely(!queue->qlen))
562 if (queue->backlog != &queue->list)
563 queue->backlog = queue->backlog->next;
565 request = queue->list.next;
568 return list_entry(request, struct crypto_async_request, list);
570 EXPORT_SYMBOL_GPL(crypto_dequeue_request);
572 int crypto_tfm_in_queue(struct crypto_queue *queue, struct crypto_tfm *tfm)
574 struct crypto_async_request *req;
576 list_for_each_entry(req, &queue->list, list) {
583 EXPORT_SYMBOL_GPL(crypto_tfm_in_queue);
585 static int __init crypto_algapi_init(void)
591 static void __exit crypto_algapi_exit(void)
596 module_init(crypto_algapi_init);
597 module_exit(crypto_algapi_exit);
599 MODULE_LICENSE("GPL");
600 MODULE_DESCRIPTION("Cryptographic algorithms API");