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
;
89 unsigned int nbytes
= walk
->entrylen
;
91 walk
->data
-= walk
->offset
;
93 if (nbytes
&& walk
->offset
& alignmask
&& !err
) {
94 walk
->offset
= ALIGN(walk
->offset
, alignmask
+ 1);
96 ((unsigned int)(PAGE_SIZE
)) - walk
->offset
);
97 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
);
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 int crypto_ahash_setkey(struct crypto_ahash
*tfm
, const u8
*key
,
196 unsigned long alignmask
= crypto_ahash_alignmask(tfm
);
199 if ((unsigned long)key
& alignmask
)
200 err
= ahash_setkey_unaligned(tfm
, key
, keylen
);
202 err
= tfm
->setkey(tfm
, key
, keylen
);
207 crypto_ahash_clear_flags(tfm
, CRYPTO_TFM_NEED_KEY
);
210 EXPORT_SYMBOL_GPL(crypto_ahash_setkey
);
212 static int ahash_nosetkey(struct crypto_ahash
*tfm
, const u8
*key
,
218 static inline unsigned int ahash_align_buffer_size(unsigned len
,
221 return len
+ (mask
& ~(crypto_tfm_ctx_alignment() - 1));
224 static int ahash_save_req(struct ahash_request
*req
, crypto_completion_t cplt
)
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
;
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
);
238 * WARNING: Voodoo programming below!
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!
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.
249 * The newly mangled request will look as such:
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)
262 priv
->result
= req
->result
;
263 priv
->complete
= req
->base
.complete
;
264 priv
->data
= req
->base
.data
;
265 priv
->flags
= req
->base
.flags
;
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!
273 req
->result
= PTR_ALIGN((u8
*)priv
->ubuf
, alignmask
+ 1);
274 req
->base
.complete
= cplt
;
275 req
->base
.data
= req
;
281 static void ahash_restore_req(struct ahash_request
*req
, int err
)
283 struct ahash_request_priv
*priv
= req
->priv
;
286 memcpy(priv
->result
, req
->result
,
287 crypto_ahash_digestsize(crypto_ahash_reqtfm(req
)));
289 /* Restore the original crypto request. */
290 req
->result
= priv
->result
;
292 ahash_request_set_callback(req
, priv
->flags
,
293 priv
->complete
, priv
->data
);
296 /* Free the req->priv.priv from the ADJUSTED request. */
300 static void ahash_notify_einprogress(struct ahash_request
*req
)
302 struct ahash_request_priv
*priv
= req
->priv
;
303 struct crypto_async_request oreq
;
305 oreq
.data
= priv
->data
;
307 priv
->complete(&oreq
, -EINPROGRESS
);
310 static void ahash_op_unaligned_done(struct crypto_async_request
*req
, int err
)
312 struct ahash_request
*areq
= req
->data
;
314 if (err
== -EINPROGRESS
) {
315 ahash_notify_einprogress(areq
);
320 * Restore the original request, see ahash_op_unaligned() for what
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" .
328 /* First copy req->result into req->priv.result */
329 ahash_restore_req(areq
, err
);
331 /* Complete the ORIGINAL request. */
332 areq
->base
.complete(&areq
->base
, err
);
335 static int ahash_op_unaligned(struct ahash_request
*req
,
336 int (*op
)(struct ahash_request
*))
340 err
= ahash_save_req(req
, ahash_op_unaligned_done
);
345 if (err
== -EINPROGRESS
||
346 (err
== -EBUSY
&& (ahash_request_flags(req
) &
347 CRYPTO_TFM_REQ_MAY_BACKLOG
)))
350 ahash_restore_req(req
, err
);
355 static int crypto_ahash_op(struct ahash_request
*req
,
356 int (*op
)(struct ahash_request
*))
358 struct crypto_ahash
*tfm
= crypto_ahash_reqtfm(req
);
359 unsigned long alignmask
= crypto_ahash_alignmask(tfm
);
361 if ((unsigned long)req
->result
& alignmask
)
362 return ahash_op_unaligned(req
, op
);
367 int crypto_ahash_final(struct ahash_request
*req
)
369 return crypto_ahash_op(req
, crypto_ahash_reqtfm(req
)->final
);
371 EXPORT_SYMBOL_GPL(crypto_ahash_final
);
373 int crypto_ahash_finup(struct ahash_request
*req
)
375 return crypto_ahash_op(req
, crypto_ahash_reqtfm(req
)->finup
);
377 EXPORT_SYMBOL_GPL(crypto_ahash_finup
);
379 int crypto_ahash_digest(struct ahash_request
*req
)
381 struct crypto_ahash
*tfm
= crypto_ahash_reqtfm(req
);
383 if (crypto_ahash_get_flags(tfm
) & CRYPTO_TFM_NEED_KEY
)
386 return crypto_ahash_op(req
, tfm
->digest
);
388 EXPORT_SYMBOL_GPL(crypto_ahash_digest
);
390 static void ahash_def_finup_done2(struct crypto_async_request
*req
, int err
)
392 struct ahash_request
*areq
= req
->data
;
394 if (err
== -EINPROGRESS
)
397 ahash_restore_req(areq
, err
);
399 areq
->base
.complete(&areq
->base
, err
);
402 static int ahash_def_finup_finish1(struct ahash_request
*req
, int err
)
407 req
->base
.complete
= ahash_def_finup_done2
;
409 err
= crypto_ahash_reqtfm(req
)->final(req
);
410 if (err
== -EINPROGRESS
||
411 (err
== -EBUSY
&& (ahash_request_flags(req
) &
412 CRYPTO_TFM_REQ_MAY_BACKLOG
)))
416 ahash_restore_req(req
, err
);
420 static void ahash_def_finup_done1(struct crypto_async_request
*req
, int err
)
422 struct ahash_request
*areq
= req
->data
;
424 if (err
== -EINPROGRESS
) {
425 ahash_notify_einprogress(areq
);
429 areq
->base
.flags
&= ~CRYPTO_TFM_REQ_MAY_SLEEP
;
431 err
= ahash_def_finup_finish1(areq
, err
);
435 areq
->base
.complete(&areq
->base
, err
);
438 static int ahash_def_finup(struct ahash_request
*req
)
440 struct crypto_ahash
*tfm
= crypto_ahash_reqtfm(req
);
443 err
= ahash_save_req(req
, ahash_def_finup_done1
);
447 err
= tfm
->update(req
);
448 if (err
== -EINPROGRESS
||
449 (err
== -EBUSY
&& (ahash_request_flags(req
) &
450 CRYPTO_TFM_REQ_MAY_BACKLOG
)))
453 return ahash_def_finup_finish1(req
, err
);
456 static int ahash_no_export(struct ahash_request
*req
, void *out
)
461 static int ahash_no_import(struct ahash_request
*req
, const void *in
)
466 static int crypto_ahash_init_tfm(struct crypto_tfm
*tfm
)
468 struct crypto_ahash
*hash
= __crypto_ahash_cast(tfm
);
469 struct ahash_alg
*alg
= crypto_ahash_alg(hash
);
471 hash
->setkey
= ahash_nosetkey
;
472 hash
->export
= ahash_no_export
;
473 hash
->import
= ahash_no_import
;
475 if (tfm
->__crt_alg
->cra_type
!= &crypto_ahash_type
)
476 return crypto_init_shash_ops_async(tfm
);
478 hash
->init
= alg
->init
;
479 hash
->update
= alg
->update
;
480 hash
->final
= alg
->final
;
481 hash
->finup
= alg
->finup
?: ahash_def_finup
;
482 hash
->digest
= alg
->digest
;
485 hash
->setkey
= alg
->setkey
;
486 if (!(alg
->halg
.base
.cra_flags
& CRYPTO_ALG_OPTIONAL_KEY
))
487 crypto_ahash_set_flags(hash
, CRYPTO_TFM_NEED_KEY
);
490 hash
->export
= alg
->export
;
492 hash
->import
= alg
->import
;
497 static unsigned int crypto_ahash_extsize(struct crypto_alg
*alg
)
499 if (alg
->cra_type
!= &crypto_ahash_type
)
500 return sizeof(struct crypto_shash
*);
502 return crypto_alg_extsize(alg
);
506 static int crypto_ahash_report(struct sk_buff
*skb
, struct crypto_alg
*alg
)
508 struct crypto_report_hash rhash
;
510 strncpy(rhash
.type
, "ahash", sizeof(rhash
.type
));
512 rhash
.blocksize
= alg
->cra_blocksize
;
513 rhash
.digestsize
= __crypto_hash_alg_common(alg
)->digestsize
;
515 if (nla_put(skb
, CRYPTOCFGA_REPORT_HASH
,
516 sizeof(struct crypto_report_hash
), &rhash
))
517 goto nla_put_failure
;
524 static int crypto_ahash_report(struct sk_buff
*skb
, struct crypto_alg
*alg
)
530 static void crypto_ahash_show(struct seq_file
*m
, struct crypto_alg
*alg
)
532 static void crypto_ahash_show(struct seq_file
*m
, struct crypto_alg
*alg
)
534 seq_printf(m
, "type : ahash\n");
535 seq_printf(m
, "async : %s\n", alg
->cra_flags
& CRYPTO_ALG_ASYNC
?
537 seq_printf(m
, "blocksize : %u\n", alg
->cra_blocksize
);
538 seq_printf(m
, "digestsize : %u\n",
539 __crypto_hash_alg_common(alg
)->digestsize
);
542 const struct crypto_type crypto_ahash_type
= {
543 .extsize
= crypto_ahash_extsize
,
544 .init_tfm
= crypto_ahash_init_tfm
,
545 #ifdef CONFIG_PROC_FS
546 .show
= crypto_ahash_show
,
548 .report
= crypto_ahash_report
,
549 .maskclear
= ~CRYPTO_ALG_TYPE_MASK
,
550 .maskset
= CRYPTO_ALG_TYPE_AHASH_MASK
,
551 .type
= CRYPTO_ALG_TYPE_AHASH
,
552 .tfmsize
= offsetof(struct crypto_ahash
, base
),
554 EXPORT_SYMBOL_GPL(crypto_ahash_type
);
556 struct crypto_ahash
*crypto_alloc_ahash(const char *alg_name
, u32 type
,
559 return crypto_alloc_tfm(alg_name
, &crypto_ahash_type
, type
, mask
);
561 EXPORT_SYMBOL_GPL(crypto_alloc_ahash
);
563 int crypto_has_ahash(const char *alg_name
, u32 type
, u32 mask
)
565 return crypto_type_has_alg(alg_name
, &crypto_ahash_type
, type
, mask
);
567 EXPORT_SYMBOL_GPL(crypto_has_ahash
);
569 static int ahash_prepare_alg(struct ahash_alg
*alg
)
571 struct crypto_alg
*base
= &alg
->halg
.base
;
573 if (alg
->halg
.digestsize
> PAGE_SIZE
/ 8 ||
574 alg
->halg
.statesize
> PAGE_SIZE
/ 8 ||
575 alg
->halg
.statesize
== 0)
578 base
->cra_type
= &crypto_ahash_type
;
579 base
->cra_flags
&= ~CRYPTO_ALG_TYPE_MASK
;
580 base
->cra_flags
|= CRYPTO_ALG_TYPE_AHASH
;
585 int crypto_register_ahash(struct ahash_alg
*alg
)
587 struct crypto_alg
*base
= &alg
->halg
.base
;
590 err
= ahash_prepare_alg(alg
);
594 return crypto_register_alg(base
);
596 EXPORT_SYMBOL_GPL(crypto_register_ahash
);
598 int crypto_unregister_ahash(struct ahash_alg
*alg
)
600 return crypto_unregister_alg(&alg
->halg
.base
);
602 EXPORT_SYMBOL_GPL(crypto_unregister_ahash
);
604 int crypto_register_ahashes(struct ahash_alg
*algs
, int count
)
608 for (i
= 0; i
< count
; i
++) {
609 ret
= crypto_register_ahash(&algs
[i
]);
617 for (--i
; i
>= 0; --i
)
618 crypto_unregister_ahash(&algs
[i
]);
622 EXPORT_SYMBOL_GPL(crypto_register_ahashes
);
624 void crypto_unregister_ahashes(struct ahash_alg
*algs
, int count
)
628 for (i
= count
- 1; i
>= 0; --i
)
629 crypto_unregister_ahash(&algs
[i
]);
631 EXPORT_SYMBOL_GPL(crypto_unregister_ahashes
);
633 int ahash_register_instance(struct crypto_template
*tmpl
,
634 struct ahash_instance
*inst
)
638 err
= ahash_prepare_alg(&inst
->alg
);
642 return crypto_register_instance(tmpl
, ahash_crypto_instance(inst
));
644 EXPORT_SYMBOL_GPL(ahash_register_instance
);
646 void ahash_free_instance(struct crypto_instance
*inst
)
648 crypto_drop_spawn(crypto_instance_ctx(inst
));
649 kfree(ahash_instance(inst
));
651 EXPORT_SYMBOL_GPL(ahash_free_instance
);
653 int crypto_init_ahash_spawn(struct crypto_ahash_spawn
*spawn
,
654 struct hash_alg_common
*alg
,
655 struct crypto_instance
*inst
)
657 return crypto_init_spawn2(&spawn
->base
, &alg
->base
, inst
,
660 EXPORT_SYMBOL_GPL(crypto_init_ahash_spawn
);
662 struct hash_alg_common
*ahash_attr_alg(struct rtattr
*rta
, u32 type
, u32 mask
)
664 struct crypto_alg
*alg
;
666 alg
= crypto_attr_alg2(rta
, &crypto_ahash_type
, type
, mask
);
667 return IS_ERR(alg
) ? ERR_CAST(alg
) : __crypto_hash_alg_common(alg
);
669 EXPORT_SYMBOL_GPL(ahash_attr_alg
);
671 bool crypto_hash_alg_has_setkey(struct hash_alg_common
*halg
)
673 struct crypto_alg
*alg
= &halg
->base
;
675 if (alg
->cra_type
!= &crypto_ahash_type
)
676 return crypto_shash_alg_has_setkey(__crypto_shash_alg(alg
));
678 return __crypto_ahash_alg(alg
)->setkey
!= NULL
;
680 EXPORT_SYMBOL_GPL(crypto_hash_alg_has_setkey
);
682 MODULE_LICENSE("GPL");
683 MODULE_DESCRIPTION("Asynchronous cryptographic hash type");