Update files for OpenSSL-1.0.0f import.
[dragonfly.git] / secure / usr.bin / openssl / man / dhparam.1
CommitLineData
e3261593 1.\" Automatically generated by Pod::Man 2.25 (Pod::Simple 3.19)
8b0cefbb
JR
2.\"
3.\" Standard preamble:
4.\" ========================================================================
8b0cefbb 5.de Sp \" Vertical space (when we can't use .PP)
984263bc
MD
6.if t .sp .5v
7.if n .sp
8..
8b0cefbb 9.de Vb \" Begin verbatim text
984263bc
MD
10.ft CW
11.nf
12.ne \\$1
13..
8b0cefbb 14.de Ve \" End verbatim text
984263bc 15.ft R
984263bc
MD
16.fi
17..
8b0cefbb
JR
18.\" Set up some character translations and predefined strings. \*(-- will
19.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
e257b235
PA
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-
8b0cefbb 25.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
984263bc 26.ie n \{\
8b0cefbb
JR
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' ""
984263bc
MD
35'br\}
36.el\{\
8b0cefbb
JR
37. ds -- \|\(em\|
38. ds PI \(*p
39. ds L" ``
40. ds R" ''
984263bc 41'br\}
8b0cefbb 42.\"
e257b235
PA
43.\" Escape single quotes in literal strings from groff's Unicode transform.
44.ie \n(.g .ds Aq \(aq
45.el .ds Aq '
46.\"
8b0cefbb 47.\" If the F register is turned on, we'll generate index entries on stderr for
01185282 48.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
8b0cefbb
JR
49.\" entries marked with X<> in POD. Of course, you'll have to process the
50.\" output yourself in some meaningful fashion.
e257b235 51.ie \nF \{\
8b0cefbb
JR
52. de IX
53. tm Index:\\$1\t\\n%\t"\\$2"
984263bc 54..
8b0cefbb
JR
55. nr % 0
56. rr F
984263bc 57.\}
e257b235
PA
58.el \{\
59. de IX
60..
61.\}
aac4ff6f 62.\"
8b0cefbb
JR
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
984263bc 66.if n \{\
8b0cefbb
JR
67. ds #H 0
68. ds #V .8m
69. ds #F .3m
70. ds #[ \f1
71. ds #] \fP
984263bc
MD
72.\}
73.if t \{\
8b0cefbb
JR
74. ds #H ((1u-(\\\\n(.fu%2u))*.13m)
75. ds #V .6m
76. ds #F 0
77. ds #[ \&
78. ds #] \&
984263bc 79.\}
8b0cefbb 80. \" simple accents for nroff and troff
984263bc 81.if n \{\
8b0cefbb
JR
82. ds ' \&
83. ds ` \&
84. ds ^ \&
85. ds , \&
86. ds ~ ~
87. ds /
984263bc
MD
88.\}
89.if t \{\
8b0cefbb
JR
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'
984263bc 96.\}
8b0cefbb 97. \" troff and (daisy-wheel) nroff accents
984263bc
MD
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
8b0cefbb 107. \" corrections for vroff
984263bc
MD
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'
8b0cefbb 110. \" for low resolution devices (crt and lpr)
984263bc
MD
111.if \n(.H>23 .if \n(.V>19 \
112\{\
8b0cefbb
JR
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
984263bc
MD
122.\}
123.rm #[ #] #H #V #F C
8b0cefbb
JR
124.\" ========================================================================
125.\"
126.IX Title "DHPARAM 1"
e3261593 127.TH DHPARAM 1 "2012-01-04" "1.0.0f" "OpenSSL"
e257b235
PA
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
984263bc 132.SH "NAME"
e3cdf75b 133dhparam \- DH parameter manipulation and generation
984263bc 134.SH "SYNOPSIS"
8b0cefbb
JR
135.IX Header "SYNOPSIS"
136\&\fBopenssl dhparam\fR
984263bc
MD
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]
e3cdf75b 147[\fB\-rand\fR \fIfile(s)\fR]
984263bc
MD
148[\fB\-engine id\fR]
149[\fInumbits\fR]
150.SH "DESCRIPTION"
8b0cefbb
JR
151.IX Header "DESCRIPTION"
152This command is used to manipulate \s-1DH\s0 parameter files.
984263bc 153.SH "OPTIONS"
8b0cefbb
JR
154.IX Header "OPTIONS"
155.IP "\fB\-inform DER|PEM\fR" 4
156.IX Item "-inform DER|PEM"
984263bc 157This specifies the input format. The \fB\s-1DER\s0\fR option uses an \s-1ASN1\s0 \s-1DER\s0 encoded
8b0cefbb 158form compatible with the PKCS#3 DHparameter structure. The \s-1PEM\s0 form is the
984263bc
MD
159default format: it consists of the \fB\s-1DER\s0\fR format base64 encoded with
160additional header and footer lines.
8b0cefbb
JR
161.IP "\fB\-outform DER|PEM\fR" 4
162.IX Item "-outform DER|PEM"
984263bc 163This specifies the output format, the options have the same meaning as the
8b0cefbb
JR
164\&\fB\-inform\fR option.
165.IP "\fB\-in\fR \fIfilename\fR" 4
166.IX Item "-in filename"
984263bc
MD
167This specifies the input filename to read parameters from or standard input if
168this option is not specified.
8b0cefbb
JR
169.IP "\fB\-out\fR \fIfilename\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\-dsaparam\fR" 4
175.IX Item "-dsaparam"
984263bc
MD
176If this option is used, \s-1DSA\s0 rather than \s-1DH\s0 parameters are read or created;
177they are converted to \s-1DH\s0 format. Otherwise, \*(L"strong\*(R" primes (such
8b0cefbb 178that (p\-1)/2 is also prime) will be used for \s-1DH\s0 parameter generation.
984263bc 179.Sp
8b0cefbb 180\&\s-1DH\s0 parameter generation with the \fB\-dsaparam\fR option is much faster,
984263bc 181and the recommended exponent length is shorter, which makes \s-1DH\s0 key
8b0cefbb 182exchange more efficient. Beware that with such DSA-style \s-1DH\s0
984263bc
MD
183parameters, a fresh \s-1DH\s0 key should be created for each use to
184avoid small-subgroup attacks that may be possible otherwise.
8b0cefbb
JR
185.IP "\fB\-2\fR, \fB\-5\fR" 4
186.IX Item "-2, -5"
984263bc
MD
187The generator to use, either 2 or 5. 2 is the default. If present then the
188input file is ignored and parameters are generated instead.
8b0cefbb
JR
189.IP "\fB\-rand\fR \fIfile(s)\fR" 4
190.IX Item "-rand file(s)"
984263bc 191a file or files containing random data used to seed the random number
8b0cefbb
JR
192generator, or an \s-1EGD\s0 socket (see \fIRAND_egd\fR\|(3)).
193Multiple files can be specified separated by a OS-dependent character.
e257b235 194The separator is \fB;\fR for MS-Windows, \fB,\fR for OpenVMS, and \fB:\fR for
984263bc 195all others.
8b0cefbb
JR
196.IP "\fInumbits\fR" 4
197.IX Item "numbits"
984263bc 198this option specifies that a parameter set should be generated of size
8b0cefbb 199\&\fInumbits\fR. It must be the last option. If not present then a value of 512
984263bc
MD
200is used. If this option is present then the input file is ignored and
201parameters are generated instead.
8b0cefbb
JR
202.IP "\fB\-noout\fR" 4
203.IX Item "-noout"
984263bc 204this option inhibits the output of the encoded version of the parameters.
8b0cefbb
JR
205.IP "\fB\-text\fR" 4
206.IX Item "-text"
984263bc 207this option prints out the \s-1DH\s0 parameters in human readable form.
8b0cefbb
JR
208.IP "\fB\-C\fR" 4
209.IX Item "-C"
984263bc
MD
210this option converts the parameters into C code. The parameters can then
211be loaded by calling the \fBget_dh\fR\fInumbits\fR\fB()\fR function.
8b0cefbb
JR
212.IP "\fB\-engine id\fR" 4
213.IX Item "-engine id"
01185282 214specifying an engine (by its unique \fBid\fR string) will cause \fBdhparam\fR
984263bc
MD
215to attempt to obtain a functional reference to the specified engine,
216thus initialising it if needed. The engine will then be set as the default
217for all available algorithms.
218.SH "WARNINGS"
8b0cefbb 219.IX Header "WARNINGS"
984263bc 220The program \fBdhparam\fR combines the functionality of the programs \fBdh\fR and
8b0cefbb 221\&\fBgendh\fR in previous versions of OpenSSL and SSLeay. The \fBdh\fR and \fBgendh\fR
984263bc
MD
222programs are retained for now but may have different purposes in future
223versions of OpenSSL.
224.SH "NOTES"
8b0cefbb
JR
225.IX Header "NOTES"
226\&\s-1PEM\s0 format \s-1DH\s0 parameters use the header and footer lines:
984263bc
MD
227.PP
228.Vb 2
e257b235
PA
229\& \-\-\-\-\-BEGIN DH PARAMETERS\-\-\-\-\-
230\& \-\-\-\-\-END DH PARAMETERS\-\-\-\-\-
984263bc 231.Ve
984263bc 232.PP
8b0cefbb
JR
233OpenSSL currently only supports the older PKCS#3 \s-1DH\s0, not the newer X9.42
234\&\s-1DH\s0.
235.PP
236This program manipulates \s-1DH\s0 parameters not keys.
984263bc 237.SH "BUGS"
8b0cefbb
JR
238.IX Header "BUGS"
239There should be a way to generate and manipulate \s-1DH\s0 keys.
984263bc 240.SH "SEE ALSO"
8b0cefbb
JR
241.IX Header "SEE ALSO"
242\&\fIdsaparam\fR\|(1)
984263bc 243.SH "HISTORY"
8b0cefbb 244.IX Header "HISTORY"
984263bc
MD
245The \fBdhparam\fR command was added in OpenSSL 0.9.5.
246The \fB\-dsaparam\fR option was added in OpenSSL 0.9.6.