secure/usr.bin/openssl/man/dhparam.1

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