openssl-dsa.1ossl 10 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323
  1. .\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.42)
  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. .nr rF 0
  58. .if \n(.g .if rF .nr rF 1
  59. .if (\n(rF:(\n(.g==0)) \{\
  60. . if \nF \{\
  61. . de IX
  62. . tm Index:\\$1\t\\n%\t"\\$2"
  63. ..
  64. . if !\nF==2 \{\
  65. . nr % 0
  66. . nr F 2
  67. . \}
  68. . \}
  69. .\}
  70. .rr rF
  71. .\"
  72. .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
  73. .\" Fear. Run. Save yourself. No user-serviceable parts.
  74. . \" fudge factors for nroff and troff
  75. .if n \{\
  76. . ds #H 0
  77. . ds #V .8m
  78. . ds #F .3m
  79. . ds #[ \f1
  80. . ds #] \fP
  81. .\}
  82. .if t \{\
  83. . ds #H ((1u-(\\\\n(.fu%2u))*.13m)
  84. . ds #V .6m
  85. . ds #F 0
  86. . ds #[ \&
  87. . ds #] \&
  88. .\}
  89. . \" simple accents for nroff and troff
  90. .if n \{\
  91. . ds ' \&
  92. . ds ` \&
  93. . ds ^ \&
  94. . ds , \&
  95. . ds ~ ~
  96. . ds /
  97. .\}
  98. .if t \{\
  99. . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
  100. . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
  101. . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
  102. . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
  103. . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
  104. . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
  105. .\}
  106. . \" troff and (daisy-wheel) nroff accents
  107. .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
  108. .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
  109. .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
  110. .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
  111. .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
  112. .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
  113. .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
  114. .ds ae a\h'-(\w'a'u*4/10)'e
  115. .ds Ae A\h'-(\w'A'u*4/10)'E
  116. . \" corrections for vroff
  117. .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
  118. .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
  119. . \" for low resolution devices (crt and lpr)
  120. .if \n(.H>23 .if \n(.V>19 \
  121. \{\
  122. . ds : e
  123. . ds 8 ss
  124. . ds o a
  125. . ds d- d\h'-1'\(ga
  126. . ds D- D\h'-1'\(hy
  127. . ds th \o'bp'
  128. . ds Th \o'LP'
  129. . ds ae ae
  130. . ds Ae AE
  131. .\}
  132. .rm #[ #] #H #V #F C
  133. .\" ========================================================================
  134. .\"
  135. .IX Title "OPENSSL-DSA 1ossl"
  136. .TH OPENSSL-DSA 1ossl "2025-06-29" "3.3.2" "OpenSSL"
  137. .\" For nroff, turn off justification. Always turn off hyphenation; it makes
  138. .\" way too many mistakes in technical documents.
  139. .if n .ad l
  140. .nh
  141. .SH "NAME"
  142. openssl\-dsa \- DSA key processing
  143. .SH "SYNOPSIS"
  144. .IX Header "SYNOPSIS"
  145. \&\fBopenssl\fR \fBdsa\fR
  146. [\fB\-help\fR]
  147. [\fB\-inform\fR \fB\s-1DER\s0\fR|\fB\s-1PEM\s0\fR]
  148. [\fB\-outform\fR \fB\s-1DER\s0\fR|\fB\s-1PEM\s0\fR]
  149. [\fB\-in\fR \fIfilename\fR]
  150. [\fB\-passin\fR \fIarg\fR]
  151. [\fB\-out\fR \fIfilename\fR]
  152. [\fB\-passout\fR \fIarg\fR]
  153. [\fB\-aes128\fR]
  154. [\fB\-aes192\fR]
  155. [\fB\-aes256\fR]
  156. [\fB\-aria128\fR]
  157. [\fB\-aria192\fR]
  158. [\fB\-aria256\fR]
  159. [\fB\-camellia128\fR]
  160. [\fB\-camellia192\fR]
  161. [\fB\-camellia256\fR]
  162. [\fB\-des\fR]
  163. [\fB\-des3\fR]
  164. [\fB\-idea\fR]
  165. [\fB\-text\fR]
  166. [\fB\-noout\fR]
  167. [\fB\-modulus\fR]
  168. [\fB\-pubin\fR]
  169. [\fB\-pubout\fR]
  170. [\fB\-pvk\-strong\fR]
  171. [\fB\-pvk\-weak\fR]
  172. [\fB\-pvk\-none\fR]
  173. [\fB\-engine\fR \fIid\fR]
  174. [\fB\-provider\fR \fIname\fR]
  175. [\fB\-provider\-path\fR \fIpath\fR]
  176. [\fB\-propquery\fR \fIpropq\fR]
  177. .SH "DESCRIPTION"
  178. .IX Header "DESCRIPTION"
  179. This command processes \s-1DSA\s0 keys. They can be converted between various
  180. forms and their components printed out. \fBNote\fR This command uses the
  181. traditional SSLeay compatible format for private key encryption: newer
  182. applications should use the more secure PKCS#8 format using the \fBpkcs8\fR
  183. .SH "OPTIONS"
  184. .IX Header "OPTIONS"
  185. .IP "\fB\-help\fR" 4
  186. .IX Item "-help"
  187. Print out a usage message.
  188. .IP "\fB\-inform\fR \fB\s-1DER\s0\fR|\fB\s-1PEM\s0\fR" 4
  189. .IX Item "-inform DER|PEM"
  190. The key input format; unspecified by default.
  191. See \fBopenssl\-format\-options\fR\|(1) for details.
  192. .IP "\fB\-outform\fR \fB\s-1DER\s0\fR|\fB\s-1PEM\s0\fR" 4
  193. .IX Item "-outform DER|PEM"
  194. The key output format; the default is \fB\s-1PEM\s0\fR.
  195. See \fBopenssl\-format\-options\fR\|(1) for details.
  196. .Sp
  197. Private keys are a sequence of \fB\s-1ASN.1 INTEGERS\s0\fR: the version (zero), \fBp\fR,
  198. \&\fBq\fR, \fBg\fR, and the public and private key components. Public keys
  199. are a \fBSubjectPublicKeyInfo\fR structure with the \fB\s-1DSA\s0\fR type.
  200. .Sp
  201. The \fB\s-1PEM\s0\fR format also accepts PKCS#8 data.
  202. .IP "\fB\-in\fR \fIfilename\fR" 4
  203. .IX Item "-in filename"
  204. This specifies the input filename to read a key from or standard input if this
  205. option is not specified. If the key is encrypted a pass phrase will be
  206. prompted for.
  207. .IP "\fB\-out\fR \fIfilename\fR" 4
  208. .IX Item "-out filename"
  209. This specifies the output filename to write a key to or standard output by
  210. is not specified. If any encryption options are set then a pass phrase will be
  211. prompted for. The output filename should \fBnot\fR be the same as the input
  212. filename.
  213. .IP "\fB\-passin\fR \fIarg\fR, \fB\-passout\fR \fIarg\fR" 4
  214. .IX Item "-passin arg, -passout arg"
  215. The password source for the input and output file.
  216. For more information about the format of \fBarg\fR
  217. see \fBopenssl\-passphrase\-options\fR\|(1).
  218. .IP "\fB\-aes128\fR, \fB\-aes192\fR, \fB\-aes256\fR, \fB\-aria128\fR, \fB\-aria192\fR, \fB\-aria256\fR, \fB\-camellia128\fR, \fB\-camellia192\fR, \fB\-camellia256\fR, \fB\-des\fR, \fB\-des3\fR, \fB\-idea\fR" 4
  219. .IX Item "-aes128, -aes192, -aes256, -aria128, -aria192, -aria256, -camellia128, -camellia192, -camellia256, -des, -des3, -idea"
  220. These options encrypt the private key with the specified
  221. cipher before outputting it. A pass phrase is prompted for.
  222. If none of these options is specified the key is written in plain text. This
  223. means that this command can be used to remove the pass phrase from a key
  224. by not giving any encryption option is given, or to add or change the pass
  225. phrase by setting them.
  226. These options can only be used with \s-1PEM\s0 format output files.
  227. .IP "\fB\-text\fR" 4
  228. .IX Item "-text"
  229. Prints out the public, private key components and parameters.
  230. .IP "\fB\-noout\fR" 4
  231. .IX Item "-noout"
  232. This option prevents output of the encoded version of the key.
  233. .IP "\fB\-modulus\fR" 4
  234. .IX Item "-modulus"
  235. This option prints out the value of the public key component of the key.
  236. .IP "\fB\-pubin\fR" 4
  237. .IX Item "-pubin"
  238. By default, a private key is read from the input.
  239. With this option a public key is read instead.
  240. If the input contains no public key but a private key, its public part is used.
  241. .IP "\fB\-pubout\fR" 4
  242. .IX Item "-pubout"
  243. By default, a private key is output. With this option a public
  244. key will be output instead. This option is automatically set if the input is
  245. a public key.
  246. .IP "\fB\-pvk\-strong\fR" 4
  247. .IX Item "-pvk-strong"
  248. Enable 'Strong' \s-1PVK\s0 encoding level (default).
  249. .IP "\fB\-pvk\-weak\fR" 4
  250. .IX Item "-pvk-weak"
  251. Enable 'Weak' \s-1PVK\s0 encoding level.
  252. .IP "\fB\-pvk\-none\fR" 4
  253. .IX Item "-pvk-none"
  254. Don't enforce \s-1PVK\s0 encoding.
  255. .IP "\fB\-engine\fR \fIid\fR" 4
  256. .IX Item "-engine id"
  257. See \*(L"Engine Options\*(R" in \fBopenssl\fR\|(1).
  258. This option is deprecated.
  259. .IP "\fB\-provider\fR \fIname\fR" 4
  260. .IX Item "-provider name"
  261. .PD 0
  262. .IP "\fB\-provider\-path\fR \fIpath\fR" 4
  263. .IX Item "-provider-path path"
  264. .IP "\fB\-propquery\fR \fIpropq\fR" 4
  265. .IX Item "-propquery propq"
  266. .PD
  267. See \*(L"Provider Options\*(R" in \fBopenssl\fR\|(1), \fBprovider\fR\|(7), and \fBproperty\fR\|(7).
  268. .PP
  269. The \fBopenssl\-pkey\fR\|(1) command is capable of performing all the operations
  270. this command can, as well as supporting other public key types.
  271. .SH "EXAMPLES"
  272. .IX Header "EXAMPLES"
  273. The documentation for the \fBopenssl\-pkey\fR\|(1) command contains examples
  274. equivalent to the ones listed here.
  275. .PP
  276. To remove the pass phrase on a \s-1DSA\s0 private key:
  277. .PP
  278. .Vb 1
  279. \& openssl dsa \-in key.pem \-out keyout.pem
  280. .Ve
  281. .PP
  282. To encrypt a private key using triple \s-1DES:\s0
  283. .PP
  284. .Vb 1
  285. \& openssl dsa \-in key.pem \-des3 \-out keyout.pem
  286. .Ve
  287. .PP
  288. To convert a private key from \s-1PEM\s0 to \s-1DER\s0 format:
  289. .PP
  290. .Vb 1
  291. \& openssl dsa \-in key.pem \-outform DER \-out keyout.der
  292. .Ve
  293. .PP
  294. To print out the components of a private key to standard output:
  295. .PP
  296. .Vb 1
  297. \& openssl dsa \-in key.pem \-text \-noout
  298. .Ve
  299. .PP
  300. To just output the public part of a private key:
  301. .PP
  302. .Vb 1
  303. \& openssl dsa \-in key.pem \-pubout \-out pubkey.pem
  304. .Ve
  305. .SH "SEE ALSO"
  306. .IX Header "SEE ALSO"
  307. \&\fBopenssl\fR\|(1),
  308. \&\fBopenssl\-pkey\fR\|(1),
  309. \&\fBopenssl\-dsaparam\fR\|(1),
  310. \&\fBopenssl\-gendsa\fR\|(1),
  311. \&\fBopenssl\-rsa\fR\|(1),
  312. \&\fBopenssl\-genrsa\fR\|(1)
  313. .SH "HISTORY"
  314. .IX Header "HISTORY"
  315. The \fB\-engine\fR option was deprecated in OpenSSL 3.0.
  316. .SH "COPYRIGHT"
  317. .IX Header "COPYRIGHT"
  318. Copyright 2000\-2023 The OpenSSL Project Authors. All Rights Reserved.
  319. .PP
  320. Licensed under the Apache License 2.0 (the \*(L"License\*(R"). You may not use
  321. this file except in compliance with the License. You can obtain a copy
  322. in the file \s-1LICENSE\s0 in the source distribution or at
  323. <https://www.openssl.org/source/license.html>.