check reviewer --reviewer=emilia
[openssl.git] / crypto / pem / pem_pk8.c
1 /* Copyright (C) 1995-1998 Eric Young (eay@cryptsoft.com)
2  * All rights reserved.
3  *
4  * This package is an SSL implementation written
5  * by Eric Young (eay@cryptsoft.com).
6  * The implementation was written so as to conform with Netscapes SSL.
7  *
8  * This library is free for commercial and non-commercial use as long as
9  * the following conditions are aheared to.  The following conditions
10  * apply to all code found in this distribution, be it the RC4, RSA,
11  * lhash, DES, etc., code; not just the SSL code.  The SSL documentation
12  * included with this distribution is covered by the same copyright terms
13  * except that the holder is Tim Hudson (tjh@cryptsoft.com).
14  *
15  * Copyright remains Eric Young's, and as such any Copyright notices in
16  * the code are not to be removed.
17  * If this package is used in a product, Eric Young should be given attribution
18  * as the author of the parts of the library used.
19  * This can be in the form of a textual message at program startup or
20  * in documentation (online or textual) provided with the package.
21  *
22  * Redistribution and use in source and binary forms, with or without
23  * modification, are permitted provided that the following conditions
24  * are met:
25  * 1. Redistributions of source code must retain the copyright
26  *    notice, this list of conditions and the following disclaimer.
27  * 2. Redistributions in binary form must reproduce the above copyright
28  *    notice, this list of conditions and the following disclaimer in the
29  *    documentation and/or other materials provided with the distribution.
30  * 3. All advertising materials mentioning features or use of this software
31  *    must display the following acknowledgement:
32  *    "This product includes cryptographic software written by
33  *     Eric Young (eay@cryptsoft.com)"
34  *    The word 'cryptographic' can be left out if the rouines from the library
35  *    being used are not cryptographic related :-).
36  * 4. If you include any Windows specific code (or a derivative thereof) from
37  *    the apps directory (application code) you must include an acknowledgement:
38  *    "This product includes software written by Tim Hudson (tjh@cryptsoft.com)"
39  *
40  * THIS SOFTWARE IS PROVIDED BY ERIC YOUNG ``AS IS'' AND
41  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
42  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
43  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
44  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
45  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
46  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
47  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
48  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
49  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
50  * SUCH DAMAGE.
51  *
52  * The licence and distribution terms for any publically available version or
53  * derivative of this code cannot be changed.  i.e. this code cannot simply be
54  * copied and put under another distribution licence
55  * [including the GNU Public Licence.]
56  */
57
58 #include <stdio.h>
59 #include "internal/cryptlib.h"
60 #include <openssl/buffer.h>
61 #include <openssl/objects.h>
62 #include <openssl/evp.h>
63 #include <openssl/rand.h>
64 #include <openssl/x509.h>
65 #include <openssl/pkcs12.h>
66 #include <openssl/pem.h>
67
68 static int do_pk8pkey(BIO *bp, EVP_PKEY *x, int isder,
69                       int nid, const EVP_CIPHER *enc,
70                       char *kstr, int klen, pem_password_cb *cb, void *u);
71
72 #ifndef OPENSSL_NO_STDIO
73 static int do_pk8pkey_fp(FILE *bp, EVP_PKEY *x, int isder,
74                          int nid, const EVP_CIPHER *enc,
75                          char *kstr, int klen, pem_password_cb *cb, void *u);
76 #endif
77 /*
78  * These functions write a private key in PKCS#8 format: it is a "drop in"
79  * replacement for PEM_write_bio_PrivateKey() and friends. As usual if 'enc'
80  * is NULL then it uses the unencrypted private key form. The 'nid' versions
81  * uses PKCS#5 v1.5 PBE algorithms whereas the others use PKCS#5 v2.0.
82  */
83
84 int PEM_write_bio_PKCS8PrivateKey_nid(BIO *bp, EVP_PKEY *x, int nid,
85                                       char *kstr, int klen,
86                                       pem_password_cb *cb, void *u)
87 {
88     return do_pk8pkey(bp, x, 0, nid, NULL, kstr, klen, cb, u);
89 }
90
91 int PEM_write_bio_PKCS8PrivateKey(BIO *bp, EVP_PKEY *x, const EVP_CIPHER *enc,
92                                   char *kstr, int klen,
93                                   pem_password_cb *cb, void *u)
94 {
95     return do_pk8pkey(bp, x, 0, -1, enc, kstr, klen, cb, u);
96 }
97
98 int i2d_PKCS8PrivateKey_bio(BIO *bp, EVP_PKEY *x, const EVP_CIPHER *enc,
99                             char *kstr, int klen,
100                             pem_password_cb *cb, void *u)
101 {
102     return do_pk8pkey(bp, x, 1, -1, enc, kstr, klen, cb, u);
103 }
104
105 int i2d_PKCS8PrivateKey_nid_bio(BIO *bp, EVP_PKEY *x, int nid,
106                                 char *kstr, int klen,
107                                 pem_password_cb *cb, void *u)
108 {
109     return do_pk8pkey(bp, x, 1, nid, NULL, kstr, klen, cb, u);
110 }
111
112 static int do_pk8pkey(BIO *bp, EVP_PKEY *x, int isder, int nid,
113                       const EVP_CIPHER *enc, char *kstr, int klen,
114                       pem_password_cb *cb, void *u)
115 {
116     X509_SIG *p8;
117     PKCS8_PRIV_KEY_INFO *p8inf;
118     char buf[PEM_BUFSIZE];
119     int ret;
120
121     if ((p8inf = EVP_PKEY2PKCS8(x)) == NULL) {
122         PEMerr(PEM_F_DO_PK8PKEY, PEM_R_ERROR_CONVERTING_PRIVATE_KEY);
123         return 0;
124     }
125     if (enc || (nid != -1)) {
126         if (!kstr) {
127             if (!cb)
128                 klen = PEM_def_callback(buf, PEM_BUFSIZE, 1, u);
129             else
130                 klen = cb(buf, PEM_BUFSIZE, 1, u);
131             if (klen <= 0) {
132                 PEMerr(PEM_F_DO_PK8PKEY, PEM_R_READ_KEY);
133                 PKCS8_PRIV_KEY_INFO_free(p8inf);
134                 return 0;
135             }
136
137             kstr = buf;
138         }
139         p8 = PKCS8_encrypt(nid, enc, kstr, klen, NULL, 0, 0, p8inf);
140         if (kstr == buf)
141             OPENSSL_cleanse(buf, klen);
142         PKCS8_PRIV_KEY_INFO_free(p8inf);
143         if (p8 == NULL)
144             return 0;
145         if (isder)
146             ret = i2d_PKCS8_bio(bp, p8);
147         else
148             ret = PEM_write_bio_PKCS8(bp, p8);
149         X509_SIG_free(p8);
150         return ret;
151     } else {
152         if (isder)
153             ret = i2d_PKCS8_PRIV_KEY_INFO_bio(bp, p8inf);
154         else
155             ret = PEM_write_bio_PKCS8_PRIV_KEY_INFO(bp, p8inf);
156         PKCS8_PRIV_KEY_INFO_free(p8inf);
157         return ret;
158     }
159 }
160
161 EVP_PKEY *d2i_PKCS8PrivateKey_bio(BIO *bp, EVP_PKEY **x, pem_password_cb *cb,
162                                   void *u)
163 {
164     PKCS8_PRIV_KEY_INFO *p8inf = NULL;
165     X509_SIG *p8 = NULL;
166     int klen;
167     EVP_PKEY *ret;
168     char psbuf[PEM_BUFSIZE];
169     p8 = d2i_PKCS8_bio(bp, NULL);
170     if (!p8)
171         return NULL;
172     if (cb)
173         klen = cb(psbuf, PEM_BUFSIZE, 0, u);
174     else
175         klen = PEM_def_callback(psbuf, PEM_BUFSIZE, 0, u);
176     if (klen <= 0) {
177         PEMerr(PEM_F_D2I_PKCS8PRIVATEKEY_BIO, PEM_R_BAD_PASSWORD_READ);
178         X509_SIG_free(p8);
179         return NULL;
180     }
181     p8inf = PKCS8_decrypt(p8, psbuf, klen);
182     X509_SIG_free(p8);
183     if (!p8inf)
184         return NULL;
185     ret = EVP_PKCS82PKEY(p8inf);
186     PKCS8_PRIV_KEY_INFO_free(p8inf);
187     if (!ret)
188         return NULL;
189     if (x) {
190         EVP_PKEY_free(*x);
191         *x = ret;
192     }
193     return ret;
194 }
195
196 #ifndef OPENSSL_NO_STDIO
197
198 int i2d_PKCS8PrivateKey_fp(FILE *fp, EVP_PKEY *x, const EVP_CIPHER *enc,
199                            char *kstr, int klen, pem_password_cb *cb, void *u)
200 {
201     return do_pk8pkey_fp(fp, x, 1, -1, enc, kstr, klen, cb, u);
202 }
203
204 int i2d_PKCS8PrivateKey_nid_fp(FILE *fp, EVP_PKEY *x, int nid,
205                                char *kstr, int klen,
206                                pem_password_cb *cb, void *u)
207 {
208     return do_pk8pkey_fp(fp, x, 1, nid, NULL, kstr, klen, cb, u);
209 }
210
211 int PEM_write_PKCS8PrivateKey_nid(FILE *fp, EVP_PKEY *x, int nid,
212                                   char *kstr, int klen,
213                                   pem_password_cb *cb, void *u)
214 {
215     return do_pk8pkey_fp(fp, x, 0, nid, NULL, kstr, klen, cb, u);
216 }
217
218 int PEM_write_PKCS8PrivateKey(FILE *fp, EVP_PKEY *x, const EVP_CIPHER *enc,
219                               char *kstr, int klen, pem_password_cb *cb,
220                               void *u)
221 {
222     return do_pk8pkey_fp(fp, x, 0, -1, enc, kstr, klen, cb, u);
223 }
224
225 static int do_pk8pkey_fp(FILE *fp, EVP_PKEY *x, int isder, int nid,
226                          const EVP_CIPHER *enc, char *kstr, int klen,
227                          pem_password_cb *cb, void *u)
228 {
229     BIO *bp;
230     int ret;
231
232     if ((bp = BIO_new_fp(fp, BIO_NOCLOSE)) == NULL) {
233         PEMerr(PEM_F_DO_PK8PKEY_FP, ERR_R_BUF_LIB);
234         return (0);
235     }
236     ret = do_pk8pkey(bp, x, isder, nid, enc, kstr, klen, cb, u);
237     BIO_free(bp);
238     return ret;
239 }
240
241 EVP_PKEY *d2i_PKCS8PrivateKey_fp(FILE *fp, EVP_PKEY **x, pem_password_cb *cb,
242                                  void *u)
243 {
244     BIO *bp;
245     EVP_PKEY *ret;
246
247     if ((bp = BIO_new_fp(fp, BIO_NOCLOSE)) == NULL) {
248         PEMerr(PEM_F_D2I_PKCS8PRIVATEKEY_FP, ERR_R_BUF_LIB);
249         return NULL;
250     }
251     ret = d2i_PKCS8PrivateKey_bio(bp, x, cb, u);
252     BIO_free(bp);
253     return ret;
254 }
255
256 #endif
257
258 IMPLEMENT_PEM_rw(PKCS8, X509_SIG, PEM_STRING_PKCS8, X509_SIG)
259
260
261 IMPLEMENT_PEM_rw(PKCS8_PRIV_KEY_INFO, PKCS8_PRIV_KEY_INFO, PEM_STRING_PKCS8INF,
262              PKCS8_PRIV_KEY_INFO)