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

   1 .\" Automatically generated by Pod::Man 4.07 (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 .if !\nF .nr F 0
  58 .if \nF>0 \{\
  59 .    de IX
  60 .    tm Index:\\$1\t\\n%\t"\\$2"
  61 ..
  62 .    if !\nF==2 \{\
  63 .        nr % 0
  64 .        nr F 2
  65 .    \}
  66 .\}
  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 "2017-05-25" "1.0.2l" "OpenSSL"
 133 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
 134 .\" way too many mistakes in technical documents.
 135 .if n .ad l
 136 .nh
 137 .SH "NAME"
 138 dhparam \- DH parameter manipulation and generation
 139 .SH "SYNOPSIS"
 140 .IX Header "SYNOPSIS"
 141 \&\fBopenssl dhparam\fR
 142 [\fB\-inform DER|PEM\fR]
 143 [\fB\-outform DER|PEM\fR]
 144 [\fB\-in\fR \fIfilename\fR]
 145 [\fB\-out\fR \fIfilename\fR]
 146 [\fB\-dsaparam\fR]
 147 [\fB\-check\fR]
 148 [\fB\-noout\fR]
 149 [\fB\-text\fR]
 150 [\fB\-C\fR]
 151 [\fB\-2\fR]
 152 [\fB\-5\fR]
 153 [\fB\-rand\fR \fIfile(s)\fR]
 154 [\fB\-engine id\fR]
 155 [\fInumbits\fR]
 156 .SH "DESCRIPTION"
 157 .IX Header "DESCRIPTION"
 158 This command is used to manipulate \s-1DH\s0 parameter files.
 159 .SH "OPTIONS"
 160 .IX Header "OPTIONS"
 161 .IP "\fB\-inform DER|PEM\fR" 4
 162 .IX Item "-inform DER|PEM"
 163 This specifies the input format. The \fB\s-1DER\s0\fR option uses an \s-1ASN1 DER\s0 encoded
 164 form compatible with the PKCS#3 DHparameter structure. The \s-1PEM\s0 form is the
 165 default format: it consists of the \fB\s-1DER\s0\fR format base64 encoded with
 166 additional header and footer lines.
 167 .IP "\fB\-outform DER|PEM\fR" 4
 168 .IX Item "-outform DER|PEM"
 169 This specifies the output format, the options have the same meaning as the
 170 \&\fB\-inform\fR option.
 171 .IP "\fB\-in\fR \fIfilename\fR" 4
 172 .IX Item "-in filename"
 173 This specifies the input filename to read parameters from or standard input if
 174 this option is not specified.
 175 .IP "\fB\-out\fR \fIfilename\fR" 4
 176 .IX Item "-out filename"
 177 This specifies the output filename parameters to. Standard output is used
 178 if this option is not present. The output filename should \fBnot\fR be the same
 179 as the input filename.
 180 .IP "\fB\-dsaparam\fR" 4
 181 .IX Item "-dsaparam"
 182 If this option is used, \s-1DSA\s0 rather than \s-1DH\s0 parameters are read or created;
 183 they are converted to \s-1DH\s0 format.  Otherwise, \*(L"strong\*(R" primes (such
 184 that (p\-1)/2 is also prime) will be used for \s-1DH\s0 parameter generation.
 185 .Sp
 186 \&\s-1DH\s0 parameter generation with the \fB\-dsaparam\fR option is much faster,
 187 and the recommended exponent length is shorter, which makes \s-1DH\s0 key
 188 exchange more efficient.  Beware that with such DSA-style \s-1DH\s0
 189 parameters, a fresh \s-1DH\s0 key should be created for each use to
 190 avoid small-subgroup attacks that may be possible otherwise.
 191 .IP "\fB\-check\fR" 4
 192 .IX Item "-check"
 193 check if the parameters are valid primes and generator.
 194 .IP "\fB\-2\fR, \fB\-5\fR" 4
 195 .IX Item "-2, -5"
 196 The generator to use, either 2 or 5. If present then the
 197 input file is ignored and parameters are generated instead. If not
 198 present but \fBnumbits\fR is present, parameters are generated with the
 199 default generator 2.
 200 .IP "\fB\-rand\fR \fIfile(s)\fR" 4
 201 .IX Item "-rand file(s)"
 202 a file or files containing random data used to seed the random number
 203 generator, or an \s-1EGD\s0 socket (see \fIRAND_egd\fR\|(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 this option is present then
 211 the input file is ignored and parameters are generated instead. If
 212 this option is not present but a generator (\fB\-2\fR or \fB\-5\fR) is
 213 present, parameters are generated with a default length of 2048 bits.
 214 .IP "\fB\-noout\fR" 4
 215 .IX Item "-noout"
 216 this option inhibits the output of the encoded version of the parameters.
 217 .IP "\fB\-text\fR" 4
 218 .IX Item "-text"
 219 this option prints out the \s-1DH\s0 parameters in human readable form.
 220 .IP "\fB\-C\fR" 4
 221 .IX Item "-C"
 222 this option converts the parameters into C code. The parameters can then
 223 be loaded by calling the \fBget_dh\fR\fInumbits\fR\fB()\fR function.
 224 .IP "\fB\-engine id\fR" 4
 225 .IX Item "-engine id"
 226 specifying an engine (by its unique \fBid\fR string) will cause \fBdhparam\fR
 227 to attempt to obtain a functional reference to the specified engine,
 228 thus initialising it if needed. The engine will then be set as the default
 229 for all available algorithms.
 230 .SH "WARNINGS"
 231 .IX Header "WARNINGS"
 232 The program \fBdhparam\fR combines the functionality of the programs \fBdh\fR and
 233 \&\fBgendh\fR in previous versions of OpenSSL and SSLeay. The \fBdh\fR and \fBgendh\fR
 234 programs are retained for now but may have different purposes in future
 235 versions of OpenSSL.
 236 .SH "NOTES"
 237 .IX Header "NOTES"
 238 \&\s-1PEM\s0 format \s-1DH\s0 parameters use the header and footer lines:
 239 .PP
 240 .Vb 2
 241 \& \-\-\-\-\-BEGIN DH PARAMETERS\-\-\-\-\-
 242 \& \-\-\-\-\-END DH PARAMETERS\-\-\-\-\-
 243 .Ve
 244 .PP
 245 OpenSSL currently only supports the older PKCS#3 \s-1DH,\s0 not the newer X9.42
 246 \&\s-1DH.\s0
 247 .PP
 248 This program manipulates \s-1DH\s0 parameters not keys.
 249 .SH "BUGS"
 250 .IX Header "BUGS"
 251 There should be a way to generate and manipulate \s-1DH\s0 keys.
 252 .SH "SEE ALSO"
 253 .IX Header "SEE ALSO"
 254 \&\fIdsaparam\fR\|(1)
 255 .SH "HISTORY"
 256 .IX Header "HISTORY"
 257 The \fBdhparam\fR command was added in OpenSSL 0.9.5.
 258 The \fB\-dsaparam\fR option was added in OpenSSL 0.9.6.