2 * Asynchronous Cryptographic Hash operations.
4 * This is the asynchronous version of hash.c with notification of
5 * completion via a callback.
7 * Copyright (c) 2008 Loc Ho <lho@amcc.com>
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)
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>
31 struct ahash_request_priv
{
32 crypto_completion_t complete
;
36 void *ubuf
[] CRYPTO_MINALIGN_ATTR
;
39 static inline struct ahash_alg
*crypto_ahash_alg(struct crypto_ahash
*hash
)
41 return container_of(crypto_hash_alg_common(hash
), struct ahash_alg
,
45 static int hash_walk_next(struct crypto_hash_walk
*walk
)
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
);
52 if (walk
->flags
& CRYPTO_ALG_ASYNC
)
53 walk
->data
= kmap(walk
->pg
);
55 walk
->data
= kmap_atomic(walk
->pg
);
58 if (offset
& alignmask
) {
59 unsigned int unaligned
= alignmask
+ 1 - (offset
& alignmask
);
61 if (nbytes
> unaligned
)
65 walk
->entrylen
-= nbytes
;
69 static int hash_walk_new_entry(struct crypto_hash_walk
*walk
)
71 struct scatterlist
*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
;
79 if (walk
->entrylen
> walk
->total
)
80 walk
->entrylen
= walk
->total
;
81 walk
->total
-= walk
->entrylen
;
83 return hash_walk_next(walk
);
86 int crypto_hash_walk_done(struct crypto_hash_walk
*walk
, int err
)
88 unsigned int alignmask
= walk
->alignmask
;
90 walk
->data
-= walk
->offset
;
92 if (walk
->entrylen
&& (walk
->offset
& alignmask
) && !err
) {
95 walk
->offset
= ALIGN(walk
->offset
, alignmask
+ 1);
96 nbytes
= min(walk
->entrylen
,
97 (unsigned int)(PAGE_SIZE
- walk
->offset
));
99 walk
->entrylen
-= nbytes
;
100 walk
->data
+= walk
->offset
;
105 if (walk
->flags
& CRYPTO_ALG_ASYNC
)
108 kunmap_atomic(walk
->data
);
110 * The may sleep test only makes sense for sync users.
111 * Async users don't need to sleep here anyway.
113 crypto_yield(walk
->flags
);
119 if (walk
->entrylen
) {
122 return hash_walk_next(walk
);
128 walk
->sg
= sg_next(walk
->sg
);
130 return hash_walk_new_entry(walk
);
132 EXPORT_SYMBOL_GPL(crypto_hash_walk_done
);
134 int crypto_hash_walk_first(struct ahash_request
*req
,
135 struct crypto_hash_walk
*walk
)
137 walk
->total
= req
->nbytes
;
144 walk
->alignmask
= crypto_ahash_alignmask(crypto_ahash_reqtfm(req
));
146 walk
->flags
= req
->base
.flags
& CRYPTO_TFM_REQ_MASK
;
148 return hash_walk_new_entry(walk
);
150 EXPORT_SYMBOL_GPL(crypto_hash_walk_first
);
152 int crypto_ahash_walk_first(struct ahash_request
*req
,
153 struct crypto_hash_walk
*walk
)
155 walk
->total
= req
->nbytes
;
162 walk
->alignmask
= crypto_ahash_alignmask(crypto_ahash_reqtfm(req
));
164 walk
->flags
= req
->base
.flags
& CRYPTO_TFM_REQ_MASK
;
165 walk
->flags
|= CRYPTO_ALG_ASYNC
;
167 BUILD_BUG_ON(CRYPTO_TFM_REQ_MASK
& CRYPTO_ALG_ASYNC
);
169 return hash_walk_new_entry(walk
);
171 EXPORT_SYMBOL_GPL(crypto_ahash_walk_first
);
173 static int ahash_setkey_unaligned(struct crypto_ahash
*tfm
, const u8
*key
,
176 unsigned long alignmask
= crypto_ahash_alignmask(tfm
);
178 u8
*buffer
, *alignbuffer
;
179 unsigned long absize
;
181 absize
= keylen
+ alignmask
;
182 buffer
= kmalloc(absize
, GFP_KERNEL
);
186 alignbuffer
= (u8
*)ALIGN((unsigned long)buffer
, alignmask
+ 1);
187 memcpy(alignbuffer
, key
, keylen
);
188 ret
= tfm
->setkey(tfm
, alignbuffer
, keylen
);
193 static int ahash_nosetkey(struct crypto_ahash
*tfm
, const u8
*key
,
199 static void ahash_set_needkey(struct crypto_ahash
*tfm
)
201 const struct hash_alg_common
*alg
= crypto_hash_alg_common(tfm
);
203 if (tfm
->setkey
!= ahash_nosetkey
&&
204 !(alg
->base
.cra_flags
& CRYPTO_ALG_OPTIONAL_KEY
))
205 crypto_ahash_set_flags(tfm
, CRYPTO_TFM_NEED_KEY
);
208 int crypto_ahash_setkey(struct crypto_ahash
*tfm
, const u8
*key
,
211 unsigned long alignmask
= crypto_ahash_alignmask(tfm
);
214 if ((unsigned long)key
& alignmask
)
215 err
= ahash_setkey_unaligned(tfm
, key
, keylen
);
217 err
= tfm
->setkey(tfm
, key
, keylen
);
220 ahash_set_needkey(tfm
);
224 crypto_ahash_clear_flags(tfm
, CRYPTO_TFM_NEED_KEY
);
227 EXPORT_SYMBOL_GPL(crypto_ahash_setkey
);
229 static inline unsigned int ahash_align_buffer_size(unsigned len
,
232 return len
+ (mask
& ~(crypto_tfm_ctx_alignment() - 1));
235 static int ahash_save_req(struct ahash_request
*req
, crypto_completion_t cplt
)
237 struct crypto_ahash
*tfm
= crypto_ahash_reqtfm(req
);
238 unsigned long alignmask
= crypto_ahash_alignmask(tfm
);
239 unsigned int ds
= crypto_ahash_digestsize(tfm
);
240 struct ahash_request_priv
*priv
;
242 priv
= kmalloc(sizeof(*priv
) + ahash_align_buffer_size(ds
, alignmask
),
243 (req
->base
.flags
& CRYPTO_TFM_REQ_MAY_SLEEP
) ?
244 GFP_KERNEL
: GFP_ATOMIC
);
249 * WARNING: Voodoo programming below!
251 * The code below is obscure and hard to understand, thus explanation
252 * is necessary. See include/crypto/hash.h and include/linux/crypto.h
253 * to understand the layout of structures used here!
255 * The code here will replace portions of the ORIGINAL request with
256 * pointers to new code and buffers so the hashing operation can store
257 * the result in aligned buffer. We will call the modified request
258 * an ADJUSTED request.
260 * The newly mangled request will look as such:
263 * .result = ADJUSTED[new aligned buffer]
264 * .base.complete = ADJUSTED[pointer to completion function]
265 * .base.data = ADJUSTED[*req (pointer to self)]
266 * .priv = ADJUSTED[new priv] {
267 * .result = ORIGINAL(result)
268 * .complete = ORIGINAL(base.complete)
269 * .data = ORIGINAL(base.data)
273 priv
->result
= req
->result
;
274 priv
->complete
= req
->base
.complete
;
275 priv
->data
= req
->base
.data
;
276 priv
->flags
= req
->base
.flags
;
279 * WARNING: We do not backup req->priv here! The req->priv
280 * is for internal use of the Crypto API and the
281 * user must _NOT_ _EVER_ depend on it's content!
284 req
->result
= PTR_ALIGN((u8
*)priv
->ubuf
, alignmask
+ 1);
285 req
->base
.complete
= cplt
;
286 req
->base
.data
= req
;
292 static void ahash_restore_req(struct ahash_request
*req
, int err
)
294 struct ahash_request_priv
*priv
= req
->priv
;
297 memcpy(priv
->result
, req
->result
,
298 crypto_ahash_digestsize(crypto_ahash_reqtfm(req
)));
300 /* Restore the original crypto request. */
301 req
->result
= priv
->result
;
303 ahash_request_set_callback(req
, priv
->flags
,
304 priv
->complete
, priv
->data
);
307 /* Free the req->priv.priv from the ADJUSTED request. */
311 static void ahash_notify_einprogress(struct ahash_request
*req
)
313 struct ahash_request_priv
*priv
= req
->priv
;
314 struct crypto_async_request oreq
;
316 oreq
.data
= priv
->data
;
318 priv
->complete(&oreq
, -EINPROGRESS
);
321 static void ahash_op_unaligned_done(struct crypto_async_request
*req
, int err
)
323 struct ahash_request
*areq
= req
->data
;
325 if (err
== -EINPROGRESS
) {
326 ahash_notify_einprogress(areq
);
331 * Restore the original request, see ahash_op_unaligned() for what
334 * The "struct ahash_request *req" here is in fact the "req.base"
335 * from the ADJUSTED request from ahash_op_unaligned(), thus as it
336 * is a pointer to self, it is also the ADJUSTED "req" .
339 /* First copy req->result into req->priv.result */
340 ahash_restore_req(areq
, err
);
342 /* Complete the ORIGINAL request. */
343 areq
->base
.complete(&areq
->base
, err
);
346 static int ahash_op_unaligned(struct ahash_request
*req
,
347 int (*op
)(struct ahash_request
*))
351 err
= ahash_save_req(req
, ahash_op_unaligned_done
);
356 if (err
== -EINPROGRESS
|| err
== -EBUSY
)
359 ahash_restore_req(req
, err
);
364 static int crypto_ahash_op(struct ahash_request
*req
,
365 int (*op
)(struct ahash_request
*))
367 struct crypto_ahash
*tfm
= crypto_ahash_reqtfm(req
);
368 unsigned long alignmask
= crypto_ahash_alignmask(tfm
);
370 if ((unsigned long)req
->result
& alignmask
)
371 return ahash_op_unaligned(req
, op
);
376 int crypto_ahash_final(struct ahash_request
*req
)
378 struct crypto_ahash
*tfm
= crypto_ahash_reqtfm(req
);
379 struct crypto_alg
*alg
= tfm
->base
.__crt_alg
;
380 unsigned int nbytes
= req
->nbytes
;
383 crypto_stats_get(alg
);
384 ret
= crypto_ahash_op(req
, crypto_ahash_reqtfm(req
)->final
);
385 crypto_stats_ahash_final(nbytes
, ret
, alg
);
388 EXPORT_SYMBOL_GPL(crypto_ahash_final
);
390 int crypto_ahash_finup(struct ahash_request
*req
)
392 struct crypto_ahash
*tfm
= crypto_ahash_reqtfm(req
);
393 struct crypto_alg
*alg
= tfm
->base
.__crt_alg
;
394 unsigned int nbytes
= req
->nbytes
;
397 crypto_stats_get(alg
);
398 ret
= crypto_ahash_op(req
, crypto_ahash_reqtfm(req
)->finup
);
399 crypto_stats_ahash_final(nbytes
, ret
, alg
);
402 EXPORT_SYMBOL_GPL(crypto_ahash_finup
);
404 int crypto_ahash_digest(struct ahash_request
*req
)
406 struct crypto_ahash
*tfm
= crypto_ahash_reqtfm(req
);
407 struct crypto_alg
*alg
= tfm
->base
.__crt_alg
;
408 unsigned int nbytes
= req
->nbytes
;
411 crypto_stats_get(alg
);
412 if (crypto_ahash_get_flags(tfm
) & CRYPTO_TFM_NEED_KEY
)
415 ret
= crypto_ahash_op(req
, tfm
->digest
);
416 crypto_stats_ahash_final(nbytes
, ret
, alg
);
419 EXPORT_SYMBOL_GPL(crypto_ahash_digest
);
421 static void ahash_def_finup_done2(struct crypto_async_request
*req
, int err
)
423 struct ahash_request
*areq
= req
->data
;
425 if (err
== -EINPROGRESS
)
428 ahash_restore_req(areq
, err
);
430 areq
->base
.complete(&areq
->base
, err
);
433 static int ahash_def_finup_finish1(struct ahash_request
*req
, int err
)
438 req
->base
.complete
= ahash_def_finup_done2
;
440 err
= crypto_ahash_reqtfm(req
)->final(req
);
441 if (err
== -EINPROGRESS
|| err
== -EBUSY
)
445 ahash_restore_req(req
, err
);
449 static void ahash_def_finup_done1(struct crypto_async_request
*req
, int err
)
451 struct ahash_request
*areq
= req
->data
;
453 if (err
== -EINPROGRESS
) {
454 ahash_notify_einprogress(areq
);
458 areq
->base
.flags
&= ~CRYPTO_TFM_REQ_MAY_SLEEP
;
460 err
= ahash_def_finup_finish1(areq
, err
);
464 areq
->base
.complete(&areq
->base
, err
);
467 static int ahash_def_finup(struct ahash_request
*req
)
469 struct crypto_ahash
*tfm
= crypto_ahash_reqtfm(req
);
472 err
= ahash_save_req(req
, ahash_def_finup_done1
);
476 err
= tfm
->update(req
);
477 if (err
== -EINPROGRESS
|| err
== -EBUSY
)
480 return ahash_def_finup_finish1(req
, err
);
483 static int crypto_ahash_init_tfm(struct crypto_tfm
*tfm
)
485 struct crypto_ahash
*hash
= __crypto_ahash_cast(tfm
);
486 struct ahash_alg
*alg
= crypto_ahash_alg(hash
);
488 hash
->setkey
= ahash_nosetkey
;
490 if (tfm
->__crt_alg
->cra_type
!= &crypto_ahash_type
)
491 return crypto_init_shash_ops_async(tfm
);
493 hash
->init
= alg
->init
;
494 hash
->update
= alg
->update
;
495 hash
->final
= alg
->final
;
496 hash
->finup
= alg
->finup
?: ahash_def_finup
;
497 hash
->digest
= alg
->digest
;
498 hash
->export
= alg
->export
;
499 hash
->import
= alg
->import
;
502 hash
->setkey
= alg
->setkey
;
503 ahash_set_needkey(hash
);
509 static unsigned int crypto_ahash_extsize(struct crypto_alg
*alg
)
511 if (alg
->cra_type
!= &crypto_ahash_type
)
512 return sizeof(struct crypto_shash
*);
514 return crypto_alg_extsize(alg
);
518 static int crypto_ahash_report(struct sk_buff
*skb
, struct crypto_alg
*alg
)
520 struct crypto_report_hash rhash
;
522 memset(&rhash
, 0, sizeof(rhash
));
524 strscpy(rhash
.type
, "ahash", sizeof(rhash
.type
));
526 rhash
.blocksize
= alg
->cra_blocksize
;
527 rhash
.digestsize
= __crypto_hash_alg_common(alg
)->digestsize
;
529 return nla_put(skb
, CRYPTOCFGA_REPORT_HASH
, sizeof(rhash
), &rhash
);
532 static int crypto_ahash_report(struct sk_buff
*skb
, struct crypto_alg
*alg
)
538 static void crypto_ahash_show(struct seq_file
*m
, struct crypto_alg
*alg
)
540 static void crypto_ahash_show(struct seq_file
*m
, struct crypto_alg
*alg
)
542 seq_printf(m
, "type : ahash\n");
543 seq_printf(m
, "async : %s\n", alg
->cra_flags
& CRYPTO_ALG_ASYNC
?
545 seq_printf(m
, "blocksize : %u\n", alg
->cra_blocksize
);
546 seq_printf(m
, "digestsize : %u\n",
547 __crypto_hash_alg_common(alg
)->digestsize
);
550 const struct crypto_type crypto_ahash_type
= {
551 .extsize
= crypto_ahash_extsize
,
552 .init_tfm
= crypto_ahash_init_tfm
,
553 #ifdef CONFIG_PROC_FS
554 .show
= crypto_ahash_show
,
556 .report
= crypto_ahash_report
,
557 .maskclear
= ~CRYPTO_ALG_TYPE_MASK
,
558 .maskset
= CRYPTO_ALG_TYPE_AHASH_MASK
,
559 .type
= CRYPTO_ALG_TYPE_AHASH
,
560 .tfmsize
= offsetof(struct crypto_ahash
, base
),
562 EXPORT_SYMBOL_GPL(crypto_ahash_type
);
564 struct crypto_ahash
*crypto_alloc_ahash(const char *alg_name
, u32 type
,
567 return crypto_alloc_tfm(alg_name
, &crypto_ahash_type
, type
, mask
);
569 EXPORT_SYMBOL_GPL(crypto_alloc_ahash
);
571 int crypto_has_ahash(const char *alg_name
, u32 type
, u32 mask
)
573 return crypto_type_has_alg(alg_name
, &crypto_ahash_type
, type
, mask
);
575 EXPORT_SYMBOL_GPL(crypto_has_ahash
);
577 static int ahash_prepare_alg(struct ahash_alg
*alg
)
579 struct crypto_alg
*base
= &alg
->halg
.base
;
581 if (alg
->halg
.digestsize
> HASH_MAX_DIGESTSIZE
||
582 alg
->halg
.statesize
> HASH_MAX_STATESIZE
||
583 alg
->halg
.statesize
== 0)
586 base
->cra_type
= &crypto_ahash_type
;
587 base
->cra_flags
&= ~CRYPTO_ALG_TYPE_MASK
;
588 base
->cra_flags
|= CRYPTO_ALG_TYPE_AHASH
;
593 int crypto_register_ahash(struct ahash_alg
*alg
)
595 struct crypto_alg
*base
= &alg
->halg
.base
;
598 err
= ahash_prepare_alg(alg
);
602 return crypto_register_alg(base
);
604 EXPORT_SYMBOL_GPL(crypto_register_ahash
);
606 int crypto_unregister_ahash(struct ahash_alg
*alg
)
608 return crypto_unregister_alg(&alg
->halg
.base
);
610 EXPORT_SYMBOL_GPL(crypto_unregister_ahash
);
612 int crypto_register_ahashes(struct ahash_alg
*algs
, int count
)
616 for (i
= 0; i
< count
; i
++) {
617 ret
= crypto_register_ahash(&algs
[i
]);
625 for (--i
; i
>= 0; --i
)
626 crypto_unregister_ahash(&algs
[i
]);
630 EXPORT_SYMBOL_GPL(crypto_register_ahashes
);
632 void crypto_unregister_ahashes(struct ahash_alg
*algs
, int count
)
636 for (i
= count
- 1; i
>= 0; --i
)
637 crypto_unregister_ahash(&algs
[i
]);
639 EXPORT_SYMBOL_GPL(crypto_unregister_ahashes
);
641 int ahash_register_instance(struct crypto_template
*tmpl
,
642 struct ahash_instance
*inst
)
646 err
= ahash_prepare_alg(&inst
->alg
);
650 return crypto_register_instance(tmpl
, ahash_crypto_instance(inst
));
652 EXPORT_SYMBOL_GPL(ahash_register_instance
);
654 void ahash_free_instance(struct crypto_instance
*inst
)
656 crypto_drop_spawn(crypto_instance_ctx(inst
));
657 kfree(ahash_instance(inst
));
659 EXPORT_SYMBOL_GPL(ahash_free_instance
);
661 int crypto_init_ahash_spawn(struct crypto_ahash_spawn
*spawn
,
662 struct hash_alg_common
*alg
,
663 struct crypto_instance
*inst
)
665 return crypto_init_spawn2(&spawn
->base
, &alg
->base
, inst
,
668 EXPORT_SYMBOL_GPL(crypto_init_ahash_spawn
);
670 struct hash_alg_common
*ahash_attr_alg(struct rtattr
*rta
, u32 type
, u32 mask
)
672 struct crypto_alg
*alg
;
674 alg
= crypto_attr_alg2(rta
, &crypto_ahash_type
, type
, mask
);
675 return IS_ERR(alg
) ? ERR_CAST(alg
) : __crypto_hash_alg_common(alg
);
677 EXPORT_SYMBOL_GPL(ahash_attr_alg
);
679 bool crypto_hash_alg_has_setkey(struct hash_alg_common
*halg
)
681 struct crypto_alg
*alg
= &halg
->base
;
683 if (alg
->cra_type
!= &crypto_ahash_type
)
684 return crypto_shash_alg_has_setkey(__crypto_shash_alg(alg
));
686 return __crypto_ahash_alg(alg
)->setkey
!= NULL
;
688 EXPORT_SYMBOL_GPL(crypto_hash_alg_has_setkey
);
690 MODULE_LICENSE("GPL");
691 MODULE_DESCRIPTION("Asynchronous cryptographic hash type");