apps/dhparam.c

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