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