Experimental multi-implementation support for FIPS capable OpenSSL.
[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 #include <stdio.h>
59 #include <stdlib.h>
60 #include <string.h>
61 #include "cryptlib.h"
62 #include <openssl/hmac.h>
63
64 #ifdef OPENSSL_FIPS
65 #include <openssl/fips.h>
66 #endif
67
68 int HMAC_Init_ex(HMAC_CTX *ctx, const void *key, int len,
69                   const EVP_MD *md, ENGINE *impl)
70         {
71         int i,j,reset=0;
72         unsigned char pad[HMAC_MAX_MD_CBLOCK];
73
74 #ifdef OPENSSL_FIPS
75         /* If FIPS mode switch to approved implementation if possible */
76         if (FIPS_mode())
77                 {
78                 const EVP_MD *fipsmd;
79                 if (md)
80                         {
81                         fipsmd = FIPS_get_digestbynid(EVP_MD_type(md));
82                         if (fipsmd)
83                                 md = fipsmd;
84                         }
85                 }
86
87         if (FIPS_mode())
88                 {
89                 /* If we have an ENGINE need to allow non FIPS */
90                 if ((impl || ctx->i_ctx.engine)
91                         &&  !(ctx->i_ctx.flags & EVP_CIPH_FLAG_NON_FIPS_ALLOW))
92                         {
93                         EVPerr(EVP_F_HMAC_INIT_EX, EVP_R_DISABLED_FOR_FIPS);
94                         return 0;
95                         }
96                 /* Other algorithm blocking will be done in FIPS_cmac_init,
97                  * via FIPS_hmac_init_ex().
98                  */
99                 if (!impl && !ctx->i_ctx.engine)
100                         return FIPS_hmac_init_ex(ctx, key, len, md, NULL);
101                 }
102 #endif
103
104         if (md != NULL)
105                 {
106                 reset=1;
107                 ctx->md=md;
108                 }
109         else
110                 md=ctx->md;
111
112         if (key != NULL)
113                 {
114                 reset=1;
115                 j=EVP_MD_block_size(md);
116                 OPENSSL_assert(j <= (int)sizeof(ctx->key));
117                 if (j < len)
118                         {
119                         if (!EVP_DigestInit_ex(&ctx->md_ctx,md, impl))
120                                 goto err;
121                         if (!EVP_DigestUpdate(&ctx->md_ctx,key,len))
122                                 goto err;
123                         if (!EVP_DigestFinal_ex(&(ctx->md_ctx),ctx->key,
124                                 &ctx->key_length))
125                                 goto err;
126                         }
127                 else
128                         {
129                         OPENSSL_assert(len>=0 && len<=(int)sizeof(ctx->key));
130                         memcpy(ctx->key,key,len);
131                         ctx->key_length=len;
132                         }
133                 if(ctx->key_length != HMAC_MAX_MD_CBLOCK)
134                         memset(&ctx->key[ctx->key_length], 0,
135                                 HMAC_MAX_MD_CBLOCK - ctx->key_length);
136                 }
137
138         if (reset)      
139                 {
140                 for (i=0; i<HMAC_MAX_MD_CBLOCK; i++)
141                         pad[i]=0x36^ctx->key[i];
142                 if (!EVP_DigestInit_ex(&ctx->i_ctx,md, impl))
143                         goto err;
144                 if (!EVP_DigestUpdate(&ctx->i_ctx,pad,EVP_MD_block_size(md)))
145                         goto err;
146
147                 for (i=0; i<HMAC_MAX_MD_CBLOCK; i++)
148                         pad[i]=0x5c^ctx->key[i];
149                 if (!EVP_DigestInit_ex(&ctx->o_ctx,md, impl))
150                         goto err;
151                 if (!EVP_DigestUpdate(&ctx->o_ctx,pad,EVP_MD_block_size(md)))
152                         goto err;
153                 }
154         if (!EVP_MD_CTX_copy_ex(&ctx->md_ctx,&ctx->i_ctx))
155                         goto err;
156         return 1;
157         err:
158         return 0;
159         }
160
161 int HMAC_Init(HMAC_CTX *ctx, const void *key, int len, const EVP_MD *md)
162         {
163         if(key && md)
164             HMAC_CTX_init(ctx);
165         return HMAC_Init_ex(ctx,key,len,md, NULL);
166         }
167
168 int HMAC_Update(HMAC_CTX *ctx, const unsigned char *data, size_t len)
169         {
170 #ifdef OPENSSL_FIPS
171         if (FIPS_mode() && !ctx->i_ctx.engine)
172                 return FIPS_hmac_update(ctx, data, len);
173 #endif
174         return EVP_DigestUpdate(&ctx->md_ctx,data,len);
175         }
176
177 int HMAC_Final(HMAC_CTX *ctx, unsigned char *md, unsigned int *len)
178         {
179         unsigned int i;
180         unsigned char buf[EVP_MAX_MD_SIZE];
181 #ifdef OPENSSL_FIPS
182         if (FIPS_mode() && !ctx->i_ctx.engine)
183                 return FIPS_hmac_final(ctx, md, len);
184 #endif
185
186         if (!EVP_DigestFinal_ex(&ctx->md_ctx,buf,&i))
187                 goto err;
188         if (!EVP_MD_CTX_copy_ex(&ctx->md_ctx,&ctx->o_ctx))
189                 goto err;
190         if (!EVP_DigestUpdate(&ctx->md_ctx,buf,i))
191                 goto err;
192         if (!EVP_DigestFinal_ex(&ctx->md_ctx,md,len))
193                 goto err;
194         return 1;
195         err:
196         return 0;
197         }
198
199 void HMAC_CTX_init(HMAC_CTX *ctx)
200         {
201         EVP_MD_CTX_init(&ctx->i_ctx);
202         EVP_MD_CTX_init(&ctx->o_ctx);
203         EVP_MD_CTX_init(&ctx->md_ctx);
204         }
205
206 int HMAC_CTX_copy(HMAC_CTX *dctx, HMAC_CTX *sctx)
207         {
208         if (!EVP_MD_CTX_copy(&dctx->i_ctx, &sctx->i_ctx))
209                 goto err;
210         if (!EVP_MD_CTX_copy(&dctx->o_ctx, &sctx->o_ctx))
211                 goto err;
212         if (!EVP_MD_CTX_copy(&dctx->md_ctx, &sctx->md_ctx))
213                 goto err;
214         memcpy(dctx->key, sctx->key, HMAC_MAX_MD_CBLOCK);
215         dctx->key_length = sctx->key_length;
216         dctx->md = sctx->md;
217         return 1;
218         err:
219         return 0;
220         }
221
222 void HMAC_CTX_cleanup(HMAC_CTX *ctx)
223         {
224 #ifdef OPENSSL_FIPS
225         if (FIPS_mode() && !ctx->i_ctx.engine)
226                 {
227                 FIPS_hmac_ctx_cleanup(ctx);
228                 return;
229                 }
230 #endif
231         EVP_MD_CTX_cleanup(&ctx->i_ctx);
232         EVP_MD_CTX_cleanup(&ctx->o_ctx);
233         EVP_MD_CTX_cleanup(&ctx->md_ctx);
234         memset(ctx,0,sizeof *ctx);
235         }
236
237 unsigned char *HMAC(const EVP_MD *evp_md, const void *key, int key_len,
238                     const unsigned char *d, size_t n, unsigned char *md,
239                     unsigned int *md_len)
240         {
241         HMAC_CTX c;
242         static unsigned char m[EVP_MAX_MD_SIZE];
243
244         if (md == NULL) md=m;
245         HMAC_CTX_init(&c);
246         if (!HMAC_Init(&c,key,key_len,evp_md))
247                 goto err;
248         if (!HMAC_Update(&c,d,n))
249                 goto err;
250         if (!HMAC_Final(&c,md,md_len))
251                 goto err;
252         HMAC_CTX_cleanup(&c);
253         return md;
254         err:
255         return NULL;
256         }
257
258 void HMAC_CTX_set_flags(HMAC_CTX *ctx, unsigned long flags)
259         {
260         EVP_MD_CTX_set_flags(&ctx->i_ctx, flags);
261         EVP_MD_CTX_set_flags(&ctx->o_ctx, flags);
262         EVP_MD_CTX_set_flags(&ctx->md_ctx, flags);
263         }