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