doc/man1/openssl-dhparam.pod

   1 =pod
   2
   3 =head1 NAME
   4
   5 openssl-dhparam - DH parameter manipulation and generation
   6
   7 =head1 SYNOPSIS
   8
   9 B<openssl dhparam>
  10 [B<-help>]
  11 [B<-inform> B<DER>|B<PEM>]
  12 [B<-outform> B<DER>|B<PEM>]
  13 [B<-in> I<filename>]
  14 [B<-out> I<filename>]
  15 [B<-dsaparam>]
  16 [B<-check>]
  17 [B<-noout>]
  18 [B<-text>]
  19 [B<-C>]
  20 [B<-2>]
  21 [B<-3>]
  22 [B<-5>]
  23 [B<-rand> I<file...>]
  24 [B<-writerand> I<file>]
  25 [B<-engine> I<id>]
  26 [I<numbits>]
  27
  28 =for comment ifdef dsaparam engine
  29
  30 =head1 DESCRIPTION
  31
  32 This command is used to manipulate DH parameter files.
  33
  34 =head1 OPTIONS
  35
  36 =over 4
  37
  38 =item B<-help>
  39
  40 Print out a usage message.
  41
  42 =item B<-inform> B<DER>|B<PEM>
  43
  44 This specifies the input format. The B<DER> option uses an ASN1 DER encoded
  45 form compatible with the PKCS#3 DHparameter structure. The PEM form is the
  46 default format: it consists of the B<DER> format base64 encoded with
  47 additional header and footer lines.
  48
  49 =item B<-outform> B<DER>|B<PEM>
  50
  51 This specifies the output format, the options have the same meaning and default
  52 as the B<-inform> option.
  53
  54 =item B<-in> I<filename>
  55
  56 This specifies the input filename to read parameters from or standard input if
  57 this option is not specified.
  58
  59 =item B<-out> I<filename>
  60
  61 This specifies the output filename parameters to. Standard output is used
  62 if this option is not present. The output filename should B<not> be the same
  63 as the input filename.
  64
  65 =item B<-dsaparam>
  66
  67 If this option is used, DSA rather than DH parameters are read or created;
  68 they are converted to DH format.  Otherwise, "strong" primes (such
  69 that (p-1)/2 is also prime) will be used for DH parameter generation.
  70
  71 DH parameter generation with the B<-dsaparam> option is much faster,
  72 and the recommended exponent length is shorter, which makes DH key
  73 exchange more efficient.  Beware that with such DSA-style DH
  74 parameters, a fresh DH key should be created for each use to
  75 avoid small-subgroup attacks that may be possible otherwise.
  76
  77 =item B<-check>
  78
  79 Performs numerous checks to see if the supplied parameters are valid and
  80 displays a warning if not.
  81
  82 =item B<-2>, B<-3>, B<-5>
  83
  84 The generator to use, either 2, 3 or 5. If present then the
  85 input file is ignored and parameters are generated instead. If not
  86 present but B<numbits> is present, parameters are generated with the
  87 default generator 2.
  88
  89 =item B<-rand> I<file...>
  90
  91 A file or files containing random data used to seed the random number
  92 generator.
  93 Multiple files can be specified separated by an OS-dependent character.
  94 The separator is B<;> for MS-Windows, B<,> for OpenVMS, and B<:> for
  95 all others.
  96
  97 =item B<-writerand> I<file>
  98
  99 Writes random data to the specified I<file> upon exit.
 100 This can be used with a subsequent B<-rand> flag.
 101
 102 =item I<numbits>
 103
 104 This option specifies that a parameter set should be generated of size
 105 I<numbits>. It must be the last option. If this option is present then
 106 the input file is ignored and parameters are generated instead. If
 107 this option is not present but a generator (B<-2>, B<-3> or B<-5>) is
 108 present, parameters are generated with a default length of 2048 bits.
 109 The minimim length is 512 bits. The maximum length is 10000 bits.
 110
 111 =item B<-noout>
 112
 113 This option inhibits the output of the encoded version of the parameters.
 114
 115 =item B<-text>
 116
 117 This option prints out the DH parameters in human readable form.
 118
 119 =item B<-C>
 120
 121 This option converts the parameters into C code. The parameters can then
 122 be loaded by calling the get_dhNNNN() function.
 123
 124 =item B<-engine> I<id>
 125
 126 Specifying an engine (by its unique B<id> string) will cause B<dhparam>
 127 to attempt to obtain a functional reference to the specified engine,
 128 thus initialising it if needed. The engine will then be set as the default
 129 for all available algorithms.
 130
 131 =back
 132
 133 =head1 WARNINGS
 134
 135 The program B<dhparam> combines the functionality of the programs B<dh> and
 136 B<gendh> in previous versions of OpenSSL. The B<dh> and B<gendh>
 137 programs are retained for now but may have different purposes in future
 138 versions of OpenSSL.
 139
 140 =head1 NOTES
 141
 142 PEM format DH parameters use the header and footer lines:
 143
 144  -----BEGIN DH PARAMETERS-----
 145  -----END DH PARAMETERS-----
 146
 147 OpenSSL currently only supports the older PKCS#3 DH, not the newer X9.42
 148 DH.
 149
 150 This program manipulates DH parameters not keys.
 151
 152 =head1 BUGS
 153
 154 There should be a way to generate and manipulate DH keys.
 155
 156 =head1 SEE ALSO
 157
 158 L<openssl(1)>,
 159 L<openssl-dsaparam(1)>
 160
 161 =head1 COPYRIGHT
 162
 163 Copyright 2000-2019 The OpenSSL Project Authors. All Rights Reserved.
 164
 165 Licensed under the Apache License 2.0 (the "License").  You may not use
 166 this file except in compliance with the License.  You can obtain a copy
 167 in the file LICENSE in the source distribution or at
 168 L<https://www.openssl.org/source/license.html>.
 169
 170 =cut