docbook: add idr/ida to kernel-api docbook
[linux-2.6/next.git] / crypto / shash.c
blob22fd9433141f997c2d5d11f0e46625309dfbe43a
1 /*
2 * Synchronous Cryptographic Hash operations.
4 * Copyright (c) 2008 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)
9 * any later version.
13 #include <crypto/scatterwalk.h>
14 #include <crypto/internal/hash.h>
15 #include <linux/err.h>
16 #include <linux/kernel.h>
17 #include <linux/module.h>
18 #include <linux/slab.h>
19 #include <linux/seq_file.h>
21 #include "internal.h"
23 static const struct crypto_type crypto_shash_type;
25 static int shash_no_setkey(struct crypto_shash *tfm, const u8 *key,
26 unsigned int keylen)
28 return -ENOSYS;
31 static int shash_setkey_unaligned(struct crypto_shash *tfm, const u8 *key,
32 unsigned int keylen)
34 struct shash_alg *shash = crypto_shash_alg(tfm);
35 unsigned long alignmask = crypto_shash_alignmask(tfm);
36 unsigned long absize;
37 u8 *buffer, *alignbuffer;
38 int err;
40 absize = keylen + (alignmask & ~(crypto_tfm_ctx_alignment() - 1));
41 buffer = kmalloc(absize, GFP_KERNEL);
42 if (!buffer)
43 return -ENOMEM;
45 alignbuffer = (u8 *)ALIGN((unsigned long)buffer, alignmask + 1);
46 memcpy(alignbuffer, key, keylen);
47 err = shash->setkey(tfm, alignbuffer, keylen);
48 kzfree(buffer);
49 return err;
52 int crypto_shash_setkey(struct crypto_shash *tfm, const u8 *key,
53 unsigned int keylen)
55 struct shash_alg *shash = crypto_shash_alg(tfm);
56 unsigned long alignmask = crypto_shash_alignmask(tfm);
58 if ((unsigned long)key & alignmask)
59 return shash_setkey_unaligned(tfm, key, keylen);
61 return shash->setkey(tfm, key, keylen);
63 EXPORT_SYMBOL_GPL(crypto_shash_setkey);
65 static inline unsigned int shash_align_buffer_size(unsigned len,
66 unsigned long mask)
68 return len + (mask & ~(__alignof__(u8 __attribute__ ((aligned))) - 1));
71 static int shash_update_unaligned(struct shash_desc *desc, const u8 *data,
72 unsigned int len)
74 struct crypto_shash *tfm = desc->tfm;
75 struct shash_alg *shash = crypto_shash_alg(tfm);
76 unsigned long alignmask = crypto_shash_alignmask(tfm);
77 unsigned int unaligned_len = alignmask + 1 -
78 ((unsigned long)data & alignmask);
79 u8 ubuf[shash_align_buffer_size(unaligned_len, alignmask)]
80 __attribute__ ((aligned));
81 u8 *buf = PTR_ALIGN(&ubuf[0], alignmask + 1);
82 int err;
84 if (unaligned_len > len)
85 unaligned_len = len;
87 memcpy(buf, data, unaligned_len);
88 err = shash->update(desc, buf, unaligned_len);
89 memset(buf, 0, unaligned_len);
91 return err ?:
92 shash->update(desc, data + unaligned_len, len - unaligned_len);
95 int crypto_shash_update(struct shash_desc *desc, const u8 *data,
96 unsigned int len)
98 struct crypto_shash *tfm = desc->tfm;
99 struct shash_alg *shash = crypto_shash_alg(tfm);
100 unsigned long alignmask = crypto_shash_alignmask(tfm);
102 if ((unsigned long)data & alignmask)
103 return shash_update_unaligned(desc, data, len);
105 return shash->update(desc, data, len);
107 EXPORT_SYMBOL_GPL(crypto_shash_update);
109 static int shash_final_unaligned(struct shash_desc *desc, u8 *out)
111 struct crypto_shash *tfm = desc->tfm;
112 unsigned long alignmask = crypto_shash_alignmask(tfm);
113 struct shash_alg *shash = crypto_shash_alg(tfm);
114 unsigned int ds = crypto_shash_digestsize(tfm);
115 u8 ubuf[shash_align_buffer_size(ds, alignmask)]
116 __attribute__ ((aligned));
117 u8 *buf = PTR_ALIGN(&ubuf[0], alignmask + 1);
118 int err;
120 err = shash->final(desc, buf);
121 if (err)
122 goto out;
124 memcpy(out, buf, ds);
126 out:
127 memset(buf, 0, ds);
128 return err;
131 int crypto_shash_final(struct shash_desc *desc, u8 *out)
133 struct crypto_shash *tfm = desc->tfm;
134 struct shash_alg *shash = crypto_shash_alg(tfm);
135 unsigned long alignmask = crypto_shash_alignmask(tfm);
137 if ((unsigned long)out & alignmask)
138 return shash_final_unaligned(desc, out);
140 return shash->final(desc, out);
142 EXPORT_SYMBOL_GPL(crypto_shash_final);
144 static int shash_finup_unaligned(struct shash_desc *desc, const u8 *data,
145 unsigned int len, u8 *out)
147 return crypto_shash_update(desc, data, len) ?:
148 crypto_shash_final(desc, out);
151 int crypto_shash_finup(struct shash_desc *desc, const u8 *data,
152 unsigned int len, u8 *out)
154 struct crypto_shash *tfm = desc->tfm;
155 struct shash_alg *shash = crypto_shash_alg(tfm);
156 unsigned long alignmask = crypto_shash_alignmask(tfm);
158 if (((unsigned long)data | (unsigned long)out) & alignmask)
159 return shash_finup_unaligned(desc, data, len, out);
161 return shash->finup(desc, data, len, out);
163 EXPORT_SYMBOL_GPL(crypto_shash_finup);
165 static int shash_digest_unaligned(struct shash_desc *desc, const u8 *data,
166 unsigned int len, u8 *out)
168 return crypto_shash_init(desc) ?:
169 crypto_shash_finup(desc, data, len, out);
172 int crypto_shash_digest(struct shash_desc *desc, const u8 *data,
173 unsigned int len, u8 *out)
175 struct crypto_shash *tfm = desc->tfm;
176 struct shash_alg *shash = crypto_shash_alg(tfm);
177 unsigned long alignmask = crypto_shash_alignmask(tfm);
179 if (((unsigned long)data | (unsigned long)out) & alignmask)
180 return shash_digest_unaligned(desc, data, len, out);
182 return shash->digest(desc, data, len, out);
184 EXPORT_SYMBOL_GPL(crypto_shash_digest);
186 static int shash_default_export(struct shash_desc *desc, void *out)
188 memcpy(out, shash_desc_ctx(desc), crypto_shash_descsize(desc->tfm));
189 return 0;
192 static int shash_default_import(struct shash_desc *desc, const void *in)
194 memcpy(shash_desc_ctx(desc), in, crypto_shash_descsize(desc->tfm));
195 return 0;
198 static int shash_async_setkey(struct crypto_ahash *tfm, const u8 *key,
199 unsigned int keylen)
201 struct crypto_shash **ctx = crypto_ahash_ctx(tfm);
203 return crypto_shash_setkey(*ctx, key, keylen);
206 static int shash_async_init(struct ahash_request *req)
208 struct crypto_shash **ctx = crypto_ahash_ctx(crypto_ahash_reqtfm(req));
209 struct shash_desc *desc = ahash_request_ctx(req);
211 desc->tfm = *ctx;
212 desc->flags = req->base.flags;
214 return crypto_shash_init(desc);
217 int shash_ahash_update(struct ahash_request *req, struct shash_desc *desc)
219 struct crypto_hash_walk walk;
220 int nbytes;
222 for (nbytes = crypto_hash_walk_first(req, &walk); nbytes > 0;
223 nbytes = crypto_hash_walk_done(&walk, nbytes))
224 nbytes = crypto_shash_update(desc, walk.data, nbytes);
226 return nbytes;
228 EXPORT_SYMBOL_GPL(shash_ahash_update);
230 static int shash_async_update(struct ahash_request *req)
232 return shash_ahash_update(req, ahash_request_ctx(req));
235 static int shash_async_final(struct ahash_request *req)
237 return crypto_shash_final(ahash_request_ctx(req), req->result);
240 int shash_ahash_finup(struct ahash_request *req, struct shash_desc *desc)
242 struct crypto_hash_walk walk;
243 int nbytes;
245 nbytes = crypto_hash_walk_first(req, &walk);
246 if (!nbytes)
247 return crypto_shash_final(desc, req->result);
249 do {
250 nbytes = crypto_hash_walk_last(&walk) ?
251 crypto_shash_finup(desc, walk.data, nbytes,
252 req->result) :
253 crypto_shash_update(desc, walk.data, nbytes);
254 nbytes = crypto_hash_walk_done(&walk, nbytes);
255 } while (nbytes > 0);
257 return nbytes;
259 EXPORT_SYMBOL_GPL(shash_ahash_finup);
261 static int shash_async_finup(struct ahash_request *req)
263 struct crypto_shash **ctx = crypto_ahash_ctx(crypto_ahash_reqtfm(req));
264 struct shash_desc *desc = ahash_request_ctx(req);
266 desc->tfm = *ctx;
267 desc->flags = req->base.flags;
269 return shash_ahash_finup(req, desc);
272 int shash_ahash_digest(struct ahash_request *req, struct shash_desc *desc)
274 struct scatterlist *sg = req->src;
275 unsigned int offset = sg->offset;
276 unsigned int nbytes = req->nbytes;
277 int err;
279 if (nbytes < min(sg->length, ((unsigned int)(PAGE_SIZE)) - offset)) {
280 void *data;
282 data = crypto_kmap(sg_page(sg), 0);
283 err = crypto_shash_digest(desc, data + offset, nbytes,
284 req->result);
285 crypto_kunmap(data, 0);
286 crypto_yield(desc->flags);
287 } else
288 err = crypto_shash_init(desc) ?:
289 shash_ahash_finup(req, desc);
291 return err;
293 EXPORT_SYMBOL_GPL(shash_ahash_digest);
295 static int shash_async_digest(struct ahash_request *req)
297 struct crypto_shash **ctx = crypto_ahash_ctx(crypto_ahash_reqtfm(req));
298 struct shash_desc *desc = ahash_request_ctx(req);
300 desc->tfm = *ctx;
301 desc->flags = req->base.flags;
303 return shash_ahash_digest(req, desc);
306 static int shash_async_export(struct ahash_request *req, void *out)
308 return crypto_shash_export(ahash_request_ctx(req), out);
311 static int shash_async_import(struct ahash_request *req, const void *in)
313 return crypto_shash_import(ahash_request_ctx(req), in);
316 static void crypto_exit_shash_ops_async(struct crypto_tfm *tfm)
318 struct crypto_shash **ctx = crypto_tfm_ctx(tfm);
320 crypto_free_shash(*ctx);
323 int crypto_init_shash_ops_async(struct crypto_tfm *tfm)
325 struct crypto_alg *calg = tfm->__crt_alg;
326 struct shash_alg *alg = __crypto_shash_alg(calg);
327 struct crypto_ahash *crt = __crypto_ahash_cast(tfm);
328 struct crypto_shash **ctx = crypto_tfm_ctx(tfm);
329 struct crypto_shash *shash;
331 if (!crypto_mod_get(calg))
332 return -EAGAIN;
334 shash = crypto_create_tfm(calg, &crypto_shash_type);
335 if (IS_ERR(shash)) {
336 crypto_mod_put(calg);
337 return PTR_ERR(shash);
340 *ctx = shash;
341 tfm->exit = crypto_exit_shash_ops_async;
343 crt->init = shash_async_init;
344 crt->update = shash_async_update;
345 crt->final = shash_async_final;
346 crt->finup = shash_async_finup;
347 crt->digest = shash_async_digest;
349 if (alg->setkey)
350 crt->setkey = shash_async_setkey;
351 if (alg->export)
352 crt->export = shash_async_export;
353 if (alg->import)
354 crt->import = shash_async_import;
356 crt->reqsize = sizeof(struct shash_desc) + crypto_shash_descsize(shash);
358 return 0;
361 static int shash_compat_setkey(struct crypto_hash *tfm, const u8 *key,
362 unsigned int keylen)
364 struct shash_desc **descp = crypto_hash_ctx(tfm);
365 struct shash_desc *desc = *descp;
367 return crypto_shash_setkey(desc->tfm, key, keylen);
370 static int shash_compat_init(struct hash_desc *hdesc)
372 struct shash_desc **descp = crypto_hash_ctx(hdesc->tfm);
373 struct shash_desc *desc = *descp;
375 desc->flags = hdesc->flags;
377 return crypto_shash_init(desc);
380 static int shash_compat_update(struct hash_desc *hdesc, struct scatterlist *sg,
381 unsigned int len)
383 struct shash_desc **descp = crypto_hash_ctx(hdesc->tfm);
384 struct shash_desc *desc = *descp;
385 struct crypto_hash_walk walk;
386 int nbytes;
388 for (nbytes = crypto_hash_walk_first_compat(hdesc, &walk, sg, len);
389 nbytes > 0; nbytes = crypto_hash_walk_done(&walk, nbytes))
390 nbytes = crypto_shash_update(desc, walk.data, nbytes);
392 return nbytes;
395 static int shash_compat_final(struct hash_desc *hdesc, u8 *out)
397 struct shash_desc **descp = crypto_hash_ctx(hdesc->tfm);
399 return crypto_shash_final(*descp, out);
402 static int shash_compat_digest(struct hash_desc *hdesc, struct scatterlist *sg,
403 unsigned int nbytes, u8 *out)
405 unsigned int offset = sg->offset;
406 int err;
408 if (nbytes < min(sg->length, ((unsigned int)(PAGE_SIZE)) - offset)) {
409 struct shash_desc **descp = crypto_hash_ctx(hdesc->tfm);
410 struct shash_desc *desc = *descp;
411 void *data;
413 desc->flags = hdesc->flags;
415 data = crypto_kmap(sg_page(sg), 0);
416 err = crypto_shash_digest(desc, data + offset, nbytes, out);
417 crypto_kunmap(data, 0);
418 crypto_yield(desc->flags);
419 goto out;
422 err = shash_compat_init(hdesc);
423 if (err)
424 goto out;
426 err = shash_compat_update(hdesc, sg, nbytes);
427 if (err)
428 goto out;
430 err = shash_compat_final(hdesc, out);
432 out:
433 return err;
436 static void crypto_exit_shash_ops_compat(struct crypto_tfm *tfm)
438 struct shash_desc **descp = crypto_tfm_ctx(tfm);
439 struct shash_desc *desc = *descp;
441 crypto_free_shash(desc->tfm);
442 kzfree(desc);
445 static int crypto_init_shash_ops_compat(struct crypto_tfm *tfm)
447 struct hash_tfm *crt = &tfm->crt_hash;
448 struct crypto_alg *calg = tfm->__crt_alg;
449 struct shash_alg *alg = __crypto_shash_alg(calg);
450 struct shash_desc **descp = crypto_tfm_ctx(tfm);
451 struct crypto_shash *shash;
452 struct shash_desc *desc;
454 if (!crypto_mod_get(calg))
455 return -EAGAIN;
457 shash = crypto_create_tfm(calg, &crypto_shash_type);
458 if (IS_ERR(shash)) {
459 crypto_mod_put(calg);
460 return PTR_ERR(shash);
463 desc = kmalloc(sizeof(*desc) + crypto_shash_descsize(shash),
464 GFP_KERNEL);
465 if (!desc) {
466 crypto_free_shash(shash);
467 return -ENOMEM;
470 *descp = desc;
471 desc->tfm = shash;
472 tfm->exit = crypto_exit_shash_ops_compat;
474 crt->init = shash_compat_init;
475 crt->update = shash_compat_update;
476 crt->final = shash_compat_final;
477 crt->digest = shash_compat_digest;
478 crt->setkey = shash_compat_setkey;
480 crt->digestsize = alg->digestsize;
482 return 0;
485 static int crypto_init_shash_ops(struct crypto_tfm *tfm, u32 type, u32 mask)
487 switch (mask & CRYPTO_ALG_TYPE_MASK) {
488 case CRYPTO_ALG_TYPE_HASH_MASK:
489 return crypto_init_shash_ops_compat(tfm);
492 return -EINVAL;
495 static unsigned int crypto_shash_ctxsize(struct crypto_alg *alg, u32 type,
496 u32 mask)
498 switch (mask & CRYPTO_ALG_TYPE_MASK) {
499 case CRYPTO_ALG_TYPE_HASH_MASK:
500 return sizeof(struct shash_desc *);
503 return 0;
506 static int crypto_shash_init_tfm(struct crypto_tfm *tfm)
508 struct crypto_shash *hash = __crypto_shash_cast(tfm);
510 hash->descsize = crypto_shash_alg(hash)->descsize;
511 return 0;
514 static unsigned int crypto_shash_extsize(struct crypto_alg *alg)
516 return alg->cra_ctxsize;
519 static void crypto_shash_show(struct seq_file *m, struct crypto_alg *alg)
520 __attribute__ ((unused));
521 static void crypto_shash_show(struct seq_file *m, struct crypto_alg *alg)
523 struct shash_alg *salg = __crypto_shash_alg(alg);
525 seq_printf(m, "type : shash\n");
526 seq_printf(m, "blocksize : %u\n", alg->cra_blocksize);
527 seq_printf(m, "digestsize : %u\n", salg->digestsize);
530 static const struct crypto_type crypto_shash_type = {
531 .ctxsize = crypto_shash_ctxsize,
532 .extsize = crypto_shash_extsize,
533 .init = crypto_init_shash_ops,
534 .init_tfm = crypto_shash_init_tfm,
535 #ifdef CONFIG_PROC_FS
536 .show = crypto_shash_show,
537 #endif
538 .maskclear = ~CRYPTO_ALG_TYPE_MASK,
539 .maskset = CRYPTO_ALG_TYPE_MASK,
540 .type = CRYPTO_ALG_TYPE_SHASH,
541 .tfmsize = offsetof(struct crypto_shash, base),
544 struct crypto_shash *crypto_alloc_shash(const char *alg_name, u32 type,
545 u32 mask)
547 return crypto_alloc_tfm(alg_name, &crypto_shash_type, type, mask);
549 EXPORT_SYMBOL_GPL(crypto_alloc_shash);
551 static int shash_prepare_alg(struct shash_alg *alg)
553 struct crypto_alg *base = &alg->base;
555 if (alg->digestsize > PAGE_SIZE / 8 ||
556 alg->descsize > PAGE_SIZE / 8 ||
557 alg->statesize > PAGE_SIZE / 8)
558 return -EINVAL;
560 base->cra_type = &crypto_shash_type;
561 base->cra_flags &= ~CRYPTO_ALG_TYPE_MASK;
562 base->cra_flags |= CRYPTO_ALG_TYPE_SHASH;
564 if (!alg->finup)
565 alg->finup = shash_finup_unaligned;
566 if (!alg->digest)
567 alg->digest = shash_digest_unaligned;
568 if (!alg->export) {
569 alg->export = shash_default_export;
570 alg->import = shash_default_import;
571 alg->statesize = alg->descsize;
573 if (!alg->setkey)
574 alg->setkey = shash_no_setkey;
576 return 0;
579 int crypto_register_shash(struct shash_alg *alg)
581 struct crypto_alg *base = &alg->base;
582 int err;
584 err = shash_prepare_alg(alg);
585 if (err)
586 return err;
588 return crypto_register_alg(base);
590 EXPORT_SYMBOL_GPL(crypto_register_shash);
592 int crypto_unregister_shash(struct shash_alg *alg)
594 return crypto_unregister_alg(&alg->base);
596 EXPORT_SYMBOL_GPL(crypto_unregister_shash);
598 int shash_register_instance(struct crypto_template *tmpl,
599 struct shash_instance *inst)
601 int err;
603 err = shash_prepare_alg(&inst->alg);
604 if (err)
605 return err;
607 return crypto_register_instance(tmpl, shash_crypto_instance(inst));
609 EXPORT_SYMBOL_GPL(shash_register_instance);
611 void shash_free_instance(struct crypto_instance *inst)
613 crypto_drop_spawn(crypto_instance_ctx(inst));
614 kfree(shash_instance(inst));
616 EXPORT_SYMBOL_GPL(shash_free_instance);
618 int crypto_init_shash_spawn(struct crypto_shash_spawn *spawn,
619 struct shash_alg *alg,
620 struct crypto_instance *inst)
622 return crypto_init_spawn2(&spawn->base, &alg->base, inst,
623 &crypto_shash_type);
625 EXPORT_SYMBOL_GPL(crypto_init_shash_spawn);
627 struct shash_alg *shash_attr_alg(struct rtattr *rta, u32 type, u32 mask)
629 struct crypto_alg *alg;
631 alg = crypto_attr_alg2(rta, &crypto_shash_type, type, mask);
632 return IS_ERR(alg) ? ERR_CAST(alg) :
633 container_of(alg, struct shash_alg, base);
635 EXPORT_SYMBOL_GPL(shash_attr_alg);
637 MODULE_LICENSE("GPL");
638 MODULE_DESCRIPTION("Synchronous cryptographic hash type");