dsaparam.pod 3.3 KB

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