Backwards-compatibility subject to OPENSSL_API_COMPAT
[openssl.git] / crypto / hmac / hmac.c
1 /* crypto/hmac/hmac.c */
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 #include "internal/cryptlib.h"
63 #include <openssl/hmac.h>
64 #include <openssl/opensslconf.h>
65 #include "hmac_lcl.h"
66
67 int HMAC_Init_ex(HMAC_CTX *ctx, const void *key, int len,
68                  const EVP_MD *md, ENGINE *impl)
69 {
70     int i, j, reset = 0;
71     unsigned char pad[HMAC_MAX_MD_CBLOCK];
72
73     /* If we are changing MD then we must have a key */
74     if (md != NULL && md != ctx->md && (key == NULL || len < 0))
75         return 0;
76
77     if (md != NULL) {
78         reset = 1;
79         ctx->md = md;
80     } else if (ctx->md) {
81         md = ctx->md;
82     } else {
83         return 0;
84     }
85
86     if (key != NULL) {
87         reset = 1;
88         j = EVP_MD_block_size(md);
89         OPENSSL_assert(j <= (int)sizeof(ctx->key));
90         if (j < len) {
91             if (!EVP_DigestInit_ex(ctx->md_ctx, md, impl))
92                 goto err;
93             if (!EVP_DigestUpdate(ctx->md_ctx, key, len))
94                 goto err;
95             if (!EVP_DigestFinal_ex(ctx->md_ctx, ctx->key,
96                                     &ctx->key_length))
97                 goto err;
98         } else {
99             if (len < 0 || len > (int)sizeof(ctx->key))
100                 return 0;
101             memcpy(ctx->key, key, len);
102             ctx->key_length = len;
103         }
104         if (ctx->key_length != HMAC_MAX_MD_CBLOCK)
105             memset(&ctx->key[ctx->key_length], 0,
106                    HMAC_MAX_MD_CBLOCK - ctx->key_length);
107     }
108
109     if (reset) {
110         for (i = 0; i < HMAC_MAX_MD_CBLOCK; i++)
111             pad[i] = 0x36 ^ ctx->key[i];
112         if (!EVP_DigestInit_ex(ctx->i_ctx, md, impl))
113             goto err;
114         if (!EVP_DigestUpdate(ctx->i_ctx, pad, EVP_MD_block_size(md)))
115             goto err;
116
117         for (i = 0; i < HMAC_MAX_MD_CBLOCK; i++)
118             pad[i] = 0x5c ^ ctx->key[i];
119         if (!EVP_DigestInit_ex(ctx->o_ctx, md, impl))
120             goto err;
121         if (!EVP_DigestUpdate(ctx->o_ctx, pad, EVP_MD_block_size(md)))
122             goto err;
123     }
124     if (!EVP_MD_CTX_copy_ex(ctx->md_ctx, ctx->i_ctx))
125         goto err;
126     return 1;
127  err:
128     return 0;
129 }
130
131 #if OPENSSL_API_COMPAT < 0x10100000L
132 int HMAC_Init(HMAC_CTX *ctx, const void *key, int len, const EVP_MD *md)
133 {
134     if (key && md)
135         HMAC_CTX_reset(ctx);
136     return HMAC_Init_ex(ctx, key, len, md, NULL);
137 }
138 #endif
139
140 int HMAC_Update(HMAC_CTX *ctx, const unsigned char *data, size_t len)
141 {
142     if (!ctx->md)
143         return 0;
144     return EVP_DigestUpdate(ctx->md_ctx, data, len);
145 }
146
147 int HMAC_Final(HMAC_CTX *ctx, unsigned char *md, unsigned int *len)
148 {
149     unsigned int i;
150     unsigned char buf[EVP_MAX_MD_SIZE];
151
152     if (!ctx->md)
153         goto err;
154
155     if (!EVP_DigestFinal_ex(ctx->md_ctx, buf, &i))
156         goto err;
157     if (!EVP_MD_CTX_copy_ex(ctx->md_ctx, ctx->o_ctx))
158         goto err;
159     if (!EVP_DigestUpdate(ctx->md_ctx, buf, i))
160         goto err;
161     if (!EVP_DigestFinal_ex(ctx->md_ctx, md, len))
162         goto err;
163     return 1;
164  err:
165     return 0;
166 }
167
168 size_t HMAC_size(HMAC_CTX *ctx)
169 {
170     return EVP_MD_size((ctx)->md);
171 }
172
173 HMAC_CTX *HMAC_CTX_new(void)
174 {
175     HMAC_CTX *ctx = (HMAC_CTX *)OPENSSL_zalloc(sizeof(HMAC_CTX));
176     if (ctx)
177         if (!HMAC_CTX_reset(ctx)) {
178             HMAC_CTX_free(ctx);
179             ctx = NULL;
180         }
181     return ctx;
182 }
183
184 static void hmac_ctx_cleanup(HMAC_CTX *ctx)
185 {
186     EVP_MD_CTX_reset(ctx->i_ctx);
187     EVP_MD_CTX_reset(ctx->o_ctx);
188     EVP_MD_CTX_reset(ctx->md_ctx);
189     ctx->md = NULL;
190     ctx->key_length = 0;
191     memset(ctx->key, 0, sizeof(HMAC_MAX_MD_CBLOCK));
192 }
193
194 void HMAC_CTX_free(HMAC_CTX *ctx)
195 {
196     if (ctx != NULL) {
197         hmac_ctx_cleanup(ctx);
198         EVP_MD_CTX_free(ctx->i_ctx);
199         EVP_MD_CTX_free(ctx->o_ctx);
200         EVP_MD_CTX_free(ctx->md_ctx);
201         OPENSSL_free(ctx);
202     }
203 }
204
205 int HMAC_CTX_reset(HMAC_CTX *ctx)
206 {
207     hmac_ctx_cleanup(ctx);
208     if (ctx->i_ctx == NULL)
209         ctx->i_ctx = EVP_MD_CTX_new();
210     if (ctx->i_ctx == NULL)
211         goto err;
212     if (ctx->o_ctx == NULL)
213         ctx->o_ctx = EVP_MD_CTX_new();
214     if (ctx->o_ctx == NULL)
215         goto err;
216     if (ctx->md_ctx == NULL)
217         ctx->md_ctx = EVP_MD_CTX_new();
218     if (ctx->md_ctx == NULL)
219         goto err;
220     ctx->md = NULL;
221     return 1;
222  err:
223     hmac_ctx_cleanup(ctx);
224     return 0;
225 }
226
227 int HMAC_CTX_copy(HMAC_CTX *dctx, HMAC_CTX *sctx)
228 {
229     if (!HMAC_CTX_reset(dctx))
230         goto err;
231     if (!EVP_MD_CTX_copy_ex(dctx->i_ctx, sctx->i_ctx))
232         goto err;
233     if (!EVP_MD_CTX_copy_ex(dctx->o_ctx, sctx->o_ctx))
234         goto err;
235     if (!EVP_MD_CTX_copy_ex(dctx->md_ctx, sctx->md_ctx))
236         goto err;
237     memcpy(dctx->key, sctx->key, HMAC_MAX_MD_CBLOCK);
238     dctx->key_length = sctx->key_length;
239     dctx->md = sctx->md;
240     return 1;
241  err:
242     hmac_ctx_cleanup(dctx);
243     return 0;
244 }
245
246 unsigned char *HMAC(const EVP_MD *evp_md, const void *key, int key_len,
247                     const unsigned char *d, size_t n, unsigned char *md,
248                     unsigned int *md_len)
249 {
250     HMAC_CTX *c = NULL;
251     static unsigned char m[EVP_MAX_MD_SIZE];
252
253     if (md == NULL)
254         md = m;
255     if ((c = HMAC_CTX_new()) == NULL)
256         goto err;
257     if (!HMAC_Init_ex(c, key, key_len, evp_md, NULL))
258         goto err;
259     if (!HMAC_Update(c, d, n))
260         goto err;
261     if (!HMAC_Final(c, md, md_len))
262         goto err;
263     HMAC_CTX_free(c);
264     return md;
265  err:
266     HMAC_CTX_free(c);
267     return NULL;
268 }
269
270 void HMAC_CTX_set_flags(HMAC_CTX *ctx, unsigned long flags)
271 {
272     EVP_MD_CTX_set_flags(ctx->i_ctx, flags);
273     EVP_MD_CTX_set_flags(ctx->o_ctx, flags);
274     EVP_MD_CTX_set_flags(ctx->md_ctx, flags);
275 }