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