dsaparam.pod 2.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110
  1. =pod
  2. =head1 NAME
  3. dsaparam - DSA parameter manipulation and generation
  4. =head1 SYNOPSIS
  5. B<openssl dsaparam>
  6. [B<-inform DER|PEM>]
  7. [B<-outform DER|PEM>]
  8. [B<-in filename>]
  9. [B<-out filename>]
  10. [B<-noout>]
  11. [B<-text>]
  12. [B<-C>]
  13. [B<-rand file(s)>]
  14. [B<-genkey>]
  15. [B<-engine id>]
  16. [B<numbits>]
  17. =head1 DESCRIPTION
  18. This command is used to manipulate or generate DSA parameter files.
  19. =head1 OPTIONS
  20. =over 4
  21. =item B<-inform DER|PEM>
  22. This specifies the input format. The B<DER> option uses an ASN1 DER encoded
  23. form compatible with RFC2459 (PKIX) DSS-Parms that is a SEQUENCE consisting
  24. of p, q and g respectively. The PEM form is the default format: it consists
  25. of the B<DER> format base64 encoded with additional header and footer lines.
  26. =item B<-outform DER|PEM>
  27. This specifies the output format, the options have the same meaning as the
  28. B<-inform> option.
  29. =item B<-in filename>
  30. This specifies the input filename to read parameters from or standard input if
  31. this option is not specified. If the B<numbits> parameter is included then
  32. this option will be ignored.
  33. =item B<-out filename>
  34. This specifies the output filename parameters to. Standard output is used
  35. if this option is not present. The output filename should B<not> be the same
  36. as the input filename.
  37. =item B<-noout>
  38. this option inhibits the output of the encoded version of the parameters.
  39. =item B<-text>
  40. this option prints out the DSA parameters in human readable form.
  41. =item B<-C>
  42. this option converts the parameters into C code. The parameters can then
  43. be loaded by calling the B<get_dsaXXX()> function.
  44. =item B<-genkey>
  45. this option will generate a DSA either using the specified or generated
  46. parameters.
  47. =item B<-rand file(s)>
  48. a file or files containing random data used to seed the random number
  49. generator, or an EGD socket (see L<RAND_egd(3)|RAND_egd(3)>).
  50. Multiple files can be specified separated by a OS-dependent character.
  51. The separator is B<;> for MS-Windows, B<,> for OpenVMS, and B<:> for
  52. all others.
  53. =item B<numbits>
  54. this option specifies that a parameter set should be generated of size
  55. B<numbits>. It must be the last option. If this option is included then
  56. the input file (if any) is ignored.
  57. =item B<-engine id>
  58. specifying an engine (by its unique B<id> string) will cause B<dsaparam>
  59. to attempt to obtain a functional reference to the specified engine,
  60. thus initialising it if needed. The engine will then be set as the default
  61. for all available algorithms.
  62. =back
  63. =head1 NOTES
  64. PEM format DSA parameters use the header and footer lines:
  65. -----BEGIN DSA PARAMETERS-----
  66. -----END DSA PARAMETERS-----
  67. DSA parameter generation is a slow process and as a result the same set of
  68. DSA parameters is often used to generate several distinct keys.
  69. =head1 SEE ALSO
  70. L<gendsa(1)|gendsa(1)>, L<dsa(1)|dsa(1)>, L<genrsa(1)|genrsa(1)>,
  71. L<rsa(1)|rsa(1)>
  72. =cut