1 /* $OpenBSD: pem_pkey.c,v 1.25 2021/12/24 12:59:18 tb Exp $ */
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 
59 #include <stdio.h>
60 #include <string.h>
61 
62 #include <openssl/opensslconf.h>
63 
64 #include <openssl/buffer.h>
65 #include <openssl/err.h>
66 #include <openssl/evp.h>
67 #include <openssl/objects.h>
68 #include <openssl/pem.h>
69 #include <openssl/pkcs12.h>
70 #include <openssl/x509.h>
71 
72 #ifndef OPENSSL_NO_ENGINE
73 #include <openssl/engine.h>
74 #endif
75 
76 #include "asn1_locl.h"
77 #include "evp_locl.h"
78 
79 int pem_check_suffix(const char *pem_str, const char *suffix);
80 
81 EVP_PKEY *
82 PEM_read_bio_PrivateKey(BIO *bp, EVP_PKEY **x, pem_password_cb *cb, void *u)
83 {
84 	char *nm = NULL;
85 	const unsigned char *p = NULL;
86 	unsigned char *data = NULL;
87 	long len;
88 	int slen;
89 	EVP_PKEY *ret = NULL;
90 
91 	if (!PEM_bytes_read_bio(&data, &len, &nm, PEM_STRING_EVP_PKEY,
92 	    bp, cb, u))
93 		return NULL;
94 	p = data;
95 
96 	if (strcmp(nm, PEM_STRING_PKCS8INF) == 0) {
97 		PKCS8_PRIV_KEY_INFO *p8inf;
98 		p8inf = d2i_PKCS8_PRIV_KEY_INFO(NULL, &p, len);
99 		if (!p8inf)
100 			goto p8err;
101 		ret = EVP_PKCS82PKEY(p8inf);
102 		if (x) {
103 			EVP_PKEY_free(*x);
104 			*x = ret;
105 		}
106 		PKCS8_PRIV_KEY_INFO_free(p8inf);
107 	} else if (strcmp(nm, PEM_STRING_PKCS8) == 0) {
108 		PKCS8_PRIV_KEY_INFO *p8inf;
109 		X509_SIG *p8;
110 		int klen;
111 		char psbuf[PEM_BUFSIZE];
112 		p8 = d2i_X509_SIG(NULL, &p, len);
113 		if (!p8)
114 			goto p8err;
115 		if (cb)
116 			klen = cb(psbuf, PEM_BUFSIZE, 0, u);
117 		else
118 			klen = PEM_def_callback(psbuf, PEM_BUFSIZE, 0, u);
119 		if (klen <= 0) {
120 			PEMerror(PEM_R_BAD_PASSWORD_READ);
121 			X509_SIG_free(p8);
122 			goto err;
123 		}
124 		p8inf = PKCS8_decrypt(p8, psbuf, klen);
125 		X509_SIG_free(p8);
126 		if (!p8inf)
127 			goto p8err;
128 		ret = EVP_PKCS82PKEY(p8inf);
129 		if (x) {
130 			EVP_PKEY_free(*x);
131 			*x = ret;
132 		}
133 		PKCS8_PRIV_KEY_INFO_free(p8inf);
134 	} else if ((slen = pem_check_suffix(nm, "PRIVATE KEY")) > 0) {
135 		const EVP_PKEY_ASN1_METHOD *ameth;
136 		ameth = EVP_PKEY_asn1_find_str(NULL, nm, slen);
137 		if (!ameth || !ameth->old_priv_decode)
138 			goto p8err;
139 		ret = d2i_PrivateKey(ameth->pkey_id, x, &p, len);
140 	}
141 
142 p8err:
143 	if (ret == NULL)
144 		PEMerror(ERR_R_ASN1_LIB);
145 err:
146 	free(nm);
147 	freezero(data, len);
148 	return (ret);
149 }
150 
151 int
152 PEM_write_bio_PrivateKey(BIO *bp, EVP_PKEY *x, const EVP_CIPHER *enc,
153     unsigned char *kstr, int klen, pem_password_cb *cb, void *u)
154 {
155 	if (x->ameth == NULL || x->ameth->priv_encode != NULL)
156 		return PEM_write_bio_PKCS8PrivateKey(bp, x, enc,
157 		    (char *)kstr, klen, cb, u);
158 
159 	return PEM_write_bio_PrivateKey_traditional(bp, x, enc, kstr, klen, cb,
160 	    u);
161 }
162 
163 int
164 PEM_write_bio_PrivateKey_traditional(BIO *bp, EVP_PKEY *x,
165     const EVP_CIPHER *enc, unsigned char *kstr, int klen, pem_password_cb *cb,
166     void *u)
167 {
168 	char pem_str[80];
169 
170 	(void) snprintf(pem_str, sizeof(pem_str), "%s PRIVATE KEY",
171 	    x->ameth->pem_str);
172 	return PEM_ASN1_write_bio((i2d_of_void *)i2d_PrivateKey,
173 	    pem_str, bp, x, enc, kstr, klen, cb, u);
174 }
175 
176 EVP_PKEY *
177 PEM_read_bio_Parameters(BIO *bp, EVP_PKEY **x)
178 {
179 	char *nm = NULL;
180 	const unsigned char *p = NULL;
181 	unsigned char *data = NULL;
182 	long len;
183 	int slen;
184 	EVP_PKEY *ret = NULL;
185 
186 	if (!PEM_bytes_read_bio(&data, &len, &nm, PEM_STRING_PARAMETERS,
187 	    bp, 0, NULL))
188 		return NULL;
189 	p = data;
190 
191 	if ((slen = pem_check_suffix(nm, "PARAMETERS")) > 0) {
192 		ret = EVP_PKEY_new();
193 		if (!ret)
194 			goto err;
195 		if (!EVP_PKEY_set_type_str(ret, nm, slen) ||
196 		    !ret->ameth->param_decode ||
197 		    !ret->ameth->param_decode(ret, &p, len)) {
198 			EVP_PKEY_free(ret);
199 			ret = NULL;
200 			goto err;
201 		}
202 		if (x) {
203 			EVP_PKEY_free(*x);
204 			*x = ret;
205 		}
206 	}
207 
208 err:
209 	if (ret == NULL)
210 		PEMerror(ERR_R_ASN1_LIB);
211 	free(nm);
212 	free(data);
213 	return (ret);
214 }
215 
216 int
217 PEM_write_bio_Parameters(BIO *bp, EVP_PKEY *x)
218 {
219 	char pem_str[80];
220 
221 	if (!x->ameth || !x->ameth->param_encode)
222 		return 0;
223 
224 	(void) snprintf(pem_str, sizeof(pem_str), "%s PARAMETERS",
225 	    x->ameth->pem_str);
226 	return PEM_ASN1_write_bio((i2d_of_void *)x->ameth->param_encode,
227 	    pem_str, bp, x, NULL, NULL, 0, 0, NULL);
228 }
229 
230 EVP_PKEY *
231 PEM_read_PrivateKey(FILE *fp, EVP_PKEY **x, pem_password_cb *cb, void *u)
232 {
233 	BIO *b;
234 	EVP_PKEY *ret;
235 
236 	if ((b = BIO_new(BIO_s_file())) == NULL) {
237 		PEMerror(ERR_R_BUF_LIB);
238 		return (0);
239 	}
240 	BIO_set_fp(b, fp, BIO_NOCLOSE);
241 	ret = PEM_read_bio_PrivateKey(b, x, cb, u);
242 	BIO_free(b);
243 	return (ret);
244 }
245 
246 int
247 PEM_write_PrivateKey(FILE *fp, EVP_PKEY *x, const EVP_CIPHER *enc,
248     unsigned char *kstr, int klen, pem_password_cb *cb, void *u)
249 {
250 	BIO *b;
251 	int ret;
252 
253 	if ((b = BIO_new_fp(fp, BIO_NOCLOSE)) == NULL) {
254 		PEMerror(ERR_R_BUF_LIB);
255 		return 0;
256 	}
257 	ret = PEM_write_bio_PrivateKey(b, x, enc, kstr, klen, cb, u);
258 	BIO_free(b);
259 	return ret;
260 }
261 
262