apps/dhparam.c

   1 /*
   2  * Copyright 1995-2018 The OpenSSL Project Authors. All Rights Reserved.
   3  *
   4  * Licensed under the OpenSSL license (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
   8  */
   9
  10 #include <openssl/opensslconf.h>
  11 #ifdef OPENSSL_NO_DH
  12 NON_EMPTY_TRANSLATION_UNIT
  13 #else
  14
  15 # include <stdio.h>
  16 # include <stdlib.h>
  17 # include <time.h>
  18 # include <string.h>
  19 # include "apps.h"
  20 # include "progs.h"
  21 # include <openssl/bio.h>
  22 # include <openssl/err.h>
  23 # include <openssl/bn.h>
  24 # include <openssl/dh.h>
  25 # include <openssl/x509.h>
  26 # include <openssl/pem.h>
  27
  28 # ifndef OPENSSL_NO_DSA
  29 #  include <openssl/dsa.h>
  30 # endif
  31
  32 # define DEFBITS 2048
  33
  34 static int dh_cb(int p, int n, BN_GENCB *cb);
  35
  36 typedef enum OPTION_choice {
  37     OPT_ERR = -1, OPT_EOF = 0, OPT_HELP,
  38     OPT_INFORM, OPT_OUTFORM, OPT_IN, OPT_OUT,
  39     OPT_ENGINE, OPT_CHECK, OPT_TEXT, OPT_NOOUT,
  40     OPT_DSAPARAM, OPT_C, OPT_2, OPT_5,
  41     OPT_R_ENUM
  42 } OPTION_CHOICE;
  43
  44 const OPTIONS dhparam_options[] = {
  45     {OPT_HELP_STR, 1, '-', "Usage: %s [flags] [numbits]\n"},
  46     {OPT_HELP_STR, 1, '-', "Valid options are:\n"},
  47     {"help", OPT_HELP, '-', "Display this summary"},
  48     {"in", OPT_IN, '<', "Input file"},
  49     {"inform", OPT_INFORM, 'F', "Input format, DER or PEM"},
  50     {"outform", OPT_OUTFORM, 'F', "Output format, DER or PEM"},
  51     {"out", OPT_OUT, '>', "Output file"},
  52     {"check", OPT_CHECK, '-', "Check the DH parameters"},
  53     {"text", OPT_TEXT, '-', "Print a text form of the DH parameters"},
  54     {"noout", OPT_NOOUT, '-', "Don't output any DH parameters"},
  55     OPT_R_OPTIONS,
  56     {"C", OPT_C, '-', "Print C code"},
  57     {"2", OPT_2, '-', "Generate parameters using 2 as the generator value"},
  58     {"5", OPT_5, '-', "Generate parameters using 5 as the generator value"},
  59 # ifndef OPENSSL_NO_DSA
  60     {"dsaparam", OPT_DSAPARAM, '-',
  61      "Read or generate DSA parameters, convert to DH"},
  62 # endif
  63 # ifndef OPENSSL_NO_ENGINE
  64     {"engine", OPT_ENGINE, 's', "Use engine e, possibly a hardware device"},
  65 # endif
  66     {NULL}
  67 };
  68
  69 int dhparam_main(int argc, char **argv)
  70 {
  71     BIO *in = NULL, *out = NULL;
  72     DH *dh = NULL;
  73     char *infile = NULL, *outfile = NULL, *prog;
  74     ENGINE *e = NULL;
  75 #ifndef OPENSSL_NO_DSA
  76     int dsaparam = 0;
  77 #endif
  78     int i, text = 0, C = 0, ret = 1, num = 0, g = 0;
  79     int informat = FORMAT_PEM, outformat = FORMAT_PEM, check = 0, noout = 0;
  80     OPTION_CHOICE o;
  81
  82     prog = opt_init(argc, argv, dhparam_options);
  83     while ((o = opt_next()) != OPT_EOF) {
  84         switch (o) {
  85         case OPT_EOF:
  86         case OPT_ERR:
  87  opthelp:
  88             BIO_printf(bio_err, "%s: Use -help for summary.\n", prog);
  89             goto end;
  90         case OPT_HELP:
  91             opt_help(dhparam_options);
  92             ret = 0;
  93             goto end;
  94         case OPT_INFORM:
  95             if (!opt_format(opt_arg(), OPT_FMT_PEMDER, &informat))
  96                 goto opthelp;
  97             break;
  98         case OPT_OUTFORM:
  99             if (!opt_format(opt_arg(), OPT_FMT_PEMDER, &outformat))
 100                 goto opthelp;
 101             break;
 102         case OPT_IN:
 103             infile = opt_arg();
 104             break;
 105         case OPT_OUT:
 106             outfile = opt_arg();
 107             break;
 108         case OPT_ENGINE:
 109             e = setup_engine(opt_arg(), 0);
 110             break;
 111         case OPT_CHECK:
 112             check = 1;
 113             break;
 114         case OPT_TEXT:
 115             text = 1;
 116             break;
 117         case OPT_DSAPARAM:
 118 #ifndef OPENSSL_NO_DSA
 119             dsaparam = 1;
 120 #endif
 121             break;
 122         case OPT_C:
 123             C = 1;
 124             break;
 125         case OPT_2:
 126             g = 2;
 127             break;
 128         case OPT_5:
 129             g = 5;
 130             break;
 131         case OPT_NOOUT:
 132             noout = 1;
 133             break;
 134         case OPT_R_CASES:
 135             if (!opt_rand(o))
 136                 goto end;
 137             break;
 138         }
 139     }
 140     argc = opt_num_rest();
 141     argv = opt_rest();
 142
 143     if (argv[0] != NULL && (!opt_int(argv[0], &num) || num <= 0))
 144         goto end;
 145
 146     if (g && !num)
 147         num = DEFBITS;
 148
 149 # ifndef OPENSSL_NO_DSA
 150     if (dsaparam && g) {
 151         BIO_printf(bio_err,
 152                    "generator may not be chosen for DSA parameters\n");
 153         goto end;
 154     }
 155 # endif
 156     /* DH parameters */
 157     if (num && !g)
 158         g = 2;
 159
 160     if (num) {
 161
 162         BN_GENCB *cb;
 163         cb = BN_GENCB_new();
 164         if (cb == NULL) {
 165             ERR_print_errors(bio_err);
 166             goto end;
 167         }
 168
 169         BN_GENCB_set(cb, dh_cb, bio_err);
 170
 171 # ifndef OPENSSL_NO_DSA
 172         if (dsaparam) {
 173             DSA *dsa = DSA_new();
 174
 175             BIO_printf(bio_err,
 176                        "Generating DSA parameters, %d bit long prime\n", num);
 177             if (dsa == NULL
 178                 || !DSA_generate_parameters_ex(dsa, num, NULL, 0, NULL, NULL,
 179                                                cb)) {
 180                 DSA_free(dsa);
 181                 BN_GENCB_free(cb);
 182                 ERR_print_errors(bio_err);
 183                 goto end;
 184             }
 185
 186             dh = DSA_dup_DH(dsa);
 187             DSA_free(dsa);
 188             if (dh == NULL) {
 189                 BN_GENCB_free(cb);
 190                 ERR_print_errors(bio_err);
 191                 goto end;
 192             }
 193         } else
 194 # endif
 195         {
 196             dh = DH_new();
 197             BIO_printf(bio_err,
 198                        "Generating DH parameters, %d bit long safe prime, generator %d\n",
 199                        num, g);
 200             BIO_printf(bio_err, "This is going to take a long time\n");
 201             if (dh == NULL || !DH_generate_parameters_ex(dh, num, g, cb)) {
 202                 BN_GENCB_free(cb);
 203                 ERR_print_errors(bio_err);
 204                 goto end;
 205             }
 206         }
 207
 208         BN_GENCB_free(cb);
 209     } else {
 210
 211         in = bio_open_default(infile, 'r', informat);
 212         if (in == NULL)
 213             goto end;
 214
 215 # ifndef OPENSSL_NO_DSA
 216         if (dsaparam) {
 217             DSA *dsa;
 218
 219             if (informat == FORMAT_ASN1)
 220                 dsa = d2i_DSAparams_bio(in, NULL);
 221             else                /* informat == FORMAT_PEM */
 222                 dsa = PEM_read_bio_DSAparams(in, NULL, NULL, NULL);
 223
 224             if (dsa == NULL) {
 225                 BIO_printf(bio_err, "unable to load DSA parameters\n");
 226                 ERR_print_errors(bio_err);
 227                 goto end;
 228             }
 229
 230             dh = DSA_dup_DH(dsa);
 231             DSA_free(dsa);
 232             if (dh == NULL) {
 233                 ERR_print_errors(bio_err);
 234                 goto end;
 235             }
 236         } else
 237 # endif
 238         {
 239             if (informat == FORMAT_ASN1) {
 240                 /*
 241                  * We have no PEM header to determine what type of DH params it
 242                  * is. We'll just try both.
 243                  */
 244                 dh = d2i_DHparams_bio(in, NULL);
 245                 /* BIO_reset() returns 0 for success for file BIOs only!!! */
 246                 if (dh == NULL && BIO_reset(in) == 0)
 247                     dh = d2i_DHxparams_bio(in, NULL);
 248             } else {
 249                 /* informat == FORMAT_PEM */
 250                 dh = PEM_read_bio_DHparams(in, NULL, NULL, NULL);
 251             }
 252
 253             if (dh == NULL) {
 254                 BIO_printf(bio_err, "unable to load DH parameters\n");
 255                 ERR_print_errors(bio_err);
 256                 goto end;
 257             }
 258         }
 259
 260         /* dh != NULL */
 261     }
 262
 263     out = bio_open_default(outfile, 'w', outformat);
 264     if (out == NULL)
 265         goto end;
 266
 267     if (text) {
 268         DHparams_print(out, dh);
 269     }
 270
 271     if (check) {
 272         if (!DH_check(dh, &i)) {
 273             ERR_print_errors(bio_err);
 274             goto end;
 275         }
 276         if (i & DH_CHECK_P_NOT_PRIME)
 277             BIO_printf(bio_err, "WARNING: p value is not prime\n");
 278         if (i & DH_CHECK_P_NOT_SAFE_PRIME)
 279             BIO_printf(bio_err, "WARNING: p value is not a safe prime\n");
 280         if (i & DH_CHECK_Q_NOT_PRIME)
 281             BIO_printf(bio_err, "WARNING: q value is not a prime\n");
 282         if (i & DH_CHECK_INVALID_Q_VALUE)
 283             BIO_printf(bio_err, "WARNING: q value is invalid\n");
 284         if (i & DH_CHECK_INVALID_J_VALUE)
 285             BIO_printf(bio_err, "WARNING: j value is invalid\n");
 286         if (i & DH_UNABLE_TO_CHECK_GENERATOR)
 287             BIO_printf(bio_err,
 288                        "WARNING: unable to check the generator value\n");
 289         if (i & DH_NOT_SUITABLE_GENERATOR)
 290             BIO_printf(bio_err, "WARNING: the g value is not a generator\n");
 291         if (i == 0)
 292             BIO_printf(bio_err, "DH parameters appear to be ok.\n");
 293         if (num != 0 && i != 0) {
 294             /*
 295              * We have generated parameters but DH_check() indicates they are
 296              * invalid! This should never happen!
 297              */
 298             BIO_printf(bio_err, "ERROR: Invalid parameters generated\n");
 299             goto end;
 300         }
 301     }
 302     if (C) {
 303         unsigned char *data;
 304         int len, bits;
 305         const BIGNUM *pbn, *gbn;
 306
 307         len = DH_size(dh);
 308         bits = DH_bits(dh);
 309         DH_get0_pqg(dh, &pbn, NULL, &gbn);
 310         data = app_malloc(len, "print a BN");
 311         BIO_printf(out, "#ifndef HEADER_DH_H\n"
 312                         "# include <openssl/dh.h>\n"
 313                         "#endif\n"
 314                         "\n");
 315         BIO_printf(out, "DH *get_dh%d()\n{\n", bits);
 316         print_bignum_var(out, pbn, "dhp", bits, data);
 317         print_bignum_var(out, gbn, "dhg", bits, data);
 318         BIO_printf(out, "    DH *dh = DH_new();\n"
 319                         "    BIGNUM *dhp_bn, *dhg_bn;\n"
 320                         "\n"
 321                         "    if (dh == NULL)\n"
 322                         "        return NULL;\n");
 323         BIO_printf(out, "    dhp_bn = BN_bin2bn(dhp_%d, sizeof(dhp_%d), NULL);\n",
 324                    bits, bits);
 325         BIO_printf(out, "    dhg_bn = BN_bin2bn(dhg_%d, sizeof(dhg_%d), NULL);\n",
 326                    bits, bits);
 327         BIO_printf(out, "    if (dhp_bn == NULL || dhg_bn == NULL\n"
 328                         "            || !DH_set0_pqg(dh, dhp_bn, NULL, dhg_bn)) {\n"
 329                         "        DH_free(dh);\n"
 330                         "        BN_free(dhp_bn);\n"
 331                         "        BN_free(dhg_bn);\n"
 332                         "        return NULL;\n"
 333                         "    }\n");
 334         if (DH_get_length(dh) > 0)
 335             BIO_printf(out,
 336                         "    if (!DH_set_length(dh, %ld)) {\n"
 337                         "        DH_free(dh);\n"
 338                         "    }\n", DH_get_length(dh));
 339         BIO_printf(out, "    return dh;\n}\n");
 340         OPENSSL_free(data);
 341     }
 342
 343     if (!noout) {
 344         const BIGNUM *q;
 345         DH_get0_pqg(dh, NULL, &q, NULL);
 346         if (outformat == FORMAT_ASN1) {
 347             if (q != NULL)
 348                 i = i2d_DHxparams_bio(out, dh);
 349             else
 350                 i = i2d_DHparams_bio(out, dh);
 351         } else if (q != NULL) {
 352             i = PEM_write_bio_DHxparams(out, dh);
 353         } else {
 354             i = PEM_write_bio_DHparams(out, dh);
 355         }
 356         if (!i) {
 357             BIO_printf(bio_err, "unable to write DH parameters\n");
 358             ERR_print_errors(bio_err);
 359             goto end;
 360         }
 361     }
 362     ret = 0;
 363  end:
 364     BIO_free(in);
 365     BIO_free_all(out);
 366     DH_free(dh);
 367     release_engine(e);
 368     return ret;
 369 }
 370
 371 static int dh_cb(int p, int n, BN_GENCB *cb)
 372 {
 373     char c = '*';
 374
 375     if (p == 0)
 376         c = '.';
 377     if (p == 1)
 378         c = '+';
 379     if (p == 2)
 380         c = '*';
 381     if (p == 3)
 382         c = '\n';
 383     BIO_write(BN_GENCB_get_arg(cb), &c, 1);
 384     (void)BIO_flush(BN_GENCB_get_arg(cb));
 385     return 1;
 386 }
 387 #endif