Merge git://git.kernel.org/pub/scm/linux/kernel/git/davem/net
[sfrench/cifs-2.6.git] / crypto / ahash.c
1 /*
2  * Asynchronous Cryptographic Hash operations.
3  *
4  * This is the asynchronous version of hash.c with notification of
5  * completion via a callback.
6  *
7  * Copyright (c) 2008 Loc Ho <lho@amcc.com>
8  *
9  * This program is free software; you can redistribute it and/or modify it
10  * under the terms of the GNU General Public License as published by the Free
11  * Software Foundation; either version 2 of the License, or (at your option)
12  * any later version.
13  *
14  */
15
16 #include <crypto/internal/hash.h>
17 #include <crypto/scatterwalk.h>
18 #include <linux/bug.h>
19 #include <linux/err.h>
20 #include <linux/kernel.h>
21 #include <linux/module.h>
22 #include <linux/sched.h>
23 #include <linux/slab.h>
24 #include <linux/seq_file.h>
25 #include <linux/cryptouser.h>
26 #include <linux/compiler.h>
27 #include <net/netlink.h>
28
29 #include "internal.h"
30
31 struct ahash_request_priv {
32         crypto_completion_t complete;
33         void *data;
34         u8 *result;
35         u32 flags;
36         void *ubuf[] CRYPTO_MINALIGN_ATTR;
37 };
38
39 static inline struct ahash_alg *crypto_ahash_alg(struct crypto_ahash *hash)
40 {
41         return container_of(crypto_hash_alg_common(hash), struct ahash_alg,
42                             halg);
43 }
44
45 static int hash_walk_next(struct crypto_hash_walk *walk)
46 {
47         unsigned int alignmask = walk->alignmask;
48         unsigned int offset = walk->offset;
49         unsigned int nbytes = min(walk->entrylen,
50                                   ((unsigned int)(PAGE_SIZE)) - offset);
51
52         if (walk->flags & CRYPTO_ALG_ASYNC)
53                 walk->data = kmap(walk->pg);
54         else
55                 walk->data = kmap_atomic(walk->pg);
56         walk->data += offset;
57
58         if (offset & alignmask) {
59                 unsigned int unaligned = alignmask + 1 - (offset & alignmask);
60
61                 if (nbytes > unaligned)
62                         nbytes = unaligned;
63         }
64
65         walk->entrylen -= nbytes;
66         return nbytes;
67 }
68
69 static int hash_walk_new_entry(struct crypto_hash_walk *walk)
70 {
71         struct scatterlist *sg;
72
73         sg = walk->sg;
74         walk->offset = sg->offset;
75         walk->pg = sg_page(walk->sg) + (walk->offset >> PAGE_SHIFT);
76         walk->offset = offset_in_page(walk->offset);
77         walk->entrylen = sg->length;
78
79         if (walk->entrylen > walk->total)
80                 walk->entrylen = walk->total;
81         walk->total -= walk->entrylen;
82
83         return hash_walk_next(walk);
84 }
85
86 int crypto_hash_walk_done(struct crypto_hash_walk *walk, int err)
87 {
88         unsigned int alignmask = walk->alignmask;
89         unsigned int nbytes = walk->entrylen;
90
91         walk->data -= walk->offset;
92
93         if (nbytes && walk->offset & alignmask && !err) {
94                 walk->offset = ALIGN(walk->offset, alignmask + 1);
95                 nbytes = min(nbytes,
96                              ((unsigned int)(PAGE_SIZE)) - walk->offset);
97                 walk->entrylen -= nbytes;
98
99                 if (nbytes) {
100                         walk->data += walk->offset;
101                         return nbytes;
102                 }
103         }
104
105         if (walk->flags & CRYPTO_ALG_ASYNC)
106                 kunmap(walk->pg);
107         else {
108                 kunmap_atomic(walk->data);
109                 /*
110                  * The may sleep test only makes sense for sync users.
111                  * Async users don't need to sleep here anyway.
112                  */
113                 crypto_yield(walk->flags);
114         }
115
116         if (err)
117                 return err;
118
119         if (nbytes) {
120                 walk->offset = 0;
121                 walk->pg++;
122                 return hash_walk_next(walk);
123         }
124
125         if (!walk->total)
126                 return 0;
127
128         walk->sg = sg_next(walk->sg);
129
130         return hash_walk_new_entry(walk);
131 }
132 EXPORT_SYMBOL_GPL(crypto_hash_walk_done);
133
134 int crypto_hash_walk_first(struct ahash_request *req,
135                            struct crypto_hash_walk *walk)
136 {
137         walk->total = req->nbytes;
138
139         if (!walk->total) {
140                 walk->entrylen = 0;
141                 return 0;
142         }
143
144         walk->alignmask = crypto_ahash_alignmask(crypto_ahash_reqtfm(req));
145         walk->sg = req->src;
146         walk->flags = req->base.flags & CRYPTO_TFM_REQ_MASK;
147
148         return hash_walk_new_entry(walk);
149 }
150 EXPORT_SYMBOL_GPL(crypto_hash_walk_first);
151
152 int crypto_ahash_walk_first(struct ahash_request *req,
153                             struct crypto_hash_walk *walk)
154 {
155         walk->total = req->nbytes;
156
157         if (!walk->total) {
158                 walk->entrylen = 0;
159                 return 0;
160         }
161
162         walk->alignmask = crypto_ahash_alignmask(crypto_ahash_reqtfm(req));
163         walk->sg = req->src;
164         walk->flags = req->base.flags & CRYPTO_TFM_REQ_MASK;
165         walk->flags |= CRYPTO_ALG_ASYNC;
166
167         BUILD_BUG_ON(CRYPTO_TFM_REQ_MASK & CRYPTO_ALG_ASYNC);
168
169         return hash_walk_new_entry(walk);
170 }
171 EXPORT_SYMBOL_GPL(crypto_ahash_walk_first);
172
173 static int ahash_setkey_unaligned(struct crypto_ahash *tfm, const u8 *key,
174                                 unsigned int keylen)
175 {
176         unsigned long alignmask = crypto_ahash_alignmask(tfm);
177         int ret;
178         u8 *buffer, *alignbuffer;
179         unsigned long absize;
180
181         absize = keylen + alignmask;
182         buffer = kmalloc(absize, GFP_KERNEL);
183         if (!buffer)
184                 return -ENOMEM;
185
186         alignbuffer = (u8 *)ALIGN((unsigned long)buffer, alignmask + 1);
187         memcpy(alignbuffer, key, keylen);
188         ret = tfm->setkey(tfm, alignbuffer, keylen);
189         kzfree(buffer);
190         return ret;
191 }
192
193 int crypto_ahash_setkey(struct crypto_ahash *tfm, const u8 *key,
194                         unsigned int keylen)
195 {
196         unsigned long alignmask = crypto_ahash_alignmask(tfm);
197         int err;
198
199         if ((unsigned long)key & alignmask)
200                 err = ahash_setkey_unaligned(tfm, key, keylen);
201         else
202                 err = tfm->setkey(tfm, key, keylen);
203
204         if (err)
205                 return err;
206
207         crypto_ahash_clear_flags(tfm, CRYPTO_TFM_NEED_KEY);
208         return 0;
209 }
210 EXPORT_SYMBOL_GPL(crypto_ahash_setkey);
211
212 static int ahash_nosetkey(struct crypto_ahash *tfm, const u8 *key,
213                           unsigned int keylen)
214 {
215         return -ENOSYS;
216 }
217
218 static inline unsigned int ahash_align_buffer_size(unsigned len,
219                                                    unsigned long mask)
220 {
221         return len + (mask & ~(crypto_tfm_ctx_alignment() - 1));
222 }
223
224 static int ahash_save_req(struct ahash_request *req, crypto_completion_t cplt)
225 {
226         struct crypto_ahash *tfm = crypto_ahash_reqtfm(req);
227         unsigned long alignmask = crypto_ahash_alignmask(tfm);
228         unsigned int ds = crypto_ahash_digestsize(tfm);
229         struct ahash_request_priv *priv;
230
231         priv = kmalloc(sizeof(*priv) + ahash_align_buffer_size(ds, alignmask),
232                        (req->base.flags & CRYPTO_TFM_REQ_MAY_SLEEP) ?
233                        GFP_KERNEL : GFP_ATOMIC);
234         if (!priv)
235                 return -ENOMEM;
236
237         /*
238          * WARNING: Voodoo programming below!
239          *
240          * The code below is obscure and hard to understand, thus explanation
241          * is necessary. See include/crypto/hash.h and include/linux/crypto.h
242          * to understand the layout of structures used here!
243          *
244          * The code here will replace portions of the ORIGINAL request with
245          * pointers to new code and buffers so the hashing operation can store
246          * the result in aligned buffer. We will call the modified request
247          * an ADJUSTED request.
248          *
249          * The newly mangled request will look as such:
250          *
251          * req {
252          *   .result        = ADJUSTED[new aligned buffer]
253          *   .base.complete = ADJUSTED[pointer to completion function]
254          *   .base.data     = ADJUSTED[*req (pointer to self)]
255          *   .priv          = ADJUSTED[new priv] {
256          *           .result   = ORIGINAL(result)
257          *           .complete = ORIGINAL(base.complete)
258          *           .data     = ORIGINAL(base.data)
259          *   }
260          */
261
262         priv->result = req->result;
263         priv->complete = req->base.complete;
264         priv->data = req->base.data;
265         priv->flags = req->base.flags;
266
267         /*
268          * WARNING: We do not backup req->priv here! The req->priv
269          *          is for internal use of the Crypto API and the
270          *          user must _NOT_ _EVER_ depend on it's content!
271          */
272
273         req->result = PTR_ALIGN((u8 *)priv->ubuf, alignmask + 1);
274         req->base.complete = cplt;
275         req->base.data = req;
276         req->priv = priv;
277
278         return 0;
279 }
280
281 static void ahash_restore_req(struct ahash_request *req, int err)
282 {
283         struct ahash_request_priv *priv = req->priv;
284
285         if (!err)
286                 memcpy(priv->result, req->result,
287                        crypto_ahash_digestsize(crypto_ahash_reqtfm(req)));
288
289         /* Restore the original crypto request. */
290         req->result = priv->result;
291
292         ahash_request_set_callback(req, priv->flags,
293                                    priv->complete, priv->data);
294         req->priv = NULL;
295
296         /* Free the req->priv.priv from the ADJUSTED request. */
297         kzfree(priv);
298 }
299
300 static void ahash_notify_einprogress(struct ahash_request *req)
301 {
302         struct ahash_request_priv *priv = req->priv;
303         struct crypto_async_request oreq;
304
305         oreq.data = priv->data;
306
307         priv->complete(&oreq, -EINPROGRESS);
308 }
309
310 static void ahash_op_unaligned_done(struct crypto_async_request *req, int err)
311 {
312         struct ahash_request *areq = req->data;
313
314         if (err == -EINPROGRESS) {
315                 ahash_notify_einprogress(areq);
316                 return;
317         }
318
319         /*
320          * Restore the original request, see ahash_op_unaligned() for what
321          * goes where.
322          *
323          * The "struct ahash_request *req" here is in fact the "req.base"
324          * from the ADJUSTED request from ahash_op_unaligned(), thus as it
325          * is a pointer to self, it is also the ADJUSTED "req" .
326          */
327
328         /* First copy req->result into req->priv.result */
329         ahash_restore_req(areq, err);
330
331         /* Complete the ORIGINAL request. */
332         areq->base.complete(&areq->base, err);
333 }
334
335 static int ahash_op_unaligned(struct ahash_request *req,
336                               int (*op)(struct ahash_request *))
337 {
338         int err;
339
340         err = ahash_save_req(req, ahash_op_unaligned_done);
341         if (err)
342                 return err;
343
344         err = op(req);
345         if (err == -EINPROGRESS || err == -EBUSY)
346                 return err;
347
348         ahash_restore_req(req, err);
349
350         return err;
351 }
352
353 static int crypto_ahash_op(struct ahash_request *req,
354                            int (*op)(struct ahash_request *))
355 {
356         struct crypto_ahash *tfm = crypto_ahash_reqtfm(req);
357         unsigned long alignmask = crypto_ahash_alignmask(tfm);
358
359         if ((unsigned long)req->result & alignmask)
360                 return ahash_op_unaligned(req, op);
361
362         return op(req);
363 }
364
365 int crypto_ahash_final(struct ahash_request *req)
366 {
367         struct crypto_ahash *tfm = crypto_ahash_reqtfm(req);
368         struct crypto_alg *alg = tfm->base.__crt_alg;
369         unsigned int nbytes = req->nbytes;
370         int ret;
371
372         crypto_stats_get(alg);
373         ret = crypto_ahash_op(req, crypto_ahash_reqtfm(req)->final);
374         crypto_stats_ahash_final(nbytes, ret, alg);
375         return ret;
376 }
377 EXPORT_SYMBOL_GPL(crypto_ahash_final);
378
379 int crypto_ahash_finup(struct ahash_request *req)
380 {
381         struct crypto_ahash *tfm = crypto_ahash_reqtfm(req);
382         struct crypto_alg *alg = tfm->base.__crt_alg;
383         unsigned int nbytes = req->nbytes;
384         int ret;
385
386         crypto_stats_get(alg);
387         ret = crypto_ahash_op(req, crypto_ahash_reqtfm(req)->finup);
388         crypto_stats_ahash_final(nbytes, ret, alg);
389         return ret;
390 }
391 EXPORT_SYMBOL_GPL(crypto_ahash_finup);
392
393 int crypto_ahash_digest(struct ahash_request *req)
394 {
395         struct crypto_ahash *tfm = crypto_ahash_reqtfm(req);
396         struct crypto_alg *alg = tfm->base.__crt_alg;
397         unsigned int nbytes = req->nbytes;
398         int ret;
399
400         crypto_stats_get(alg);
401         if (crypto_ahash_get_flags(tfm) & CRYPTO_TFM_NEED_KEY)
402                 ret = -ENOKEY;
403         else
404                 ret = crypto_ahash_op(req, tfm->digest);
405         crypto_stats_ahash_final(nbytes, ret, alg);
406         return ret;
407 }
408 EXPORT_SYMBOL_GPL(crypto_ahash_digest);
409
410 static void ahash_def_finup_done2(struct crypto_async_request *req, int err)
411 {
412         struct ahash_request *areq = req->data;
413
414         if (err == -EINPROGRESS)
415                 return;
416
417         ahash_restore_req(areq, err);
418
419         areq->base.complete(&areq->base, err);
420 }
421
422 static int ahash_def_finup_finish1(struct ahash_request *req, int err)
423 {
424         if (err)
425                 goto out;
426
427         req->base.complete = ahash_def_finup_done2;
428
429         err = crypto_ahash_reqtfm(req)->final(req);
430         if (err == -EINPROGRESS || err == -EBUSY)
431                 return err;
432
433 out:
434         ahash_restore_req(req, err);
435         return err;
436 }
437
438 static void ahash_def_finup_done1(struct crypto_async_request *req, int err)
439 {
440         struct ahash_request *areq = req->data;
441
442         if (err == -EINPROGRESS) {
443                 ahash_notify_einprogress(areq);
444                 return;
445         }
446
447         areq->base.flags &= ~CRYPTO_TFM_REQ_MAY_SLEEP;
448
449         err = ahash_def_finup_finish1(areq, err);
450         if (areq->priv)
451                 return;
452
453         areq->base.complete(&areq->base, err);
454 }
455
456 static int ahash_def_finup(struct ahash_request *req)
457 {
458         struct crypto_ahash *tfm = crypto_ahash_reqtfm(req);
459         int err;
460
461         err = ahash_save_req(req, ahash_def_finup_done1);
462         if (err)
463                 return err;
464
465         err = tfm->update(req);
466         if (err == -EINPROGRESS || err == -EBUSY)
467                 return err;
468
469         return ahash_def_finup_finish1(req, err);
470 }
471
472 static int crypto_ahash_init_tfm(struct crypto_tfm *tfm)
473 {
474         struct crypto_ahash *hash = __crypto_ahash_cast(tfm);
475         struct ahash_alg *alg = crypto_ahash_alg(hash);
476
477         hash->setkey = ahash_nosetkey;
478
479         if (tfm->__crt_alg->cra_type != &crypto_ahash_type)
480                 return crypto_init_shash_ops_async(tfm);
481
482         hash->init = alg->init;
483         hash->update = alg->update;
484         hash->final = alg->final;
485         hash->finup = alg->finup ?: ahash_def_finup;
486         hash->digest = alg->digest;
487         hash->export = alg->export;
488         hash->import = alg->import;
489
490         if (alg->setkey) {
491                 hash->setkey = alg->setkey;
492                 if (!(alg->halg.base.cra_flags & CRYPTO_ALG_OPTIONAL_KEY))
493                         crypto_ahash_set_flags(hash, CRYPTO_TFM_NEED_KEY);
494         }
495
496         return 0;
497 }
498
499 static unsigned int crypto_ahash_extsize(struct crypto_alg *alg)
500 {
501         if (alg->cra_type != &crypto_ahash_type)
502                 return sizeof(struct crypto_shash *);
503
504         return crypto_alg_extsize(alg);
505 }
506
507 #ifdef CONFIG_NET
508 static int crypto_ahash_report(struct sk_buff *skb, struct crypto_alg *alg)
509 {
510         struct crypto_report_hash rhash;
511
512         memset(&rhash, 0, sizeof(rhash));
513
514         strscpy(rhash.type, "ahash", sizeof(rhash.type));
515
516         rhash.blocksize = alg->cra_blocksize;
517         rhash.digestsize = __crypto_hash_alg_common(alg)->digestsize;
518
519         return nla_put(skb, CRYPTOCFGA_REPORT_HASH, sizeof(rhash), &rhash);
520 }
521 #else
522 static int crypto_ahash_report(struct sk_buff *skb, struct crypto_alg *alg)
523 {
524         return -ENOSYS;
525 }
526 #endif
527
528 static void crypto_ahash_show(struct seq_file *m, struct crypto_alg *alg)
529         __maybe_unused;
530 static void crypto_ahash_show(struct seq_file *m, struct crypto_alg *alg)
531 {
532         seq_printf(m, "type         : ahash\n");
533         seq_printf(m, "async        : %s\n", alg->cra_flags & CRYPTO_ALG_ASYNC ?
534                                              "yes" : "no");
535         seq_printf(m, "blocksize    : %u\n", alg->cra_blocksize);
536         seq_printf(m, "digestsize   : %u\n",
537                    __crypto_hash_alg_common(alg)->digestsize);
538 }
539
540 const struct crypto_type crypto_ahash_type = {
541         .extsize = crypto_ahash_extsize,
542         .init_tfm = crypto_ahash_init_tfm,
543 #ifdef CONFIG_PROC_FS
544         .show = crypto_ahash_show,
545 #endif
546         .report = crypto_ahash_report,
547         .maskclear = ~CRYPTO_ALG_TYPE_MASK,
548         .maskset = CRYPTO_ALG_TYPE_AHASH_MASK,
549         .type = CRYPTO_ALG_TYPE_AHASH,
550         .tfmsize = offsetof(struct crypto_ahash, base),
551 };
552 EXPORT_SYMBOL_GPL(crypto_ahash_type);
553
554 struct crypto_ahash *crypto_alloc_ahash(const char *alg_name, u32 type,
555                                         u32 mask)
556 {
557         return crypto_alloc_tfm(alg_name, &crypto_ahash_type, type, mask);
558 }
559 EXPORT_SYMBOL_GPL(crypto_alloc_ahash);
560
561 int crypto_has_ahash(const char *alg_name, u32 type, u32 mask)
562 {
563         return crypto_type_has_alg(alg_name, &crypto_ahash_type, type, mask);
564 }
565 EXPORT_SYMBOL_GPL(crypto_has_ahash);
566
567 static int ahash_prepare_alg(struct ahash_alg *alg)
568 {
569         struct crypto_alg *base = &alg->halg.base;
570
571         if (alg->halg.digestsize > HASH_MAX_DIGESTSIZE ||
572             alg->halg.statesize > HASH_MAX_STATESIZE ||
573             alg->halg.statesize == 0)
574                 return -EINVAL;
575
576         base->cra_type = &crypto_ahash_type;
577         base->cra_flags &= ~CRYPTO_ALG_TYPE_MASK;
578         base->cra_flags |= CRYPTO_ALG_TYPE_AHASH;
579
580         return 0;
581 }
582
583 int crypto_register_ahash(struct ahash_alg *alg)
584 {
585         struct crypto_alg *base = &alg->halg.base;
586         int err;
587
588         err = ahash_prepare_alg(alg);
589         if (err)
590                 return err;
591
592         return crypto_register_alg(base);
593 }
594 EXPORT_SYMBOL_GPL(crypto_register_ahash);
595
596 int crypto_unregister_ahash(struct ahash_alg *alg)
597 {
598         return crypto_unregister_alg(&alg->halg.base);
599 }
600 EXPORT_SYMBOL_GPL(crypto_unregister_ahash);
601
602 int crypto_register_ahashes(struct ahash_alg *algs, int count)
603 {
604         int i, ret;
605
606         for (i = 0; i < count; i++) {
607                 ret = crypto_register_ahash(&algs[i]);
608                 if (ret)
609                         goto err;
610         }
611
612         return 0;
613
614 err:
615         for (--i; i >= 0; --i)
616                 crypto_unregister_ahash(&algs[i]);
617
618         return ret;
619 }
620 EXPORT_SYMBOL_GPL(crypto_register_ahashes);
621
622 void crypto_unregister_ahashes(struct ahash_alg *algs, int count)
623 {
624         int i;
625
626         for (i = count - 1; i >= 0; --i)
627                 crypto_unregister_ahash(&algs[i]);
628 }
629 EXPORT_SYMBOL_GPL(crypto_unregister_ahashes);
630
631 int ahash_register_instance(struct crypto_template *tmpl,
632                             struct ahash_instance *inst)
633 {
634         int err;
635
636         err = ahash_prepare_alg(&inst->alg);
637         if (err)
638                 return err;
639
640         return crypto_register_instance(tmpl, ahash_crypto_instance(inst));
641 }
642 EXPORT_SYMBOL_GPL(ahash_register_instance);
643
644 void ahash_free_instance(struct crypto_instance *inst)
645 {
646         crypto_drop_spawn(crypto_instance_ctx(inst));
647         kfree(ahash_instance(inst));
648 }
649 EXPORT_SYMBOL_GPL(ahash_free_instance);
650
651 int crypto_init_ahash_spawn(struct crypto_ahash_spawn *spawn,
652                             struct hash_alg_common *alg,
653                             struct crypto_instance *inst)
654 {
655         return crypto_init_spawn2(&spawn->base, &alg->base, inst,
656                                   &crypto_ahash_type);
657 }
658 EXPORT_SYMBOL_GPL(crypto_init_ahash_spawn);
659
660 struct hash_alg_common *ahash_attr_alg(struct rtattr *rta, u32 type, u32 mask)
661 {
662         struct crypto_alg *alg;
663
664         alg = crypto_attr_alg2(rta, &crypto_ahash_type, type, mask);
665         return IS_ERR(alg) ? ERR_CAST(alg) : __crypto_hash_alg_common(alg);
666 }
667 EXPORT_SYMBOL_GPL(ahash_attr_alg);
668
669 bool crypto_hash_alg_has_setkey(struct hash_alg_common *halg)
670 {
671         struct crypto_alg *alg = &halg->base;
672
673         if (alg->cra_type != &crypto_ahash_type)
674                 return crypto_shash_alg_has_setkey(__crypto_shash_alg(alg));
675
676         return __crypto_ahash_alg(alg)->setkey != NULL;
677 }
678 EXPORT_SYMBOL_GPL(crypto_hash_alg_has_setkey);
679
680 MODULE_LICENSE("GPL");
681 MODULE_DESCRIPTION("Asynchronous cryptographic hash type");