openssl-gendsa.pod.in 2.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108
  1. =pod
  2. {- OpenSSL::safe::output_do_not_edit_headers(); -}
  3. =head1 NAME
  4. openssl-gendsa - generate a DSA private key from a set of parameters
  5. =head1 SYNOPSIS
  6. B<openssl> B<gendsa>
  7. [B<-help>]
  8. [B<-out> I<filename>]
  9. [B<-passout> I<arg>]
  10. [B<-aes128>]
  11. [B<-aes192>]
  12. [B<-aes256>]
  13. [B<-aria128>]
  14. [B<-aria192>]
  15. [B<-aria256>]
  16. [B<-camellia128>]
  17. [B<-camellia192>]
  18. [B<-camellia256>]
  19. [B<-des>]
  20. [B<-des3>]
  21. [B<-idea>]
  22. [B<-verbose>]
  23. {- $OpenSSL::safe::opt_r_synopsis -}
  24. {- $OpenSSL::safe::opt_engine_synopsis -}
  25. {- $OpenSSL::safe::opt_provider_synopsis -}
  26. [I<paramfile>]
  27. =for openssl ifdef engine
  28. =head1 DESCRIPTION
  29. This command generates a DSA private key from a DSA parameter file
  30. (which will be typically generated by the L<openssl-dsaparam(1)> command).
  31. =head1 OPTIONS
  32. =over 4
  33. =item B<-help>
  34. Print out a usage message.
  35. =item B<-out> I<filename>
  36. Output the key to the specified file. If this argument is not specified then
  37. standard output is used.
  38. =item B<-passout> I<arg>
  39. The passphrase used for the output file.
  40. See L<openssl(1)/Pass Phrase Options>.
  41. =item B<-aes128>, B<-aes192>, B<-aes256>, B<-aria128>, B<-aria192>, B<-aria256>, B<-camellia128>, B<-camellia192>, B<-camellia256>, B<-des>, B<-des3>, B<-idea>
  42. These options encrypt the private key with specified
  43. cipher before outputting it. A pass phrase is prompted for.
  44. If none of these options is specified no encryption is used.
  45. =item B<-verbose>
  46. Print extra details about the operations being performed.
  47. {- $OpenSSL::safe::opt_r_item -}
  48. {- $OpenSSL::safe::opt_engine_item -}
  49. =item I<paramfile>
  50. The DSA parameter file to use. The parameters in this file determine
  51. the size of the private key. DSA parameters can be generated and
  52. examined using the L<openssl-dsaparam(1)> command.
  53. {- $OpenSSL::safe::opt_provider_item -}
  54. =back
  55. =head1 NOTES
  56. DSA key generation is little more than random number generation so it is
  57. much quicker that RSA key generation for example.
  58. =head1 SEE ALSO
  59. L<openssl(1)>,
  60. L<openssl-genpkey(1)>,
  61. L<openssl-dsaparam(1)>,
  62. L<openssl-dsa(1)>,
  63. L<openssl-genrsa(1)>,
  64. L<openssl-rsa(1)>
  65. =head1 HISTORY
  66. The B<-engine> option was deprecated in OpenSSL 3.0.
  67. =head1 COPYRIGHT
  68. Copyright 2000-2020 The OpenSSL Project Authors. All Rights Reserved.
  69. Licensed under the Apache License 2.0 (the "License"). You may not use
  70. this file except in compliance with the License. You can obtain a copy
  71. in the file LICENSE in the source distribution or at
  72. L<https://www.openssl.org/source/license.html>.
  73. =cut