dsa.pod 4.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182
  1. =pod
  2. =head1 NAME
  3. openssl-dsa,
  4. dsa - DSA key processing
  5. =head1 SYNOPSIS
  6. B<openssl> B<dsa>
  7. [B<-help>]
  8. [B<-inform PEM|DER>]
  9. [B<-outform PEM|DER>]
  10. [B<-in filename>]
  11. [B<-passin arg>]
  12. [B<-out filename>]
  13. [B<-passout arg>]
  14. [B<-aes128>]
  15. [B<-aes192>]
  16. [B<-aes256>]
  17. [B<-aria128>]
  18. [B<-aria192>]
  19. [B<-aria256>]
  20. [B<-camellia128>]
  21. [B<-camellia192>]
  22. [B<-camellia256>]
  23. [B<-des>]
  24. [B<-des3>]
  25. [B<-idea>]
  26. [B<-text>]
  27. [B<-noout>]
  28. [B<-modulus>]
  29. [B<-pubin>]
  30. [B<-pubout>]
  31. [B<-engine id>]
  32. =head1 DESCRIPTION
  33. The B<dsa> command processes DSA keys. They can be converted between various
  34. forms and their components printed out. B<Note> This command uses the
  35. traditional SSLeay compatible format for private key encryption: newer
  36. applications should use the more secure PKCS#8 format using the B<pkcs8>
  37. =head1 OPTIONS
  38. =over 4
  39. =item B<-help>
  40. Print out a usage message.
  41. =item B<-inform DER|PEM>
  42. This specifies the input format. The B<DER> option with a private key uses
  43. an ASN1 DER encoded form of an ASN.1 SEQUENCE consisting of the values of
  44. version (currently zero), p, q, g, the public and private key components
  45. respectively as ASN.1 INTEGERs. When used with a public key it uses a
  46. SubjectPublicKeyInfo structure: it is an error if the key is not DSA.
  47. The B<PEM> form is the default format: it consists of the B<DER> format base64
  48. encoded with additional header and footer lines. In the case of a private key
  49. PKCS#8 format is also accepted.
  50. =item B<-outform DER|PEM>
  51. This specifies the output format, the options have the same meaning and default
  52. as the B<-inform> option.
  53. =item B<-in filename>
  54. This specifies the input filename to read a key from or standard input if this
  55. option is not specified. If the key is encrypted a pass phrase will be
  56. prompted for.
  57. =item B<-passin arg>
  58. The input file password source. For more information about the format of B<arg>
  59. see the B<PASS PHRASE ARGUMENTS> section in L<openssl(1)>.
  60. =item B<-out filename>
  61. This specifies the output filename to write a key to or standard output by
  62. is not specified. If any encryption options are set then a pass phrase will be
  63. prompted for. The output filename should B<not> be the same as the input
  64. filename.
  65. =item B<-passout arg>
  66. The output file password source. For more information about the format of B<arg>
  67. see the B<PASS PHRASE ARGUMENTS> section in L<openssl(1)>.
  68. =item B<-aes128|-aes192|-aes256|-aria128|-aria192|-aria256|-camellia128|-camellia192|-camellia256|-des|-des3|-idea>
  69. These options encrypt the private key with the specified
  70. cipher before outputting it. A pass phrase is prompted for.
  71. If none of these options is specified the key is written in plain text. This
  72. means that using the B<dsa> utility to read in an encrypted key with no
  73. encryption option can be used to remove the pass phrase from a key, or by
  74. setting the encryption options it can be use to add or change the pass phrase.
  75. These options can only be used with PEM format output files.
  76. =item B<-text>
  77. Prints out the public, private key components and parameters.
  78. =item B<-noout>
  79. This option prevents output of the encoded version of the key.
  80. =item B<-modulus>
  81. This option prints out the value of the public key component of the key.
  82. =item B<-pubin>
  83. By default, a private key is read from the input file. With this option a
  84. public key is read instead.
  85. =item B<-pubout>
  86. By default, a private key is output. With this option a public
  87. key will be output instead. This option is automatically set if the input is
  88. a public key.
  89. =item B<-engine id>
  90. Specifying an engine (by its unique B<id> string) will cause B<dsa>
  91. to attempt to obtain a functional reference to the specified engine,
  92. thus initialising it if needed. The engine will then be set as the default
  93. for all available algorithms.
  94. =back
  95. =head1 NOTES
  96. The PEM private key format uses the header and footer lines:
  97. -----BEGIN DSA PRIVATE KEY-----
  98. -----END DSA PRIVATE KEY-----
  99. The PEM public key format uses the header and footer lines:
  100. -----BEGIN PUBLIC KEY-----
  101. -----END PUBLIC KEY-----
  102. =head1 EXAMPLES
  103. To remove the pass phrase on a DSA private key:
  104. openssl dsa -in key.pem -out keyout.pem
  105. To encrypt a private key using triple DES:
  106. openssl dsa -in key.pem -des3 -out keyout.pem
  107. To convert a private key from PEM to DER format:
  108. openssl dsa -in key.pem -outform DER -out keyout.der
  109. To print out the components of a private key to standard output:
  110. openssl dsa -in key.pem -text -noout
  111. To just output the public part of a private key:
  112. openssl dsa -in key.pem -pubout -out pubkey.pem
  113. =head1 SEE ALSO
  114. L<dsaparam(1)>, L<gendsa(1)>, L<rsa(1)>,
  115. L<genrsa(1)>
  116. =head1 COPYRIGHT
  117. Copyright 2000-2017 The OpenSSL Project Authors. All Rights Reserved.
  118. Licensed under the OpenSSL license (the "License"). You may not use
  119. this file except in compliance with the License. You can obtain a copy
  120. in the file LICENSE in the source distribution or at
  121. L<https://www.openssl.org/source/license.html>.
  122. =cut