openssl-dsaparam.pod.in 3.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133
  1. =pod
  2. {- OpenSSL::safe::output_do_not_edit_headers(); -}
  3. =head1 NAME
  4. openssl-dsaparam - DSA parameter manipulation and generation
  5. =head1 SYNOPSIS
  6. B<openssl dsaparam>
  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<-noout>]
  13. [B<-text>]
  14. [B<-genkey>]
  15. [B<-verbose>]
  16. [B<-quiet>]
  17. {- $OpenSSL::safe::opt_r_synopsis -}
  18. {- $OpenSSL::safe::opt_engine_synopsis -}{- $OpenSSL::safe::opt_provider_synopsis -}
  19. [I<numbits>]
  20. [I<numqbits>]
  21. =head1 DESCRIPTION
  22. This command is used to manipulate or generate DSA parameter files.
  23. DSA parameter generation can be a slow process and as a result the same set of
  24. DSA parameters is often used to generate several distinct keys.
  25. =head1 OPTIONS
  26. =over 4
  27. =item B<-help>
  28. Print out a usage message.
  29. =item B<-inform> B<DER>|B<PEM>
  30. The DSA parameters input format; unspecified by default.
  31. See L<openssl-format-options(1)> for details.
  32. =item B<-outform> B<DER>|B<PEM>
  33. The DSA parameters output format; the default is B<PEM>.
  34. See L<openssl-format-options(1)> for details.
  35. Parameters are a sequence of B<ASN.1 INTEGER>s: B<p>, B<q>, and B<g>.
  36. This is compatible with RFC 2459 B<DSS-Parms> structure.
  37. =item B<-in> I<filename>
  38. This specifies the input filename to read parameters from or standard input if
  39. this option is not specified. If the I<numbits> parameter is included then
  40. this option will be ignored.
  41. =item B<-out> I<filename>
  42. This specifies the output filename parameters to. Standard output is used
  43. if this option is not present. The output filename should B<not> be the same
  44. as the input filename.
  45. =item B<-noout>
  46. This option inhibits the output of the encoded version of the parameters.
  47. =item B<-text>
  48. This option prints out the DSA parameters in human readable form.
  49. =item B<-genkey>
  50. This option will generate a DSA either using the specified or generated
  51. parameters.
  52. =item B<-verbose>
  53. Print extra details about the operations being performed.
  54. =item B<-quiet>
  55. Print fewer details about the operations being performed, which may
  56. be handy during batch scripts and pipelines.
  57. {- $OpenSSL::safe::opt_r_item -}
  58. {- $OpenSSL::safe::opt_engine_item -}
  59. =item I<numbits>
  60. This optional argument specifies that a parameter set should be generated of
  61. size I<numbits>. If this argument is included then the input file (if any) is
  62. ignored.
  63. =item I<numqbits>
  64. This optional argument specifies that a parameter set should be generated with
  65. a subprime parameter q of size I<numqbits>. It must be the last argument. If
  66. this argument is included then the input file (if any) is ignored.
  67. {- $OpenSSL::safe::opt_provider_item -}
  68. =back
  69. =head1 SEE ALSO
  70. L<openssl(1)>,
  71. L<openssl-pkeyparam(1)>,
  72. L<openssl-gendsa(1)>,
  73. L<openssl-dsa(1)>,
  74. L<openssl-genrsa(1)>,
  75. L<openssl-rsa(1)>
  76. =head1 HISTORY
  77. The B<-engine> option was deprecated in OpenSSL 3.0.
  78. The B<-C> option was removed in OpenSSL 3.0.
  79. =head1 COPYRIGHT
  80. Copyright 2000-2023 The OpenSSL Project Authors. All Rights Reserved.
  81. Licensed under the Apache License 2.0 (the "License"). You may not use
  82. this file except in compliance with the License. You can obtain a copy
  83. in the file LICENSE in the source distribution or at
  84. L<https://www.openssl.org/source/license.html>.
  85. =cut