openssl-dhparam.pod.in 3.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136
  1. =pod
  2. {- OpenSSL::safe::output_do_not_edit_headers(); -}
  3. =head1 NAME
  4. openssl-dhparam - DH parameter manipulation and generation
  5. =head1 SYNOPSIS
  6. B<openssl dhparam>
  7. [B<-help>]
  8. [B<-inform> B<DER>|B<PEM>]
  9. [B<-outform> B<DER>|B<PEM>]
  10. [B<-in> I<filename>]
  11. [B<-out> I<filename>]
  12. [B<-dsaparam>]
  13. [B<-check>]
  14. [B<-noout>]
  15. [B<-text>]
  16. [B<-2>]
  17. [B<-3>]
  18. [B<-5>]
  19. {- $OpenSSL::safe::opt_engine_synopsis -}{- $OpenSSL::safe::opt_r_synopsis -}
  20. {- $OpenSSL::safe::opt_provider_synopsis -}
  21. [I<numbits>]
  22. =head1 DESCRIPTION
  23. This command is used to manipulate DH parameter files.
  24. See L<openssl-genpkey(1)/EXAMPLES> for examples on how to generate
  25. a key using a named safe prime group without generating intermediate
  26. parameters.
  27. =head1 OPTIONS
  28. =over 4
  29. =item B<-help>
  30. Print out a usage message.
  31. =item B<-inform> B<DER>|B<PEM>, B<-outform> B<DER>|B<PEM>
  32. The input format and output format; the default is B<PEM>.
  33. The object is compatible with the PKCS#3 B<DHparameter> structure.
  34. See L<openssl-format-options(1)> for details.
  35. =item B<-in> I<filename>
  36. This specifies the input filename to read parameters from or standard input if
  37. this option is not specified.
  38. =item B<-out> I<filename>
  39. This specifies the output filename parameters to. Standard output is used
  40. if this option is not present. The output filename should B<not> be the same
  41. as the input filename.
  42. =item B<-dsaparam>
  43. If this option is used, DSA rather than DH parameters are read or created;
  44. they are converted to DH format. Otherwise, "strong" primes (such
  45. that (p-1)/2 is also prime) will be used for DH parameter generation.
  46. DH parameter generation with the B<-dsaparam> option is much faster,
  47. and the recommended exponent length is shorter, which makes DH key
  48. exchange more efficient. Beware that with such DSA-style DH
  49. parameters, a fresh DH key should be created for each use to
  50. avoid small-subgroup attacks that may be possible otherwise.
  51. =item B<-check>
  52. Performs numerous checks to see if the supplied parameters are valid and
  53. displays a warning if not.
  54. =item B<-2>, B<-3>, B<-5>
  55. The generator to use, either 2, 3 or 5. If present then the
  56. input file is ignored and parameters are generated instead. If not
  57. present but I<numbits> is present, parameters are generated with the
  58. default generator 2.
  59. =item I<numbits>
  60. This option specifies that a parameter set should be generated of size
  61. I<numbits>. It must be the last option. If this option is present then
  62. the input file is ignored and parameters are generated instead. If
  63. this option is not present but a generator (B<-2>, B<-3> or B<-5>) is
  64. present, parameters are generated with a default length of 2048 bits.
  65. The minimim length is 512 bits. The maximum length is 10000 bits.
  66. =item B<-noout>
  67. This option inhibits the output of the encoded version of the parameters.
  68. =item B<-text>
  69. This option prints out the DH parameters in human readable form.
  70. {- $OpenSSL::safe::opt_engine_item -}
  71. {- $OpenSSL::safe::opt_r_item -}
  72. {- $OpenSSL::safe::opt_provider_item -}
  73. =back
  74. =head1 NOTES
  75. This command replaces the B<dh> and B<gendh> commands of previous
  76. releases.
  77. =head1 SEE ALSO
  78. L<openssl(1)>,
  79. L<openssl-pkeyparam(1)>,
  80. L<openssl-dsaparam(1)>,
  81. L<openssl-genpkey(1)>.
  82. =head1 HISTORY
  83. The B<-engine> option was deprecated in OpenSSL 3.0.
  84. The B<-C> option was removed in OpenSSL 3.0.
  85. =head1 COPYRIGHT
  86. Copyright 2000-2021 The OpenSSL Project Authors. All Rights Reserved.
  87. Licensed under the Apache License 2.0 (the "License"). You may not use
  88. this file except in compliance with the License. You can obtain a copy
  89. in the file LICENSE in the source distribution or at
  90. L<https://www.openssl.org/source/license.html>.
  91. =cut