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