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