openssl-dsaparam.pod.in 2.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120
  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<-C>]
  15. [B<-genkey>]
  16. [B<-verbose>]
  17. {- $OpenSSL::safe::opt_r_synopsis -}
  18. {- $OpenSSL::safe::opt_engine_synopsis -}
  19. {- $OpenSSL::safe::opt_provider_synopsis -}
  20. [I<numbits>]
  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>, B<-outform> B<DER>|B<PEM>
  30. The input and formats; the default is B<PEM>.
  31. See L<openssl(1)/Format Options> for details.
  32. Parameters are a sequence of B<ASN.1 INTEGER>s: B<p>, B<q>, and B<g>.
  33. This is compatible with RFC 2459 B<DSS-Parms> structure.
  34. =item B<-in> I<filename>
  35. This specifies the input filename to read parameters from or standard input if
  36. this option is not specified. If the I<numbits> parameter is included then
  37. this option will be ignored.
  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<-noout>
  43. This option inhibits the output of the encoded version of the parameters.
  44. =item B<-text>
  45. This option prints out the DSA parameters in human readable form.
  46. =item B<-C>
  47. This option converts the parameters into C code. The parameters can then
  48. be loaded by calling the get_dsaXXX() function.
  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. {- $OpenSSL::safe::opt_r_item -}
  55. {- $OpenSSL::safe::opt_engine_item -}
  56. =item I<numbits>
  57. This option specifies that a parameter set should be generated of size
  58. I<numbits>. It must be the last option. If this option is included then
  59. the input file (if any) is ignored.
  60. {- $OpenSSL::safe::opt_provider_item -}
  61. =back
  62. =head1 SEE ALSO
  63. L<openssl(1)>,
  64. L<openssl-pkeyparam(1)>,
  65. L<openssl-gendsa(1)>,
  66. L<openssl-dsa(1)>,
  67. L<openssl-genrsa(1)>,
  68. L<openssl-rsa(1)>
  69. =head1 HISTORY
  70. The B<-engine> option was deprecated in OpenSSL 3.0.
  71. =head1 COPYRIGHT
  72. Copyright 2000-2020 The OpenSSL Project Authors. All Rights Reserved.
  73. Licensed under the Apache License 2.0 (the "License"). You may not use
  74. this file except in compliance with the License. You can obtain a copy
  75. in the file LICENSE in the source distribution or at
  76. L<https://www.openssl.org/source/license.html>.
  77. =cut