dsaparam.pod 3.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131
  1. =pod
  2. =head1 NAME
  3. openssl-dsaparam,
  4. dsaparam - DSA parameter manipulation and generation
  5. =head1 SYNOPSIS
  6. B<openssl dsaparam>
  7. [B<-help>]
  8. [B<-inform DER|PEM>]
  9. [B<-outform DER|PEM>]
  10. [B<-in filename>]
  11. [B<-out filename>]
  12. [B<-noout>]
  13. [B<-text>]
  14. [B<-C>]
  15. [B<-rand file...>]
  16. [B<-writerand file>]
  17. [B<-genkey>]
  18. [B<-engine id>]
  19. [B<numbits>]
  20. =head1 DESCRIPTION
  21. This command is used to manipulate or generate DSA parameter files.
  22. =head1 OPTIONS
  23. =over 4
  24. =item B<-help>
  25. Print out a usage message.
  26. =item B<-inform DER|PEM>
  27. This specifies the input format. The B<DER> option uses an ASN1 DER encoded
  28. form compatible with RFC2459 (PKIX) DSS-Parms that is a SEQUENCE consisting
  29. of p, q and g respectively. The PEM form is the default format: it consists
  30. of the B<DER> format base64 encoded with additional header and footer lines.
  31. =item B<-outform DER|PEM>
  32. This specifies the output format, the options have the same meaning and default
  33. as the B<-inform> option.
  34. =item B<-in filename>
  35. This specifies the input filename to read parameters from or standard input if
  36. this option is not specified. If the B<numbits> parameter is included then
  37. this option will be ignored.
  38. =item B<-out 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<-rand file...>
  53. A file or files containing random data used to seed the random number
  54. generator.
  55. Multiple files can be specified separated by an OS-dependent character.
  56. The separator is B<;> for MS-Windows, B<,> for OpenVMS, and B<:> for
  57. all others.
  58. =item [B<-writerand file>]
  59. Writes random data to the specified I<file> upon exit.
  60. This can be used with a subsequent B<-rand> flag.
  61. =item B<numbits>
  62. This option specifies that a parameter set should be generated of size
  63. B<numbits>. It must be the last option. If this option is included then
  64. the input file (if any) is ignored.
  65. =item B<-engine id>
  66. Specifying an engine (by its unique B<id> string) will cause B<dsaparam>
  67. to attempt to obtain a functional reference to the specified engine,
  68. thus initialising it if needed. The engine will then be set as the default
  69. for all available algorithms.
  70. =back
  71. =head1 NOTES
  72. PEM format DSA parameters use the header and footer lines:
  73. -----BEGIN DSA PARAMETERS-----
  74. -----END DSA PARAMETERS-----
  75. DSA parameter generation is a slow process and as a result the same set of
  76. DSA parameters is often used to generate several distinct keys.
  77. =head1 SEE ALSO
  78. L<gendsa(1)>, L<dsa(1)>, L<genrsa(1)>,
  79. L<rsa(1)>
  80. =head1 COPYRIGHT
  81. Copyright 2000-2017 The OpenSSL Project Authors. All Rights Reserved.
  82. Licensed under the OpenSSL license (the "License"). You may not use
  83. this file except in compliance with the License. You can obtain a copy
  84. in the file LICENSE in the source distribution or at
  85. L<https://www.openssl.org/source/license.html>.
  86. =cut