1 /* $OpenBSD: hm_ameth.c,v 1.9 2015/07/20 15:45:29 miod Exp $ */
2 /* Written by Dr Stephen N Henson (steve@openssl.org) for the OpenSSL
3  * project 2007.
4  */
5 /* ====================================================================
6  * Copyright (c) 2007 The OpenSSL Project.  All rights reserved.
7  *
8  * Redistribution and use in source and binary forms, with or without
9  * modification, are permitted provided that the following conditions
10  * are met:
11  *
12  * 1. Redistributions of source code must retain the above copyright
13  *    notice, this list of conditions and the following disclaimer.
14  *
15  * 2. Redistributions in binary form must reproduce the above copyright
16  *    notice, this list of conditions and the following disclaimer in
17  *    the documentation and/or other materials provided with the
18  *    distribution.
19  *
20  * 3. All advertising materials mentioning features or use of this
21  *    software must display the following acknowledgment:
22  *    "This product includes software developed by the OpenSSL Project
23  *    for use in the OpenSSL Toolkit. (http://www.OpenSSL.org/)"
24  *
25  * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
26  *    endorse or promote products derived from this software without
27  *    prior written permission. For written permission, please contact
28  *    licensing@OpenSSL.org.
29  *
30  * 5. Products derived from this software may not be called "OpenSSL"
31  *    nor may "OpenSSL" appear in their names without prior written
32  *    permission of the OpenSSL Project.
33  *
34  * 6. Redistributions of any form whatsoever must retain the following
35  *    acknowledgment:
36  *    "This product includes software developed by the OpenSSL Project
37  *    for use in the OpenSSL Toolkit (http://www.OpenSSL.org/)"
38  *
39  * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
40  * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
41  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
42  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE OpenSSL PROJECT OR
43  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
44  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
45  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
46  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
47  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
48  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
49  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
50  * OF THE POSSIBILITY OF SUCH DAMAGE.
51  * ====================================================================
52  *
53  * This product includes cryptographic software written by Eric Young
54  * (eay@cryptsoft.com).  This product includes software written by Tim
55  * Hudson (tjh@cryptsoft.com).
56  *
57  */
58 
59 #include <stdio.h>
60 #include <string.h>
61 
62 #include <openssl/evp.h>
63 
64 #include "asn1_locl.h"
65 
66 #define HMAC_TEST_PRIVATE_KEY_FORMAT
67 
68 /* HMAC "ASN1" method. This is just here to indicate the
69  * maximum HMAC output length and to free up an HMAC
70  * key.
71  */
72 
73 static int
74 hmac_size(const EVP_PKEY *pkey)
75 {
76 	return EVP_MAX_MD_SIZE;
77 }
78 
79 static void
80 hmac_key_free(EVP_PKEY *pkey)
81 {
82 	ASN1_OCTET_STRING *os = (ASN1_OCTET_STRING *)pkey->pkey.ptr;
83 
84 	if (os) {
85 		if (os->data)
86 			explicit_bzero(os->data, os->length);
87 		ASN1_OCTET_STRING_free(os);
88 	}
89 }
90 
91 static int
92 hmac_pkey_ctrl(EVP_PKEY *pkey, int op, long arg1, void *arg2)
93 {
94 	switch (op) {
95 	case ASN1_PKEY_CTRL_DEFAULT_MD_NID:
96 		*(int *)arg2 = NID_sha1;
97 		return 1;
98 	default:
99 		return -2;
100 	}
101 }
102 
103 #ifdef HMAC_TEST_PRIVATE_KEY_FORMAT
104 /* A bogus private key format for test purposes. This is simply the
105  * HMAC key with "HMAC PRIVATE KEY" in the headers. When enabled the
106  * genpkey utility can be used to "generate" HMAC keys.
107  */
108 
109 static int
110 old_hmac_decode(EVP_PKEY *pkey, const unsigned char **pder, int derlen)
111 {
112 	ASN1_OCTET_STRING *os;
113 
114 	os = ASN1_OCTET_STRING_new();
115 	if (os == NULL)
116 		goto err;
117 	if (ASN1_OCTET_STRING_set(os, *pder, derlen) == 0)
118 		goto err;
119 	if (EVP_PKEY_assign(pkey, EVP_PKEY_HMAC, os) == 0)
120 		goto err;
121 	return 1;
122 
123 err:
124 	ASN1_OCTET_STRING_free(os);
125 	return 0;
126 }
127 
128 static int
129 old_hmac_encode(const EVP_PKEY *pkey, unsigned char **pder)
130 {
131 	int inc;
132 	ASN1_OCTET_STRING *os = (ASN1_OCTET_STRING *)pkey->pkey.ptr;
133 
134 	if (pder) {
135 		if (!*pder) {
136 			*pder = malloc(os->length);
137 			if (*pder == NULL)
138 				return -1;
139 			inc = 0;
140 		} else
141 			inc = 1;
142 
143 		memcpy(*pder, os->data, os->length);
144 
145 		if (inc)
146 			*pder += os->length;
147 	}
148 
149 	return os->length;
150 }
151 
152 #endif
153 
154 const EVP_PKEY_ASN1_METHOD hmac_asn1_meth = {
155 	.pkey_id = EVP_PKEY_HMAC,
156 	.pkey_base_id = EVP_PKEY_HMAC,
157 
158 	.pem_str = "HMAC",
159 	.info = "OpenSSL HMAC method",
160 
161 	.pkey_size = hmac_size,
162 
163 	.pkey_free = hmac_key_free,
164 	.pkey_ctrl = hmac_pkey_ctrl,
165 #ifdef HMAC_TEST_PRIVATE_KEY_FORMAT
166 	.old_priv_decode = old_hmac_decode,
167 	.old_priv_encode = old_hmac_encode
168 #endif
169 };
170