b2f53e6705680316671b6f7d1881b9c021763255
[dragonfly.git] / secure / usr.bin / openssl / man / dhparam.1
1 .\" Automatically generated by Pod::Man 2.23 (Pod::Simple 3.14)
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 'br\}
42 .\"
43 .\" Escape single quotes in literal strings from groff's Unicode transform.
44 .ie \n(.g .ds Aq \(aq
45 .el       .ds Aq '
46 .\"
47 .\" If the F register is turned on, we'll generate index entries on stderr for
48 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
49 .\" entries marked with X<> in POD.  Of course, you'll have to process the
50 .\" output yourself in some meaningful fashion.
51 .ie \nF \{\
52 .    de IX
53 .    tm Index:\\$1\t\\n%\t"\\$2"
54 ..
55 .    nr % 0
56 .    rr F
57 .\}
58 .el \{\
59 .    de IX
60 ..
61 .\}
62 .\"
63 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
64 .\" Fear.  Run.  Save yourself.  No user-serviceable parts.
65 .    \" fudge factors for nroff and troff
66 .if n \{\
67 .    ds #H 0
68 .    ds #V .8m
69 .    ds #F .3m
70 .    ds #[ \f1
71 .    ds #] \fP
72 .\}
73 .if t \{\
74 .    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
75 .    ds #V .6m
76 .    ds #F 0
77 .    ds #[ \&
78 .    ds #] \&
79 .\}
80 .    \" simple accents for nroff and troff
81 .if n \{\
82 .    ds ' \&
83 .    ds ` \&
84 .    ds ^ \&
85 .    ds , \&
86 .    ds ~ ~
87 .    ds /
88 .\}
89 .if t \{\
90 .    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
91 .    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
92 .    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
93 .    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
94 .    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
95 .    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
96 .\}
97 .    \" troff and (daisy-wheel) nroff accents
98 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
99 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
100 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
101 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
102 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
103 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
104 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
105 .ds ae a\h'-(\w'a'u*4/10)'e
106 .ds Ae A\h'-(\w'A'u*4/10)'E
107 .    \" corrections for vroff
108 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
109 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
110 .    \" for low resolution devices (crt and lpr)
111 .if \n(.H>23 .if \n(.V>19 \
112 \{\
113 .    ds : e
114 .    ds 8 ss
115 .    ds o a
116 .    ds d- d\h'-1'\(ga
117 .    ds D- D\h'-1'\(hy
118 .    ds th \o'bp'
119 .    ds Th \o'LP'
120 .    ds ae ae
121 .    ds Ae AE
122 .\}
123 .rm #[ #] #H #V #F C
124 .\" ========================================================================
125 .\"
126 .IX Title "DHPARAM 1"
127 .TH DHPARAM 1 "2010-06-01" "1.0.0a" "OpenSSL"
128 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
129 .\" way too many mistakes in technical documents.
130 .if n .ad l
131 .nh
132 .SH "NAME"
133 dhparam \- DH parameter manipulation and generation
134 .SH "SYNOPSIS"
135 .IX Header "SYNOPSIS"
136 \&\fBopenssl dhparam\fR
137 [\fB\-inform DER|PEM\fR]
138 [\fB\-outform DER|PEM\fR]
139 [\fB\-in\fR \fIfilename\fR]
140 [\fB\-out\fR \fIfilename\fR]
141 [\fB\-dsaparam\fR]
142 [\fB\-noout\fR]
143 [\fB\-text\fR]
144 [\fB\-C\fR]
145 [\fB\-2\fR]
146 [\fB\-5\fR]
147 [\fB\-rand\fR \fIfile(s)\fR]
148 [\fB\-engine id\fR]
149 [\fInumbits\fR]
150 .SH "DESCRIPTION"
151 .IX Header "DESCRIPTION"
152 This command is used to manipulate \s-1DH\s0 parameter files.
153 .SH "OPTIONS"
154 .IX Header "OPTIONS"
155 .IP "\fB\-inform DER|PEM\fR" 4
156 .IX Item "-inform DER|PEM"
157 This specifies the input format. The \fB\s-1DER\s0\fR option uses an \s-1ASN1\s0 \s-1DER\s0 encoded
158 form compatible with the PKCS#3 DHparameter structure. The \s-1PEM\s0 form is the
159 default format: it consists of the \fB\s-1DER\s0\fR format base64 encoded with
160 additional header and footer lines.
161 .IP "\fB\-outform DER|PEM\fR" 4
162 .IX Item "-outform DER|PEM"
163 This specifies the output format, the options have the same meaning as the 
164 \&\fB\-inform\fR option.
165 .IP "\fB\-in\fR \fIfilename\fR" 4
166 .IX Item "-in filename"
167 This specifies the input filename to read parameters from or standard input if
168 this option is not specified.
169 .IP "\fB\-out\fR \fIfilename\fR" 4
170 .IX Item "-out filename"
171 This specifies the output filename parameters to. Standard output is used
172 if this option is not present. The output filename should \fBnot\fR be the same
173 as the input filename.
174 .IP "\fB\-dsaparam\fR" 4
175 .IX Item "-dsaparam"
176 If this option is used, \s-1DSA\s0 rather than \s-1DH\s0 parameters are read or created;
177 they are converted to \s-1DH\s0 format.  Otherwise, \*(L"strong\*(R" primes (such
178 that (p\-1)/2 is also prime) will be used for \s-1DH\s0 parameter generation.
179 .Sp
180 \&\s-1DH\s0 parameter generation with the \fB\-dsaparam\fR option is much faster,
181 and the recommended exponent length is shorter, which makes \s-1DH\s0 key
182 exchange more efficient.  Beware that with such DSA-style \s-1DH\s0
183 parameters, a fresh \s-1DH\s0 key should be created for each use to
184 avoid small-subgroup attacks that may be possible otherwise.
185 .IP "\fB\-2\fR, \fB\-5\fR" 4
186 .IX Item "-2, -5"
187 The generator to use, either 2 or 5. 2 is the default. If present then the
188 input file is ignored and parameters are generated instead.
189 .IP "\fB\-rand\fR \fIfile(s)\fR" 4
190 .IX Item "-rand file(s)"
191 a file or files containing random data used to seed the random number
192 generator, or an \s-1EGD\s0 socket (see \fIRAND_egd\fR\|(3)).
193 Multiple files can be specified separated by a OS-dependent character.
194 The separator is \fB;\fR for MS-Windows, \fB,\fR for OpenVMS, and \fB:\fR for
195 all others.
196 .IP "\fInumbits\fR" 4
197 .IX Item "numbits"
198 this option specifies that a parameter set should be generated of size
199 \&\fInumbits\fR. It must be the last option. If not present then a value of 512
200 is used. If this option is present then the input file is ignored and 
201 parameters are generated instead.
202 .IP "\fB\-noout\fR" 4
203 .IX Item "-noout"
204 this option inhibits the output of the encoded version of the parameters.
205 .IP "\fB\-text\fR" 4
206 .IX Item "-text"
207 this option prints out the \s-1DH\s0 parameters in human readable form.
208 .IP "\fB\-C\fR" 4
209 .IX Item "-C"
210 this option converts the parameters into C code. The parameters can then
211 be loaded by calling the \fBget_dh\fR\fInumbits\fR\fB()\fR function.
212 .IP "\fB\-engine id\fR" 4
213 .IX Item "-engine id"
214 specifying an engine (by its unique \fBid\fR string) will cause \fBdhparam\fR
215 to attempt to obtain a functional reference to the specified engine,
216 thus initialising it if needed. The engine will then be set as the default
217 for all available algorithms.
218 .SH "WARNINGS"
219 .IX Header "WARNINGS"
220 The program \fBdhparam\fR combines the functionality of the programs \fBdh\fR and
221 \&\fBgendh\fR in previous versions of OpenSSL and SSLeay. The \fBdh\fR and \fBgendh\fR
222 programs are retained for now but may have different purposes in future 
223 versions of OpenSSL.
224 .SH "NOTES"
225 .IX Header "NOTES"
226 \&\s-1PEM\s0 format \s-1DH\s0 parameters use the header and footer lines:
227 .PP
228 .Vb 2
229 \& \-\-\-\-\-BEGIN DH PARAMETERS\-\-\-\-\-
230 \& \-\-\-\-\-END DH PARAMETERS\-\-\-\-\-
231 .Ve
232 .PP
233 OpenSSL currently only supports the older PKCS#3 \s-1DH\s0, not the newer X9.42
234 \&\s-1DH\s0.
235 .PP
236 This program manipulates \s-1DH\s0 parameters not keys.
237 .SH "BUGS"
238 .IX Header "BUGS"
239 There should be a way to generate and manipulate \s-1DH\s0 keys.
240 .SH "SEE ALSO"
241 .IX Header "SEE ALSO"
242 \&\fIdsaparam\fR\|(1)
243 .SH "HISTORY"
244 .IX Header "HISTORY"
245 The \fBdhparam\fR command was added in OpenSSL 0.9.5.
246 The \fB\-dsaparam\fR option was added in OpenSSL 0.9.6.