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