1 /* $OpenBSD: pem_pkey.c,v 1.20 2015/02/11 03:19:37 doug 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 
78 int pem_check_suffix(const char *pem_str, const char *suffix);
79 
80 EVP_PKEY *
81 PEM_read_bio_PrivateKey(BIO *bp, EVP_PKEY **x, pem_password_cb *cb, void *u)
82 {
83 	char *nm = NULL;
84 	const unsigned char *p = NULL;
85 	unsigned char *data = NULL;
86 	long len;
87 	int slen;
88 	EVP_PKEY *ret = NULL;
89 
90 	if (!PEM_bytes_read_bio(&data, &len, &nm, PEM_STRING_EVP_PKEY,
91 	    bp, cb, u))
92 		return NULL;
93 	p = data;
94 
95 	if (strcmp(nm, PEM_STRING_PKCS8INF) == 0) {
96 		PKCS8_PRIV_KEY_INFO *p8inf;
97 		p8inf = d2i_PKCS8_PRIV_KEY_INFO(NULL, &p, len);
98 		if (!p8inf)
99 			goto p8err;
100 		ret = EVP_PKCS82PKEY(p8inf);
101 		if (x) {
102 			EVP_PKEY_free(*x);
103 			*x = ret;
104 		}
105 		PKCS8_PRIV_KEY_INFO_free(p8inf);
106 	} else if (strcmp(nm, PEM_STRING_PKCS8) == 0) {
107 		PKCS8_PRIV_KEY_INFO *p8inf;
108 		X509_SIG *p8;
109 		int klen;
110 		char psbuf[PEM_BUFSIZE];
111 		p8 = d2i_X509_SIG(NULL, &p, len);
112 		if (!p8)
113 			goto p8err;
114 		if (cb)
115 			klen = cb(psbuf, PEM_BUFSIZE, 0, u);
116 		else
117 			klen = PEM_def_callback(psbuf, PEM_BUFSIZE, 0, u);
118 		if (klen <= 0) {
119 			PEMerr(PEM_F_PEM_READ_BIO_PRIVATEKEY,
120 			    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 		PEMerr(PEM_F_PEM_READ_BIO_PRIVATEKEY, ERR_R_ASN1_LIB);
145 err:
146 	free(nm);
147 	explicit_bzero(data, len);
148 	free(data);
149 	return (ret);
150 }
151 
152 int
153 PEM_write_bio_PrivateKey(BIO *bp, EVP_PKEY *x, const EVP_CIPHER *enc,
154     unsigned char *kstr, int klen, pem_password_cb *cb, void *u)
155 {
156 	char pem_str[80];
157 
158 	if (!x->ameth || x->ameth->priv_encode)
159 		return PEM_write_bio_PKCS8PrivateKey(bp, x, enc,
160 		    (char *)kstr, klen, cb, u);
161 
162 	(void) snprintf(pem_str, sizeof(pem_str), "%s PRIVATE KEY",
163 	    x->ameth->pem_str);
164 	return PEM_ASN1_write_bio((i2d_of_void *)i2d_PrivateKey,
165 	    pem_str, bp, x, enc, kstr, klen, cb, u);
166 }
167 
168 EVP_PKEY *
169 PEM_read_bio_Parameters(BIO *bp, EVP_PKEY **x)
170 {
171 	char *nm = NULL;
172 	const unsigned char *p = NULL;
173 	unsigned char *data = NULL;
174 	long len;
175 	int slen;
176 	EVP_PKEY *ret = NULL;
177 
178 	if (!PEM_bytes_read_bio(&data, &len, &nm, PEM_STRING_PARAMETERS,
179 	    bp, 0, NULL))
180 		return NULL;
181 	p = data;
182 
183 	if ((slen = pem_check_suffix(nm, "PARAMETERS")) > 0) {
184 		ret = EVP_PKEY_new();
185 		if (!ret)
186 			goto err;
187 		if (!EVP_PKEY_set_type_str(ret, nm, slen) ||
188 		    !ret->ameth->param_decode ||
189 		    !ret->ameth->param_decode(ret, &p, len)) {
190 			EVP_PKEY_free(ret);
191 			ret = NULL;
192 			goto err;
193 		}
194 		if (x) {
195 			EVP_PKEY_free(*x);
196 			*x = ret;
197 		}
198 	}
199 
200 err:
201 	if (ret == NULL)
202 		PEMerr(PEM_F_PEM_READ_BIO_PARAMETERS, ERR_R_ASN1_LIB);
203 	free(nm);
204 	free(data);
205 	return (ret);
206 }
207 
208 int
209 PEM_write_bio_Parameters(BIO *bp, EVP_PKEY *x)
210 {
211 	char pem_str[80];
212 
213 	if (!x->ameth || !x->ameth->param_encode)
214 		return 0;
215 
216 	(void) snprintf(pem_str, sizeof(pem_str), "%s PARAMETERS",
217 	    x->ameth->pem_str);
218 	return PEM_ASN1_write_bio((i2d_of_void *)x->ameth->param_encode,
219 	    pem_str, bp, x, NULL, NULL, 0, 0, NULL);
220 }
221 
222 EVP_PKEY *
223 PEM_read_PrivateKey(FILE *fp, EVP_PKEY **x, pem_password_cb *cb, void *u)
224 {
225 	BIO *b;
226 	EVP_PKEY *ret;
227 
228 	if ((b = BIO_new(BIO_s_file())) == NULL) {
229 		PEMerr(PEM_F_PEM_READ_PRIVATEKEY, ERR_R_BUF_LIB);
230 		return (0);
231 	}
232 	BIO_set_fp(b, fp, BIO_NOCLOSE);
233 	ret = PEM_read_bio_PrivateKey(b, x, cb, u);
234 	BIO_free(b);
235 	return (ret);
236 }
237 
238 int
239 PEM_write_PrivateKey(FILE *fp, EVP_PKEY *x, const EVP_CIPHER *enc,
240     unsigned char *kstr, int klen, pem_password_cb *cb, void *u)
241 {
242 	BIO *b;
243 	int ret;
244 
245 	if ((b = BIO_new_fp(fp, BIO_NOCLOSE)) == NULL) {
246 		PEMerr(PEM_F_PEM_WRITE_PRIVATEKEY, ERR_R_BUF_LIB);
247 		return 0;
248 	}
249 	ret = PEM_write_bio_PrivateKey(b, x, enc, kstr, klen, cb, u);
250 	BIO_free(b);
251 	return ret;
252 }
253 
254