Merge branch 'vendor/OPENSSL'
[dragonfly.git] / secure / usr.bin / openssl / man / dsaparam.1
CommitLineData
e257b235 1.\" Automatically generated by Pod::Man 2.16 (Pod::Simple 3.05)
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
e257b235
PA
28.\" double quote, and \*(R" will give a right double quote. \*(C+ will
29.\" give a nicer C++. Capital omega is used to do unbreakable dashes and
30.\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff,
31.\" nothing in troff, for use with C<>.
32.tr \(*W-
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 50.\"
e257b235
PA
51.\" Escape single quotes in literal strings from groff's Unicode transform.
52.ie \n(.g .ds Aq \(aq
53.el .ds Aq '
54.\"
8b0cefbb
JR
55.\" If the F register is turned on, we'll generate index entries on stderr for
56.\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
57.\" entries marked with X<> in POD. Of course, you'll have to process the
58.\" output yourself in some meaningful fashion.
e257b235 59.ie \nF \{\
8b0cefbb
JR
60. de IX
61. tm Index:\\$1\t\\n%\t"\\$2"
984263bc 62..
8b0cefbb
JR
63. nr % 0
64. rr F
984263bc 65.\}
e257b235
PA
66.el \{\
67. de IX
68..
69.\}
aac4ff6f 70.\"
8b0cefbb
JR
71.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
72.\" Fear. Run. Save yourself. No user-serviceable parts.
73. \" fudge factors for nroff and troff
984263bc 74.if n \{\
8b0cefbb
JR
75. ds #H 0
76. ds #V .8m
77. ds #F .3m
78. ds #[ \f1
79. ds #] \fP
984263bc
MD
80.\}
81.if t \{\
8b0cefbb
JR
82. ds #H ((1u-(\\\\n(.fu%2u))*.13m)
83. ds #V .6m
84. ds #F 0
85. ds #[ \&
86. ds #] \&
984263bc 87.\}
8b0cefbb 88. \" simple accents for nroff and troff
984263bc 89.if n \{\
8b0cefbb
JR
90. ds ' \&
91. ds ` \&
92. ds ^ \&
93. ds , \&
94. ds ~ ~
95. ds /
984263bc
MD
96.\}
97.if t \{\
8b0cefbb
JR
98. ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
99. ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
100. ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
101. ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
102. ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
103. ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
984263bc 104.\}
8b0cefbb 105. \" troff and (daisy-wheel) nroff accents
984263bc
MD
106.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
107.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
108.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
109.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
110.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
111.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
112.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
113.ds ae a\h'-(\w'a'u*4/10)'e
114.ds Ae A\h'-(\w'A'u*4/10)'E
8b0cefbb 115. \" corrections for vroff
984263bc
MD
116.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
117.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
8b0cefbb 118. \" for low resolution devices (crt and lpr)
984263bc
MD
119.if \n(.H>23 .if \n(.V>19 \
120\{\
8b0cefbb
JR
121. ds : e
122. ds 8 ss
123. ds o a
124. ds d- d\h'-1'\(ga
125. ds D- D\h'-1'\(hy
126. ds th \o'bp'
127. ds Th \o'LP'
128. ds ae ae
129. ds Ae AE
984263bc
MD
130.\}
131.rm #[ #] #H #V #F C
8b0cefbb
JR
132.\" ========================================================================
133.\"
134.IX Title "DSAPARAM 1"
fc468453 135.TH DSAPARAM 1 "2010-02-27" "0.9.8m" "OpenSSL"
e257b235
PA
136.\" For nroff, turn off justification. Always turn off hyphenation; it makes
137.\" way too many mistakes in technical documents.
138.if n .ad l
139.nh
984263bc 140.SH "NAME"
e3cdf75b 141dsaparam \- DSA parameter manipulation and generation
984263bc 142.SH "SYNOPSIS"
8b0cefbb
JR
143.IX Header "SYNOPSIS"
144\&\fBopenssl dsaparam\fR
984263bc
MD
145[\fB\-inform DER|PEM\fR]
146[\fB\-outform DER|PEM\fR]
147[\fB\-in filename\fR]
148[\fB\-out filename\fR]
149[\fB\-noout\fR]
150[\fB\-text\fR]
151[\fB\-C\fR]
e3cdf75b 152[\fB\-rand file(s)\fR]
984263bc
MD
153[\fB\-genkey\fR]
154[\fB\-engine id\fR]
155[\fBnumbits\fR]
156.SH "DESCRIPTION"
8b0cefbb
JR
157.IX Header "DESCRIPTION"
158This command is used to manipulate or generate \s-1DSA\s0 parameter files.
984263bc 159.SH "OPTIONS"
8b0cefbb
JR
160.IX Header "OPTIONS"
161.IP "\fB\-inform DER|PEM\fR" 4
162.IX Item "-inform DER|PEM"
984263bc 163This specifies the input format. The \fB\s-1DER\s0\fR option uses an \s-1ASN1\s0 \s-1DER\s0 encoded
8b0cefbb 164form compatible with \s-1RFC2459\s0 (\s-1PKIX\s0) DSS-Parms that is a \s-1SEQUENCE\s0 consisting
984263bc
MD
165of p, q and g respectively. The \s-1PEM\s0 form is the default format: it consists
166of the \fB\s-1DER\s0\fR format base64 encoded with additional header and footer lines.
8b0cefbb
JR
167.IP "\fB\-outform DER|PEM\fR" 4
168.IX Item "-outform DER|PEM"
984263bc 169This specifies the output format, the options have the same meaning as the
8b0cefbb
JR
170\&\fB\-inform\fR option.
171.IP "\fB\-in filename\fR" 4
172.IX Item "-in filename"
984263bc
MD
173This specifies the input filename to read parameters from or standard input if
174this option is not specified. If the \fBnumbits\fR parameter is included then
175this option will be ignored.
8b0cefbb
JR
176.IP "\fB\-out filename\fR" 4
177.IX Item "-out filename"
984263bc
MD
178This specifies the output filename parameters to. Standard output is used
179if this option is not present. The output filename should \fBnot\fR be the same
180as the input filename.
8b0cefbb
JR
181.IP "\fB\-noout\fR" 4
182.IX Item "-noout"
984263bc 183this option inhibits the output of the encoded version of the parameters.
8b0cefbb
JR
184.IP "\fB\-text\fR" 4
185.IX Item "-text"
984263bc 186this option prints out the \s-1DSA\s0 parameters in human readable form.
8b0cefbb
JR
187.IP "\fB\-C\fR" 4
188.IX Item "-C"
984263bc 189this option converts the parameters into C code. The parameters can then
8b0cefbb
JR
190be loaded by calling the \fB\f(BIget_dsaXXX()\fB\fR function.
191.IP "\fB\-genkey\fR" 4
192.IX Item "-genkey"
984263bc
MD
193this option will generate a \s-1DSA\s0 either using the specified or generated
194parameters.
8b0cefbb
JR
195.IP "\fB\-rand file(s)\fR" 4
196.IX Item "-rand file(s)"
984263bc 197a file or files containing random data used to seed the random number
8b0cefbb
JR
198generator, or an \s-1EGD\s0 socket (see \fIRAND_egd\fR\|(3)).
199Multiple files can be specified separated by a OS-dependent character.
e257b235 200The separator is \fB;\fR for MS-Windows, \fB,\fR for OpenVMS, and \fB:\fR for
984263bc 201all others.
8b0cefbb
JR
202.IP "\fBnumbits\fR" 4
203.IX Item "numbits"
984263bc 204this option specifies that a parameter set should be generated of size
8b0cefbb 205\&\fBnumbits\fR. It must be the last option. If this option is included then
984263bc 206the input file (if any) is ignored.
8b0cefbb
JR
207.IP "\fB\-engine id\fR" 4
208.IX Item "-engine id"
984263bc
MD
209specifying an engine (by it's unique \fBid\fR string) will cause \fBreq\fR
210to attempt to obtain a functional reference to the specified engine,
211thus initialising it if needed. The engine will then be set as the default
212for all available algorithms.
213.SH "NOTES"
8b0cefbb
JR
214.IX Header "NOTES"
215\&\s-1PEM\s0 format \s-1DSA\s0 parameters use the header and footer lines:
984263bc
MD
216.PP
217.Vb 2
e257b235
PA
218\& \-\-\-\-\-BEGIN DSA PARAMETERS\-\-\-\-\-
219\& \-\-\-\-\-END DSA PARAMETERS\-\-\-\-\-
984263bc 220.Ve
8b0cefbb
JR
221.PP
222\&\s-1DSA\s0 parameter generation is a slow process and as a result the same set of
223\&\s-1DSA\s0 parameters is often used to generate several distinct keys.
984263bc 224.SH "SEE ALSO"
e3cdf75b 225.IX Header "SEE ALSO"
8b0cefbb
JR
226\&\fIgendsa\fR\|(1), \fIdsa\fR\|(1), \fIgenrsa\fR\|(1),
227\&\fIrsa\fR\|(1)