4 * HMAC: Keyed-Hashing for Message Authentication (RFC2104).
6 * Copyright (c) 2002 James Morris <jmorris@intercode.com.au>
7 * Copyright (c) 2006 Herbert Xu <herbert@gondor.apana.org.au>
9 * The HMAC implementation is derived from USAGI.
10 * Copyright (c) 2002 Kazunori Miyazawa <miyazawa@linux-ipv6.org> / USAGI
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)
19 #include <crypto/algapi.h>
20 #include <linux/err.h>
21 #include <linux/init.h>
22 #include <linux/kernel.h>
23 #include <linux/module.h>
24 #include <linux/scatterlist.h>
25 #include <linux/slab.h>
26 #include <linux/string.h>
29 struct crypto_hash *child;
32 static inline void *align_ptr(void *p, unsigned int align)
34 return (void *)ALIGN((unsigned long)p, align);
37 static inline struct hmac_ctx *hmac_ctx(struct crypto_hash *tfm)
39 return align_ptr(crypto_hash_ctx_aligned(tfm) +
40 crypto_hash_blocksize(tfm) * 2 +
41 crypto_hash_digestsize(tfm), sizeof(void *));
44 static int hmac_setkey(struct crypto_hash *parent,
45 const u8 *inkey, unsigned int keylen)
47 int bs = crypto_hash_blocksize(parent);
48 int ds = crypto_hash_digestsize(parent);
49 char *ipad = crypto_hash_ctx_aligned(parent);
50 char *opad = ipad + bs;
51 char *digest = opad + bs;
52 struct hmac_ctx *ctx = align_ptr(digest + ds, sizeof(void *));
53 struct crypto_hash *tfm = ctx->child;
57 struct hash_desc desc;
58 struct scatterlist tmp;
62 desc.flags = crypto_hash_get_flags(parent);
63 desc.flags &= CRYPTO_TFM_REQ_MAY_SLEEP;
64 sg_set_buf(&tmp, inkey, keylen);
66 err = crypto_hash_digest(&desc, &tmp, keylen, digest);
74 memcpy(ipad, inkey, keylen);
75 memset(ipad + keylen, 0, bs - keylen);
76 memcpy(opad, ipad, bs);
78 for (i = 0; i < bs; i++) {
86 static int hmac_init(struct hash_desc *pdesc)
88 struct crypto_hash *parent = pdesc->tfm;
89 int bs = crypto_hash_blocksize(parent);
90 int ds = crypto_hash_digestsize(parent);
91 char *ipad = crypto_hash_ctx_aligned(parent);
92 struct hmac_ctx *ctx = align_ptr(ipad + bs * 2 + ds, sizeof(void *));
93 struct hash_desc desc;
94 struct scatterlist tmp;
97 desc.tfm = ctx->child;
98 desc.flags = pdesc->flags & CRYPTO_TFM_REQ_MAY_SLEEP;
99 sg_set_buf(&tmp, ipad, bs);
101 err = crypto_hash_init(&desc);
105 return crypto_hash_update(&desc, &tmp, bs);
108 static int hmac_update(struct hash_desc *pdesc,
109 struct scatterlist *sg, unsigned int nbytes)
111 struct hmac_ctx *ctx = hmac_ctx(pdesc->tfm);
112 struct hash_desc desc;
114 desc.tfm = ctx->child;
115 desc.flags = pdesc->flags & CRYPTO_TFM_REQ_MAY_SLEEP;
117 return crypto_hash_update(&desc, sg, nbytes);
120 static int hmac_final(struct hash_desc *pdesc, u8 *out)
122 struct crypto_hash *parent = pdesc->tfm;
123 int bs = crypto_hash_blocksize(parent);
124 int ds = crypto_hash_digestsize(parent);
125 char *opad = crypto_hash_ctx_aligned(parent) + bs;
126 char *digest = opad + bs;
127 struct hmac_ctx *ctx = align_ptr(digest + ds, sizeof(void *));
128 struct hash_desc desc;
129 struct scatterlist tmp;
132 desc.tfm = ctx->child;
133 desc.flags = pdesc->flags & CRYPTO_TFM_REQ_MAY_SLEEP;
134 sg_set_buf(&tmp, opad, bs + ds);
136 err = crypto_hash_final(&desc, digest);
140 return crypto_hash_digest(&desc, &tmp, bs + ds, out);
143 static int hmac_digest(struct hash_desc *pdesc, struct scatterlist *sg,
144 unsigned int nbytes, u8 *out)
146 struct crypto_hash *parent = pdesc->tfm;
147 int bs = crypto_hash_blocksize(parent);
148 int ds = crypto_hash_digestsize(parent);
149 char *ipad = crypto_hash_ctx_aligned(parent);
150 char *opad = ipad + bs;
151 char *digest = opad + bs;
152 struct hmac_ctx *ctx = align_ptr(digest + ds, sizeof(void *));
153 struct hash_desc desc;
154 struct scatterlist sg1[2];
155 struct scatterlist sg2[1];
158 desc.tfm = ctx->child;
159 desc.flags = pdesc->flags & CRYPTO_TFM_REQ_MAY_SLEEP;
161 sg_set_buf(sg1, ipad, bs);
162 sg1[1].page = (void *)sg;
164 sg_set_buf(sg2, opad, bs + ds);
166 err = crypto_hash_digest(&desc, sg1, nbytes + bs, digest);
170 return crypto_hash_digest(&desc, sg2, bs + ds, out);
173 static int hmac_init_tfm(struct crypto_tfm *tfm)
175 struct crypto_instance *inst = (void *)tfm->__crt_alg;
176 struct crypto_spawn *spawn = crypto_instance_ctx(inst);
177 struct hmac_ctx *ctx = hmac_ctx(__crypto_hash_cast(tfm));
179 tfm = crypto_spawn_tfm(spawn);
183 ctx->child = crypto_hash_cast(tfm);
187 static void hmac_exit_tfm(struct crypto_tfm *tfm)
189 struct hmac_ctx *ctx = hmac_ctx(__crypto_hash_cast(tfm));
190 crypto_free_hash(ctx->child);
193 static void hmac_free(struct crypto_instance *inst)
195 crypto_drop_spawn(crypto_instance_ctx(inst));
199 static struct crypto_instance *hmac_alloc(void *param, unsigned int len)
201 struct crypto_instance *inst;
202 struct crypto_alg *alg;
204 alg = crypto_get_attr_alg(param, len, CRYPTO_ALG_TYPE_HASH,
205 CRYPTO_ALG_TYPE_HASH_MASK | CRYPTO_ALG_ASYNC);
207 return ERR_PTR(PTR_ERR(alg));
209 inst = crypto_alloc_instance("hmac", alg);
213 inst->alg.cra_flags = CRYPTO_ALG_TYPE_HASH;
214 inst->alg.cra_priority = alg->cra_priority;
215 inst->alg.cra_blocksize = alg->cra_blocksize;
216 inst->alg.cra_alignmask = alg->cra_alignmask;
217 inst->alg.cra_type = &crypto_hash_type;
219 inst->alg.cra_hash.digestsize =
220 (alg->cra_flags & CRYPTO_ALG_TYPE_MASK) ==
221 CRYPTO_ALG_TYPE_HASH ? alg->cra_hash.digestsize :
222 alg->cra_digest.dia_digestsize;
224 inst->alg.cra_ctxsize = sizeof(struct hmac_ctx) +
225 ALIGN(inst->alg.cra_blocksize * 2 +
226 inst->alg.cra_hash.digestsize,
229 inst->alg.cra_init = hmac_init_tfm;
230 inst->alg.cra_exit = hmac_exit_tfm;
232 inst->alg.cra_hash.init = hmac_init;
233 inst->alg.cra_hash.update = hmac_update;
234 inst->alg.cra_hash.final = hmac_final;
235 inst->alg.cra_hash.digest = hmac_digest;
236 inst->alg.cra_hash.setkey = hmac_setkey;
243 static struct crypto_template hmac_tmpl = {
247 .module = THIS_MODULE,
250 static int __init hmac_module_init(void)
252 return crypto_register_template(&hmac_tmpl);
255 static void __exit hmac_module_exit(void)
257 crypto_unregister_template(&hmac_tmpl);
260 module_init(hmac_module_init);
261 module_exit(hmac_module_exit);
263 MODULE_LICENSE("GPL");
264 MODULE_DESCRIPTION("HMAC hash algorithm");