openssl-dsaparam.1ossl 8.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259
  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-DSAPARAM 1ossl"
  136. .TH OPENSSL-DSAPARAM 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\-dsaparam \- DSA parameter manipulation and generation
  143. .SH "SYNOPSIS"
  144. .IX Header "SYNOPSIS"
  145. \&\fBopenssl dsaparam\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\-out\fR \fIfilename\fR]
  151. [\fB\-noout\fR]
  152. [\fB\-text\fR]
  153. [\fB\-genkey\fR]
  154. [\fB\-verbose\fR]
  155. [\fB\-quiet\fR]
  156. [\fB\-rand\fR \fIfiles\fR]
  157. [\fB\-writerand\fR \fIfile\fR]
  158. [\fB\-engine\fR \fIid\fR]
  159. [\fB\-provider\fR \fIname\fR]
  160. [\fB\-provider\-path\fR \fIpath\fR]
  161. [\fB\-propquery\fR \fIpropq\fR]
  162. [\fInumbits\fR]
  163. [\fInumqbits\fR]
  164. .SH "DESCRIPTION"
  165. .IX Header "DESCRIPTION"
  166. This command is used to manipulate or generate \s-1DSA\s0 parameter files.
  167. .PP
  168. \&\s-1DSA\s0 parameter generation can be a slow process and as a result the same set of
  169. \&\s-1DSA\s0 parameters is often used to generate several distinct keys.
  170. .SH "OPTIONS"
  171. .IX Header "OPTIONS"
  172. .IP "\fB\-help\fR" 4
  173. .IX Item "-help"
  174. Print out a usage message.
  175. .IP "\fB\-inform\fR \fB\s-1DER\s0\fR|\fB\s-1PEM\s0\fR" 4
  176. .IX Item "-inform DER|PEM"
  177. The \s-1DSA\s0 parameters input format; unspecified by default.
  178. See \fBopenssl\-format\-options\fR\|(1) for details.
  179. .IP "\fB\-outform\fR \fB\s-1DER\s0\fR|\fB\s-1PEM\s0\fR" 4
  180. .IX Item "-outform DER|PEM"
  181. The \s-1DSA\s0 parameters output format; the default is \fB\s-1PEM\s0\fR.
  182. See \fBopenssl\-format\-options\fR\|(1) for details.
  183. .Sp
  184. Parameters are a sequence of \fB\s-1ASN.1 INTEGER\s0\fRs: \fBp\fR, \fBq\fR, and \fBg\fR.
  185. This is compatible with \s-1RFC 2459\s0 \fBDSS-Parms\fR structure.
  186. .IP "\fB\-in\fR \fIfilename\fR" 4
  187. .IX Item "-in filename"
  188. This specifies the input filename to read parameters from or standard input if
  189. this option is not specified. If the \fInumbits\fR parameter is included then
  190. this option will be ignored.
  191. .IP "\fB\-out\fR \fIfilename\fR" 4
  192. .IX Item "-out filename"
  193. This specifies the output filename parameters to. Standard output is used
  194. if this option is not present. The output filename should \fBnot\fR be the same
  195. as the input filename.
  196. .IP "\fB\-noout\fR" 4
  197. .IX Item "-noout"
  198. This option inhibits the output of the encoded version of the parameters.
  199. .IP "\fB\-text\fR" 4
  200. .IX Item "-text"
  201. This option prints out the \s-1DSA\s0 parameters in human readable form.
  202. .IP "\fB\-genkey\fR" 4
  203. .IX Item "-genkey"
  204. This option will generate a \s-1DSA\s0 either using the specified or generated
  205. parameters.
  206. .IP "\fB\-verbose\fR" 4
  207. .IX Item "-verbose"
  208. Print extra details about the operations being performed.
  209. .IP "\fB\-quiet\fR" 4
  210. .IX Item "-quiet"
  211. Print fewer details about the operations being performed, which may
  212. be handy during batch scripts and pipelines.
  213. .IP "\fB\-rand\fR \fIfiles\fR, \fB\-writerand\fR \fIfile\fR" 4
  214. .IX Item "-rand files, -writerand file"
  215. See \*(L"Random State Options\*(R" in \fBopenssl\fR\|(1) for details.
  216. .IP "\fB\-engine\fR \fIid\fR" 4
  217. .IX Item "-engine id"
  218. See \*(L"Engine Options\*(R" in \fBopenssl\fR\|(1).
  219. This option is deprecated.
  220. .IP "\fInumbits\fR" 4
  221. .IX Item "numbits"
  222. This optional argument specifies that a parameter set should be generated of
  223. size \fInumbits\fR. If this argument is included then the input file (if any) is
  224. ignored.
  225. .IP "\fInumqbits\fR" 4
  226. .IX Item "numqbits"
  227. This optional argument specifies that a parameter set should be generated with
  228. a subprime parameter q of size \fInumqbits\fR. It must be the last argument. If
  229. this argument is included then the input file (if any) is ignored.
  230. .IP "\fB\-provider\fR \fIname\fR" 4
  231. .IX Item "-provider name"
  232. .PD 0
  233. .IP "\fB\-provider\-path\fR \fIpath\fR" 4
  234. .IX Item "-provider-path path"
  235. .IP "\fB\-propquery\fR \fIpropq\fR" 4
  236. .IX Item "-propquery propq"
  237. .PD
  238. See \*(L"Provider Options\*(R" in \fBopenssl\fR\|(1), \fBprovider\fR\|(7), and \fBproperty\fR\|(7).
  239. .SH "SEE ALSO"
  240. .IX Header "SEE ALSO"
  241. \&\fBopenssl\fR\|(1),
  242. \&\fBopenssl\-pkeyparam\fR\|(1),
  243. \&\fBopenssl\-gendsa\fR\|(1),
  244. \&\fBopenssl\-dsa\fR\|(1),
  245. \&\fBopenssl\-genrsa\fR\|(1),
  246. \&\fBopenssl\-rsa\fR\|(1)
  247. .SH "HISTORY"
  248. .IX Header "HISTORY"
  249. The \fB\-engine\fR option was deprecated in OpenSSL 3.0.
  250. .PP
  251. The \fB\-C\fR option was removed in OpenSSL 3.0.
  252. .SH "COPYRIGHT"
  253. .IX Header "COPYRIGHT"
  254. Copyright 2000\-2023 The OpenSSL Project Authors. All Rights Reserved.
  255. .PP
  256. Licensed under the Apache License 2.0 (the \*(L"License\*(R"). You may not use
  257. this file except in compliance with the License. You can obtain a copy
  258. in the file \s-1LICENSE\s0 in the source distribution or at
  259. <https://www.openssl.org/source/license.html>.