xref: /openbsd-src/lib/libcrypto/hmac/hmac.c (revision 3374c67d44f9b75b98444cbf63020f777792342e)
1 /* $OpenBSD: hmac.c,v 1.30 2022/11/26 16:08:53 tb Exp $ */
2 /* Copyright (C) 1995-1998 Eric Young (eay@cryptsoft.com)
3  * All rights reserved.
4  *
5  * This package is an SSL implementation written
6  * by Eric Young (eay@cryptsoft.com).
7  * The implementation was written so as to conform with Netscapes SSL.
8  *
9  * This library is free for commercial and non-commercial use as long as
10  * the following conditions are aheared to.  The following conditions
11  * apply to all code found in this distribution, be it the RC4, RSA,
12  * lhash, DES, etc., code; not just the SSL code.  The SSL documentation
13  * included with this distribution is covered by the same copyright terms
14  * except that the holder is Tim Hudson (tjh@cryptsoft.com).
15  *
16  * Copyright remains Eric Young's, and as such any Copyright notices in
17  * the code are not to be removed.
18  * If this package is used in a product, Eric Young should be given attribution
19  * as the author of the parts of the library used.
20  * This can be in the form of a textual message at program startup or
21  * in documentation (online or textual) provided with the package.
22  *
23  * Redistribution and use in source and binary forms, with or without
24  * modification, are permitted provided that the following conditions
25  * are met:
26  * 1. Redistributions of source code must retain the copyright
27  *    notice, this list of conditions and the following disclaimer.
28  * 2. Redistributions in binary form must reproduce the above copyright
29  *    notice, this list of conditions and the following disclaimer in the
30  *    documentation and/or other materials provided with the distribution.
31  * 3. All advertising materials mentioning features or use of this software
32  *    must display the following acknowledgement:
33  *    "This product includes cryptographic software written by
34  *     Eric Young (eay@cryptsoft.com)"
35  *    The word 'cryptographic' can be left out if the rouines from the library
36  *    being used are not cryptographic related :-).
37  * 4. If you include any Windows specific code (or a derivative thereof) from
38  *    the apps directory (application code) you must include an acknowledgement:
39  *    "This product includes software written by Tim Hudson (tjh@cryptsoft.com)"
40  *
41  * THIS SOFTWARE IS PROVIDED BY ERIC YOUNG ``AS IS'' AND
42  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
43  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
44  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
45  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
46  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
47  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
48  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
49  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
50  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
51  * SUCH DAMAGE.
52  *
53  * The licence and distribution terms for any publically available version or
54  * derivative of this code cannot be changed.  i.e. this code cannot simply be
55  * copied and put under another distribution licence
56  * [including the GNU Public Licence.]
57  */
58 
59 #include <stdio.h>
60 #include <stdlib.h>
61 #include <string.h>
62 
63 #include <openssl/err.h>
64 #include <openssl/hmac.h>
65 
66 #include "evp_local.h"
67 #include "hmac_local.h"
68 
69 int
70 HMAC_Init_ex(HMAC_CTX *ctx, const void *key, int len, const EVP_MD *md,
71     ENGINE *impl)
72 {
73 	int i, j, reset = 0;
74 	unsigned char pad[HMAC_MAX_MD_CBLOCK];
75 
76 	/* If we are changing MD then we must have a key */
77 	if (md != NULL && md != ctx->md && (key == NULL || len < 0))
78 		return 0;
79 
80 	if (md != NULL) {
81 		reset = 1;
82 		ctx->md = md;
83 	} else if (ctx->md != NULL)
84 		md = ctx->md;
85 	else
86 		return 0;
87 
88 	if (key != NULL) {
89 		reset = 1;
90 		j = EVP_MD_block_size(md);
91 		if ((size_t)j > sizeof(ctx->key)) {
92 			EVPerror(EVP_R_BAD_BLOCK_LENGTH);
93 			goto err;
94 		}
95 		if (j < len) {
96 			if (!EVP_DigestInit_ex(&ctx->md_ctx, md, impl))
97 				goto err;
98 			if (!EVP_DigestUpdate(&ctx->md_ctx, key, len))
99 				goto err;
100 			if (!EVP_DigestFinal_ex(&(ctx->md_ctx), ctx->key,
101 			    &ctx->key_length))
102 				goto err;
103 		} else {
104 			if (len < 0 || (size_t)len > sizeof(ctx->key)) {
105 				EVPerror(EVP_R_BAD_KEY_LENGTH);
106 				goto err;
107 			}
108 			memcpy(ctx->key, key, len);
109 			ctx->key_length = len;
110 		}
111 		if (ctx->key_length != HMAC_MAX_MD_CBLOCK)
112 			memset(&ctx->key[ctx->key_length], 0,
113 			    HMAC_MAX_MD_CBLOCK - ctx->key_length);
114 	}
115 
116 	if (reset) {
117 		for (i = 0; i < HMAC_MAX_MD_CBLOCK; i++)
118 			pad[i] = 0x36 ^ ctx->key[i];
119 		if (!EVP_DigestInit_ex(&ctx->i_ctx, md, impl))
120 			goto err;
121 		if (!EVP_DigestUpdate(&ctx->i_ctx, pad, EVP_MD_block_size(md)))
122 			goto err;
123 
124 		for (i = 0; i < HMAC_MAX_MD_CBLOCK; i++)
125 			pad[i] = 0x5c ^ ctx->key[i];
126 		if (!EVP_DigestInit_ex(&ctx->o_ctx, md, impl))
127 			goto err;
128 		if (!EVP_DigestUpdate(&ctx->o_ctx, pad, EVP_MD_block_size(md)))
129 			goto err;
130 	}
131 	if (!EVP_MD_CTX_copy_ex(&ctx->md_ctx, &ctx->i_ctx))
132 		goto err;
133 	return 1;
134 err:
135 	return 0;
136 }
137 LCRYPTO_ALIAS(HMAC_Init_ex)
138 
139 int
140 HMAC_Init(HMAC_CTX *ctx, const void *key, int len, const EVP_MD *md)
141 {
142 	if (key && md)
143 		HMAC_CTX_init(ctx);
144 	return HMAC_Init_ex(ctx, key, len, md, NULL);
145 }
146 
147 int
148 HMAC_Update(HMAC_CTX *ctx, const unsigned char *data, size_t len)
149 {
150 	if (ctx->md == NULL)
151 		return 0;
152 
153 	return EVP_DigestUpdate(&ctx->md_ctx, data, len);
154 }
155 LCRYPTO_ALIAS(HMAC_Update)
156 
157 int
158 HMAC_Final(HMAC_CTX *ctx, unsigned char *md, unsigned int *len)
159 {
160 	unsigned int i;
161 	unsigned char buf[EVP_MAX_MD_SIZE];
162 
163 	if (ctx->md == NULL)
164 		goto err;
165 
166 	if (!EVP_DigestFinal_ex(&ctx->md_ctx, buf, &i))
167 		goto err;
168 	if (!EVP_MD_CTX_copy_ex(&ctx->md_ctx, &ctx->o_ctx))
169 		goto err;
170 	if (!EVP_DigestUpdate(&ctx->md_ctx, buf, i))
171 		goto err;
172 	if (!EVP_DigestFinal_ex(&ctx->md_ctx, md, len))
173 		goto err;
174 	return 1;
175 err:
176 	return 0;
177 }
178 LCRYPTO_ALIAS(HMAC_Final)
179 
180 HMAC_CTX *
181 HMAC_CTX_new(void)
182 {
183 	HMAC_CTX *ctx;
184 
185 	if ((ctx = calloc(1, sizeof(*ctx))) == NULL)
186 		return NULL;
187 
188 	HMAC_CTX_init(ctx);
189 
190 	return ctx;
191 }
192 LCRYPTO_ALIAS(HMAC_CTX_new)
193 
194 void
195 HMAC_CTX_free(HMAC_CTX *ctx)
196 {
197 	if (ctx == NULL)
198 		return;
199 
200 	HMAC_CTX_cleanup(ctx);
201 
202 	free(ctx);
203 }
204 LCRYPTO_ALIAS(HMAC_CTX_free)
205 
206 int
207 HMAC_CTX_reset(HMAC_CTX *ctx)
208 {
209 	HMAC_CTX_cleanup(ctx);
210 	HMAC_CTX_init(ctx);
211 	return 1;
212 }
213 
214 void
215 HMAC_CTX_init(HMAC_CTX *ctx)
216 {
217 	EVP_MD_CTX_init(&ctx->i_ctx);
218 	EVP_MD_CTX_init(&ctx->o_ctx);
219 	EVP_MD_CTX_init(&ctx->md_ctx);
220 	ctx->md = NULL;
221 }
222 
223 int
224 HMAC_CTX_copy(HMAC_CTX *dctx, HMAC_CTX *sctx)
225 {
226 	if (!EVP_MD_CTX_copy(&dctx->i_ctx, &sctx->i_ctx))
227 		goto err;
228 	if (!EVP_MD_CTX_copy(&dctx->o_ctx, &sctx->o_ctx))
229 		goto err;
230 	if (!EVP_MD_CTX_copy(&dctx->md_ctx, &sctx->md_ctx))
231 		goto err;
232 	memcpy(dctx->key, sctx->key, HMAC_MAX_MD_CBLOCK);
233 	dctx->key_length = sctx->key_length;
234 	dctx->md = sctx->md;
235 	return 1;
236 err:
237 	return 0;
238 }
239 LCRYPTO_ALIAS(HMAC_CTX_copy)
240 
241 void
242 HMAC_CTX_cleanup(HMAC_CTX *ctx)
243 {
244 	EVP_MD_CTX_cleanup(&ctx->i_ctx);
245 	EVP_MD_CTX_cleanup(&ctx->o_ctx);
246 	EVP_MD_CTX_cleanup(&ctx->md_ctx);
247 	explicit_bzero(ctx, sizeof(*ctx));
248 }
249 
250 void
251 HMAC_CTX_set_flags(HMAC_CTX *ctx, unsigned long flags)
252 {
253 	EVP_MD_CTX_set_flags(&ctx->i_ctx, flags);
254 	EVP_MD_CTX_set_flags(&ctx->o_ctx, flags);
255 	EVP_MD_CTX_set_flags(&ctx->md_ctx, flags);
256 }
257 LCRYPTO_ALIAS(HMAC_CTX_set_flags)
258 
259 const EVP_MD *
260 HMAC_CTX_get_md(const HMAC_CTX *ctx)
261 {
262 	return ctx->md;
263 }
264 LCRYPTO_ALIAS(HMAC_CTX_get_md)
265 
266 unsigned char *
267 HMAC(const EVP_MD *evp_md, const void *key, int key_len, const unsigned char *d,
268     size_t n, unsigned char *md, unsigned int *md_len)
269 {
270 	HMAC_CTX c;
271 	static unsigned char m[EVP_MAX_MD_SIZE];
272 	const unsigned char dummy_key[1] = { 0 };
273 
274 	if (md == NULL)
275 		md = m;
276 	if (key == NULL) {
277 		key = dummy_key;
278 		key_len = 0;
279 	}
280 	HMAC_CTX_init(&c);
281 	if (!HMAC_Init_ex(&c, key, key_len, evp_md, NULL))
282 		goto err;
283 	if (!HMAC_Update(&c, d, n))
284 		goto err;
285 	if (!HMAC_Final(&c, md, md_len))
286 		goto err;
287 	HMAC_CTX_cleanup(&c);
288 	return md;
289 err:
290 	HMAC_CTX_cleanup(&c);
291 	return NULL;
292 }
293 LCRYPTO_ALIAS(HMAC)
294