NetBSD/lib/libcrypto/man/openssl_dhparam.1

321 lines
8.3 KiB
Groff

.rn '' }`
'''
'''
.de Sh
.br
.if t .Sp
.ne 5
.PP
\fB\\$1\fR
.PP
..
.de Sp
.if t .sp .5v
.if n .sp
..
.de Ip
.br
.ie \\n(.$>=3 .ne \\$3
.el .ne 3
.IP "\\$1" \\$2
..
.de Vb
.ft CW
.nf
.ne \\$1
..
.de Ve
.ft R
.fi
..
'''
'''
''' Set up \*(-- to give an unbreakable dash;
''' string Tr holds user defined translation string.
''' Bell System Logo is used as a dummy character.
'''
.tr \(*W-|\(bv\*(Tr
.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" ""
''' \*(M", \*(S", \*(N" and \*(T" are the equivalent of
''' \*(L" and \*(R", except that they are used on ".xx" lines,
''' such as .IP and .SH, which do another additional levels of
''' double-quote interpretation
.ds M" """
.ds S" """
.ds N" """""
.ds T" """""
.ds L' '
.ds R' '
.ds M' '
.ds S' '
.ds N' '
.ds T' '
'br\}
.el\{\
.ds -- \(em\|
.tr \*(Tr
.ds L" ``
.ds R" ''
.ds M" ``
.ds S" ''
.ds N" ``
.ds T" ''
.ds L' `
.ds R' '
.ds M' `
.ds S' '
.ds N' `
.ds T' '
.ds PI \(*p
'br\}
.\" If the F register is turned on, we'll generate
.\" index entries out stderr for the following things:
.\" TH Title
.\" SH Header
.\" Sh Subsection
.\" Ip Item
.\" X<> Xref (embedded
.\" Of course, you have to process the output yourself
.\" in some meaninful fashion.
.if \nF \{
.de IX
.tm Index:\\$1\t\\n%\t"\\$2"
..
.nr % 0
.rr F
.\}
.TH DHPARAM 1 "0.9.5a" "22/Jul/2000" "OpenSSL"
.UC
.if n .hy 0
.if n .na
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.de CQ \" put $1 in typewriter font
.ft CW
'if n "\c
'if t \\&\\$1\c
'if n \\&\\$1\c
'if n \&"
\\&\\$2 \\$3 \\$4 \\$5 \\$6 \\$7
'.ft R
..
.\" @(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2
. \" AM - accent mark definitions
.bd B 3
. \" 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 ? ?
. ds ! !
. ds /
. ds q
.\}
.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 ? \s-2c\h'-\w'c'u*7/10'\u\h'\*(#H'\zi\d\s+2\h'\w'c'u*8/10'
. ds ! \s-2\(or\s+2\h'-\w'\(or'u'\v'-.8m'.\v'.8m'
. ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
. ds q o\h'-\w'o'u*8/10'\s-4\v'.4m'\z\(*i\v'-.4m'\s+4\h'\w'o'u*8/10'
.\}
. \" 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 v \\k:\h'-(\\n(.wu*9/10-\*(#H)'\v'-\*(#V'\*(#[\s-4v\s0\v'\*(#V'\h'|\\n:u'\*(#]
.ds _ \\k:\h'-(\\n(.wu*9/10-\*(#H+(\*(#F*2/3))'\v'-.4m'\z\(hy\v'.4m'\h'|\\n:u'
.ds . \\k:\h'-(\\n(.wu*8/10)'\v'\*(#V*4/10'\z.\v'-\*(#V*4/10'\h'|\\n:u'
.ds 3 \*(#[\v'.2m'\s-2\&3\s0\v'-.2m'\*(#]
.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
.ds oe o\h'-(\w'o'u*4/10)'e
.ds Oe O\h'-(\w'O'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 v \h'-1'\o'\(aa\(ga'
. ds _ \h'-1'^
. ds . \h'-1'.
. ds 3 3
. 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
. ds oe oe
. ds Oe OE
.\}
.rm #[ #] #H #V #F C
.SH "NAME"
dhparam \- DH parameter manipulation and generation
.SH "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]
[\fInumbits\fR]
.SH "DESCRIPTION"
This command is used to manipulate DH parameter files.
.SH "OPTIONS"
.Ip "\fB\-inform \s-1DER\s0|\s-1PEM\s0\fR" 4
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 \s-1PKCS\s0#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 \s-1DER\s0|\s-1PEM\s0\fR" 4
This specifies the output format, the options have the same meaning as the
\fB\-inform\fR option.
.Ip "\fB\-in\fR \fIfilename\fR" 4
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
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
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 \s-1DSA\s0\-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
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
a file or files containing random data used to seed the random number
generator, or an \s-1EGD\s0 socket (see the \fIRAND_egd(3)|RAND_egd(3)\fR manpage).
Multiple files can be specified separated by a \s-1OS\s0\-dependent character.
The separator is \fB;\fR for \s-1MS\s0\-Windows, \fB,\fR for OpenVSM, and \fB:\fR for
all others.
.Ip "\fInumbits\fR" 4
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
this option inhibits the output of the encoded version of the parameters.
.Ip "\fB\-text\fR" 4
this option prints out the \s-1DH\s0 parameters in human readable form.
.Ip "\fB\-C\fR" 4
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.
.SH "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"
PEM format DH parameters use the header and footer lines:
.PP
.Vb 2
\& -----BEGIN DH PARAMETERS-----
\& -----END DH PARAMETERS-----
.Ve
OpenSSL currently only supports the older PKCS#3 DH, not the newer X9.42
DH.
.PP
This program manipulates DH parameters not keys.
.SH "BUGS"
There should be a way to generate and manipulate DH keys.
.SH "SEE ALSO"
the \fIdsaparam(1)|dsaparam(1)\fR manpage
.SH "HISTORY"
The \fBdhparam\fR command was added in OpenSSL 0.9.5.
The \fB\-dsaparam\fR option was added in OpenSSL 0.9.6.
.rn }` ''
.IX Title "DHPARAM 1"
.IX Name "dhparam - DH parameter manipulation and generation"
.IX Header "NAME"
.IX Header "SYNOPSIS"
.IX Header "DESCRIPTION"
.IX Header "OPTIONS"
.IX Item "\fB\-inform \s-1DER\s0|\s-1PEM\s0\fR"
.IX Item "\fB\-outform \s-1DER\s0|\s-1PEM\s0\fR"
.IX Item "\fB\-in\fR \fIfilename\fR"
.IX Item "\fB\-out\fR \fIfilename\fR"
.IX Item "\fB\-dsaparam\fR"
.IX Item "\fB\-2\fR, \fB\-5\fR"
.IX Item "\fB\-rand\fR \fIfile(s)\fR"
.IX Item "\fInumbits\fR"
.IX Item "\fB\-noout\fR"
.IX Item "\fB\-text\fR"
.IX Item "\fB\-C\fR"
.IX Header "WARNINGS"
.IX Header "NOTES"
.IX Header "BUGS"
.IX Header "SEE ALSO"
.IX Header "HISTORY"