openssl-gendsa.pod.in 2.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113
  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. [B<-quiet>]
  24. {- $OpenSSL::safe::opt_r_synopsis -}
  25. {- $OpenSSL::safe::opt_engine_synopsis -}{- $OpenSSL::safe::opt_provider_synopsis -}
  26. [I<paramfile>]
  27. =head1 DESCRIPTION
  28. This command generates a DSA private key from a DSA parameter file
  29. (which will be typically generated by the L<openssl-dsaparam(1)> command).
  30. =head1 OPTIONS
  31. =over 4
  32. =item B<-help>
  33. Print out a usage message.
  34. =item B<-out> I<filename>
  35. Output the key to the specified file. If this argument is not specified then
  36. standard output is used.
  37. =item B<-passout> I<arg>
  38. The passphrase used for the output file.
  39. See L<openssl-passphrase-options(1)>.
  40. =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>
  41. These options encrypt the private key with specified
  42. cipher before outputting it. A pass phrase is prompted for.
  43. If none of these options is specified no encryption is used.
  44. Note that all options must be given before the I<paramfile> argument.
  45. =item B<-verbose>
  46. Print extra details about the operations being performed.
  47. =item B<-quiet>
  48. Print fewer details about the operations being performed, which may
  49. be handy during batch scripts and pipelines.
  50. {- $OpenSSL::safe::opt_r_item -}
  51. {- $OpenSSL::safe::opt_engine_item -}
  52. =item I<paramfile>
  53. The DSA parameter file to use. The parameters in this file determine
  54. the size of the private key. DSA parameters can be generated and
  55. examined using the L<openssl-dsaparam(1)> command.
  56. {- $OpenSSL::safe::opt_provider_item -}
  57. =back
  58. =head1 NOTES
  59. DSA key generation is little more than random number generation so it is
  60. much quicker that RSA key generation for example.
  61. =head1 SEE ALSO
  62. L<openssl(1)>,
  63. L<openssl-genpkey(1)>,
  64. L<openssl-dsaparam(1)>,
  65. L<openssl-dsa(1)>,
  66. L<openssl-genrsa(1)>,
  67. L<openssl-rsa(1)>
  68. =head1 HISTORY
  69. The B<-engine> option was deprecated in OpenSSL 3.0.
  70. =head1 COPYRIGHT
  71. Copyright 2000-2023 The OpenSSL Project Authors. All Rights Reserved.
  72. Licensed under the Apache License 2.0 (the "License"). You may not use
  73. this file except in compliance with the License. You can obtain a copy
  74. in the file LICENSE in the source distribution or at
  75. L<https://www.openssl.org/source/license.html>.
  76. =cut