Merge tag 'io_uring-6.16-20250630' of git://git.kernel.dk/linux
[linux-2.6-block.git] / crypto / shash.c
CommitLineData
2874c5fd 1// SPDX-License-Identifier: GPL-2.0-or-later
7b5a080b
HX
2/*
3 * Synchronous Cryptographic Hash operations.
4 *
5 * Copyright (c) 2008 Herbert Xu <herbert@gondor.apana.org.au>
7b5a080b
HX
6 */
7
3b2f6df0 8#include <crypto/scatterwalk.h>
42808e5d 9#include <linux/cryptouser.h>
7b5a080b
HX
10#include <linux/err.h>
11#include <linux/kernel.h>
12#include <linux/module.h>
7b5a080b 13#include <linux/seq_file.h>
42808e5d 14#include <linux/string.h>
f4d663ce 15#include <net/netlink.h>
7b5a080b 16
42808e5d 17#include "hash.h"
3b2f6df0 18
7650f826
HX
19static inline bool crypto_shash_block_only(struct crypto_shash *tfm)
20{
21 return crypto_shash_alg(tfm)->base.cra_flags &
22 CRYPTO_AHASH_ALG_BLOCK_ONLY;
23}
24
25static inline bool crypto_shash_final_nonzero(struct crypto_shash *tfm)
26{
27 return crypto_shash_alg(tfm)->base.cra_flags &
28 CRYPTO_AHASH_ALG_FINAL_NONZERO;
29}
30
31static inline bool crypto_shash_finup_max(struct crypto_shash *tfm)
32{
33 return crypto_shash_alg(tfm)->base.cra_flags &
34 CRYPTO_AHASH_ALG_FINUP_MAX;
35}
36
c060e16d
EB
37int shash_no_setkey(struct crypto_shash *tfm, const u8 *key,
38 unsigned int keylen)
57cfe44b
HX
39{
40 return -ENOSYS;
41}
c060e16d 42EXPORT_SYMBOL_GPL(shash_no_setkey);
57cfe44b 43
ba7d7433
EB
44static void shash_set_needkey(struct crypto_shash *tfm, struct shash_alg *alg)
45{
c2881789 46 if (crypto_shash_alg_needs_key(alg))
ba7d7433
EB
47 crypto_shash_set_flags(tfm, CRYPTO_TFM_NEED_KEY);
48}
49
7b5a080b
HX
50int crypto_shash_setkey(struct crypto_shash *tfm, const u8 *key,
51 unsigned int keylen)
52{
53 struct shash_alg *shash = crypto_shash_alg(tfm);
9fa68f62 54 int err;
7b5a080b 55
345bfa3c 56 err = shash->setkey(tfm, key, keylen);
ba7d7433
EB
57 if (unlikely(err)) {
58 shash_set_needkey(tfm, shash);
9fa68f62 59 return err;
ba7d7433 60 }
7b5a080b 61
9fa68f62
EB
62 crypto_shash_clear_flags(tfm, CRYPTO_TFM_NEED_KEY);
63 return 0;
7b5a080b
HX
64}
65EXPORT_SYMBOL_GPL(crypto_shash_setkey);
66
7650f826 67static int __crypto_shash_init(struct shash_desc *desc)
7b5a080b 68{
7650f826
HX
69 struct crypto_shash *tfm = desc->tfm;
70
71 if (crypto_shash_block_only(tfm)) {
72 u8 *buf = shash_desc_ctx(desc);
73
74 buf += crypto_shash_descsize(tfm) - 1;
75 *buf = 0;
76 }
77
78 return crypto_shash_alg(tfm)->init(desc);
7b5a080b 79}
7b5a080b 80
7650f826 81int crypto_shash_init(struct shash_desc *desc)
7b5a080b 82{
7650f826
HX
83 if (crypto_shash_get_flags(desc->tfm) & CRYPTO_TFM_NEED_KEY)
84 return -ENOKEY;
85 return __crypto_shash_init(desc);
7b5a080b 86}
7650f826 87EXPORT_SYMBOL_GPL(crypto_shash_init);
7b5a080b 88
313a4074
EB
89static int shash_default_finup(struct shash_desc *desc, const u8 *data,
90 unsigned int len, u8 *out)
91{
92 struct shash_alg *shash = crypto_shash_alg(desc->tfm);
93
94 return shash->update(desc, data, len) ?:
95 shash->final(desc, out);
96}
97
7650f826
HX
98static int crypto_shash_op_and_zero(
99 int (*op)(struct shash_desc *desc, const u8 *data,
100 unsigned int len, u8 *out),
101 struct shash_desc *desc, const u8 *data, unsigned int len, u8 *out)
7b5a080b 102{
7650f826
HX
103 int err;
104
105 err = op(desc, data, len, out);
106 memset(shash_desc_ctx(desc), 0, crypto_shash_descsize(desc->tfm));
107 return err;
108}
109
110int crypto_shash_finup(struct shash_desc *restrict desc, const u8 *data,
111 unsigned int len, u8 *restrict out)
112{
113 struct crypto_shash *tfm = desc->tfm;
114 u8 *blenp = shash_desc_ctx(desc);
115 bool finup_max, nonzero;
116 unsigned int bs;
117 int err;
118 u8 *buf;
119
120 if (!crypto_shash_block_only(tfm)) {
121 if (out)
122 goto finup;
123 return crypto_shash_alg(tfm)->update(desc, data, len);
124 }
125
126 finup_max = out && crypto_shash_finup_max(tfm);
127
128 /* Retain extra block for final nonzero algorithms. */
129 nonzero = crypto_shash_final_nonzero(tfm);
130
131 /*
132 * The partial block buffer follows the algorithm desc context.
133 * The byte following that contains the length.
134 */
135 blenp += crypto_shash_descsize(tfm) - 1;
136 bs = crypto_shash_blocksize(tfm);
137 buf = blenp - bs;
138
139 if (likely(!*blenp && finup_max))
140 goto finup;
141
142 while ((*blenp + len) >= bs + nonzero) {
143 unsigned int nbytes = len - nonzero;
144 const u8 *src = data;
145
146 if (*blenp) {
147 memcpy(buf + *blenp, data, bs - *blenp);
148 nbytes = bs;
149 src = buf;
150 }
151
152 err = crypto_shash_alg(tfm)->update(desc, src, nbytes);
153 if (err < 0)
154 return err;
155
156 data += nbytes - err - *blenp;
157 len -= nbytes - err - *blenp;
158 *blenp = 0;
159 }
160
161 if (*blenp || !out) {
162 memcpy(buf + *blenp, data, len);
163 *blenp += len;
164 if (!out)
165 return 0;
166 data = buf;
167 len = *blenp;
168 }
169
170finup:
171 return crypto_shash_op_and_zero(crypto_shash_alg(tfm)->finup, desc,
172 data, len, out);
7b5a080b
HX
173}
174EXPORT_SYMBOL_GPL(crypto_shash_finup);
175
313a4074
EB
176static int shash_default_digest(struct shash_desc *desc, const u8 *data,
177 unsigned int len, u8 *out)
178{
7650f826
HX
179 return __crypto_shash_init(desc) ?:
180 crypto_shash_finup(desc, data, len, out);
313a4074
EB
181}
182
7b5a080b
HX
183int crypto_shash_digest(struct shash_desc *desc, const u8 *data,
184 unsigned int len, u8 *out)
185{
186 struct crypto_shash *tfm = desc->tfm;
7b5a080b 187
42808e5d 188 if (crypto_shash_get_flags(tfm) & CRYPTO_TFM_NEED_KEY)
29ce50e0 189 return -ENOKEY;
42808e5d 190
7650f826
HX
191 return crypto_shash_op_and_zero(crypto_shash_alg(tfm)->digest, desc,
192 data, len, out);
7b5a080b
HX
193}
194EXPORT_SYMBOL_GPL(crypto_shash_digest);
195
822a98b8
EB
196int crypto_shash_tfm_digest(struct crypto_shash *tfm, const u8 *data,
197 unsigned int len, u8 *out)
198{
199 SHASH_DESC_ON_STACK(desc, tfm);
822a98b8
EB
200
201 desc->tfm = tfm;
7650f826
HX
202 return crypto_shash_digest(desc, data, len, out);
203}
204EXPORT_SYMBOL_GPL(crypto_shash_tfm_digest);
822a98b8 205
c6a12f39
HX
206static int __crypto_shash_export(struct shash_desc *desc, void *out,
207 int (*export)(struct shash_desc *desc,
208 void *out))
7650f826 209{
7650f826
HX
210 struct crypto_shash *tfm = desc->tfm;
211 u8 *buf = shash_desc_ctx(desc);
212 unsigned int plen, ss;
213
214 plen = crypto_shash_blocksize(tfm) + 1;
215 ss = crypto_shash_statesize(tfm);
216 if (crypto_shash_block_only(tfm))
217 ss -= plen;
7650f826
HX
218 if (!export) {
219 memcpy(out, buf, ss);
220 return 0;
221 }
822a98b8 222
7650f826 223 return export(desc, out);
822a98b8 224}
c6a12f39
HX
225
226int crypto_shash_export_core(struct shash_desc *desc, void *out)
227{
228 return __crypto_shash_export(desc, out,
229 crypto_shash_alg(desc->tfm)->export_core);
230}
7650f826 231EXPORT_SYMBOL_GPL(crypto_shash_export_core);
822a98b8 232
08debaa5 233int crypto_shash_export(struct shash_desc *desc, void *out)
dec8b786 234{
08debaa5 235 struct crypto_shash *tfm = desc->tfm;
08debaa5 236
7650f826
HX
237 if (crypto_shash_block_only(tfm)) {
238 unsigned int plen = crypto_shash_blocksize(tfm) + 1;
239 unsigned int descsize = crypto_shash_descsize(tfm);
240 unsigned int ss = crypto_shash_statesize(tfm);
241 u8 *buf = shash_desc_ctx(desc);
08debaa5 242
7650f826
HX
243 memcpy(out + ss - plen, buf + descsize - plen, plen);
244 }
c6a12f39 245 return __crypto_shash_export(desc, out, crypto_shash_alg(tfm)->export);
99d27e1c 246}
08debaa5 247EXPORT_SYMBOL_GPL(crypto_shash_export);
dec8b786 248
c6a12f39
HX
249static int __crypto_shash_import(struct shash_desc *desc, const void *in,
250 int (*import)(struct shash_desc *desc,
251 const void *in))
99d27e1c 252{
08debaa5 253 struct crypto_shash *tfm = desc->tfm;
7650f826
HX
254 unsigned int descsize, plen, ss;
255 u8 *buf = shash_desc_ctx(desc);
08debaa5
EB
256
257 if (crypto_shash_get_flags(tfm) & CRYPTO_TFM_NEED_KEY)
258 return -ENOKEY;
259
7650f826 260 ss = crypto_shash_statesize(tfm);
0a84874c
HX
261 if (crypto_shash_block_only(tfm)) {
262 plen = crypto_shash_blocksize(tfm) + 1;
7650f826 263 ss -= plen;
0a84874c
HX
264 descsize = crypto_shash_descsize(tfm);
265 buf[descsize - 1] = 0;
266 }
7650f826
HX
267 if (!import) {
268 memcpy(buf, in, ss);
269 return 0;
270 }
08debaa5 271
7650f826
HX
272 return import(desc, in);
273}
c6a12f39
HX
274
275int crypto_shash_import_core(struct shash_desc *desc, const void *in)
276{
277 return __crypto_shash_import(desc, in,
278 crypto_shash_alg(desc->tfm)->import_core);
279}
7650f826
HX
280EXPORT_SYMBOL_GPL(crypto_shash_import_core);
281
282int crypto_shash_import(struct shash_desc *desc, const void *in)
283{
284 struct crypto_shash *tfm = desc->tfm;
285 int err;
286
c6a12f39 287 err = __crypto_shash_import(desc, in, crypto_shash_alg(tfm)->import);
7650f826
HX
288 if (crypto_shash_block_only(tfm)) {
289 unsigned int plen = crypto_shash_blocksize(tfm) + 1;
290 unsigned int descsize = crypto_shash_descsize(tfm);
291 unsigned int ss = crypto_shash_statesize(tfm);
292 u8 *buf = shash_desc_ctx(desc);
293
294 memcpy(buf + descsize - plen, in + ss - plen, plen);
295 if (buf[descsize - 1] >= plen)
296 err = -EOVERFLOW;
297 }
298 return err;
dec8b786 299}
08debaa5 300EXPORT_SYMBOL_GPL(crypto_shash_import);
dec8b786 301
fbce6be5
HX
302static void crypto_shash_exit_tfm(struct crypto_tfm *tfm)
303{
304 struct crypto_shash *hash = __crypto_shash_cast(tfm);
305 struct shash_alg *alg = crypto_shash_alg(hash);
306
307 alg->exit_tfm(hash);
308}
309
2ca33da1 310static int crypto_shash_init_tfm(struct crypto_tfm *tfm)
7b5a080b 311{
113adefc 312 struct crypto_shash *hash = __crypto_shash_cast(tfm);
9fa68f62 313 struct shash_alg *alg = crypto_shash_alg(hash);
9fa68f62 314
ba7d7433 315 shash_set_needkey(hash, alg);
113adefc 316
fbce6be5
HX
317 if (alg->exit_tfm)
318 tfm->exit = crypto_shash_exit_tfm;
319
320 if (!alg->init_tfm)
321 return 0;
322
90916934 323 return alg->init_tfm(hash);
7b5a080b
HX
324}
325
48fb3e57
EB
326static void crypto_shash_free_instance(struct crypto_instance *inst)
327{
328 struct shash_instance *shash = shash_instance(inst);
329
48fb3e57
EB
330 shash->free(shash);
331}
332
c0f9e01d
HX
333static int __maybe_unused crypto_shash_report(
334 struct sk_buff *skb, struct crypto_alg *alg)
f4d663ce
SK
335{
336 struct crypto_report_hash rhash;
337 struct shash_alg *salg = __crypto_shash_alg(alg);
338
37db69e0
EB
339 memset(&rhash, 0, sizeof(rhash));
340
341 strscpy(rhash.type, "shash", sizeof(rhash.type));
9a5467bf 342
f4d663ce
SK
343 rhash.blocksize = alg->cra_blocksize;
344 rhash.digestsize = salg->digestsize;
345
37db69e0 346 return nla_put(skb, CRYPTOCFGA_REPORT_HASH, sizeof(rhash), &rhash);
f4d663ce
SK
347}
348
7b5a080b 349static void crypto_shash_show(struct seq_file *m, struct crypto_alg *alg)
d8c34b94 350 __maybe_unused;
7b5a080b
HX
351static void crypto_shash_show(struct seq_file *m, struct crypto_alg *alg)
352{
353 struct shash_alg *salg = __crypto_shash_alg(alg);
354
355 seq_printf(m, "type : shash\n");
356 seq_printf(m, "blocksize : %u\n", alg->cra_blocksize);
357 seq_printf(m, "digestsize : %u\n", salg->digestsize);
7b5a080b
HX
358}
359
ecf889b7 360const struct crypto_type crypto_shash_type = {
ac611680 361 .extsize = crypto_alg_extsize,
7b5a080b 362 .init_tfm = crypto_shash_init_tfm,
48fb3e57 363 .free = crypto_shash_free_instance,
7b5a080b
HX
364#ifdef CONFIG_PROC_FS
365 .show = crypto_shash_show,
366#endif
b8969a1b 367#if IS_ENABLED(CONFIG_CRYPTO_USER)
f4d663ce 368 .report = crypto_shash_report,
42808e5d 369#endif
7b5a080b
HX
370 .maskclear = ~CRYPTO_ALG_TYPE_MASK,
371 .maskset = CRYPTO_ALG_TYPE_MASK,
372 .type = CRYPTO_ALG_TYPE_SHASH,
373 .tfmsize = offsetof(struct crypto_shash, base),
f1440a90 374 .algsize = offsetof(struct shash_alg, base),
7b5a080b
HX
375};
376
fdfad1ff
EB
377int crypto_grab_shash(struct crypto_shash_spawn *spawn,
378 struct crypto_instance *inst,
379 const char *name, u32 type, u32 mask)
380{
381 spawn->base.frontend = &crypto_shash_type;
382 return crypto_grab_spawn(&spawn->base, inst, name, type, mask);
383}
384EXPORT_SYMBOL_GPL(crypto_grab_shash);
385
7b5a080b
HX
386struct crypto_shash *crypto_alloc_shash(const char *alg_name, u32 type,
387 u32 mask)
388{
3f683d61 389 return crypto_alloc_tfm(alg_name, &crypto_shash_type, type, mask);
7b5a080b
HX
390}
391EXPORT_SYMBOL_GPL(crypto_alloc_shash);
392
85cc4243
HR
393int crypto_has_shash(const char *alg_name, u32 type, u32 mask)
394{
395 return crypto_type_has_alg(alg_name, &crypto_shash_type, type, mask);
396}
397EXPORT_SYMBOL_GPL(crypto_has_shash);
398
ed3630b8
HX
399struct crypto_shash *crypto_clone_shash(struct crypto_shash *hash)
400{
401 struct crypto_tfm *tfm = crypto_shash_tfm(hash);
402 struct shash_alg *alg = crypto_shash_alg(hash);
403 struct crypto_shash *nhash;
404 int err;
405
406 if (!crypto_shash_alg_has_setkey(alg)) {
407 tfm = crypto_tfm_get(tfm);
408 if (IS_ERR(tfm))
409 return ERR_CAST(tfm);
410
411 return hash;
412 }
413
b7be31b0 414 if (!alg->clone_tfm && (alg->init_tfm || alg->base.cra_init))
ed3630b8
HX
415 return ERR_PTR(-ENOSYS);
416
417 nhash = crypto_clone_tfm(&crypto_shash_type, tfm);
418 if (IS_ERR(nhash))
419 return nhash;
420
b7be31b0
HX
421 if (alg->clone_tfm) {
422 err = alg->clone_tfm(nhash, hash);
423 if (err) {
424 crypto_free_shash(nhash);
425 return ERR_PTR(err);
426 }
ed3630b8
HX
427 }
428
2cfe4163
HX
429 if (alg->exit_tfm)
430 crypto_shash_tfm(nhash)->exit = crypto_shash_exit_tfm;
431
ed3630b8
HX
432 return nhash;
433}
434EXPORT_SYMBOL_GPL(crypto_clone_shash);
435
42808e5d 436int hash_prepare_alg(struct hash_alg_common *alg)
7b5a080b
HX
437{
438 struct crypto_alg *base = &alg->base;
439
9697b328 440 if (alg->digestsize > HASH_MAX_DIGESTSIZE)
7b5a080b
HX
441 return -EINVAL;
442
c626910f
EB
443 /* alignmask is not useful for hashes, so it is not supported. */
444 if (base->cra_alignmask)
445 return -EINVAL;
446
42808e5d
HX
447 base->cra_flags &= ~CRYPTO_ALG_TYPE_MASK;
448
42808e5d
HX
449 return 0;
450}
451
c6a12f39
HX
452static int shash_default_export_core(struct shash_desc *desc, void *out)
453{
454 return -ENOSYS;
455}
456
457static int shash_default_import_core(struct shash_desc *desc, const void *in)
458{
459 return -ENOSYS;
460}
461
42808e5d
HX
462static int shash_prepare_alg(struct shash_alg *alg)
463{
464 struct crypto_alg *base = &alg->halg.base;
465 int err;
466
41a2e94f
EB
467 if ((alg->export && !alg->import) || (alg->import && !alg->export))
468 return -EINVAL;
469
42808e5d
HX
470 err = hash_prepare_alg(&alg->halg);
471 if (err)
472 return err;
473
7b5a080b 474 base->cra_type = &crypto_shash_type;
7b5a080b 475 base->cra_flags |= CRYPTO_ALG_TYPE_SHASH;
f4e365d5 476 base->cra_flags |= CRYPTO_ALG_REQ_VIRT;
99d27e1c 477
08debaa5
EB
478 /*
479 * Handle missing optional functions. For each one we can either
480 * install a default here, or we can leave the pointer as NULL and check
481 * the pointer for NULL in crypto_shash_*(), avoiding an indirect call
482 * when the default behavior is desired. For ->finup and ->digest we
483 * install defaults, since for optimal performance algorithms should
484 * implement these anyway. On the other hand, for ->import and
485 * ->export the common case and best performance comes from the simple
486 * memcpy of the shash_desc_ctx, so when those pointers are NULL we
487 * leave them NULL and provide the memcpy with no indirect call.
488 */
8267adab 489 if (!alg->finup)
313a4074 490 alg->finup = shash_default_finup;
8267adab 491 if (!alg->digest)
313a4074 492 alg->digest = shash_default_digest;
7650f826 493 if (!alg->export && !alg->halg.statesize)
42808e5d 494 alg->halg.statesize = alg->descsize;
57cfe44b
HX
495 if (!alg->setkey)
496 alg->setkey = shash_no_setkey;
99d27e1c 497
7650f826
HX
498 if (base->cra_flags & CRYPTO_AHASH_ALG_BLOCK_ONLY) {
499 BUILD_BUG_ON(MAX_ALGAPI_BLOCKSIZE >= 256);
500 alg->descsize += base->cra_blocksize + 1;
501 alg->statesize += base->cra_blocksize + 1;
c6a12f39
HX
502 alg->export_core = alg->export;
503 alg->import_core = alg->import;
504 } else if (!alg->export_core || !alg->import_core) {
505 alg->export_core = shash_default_export_core;
506 alg->import_core = shash_default_import_core;
507 base->cra_flags |= CRYPTO_AHASH_ALG_NO_EXPORT_CORE;
7650f826
HX
508 }
509
510 if (alg->descsize > HASH_MAX_DESCSIZE)
511 return -EINVAL;
2b1a29ce
HX
512 if (alg->statesize > HASH_MAX_STATESIZE)
513 return -EINVAL;
7650f826 514
32a9fd8f
HX
515 base->cra_reqsize = sizeof(struct shash_desc) + alg->descsize;
516
619a6ebd
HX
517 return 0;
518}
519
520int crypto_register_shash(struct shash_alg *alg)
521{
522 struct crypto_alg *base = &alg->base;
523 int err;
524
525 err = shash_prepare_alg(alg);
526 if (err)
527 return err;
7b5a080b
HX
528
529 return crypto_register_alg(base);
530}
531EXPORT_SYMBOL_GPL(crypto_register_shash);
532
c6d633a9 533void crypto_unregister_shash(struct shash_alg *alg)
7b5a080b 534{
c6d633a9 535 crypto_unregister_alg(&alg->base);
7b5a080b
HX
536}
537EXPORT_SYMBOL_GPL(crypto_unregister_shash);
538
50fc3e8d
JK
539int crypto_register_shashes(struct shash_alg *algs, int count)
540{
541 int i, ret;
542
543 for (i = 0; i < count; i++) {
544 ret = crypto_register_shash(&algs[i]);
545 if (ret)
546 goto err;
547 }
548
549 return 0;
550
551err:
552 for (--i; i >= 0; --i)
553 crypto_unregister_shash(&algs[i]);
554
555 return ret;
556}
557EXPORT_SYMBOL_GPL(crypto_register_shashes);
558
c6d633a9 559void crypto_unregister_shashes(struct shash_alg *algs, int count)
50fc3e8d 560{
c6d633a9 561 int i;
50fc3e8d 562
c6d633a9
EB
563 for (i = count - 1; i >= 0; --i)
564 crypto_unregister_shash(&algs[i]);
50fc3e8d
JK
565}
566EXPORT_SYMBOL_GPL(crypto_unregister_shashes);
567
619a6ebd
HX
568int shash_register_instance(struct crypto_template *tmpl,
569 struct shash_instance *inst)
570{
571 int err;
572
d4fdc2df
EB
573 if (WARN_ON(!inst->free))
574 return -EINVAL;
575
619a6ebd
HX
576 err = shash_prepare_alg(&inst->alg);
577 if (err)
578 return err;
579
580 return crypto_register_instance(tmpl, shash_crypto_instance(inst));
581}
582EXPORT_SYMBOL_GPL(shash_register_instance);
583
a39c66cc 584void shash_free_singlespawn_instance(struct shash_instance *inst)
2e4fddd8 585{
a39c66cc
EB
586 crypto_drop_spawn(shash_instance_ctx(inst));
587 kfree(inst);
2e4fddd8 588}
a39c66cc 589EXPORT_SYMBOL_GPL(shash_free_singlespawn_instance);
2e4fddd8 590
7b5a080b
HX
591MODULE_LICENSE("GPL");
592MODULE_DESCRIPTION("Synchronous cryptographic hash type");