Commit | Line | Data |
---|---|---|
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 | |
c060e16d EB |
19 | int shash_no_setkey(struct crypto_shash *tfm, const u8 *key, |
20 | unsigned int keylen) | |
57cfe44b HX |
21 | { |
22 | return -ENOSYS; | |
23 | } | |
c060e16d | 24 | EXPORT_SYMBOL_GPL(shash_no_setkey); |
57cfe44b | 25 | |
ba7d7433 EB |
26 | static void shash_set_needkey(struct crypto_shash *tfm, struct shash_alg *alg) |
27 | { | |
c2881789 | 28 | if (crypto_shash_alg_needs_key(alg)) |
ba7d7433 EB |
29 | crypto_shash_set_flags(tfm, CRYPTO_TFM_NEED_KEY); |
30 | } | |
31 | ||
7b5a080b HX |
32 | int crypto_shash_setkey(struct crypto_shash *tfm, const u8 *key, |
33 | unsigned int keylen) | |
34 | { | |
35 | struct shash_alg *shash = crypto_shash_alg(tfm); | |
9fa68f62 | 36 | int err; |
7b5a080b | 37 | |
345bfa3c | 38 | err = shash->setkey(tfm, key, keylen); |
ba7d7433 EB |
39 | if (unlikely(err)) { |
40 | shash_set_needkey(tfm, shash); | |
9fa68f62 | 41 | return err; |
ba7d7433 | 42 | } |
7b5a080b | 43 | |
9fa68f62 EB |
44 | crypto_shash_clear_flags(tfm, CRYPTO_TFM_NEED_KEY); |
45 | return 0; | |
7b5a080b HX |
46 | } |
47 | EXPORT_SYMBOL_GPL(crypto_shash_setkey); | |
48 | ||
7b5a080b HX |
49 | int crypto_shash_update(struct shash_desc *desc, const u8 *data, |
50 | unsigned int len) | |
51 | { | |
29ce50e0 | 52 | return crypto_shash_alg(desc->tfm)->update(desc, data, len); |
7b5a080b HX |
53 | } |
54 | EXPORT_SYMBOL_GPL(crypto_shash_update); | |
55 | ||
7b5a080b HX |
56 | int crypto_shash_final(struct shash_desc *desc, u8 *out) |
57 | { | |
29ce50e0 | 58 | return crypto_shash_alg(desc->tfm)->final(desc, out); |
7b5a080b HX |
59 | } |
60 | EXPORT_SYMBOL_GPL(crypto_shash_final); | |
61 | ||
313a4074 EB |
62 | static int shash_default_finup(struct shash_desc *desc, const u8 *data, |
63 | unsigned int len, u8 *out) | |
64 | { | |
65 | struct shash_alg *shash = crypto_shash_alg(desc->tfm); | |
66 | ||
67 | return shash->update(desc, data, len) ?: | |
68 | shash->final(desc, out); | |
69 | } | |
70 | ||
7b5a080b HX |
71 | int crypto_shash_finup(struct shash_desc *desc, const u8 *data, |
72 | unsigned int len, u8 *out) | |
73 | { | |
29ce50e0 | 74 | return crypto_shash_alg(desc->tfm)->finup(desc, data, len, out); |
7b5a080b HX |
75 | } |
76 | EXPORT_SYMBOL_GPL(crypto_shash_finup); | |
77 | ||
313a4074 EB |
78 | static int shash_default_digest(struct shash_desc *desc, const u8 *data, |
79 | unsigned int len, u8 *out) | |
80 | { | |
81 | struct shash_alg *shash = crypto_shash_alg(desc->tfm); | |
82 | ||
83 | return shash->init(desc) ?: | |
84 | shash->finup(desc, data, len, out); | |
85 | } | |
86 | ||
7b5a080b HX |
87 | int crypto_shash_digest(struct shash_desc *desc, const u8 *data, |
88 | unsigned int len, u8 *out) | |
89 | { | |
90 | struct crypto_shash *tfm = desc->tfm; | |
7b5a080b | 91 | |
42808e5d | 92 | if (crypto_shash_get_flags(tfm) & CRYPTO_TFM_NEED_KEY) |
29ce50e0 | 93 | return -ENOKEY; |
42808e5d | 94 | |
29ce50e0 | 95 | return crypto_shash_alg(tfm)->digest(desc, data, len, out); |
7b5a080b HX |
96 | } |
97 | EXPORT_SYMBOL_GPL(crypto_shash_digest); | |
98 | ||
822a98b8 EB |
99 | int crypto_shash_tfm_digest(struct crypto_shash *tfm, const u8 *data, |
100 | unsigned int len, u8 *out) | |
101 | { | |
102 | SHASH_DESC_ON_STACK(desc, tfm); | |
103 | int err; | |
104 | ||
105 | desc->tfm = tfm; | |
106 | ||
107 | err = crypto_shash_digest(desc, data, len, out); | |
108 | ||
109 | shash_desc_zero(desc); | |
110 | ||
111 | return err; | |
112 | } | |
113 | EXPORT_SYMBOL_GPL(crypto_shash_tfm_digest); | |
114 | ||
08debaa5 | 115 | int crypto_shash_export(struct shash_desc *desc, void *out) |
dec8b786 | 116 | { |
08debaa5 EB |
117 | struct crypto_shash *tfm = desc->tfm; |
118 | struct shash_alg *shash = crypto_shash_alg(tfm); | |
119 | ||
120 | if (shash->export) | |
121 | return shash->export(desc, out); | |
122 | ||
123 | memcpy(out, shash_desc_ctx(desc), crypto_shash_descsize(tfm)); | |
f592682f | 124 | return 0; |
99d27e1c | 125 | } |
08debaa5 | 126 | EXPORT_SYMBOL_GPL(crypto_shash_export); |
dec8b786 | 127 | |
08debaa5 | 128 | int crypto_shash_import(struct shash_desc *desc, const void *in) |
99d27e1c | 129 | { |
08debaa5 EB |
130 | struct crypto_shash *tfm = desc->tfm; |
131 | struct shash_alg *shash = crypto_shash_alg(tfm); | |
132 | ||
133 | if (crypto_shash_get_flags(tfm) & CRYPTO_TFM_NEED_KEY) | |
134 | return -ENOKEY; | |
135 | ||
136 | if (shash->import) | |
137 | return shash->import(desc, in); | |
138 | ||
139 | memcpy(shash_desc_ctx(desc), in, crypto_shash_descsize(tfm)); | |
f592682f | 140 | return 0; |
dec8b786 | 141 | } |
08debaa5 | 142 | EXPORT_SYMBOL_GPL(crypto_shash_import); |
dec8b786 | 143 | |
fbce6be5 HX |
144 | static void crypto_shash_exit_tfm(struct crypto_tfm *tfm) |
145 | { | |
146 | struct crypto_shash *hash = __crypto_shash_cast(tfm); | |
147 | struct shash_alg *alg = crypto_shash_alg(hash); | |
148 | ||
149 | alg->exit_tfm(hash); | |
150 | } | |
151 | ||
2ca33da1 | 152 | static int crypto_shash_init_tfm(struct crypto_tfm *tfm) |
7b5a080b | 153 | { |
113adefc | 154 | struct crypto_shash *hash = __crypto_shash_cast(tfm); |
9fa68f62 | 155 | struct shash_alg *alg = crypto_shash_alg(hash); |
fbce6be5 | 156 | int err; |
9fa68f62 EB |
157 | |
158 | hash->descsize = alg->descsize; | |
159 | ||
ba7d7433 | 160 | shash_set_needkey(hash, alg); |
113adefc | 161 | |
fbce6be5 HX |
162 | if (alg->exit_tfm) |
163 | tfm->exit = crypto_shash_exit_tfm; | |
164 | ||
165 | if (!alg->init_tfm) | |
166 | return 0; | |
167 | ||
168 | err = alg->init_tfm(hash); | |
169 | if (err) | |
170 | return err; | |
171 | ||
172 | /* ->init_tfm() may have increased the descsize. */ | |
173 | if (WARN_ON_ONCE(hash->descsize > HASH_MAX_DESCSIZE)) { | |
174 | if (alg->exit_tfm) | |
175 | alg->exit_tfm(hash); | |
176 | return -EINVAL; | |
177 | } | |
178 | ||
7b5a080b HX |
179 | return 0; |
180 | } | |
181 | ||
48fb3e57 EB |
182 | static void crypto_shash_free_instance(struct crypto_instance *inst) |
183 | { | |
184 | struct shash_instance *shash = shash_instance(inst); | |
185 | ||
48fb3e57 EB |
186 | shash->free(shash); |
187 | } | |
188 | ||
c0f9e01d HX |
189 | static int __maybe_unused crypto_shash_report( |
190 | struct sk_buff *skb, struct crypto_alg *alg) | |
f4d663ce SK |
191 | { |
192 | struct crypto_report_hash rhash; | |
193 | struct shash_alg *salg = __crypto_shash_alg(alg); | |
194 | ||
37db69e0 EB |
195 | memset(&rhash, 0, sizeof(rhash)); |
196 | ||
197 | strscpy(rhash.type, "shash", sizeof(rhash.type)); | |
9a5467bf | 198 | |
f4d663ce SK |
199 | rhash.blocksize = alg->cra_blocksize; |
200 | rhash.digestsize = salg->digestsize; | |
201 | ||
37db69e0 | 202 | return nla_put(skb, CRYPTOCFGA_REPORT_HASH, sizeof(rhash), &rhash); |
f4d663ce SK |
203 | } |
204 | ||
7b5a080b | 205 | static void crypto_shash_show(struct seq_file *m, struct crypto_alg *alg) |
d8c34b94 | 206 | __maybe_unused; |
7b5a080b HX |
207 | static void crypto_shash_show(struct seq_file *m, struct crypto_alg *alg) |
208 | { | |
209 | struct shash_alg *salg = __crypto_shash_alg(alg); | |
210 | ||
211 | seq_printf(m, "type : shash\n"); | |
212 | seq_printf(m, "blocksize : %u\n", alg->cra_blocksize); | |
213 | seq_printf(m, "digestsize : %u\n", salg->digestsize); | |
7b5a080b HX |
214 | } |
215 | ||
ecf889b7 | 216 | const struct crypto_type crypto_shash_type = { |
ac611680 | 217 | .extsize = crypto_alg_extsize, |
7b5a080b | 218 | .init_tfm = crypto_shash_init_tfm, |
48fb3e57 | 219 | .free = crypto_shash_free_instance, |
7b5a080b HX |
220 | #ifdef CONFIG_PROC_FS |
221 | .show = crypto_shash_show, | |
222 | #endif | |
b8969a1b | 223 | #if IS_ENABLED(CONFIG_CRYPTO_USER) |
f4d663ce | 224 | .report = crypto_shash_report, |
42808e5d | 225 | #endif |
7b5a080b HX |
226 | .maskclear = ~CRYPTO_ALG_TYPE_MASK, |
227 | .maskset = CRYPTO_ALG_TYPE_MASK, | |
228 | .type = CRYPTO_ALG_TYPE_SHASH, | |
229 | .tfmsize = offsetof(struct crypto_shash, base), | |
230 | }; | |
231 | ||
fdfad1ff EB |
232 | int crypto_grab_shash(struct crypto_shash_spawn *spawn, |
233 | struct crypto_instance *inst, | |
234 | const char *name, u32 type, u32 mask) | |
235 | { | |
236 | spawn->base.frontend = &crypto_shash_type; | |
237 | return crypto_grab_spawn(&spawn->base, inst, name, type, mask); | |
238 | } | |
239 | EXPORT_SYMBOL_GPL(crypto_grab_shash); | |
240 | ||
7b5a080b HX |
241 | struct crypto_shash *crypto_alloc_shash(const char *alg_name, u32 type, |
242 | u32 mask) | |
243 | { | |
3f683d61 | 244 | return crypto_alloc_tfm(alg_name, &crypto_shash_type, type, mask); |
7b5a080b HX |
245 | } |
246 | EXPORT_SYMBOL_GPL(crypto_alloc_shash); | |
247 | ||
85cc4243 HR |
248 | int crypto_has_shash(const char *alg_name, u32 type, u32 mask) |
249 | { | |
250 | return crypto_type_has_alg(alg_name, &crypto_shash_type, type, mask); | |
251 | } | |
252 | EXPORT_SYMBOL_GPL(crypto_has_shash); | |
253 | ||
ed3630b8 HX |
254 | struct crypto_shash *crypto_clone_shash(struct crypto_shash *hash) |
255 | { | |
256 | struct crypto_tfm *tfm = crypto_shash_tfm(hash); | |
257 | struct shash_alg *alg = crypto_shash_alg(hash); | |
258 | struct crypto_shash *nhash; | |
259 | int err; | |
260 | ||
261 | if (!crypto_shash_alg_has_setkey(alg)) { | |
262 | tfm = crypto_tfm_get(tfm); | |
263 | if (IS_ERR(tfm)) | |
264 | return ERR_CAST(tfm); | |
265 | ||
266 | return hash; | |
267 | } | |
268 | ||
b7be31b0 | 269 | if (!alg->clone_tfm && (alg->init_tfm || alg->base.cra_init)) |
ed3630b8 HX |
270 | return ERR_PTR(-ENOSYS); |
271 | ||
272 | nhash = crypto_clone_tfm(&crypto_shash_type, tfm); | |
273 | if (IS_ERR(nhash)) | |
274 | return nhash; | |
275 | ||
276 | nhash->descsize = hash->descsize; | |
277 | ||
b7be31b0 HX |
278 | if (alg->clone_tfm) { |
279 | err = alg->clone_tfm(nhash, hash); | |
280 | if (err) { | |
281 | crypto_free_shash(nhash); | |
282 | return ERR_PTR(err); | |
283 | } | |
ed3630b8 HX |
284 | } |
285 | ||
286 | return nhash; | |
287 | } | |
288 | EXPORT_SYMBOL_GPL(crypto_clone_shash); | |
289 | ||
42808e5d | 290 | int hash_prepare_alg(struct hash_alg_common *alg) |
7b5a080b HX |
291 | { |
292 | struct crypto_alg *base = &alg->base; | |
293 | ||
9697b328 | 294 | if (alg->digestsize > HASH_MAX_DIGESTSIZE) |
7b5a080b HX |
295 | return -EINVAL; |
296 | ||
c626910f EB |
297 | /* alignmask is not useful for hashes, so it is not supported. */ |
298 | if (base->cra_alignmask) | |
299 | return -EINVAL; | |
300 | ||
42808e5d HX |
301 | base->cra_flags &= ~CRYPTO_ALG_TYPE_MASK; |
302 | ||
42808e5d HX |
303 | return 0; |
304 | } | |
305 | ||
306 | static int shash_prepare_alg(struct shash_alg *alg) | |
307 | { | |
308 | struct crypto_alg *base = &alg->halg.base; | |
309 | int err; | |
310 | ||
311 | if (alg->descsize > HASH_MAX_DESCSIZE) | |
312 | return -EINVAL; | |
313 | ||
41a2e94f EB |
314 | if ((alg->export && !alg->import) || (alg->import && !alg->export)) |
315 | return -EINVAL; | |
316 | ||
42808e5d HX |
317 | err = hash_prepare_alg(&alg->halg); |
318 | if (err) | |
319 | return err; | |
320 | ||
7b5a080b | 321 | base->cra_type = &crypto_shash_type; |
7b5a080b | 322 | base->cra_flags |= CRYPTO_ALG_TYPE_SHASH; |
99d27e1c | 323 | |
08debaa5 EB |
324 | /* |
325 | * Handle missing optional functions. For each one we can either | |
326 | * install a default here, or we can leave the pointer as NULL and check | |
327 | * the pointer for NULL in crypto_shash_*(), avoiding an indirect call | |
328 | * when the default behavior is desired. For ->finup and ->digest we | |
329 | * install defaults, since for optimal performance algorithms should | |
330 | * implement these anyway. On the other hand, for ->import and | |
331 | * ->export the common case and best performance comes from the simple | |
332 | * memcpy of the shash_desc_ctx, so when those pointers are NULL we | |
333 | * leave them NULL and provide the memcpy with no indirect call. | |
334 | */ | |
8267adab | 335 | if (!alg->finup) |
313a4074 | 336 | alg->finup = shash_default_finup; |
8267adab | 337 | if (!alg->digest) |
313a4074 | 338 | alg->digest = shash_default_digest; |
08debaa5 | 339 | if (!alg->export) |
42808e5d | 340 | alg->halg.statesize = alg->descsize; |
57cfe44b HX |
341 | if (!alg->setkey) |
342 | alg->setkey = shash_no_setkey; | |
99d27e1c | 343 | |
619a6ebd HX |
344 | return 0; |
345 | } | |
346 | ||
347 | int crypto_register_shash(struct shash_alg *alg) | |
348 | { | |
349 | struct crypto_alg *base = &alg->base; | |
350 | int err; | |
351 | ||
352 | err = shash_prepare_alg(alg); | |
353 | if (err) | |
354 | return err; | |
7b5a080b HX |
355 | |
356 | return crypto_register_alg(base); | |
357 | } | |
358 | EXPORT_SYMBOL_GPL(crypto_register_shash); | |
359 | ||
c6d633a9 | 360 | void crypto_unregister_shash(struct shash_alg *alg) |
7b5a080b | 361 | { |
c6d633a9 | 362 | crypto_unregister_alg(&alg->base); |
7b5a080b HX |
363 | } |
364 | EXPORT_SYMBOL_GPL(crypto_unregister_shash); | |
365 | ||
50fc3e8d JK |
366 | int crypto_register_shashes(struct shash_alg *algs, int count) |
367 | { | |
368 | int i, ret; | |
369 | ||
370 | for (i = 0; i < count; i++) { | |
371 | ret = crypto_register_shash(&algs[i]); | |
372 | if (ret) | |
373 | goto err; | |
374 | } | |
375 | ||
376 | return 0; | |
377 | ||
378 | err: | |
379 | for (--i; i >= 0; --i) | |
380 | crypto_unregister_shash(&algs[i]); | |
381 | ||
382 | return ret; | |
383 | } | |
384 | EXPORT_SYMBOL_GPL(crypto_register_shashes); | |
385 | ||
c6d633a9 | 386 | void crypto_unregister_shashes(struct shash_alg *algs, int count) |
50fc3e8d | 387 | { |
c6d633a9 | 388 | int i; |
50fc3e8d | 389 | |
c6d633a9 EB |
390 | for (i = count - 1; i >= 0; --i) |
391 | crypto_unregister_shash(&algs[i]); | |
50fc3e8d JK |
392 | } |
393 | EXPORT_SYMBOL_GPL(crypto_unregister_shashes); | |
394 | ||
619a6ebd HX |
395 | int shash_register_instance(struct crypto_template *tmpl, |
396 | struct shash_instance *inst) | |
397 | { | |
398 | int err; | |
399 | ||
d4fdc2df EB |
400 | if (WARN_ON(!inst->free)) |
401 | return -EINVAL; | |
402 | ||
619a6ebd HX |
403 | err = shash_prepare_alg(&inst->alg); |
404 | if (err) | |
405 | return err; | |
406 | ||
407 | return crypto_register_instance(tmpl, shash_crypto_instance(inst)); | |
408 | } | |
409 | EXPORT_SYMBOL_GPL(shash_register_instance); | |
410 | ||
a39c66cc | 411 | void shash_free_singlespawn_instance(struct shash_instance *inst) |
2e4fddd8 | 412 | { |
a39c66cc EB |
413 | crypto_drop_spawn(shash_instance_ctx(inst)); |
414 | kfree(inst); | |
2e4fddd8 | 415 | } |
a39c66cc | 416 | EXPORT_SYMBOL_GPL(shash_free_singlespawn_instance); |
2e4fddd8 | 417 | |
7b5a080b HX |
418 | MODULE_LICENSE("GPL"); |
419 | MODULE_DESCRIPTION("Synchronous cryptographic hash type"); |