openssl-dsa.pod.in 4.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174
  1. =pod
  2. =begin comment
  3. {- join("\n", @autowarntext) -}
  4. =end comment
  5. =head1 NAME
  6. openssl-dsa - DSA key processing
  7. =head1 SYNOPSIS
  8. B<openssl> B<dsa>
  9. [B<-help>]
  10. [B<-inform> B<DER>|B<PEM>]
  11. [B<-outform> B<DER>|B<PEM>]
  12. [B<-in> I<filename>]
  13. [B<-passin> I<arg>]
  14. [B<-out> I<filename>]
  15. [B<-passout> I<arg>]
  16. [B<-aes128>]
  17. [B<-aes192>]
  18. [B<-aes256>]
  19. [B<-aria128>]
  20. [B<-aria192>]
  21. [B<-aria256>]
  22. [B<-camellia128>]
  23. [B<-camellia192>]
  24. [B<-camellia256>]
  25. [B<-des>]
  26. [B<-des3>]
  27. [B<-idea>]
  28. [B<-text>]
  29. [B<-noout>]
  30. [B<-modulus>]
  31. [B<-pubin>]
  32. [B<-pubout>]
  33. {- $OpenSSL::safe::opt_engine_synopsis -}{- $OpenSSL::safe::opt_provider_synopsis -}
  34. =for openssl ifdef pvk-string pvk-weak pvk-none engine
  35. =head1 DESCRIPTION
  36. This command processes DSA keys. They can be converted between various
  37. forms and their components printed out. B<Note> This command uses the
  38. traditional SSLeay compatible format for private key encryption: newer
  39. applications should use the more secure PKCS#8 format using the B<pkcs8>
  40. =head1 OPTIONS
  41. =over 4
  42. =item B<-help>
  43. Print out a usage message.
  44. =item B<-inform> B<DER>|B<PEM>, B<-outform> B<DER>|B<PEM>
  45. The input and formats; the default is B<PEM>.
  46. See L<openssl-format-options(1)> for details.
  47. Private keys are a sequence of B<ASN.1 INTEGERS>: the version (zero), B<p>,
  48. B<q>, B<g>, and the public and private key components. Public keys
  49. are a B<SubjectPublicKeyInfo> structure with the B<DSA> type.
  50. The B<PEM> format also accepts PKCS#8 data.
  51. =item B<-in> I<filename>
  52. This specifies the input filename to read a key from or standard input if this
  53. option is not specified. If the key is encrypted a pass phrase will be
  54. prompted for.
  55. =item B<-out> I<filename>
  56. This specifies the output filename to write a key to or standard output by
  57. is not specified. If any encryption options are set then a pass phrase will be
  58. prompted for. The output filename should B<not> be the same as the input
  59. filename.
  60. =item B<-passin> I<arg>, B<-passout> I<arg>
  61. The password source for the input and output file.
  62. For more information about the format of B<arg>
  63. see L<openssl-passphrase-options(1)>.
  64. =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>
  65. These options encrypt the private key with the specified
  66. cipher before outputting it. A pass phrase is prompted for.
  67. If none of these options is specified the key is written in plain text. This
  68. means that this command can be used to remove the pass phrase from a key
  69. by not giving any encryption option is given, or to add or change the pass
  70. phrase by setting them.
  71. These options can only be used with PEM format output files.
  72. =item B<-text>
  73. Prints out the public, private key components and parameters.
  74. =item B<-noout>
  75. This option prevents output of the encoded version of the key.
  76. =item B<-modulus>
  77. This option prints out the value of the public key component of the key.
  78. =item B<-pubin>
  79. By default, a private key is read from the input file. With this option a
  80. public key is read instead.
  81. =item B<-pubout>
  82. By default, a private key is output. With this option a public
  83. key will be output instead. This option is automatically set if the input is
  84. a public key.
  85. {- $OpenSSL::safe::opt_engine_item -}
  86. {- $OpenSSL::safe::opt_provider_item -}
  87. =back
  88. =head1 EXAMPLES
  89. Examples equivalent to these can be found in the documentation for the
  90. non-deprecated L<openssl-pkey(1)> command.
  91. To remove the pass phrase on a DSA private key:
  92. openssl dsa -in key.pem -out keyout.pem
  93. To encrypt a private key using triple DES:
  94. openssl dsa -in key.pem -des3 -out keyout.pem
  95. To convert a private key from PEM to DER format:
  96. openssl dsa -in key.pem -outform DER -out keyout.der
  97. To print out the components of a private key to standard output:
  98. openssl dsa -in key.pem -text -noout
  99. To just output the public part of a private key:
  100. openssl dsa -in key.pem -pubout -out pubkey.pem
  101. =head1 SEE ALSO
  102. L<openssl(1)>,
  103. L<openssl-pkey(1)>,
  104. L<openssl-dsaparam(1)>,
  105. L<openssl-gendsa(1)>,
  106. L<openssl-rsa(1)>,
  107. L<openssl-genrsa(1)>
  108. =head1 HISTORY
  109. The B<-engine> option was deprecated in OpenSSL 3.0.
  110. =head1 COPYRIGHT
  111. Copyright 2000-2020 The OpenSSL Project Authors. All Rights Reserved.
  112. Licensed under the Apache License 2.0 (the "License"). You may not use
  113. this file except in compliance with the License. You can obtain a copy
  114. in the file LICENSE in the source distribution or at
  115. L<https://www.openssl.org/source/license.html>.
  116. =cut