252 lines
8.2 KiB
Groff
252 lines
8.2 KiB
Groff
.\" $NetBSD: openssl_dhparam.1,v 1.15 2006/11/13 22:02:01 christos Exp $
|
|
.\"
|
|
.\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.32
|
|
.\"
|
|
.\" Standard preamble:
|
|
.\" ========================================================================
|
|
.de Sh \" Subsection heading
|
|
.br
|
|
.if t .Sp
|
|
.ne 5
|
|
.PP
|
|
\fB\\$1\fR
|
|
.PP
|
|
..
|
|
.de Sp \" Vertical space (when we can't use .PP)
|
|
.if t .sp .5v
|
|
.if n .sp
|
|
..
|
|
.de Vb \" Begin verbatim text
|
|
.ft CW
|
|
.nf
|
|
.ne \\$1
|
|
..
|
|
.de Ve \" End verbatim text
|
|
.ft R
|
|
.fi
|
|
..
|
|
.\" Set up some character translations and predefined strings. \*(-- will
|
|
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
|
|
.\" double quote, and \*(R" will give a right double quote. | will give a
|
|
.\" real vertical bar. \*(C+ will give a nicer C++. Capital omega is used to
|
|
.\" do unbreakable dashes and therefore won't be available. \*(C` and \*(C'
|
|
.\" expand to `' in nroff, nothing in troff, for use with C<>.
|
|
.tr \(*W-|\(bv\*(Tr
|
|
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
|
|
.ie n \{\
|
|
. ds -- \(*W-
|
|
. ds PI pi
|
|
. if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
|
|
. if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch
|
|
. ds L" ""
|
|
. ds R" ""
|
|
. ds C` ""
|
|
. ds C' ""
|
|
'br\}
|
|
.el\{\
|
|
. ds -- \|\(em\|
|
|
. ds PI \(*p
|
|
. ds L" ``
|
|
. ds R" ''
|
|
'br\}
|
|
.\"
|
|
.\" If the F register is turned on, we'll generate index entries on stderr for
|
|
.\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
|
|
.\" entries marked with X<> in POD. Of course, you'll have to process the
|
|
.\" output yourself in some meaningful fashion.
|
|
.if \nF \{\
|
|
. de IX
|
|
. tm Index:\\$1\t\\n%\t"\\$2"
|
|
..
|
|
. nr % 0
|
|
. rr F
|
|
.\}
|
|
.\"
|
|
.\" For nroff, turn off justification. Always turn off hyphenation; it makes
|
|
.\" way too many mistakes in technical documents.
|
|
.hy 0
|
|
.if n .na
|
|
.\"
|
|
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
|
|
.\" Fear. Run. Save yourself. No user-serviceable parts.
|
|
. \" fudge factors for nroff and troff
|
|
.if n \{\
|
|
. ds #H 0
|
|
. ds #V .8m
|
|
. ds #F .3m
|
|
. ds #[ \f1
|
|
. ds #] \fP
|
|
.\}
|
|
.if t \{\
|
|
. ds #H ((1u-(\\\\n(.fu%2u))*.13m)
|
|
. ds #V .6m
|
|
. ds #F 0
|
|
. ds #[ \&
|
|
. ds #] \&
|
|
.\}
|
|
. \" simple accents for nroff and troff
|
|
.if n \{\
|
|
. ds ' \&
|
|
. ds ` \&
|
|
. ds ^ \&
|
|
. ds , \&
|
|
. ds ~ ~
|
|
. ds /
|
|
.\}
|
|
.if t \{\
|
|
. ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
|
|
. ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
|
|
. ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
|
|
. ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
|
|
. ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
|
|
. ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
|
|
.\}
|
|
. \" troff and (daisy-wheel) nroff accents
|
|
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
|
|
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
|
|
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
|
|
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
|
|
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
|
|
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
|
|
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
|
|
.ds ae a\h'-(\w'a'u*4/10)'e
|
|
.ds Ae A\h'-(\w'A'u*4/10)'E
|
|
. \" corrections for vroff
|
|
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
|
|
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
|
|
. \" for low resolution devices (crt and lpr)
|
|
.if \n(.H>23 .if \n(.V>19 \
|
|
\{\
|
|
. ds : e
|
|
. ds 8 ss
|
|
. ds o a
|
|
. ds d- d\h'-1'\(ga
|
|
. ds D- D\h'-1'\(hy
|
|
. ds th \o'bp'
|
|
. ds Th \o'LP'
|
|
. ds ae ae
|
|
. ds Ae AE
|
|
.\}
|
|
.rm #[ #] #H #V #F C
|
|
.\" ========================================================================
|
|
.\"
|
|
.IX Title "DHPARAM 1"
|
|
.TH DHPARAM 1 "2003-07-24" "0.9.8d" "OpenSSL"
|
|
.SH "NAME"
|
|
dhparam \- DH parameter manipulation and generation
|
|
.SH "LIBRARY"
|
|
libcrypto, -lcrypto
|
|
.SH "SYNOPSIS"
|
|
.IX Header "SYNOPSIS"
|
|
\&\fBopenssl dhparam\fR
|
|
[\fB\-inform DER|PEM\fR]
|
|
[\fB\-outform DER|PEM\fR]
|
|
[\fB\-in\fR \fIfilename\fR]
|
|
[\fB\-out\fR \fIfilename\fR]
|
|
[\fB\-dsaparam\fR]
|
|
[\fB\-noout\fR]
|
|
[\fB\-text\fR]
|
|
[\fB\-C\fR]
|
|
[\fB\-2\fR]
|
|
[\fB\-5\fR]
|
|
[\fB\-rand\fR \fIfile(s)\fR]
|
|
[\fB\-engine id\fR]
|
|
[\fInumbits\fR]
|
|
.SH "DESCRIPTION"
|
|
.IX Header "DESCRIPTION"
|
|
This command is used to manipulate \s-1DH\s0 parameter files.
|
|
.SH "OPTIONS"
|
|
.IX Header "OPTIONS"
|
|
.IP "\fB\-inform DER|PEM\fR" 4
|
|
.IX Item "-inform DER|PEM"
|
|
This specifies the input format. The \fB\s-1DER\s0\fR option uses an \s-1ASN1\s0 \s-1DER\s0 encoded
|
|
form compatible with the PKCS#3 DHparameter structure. The \s-1PEM\s0 form is the
|
|
default format: it consists of the \fB\s-1DER\s0\fR format base64 encoded with
|
|
additional header and footer lines.
|
|
.IP "\fB\-outform DER|PEM\fR" 4
|
|
.IX Item "-outform DER|PEM"
|
|
This specifies the output format, the options have the same meaning as the
|
|
\&\fB\-inform\fR option.
|
|
.IP "\fB\-in\fR \fIfilename\fR" 4
|
|
.IX Item "-in filename"
|
|
This specifies the input filename to read parameters from or standard input if
|
|
this option is not specified.
|
|
.IP "\fB\-out\fR \fIfilename\fR" 4
|
|
.IX Item "-out filename"
|
|
This specifies the output filename parameters to. Standard output is used
|
|
if this option is not present. The output filename should \fBnot\fR be the same
|
|
as the input filename.
|
|
.IP "\fB\-dsaparam\fR" 4
|
|
.IX Item "-dsaparam"
|
|
If this option is used, \s-1DSA\s0 rather than \s-1DH\s0 parameters are read or created;
|
|
they are converted to \s-1DH\s0 format. Otherwise, \*(L"strong\*(R" primes (such
|
|
that (p\-1)/2 is also prime) will be used for \s-1DH\s0 parameter generation.
|
|
.Sp
|
|
\&\s-1DH\s0 parameter generation with the \fB\-dsaparam\fR option is much faster,
|
|
and the recommended exponent length is shorter, which makes \s-1DH\s0 key
|
|
exchange more efficient. Beware that with such DSA-style \s-1DH\s0
|
|
parameters, a fresh \s-1DH\s0 key should be created for each use to
|
|
avoid small-subgroup attacks that may be possible otherwise.
|
|
.IP "\fB\-2\fR, \fB\-5\fR" 4
|
|
.IX Item "-2, -5"
|
|
The generator to use, either 2 or 5. 2 is the default. If present then the
|
|
input file is ignored and parameters are generated instead.
|
|
.IP "\fB\-rand\fR \fIfile(s)\fR" 4
|
|
.IX Item "-rand file(s)"
|
|
a file or files containing random data used to seed the random number
|
|
generator, or an \s-1EGD\s0 socket (see \fIRAND_egd\fR\|(3)).
|
|
Multiple files can be specified separated by a OS-dependent character.
|
|
The separator is \fB;\fR for MS\-Windows, \fB,\fR for OpenVMS, and \fB:\fR for
|
|
all others.
|
|
.IP "\fInumbits\fR" 4
|
|
.IX Item "numbits"
|
|
this option specifies that a parameter set should be generated of size
|
|
\&\fInumbits\fR. It must be the last option. If not present then a value of 512
|
|
is used. If this option is present then the input file is ignored and
|
|
parameters are generated instead.
|
|
.IP "\fB\-noout\fR" 4
|
|
.IX Item "-noout"
|
|
this option inhibits the output of the encoded version of the parameters.
|
|
.IP "\fB\-text\fR" 4
|
|
.IX Item "-text"
|
|
this option prints out the \s-1DH\s0 parameters in human readable form.
|
|
.IP "\fB\-C\fR" 4
|
|
.IX Item "-C"
|
|
this option converts the parameters into C code. The parameters can then
|
|
be loaded by calling the \fBget_dh\fR\fInumbits\fR\fB()\fR function.
|
|
.IP "\fB\-engine id\fR" 4
|
|
.IX Item "-engine id"
|
|
specifying an engine (by it's unique \fBid\fR string) will cause \fBreq\fR
|
|
to attempt to obtain a functional reference to the specified engine,
|
|
thus initialising it if needed. The engine will then be set as the default
|
|
for all available algorithms.
|
|
.SH "WARNINGS"
|
|
.IX Header "WARNINGS"
|
|
The program \fBdhparam\fR combines the functionality of the programs \fBdh\fR and
|
|
\&\fBgendh\fR in previous versions of OpenSSL and SSLeay. The \fBdh\fR and \fBgendh\fR
|
|
programs are retained for now but may have different purposes in future
|
|
versions of OpenSSL.
|
|
.SH "NOTES"
|
|
.IX Header "NOTES"
|
|
\&\s-1PEM\s0 format \s-1DH\s0 parameters use the header and footer lines:
|
|
.PP
|
|
.Vb 2
|
|
\& -----BEGIN DH PARAMETERS-----
|
|
\& -----END DH PARAMETERS-----
|
|
.Ve
|
|
.PP
|
|
OpenSSL currently only supports the older PKCS#3 \s-1DH\s0, not the newer X9.42
|
|
\&\s-1DH\s0.
|
|
.PP
|
|
This program manipulates \s-1DH\s0 parameters not keys.
|
|
.SH "BUGS"
|
|
.IX Header "BUGS"
|
|
There should be a way to generate and manipulate \s-1DH\s0 keys.
|
|
.SH "SEE ALSO"
|
|
.IX Header "SEE ALSO"
|
|
\&\fIdsaparam\fR\|(1)
|
|
.SH "HISTORY"
|
|
.IX Header "HISTORY"
|
|
The \fBdhparam\fR command was added in OpenSSL 0.9.5.
|
|
The \fB\-dsaparam\fR option was added in OpenSSL 0.9.6.
|