2 * Copyright 1999-2021 The OpenSSL Project Authors. All Rights Reserved.
4 * Licensed under the Apache License 2.0 (the "License"). You may not use
5 * this file except in compliance with the License. You can obtain a copy
6 * in the file LICENSE in the source distribution or at
7 * https://www.openssl.org/source/license.html
15 #include <openssl/pem.h>
16 #include <openssl/err.h>
17 #include <openssl/evp.h>
18 #include <openssl/pkcs12.h>
20 typedef enum OPTION_choice {
22 OPT_INFORM, OPT_OUTFORM, OPT_ENGINE, OPT_IN, OPT_OUT,
23 OPT_TOPK8, OPT_NOITER, OPT_NOCRYPT,
24 #ifndef OPENSSL_NO_SCRYPT
25 OPT_SCRYPT, OPT_SCRYPT_N, OPT_SCRYPT_R, OPT_SCRYPT_P,
27 OPT_V2, OPT_V1, OPT_V2PRF, OPT_ITER, OPT_PASSIN, OPT_PASSOUT,
29 OPT_R_ENUM, OPT_PROV_ENUM
32 const OPTIONS pkcs8_options[] = {
33 OPT_SECTION("General"),
34 {"help", OPT_HELP, '-', "Display this summary"},
35 #ifndef OPENSSL_NO_ENGINE
36 {"engine", OPT_ENGINE, 's', "Use engine, possibly a hardware device"},
38 {"v1", OPT_V1, 's', "Use PKCS#5 v1.5 and cipher"},
39 {"v2", OPT_V2, 's', "Use PKCS#5 v2.0 and cipher"},
40 {"v2prf", OPT_V2PRF, 's', "Set the PRF algorithm to use with PKCS#5 v2.0"},
43 {"in", OPT_IN, '<', "Input file"},
44 {"inform", OPT_INFORM, 'F', "Input format (DER or PEM)"},
45 {"passin", OPT_PASSIN, 's', "Input file pass phrase source"},
46 {"nocrypt", OPT_NOCRYPT, '-', "Use or expect unencrypted private key"},
48 OPT_SECTION("Output"),
49 {"out", OPT_OUT, '>', "Output file"},
50 {"outform", OPT_OUTFORM, 'F', "Output format (DER or PEM)"},
51 {"topk8", OPT_TOPK8, '-', "Output PKCS8 file"},
52 {"passout", OPT_PASSOUT, 's', "Output file pass phrase source"},
53 {"traditional", OPT_TRADITIONAL, '-', "use traditional format private key"},
54 {"iter", OPT_ITER, 'p', "Specify the iteration count"},
55 {"noiter", OPT_NOITER, '-', "Use 1 as iteration count"},
57 #ifndef OPENSSL_NO_SCRYPT
58 OPT_SECTION("Scrypt"),
59 {"scrypt", OPT_SCRYPT, '-', "Use scrypt algorithm"},
60 {"scrypt_N", OPT_SCRYPT_N, 's', "Set scrypt N parameter"},
61 {"scrypt_r", OPT_SCRYPT_R, 's', "Set scrypt r parameter"},
62 {"scrypt_p", OPT_SCRYPT_P, 's', "Set scrypt p parameter"},
70 int pkcs8_main(int argc, char **argv)
72 BIO *in = NULL, *out = NULL;
74 EVP_PKEY *pkey = NULL;
75 PKCS8_PRIV_KEY_INFO *p8inf = NULL;
77 EVP_CIPHER *cipher = NULL;
78 char *infile = NULL, *outfile = NULL, *ciphername = NULL;
79 char *passinarg = NULL, *passoutarg = NULL, *prog;
80 #ifndef OPENSSL_NO_UI_CONSOLE
81 char pass[APP_PASS_LEN];
83 char *passin = NULL, *passout = NULL, *p8pass = NULL;
85 int nocrypt = 0, ret = 1, iter = PKCS12_DEFAULT_ITER;
86 int informat = FORMAT_UNDEF, outformat = FORMAT_PEM, topk8 = 0, pbe_nid = -1;
87 int private = 0, traditional = 0;
88 #ifndef OPENSSL_NO_SCRYPT
89 long scrypt_N = 0, scrypt_r = 0, scrypt_p = 0;
92 prog = opt_init(argc, argv, pkcs8_options);
93 while ((o = opt_next()) != OPT_EOF) {
98 BIO_printf(bio_err, "%s: Use -help for summary.\n", prog);
101 opt_help(pkcs8_options);
105 if (!opt_format(opt_arg(), OPT_FMT_PEMDER, &informat))
112 if (!opt_format(opt_arg(), OPT_FMT_PEMDER, &outformat))
132 if (!opt_provider(o))
135 case OPT_TRADITIONAL:
139 ciphername = opt_arg();
142 pbe_nid = OBJ_txt2nid(opt_arg());
143 if (pbe_nid == NID_undef) {
145 "%s: Unknown PBE algorithm %s\n", prog, opt_arg());
150 pbe_nid = OBJ_txt2nid(opt_arg());
151 if (!EVP_PBE_find(EVP_PBE_TYPE_PRF, pbe_nid, NULL, NULL, 0)) {
153 "%s: Unknown PRF algorithm %s\n", prog, opt_arg());
157 cipher = (EVP_CIPHER *)EVP_aes_256_cbc();
160 iter = opt_int_arg();
163 passinarg = opt_arg();
166 passoutarg = opt_arg();
169 e = setup_engine(opt_arg(), 0);
171 #ifndef OPENSSL_NO_SCRYPT
177 cipher = (EVP_CIPHER *)EVP_aes_256_cbc();
180 if (!opt_long(opt_arg(), &scrypt_N) || scrypt_N <= 0)
184 if (!opt_long(opt_arg(), &scrypt_r) || scrypt_r <= 0)
188 if (!opt_long(opt_arg(), &scrypt_p) || scrypt_p <= 0)
195 /* No extra arguments. */
196 argc = opt_num_rest();
201 if (!app_RAND_load())
204 if (ciphername != NULL) {
205 if (!opt_cipher(ciphername, &cipher))
209 if (!app_passwd(passinarg, passoutarg, &passin, &passout)) {
210 BIO_printf(bio_err, "Error getting passwords\n");
214 if ((pbe_nid == -1) && cipher == NULL)
215 cipher = (EVP_CIPHER *)EVP_aes_256_cbc();
217 in = bio_open_default(infile, 'r',
218 informat == FORMAT_UNDEF ? FORMAT_PEM : informat);
221 out = bio_open_owner(outfile, outformat, private);
226 pkey = load_key(infile, informat, 1, passin, e, "key");
229 if ((p8inf = EVP_PKEY2PKCS8(pkey)) == NULL) {
230 BIO_printf(bio_err, "Error converting key\n");
231 ERR_print_errors(bio_err);
236 if (outformat == FORMAT_PEM) {
237 PEM_write_bio_PKCS8_PRIV_KEY_INFO(out, p8inf);
238 } else if (outformat == FORMAT_ASN1) {
239 i2d_PKCS8_PRIV_KEY_INFO_bio(out, p8inf);
241 BIO_printf(bio_err, "Bad format specified for key\n");
247 #ifndef OPENSSL_NO_SCRYPT
248 if (scrypt_N && scrypt_r && scrypt_p)
249 pbe = PKCS5_pbe2_set_scrypt(cipher, NULL, 0, NULL,
250 scrypt_N, scrypt_r, scrypt_p);
253 pbe = PKCS5_pbe2_set_iv(cipher, iter, NULL, 0, NULL,
256 pbe = PKCS5_pbe_set(pbe_nid, iter, NULL, 0);
259 BIO_printf(bio_err, "Error setting PBE algorithm\n");
260 ERR_print_errors(bio_err);
263 if (passout != NULL) {
266 /* To avoid bit rot */
267 #ifndef OPENSSL_NO_UI_CONSOLE
269 if (EVP_read_pw_string
270 (pass, sizeof(pass), "Enter Encryption Password:", 1)) {
271 X509_ALGOR_free(pbe);
276 BIO_printf(bio_err, "Password required\n");
279 p8 = PKCS8_set0_pbe(p8pass, strlen(p8pass), p8inf, pbe);
281 X509_ALGOR_free(pbe);
282 BIO_printf(bio_err, "Error encrypting key\n");
283 ERR_print_errors(bio_err);
287 if (outformat == FORMAT_PEM)
288 PEM_write_bio_PKCS8(out, p8);
289 else if (outformat == FORMAT_ASN1)
290 i2d_PKCS8_bio(out, p8);
292 BIO_printf(bio_err, "Bad format specified for key\n");
302 if (informat == FORMAT_PEM || informat == FORMAT_UNDEF) {
303 p8inf = PEM_read_bio_PKCS8_PRIV_KEY_INFO(in, NULL, NULL, NULL);
304 } else if (informat == FORMAT_ASN1) {
305 p8inf = d2i_PKCS8_PRIV_KEY_INFO_bio(in, NULL);
307 BIO_printf(bio_err, "Bad format specified for key\n");
311 if (informat == FORMAT_PEM || informat == FORMAT_UNDEF) {
312 p8 = PEM_read_bio_PKCS8(in, NULL, NULL, NULL);
313 } else if (informat == FORMAT_ASN1) {
314 p8 = d2i_PKCS8_bio(in, NULL);
316 BIO_printf(bio_err, "Bad format specified for key\n");
321 BIO_printf(bio_err, "Error reading key\n");
322 ERR_print_errors(bio_err);
325 if (passin != NULL) {
328 #ifndef OPENSSL_NO_UI_CONSOLE
330 if (EVP_read_pw_string(pass, sizeof(pass), "Enter Password:", 0)) {
331 BIO_printf(bio_err, "Can't read Password\n");
336 BIO_printf(bio_err, "Password required\n");
339 p8inf = PKCS8_decrypt(p8, p8pass, strlen(p8pass));
343 BIO_printf(bio_err, "Error decrypting key\n");
344 ERR_print_errors(bio_err);
348 if ((pkey = EVP_PKCS82PKEY(p8inf)) == NULL) {
349 BIO_printf(bio_err, "Error converting key\n");
350 ERR_print_errors(bio_err);
355 if (outformat == FORMAT_PEM) {
357 PEM_write_bio_PrivateKey_traditional(out, pkey, NULL, NULL, 0,
360 PEM_write_bio_PrivateKey(out, pkey, NULL, NULL, 0, NULL, passout);
361 } else if (outformat == FORMAT_ASN1) {
362 i2d_PrivateKey_bio(out, pkey);
364 BIO_printf(bio_err, "Bad format specified for key\n");
371 PKCS8_PRIV_KEY_INFO_free(p8inf);
373 EVP_CIPHER_free(cipher);
377 OPENSSL_free(passin);
378 OPENSSL_free(passout);