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

   1 .\" Automatically generated by Pod::Man 4.10 (Pod::Simple 3.35)
   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 .    ds C`
  42 .    ds C'
  43 'br\}
  44 .\"
  45 .\" Escape single quotes in literal strings from groff's Unicode transform.
  46 .ie \n(.g .ds Aq \(aq
  47 .el       .ds Aq '
  48 .\"
  49 .\" If the F register is >0, we'll generate index entries on stderr for
  50 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
  51 .\" entries marked with X<> in POD.  Of course, you'll have to process the
  52 .\" output yourself in some meaningful fashion.
  53 .\"
  54 .\" Avoid warning from groff about undefined register 'F'.
  55 .de IX
  56 ..
  57 .nr rF 0
  58 .if \n(.g .if rF .nr rF 1
  59 .if (\n(rF:(\n(.g==0)) \{\
  60 .    if \nF \{\
  61 .        de IX
  62 .        tm Index:\\$1\t\\n%\t"\\$2"
  63 ..
  64 .        if !\nF==2 \{\
  65 .            nr % 0
  66 .            nr F 2
  67 .        \}
  68 .    \}
  69 .\}
  70 .rr rF
  71 .\"
  72 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
  73 .\" Fear.  Run.  Save yourself.  No user-serviceable parts.
  74 .    \" fudge factors for nroff and troff
  75 .if n \{\
  76 .    ds #H 0
  77 .    ds #V .8m
  78 .    ds #F .3m
  79 .    ds #[ \f1
  80 .    ds #] \fP
  81 .\}
  82 .if t \{\
  83 .    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
  84 .    ds #V .6m
  85 .    ds #F 0
  86 .    ds #[ \&
  87 .    ds #] \&
  88 .\}
  89 .    \" simple accents for nroff and troff
  90 .if n \{\
  91 .    ds ' \&
  92 .    ds ` \&
  93 .    ds ^ \&
  94 .    ds , \&
  95 .    ds ~ ~
  96 .    ds /
  97 .\}
  98 .if t \{\
  99 .    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
 100 .    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
 101 .    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
 102 .    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
 103 .    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
 104 .    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
 105 .\}
 106 .    \" troff and (daisy-wheel) nroff accents
 107 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
 108 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
 109 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
 110 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
 111 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
 112 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
 113 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
 114 .ds ae a\h'-(\w'a'u*4/10)'e
 115 .ds Ae A\h'-(\w'A'u*4/10)'E
 116 .    \" corrections for vroff
 117 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
 118 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
 119 .    \" for low resolution devices (crt and lpr)
 120 .if \n(.H>23 .if \n(.V>19 \
 121 \{\
 122 .    ds : e
 123 .    ds 8 ss
 124 .    ds o a
 125 .    ds d- d\h'-1'\(ga
 126 .    ds D- D\h'-1'\(hy
 127 .    ds th \o'bp'
 128 .    ds Th \o'LP'
 129 .    ds ae ae
 130 .    ds Ae AE
 131 .\}
 132 .rm #[ #] #H #V #F C
 133 .\" ========================================================================
 134 .\"
 135 .IX Title "DHPARAM 1"
 136 .TH DHPARAM 1 "2019-02-26" "1.0.2r" "OpenSSL"
 137 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
 138 .\" way too many mistakes in technical documents.
 139 .if n .ad l
 140 .nh
 141 .SH "NAME"
 142 openssl\-dhparam,
 143 dhparam \- DH parameter manipulation and generation
 144 .SH "SYNOPSIS"
 145 .IX Header "SYNOPSIS"
 146 \&\fBopenssl dhparam\fR
 147 [\fB\-inform DER|PEM\fR]
 148 [\fB\-outform DER|PEM\fR]
 149 [\fB\-in\fR \fIfilename\fR]
 150 [\fB\-out\fR \fIfilename\fR]
 151 [\fB\-dsaparam\fR]
 152 [\fB\-check\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 \fIfile(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 DER\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\-check\fR" 4
 197 .IX Item "-check"
 198 check if the parameters are valid primes and generator.
 199 .IP "\fB\-2\fR, \fB\-5\fR" 4
 200 .IX Item "-2, -5"
 201 The generator to use, either 2 or 5. If present then the
 202 input file is ignored and parameters are generated instead. If not
 203 present but \fBnumbits\fR is present, parameters are generated with the
 204 default generator 2.
 205 .IP "\fB\-rand\fR \fIfile(s)\fR" 4
 206 .IX Item "-rand file(s)"
 207 a file or files containing random data used to seed the random number
 208 generator, or an \s-1EGD\s0 socket (see \fBRAND_egd\fR\|(3)).
 209 Multiple files can be specified separated by a OS-dependent character.
 210 The separator is \fB;\fR for MS-Windows, \fB,\fR for OpenVMS, and \fB:\fR for
 211 all others.
 212 .IP "\fInumbits\fR" 4
 213 .IX Item "numbits"
 214 this option specifies that a parameter set should be generated of size
 215 \&\fInumbits\fR. It must be the last option. If this option is present then
 216 the input file is ignored and parameters are generated instead. If
 217 this option is not present but a generator (\fB\-2\fR or \fB\-5\fR) is
 218 present, parameters are generated with a default length of 2048 bits.
 219 .IP "\fB\-noout\fR" 4
 220 .IX Item "-noout"
 221 this option inhibits the output of the encoded version of the parameters.
 222 .IP "\fB\-text\fR" 4
 223 .IX Item "-text"
 224 this option prints out the \s-1DH\s0 parameters in human readable form.
 225 .IP "\fB\-C\fR" 4
 226 .IX Item "-C"
 227 this option converts the parameters into C code. The parameters can then
 228 be loaded by calling the \fBget_dh\fR\fInumbits\fR\fB()\fR function.
 229 .IP "\fB\-engine id\fR" 4
 230 .IX Item "-engine id"
 231 specifying an engine (by its unique \fBid\fR string) will cause \fBdhparam\fR
 232 to attempt to obtain a functional reference to the specified engine,
 233 thus initialising it if needed. The engine will then be set as the default
 234 for all available algorithms.
 235 .SH "WARNINGS"
 236 .IX Header "WARNINGS"
 237 The program \fBdhparam\fR combines the functionality of the programs \fBdh\fR and
 238 \&\fBgendh\fR in previous versions of OpenSSL and SSLeay. The \fBdh\fR and \fBgendh\fR
 239 programs are retained for now but may have different purposes in future
 240 versions of OpenSSL.
 241 .SH "NOTES"
 242 .IX Header "NOTES"
 243 \&\s-1PEM\s0 format \s-1DH\s0 parameters use the header and footer lines:
 244 .PP
 245 .Vb 2
 246 \& \-\-\-\-\-BEGIN DH PARAMETERS\-\-\-\-\-
 247 \& \-\-\-\-\-END DH PARAMETERS\-\-\-\-\-
 248 .Ve
 249 .PP
 250 OpenSSL currently only supports the older PKCS#3 \s-1DH,\s0 not the newer X9.42
 251 \&\s-1DH.\s0
 252 .PP
 253 This program manipulates \s-1DH\s0 parameters not keys.
 254 .SH "BUGS"
 255 .IX Header "BUGS"
 256 There should be a way to generate and manipulate \s-1DH\s0 keys.
 257 .SH "SEE ALSO"
 258 .IX Header "SEE ALSO"
 259 \&\fBdsaparam\fR\|(1)
 260 .SH "HISTORY"
 261 .IX Header "HISTORY"
 262 The \fBdhparam\fR command was added in OpenSSL 0.9.5.
 263 The \fB\-dsaparam\fR option was added in OpenSSL 0.9.6.