Update status.
[openssl.git] / crypto / hmac / hm_pmeth.c
1 /* Written by Dr Stephen N Henson (steve@openssl.org) for the OpenSSL
2  * project 2007.
3  */
4 /* ====================================================================
5  * Copyright (c) 2007 The OpenSSL Project.  All rights reserved.
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
10  *
11  * 1. Redistributions of source code must retain the above copyright
12  *    notice, this list of conditions and the following disclaimer. 
13  *
14  * 2. Redistributions in binary form must reproduce the above copyright
15  *    notice, this list of conditions and the following disclaimer in
16  *    the documentation and/or other materials provided with the
17  *    distribution.
18  *
19  * 3. All advertising materials mentioning features or use of this
20  *    software must display the following acknowledgment:
21  *    "This product includes software developed by the OpenSSL Project
22  *    for use in the OpenSSL Toolkit. (http://www.OpenSSL.org/)"
23  *
24  * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
25  *    endorse or promote products derived from this software without
26  *    prior written permission. For written permission, please contact
27  *    licensing@OpenSSL.org.
28  *
29  * 5. Products derived from this software may not be called "OpenSSL"
30  *    nor may "OpenSSL" appear in their names without prior written
31  *    permission of the OpenSSL Project.
32  *
33  * 6. Redistributions of any form whatsoever must retain the following
34  *    acknowledgment:
35  *    "This product includes software developed by the OpenSSL Project
36  *    for use in the OpenSSL Toolkit (http://www.OpenSSL.org/)"
37  *
38  * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
39  * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
40  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
41  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE OpenSSL PROJECT OR
42  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
43  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
44  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
45  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
46  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
47  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
48  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
49  * OF THE POSSIBILITY OF SUCH DAMAGE.
50  * ====================================================================
51  *
52  * This product includes cryptographic software written by Eric Young
53  * (eay@cryptsoft.com).  This product includes software written by Tim
54  * Hudson (tjh@cryptsoft.com).
55  *
56  */
57
58 #include <stdio.h>
59 #include "cryptlib.h"
60 #include <openssl/x509.h>
61 #include <openssl/x509v3.h>
62 #include <openssl/evp.h>
63 #include <openssl/hmac.h>
64 #include "evp_locl.h"
65
66 /* HMAC pkey context structure */
67
68 typedef struct
69         {
70         const EVP_MD *md;       /* MD for HMAC use */
71         ASN1_OCTET_STRING ktmp; /* Temp storage for key */
72         HMAC_CTX ctx;
73         } HMAC_PKEY_CTX;
74
75 static int pkey_hmac_init(EVP_PKEY_CTX *ctx)
76         {
77         HMAC_PKEY_CTX *hctx;
78         hctx = OPENSSL_malloc(sizeof(HMAC_PKEY_CTX));
79         if (!hctx)
80                 return 0;
81         hctx->md = NULL;
82         hctx->ktmp.data = NULL;
83         hctx->ktmp.length = 0;
84         hctx->ktmp.flags = 0;
85         hctx->ktmp.type = V_ASN1_OCTET_STRING;
86         HMAC_CTX_init(&hctx->ctx);
87
88         ctx->data = hctx;
89         ctx->keygen_info_count = 0;
90
91         return 1;
92         }
93
94 static int pkey_hmac_copy(EVP_PKEY_CTX *dst, EVP_PKEY_CTX *src)
95         {
96         HMAC_PKEY_CTX *sctx, *dctx;
97         if (!pkey_hmac_init(dst))
98                 return 0;
99         sctx = src->data;
100         dctx = dst->data;
101         dctx->md = sctx->md;
102         HMAC_CTX_init(&dctx->ctx);
103         if (!HMAC_CTX_copy(&dctx->ctx, &sctx->ctx))
104                 return 0;
105         if (sctx->ktmp.data)
106                 {
107                 if (!ASN1_OCTET_STRING_set(&dctx->ktmp,
108                                         sctx->ktmp.data, sctx->ktmp.length))
109                         return 0;
110                 }
111         return 1;
112         }
113
114 static void pkey_hmac_cleanup(EVP_PKEY_CTX *ctx)
115         {
116         HMAC_PKEY_CTX *hctx = ctx->data;
117         HMAC_CTX_cleanup(&hctx->ctx);
118         if (hctx->ktmp.data)
119                 {
120                 if (hctx->ktmp.length)
121                         OPENSSL_cleanse(hctx->ktmp.data, hctx->ktmp.length);
122                 OPENSSL_free(hctx->ktmp.data);
123                 hctx->ktmp.data = NULL;
124                 }
125         OPENSSL_free(hctx);
126         }
127
128 static int pkey_hmac_keygen(EVP_PKEY_CTX *ctx, EVP_PKEY *pkey)
129         {
130         ASN1_OCTET_STRING *hkey = NULL;
131         HMAC_PKEY_CTX *hctx = ctx->data;
132         if (!hctx->ktmp.data)
133                 return 0;
134         hkey = ASN1_OCTET_STRING_dup(&hctx->ktmp);
135         if (!hkey)
136                 return 0;
137         EVP_PKEY_assign(pkey, EVP_PKEY_HMAC, hkey);
138         
139         return 1;
140         }
141
142 static int int_update(EVP_MD_CTX *ctx,const void *data,size_t count)
143         {
144         HMAC_PKEY_CTX *hctx = ctx->pctx->data;
145         if (!HMAC_Update(&hctx->ctx, data, count))
146                 return 0;
147         return 1;
148         }
149
150 static int hmac_signctx_init(EVP_PKEY_CTX *ctx, EVP_MD_CTX *mctx)
151         {
152         EVP_MD_CTX_set_flags(mctx, EVP_MD_CTX_FLAG_NO_INIT);
153         mctx->update = int_update;
154         return 1;
155         }
156
157 static int hmac_signctx(EVP_PKEY_CTX *ctx, unsigned char *sig, size_t *siglen,
158                                         EVP_MD_CTX *mctx)
159         {
160         unsigned int hlen;
161         HMAC_PKEY_CTX *hctx = ctx->data;
162         int l = EVP_MD_CTX_size(mctx);
163
164         if (l < 0)
165                 return 0;
166         *siglen = l;
167         if (!sig)
168                 return 1;
169
170         if (!HMAC_Final(&hctx->ctx, sig, &hlen))
171                 return 0;
172         *siglen = (size_t)hlen;
173         return 1;
174         }
175
176 static int pkey_hmac_ctrl(EVP_PKEY_CTX *ctx, int type, int p1, void *p2)
177         {
178         HMAC_PKEY_CTX *hctx = ctx->data;
179         ASN1_OCTET_STRING *key;
180         switch (type)
181                 {
182
183                 case EVP_PKEY_CTRL_SET_MAC_KEY:
184                 if ((!p2 && p1 > 0) || (p1 < -1))
185                         return 0;
186                 if (!ASN1_OCTET_STRING_set(&hctx->ktmp, p2, p1))
187                         return 0;
188                 break;
189
190                 case EVP_PKEY_CTRL_MD:
191                 hctx->md = p2;
192                 break;
193
194                 case EVP_PKEY_CTRL_DIGESTINIT:
195                 key = (ASN1_OCTET_STRING *)ctx->pkey->pkey.ptr;
196                 if (!HMAC_Init_ex(&hctx->ctx, key->data, key->length, hctx->md,
197                                 ctx->engine))
198                         return 0;
199                 break;
200
201                 default:
202                 return -2;
203
204                 }
205         return 1;
206         }
207
208 static int pkey_hmac_ctrl_str(EVP_PKEY_CTX *ctx,
209                         const char *type, const char *value)
210         {
211         if (!value)
212                 {
213                 return 0;
214                 }
215         if (!strcmp(type, "key"))
216                 {
217                 void *p = (void *)value;
218                 return pkey_hmac_ctrl(ctx, EVP_PKEY_CTRL_SET_MAC_KEY,
219                                 -1, p);
220                 }
221         if (!strcmp(type, "hexkey"))
222                 {
223                 unsigned char *key;
224                 int r;
225                 long keylen;
226                 key = string_to_hex(value, &keylen);
227                 if (!key)
228                         return 0;
229                 r = pkey_hmac_ctrl(ctx, EVP_PKEY_CTRL_SET_MAC_KEY, keylen, key);
230                 OPENSSL_free(key);
231                 return r;
232                 }
233         return -2;
234         }
235
236 const EVP_PKEY_METHOD hmac_pkey_meth = 
237         {
238         EVP_PKEY_HMAC,
239         0,
240         pkey_hmac_init,
241         pkey_hmac_copy,
242         pkey_hmac_cleanup,
243
244         0, 0,
245
246         0,
247         pkey_hmac_keygen,
248
249         0, 0,
250
251         0, 0,
252
253         0,0,
254
255         hmac_signctx_init,
256         hmac_signctx,
257
258         0,0,
259
260         0,0,
261
262         0,0,
263
264         0,0,
265
266         pkey_hmac_ctrl,
267         pkey_hmac_ctrl_str
268
269         };