dsa.1 9.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287
  1. .\" Automatically generated by Pod::Man 4.09 (Pod::Simple 3.35)
  2. .\"
  3. .\" Standard preamble:
  4. .\" ========================================================================
  5. .de Sp \" Vertical space (when we can't use .PP)
  6. .if t .sp .5v
  7. .if n .sp
  8. ..
  9. .de Vb \" Begin verbatim text
  10. .ft CW
  11. .nf
  12. .ne \\$1
  13. ..
  14. .de Ve \" End verbatim text
  15. .ft R
  16. .fi
  17. ..
  18. .\" Set up some character translations and predefined strings. \*(-- will
  19. .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
  20. .\" double quote, and \*(R" will give a right double quote. \*(C+ will
  21. .\" give a nicer C++. Capital omega is used to do unbreakable dashes and
  22. .\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff,
  23. .\" nothing in troff, for use with C<>.
  24. .tr \(*W-
  25. .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
  26. .ie n \{\
  27. . ds -- \(*W-
  28. . ds PI pi
  29. . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
  30. . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch
  31. . ds L" ""
  32. . ds R" ""
  33. . ds C` ""
  34. . ds C' ""
  35. 'br\}
  36. .el\{\
  37. . ds -- \|\(em\|
  38. . ds PI \(*p
  39. . ds L" ``
  40. . ds R" ''
  41. . ds C`
  42. . ds C'
  43. 'br\}
  44. .\"
  45. .\" Escape single quotes in literal strings from groff's Unicode transform.
  46. .ie \n(.g .ds Aq \(aq
  47. .el .ds Aq '
  48. .\"
  49. .\" If the F register is >0, we'll generate index entries on stderr for
  50. .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
  51. .\" entries marked with X<> in POD. Of course, you'll have to process the
  52. .\" output yourself in some meaningful fashion.
  53. .\"
  54. .\" Avoid warning from groff about undefined register 'F'.
  55. .de IX
  56. ..
  57. .if !\nF .nr F 0
  58. .if \nF>0 \{\
  59. . de IX
  60. . tm Index:\\$1\t\\n%\t"\\$2"
  61. ..
  62. . if !\nF==2 \{\
  63. . nr % 0
  64. . nr F 2
  65. . \}
  66. .\}
  67. .\"
  68. .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
  69. .\" Fear. Run. Save yourself. No user-serviceable parts.
  70. . \" fudge factors for nroff and troff
  71. .if n \{\
  72. . ds #H 0
  73. . ds #V .8m
  74. . ds #F .3m
  75. . ds #[ \f1
  76. . ds #] \fP
  77. .\}
  78. .if t \{\
  79. . ds #H ((1u-(\\\\n(.fu%2u))*.13m)
  80. . ds #V .6m
  81. . ds #F 0
  82. . ds #[ \&
  83. . ds #] \&
  84. .\}
  85. . \" simple accents for nroff and troff
  86. .if n \{\
  87. . ds ' \&
  88. . ds ` \&
  89. . ds ^ \&
  90. . ds , \&
  91. . ds ~ ~
  92. . ds /
  93. .\}
  94. .if t \{\
  95. . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
  96. . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
  97. . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
  98. . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
  99. . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
  100. . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
  101. .\}
  102. . \" troff and (daisy-wheel) nroff accents
  103. .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
  104. .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
  105. .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
  106. .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
  107. .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
  108. .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
  109. .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
  110. .ds ae a\h'-(\w'a'u*4/10)'e
  111. .ds Ae A\h'-(\w'A'u*4/10)'E
  112. . \" corrections for vroff
  113. .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
  114. .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
  115. . \" for low resolution devices (crt and lpr)
  116. .if \n(.H>23 .if \n(.V>19 \
  117. \{\
  118. . ds : e
  119. . ds 8 ss
  120. . ds o a
  121. . ds d- d\h'-1'\(ga
  122. . ds D- D\h'-1'\(hy
  123. . ds th \o'bp'
  124. . ds Th \o'LP'
  125. . ds ae ae
  126. . ds Ae AE
  127. .\}
  128. .rm #[ #] #H #V #F C
  129. .\" ========================================================================
  130. .\"
  131. .IX Title "DSA 1"
  132. .TH DSA 1 "2019-09-12" "1.0.2g" "OpenSSL"
  133. .\" For nroff, turn off justification. Always turn off hyphenation; it makes
  134. .\" way too many mistakes in technical documents.
  135. .if n .ad l
  136. .nh
  137. .SH "NAME"
  138. dsa \- DSA key processing
  139. .SH "SYNOPSIS"
  140. .IX Header "SYNOPSIS"
  141. \&\fBopenssl\fR \fBdsa\fR
  142. [\fB\-inform PEM|DER\fR]
  143. [\fB\-outform PEM|DER\fR]
  144. [\fB\-in filename\fR]
  145. [\fB\-passin arg\fR]
  146. [\fB\-out filename\fR]
  147. [\fB\-passout arg\fR]
  148. [\fB\-aes128\fR]
  149. [\fB\-aes192\fR]
  150. [\fB\-aes256\fR]
  151. [\fB\-camellia128\fR]
  152. [\fB\-camellia192\fR]
  153. [\fB\-camellia256\fR]
  154. [\fB\-des\fR]
  155. [\fB\-des3\fR]
  156. [\fB\-idea\fR]
  157. [\fB\-text\fR]
  158. [\fB\-noout\fR]
  159. [\fB\-modulus\fR]
  160. [\fB\-pubin\fR]
  161. [\fB\-pubout\fR]
  162. [\fB\-engine id\fR]
  163. .SH "DESCRIPTION"
  164. .IX Header "DESCRIPTION"
  165. The \fBdsa\fR command processes \s-1DSA\s0 keys. They can be converted between various
  166. forms and their components printed out. \fBNote\fR This command uses the
  167. traditional SSLeay compatible format for private key encryption: newer
  168. applications should use the more secure PKCS#8 format using the \fBpkcs8\fR
  169. .SH "COMMAND OPTIONS"
  170. .IX Header "COMMAND OPTIONS"
  171. .IP "\fB\-inform DER|PEM\fR" 4
  172. .IX Item "-inform DER|PEM"
  173. This specifies the input format. The \fB\s-1DER\s0\fR option with a private key uses
  174. an \s-1ASN1 DER\s0 encoded form of an \s-1ASN.1 SEQUENCE\s0 consisting of the values of
  175. version (currently zero), p, q, g, the public and private key components
  176. respectively as \s-1ASN.1\s0 INTEGERs. When used with a public key it uses a
  177. SubjectPublicKeyInfo structure: it is an error if the key is not \s-1DSA.\s0
  178. .Sp
  179. The \fB\s-1PEM\s0\fR form is the default format: it consists of the \fB\s-1DER\s0\fR format base64
  180. encoded with additional header and footer lines. In the case of a private key
  181. PKCS#8 format is also accepted.
  182. .IP "\fB\-outform DER|PEM\fR" 4
  183. .IX Item "-outform DER|PEM"
  184. This specifies the output format, the options have the same meaning as the
  185. \&\fB\-inform\fR option.
  186. .IP "\fB\-in filename\fR" 4
  187. .IX Item "-in filename"
  188. This specifies the input filename to read a key from or standard input if this
  189. option is not specified. If the key is encrypted a pass phrase will be
  190. prompted for.
  191. .IP "\fB\-passin arg\fR" 4
  192. .IX Item "-passin arg"
  193. the input file password source. For more information about the format of \fBarg\fR
  194. see the \fB\s-1PASS PHRASE ARGUMENTS\s0\fR section in \fIopenssl\fR\|(1).
  195. .IP "\fB\-out filename\fR" 4
  196. .IX Item "-out filename"
  197. This specifies the output filename to write a key to or standard output by
  198. is not specified. If any encryption options are set then a pass phrase will be
  199. prompted for. The output filename should \fBnot\fR be the same as the input
  200. filename.
  201. .IP "\fB\-passout arg\fR" 4
  202. .IX Item "-passout arg"
  203. the output file password source. For more information about the format of \fBarg\fR
  204. see the \fB\s-1PASS PHRASE ARGUMENTS\s0\fR section in \fIopenssl\fR\|(1).
  205. .IP "\fB\-aes128|\-aes192|\-aes256|\-camellia128|\-camellia192|\-camellia256|\-des|\-des3|\-idea\fR" 4
  206. .IX Item "-aes128|-aes192|-aes256|-camellia128|-camellia192|-camellia256|-des|-des3|-idea"
  207. These options encrypt the private key with the specified
  208. cipher before outputting it. A pass phrase is prompted for.
  209. If none of these options is specified the key is written in plain text. This
  210. means that using the \fBdsa\fR utility to read in an encrypted key with no
  211. encryption option can be used to remove the pass phrase from a key, or by
  212. setting the encryption options it can be use to add or change the pass phrase.
  213. These options can only be used with \s-1PEM\s0 format output files.
  214. .IP "\fB\-text\fR" 4
  215. .IX Item "-text"
  216. prints out the public, private key components and parameters.
  217. .IP "\fB\-noout\fR" 4
  218. .IX Item "-noout"
  219. this option prevents output of the encoded version of the key.
  220. .IP "\fB\-modulus\fR" 4
  221. .IX Item "-modulus"
  222. this option prints out the value of the public key component of the key.
  223. .IP "\fB\-pubin\fR" 4
  224. .IX Item "-pubin"
  225. by default a private key is read from the input file: with this option a
  226. public key is read instead.
  227. .IP "\fB\-pubout\fR" 4
  228. .IX Item "-pubout"
  229. by default a private key is output. With this option a public
  230. key will be output instead. This option is automatically set if the input is
  231. a public key.
  232. .IP "\fB\-engine id\fR" 4
  233. .IX Item "-engine id"
  234. specifying an engine (by its unique \fBid\fR string) will cause \fBdsa\fR
  235. to attempt to obtain a functional reference to the specified engine,
  236. thus initialising it if needed. The engine will then be set as the default
  237. for all available algorithms.
  238. .SH "NOTES"
  239. .IX Header "NOTES"
  240. The \s-1PEM\s0 private key format uses the header and footer lines:
  241. .PP
  242. .Vb 2
  243. \& \-\-\-\-\-BEGIN DSA PRIVATE KEY\-\-\-\-\-
  244. \& \-\-\-\-\-END DSA PRIVATE KEY\-\-\-\-\-
  245. .Ve
  246. .PP
  247. The \s-1PEM\s0 public key format uses the header and footer lines:
  248. .PP
  249. .Vb 2
  250. \& \-\-\-\-\-BEGIN PUBLIC KEY\-\-\-\-\-
  251. \& \-\-\-\-\-END PUBLIC KEY\-\-\-\-\-
  252. .Ve
  253. .SH "EXAMPLES"
  254. .IX Header "EXAMPLES"
  255. To remove the pass phrase on a \s-1DSA\s0 private key:
  256. .PP
  257. .Vb 1
  258. \& openssl dsa \-in key.pem \-out keyout.pem
  259. .Ve
  260. .PP
  261. To encrypt a private key using triple \s-1DES:\s0
  262. .PP
  263. .Vb 1
  264. \& openssl dsa \-in key.pem \-des3 \-out keyout.pem
  265. .Ve
  266. .PP
  267. To convert a private key from \s-1PEM\s0 to \s-1DER\s0 format:
  268. .PP
  269. .Vb 1
  270. \& openssl dsa \-in key.pem \-outform DER \-out keyout.der
  271. .Ve
  272. .PP
  273. To print out the components of a private key to standard output:
  274. .PP
  275. .Vb 1
  276. \& openssl dsa \-in key.pem \-text \-noout
  277. .Ve
  278. .PP
  279. To just output the public part of a private key:
  280. .PP
  281. .Vb 1
  282. \& openssl dsa \-in key.pem \-pubout \-out pubkey.pem
  283. .Ve
  284. .SH "SEE ALSO"
  285. .IX Header "SEE ALSO"
  286. \&\fIdsaparam\fR\|(1), \fIgendsa\fR\|(1), \fIrsa\fR\|(1),
  287. \&\fIgenrsa\fR\|(1)