Merge branch 'vendor/OPENSSL'
[dragonfly.git] / secure / usr.bin / openssl / man / dsaparam.1
CommitLineData
aac4ff6f 1.\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.32
8b0cefbb
JR
2.\"
3.\" Standard preamble:
4.\" ========================================================================
5.de Sh \" Subsection heading
984263bc
MD
6.br
7.if t .Sp
8.ne 5
9.PP
10\fB\\$1\fR
11.PP
12..
8b0cefbb 13.de Sp \" Vertical space (when we can't use .PP)
984263bc
MD
14.if t .sp .5v
15.if n .sp
16..
8b0cefbb 17.de Vb \" Begin verbatim text
984263bc
MD
18.ft CW
19.nf
20.ne \\$1
21..
8b0cefbb 22.de Ve \" End verbatim text
984263bc 23.ft R
984263bc
MD
24.fi
25..
8b0cefbb
JR
26.\" Set up some character translations and predefined strings. \*(-- will
27.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
aac4ff6f
PA
28.\" double quote, and \*(R" will give a right double quote. | will give a
29.\" real vertical bar. \*(C+ will give a nicer C++. Capital omega is used to
30.\" do unbreakable dashes and therefore won't be available. \*(C` and \*(C'
31.\" expand to `' in nroff, nothing in troff, for use with C<>.
32.tr \(*W-|\(bv\*(Tr
8b0cefbb 33.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
984263bc 34.ie n \{\
8b0cefbb
JR
35. ds -- \(*W-
36. ds PI pi
37. if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
38. if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch
39. ds L" ""
40. ds R" ""
41. ds C` ""
42. ds C' ""
984263bc
MD
43'br\}
44.el\{\
8b0cefbb
JR
45. ds -- \|\(em\|
46. ds PI \(*p
47. ds L" ``
48. ds R" ''
984263bc 49'br\}
8b0cefbb
JR
50.\"
51.\" If the F register is turned on, we'll generate index entries on stderr for
52.\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
53.\" entries marked with X<> in POD. Of course, you'll have to process the
54.\" output yourself in some meaningful fashion.
55.if \nF \{\
56. de IX
57. tm Index:\\$1\t\\n%\t"\\$2"
984263bc 58..
8b0cefbb
JR
59. nr % 0
60. rr F
984263bc 61.\}
8b0cefbb 62.\"
aac4ff6f
PA
63.\" For nroff, turn off justification. Always turn off hyphenation; it makes
64.\" way too many mistakes in technical documents.
65.hy 0
66.if n .na
67.\"
8b0cefbb
JR
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
984263bc 71.if n \{\
8b0cefbb
JR
72. ds #H 0
73. ds #V .8m
74. ds #F .3m
75. ds #[ \f1
76. ds #] \fP
984263bc
MD
77.\}
78.if t \{\
8b0cefbb
JR
79. ds #H ((1u-(\\\\n(.fu%2u))*.13m)
80. ds #V .6m
81. ds #F 0
82. ds #[ \&
83. ds #] \&
984263bc 84.\}
8b0cefbb 85. \" simple accents for nroff and troff
984263bc 86.if n \{\
8b0cefbb
JR
87. ds ' \&
88. ds ` \&
89. ds ^ \&
90. ds , \&
91. ds ~ ~
92. ds /
984263bc
MD
93.\}
94.if t \{\
8b0cefbb
JR
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'
984263bc 101.\}
8b0cefbb 102. \" troff and (daisy-wheel) nroff accents
984263bc
MD
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
8b0cefbb 112. \" corrections for vroff
984263bc
MD
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'
8b0cefbb 115. \" for low resolution devices (crt and lpr)
984263bc
MD
116.if \n(.H>23 .if \n(.V>19 \
117\{\
8b0cefbb
JR
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
984263bc
MD
127.\}
128.rm #[ #] #H #V #F C
8b0cefbb
JR
129.\" ========================================================================
130.\"
131.IX Title "DSAPARAM 1"
18ed9402 132.TH DSAPARAM 1 "2008-09-27" "0.9.8i" "OpenSSL"
984263bc 133.SH "NAME"
e3cdf75b 134dsaparam \- DSA parameter manipulation and generation
984263bc 135.SH "SYNOPSIS"
8b0cefbb
JR
136.IX Header "SYNOPSIS"
137\&\fBopenssl dsaparam\fR
984263bc
MD
138[\fB\-inform DER|PEM\fR]
139[\fB\-outform DER|PEM\fR]
140[\fB\-in filename\fR]
141[\fB\-out filename\fR]
142[\fB\-noout\fR]
143[\fB\-text\fR]
144[\fB\-C\fR]
e3cdf75b 145[\fB\-rand file(s)\fR]
984263bc
MD
146[\fB\-genkey\fR]
147[\fB\-engine id\fR]
148[\fBnumbits\fR]
149.SH "DESCRIPTION"
8b0cefbb
JR
150.IX Header "DESCRIPTION"
151This command is used to manipulate or generate \s-1DSA\s0 parameter files.
984263bc 152.SH "OPTIONS"
8b0cefbb
JR
153.IX Header "OPTIONS"
154.IP "\fB\-inform DER|PEM\fR" 4
155.IX Item "-inform DER|PEM"
984263bc 156This specifies the input format. The \fB\s-1DER\s0\fR option uses an \s-1ASN1\s0 \s-1DER\s0 encoded
8b0cefbb 157form compatible with \s-1RFC2459\s0 (\s-1PKIX\s0) DSS-Parms that is a \s-1SEQUENCE\s0 consisting
984263bc
MD
158of p, q and g respectively. The \s-1PEM\s0 form is the default format: it consists
159of the \fB\s-1DER\s0\fR format base64 encoded with additional header and footer lines.
8b0cefbb
JR
160.IP "\fB\-outform DER|PEM\fR" 4
161.IX Item "-outform DER|PEM"
984263bc 162This specifies the output format, the options have the same meaning as the
8b0cefbb
JR
163\&\fB\-inform\fR option.
164.IP "\fB\-in filename\fR" 4
165.IX Item "-in filename"
984263bc
MD
166This specifies the input filename to read parameters from or standard input if
167this option is not specified. If the \fBnumbits\fR parameter is included then
168this option will be ignored.
8b0cefbb
JR
169.IP "\fB\-out filename\fR" 4
170.IX Item "-out filename"
984263bc
MD
171This specifies the output filename parameters to. Standard output is used
172if this option is not present. The output filename should \fBnot\fR be the same
173as the input filename.
8b0cefbb
JR
174.IP "\fB\-noout\fR" 4
175.IX Item "-noout"
984263bc 176this option inhibits the output of the encoded version of the parameters.
8b0cefbb
JR
177.IP "\fB\-text\fR" 4
178.IX Item "-text"
984263bc 179this option prints out the \s-1DSA\s0 parameters in human readable form.
8b0cefbb
JR
180.IP "\fB\-C\fR" 4
181.IX Item "-C"
984263bc 182this option converts the parameters into C code. The parameters can then
8b0cefbb
JR
183be loaded by calling the \fB\f(BIget_dsaXXX()\fB\fR function.
184.IP "\fB\-genkey\fR" 4
185.IX Item "-genkey"
984263bc
MD
186this option will generate a \s-1DSA\s0 either using the specified or generated
187parameters.
8b0cefbb
JR
188.IP "\fB\-rand file(s)\fR" 4
189.IX Item "-rand file(s)"
984263bc 190a file or files containing random data used to seed the random number
8b0cefbb
JR
191generator, or an \s-1EGD\s0 socket (see \fIRAND_egd\fR\|(3)).
192Multiple files can be specified separated by a OS-dependent character.
aac4ff6f 193The separator is \fB;\fR for MS\-Windows, \fB,\fR for OpenVMS, and \fB:\fR for
984263bc 194all others.
8b0cefbb
JR
195.IP "\fBnumbits\fR" 4
196.IX Item "numbits"
984263bc 197this option specifies that a parameter set should be generated of size
8b0cefbb 198\&\fBnumbits\fR. It must be the last option. If this option is included then
984263bc 199the input file (if any) is ignored.
8b0cefbb
JR
200.IP "\fB\-engine id\fR" 4
201.IX Item "-engine id"
984263bc
MD
202specifying an engine (by it's unique \fBid\fR string) will cause \fBreq\fR
203to attempt to obtain a functional reference to the specified engine,
204thus initialising it if needed. The engine will then be set as the default
205for all available algorithms.
206.SH "NOTES"
8b0cefbb
JR
207.IX Header "NOTES"
208\&\s-1PEM\s0 format \s-1DSA\s0 parameters use the header and footer lines:
984263bc
MD
209.PP
210.Vb 2
aac4ff6f
PA
211\& -----BEGIN DSA PARAMETERS-----
212\& -----END DSA PARAMETERS-----
984263bc 213.Ve
8b0cefbb
JR
214.PP
215\&\s-1DSA\s0 parameter generation is a slow process and as a result the same set of
216\&\s-1DSA\s0 parameters is often used to generate several distinct keys.
984263bc 217.SH "SEE ALSO"
e3cdf75b 218.IX Header "SEE ALSO"
8b0cefbb
JR
219\&\fIgendsa\fR\|(1), \fIdsa\fR\|(1), \fIgenrsa\fR\|(1),
220\&\fIrsa\fR\|(1)