[CRYPTO] api: Added crypto_alloc_base
[safe/jmp/linux-2.6] / crypto / api.c
1 /*
2  * Scatterlist Cryptographic API.
3  *
4  * Copyright (c) 2002 James Morris <jmorris@intercode.com.au>
5  * Copyright (c) 2002 David S. Miller (davem@redhat.com)
6  * Copyright (c) 2005 Herbert Xu <herbert@gondor.apana.org.au>
7  *
8  * Portions derived from Cryptoapi, by Alexander Kjeldaas <astor@fast.no>
9  * and Nettle, by Niels Möller.
10  *
11  * This program is free software; you can redistribute it and/or modify it
12  * under the terms of the GNU General Public License as published by the Free
13  * Software Foundation; either version 2 of the License, or (at your option) 
14  * any later version.
15  *
16  */
17
18 #include <linux/err.h>
19 #include <linux/errno.h>
20 #include <linux/kernel.h>
21 #include <linux/kmod.h>
22 #include <linux/module.h>
23 #include <linux/param.h>
24 #include <linux/sched.h>
25 #include <linux/slab.h>
26 #include <linux/string.h>
27 #include "internal.h"
28
29 LIST_HEAD(crypto_alg_list);
30 EXPORT_SYMBOL_GPL(crypto_alg_list);
31 DECLARE_RWSEM(crypto_alg_sem);
32 EXPORT_SYMBOL_GPL(crypto_alg_sem);
33
34 BLOCKING_NOTIFIER_HEAD(crypto_chain);
35 EXPORT_SYMBOL_GPL(crypto_chain);
36
37 static inline struct crypto_alg *crypto_alg_get(struct crypto_alg *alg)
38 {
39         atomic_inc(&alg->cra_refcnt);
40         return alg;
41 }
42
43 struct crypto_alg *crypto_mod_get(struct crypto_alg *alg)
44 {
45         return try_module_get(alg->cra_module) ? crypto_alg_get(alg) : NULL;
46 }
47 EXPORT_SYMBOL_GPL(crypto_mod_get);
48
49 void crypto_mod_put(struct crypto_alg *alg)
50 {
51         crypto_alg_put(alg);
52         module_put(alg->cra_module);
53 }
54 EXPORT_SYMBOL_GPL(crypto_mod_put);
55
56 struct crypto_alg *__crypto_alg_lookup(const char *name, u32 type, u32 mask)
57 {
58         struct crypto_alg *q, *alg = NULL;
59         int best = -2;
60
61         list_for_each_entry(q, &crypto_alg_list, cra_list) {
62                 int exact, fuzzy;
63
64                 if (crypto_is_moribund(q))
65                         continue;
66
67                 if ((q->cra_flags ^ type) & mask)
68                         continue;
69
70                 if (crypto_is_larval(q) &&
71                     ((struct crypto_larval *)q)->mask != mask)
72                         continue;
73
74                 exact = !strcmp(q->cra_driver_name, name);
75                 fuzzy = !strcmp(q->cra_name, name);
76                 if (!exact && !(fuzzy && q->cra_priority > best))
77                         continue;
78
79                 if (unlikely(!crypto_mod_get(q)))
80                         continue;
81
82                 best = q->cra_priority;
83                 if (alg)
84                         crypto_mod_put(alg);
85                 alg = q;
86
87                 if (exact)
88                         break;
89         }
90
91         return alg;
92 }
93 EXPORT_SYMBOL_GPL(__crypto_alg_lookup);
94
95 static void crypto_larval_destroy(struct crypto_alg *alg)
96 {
97         struct crypto_larval *larval = (void *)alg;
98
99         BUG_ON(!crypto_is_larval(alg));
100         if (larval->adult)
101                 crypto_mod_put(larval->adult);
102         kfree(larval);
103 }
104
105 static struct crypto_alg *crypto_larval_alloc(const char *name, u32 type,
106                                               u32 mask)
107 {
108         struct crypto_alg *alg;
109         struct crypto_larval *larval;
110
111         larval = kzalloc(sizeof(*larval), GFP_KERNEL);
112         if (!larval)
113                 return ERR_PTR(-ENOMEM);
114
115         larval->mask = mask;
116         larval->alg.cra_flags = CRYPTO_ALG_LARVAL | type;
117         larval->alg.cra_priority = -1;
118         larval->alg.cra_destroy = crypto_larval_destroy;
119
120         atomic_set(&larval->alg.cra_refcnt, 2);
121         strlcpy(larval->alg.cra_name, name, CRYPTO_MAX_ALG_NAME);
122         init_completion(&larval->completion);
123
124         down_write(&crypto_alg_sem);
125         alg = __crypto_alg_lookup(name, type, mask);
126         if (!alg) {
127                 alg = &larval->alg;
128                 list_add(&alg->cra_list, &crypto_alg_list);
129         }
130         up_write(&crypto_alg_sem);
131
132         if (alg != &larval->alg)
133                 kfree(larval);
134
135         return alg;
136 }
137
138 static void crypto_larval_kill(struct crypto_alg *alg)
139 {
140         struct crypto_larval *larval = (void *)alg;
141
142         down_write(&crypto_alg_sem);
143         list_del(&alg->cra_list);
144         up_write(&crypto_alg_sem);
145         complete(&larval->completion);
146         crypto_alg_put(alg);
147 }
148
149 static struct crypto_alg *crypto_larval_wait(struct crypto_alg *alg)
150 {
151         struct crypto_larval *larval = (void *)alg;
152
153         wait_for_completion_interruptible_timeout(&larval->completion, 60 * HZ);
154         alg = larval->adult;
155         if (alg) {
156                 if (!crypto_mod_get(alg))
157                         alg = ERR_PTR(-EAGAIN);
158         } else
159                 alg = ERR_PTR(-ENOENT);
160         crypto_mod_put(&larval->alg);
161
162         return alg;
163 }
164
165 static struct crypto_alg *crypto_alg_lookup(const char *name, u32 type,
166                                             u32 mask)
167 {
168         struct crypto_alg *alg;
169
170         down_read(&crypto_alg_sem);
171         alg = __crypto_alg_lookup(name, type, mask);
172         up_read(&crypto_alg_sem);
173
174         return alg;
175 }
176
177 struct crypto_alg *crypto_alg_mod_lookup(const char *name, u32 type, u32 mask)
178 {
179         struct crypto_alg *alg;
180         struct crypto_alg *larval;
181         int ok;
182
183         if (!name)
184                 return ERR_PTR(-ENOENT);
185
186         mask &= ~(CRYPTO_ALG_LARVAL | CRYPTO_ALG_DEAD);
187         type &= mask;
188
189         alg = try_then_request_module(crypto_alg_lookup(name, type, mask),
190                                       name);
191         if (alg)
192                 return crypto_is_larval(alg) ? crypto_larval_wait(alg) : alg;
193
194         larval = crypto_larval_alloc(name, type, mask);
195         if (IS_ERR(larval) || !crypto_is_larval(larval))
196                 return larval;
197
198         ok = crypto_notify(CRYPTO_MSG_ALG_REQUEST, larval);
199         if (ok == NOTIFY_DONE) {
200                 request_module("cryptomgr");
201                 ok = crypto_notify(CRYPTO_MSG_ALG_REQUEST, larval);
202         }
203
204         if (ok == NOTIFY_STOP)
205                 alg = crypto_larval_wait(larval);
206         else {
207                 crypto_mod_put(larval);
208                 alg = ERR_PTR(-ENOENT);
209         }
210         crypto_larval_kill(larval);
211         return alg;
212 }
213 EXPORT_SYMBOL_GPL(crypto_alg_mod_lookup);
214
215 static int crypto_init_flags(struct crypto_tfm *tfm, u32 flags)
216 {
217         tfm->crt_flags = flags & CRYPTO_TFM_REQ_MASK;
218         flags &= ~CRYPTO_TFM_REQ_MASK;
219         
220         switch (crypto_tfm_alg_type(tfm)) {
221         case CRYPTO_ALG_TYPE_CIPHER:
222                 return crypto_init_cipher_flags(tfm, flags);
223                 
224         case CRYPTO_ALG_TYPE_DIGEST:
225                 return crypto_init_digest_flags(tfm, flags);
226                 
227         case CRYPTO_ALG_TYPE_COMPRESS:
228                 return crypto_init_compress_flags(tfm, flags);
229         
230         default:
231                 break;
232         }
233         
234         BUG();
235         return -EINVAL;
236 }
237
238 static int crypto_init_ops(struct crypto_tfm *tfm)
239 {
240         switch (crypto_tfm_alg_type(tfm)) {
241         case CRYPTO_ALG_TYPE_CIPHER:
242                 return crypto_init_cipher_ops(tfm);
243                 
244         case CRYPTO_ALG_TYPE_DIGEST:
245                 return crypto_init_digest_ops(tfm);
246                 
247         case CRYPTO_ALG_TYPE_COMPRESS:
248                 return crypto_init_compress_ops(tfm);
249         
250         default:
251                 break;
252         }
253         
254         BUG();
255         return -EINVAL;
256 }
257
258 static void crypto_exit_ops(struct crypto_tfm *tfm)
259 {
260         switch (crypto_tfm_alg_type(tfm)) {
261         case CRYPTO_ALG_TYPE_CIPHER:
262                 crypto_exit_cipher_ops(tfm);
263                 break;
264                 
265         case CRYPTO_ALG_TYPE_DIGEST:
266                 crypto_exit_digest_ops(tfm);
267                 break;
268                 
269         case CRYPTO_ALG_TYPE_COMPRESS:
270                 crypto_exit_compress_ops(tfm);
271                 break;
272         
273         default:
274                 BUG();
275                 
276         }
277 }
278
279 static unsigned int crypto_ctxsize(struct crypto_alg *alg, int flags)
280 {
281         unsigned int len;
282
283         switch (alg->cra_flags & CRYPTO_ALG_TYPE_MASK) {
284         default:
285                 BUG();
286
287         case CRYPTO_ALG_TYPE_CIPHER:
288                 len = crypto_cipher_ctxsize(alg, flags);
289                 break;
290                 
291         case CRYPTO_ALG_TYPE_DIGEST:
292                 len = crypto_digest_ctxsize(alg, flags);
293                 break;
294                 
295         case CRYPTO_ALG_TYPE_COMPRESS:
296                 len = crypto_compress_ctxsize(alg, flags);
297                 break;
298         }
299
300         return len + (alg->cra_alignmask & ~(crypto_tfm_ctx_alignment() - 1));
301 }
302
303 void crypto_shoot_alg(struct crypto_alg *alg)
304 {
305         down_write(&crypto_alg_sem);
306         alg->cra_flags |= CRYPTO_ALG_DYING;
307         up_write(&crypto_alg_sem);
308 }
309 EXPORT_SYMBOL_GPL(crypto_shoot_alg);
310
311 struct crypto_tfm *__crypto_alloc_tfm(struct crypto_alg *alg, u32 flags)
312 {
313         struct crypto_tfm *tfm = NULL;
314         unsigned int tfm_size;
315         int err = -ENOMEM;
316
317         tfm_size = sizeof(*tfm) + crypto_ctxsize(alg, flags);
318         tfm = kzalloc(tfm_size, GFP_KERNEL);
319         if (tfm == NULL)
320                 goto out;
321
322         tfm->__crt_alg = alg;
323
324         err = crypto_init_flags(tfm, flags);
325         if (err)
326                 goto out_free_tfm;
327                 
328         err = crypto_init_ops(tfm);
329         if (err)
330                 goto out_free_tfm;
331
332         if (alg->cra_init && (err = alg->cra_init(tfm))) {
333                 if (err == -EAGAIN)
334                         crypto_shoot_alg(alg);
335                 goto cra_init_failed;
336         }
337
338         goto out;
339
340 cra_init_failed:
341         crypto_exit_ops(tfm);
342 out_free_tfm:
343         kfree(tfm);
344         tfm = ERR_PTR(err);
345 out:
346         return tfm;
347 }
348 EXPORT_SYMBOL_GPL(__crypto_alloc_tfm);
349
350 struct crypto_tfm *crypto_alloc_tfm(const char *name, u32 flags)
351 {
352         struct crypto_tfm *tfm = NULL;
353         int err;
354
355         do {
356                 struct crypto_alg *alg;
357
358                 alg = crypto_alg_mod_lookup(name, 0, CRYPTO_ALG_ASYNC);
359                 err = PTR_ERR(alg);
360                 if (IS_ERR(alg))
361                         continue;
362
363                 tfm = __crypto_alloc_tfm(alg, flags);
364                 err = 0;
365                 if (IS_ERR(tfm)) {
366                         crypto_mod_put(alg);
367                         err = PTR_ERR(tfm);
368                         tfm = NULL;
369                 }
370         } while (err == -EAGAIN && !signal_pending(current));
371
372         return tfm;
373 }
374
375 /*
376  *      crypto_alloc_base - Locate algorithm and allocate transform
377  *      @alg_name: Name of algorithm
378  *      @type: Type of algorithm
379  *      @mask: Mask for type comparison
380  *
381  *      crypto_alloc_base() will first attempt to locate an already loaded
382  *      algorithm.  If that fails and the kernel supports dynamically loadable
383  *      modules, it will then attempt to load a module of the same name or
384  *      alias.  If that fails it will send a query to any loaded crypto manager
385  *      to construct an algorithm on the fly.  A refcount is grabbed on the
386  *      algorithm which is then associated with the new transform.
387  *
388  *      The returned transform is of a non-determinate type.  Most people
389  *      should use one of the more specific allocation functions such as
390  *      crypto_alloc_blkcipher.
391  *
392  *      In case of error the return value is an error pointer.
393  */
394 struct crypto_tfm *crypto_alloc_base(const char *alg_name, u32 type, u32 mask)
395 {
396         struct crypto_tfm *tfm;
397         int err;
398
399         for (;;) {
400                 struct crypto_alg *alg;
401
402                 alg = crypto_alg_mod_lookup(alg_name, type, mask);
403                 err = PTR_ERR(alg);
404                 tfm = ERR_PTR(err);
405                 if (IS_ERR(alg))
406                         goto err;
407
408                 tfm = __crypto_alloc_tfm(alg, 0);
409                 if (!IS_ERR(tfm))
410                         break;
411
412                 crypto_mod_put(alg);
413                 err = PTR_ERR(tfm);
414
415 err:
416                 if (err != -EAGAIN)
417                         break;
418                 if (signal_pending(current)) {
419                         err = -EINTR;
420                         break;
421                 }
422         };
423
424         return tfm;
425 }
426 EXPORT_SYMBOL_GPL(crypto_alloc_base);
427  
428 /*
429  *      crypto_free_tfm - Free crypto transform
430  *      @tfm: Transform to free
431  *
432  *      crypto_free_tfm() frees up the transform and any associated resources,
433  *      then drops the refcount on the associated algorithm.
434  */
435 void crypto_free_tfm(struct crypto_tfm *tfm)
436 {
437         struct crypto_alg *alg;
438         int size;
439
440         if (unlikely(!tfm))
441                 return;
442
443         alg = tfm->__crt_alg;
444         size = sizeof(*tfm) + alg->cra_ctxsize;
445
446         if (alg->cra_exit)
447                 alg->cra_exit(tfm);
448         crypto_exit_ops(tfm);
449         crypto_mod_put(alg);
450         memset(tfm, 0, size);
451         kfree(tfm);
452 }
453
454 int crypto_alg_available(const char *name, u32 flags)
455 {
456         int ret = 0;
457         struct crypto_alg *alg = crypto_alg_mod_lookup(name, 0,
458                                                        CRYPTO_ALG_ASYNC);
459         
460         if (!IS_ERR(alg)) {
461                 crypto_mod_put(alg);
462                 ret = 1;
463         }
464         
465         return ret;
466 }
467
468 EXPORT_SYMBOL_GPL(crypto_alloc_tfm);
469 EXPORT_SYMBOL_GPL(crypto_free_tfm);
470 EXPORT_SYMBOL_GPL(crypto_alg_available);