doc/man1/openssl-dhparam.pod.in

   1 =pod
   2 {- OpenSSL::safe::output_do_not_edit_headers(); -}
   3
   4 =head1 NAME
   5
   6 openssl-dhparam - DH parameter manipulation and generation
   7
   8 =head1 SYNOPSIS
   9
  10 B<openssl dhparam>
  11 [B<-help>]
  12 [B<-inform> B<DER>|B<PEM>]
  13 [B<-outform> B<DER>|B<PEM>]
  14 [B<-in> I<filename>]
  15 [B<-out> I<filename>]
  16 [B<-dsaparam>]
  17 [B<-check>]
  18 [B<-noout>]
  19 [B<-text>]
  20 [B<-C>]
  21 [B<-2>]
  22 [B<-3>]
  23 [B<-5>]
  24 {- $OpenSSL::safe::opt_engine_synopsis -}
  25 {- $OpenSSL::safe::opt_r_synopsis -}
  26 {- $OpenSSL::safe::opt_provider_synopsis -}
  27 [I<numbits>]
  28
  29 =for openssl ifdef dsaparam engine
  30
  31 =head1 DESCRIPTION
  32
  33 This command is used to manipulate DH parameter files.
  34
  35 =head1 OPTIONS
  36
  37 =over 4
  38
  39 =item B<-help>
  40
  41 Print out a usage message.
  42
  43 =item B<-inform> B<DER>|B<PEM>, B<-outform> B<DER>|B<PEM>
  44
  45 The input format and output format; the default is B<PEM>.
  46 The object is compatible with the PKCS#3 B<DHparameter> structure.
  47 See L<openssl(1)/Format Options> for details.
  48
  49 =item B<-in> I<filename>
  50
  51 This specifies the input filename to read parameters from or standard input if
  52 this option is not specified.
  53
  54 =item B<-out> I<filename>
  55
  56 This specifies the output filename parameters to. Standard output is used
  57 if this option is not present. The output filename should B<not> be the same
  58 as the input filename.
  59
  60 =item B<-dsaparam>
  61
  62 This option is deprecated.
  63
  64 If this option is used, DSA rather than DH parameters are read or created;
  65 they are converted to DH format.  Otherwise, "strong" primes (such
  66 that (p-1)/2 is also prime) will be used for DH parameter generation.
  67
  68 DH parameter generation with the B<-dsaparam> option is much faster,
  69 and the recommended exponent length is shorter, which makes DH key
  70 exchange more efficient.  Beware that with such DSA-style DH
  71 parameters, a fresh DH key should be created for each use to
  72 avoid small-subgroup attacks that may be possible otherwise.
  73
  74 =item B<-check>
  75
  76 Performs numerous checks to see if the supplied parameters are valid and
  77 displays a warning if not.
  78
  79 =item B<-2>, B<-3>, B<-5>
  80
  81 The generator to use, either 2, 3 or 5. If present then the
  82 input file is ignored and parameters are generated instead. If not
  83 present but I<numbits> is present, parameters are generated with the
  84 default generator 2.
  85
  86 =item I<numbits>
  87
  88 This option specifies that a parameter set should be generated of size
  89 I<numbits>. It must be the last option. If this option is present then
  90 the input file is ignored and parameters are generated instead. If
  91 this option is not present but a generator (B<-2>, B<-3> or B<-5>) is
  92 present, parameters are generated with a default length of 2048 bits.
  93 The minimim length is 512 bits. The maximum length is 10000 bits.
  94
  95 =item B<-noout>
  96
  97 This option inhibits the output of the encoded version of the parameters.
  98
  99 =item B<-text>
 100
 101 This option prints out the DH parameters in human readable form.
 102
 103 =item B<-C>
 104
 105 This option converts the parameters into C code. The parameters can then
 106 be loaded by calling the get_dhNNNN() function.
 107
 108 {- $OpenSSL::safe::opt_engine_item -}
 109
 110 {- $OpenSSL::safe::opt_r_item -}
 111
 112 {- $OpenSSL::safe::opt_provider_item -}
 113
 114 =back
 115
 116 =head1 NOTES
 117
 118 This command replaces the B<dh> and B<gendh> commands of previous
 119 releases.
 120
 121 OpenSSL currently only supports the older PKCS#3 DH, not the newer X9.42
 122 DH.
 123
 124 This command manipulates DH parameters not keys.
 125
 126 =head1 BUGS
 127
 128 There should be a way to generate and manipulate DH keys.
 129
 130 =head1 SEE ALSO
 131
 132 L<openssl(1)>,
 133 L<openssl-pkeyparam(1)>,
 134 L<openssl-dsaparam(1)>
 135
 136 =head1 HISTORY
 137
 138 The B<-dsaparam> option was deprecated in OpenSSL 3.0.
 139
 140 =head1 COPYRIGHT
 141
 142 Copyright 2000-2020 The OpenSSL Project Authors. All Rights Reserved.
 143
 144 Licensed under the Apache License 2.0 (the "License").  You may not use
 145 this file except in compliance with the License.  You can obtain a copy
 146 in the file LICENSE in the source distribution or at
 147 L<https://www.openssl.org/source/license.html>.
 148
 149 =cut