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