- update OpenSSL to 0.9.8
[dragonfly.git] / secure / usr.bin / openssl / man / dhparam.1
1 .\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.14
2 .\"
3 .\" Standard preamble:
4 .\" ========================================================================
5 .de Sh \" Subsection heading
6 .br
7 .if t .Sp
8 .ne 5
9 .PP
10 \fB\\$1\fR
11 .PP
12 ..
13 .de Sp \" Vertical space (when we can't use .PP)
14 .if t .sp .5v
15 .if n .sp
16 ..
17 .de Vb \" Begin verbatim text
18 .ft CW
19 .nf
20 .ne \\$1
21 ..
22 .de Ve \" End verbatim text
23 .ft R
24 .fi
25 ..
26 .\" Set up some character translations and predefined strings.  \*(-- will
27 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
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
33 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
34 .ie n \{\
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' ""
43 'br\}
44 .el\{\
45 .    ds -- \|\(em\|
46 .    ds PI \(*p
47 .    ds L" ``
48 .    ds R" ''
49 'br\}
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"
58 ..
59 .    nr % 0
60 .    rr F
61 .\}
62 .\"
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 .\"
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 "DHPARAM 1"
132 .TH DHPARAM 1 "2005-07-06" "0.9.8" "OpenSSL"
133 .SH "NAME"
134 dhparam \- DH parameter manipulation and generation
135 .SH "SYNOPSIS"
136 .IX Header "SYNOPSIS"
137 \&\fBopenssl dhparam\fR
138 [\fB\-inform DER|PEM\fR]
139 [\fB\-outform DER|PEM\fR]
140 [\fB\-in\fR \fIfilename\fR]
141 [\fB\-out\fR \fIfilename\fR]
142 [\fB\-dsaparam\fR]
143 [\fB\-noout\fR]
144 [\fB\-text\fR]
145 [\fB\-C\fR]
146 [\fB\-2\fR]
147 [\fB\-5\fR]
148 [\fB\-rand\fR \fIfile(s)\fR]
149 [\fB\-engine id\fR]
150 [\fInumbits\fR]
151 .SH "DESCRIPTION"
152 .IX Header "DESCRIPTION"
153 This command is used to manipulate \s-1DH\s0 parameter files.
154 .SH "OPTIONS"
155 .IX Header "OPTIONS"
156 .IP "\fB\-inform DER|PEM\fR" 4
157 .IX Item "-inform DER|PEM"
158 This specifies the input format. The \fB\s-1DER\s0\fR option uses an \s-1ASN1\s0 \s-1DER\s0 encoded
159 form compatible with the PKCS#3 DHparameter structure. The \s-1PEM\s0 form is the
160 default format: it consists of the \fB\s-1DER\s0\fR format base64 encoded with
161 additional header and footer lines.
162 .IP "\fB\-outform DER|PEM\fR" 4
163 .IX Item "-outform DER|PEM"
164 This specifies the output format, the options have the same meaning as the 
165 \&\fB\-inform\fR option.
166 .IP "\fB\-in\fR \fIfilename\fR" 4
167 .IX Item "-in filename"
168 This specifies the input filename to read parameters from or standard input if
169 this option is not specified.
170 .IP "\fB\-out\fR \fIfilename\fR" 4
171 .IX Item "-out filename"
172 This specifies the output filename parameters to. Standard output is used
173 if this option is not present. The output filename should \fBnot\fR be the same
174 as the input filename.
175 .IP "\fB\-dsaparam\fR" 4
176 .IX Item "-dsaparam"
177 If this option is used, \s-1DSA\s0 rather than \s-1DH\s0 parameters are read or created;
178 they are converted to \s-1DH\s0 format.  Otherwise, \*(L"strong\*(R" primes (such
179 that (p\-1)/2 is also prime) will be used for \s-1DH\s0 parameter generation.
180 .Sp
181 \&\s-1DH\s0 parameter generation with the \fB\-dsaparam\fR option is much faster,
182 and the recommended exponent length is shorter, which makes \s-1DH\s0 key
183 exchange more efficient.  Beware that with such DSA-style \s-1DH\s0
184 parameters, a fresh \s-1DH\s0 key should be created for each use to
185 avoid small-subgroup attacks that may be possible otherwise.
186 .IP "\fB\-2\fR, \fB\-5\fR" 4
187 .IX Item "-2, -5"
188 The generator to use, either 2 or 5. 2 is the default. If present then the
189 input file is ignored and parameters are generated instead.
190 .IP "\fB\-rand\fR \fIfile(s)\fR" 4
191 .IX Item "-rand file(s)"
192 a file or files containing random data used to seed the random number
193 generator, or an \s-1EGD\s0 socket (see \fIRAND_egd\fR\|(3)).
194 Multiple files can be specified separated by a OS-dependent character.
195 The separator is \fB;\fR for MS\-Windows, \fB,\fR for OpenVMS, and \fB:\fR for
196 all others.
197 .IP "\fInumbits\fR" 4
198 .IX Item "numbits"
199 this option specifies that a parameter set should be generated of size
200 \&\fInumbits\fR. It must be the last option. If not present then a value of 512
201 is used. If this option is present then the input file is ignored and 
202 parameters are generated instead.
203 .IP "\fB\-noout\fR" 4
204 .IX Item "-noout"
205 this option inhibits the output of the encoded version of the parameters.
206 .IP "\fB\-text\fR" 4
207 .IX Item "-text"
208 this option prints out the \s-1DH\s0 parameters in human readable form.
209 .IP "\fB\-C\fR" 4
210 .IX Item "-C"
211 this option converts the parameters into C code. The parameters can then
212 be loaded by calling the \fBget_dh\fR\fInumbits\fR\fB()\fR function.
213 .IP "\fB\-engine id\fR" 4
214 .IX Item "-engine id"
215 specifying an engine (by it's unique \fBid\fR string) will cause \fBreq\fR
216 to attempt to obtain a functional reference to the specified engine,
217 thus initialising it if needed. The engine will then be set as the default
218 for all available algorithms.
219 .SH "WARNINGS"
220 .IX Header "WARNINGS"
221 The program \fBdhparam\fR combines the functionality of the programs \fBdh\fR and
222 \&\fBgendh\fR in previous versions of OpenSSL and SSLeay. The \fBdh\fR and \fBgendh\fR
223 programs are retained for now but may have different purposes in future 
224 versions of OpenSSL.
225 .SH "NOTES"
226 .IX Header "NOTES"
227 \&\s-1PEM\s0 format \s-1DH\s0 parameters use the header and footer lines:
228 .PP
229 .Vb 2
230 \& -----BEGIN DH PARAMETERS-----
231 \& -----END DH PARAMETERS-----
232 .Ve
233 .PP
234 OpenSSL currently only supports the older PKCS#3 \s-1DH\s0, not the newer X9.42
235 \&\s-1DH\s0.
236 .PP
237 This program manipulates \s-1DH\s0 parameters not keys.
238 .SH "BUGS"
239 .IX Header "BUGS"
240 There should be a way to generate and manipulate \s-1DH\s0 keys.
241 .SH "SEE ALSO"
242 .IX Header "SEE ALSO"
243 \&\fIdsaparam\fR\|(1)
244 .SH "HISTORY"
245 .IX Header "HISTORY"
246 The \fBdhparam\fR command was added in OpenSSL 0.9.5.
247 The \fB\-dsaparam\fR option was added in OpenSSL 0.9.6.