crypto/external/bsd/openssl/lib/libcrypto/man/openssl_dhparam.1

   1 .\"     $NetBSD: libcrypto.pl,v 1.3 2007/11/27 22:16:03 christos Exp $
   2 .\"
   3 .\" Automatically generated by Pod::Man 2.16 (Pod::Simple 3.05)
   4 .\"
   5 .\" Standard preamble:
   6 .\" ========================================================================
   7 .de Sh \" Subsection heading
   8 .br
   9 .if t .Sp
  10 .ne 5
  11 .PP
  12 \fB\\$1\fR
  13 .PP
  14 ..
  15 .de Sp \" Vertical space (when we can't use .PP)
  16 .if t .sp .5v
  17 .if n .sp
  18 ..
  19 .de Vb \" Begin verbatim text
  20 .ft CW
  21 .nf
  22 .ne \\$1
  23 ..
  24 .de Ve \" End verbatim text
  25 .ft R
  26 .fi
  27 ..
  28 .\" Set up some character translations and predefined strings.  \*(-- will
  29 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
  30 .\" double quote, and \*(R" will give a right double quote.  \*(C+ will
  31 .\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
  32 .\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
  33 .\" nothing in troff, for use with C<>.
  34 .tr \(*W-
  35 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
  36 .ie n \{\
  37 .    ds -- \(*W-
  38 .    ds PI pi
  39 .    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
  40 .    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
  41 .    ds L" ""
  42 .    ds R" ""
  43 .    ds C` ""
  44 .    ds C' ""
  45 'br\}
  46 .el\{\
  47 .    ds -- \|\(em\|
  48 .    ds PI \(*p
  49 .    ds L" ``
  50 .    ds R" ''
  51 'br\}
  52 .\"
  53 .\" Escape single quotes in literal strings from groff's Unicode transform.
  54 .ie \n(.g .ds Aq \(aq
  55 .el       .ds Aq '
  56 .\"
  57 .\" If the F register is turned on, we'll generate index entries on stderr for
  58 .\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
  59 .\" entries marked with X<> in POD.  Of course, you'll have to process the
  60 .\" output yourself in some meaningful fashion.
  61 .ie \nF \{\
  62 .    de IX
  63 .    tm Index:\\$1\t\\n%\t"\\$2"
  64 ..
  65 .    nr % 0
  66 .    rr F
  67 .\}
  68 .el \{\
  69 .    de IX
  70 ..
  71 .\}
  72 .\"
  73 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
  74 .\" Fear.  Run.  Save yourself.  No user-serviceable parts.
  75 .    \" fudge factors for nroff and troff
  76 .if n \{\
  77 .    ds #H 0
  78 .    ds #V .8m
  79 .    ds #F .3m
  80 .    ds #[ \f1
  81 .    ds #] \fP
  82 .\}
  83 .if t \{\
  84 .    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
  85 .    ds #V .6m
  86 .    ds #F 0
  87 .    ds #[ \&
  88 .    ds #] \&
  89 .\}
  90 .    \" simple accents for nroff and troff
  91 .if n \{\
  92 .    ds ' \&
  93 .    ds ` \&
  94 .    ds ^ \&
  95 .    ds , \&
  96 .    ds ~ ~
  97 .    ds /
  98 .\}
  99 .if t \{\
 100 .    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
 101 .    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
 102 .    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
 103 .    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
 104 .    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
 105 .    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
 106 .\}
 107 .    \" troff and (daisy-wheel) nroff accents
 108 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
 109 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
 110 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
 111 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
 112 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
 113 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
 114 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
 115 .ds ae a\h'-(\w'a'u*4/10)'e
 116 .ds Ae A\h'-(\w'A'u*4/10)'E
 117 .    \" corrections for vroff
 118 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
 119 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
 120 .    \" for low resolution devices (crt and lpr)
 121 .if \n(.H>23 .if \n(.V>19 \
 122 \{\
 123 .    ds : e
 124 .    ds 8 ss
 125 .    ds o a
 126 .    ds d- d\h'-1'\(ga
 127 .    ds D- D\h'-1'\(hy
 128 .    ds th \o'bp'
 129 .    ds Th \o'LP'
 130 .    ds ae ae
 131 .    ds Ae AE
 132 .\}
 133 .rm #[ #] #H #V #F C
 134 .\" ========================================================================
 135 .\"
 136 .IX Title "DHPARAM 1"
 137 .TH DHPARAM 1 "2009-04-15" "1.1.0-dev" "OpenSSL"
 138 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
 139 .\" way too many mistakes in technical documents.
 140 .if n .ad l
 141 .nh
 142 .SH "NAME"
 143 dhparam \- DH parameter manipulation and generation
 144 .SH "LIBRARY"
 145 libcrypto, -lcrypto
 146 .SH "SYNOPSIS"
 147 .IX Header "SYNOPSIS"
 148 \&\fBopenssl dhparam\fR
 149 [\fB\-inform DER|PEM\fR]
 150 [\fB\-outform DER|PEM\fR]
 151 [\fB\-in\fR \fIfilename\fR]
 152 [\fB\-out\fR \fIfilename\fR]
 153 [\fB\-dsaparam\fR]
 154 [\fB\-noout\fR]
 155 [\fB\-text\fR]
 156 [\fB\-C\fR]
 157 [\fB\-2\fR]
 158 [\fB\-5\fR]
 159 [\fB\-rand\fR \fIfile(s)\fR]
 160 [\fB\-engine id\fR]
 161 [\fInumbits\fR]
 162 .SH "DESCRIPTION"
 163 .IX Header "DESCRIPTION"
 164 This command is used to manipulate \s-1DH\s0 parameter files.
 165 .SH "OPTIONS"
 166 .IX Header "OPTIONS"
 167 .IP "\fB\-inform DER|PEM\fR" 4
 168 .IX Item "-inform DER|PEM"
 169 This specifies the input format. The \fB\s-1DER\s0\fR option uses an \s-1ASN1\s0 \s-1DER\s0 encoded
 170 form compatible with the PKCS#3 DHparameter structure. The \s-1PEM\s0 form is the
 171 default format: it consists of the \fB\s-1DER\s0\fR format base64 encoded with
 172 additional header and footer lines.
 173 .IP "\fB\-outform DER|PEM\fR" 4
 174 .IX Item "-outform DER|PEM"
 175 This specifies the output format, the options have the same meaning as the
 176 \&\fB\-inform\fR option.
 177 .IP "\fB\-in\fR \fIfilename\fR" 4
 178 .IX Item "-in filename"
 179 This specifies the input filename to read parameters from or standard input if
 180 this option is not specified.
 181 .IP "\fB\-out\fR \fIfilename\fR" 4
 182 .IX Item "-out filename"
 183 This specifies the output filename parameters to. Standard output is used
 184 if this option is not present. The output filename should \fBnot\fR be the same
 185 as the input filename.
 186 .IP "\fB\-dsaparam\fR" 4
 187 .IX Item "-dsaparam"
 188 If this option is used, \s-1DSA\s0 rather than \s-1DH\s0 parameters are read or created;
 189 they are converted to \s-1DH\s0 format.  Otherwise, \*(L"strong\*(R" primes (such
 190 that (p\-1)/2 is also prime) will be used for \s-1DH\s0 parameter generation.
 191 .Sp
 192 \&\s-1DH\s0 parameter generation with the \fB\-dsaparam\fR option is much faster,
 193 and the recommended exponent length is shorter, which makes \s-1DH\s0 key
 194 exchange more efficient.  Beware that with such DSA-style \s-1DH\s0
 195 parameters, a fresh \s-1DH\s0 key should be created for each use to
 196 avoid small-subgroup attacks that may be possible otherwise.
 197 .IP "\fB\-2\fR, \fB\-5\fR" 4
 198 .IX Item "-2, -5"
 199 The generator to use, either 2 or 5. 2 is the default. If present then the
 200 input file is ignored and parameters are generated instead.
 201 .IP "\fB\-rand\fR \fIfile(s)\fR" 4
 202 .IX Item "-rand file(s)"
 203 a file or files containing random data used to seed the random number
 204 generator, or an \s-1EGD\s0 socket (see \fIRAND_egd\fR\|(3)).
 205 Multiple files can be specified separated by a OS-dependent character.
 206 The separator is \fB;\fR for MS-Windows, \fB,\fR for OpenVMS, and \fB:\fR for
 207 all others.
 208 .IP "\fInumbits\fR" 4
 209 .IX Item "numbits"
 210 this option specifies that a parameter set should be generated of size
 211 \&\fInumbits\fR. It must be the last option. If not present then a value of 512
 212 is used. If this option is present then the input file is ignored and
 213 parameters are generated instead.
 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 \&\fIopenssl_dsaparam\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.