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

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