1 // SPDX-License-Identifier: GPL-2.0-or-later <<
2 /* 1 /*
3 * Cryptographic API. 2 * Cryptographic API.
4 * 3 *
5 * HMAC: Keyed-Hashing for Message Authenticat 4 * HMAC: Keyed-Hashing for Message Authentication (RFC2104).
6 * 5 *
7 * Copyright (c) 2002 James Morris <jmorris@in 6 * Copyright (c) 2002 James Morris <jmorris@intercode.com.au>
8 * Copyright (c) 2006 Herbert Xu <herbert@gond 7 * Copyright (c) 2006 Herbert Xu <herbert@gondor.apana.org.au>
9 * 8 *
10 * The HMAC implementation is derived from USA 9 * The HMAC implementation is derived from USAGI.
11 * Copyright (c) 2002 Kazunori Miyazawa <miyaz 10 * Copyright (c) 2002 Kazunori Miyazawa <miyazawa@linux-ipv6.org> / USAGI
>> 11 *
>> 12 * This program is free software; you can redistribute it and/or modify it
>> 13 * under the terms of the GNU General Public License as published by the Free
>> 14 * Software Foundation; either version 2 of the License, or (at your option)
>> 15 * any later version.
>> 16 *
12 */ 17 */
13 18
14 #include <crypto/hmac.h> 19 #include <crypto/hmac.h>
15 #include <crypto/internal/hash.h> 20 #include <crypto/internal/hash.h>
16 #include <crypto/scatterwalk.h> 21 #include <crypto/scatterwalk.h>
17 #include <linux/err.h> 22 #include <linux/err.h>
18 #include <linux/fips.h> <<
19 #include <linux/init.h> 23 #include <linux/init.h>
20 #include <linux/kernel.h> 24 #include <linux/kernel.h>
21 #include <linux/module.h> 25 #include <linux/module.h>
22 #include <linux/scatterlist.h> 26 #include <linux/scatterlist.h>
23 #include <linux/string.h> 27 #include <linux/string.h>
24 28
25 struct hmac_ctx { 29 struct hmac_ctx {
26 struct crypto_shash *hash; 30 struct crypto_shash *hash;
27 /* Contains 'u8 ipad[statesize];', the <<
28 u8 pads[]; <<
29 }; 31 };
30 32
>> 33 static inline void *align_ptr(void *p, unsigned int align)
>> 34 {
>> 35 return (void *)ALIGN((unsigned long)p, align);
>> 36 }
>> 37
>> 38 static inline struct hmac_ctx *hmac_ctx(struct crypto_shash *tfm)
>> 39 {
>> 40 return align_ptr(crypto_shash_ctx_aligned(tfm) +
>> 41 crypto_shash_statesize(tfm) * 2,
>> 42 crypto_tfm_ctx_alignment());
>> 43 }
>> 44
31 static int hmac_setkey(struct crypto_shash *pa 45 static int hmac_setkey(struct crypto_shash *parent,
32 const u8 *inkey, unsign 46 const u8 *inkey, unsigned int keylen)
33 { 47 {
34 int bs = crypto_shash_blocksize(parent 48 int bs = crypto_shash_blocksize(parent);
35 int ds = crypto_shash_digestsize(paren 49 int ds = crypto_shash_digestsize(parent);
36 int ss = crypto_shash_statesize(parent 50 int ss = crypto_shash_statesize(parent);
37 struct hmac_ctx *tctx = crypto_shash_c !! 51 char *ipad = crypto_shash_ctx_aligned(parent);
38 struct crypto_shash *hash = tctx->hash !! 52 char *opad = ipad + ss;
39 u8 *ipad = &tctx->pads[0]; !! 53 struct hmac_ctx *ctx = align_ptr(opad + ss,
40 u8 *opad = &tctx->pads[ss]; !! 54 crypto_tfm_ctx_alignment());
>> 55 struct crypto_shash *hash = ctx->hash;
41 SHASH_DESC_ON_STACK(shash, hash); 56 SHASH_DESC_ON_STACK(shash, hash);
42 unsigned int i; 57 unsigned int i;
43 58
44 if (fips_enabled && (keylen < 112 / 8) <<
45 return -EINVAL; <<
46 <<
47 shash->tfm = hash; 59 shash->tfm = hash;
>> 60 shash->flags = crypto_shash_get_flags(parent)
>> 61 & CRYPTO_TFM_REQ_MAY_SLEEP;
48 62
49 if (keylen > bs) { 63 if (keylen > bs) {
50 int err; 64 int err;
51 65
52 err = crypto_shash_digest(shas 66 err = crypto_shash_digest(shash, inkey, keylen, ipad);
53 if (err) 67 if (err)
54 return err; 68 return err;
55 69
56 keylen = ds; 70 keylen = ds;
57 } else 71 } else
58 memcpy(ipad, inkey, keylen); 72 memcpy(ipad, inkey, keylen);
59 73
60 memset(ipad + keylen, 0, bs - keylen); 74 memset(ipad + keylen, 0, bs - keylen);
61 memcpy(opad, ipad, bs); 75 memcpy(opad, ipad, bs);
62 76
63 for (i = 0; i < bs; i++) { 77 for (i = 0; i < bs; i++) {
64 ipad[i] ^= HMAC_IPAD_VALUE; 78 ipad[i] ^= HMAC_IPAD_VALUE;
65 opad[i] ^= HMAC_OPAD_VALUE; 79 opad[i] ^= HMAC_OPAD_VALUE;
66 } 80 }
67 81
68 return crypto_shash_init(shash) ?: 82 return crypto_shash_init(shash) ?:
69 crypto_shash_update(shash, ipad 83 crypto_shash_update(shash, ipad, bs) ?:
70 crypto_shash_export(shash, ipad 84 crypto_shash_export(shash, ipad) ?:
71 crypto_shash_init(shash) ?: 85 crypto_shash_init(shash) ?:
72 crypto_shash_update(shash, opad 86 crypto_shash_update(shash, opad, bs) ?:
73 crypto_shash_export(shash, opad 87 crypto_shash_export(shash, opad);
74 } 88 }
75 89
76 static int hmac_export(struct shash_desc *pdes 90 static int hmac_export(struct shash_desc *pdesc, void *out)
77 { 91 {
78 struct shash_desc *desc = shash_desc_c 92 struct shash_desc *desc = shash_desc_ctx(pdesc);
79 93
>> 94 desc->flags = pdesc->flags & CRYPTO_TFM_REQ_MAY_SLEEP;
>> 95
80 return crypto_shash_export(desc, out); 96 return crypto_shash_export(desc, out);
81 } 97 }
82 98
83 static int hmac_import(struct shash_desc *pdes 99 static int hmac_import(struct shash_desc *pdesc, const void *in)
84 { 100 {
85 struct shash_desc *desc = shash_desc_c 101 struct shash_desc *desc = shash_desc_ctx(pdesc);
86 const struct hmac_ctx *tctx = crypto_s !! 102 struct hmac_ctx *ctx = hmac_ctx(pdesc->tfm);
87 103
88 desc->tfm = tctx->hash; !! 104 desc->tfm = ctx->hash;
>> 105 desc->flags = pdesc->flags & CRYPTO_TFM_REQ_MAY_SLEEP;
89 106
90 return crypto_shash_import(desc, in); 107 return crypto_shash_import(desc, in);
91 } 108 }
92 109
93 static int hmac_init(struct shash_desc *pdesc) 110 static int hmac_init(struct shash_desc *pdesc)
94 { 111 {
95 const struct hmac_ctx *tctx = crypto_s !! 112 return hmac_import(pdesc, crypto_shash_ctx_aligned(pdesc->tfm));
96 <<
97 return hmac_import(pdesc, &tctx->pads[ <<
98 } 113 }
99 114
100 static int hmac_update(struct shash_desc *pdes 115 static int hmac_update(struct shash_desc *pdesc,
101 const u8 *data, unsigne 116 const u8 *data, unsigned int nbytes)
102 { 117 {
103 struct shash_desc *desc = shash_desc_c 118 struct shash_desc *desc = shash_desc_ctx(pdesc);
104 119
>> 120 desc->flags = pdesc->flags & CRYPTO_TFM_REQ_MAY_SLEEP;
>> 121
105 return crypto_shash_update(desc, data, 122 return crypto_shash_update(desc, data, nbytes);
106 } 123 }
107 124
108 static int hmac_final(struct shash_desc *pdesc 125 static int hmac_final(struct shash_desc *pdesc, u8 *out)
109 { 126 {
110 struct crypto_shash *parent = pdesc->t 127 struct crypto_shash *parent = pdesc->tfm;
111 int ds = crypto_shash_digestsize(paren 128 int ds = crypto_shash_digestsize(parent);
112 int ss = crypto_shash_statesize(parent 129 int ss = crypto_shash_statesize(parent);
113 const struct hmac_ctx *tctx = crypto_s !! 130 char *opad = crypto_shash_ctx_aligned(parent) + ss;
114 const u8 *opad = &tctx->pads[ss]; <<
115 struct shash_desc *desc = shash_desc_c 131 struct shash_desc *desc = shash_desc_ctx(pdesc);
116 132
>> 133 desc->flags = pdesc->flags & CRYPTO_TFM_REQ_MAY_SLEEP;
>> 134
117 return crypto_shash_final(desc, out) ? 135 return crypto_shash_final(desc, out) ?:
118 crypto_shash_import(desc, opad) 136 crypto_shash_import(desc, opad) ?:
119 crypto_shash_finup(desc, out, d 137 crypto_shash_finup(desc, out, ds, out);
120 } 138 }
121 139
122 static int hmac_finup(struct shash_desc *pdesc 140 static int hmac_finup(struct shash_desc *pdesc, const u8 *data,
123 unsigned int nbytes, u8 141 unsigned int nbytes, u8 *out)
124 { 142 {
125 143
126 struct crypto_shash *parent = pdesc->t 144 struct crypto_shash *parent = pdesc->tfm;
127 int ds = crypto_shash_digestsize(paren 145 int ds = crypto_shash_digestsize(parent);
128 int ss = crypto_shash_statesize(parent 146 int ss = crypto_shash_statesize(parent);
129 const struct hmac_ctx *tctx = crypto_s !! 147 char *opad = crypto_shash_ctx_aligned(parent) + ss;
130 const u8 *opad = &tctx->pads[ss]; <<
131 struct shash_desc *desc = shash_desc_c 148 struct shash_desc *desc = shash_desc_ctx(pdesc);
132 149
>> 150 desc->flags = pdesc->flags & CRYPTO_TFM_REQ_MAY_SLEEP;
>> 151
133 return crypto_shash_finup(desc, data, 152 return crypto_shash_finup(desc, data, nbytes, out) ?:
134 crypto_shash_import(desc, opad) 153 crypto_shash_import(desc, opad) ?:
135 crypto_shash_finup(desc, out, d 154 crypto_shash_finup(desc, out, ds, out);
136 } 155 }
137 156
138 static int hmac_init_tfm(struct crypto_shash * !! 157 static int hmac_init_tfm(struct crypto_tfm *tfm)
139 { 158 {
>> 159 struct crypto_shash *parent = __crypto_shash_cast(tfm);
140 struct crypto_shash *hash; 160 struct crypto_shash *hash;
141 struct shash_instance *inst = shash_al !! 161 struct crypto_instance *inst = (void *)tfm->__crt_alg;
142 struct crypto_shash_spawn *spawn = sha !! 162 struct crypto_shash_spawn *spawn = crypto_instance_ctx(inst);
143 struct hmac_ctx *tctx = crypto_shash_c !! 163 struct hmac_ctx *ctx = hmac_ctx(parent);
144 164
145 hash = crypto_spawn_shash(spawn); 165 hash = crypto_spawn_shash(spawn);
146 if (IS_ERR(hash)) 166 if (IS_ERR(hash))
147 return PTR_ERR(hash); 167 return PTR_ERR(hash);
148 168
149 parent->descsize = sizeof(struct shash 169 parent->descsize = sizeof(struct shash_desc) +
150 crypto_shash_descsi 170 crypto_shash_descsize(hash);
151 171
152 tctx->hash = hash; !! 172 ctx->hash = hash;
153 return 0; <<
154 } <<
155 <<
156 static int hmac_clone_tfm(struct crypto_shash <<
157 { <<
158 struct hmac_ctx *sctx = crypto_shash_c <<
159 struct hmac_ctx *dctx = crypto_shash_c <<
160 struct crypto_shash *hash; <<
161 <<
162 hash = crypto_clone_shash(sctx->hash); <<
163 if (IS_ERR(hash)) <<
164 return PTR_ERR(hash); <<
165 <<
166 dctx->hash = hash; <<
167 return 0; 173 return 0;
168 } 174 }
169 175
170 static void hmac_exit_tfm(struct crypto_shash !! 176 static void hmac_exit_tfm(struct crypto_tfm *tfm)
171 { 177 {
172 struct hmac_ctx *tctx = crypto_shash_c !! 178 struct hmac_ctx *ctx = hmac_ctx(__crypto_shash_cast(tfm));
173 !! 179 crypto_free_shash(ctx->hash);
174 crypto_free_shash(tctx->hash); <<
175 } 180 }
176 181
177 static int hmac_create(struct crypto_template 182 static int hmac_create(struct crypto_template *tmpl, struct rtattr **tb)
178 { 183 {
179 struct shash_instance *inst; 184 struct shash_instance *inst;
180 struct crypto_shash_spawn *spawn; <<
181 struct crypto_alg *alg; 185 struct crypto_alg *alg;
182 struct shash_alg *salg; 186 struct shash_alg *salg;
183 u32 mask; <<
184 int err; 187 int err;
185 int ds; 188 int ds;
186 int ss; 189 int ss;
187 190
188 err = crypto_check_attr_type(tb, CRYPT !! 191 err = crypto_check_attr_type(tb, CRYPTO_ALG_TYPE_SHASH);
189 if (err) 192 if (err)
190 return err; 193 return err;
191 194
192 inst = kzalloc(sizeof(*inst) + sizeof( !! 195 salg = shash_attr_alg(tb[1], 0, 0);
193 if (!inst) !! 196 if (IS_ERR(salg))
194 return -ENOMEM; !! 197 return PTR_ERR(salg);
195 spawn = shash_instance_ctx(inst); <<
196 <<
197 err = crypto_grab_shash(spawn, shash_c <<
198 crypto_attr_al <<
199 if (err) <<
200 goto err_free_inst; <<
201 salg = crypto_spawn_shash_alg(spawn); <<
202 alg = &salg->base; 198 alg = &salg->base;
203 199
204 /* The underlying hash algorithm must !! 200 /* The underlying hash algorithm must be unkeyed */
205 err = -EINVAL; 201 err = -EINVAL;
206 if (crypto_shash_alg_needs_key(salg)) !! 202 if (crypto_shash_alg_has_setkey(salg))
207 goto err_free_inst; !! 203 goto out_put_alg;
208 204
209 ds = salg->digestsize; 205 ds = salg->digestsize;
210 ss = salg->statesize; 206 ss = salg->statesize;
211 if (ds > alg->cra_blocksize || 207 if (ds > alg->cra_blocksize ||
212 ss < alg->cra_blocksize) 208 ss < alg->cra_blocksize)
213 goto err_free_inst; !! 209 goto out_put_alg;
214 210
215 err = crypto_inst_setname(shash_crypto !! 211 inst = shash_alloc_instance("hmac", alg);
>> 212 err = PTR_ERR(inst);
>> 213 if (IS_ERR(inst))
>> 214 goto out_put_alg;
>> 215
>> 216 err = crypto_init_shash_spawn(shash_instance_ctx(inst), salg,
>> 217 shash_crypto_instance(inst));
216 if (err) 218 if (err)
217 goto err_free_inst; !! 219 goto out_free_inst;
218 220
219 inst->alg.base.cra_priority = alg->cra 221 inst->alg.base.cra_priority = alg->cra_priority;
220 inst->alg.base.cra_blocksize = alg->cr 222 inst->alg.base.cra_blocksize = alg->cra_blocksize;
221 inst->alg.base.cra_ctxsize = sizeof(st !! 223 inst->alg.base.cra_alignmask = alg->cra_alignmask;
222 224
>> 225 ss = ALIGN(ss, alg->cra_alignmask + 1);
223 inst->alg.digestsize = ds; 226 inst->alg.digestsize = ds;
224 inst->alg.statesize = ss; 227 inst->alg.statesize = ss;
>> 228
>> 229 inst->alg.base.cra_ctxsize = sizeof(struct hmac_ctx) +
>> 230 ALIGN(ss * 2, crypto_tfm_ctx_alignment());
>> 231
>> 232 inst->alg.base.cra_init = hmac_init_tfm;
>> 233 inst->alg.base.cra_exit = hmac_exit_tfm;
>> 234
225 inst->alg.init = hmac_init; 235 inst->alg.init = hmac_init;
226 inst->alg.update = hmac_update; 236 inst->alg.update = hmac_update;
227 inst->alg.final = hmac_final; 237 inst->alg.final = hmac_final;
228 inst->alg.finup = hmac_finup; 238 inst->alg.finup = hmac_finup;
229 inst->alg.export = hmac_export; 239 inst->alg.export = hmac_export;
230 inst->alg.import = hmac_import; 240 inst->alg.import = hmac_import;
231 inst->alg.setkey = hmac_setkey; 241 inst->alg.setkey = hmac_setkey;
232 inst->alg.init_tfm = hmac_init_tfm; <<
233 inst->alg.clone_tfm = hmac_clone_tfm; <<
234 inst->alg.exit_tfm = hmac_exit_tfm; <<
235 <<
236 inst->free = shash_free_singlespawn_in <<
237 242
238 err = shash_register_instance(tmpl, in 243 err = shash_register_instance(tmpl, inst);
239 if (err) { 244 if (err) {
240 err_free_inst: !! 245 out_free_inst:
241 shash_free_singlespawn_instanc !! 246 shash_free_instance(shash_crypto_instance(inst));
242 } 247 }
>> 248
>> 249 out_put_alg:
>> 250 crypto_mod_put(alg);
243 return err; 251 return err;
244 } 252 }
245 253
246 static struct crypto_template hmac_tmpl = { 254 static struct crypto_template hmac_tmpl = {
247 .name = "hmac", 255 .name = "hmac",
248 .create = hmac_create, 256 .create = hmac_create,
>> 257 .free = shash_free_instance,
249 .module = THIS_MODULE, 258 .module = THIS_MODULE,
250 }; 259 };
251 260
252 static int __init hmac_module_init(void) 261 static int __init hmac_module_init(void)
253 { 262 {
254 return crypto_register_template(&hmac_ 263 return crypto_register_template(&hmac_tmpl);
255 } 264 }
256 265
257 static void __exit hmac_module_exit(void) 266 static void __exit hmac_module_exit(void)
258 { 267 {
259 crypto_unregister_template(&hmac_tmpl) 268 crypto_unregister_template(&hmac_tmpl);
260 } 269 }
261 270
262 subsys_initcall(hmac_module_init); !! 271 module_init(hmac_module_init);
263 module_exit(hmac_module_exit); 272 module_exit(hmac_module_exit);
264 273
265 MODULE_LICENSE("GPL"); 274 MODULE_LICENSE("GPL");
266 MODULE_DESCRIPTION("HMAC hash algorithm"); 275 MODULE_DESCRIPTION("HMAC hash algorithm");
267 MODULE_ALIAS_CRYPTO("hmac"); 276 MODULE_ALIAS_CRYPTO("hmac");
268 277
Linux® is a registered trademark of Linus Torvalds in the United States and other countries.
TOMOYO® is a registered trademark of NTT DATA CORPORATION.