GH408 follow-on: update buflen
[openssl.git] / apps / pkcs8.c
1 /*
2  * Written by Dr Stephen N Henson (steve@openssl.org) for the OpenSSL project
3  * 1999-2004.
4  */
5 /* ====================================================================
6  * Copyright (c) 1999 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 #include <stdio.h>
59 #include <stdlib.h>
60 #include <string.h>
61 #include "apps.h"
62 #include <openssl/pem.h>
63 #include <openssl/err.h>
64 #include <openssl/evp.h>
65 #include <openssl/pkcs12.h>
66
67 typedef enum OPTION_choice {
68     OPT_ERR = -1, OPT_EOF = 0, OPT_HELP,
69     OPT_INFORM, OPT_OUTFORM, OPT_ENGINE, OPT_IN, OPT_OUT,
70     OPT_TOPK8, OPT_NOITER, OPT_NOCRYPT, OPT_NOOCT, OPT_NSDB, OPT_EMBED,
71 #ifndef OPENSSL_NO_SCRYPT
72     OPT_SCRYPT, OPT_SCRYPT_N, OPT_SCRYPT_R, OPT_SCRYPT_P,
73 #endif
74     OPT_V2, OPT_V1, OPT_V2PRF, OPT_ITER, OPT_PASSIN, OPT_PASSOUT
75 } OPTION_CHOICE;
76
77 OPTIONS pkcs8_options[] = {
78     {"help", OPT_HELP, '-', "Display this summary"},
79     {"inform", OPT_INFORM, 'F', "Input format (DER or PEM)"},
80     {"outform", OPT_OUTFORM, 'F', "Output format (DER or PEM)"},
81     {"in", OPT_IN, '<', "Input file"},
82     {"out", OPT_OUT, '>', "Output file"},
83     {"topk8", OPT_TOPK8, '-', "Output PKCS8 file"},
84     {"noiter", OPT_NOITER, '-', "Use 1 as iteration count"},
85     {"nocrypt", OPT_NOCRYPT, '-', "Use or expect unencrypted private key"},
86     {"nooct", OPT_NOOCT, '-', "Use (nonstandard) no octet format"},
87     {"nsdb", OPT_NSDB, '-', "Use (nonstandard) DSA Netscape DB format"},
88     {"embed", OPT_EMBED, '-',
89      "Use (nonstandard) embedded DSA parameters format"},
90     {"v2", OPT_V2, 's', "Use PKCS#5 v2.0 and cipher"},
91     {"v1", OPT_V1, 's', "Use PKCS#5 v1.5 and cipher"},
92     {"v2prf", OPT_V2PRF, 's'},
93     {"iter", OPT_ITER, 'p', "Specify the iteration count"},
94     {"passin", OPT_PASSIN, 's', "Input file pass phrase source"},
95     {"passout", OPT_PASSOUT, 's', "Output file pass phrase source"},
96 #ifndef OPENSSL_NO_ENGINE
97     {"engine", OPT_ENGINE, 's', "Use engine, possibly a hardware device"},
98 #endif
99 #ifndef OPENSSL_NO_SCRYPT
100     {"scrypt", OPT_SCRYPT, '-', "Use scrypt algorithm"},
101     {"scrypt_N", OPT_SCRYPT_N, 's', "Set scrypt N parameter"},
102     {"scrypt_r", OPT_SCRYPT_R, 's', "Set scrypt r parameter"},
103     {"scrypt_p", OPT_SCRYPT_P, 's', "Set scrypt p parameter"},
104 #endif
105     {NULL}
106 };
107
108 int pkcs8_main(int argc, char **argv)
109 {
110     BIO *in = NULL, *out = NULL;
111     ENGINE *e = NULL;
112     EVP_PKEY *pkey = NULL;
113     PKCS8_PRIV_KEY_INFO *p8inf = NULL;
114     X509_SIG *p8 = NULL;
115     const EVP_CIPHER *cipher = NULL;
116     char *infile = NULL, *outfile = NULL;
117     char *passinarg = NULL, *passoutarg = NULL, *prog;
118     char pass[50], *passin = NULL, *passout = NULL, *p8pass = NULL;
119     OPTION_CHOICE o;
120     int nocrypt = 0, ret = 1, iter = PKCS12_DEFAULT_ITER, p8_broken = PKCS8_OK;
121     int informat = FORMAT_PEM, outformat = FORMAT_PEM, topk8 = 0, pbe_nid = -1;
122     int private = 0;
123 #ifndef OPENSSL_NO_SCRYPT
124     unsigned long scrypt_N = 0, scrypt_r = 0, scrypt_p = 0;
125 #endif
126
127     prog = opt_init(argc, argv, pkcs8_options);
128     while ((o = opt_next()) != OPT_EOF) {
129         switch (o) {
130         case OPT_EOF:
131         case OPT_ERR:
132  opthelp:
133             BIO_printf(bio_err, "%s: Use -help for summary.\n", prog);
134             goto end;
135         case OPT_HELP:
136             opt_help(pkcs8_options);
137             ret = 0;
138             goto end;
139         case OPT_INFORM:
140             if (!opt_format(opt_arg(), OPT_FMT_PEMDER, &informat))
141                 goto opthelp;
142             break;
143         case OPT_IN:
144             infile = opt_arg();
145             break;
146         case OPT_OUTFORM:
147             if (!opt_format(opt_arg(), OPT_FMT_PEMDER, &outformat))
148                 goto opthelp;
149             break;
150         case OPT_OUT:
151             outfile = opt_arg();
152             break;
153         case OPT_TOPK8:
154             topk8 = 1;
155             break;
156         case OPT_NOITER:
157             iter = 1;
158             break;
159         case OPT_NOCRYPT:
160             nocrypt = 1;
161             break;
162         case OPT_NOOCT:
163             p8_broken = PKCS8_NO_OCTET;
164             break;
165         case OPT_NSDB:
166             p8_broken = PKCS8_NS_DB;
167             break;
168         case OPT_EMBED:
169             p8_broken = PKCS8_EMBEDDED_PARAM;
170             break;
171         case OPT_V2:
172             if (!opt_cipher(opt_arg(), &cipher))
173                 goto opthelp;
174             break;
175         case OPT_V1:
176             pbe_nid = OBJ_txt2nid(opt_arg());
177             if (pbe_nid == NID_undef) {
178                 BIO_printf(bio_err,
179                            "%s: Unknown PBE algorithm %s\n", prog, opt_arg());
180                 goto opthelp;
181             }
182             break;
183         case OPT_V2PRF:
184             pbe_nid = OBJ_txt2nid(opt_arg());
185             if (!EVP_PBE_find(EVP_PBE_TYPE_PRF, pbe_nid, NULL, NULL, 0)) {
186                 BIO_printf(bio_err,
187                            "%s: Unknown PRF algorithm %s\n", prog, opt_arg());
188                 goto opthelp;
189             }
190             break;
191         case OPT_ITER:
192             if (!opt_int(opt_arg(), &iter))
193                 goto opthelp;
194             break;
195         case OPT_PASSIN:
196             passinarg = opt_arg();
197             break;
198         case OPT_PASSOUT:
199             passoutarg = opt_arg();
200             break;
201         case OPT_ENGINE:
202             e = setup_engine(opt_arg(), 0);
203             break;
204 #ifndef OPENSSL_NO_SCRYPT
205         case OPT_SCRYPT:
206             scrypt_N = 1024;
207             scrypt_r = 8;
208             scrypt_p = 16;
209             if (cipher == NULL)
210                 cipher = EVP_aes_256_cbc();
211             break;
212         case OPT_SCRYPT_N:
213             if (!opt_ulong(opt_arg(), &scrypt_N))
214                 goto opthelp;
215             break;
216         case OPT_SCRYPT_R:
217             if (!opt_ulong(opt_arg(), &scrypt_r))
218                 goto opthelp;
219             break;
220         case OPT_SCRYPT_P:
221             if (!opt_ulong(opt_arg(), &scrypt_p))
222                 goto opthelp;
223             break;
224 #endif
225         }
226     }
227     argc = opt_num_rest();
228     argv = opt_rest();
229     private = 1;
230
231     if (!app_passwd(passinarg, passoutarg, &passin, &passout)) {
232         BIO_printf(bio_err, "Error getting passwords\n");
233         goto end;
234     }
235
236     if (!app_load_modules(NULL))
237         goto end;
238
239     if ((pbe_nid == -1) && !cipher)
240         pbe_nid = NID_pbeWithMD5AndDES_CBC;
241
242     in = bio_open_default(infile, 'r', informat);
243     if (in == NULL)
244         goto end;
245     out = bio_open_owner(outfile, outformat, private);
246     if (out == NULL)
247         goto end;
248
249     if (topk8) {
250         pkey = load_key(infile, informat, 1, passin, e, "key");
251         if (!pkey)
252             goto end;
253         if ((p8inf = EVP_PKEY2PKCS8_broken(pkey, p8_broken)) == NULL) {
254             BIO_printf(bio_err, "Error converting key\n");
255             ERR_print_errors(bio_err);
256             goto end;
257         }
258         if (nocrypt) {
259             assert(private);
260             if (outformat == FORMAT_PEM)
261                 PEM_write_bio_PKCS8_PRIV_KEY_INFO(out, p8inf);
262             else if (outformat == FORMAT_ASN1)
263                 i2d_PKCS8_PRIV_KEY_INFO_bio(out, p8inf);
264             else {
265                 BIO_printf(bio_err, "Bad format specified for key\n");
266                 goto end;
267             }
268         } else {
269             X509_ALGOR *pbe;
270             if (cipher) {
271 #ifndef OPENSSL_NO_SCRYPT
272                 if (scrypt_N && scrypt_r && scrypt_p)
273                     pbe = PKCS5_pbe2_set_scrypt(cipher, NULL, 0, NULL,
274                                                 scrypt_N, scrypt_r, scrypt_p);
275                 else
276 #endif
277                     pbe = PKCS5_pbe2_set_iv(cipher, iter, NULL, 0, NULL,
278                                             pbe_nid);
279             } else {
280                 pbe = PKCS5_pbe_set(pbe_nid, iter, NULL, 0);
281             }
282             if (pbe == NULL) {
283                 BIO_printf(bio_err, "Error setting PBE algorithm\n");
284                 ERR_print_errors(bio_err);
285                 goto end;
286             }
287             if (passout)
288                 p8pass = passout;
289             else {
290                 p8pass = pass;
291                 if (EVP_read_pw_string
292                     (pass, sizeof pass, "Enter Encryption Password:", 1)) {
293                     X509_ALGOR_free(pbe);
294                     goto end;
295                 }
296             }
297             app_RAND_load_file(NULL, 0);
298             p8 = PKCS8_set0_pbe(p8pass, strlen(p8pass), p8inf, pbe);
299             if (p8 == NULL) {
300                 X509_ALGOR_free(pbe);
301                 BIO_printf(bio_err, "Error encrypting key\n");
302                 ERR_print_errors(bio_err);
303                 goto end;
304             }
305             app_RAND_write_file(NULL);
306             assert(private);
307             if (outformat == FORMAT_PEM)
308                 PEM_write_bio_PKCS8(out, p8);
309             else if (outformat == FORMAT_ASN1)
310                 i2d_PKCS8_bio(out, p8);
311             else {
312                 BIO_printf(bio_err, "Bad format specified for key\n");
313                 goto end;
314             }
315         }
316
317         ret = 0;
318         goto end;
319     }
320
321     if (nocrypt) {
322         if (informat == FORMAT_PEM)
323             p8inf = PEM_read_bio_PKCS8_PRIV_KEY_INFO(in, NULL, NULL, NULL);
324         else if (informat == FORMAT_ASN1)
325             p8inf = d2i_PKCS8_PRIV_KEY_INFO_bio(in, NULL);
326         else {
327             BIO_printf(bio_err, "Bad format specified for key\n");
328             goto end;
329         }
330     } else {
331         if (informat == FORMAT_PEM)
332             p8 = PEM_read_bio_PKCS8(in, NULL, NULL, NULL);
333         else if (informat == FORMAT_ASN1)
334             p8 = d2i_PKCS8_bio(in, NULL);
335         else {
336             BIO_printf(bio_err, "Bad format specified for key\n");
337             goto end;
338         }
339
340         if (!p8) {
341             BIO_printf(bio_err, "Error reading key\n");
342             ERR_print_errors(bio_err);
343             goto end;
344         }
345         if (passin)
346             p8pass = passin;
347         else {
348             p8pass = pass;
349             EVP_read_pw_string(pass, sizeof pass, "Enter Password:", 0);
350         }
351         p8inf = PKCS8_decrypt(p8, p8pass, strlen(p8pass));
352     }
353
354     if (!p8inf) {
355         BIO_printf(bio_err, "Error decrypting key\n");
356         ERR_print_errors(bio_err);
357         goto end;
358     }
359
360     if ((pkey = EVP_PKCS82PKEY(p8inf)) == NULL) {
361         BIO_printf(bio_err, "Error converting key\n");
362         ERR_print_errors(bio_err);
363         goto end;
364     }
365
366     if (p8inf->broken) {
367         BIO_printf(bio_err, "Warning: broken key encoding: ");
368         switch (p8inf->broken) {
369         case PKCS8_NO_OCTET:
370             BIO_printf(bio_err, "No Octet String in PrivateKey\n");
371             break;
372
373         case PKCS8_EMBEDDED_PARAM:
374             BIO_printf(bio_err, "DSA parameters included in PrivateKey\n");
375             break;
376
377         case PKCS8_NS_DB:
378             BIO_printf(bio_err, "DSA public key include in PrivateKey\n");
379             break;
380
381         case PKCS8_NEG_PRIVKEY:
382             BIO_printf(bio_err, "DSA private key value is negative\n");
383             break;
384
385         default:
386             BIO_printf(bio_err, "Unknown broken type\n");
387             break;
388         }
389     }
390
391     assert(private);
392     if (outformat == FORMAT_PEM)
393         PEM_write_bio_PrivateKey(out, pkey, NULL, NULL, 0, NULL, passout);
394     else if (outformat == FORMAT_ASN1)
395         i2d_PrivateKey_bio(out, pkey);
396     else {
397         BIO_printf(bio_err, "Bad format specified for key\n");
398         goto end;
399     }
400     ret = 0;
401
402  end:
403     X509_SIG_free(p8);
404     PKCS8_PRIV_KEY_INFO_free(p8inf);
405     EVP_PKEY_free(pkey);
406     BIO_free_all(out);
407     BIO_free(in);
408     OPENSSL_free(passin);
409     OPENSSL_free(passout);
410
411     return ret;
412 }