629 lines
24 KiB
Plaintext
629 lines
24 KiB
Plaintext
|
.\" Automatically generated by Pod::Man 2.27 (Pod::Simple 3.28)
|
||
|
|
.\"
|
||
|
|
.\" Standard preamble:
|
||
|
|
.\" ========================================================================
|
||
|
|
.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. \*(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-
|
||
|
|
.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" ''
|
||
|
|
. ds C`
|
||
|
|
. ds C'
|
||
|
|
'br\}
|
||
|
|
.\"
|
||
|
|
.\" Escape single quotes in literal strings from groff's Unicode transform.
|
||
|
|
.ie \n(.g .ds Aq \(aq
|
||
|
|
.el .ds Aq '
|
||
|
|
.\"
|
||
|
|
.\" If the F register is turned on, we'll generate index entries on stderr for
|
||
|
|
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
|
||
|
|
.\" entries marked with X<> in POD. Of course, you'll have to process the
|
||
|
|
.\" output yourself in some meaningful fashion.
|
||
|
|
.\"
|
||
|
|
.\" Avoid warning from groff about undefined register 'F'.
|
||
|
|
.de IX
|
||
|
|
..
|
||
|
|
.nr rF 0
|
||
|
|
.if \n(.g .if rF .nr rF 1
|
||
|
|
.if (\n(rF:(\n(.g==0)) \{
|
||
|
|
. if \nF \{
|
||
|
|
. de IX
|
||
|
|
. tm Index:\\$1\t\\n%\t"\\$2"
|
||
|
|
..
|
||
|
|
. if !\nF==2 \{
|
||
|
|
. nr % 0
|
||
|
|
. nr F 2
|
||
|
|
. \}
|
||
|
|
. \}
|
||
|
|
.\}
|
||
|
|
.rr rF
|
||
|
|
.\"
|
||
|
|
.\" 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 "OPENSSL-GENPKEY 1ossl"
|
||
|
|
.TH OPENSSL-GENPKEY 1ossl "2024-03-21" "3.2.1" "OpenSSL"
|
||
|
|
.\" For nroff, turn off justification. Always turn off hyphenation; it makes
|
||
|
|
.\" way too many mistakes in technical documents.
|
||
|
|
.if n .ad l
|
||
|
|
.nh
|
||
|
|
.SH "NAME"
|
||
|
|
openssl\-genpkey \- generate a private key or key pair
|
||
|
|
.SH "SYNOPSIS"
|
||
|
|
.IX Header "SYNOPSIS"
|
||
|
|
\&\fBopenssl\fR \fBgenpkey\fR
|
||
|
|
[\fB\-help\fR]
|
||
|
|
[\fB\-out\fR \fIfilename\fR]
|
||
|
|
[\fB\-outpubkey\fR \fIfilename\fR]
|
||
|
|
[\fB\-outform\fR \fB\s-1DER\s0\fR|\fB\s-1PEM\s0\fR]
|
||
|
|
[\fB\-verbose\fR]
|
||
|
|
[\fB\-quiet\fR]
|
||
|
|
[\fB\-pass\fR \fIarg\fR]
|
||
|
|
[\fB\-\f(BIcipher\fB\fR]
|
||
|
|
[\fB\-paramfile\fR \fIfile\fR]
|
||
|
|
[\fB\-algorithm\fR \fIalg\fR]
|
||
|
|
[\fB\-pkeyopt\fR \fIopt\fR:\fIvalue\fR]
|
||
|
|
[\fB\-genparam\fR]
|
||
|
|
[\fB\-text\fR]
|
||
|
|
[\fB\-engine\fR \fIid\fR]
|
||
|
|
[\fB\-provider\fR \fIname\fR]
|
||
|
|
[\fB\-provider\-path\fR \fIpath\fR]
|
||
|
|
[\fB\-propquery\fR \fIpropq\fR]
|
||
|
|
[\fB\-config\fR \fIconfigfile\fR]
|
||
|
|
.SH "DESCRIPTION"
|
||
|
|
.IX Header "DESCRIPTION"
|
||
|
|
This command generates a private key or key pair.
|
||
|
|
.SH "OPTIONS"
|
||
|
|
.IX Header "OPTIONS"
|
||
|
|
.IP "\fB\-help\fR" 4
|
||
|
|
.IX Item "-help"
|
||
|
|
Print out a usage message.
|
||
|
|
.IP "\fB\-out\fR \fIfilename\fR" 4
|
||
|
|
.IX Item "-out filename"
|
||
|
|
Output the private key to the specified file. If this argument is not
|
||
|
|
specified then standard output is used.
|
||
|
|
.IP "\fB\-outpubkey\fR \fIfilename\fR" 4
|
||
|
|
.IX Item "-outpubkey filename"
|
||
|
|
Output the public key to the specified file. If this argument is not
|
||
|
|
specified then the public key is not output.
|
||
|
|
.IP "\fB\-outform\fR \fB\s-1DER\s0\fR|\fB\s-1PEM\s0\fR" 4
|
||
|
|
.IX Item "-outform DER|PEM"
|
||
|
|
The output format, except when \fB\-genparam\fR is given; the default is \fB\s-1PEM\s0\fR.
|
||
|
|
See \fIopenssl\-format\-options\fR\|(1) for details.
|
||
|
|
.Sp
|
||
|
|
When \fB\-genparam\fR is given, \fB\-outform\fR is ignored.
|
||
|
|
.IP "\fB\-verbose\fR" 4
|
||
|
|
.IX Item "-verbose"
|
||
|
|
Output \*(L"status dots\*(R" while generating keys.
|
||
|
|
.IP "\fB\-quiet\fR" 4
|
||
|
|
.IX Item "-quiet"
|
||
|
|
Do not output \*(L"status dots\*(R" while generating keys.
|
||
|
|
.IP "\fB\-pass\fR \fIarg\fR" 4
|
||
|
|
.IX Item "-pass arg"
|
||
|
|
The output file password source. For more information about the format of \fIarg\fR
|
||
|
|
see \fIopenssl\-passphrase\-options\fR\|(1).
|
||
|
|
.IP "\fB\-\f(BIcipher\fB\fR" 4
|
||
|
|
.IX Item "-cipher"
|
||
|
|
This option encrypts the private key with the supplied cipher. Any algorithm
|
||
|
|
name accepted by \fIEVP_get_cipherbyname()\fR is acceptable such as \fBdes3\fR.
|
||
|
|
.IP "\fB\-algorithm\fR \fIalg\fR" 4
|
||
|
|
.IX Item "-algorithm alg"
|
||
|
|
Public key algorithm to use such as \s-1RSA, DSA, DH\s0 or \s-1DHX.\s0 If used this option must
|
||
|
|
precede any \fB\-pkeyopt\fR options. The options \fB\-paramfile\fR and \fB\-algorithm\fR
|
||
|
|
are mutually exclusive. Engines or providers may add algorithms in addition to
|
||
|
|
the standard built-in ones.
|
||
|
|
.Sp
|
||
|
|
Valid built-in algorithm names for private key generation are \s-1RSA,\s0 RSA-PSS, \s-1EC,
|
||
|
|
X25519, X448, ED25519\s0 and \s-1ED448.\s0
|
||
|
|
.Sp
|
||
|
|
Valid built-in algorithm names for parameter generation (see the \fB\-genparam\fR
|
||
|
|
option) are \s-1DH, DSA\s0 and \s-1EC.\s0
|
||
|
|
.Sp
|
||
|
|
Note that the algorithm name X9.42 \s-1DH\s0 may be used as a synonym for \s-1DHX\s0 keys and
|
||
|
|
PKCS#3 refers to \s-1DH\s0 Keys. Some options are not shared between \s-1DH\s0 and \s-1DHX\s0 keys.
|
||
|
|
.IP "\fB\-pkeyopt\fR \fIopt\fR:\fIvalue\fR" 4
|
||
|
|
.IX Item "-pkeyopt opt:value"
|
||
|
|
Set the public key algorithm option \fIopt\fR to \fIvalue\fR. The precise set of
|
||
|
|
options supported depends on the public key algorithm used and its
|
||
|
|
implementation. See \*(L"\s-1KEY GENERATION OPTIONS\*(R"\s0 and
|
||
|
|
\&\*(L"\s-1PARAMETER GENERATION OPTIONS\*(R"\s0 below for more details.
|
||
|
|
.Sp
|
||
|
|
To list the possible \fIopt\fR values for an algorithm use:
|
||
|
|
\&\fBopenssl\fR \fBgenpkey\fR \-algorithm \s-1XXX\s0 \-help
|
||
|
|
.IP "\fB\-genparam\fR" 4
|
||
|
|
.IX Item "-genparam"
|
||
|
|
Generate a set of parameters instead of a private key. If used this option must
|
||
|
|
precede any \fB\-algorithm\fR, \fB\-paramfile\fR or \fB\-pkeyopt\fR options.
|
||
|
|
.IP "\fB\-paramfile\fR \fIfilename\fR" 4
|
||
|
|
.IX Item "-paramfile filename"
|
||
|
|
Some public key algorithms generate a private key based on a set of parameters.
|
||
|
|
They can be supplied using this option. If this option is used the public key
|
||
|
|
algorithm used is determined by the parameters. If used this option must
|
||
|
|
precede any \fB\-pkeyopt\fR options. The options \fB\-paramfile\fR and \fB\-algorithm\fR
|
||
|
|
are mutually exclusive.
|
||
|
|
.IP "\fB\-text\fR" 4
|
||
|
|
.IX Item "-text"
|
||
|
|
Print an (unencrypted) text representation of private and public keys and
|
||
|
|
parameters along with the \s-1PEM\s0 or \s-1DER\s0 structure.
|
||
|
|
.IP "\fB\-engine\fR \fIid\fR" 4
|
||
|
|
.IX Item "-engine id"
|
||
|
|
See \*(L"Engine Options\*(R" in \fIopenssl\fR\|(1).
|
||
|
|
This option is deprecated.
|
||
|
|
.IP "\fB\-provider\fR \fIname\fR" 4
|
||
|
|
.IX Item "-provider name"
|
||
|
|
.PD 0
|
||
|
|
.IP "\fB\-provider\-path\fR \fIpath\fR" 4
|
||
|
|
.IX Item "-provider-path path"
|
||
|
|
.IP "\fB\-propquery\fR \fIpropq\fR" 4
|
||
|
|
.IX Item "-propquery propq"
|
||
|
|
.PD
|
||
|
|
See \*(L"Provider Options\*(R" in \fIopenssl\fR\|(1), \fIprovider\fR\|(7), and \fIproperty\fR\|(7).
|
||
|
|
.IP "\fB\-config\fR \fIconfigfile\fR" 4
|
||
|
|
.IX Item "-config configfile"
|
||
|
|
See \*(L"Configuration Option\*(R" in \fIopenssl\fR\|(1).
|
||
|
|
.SH "KEY GENERATION OPTIONS"
|
||
|
|
.IX Header "KEY GENERATION OPTIONS"
|
||
|
|
The options supported by each algorithm and indeed each implementation of an
|
||
|
|
algorithm can vary. The options for the OpenSSL implementations are detailed
|
||
|
|
below. There are no key generation options defined for the X25519, X448, \s-1ED25519\s0
|
||
|
|
or \s-1ED448\s0 algorithms.
|
||
|
|
.SS "\s-1RSA\s0 Key Generation Options"
|
||
|
|
.IX Subsection "RSA Key Generation Options"
|
||
|
|
.IP "\fBrsa_keygen_bits:numbits\fR" 4
|
||
|
|
.IX Item "rsa_keygen_bits:numbits"
|
||
|
|
The number of bits in the generated key. If not specified 2048 is used.
|
||
|
|
.IP "\fBrsa_keygen_primes:numprimes\fR" 4
|
||
|
|
.IX Item "rsa_keygen_primes:numprimes"
|
||
|
|
The number of primes in the generated key. If not specified 2 is used.
|
||
|
|
.IP "\fBrsa_keygen_pubexp:value\fR" 4
|
||
|
|
.IX Item "rsa_keygen_pubexp:value"
|
||
|
|
The \s-1RSA\s0 public exponent value. This can be a large decimal or
|
||
|
|
hexadecimal value if preceded by \f(CW\*(C`0x\*(C'\fR. Default value is 65537.
|
||
|
|
.SS "RSA-PSS Key Generation Options"
|
||
|
|
.IX Subsection "RSA-PSS Key Generation Options"
|
||
|
|
Note: by default an \fBRSA-PSS\fR key has no parameter restrictions.
|
||
|
|
.IP "\fBrsa_keygen_bits\fR:\fInumbits\fR, \fBrsa_keygen_primes\fR:\fInumprimes\fR, \fBrsa_keygen_pubexp\fR:\fIvalue\fR" 4
|
||
|
|
.IX Item "rsa_keygen_bits:numbits, rsa_keygen_primes:numprimes, rsa_keygen_pubexp:value"
|
||
|
|
These options have the same meaning as the \fB\s-1RSA\s0\fR algorithm.
|
||
|
|
.IP "\fBrsa_pss_keygen_md\fR:\fIdigest\fR" 4
|
||
|
|
.IX Item "rsa_pss_keygen_md:digest"
|
||
|
|
If set the key is restricted and can only use \fIdigest\fR for signing.
|
||
|
|
.IP "\fBrsa_pss_keygen_mgf1_md\fR:\fIdigest\fR" 4
|
||
|
|
.IX Item "rsa_pss_keygen_mgf1_md:digest"
|
||
|
|
If set the key is restricted and can only use \fIdigest\fR as it's \s-1MGF1\s0
|
||
|
|
parameter.
|
||
|
|
.IP "\fBrsa_pss_keygen_saltlen\fR:\fIlen\fR" 4
|
||
|
|
.IX Item "rsa_pss_keygen_saltlen:len"
|
||
|
|
If set the key is restricted and \fIlen\fR specifies the minimum salt length.
|
||
|
|
.SS "\s-1EC\s0 Key Generation Options"
|
||
|
|
.IX Subsection "EC Key Generation Options"
|
||
|
|
The \s-1EC\s0 key generation options can also be used for parameter generation.
|
||
|
|
.IP "\fBec_paramgen_curve\fR:\fIcurve\fR" 4
|
||
|
|
.IX Item "ec_paramgen_curve:curve"
|
||
|
|
The \s-1EC\s0 curve to use. OpenSSL supports \s-1NIST\s0 curve names such as \*(L"P\-256\*(R".
|
||
|
|
.IP "\fBec_param_enc\fR:\fIencoding\fR" 4
|
||
|
|
.IX Item "ec_param_enc:encoding"
|
||
|
|
The encoding to use for parameters. The \fIencoding\fR parameter must be either
|
||
|
|
\&\fBnamed_curve\fR or \fBexplicit\fR. The default value is \fBnamed_curve\fR.
|
||
|
|
.SS "\s-1DH\s0 Key Generation Options"
|
||
|
|
.IX Subsection "DH Key Generation Options"
|
||
|
|
.IP "\fBgroup\fR:\fIname\fR" 4
|
||
|
|
.IX Item "group:name"
|
||
|
|
The \fBparamfile\fR option is not required if a named group is used here.
|
||
|
|
See the \*(L"\s-1DH\s0 Parameter Generation Options\*(R" section below.
|
||
|
|
.SH "PARAMETER GENERATION OPTIONS"
|
||
|
|
.IX Header "PARAMETER GENERATION OPTIONS"
|
||
|
|
The options supported by each algorithm and indeed each implementation of an
|
||
|
|
algorithm can vary. The options for the OpenSSL implementations are detailed
|
||
|
|
below.
|
||
|
|
.SS "\s-1DSA\s0 Parameter Generation Options"
|
||
|
|
.IX Subsection "DSA Parameter Generation Options"
|
||
|
|
.IP "\fBdsa_paramgen_bits\fR:\fInumbits\fR" 4
|
||
|
|
.IX Item "dsa_paramgen_bits:numbits"
|
||
|
|
The number of bits in the generated prime. If not specified 2048 is used.
|
||
|
|
.IP "\fBdsa_paramgen_q_bits\fR:\fInumbits\fR" 4
|
||
|
|
.IX Item "dsa_paramgen_q_bits:numbits"
|
||
|
|
.PD 0
|
||
|
|
.IP "\fBqbits\fR:\fInumbits\fR" 4
|
||
|
|
.IX Item "qbits:numbits"
|
||
|
|
.PD
|
||
|
|
The number of bits in the q parameter. Must be one of 160, 224 or 256. If not
|
||
|
|
specified 224 is used.
|
||
|
|
.IP "\fBdsa_paramgen_md\fR:\fIdigest\fR" 4
|
||
|
|
.IX Item "dsa_paramgen_md:digest"
|
||
|
|
.PD 0
|
||
|
|
.IP "\fBdigest\fR:\fIdigest\fR" 4
|
||
|
|
.IX Item "digest:digest"
|
||
|
|
.PD
|
||
|
|
The digest to use during parameter generation. Must be one of \fBsha1\fR, \fBsha224\fR
|
||
|
|
or \fBsha256\fR. If set, then the number of bits in \fBq\fR will match the output size
|
||
|
|
of the specified digest and the \fBdsa_paramgen_q_bits\fR parameter will be
|
||
|
|
ignored. If not set, then a digest will be used that gives an output matching
|
||
|
|
the number of bits in \fBq\fR, i.e. \fBsha1\fR if q length is 160, \fBsha224\fR if it 224
|
||
|
|
or \fBsha256\fR if it is 256.
|
||
|
|
.IP "\fBproperties\fR:\fIquery\fR" 4
|
||
|
|
.IX Item "properties:query"
|
||
|
|
The \fIdigest\fR property \fIquery\fR string to use when fetching a digest from a provider.
|
||
|
|
.IP "\fBtype\fR:\fItype\fR" 4
|
||
|
|
.IX Item "type:type"
|
||
|
|
The type of generation to use. Set this to 1 to use legacy \s-1FIPS186\-2\s0 parameter
|
||
|
|
generation. The default of 0 uses \s-1FIPS186\-4\s0 parameter generation.
|
||
|
|
.IP "\fBgindex\fR:\fIindex\fR" 4
|
||
|
|
.IX Item "gindex:index"
|
||
|
|
The index to use for canonical generation and verification of the generator g.
|
||
|
|
Set this to a positive value ranging from 0..255 to use this mode. Larger values
|
||
|
|
will only use the bottom byte.
|
||
|
|
This \fIindex\fR must then be reused during key validation to verify the value of g.
|
||
|
|
If this value is not set then g is not verifiable. The default value is \-1.
|
||
|
|
.IP "\fBhexseed\fR:\fIseed\fR" 4
|
||
|
|
.IX Item "hexseed:seed"
|
||
|
|
The seed \fIseed\fR data to use instead of generating a random seed internally.
|
||
|
|
This should be used for testing purposes only. This will either produced fixed
|
||
|
|
values for the generated parameters \s-1OR\s0 it will fail if the seed did not
|
||
|
|
generate valid primes.
|
||
|
|
.SS "\s-1DH\s0 Parameter Generation Options"
|
||
|
|
.IX Subsection "DH Parameter Generation Options"
|
||
|
|
For most use cases it is recommended to use the \fBgroup\fR option rather than
|
||
|
|
the \fBtype\fR options. Note that the \fBgroup\fR option is not used by default if
|
||
|
|
no parameter generation options are specified.
|
||
|
|
.IP "\fBgroup\fR:\fIname\fR" 4
|
||
|
|
.IX Item "group:name"
|
||
|
|
.PD 0
|
||
|
|
.IP "\fBdh_param\fR:\fIname\fR" 4
|
||
|
|
.IX Item "dh_param:name"
|
||
|
|
.PD
|
||
|
|
Use a named \s-1DH\s0 group to select constant values for the \s-1DH\s0 parameters.
|
||
|
|
All other options will be ignored if this value is set.
|
||
|
|
.Sp
|
||
|
|
Valid values that are associated with the \fBalgorithm\fR of \fB\*(L"\s-1DH\*(R"\s0\fR are:
|
||
|
|
\&\*(L"ffdhe2048\*(R", \*(L"ffdhe3072\*(R", \*(L"ffdhe4096\*(R", \*(L"ffdhe6144\*(R", \*(L"ffdhe8192\*(R",
|
||
|
|
\&\*(L"modp_1536\*(R", \*(L"modp_2048\*(R", \*(L"modp_3072\*(R", \*(L"modp_4096\*(R", \*(L"modp_6144\*(R", \*(L"modp_8192\*(R".
|
||
|
|
.Sp
|
||
|
|
Valid values that are associated with the \fBalgorithm\fR of \fB\*(L"\s-1DHX\*(R"\s0\fR are the
|
||
|
|
\&\s-1RFC5114\s0 names \*(L"dh_1024_160\*(R", \*(L"dh_2048_224\*(R", \*(L"dh_2048_256\*(R".
|
||
|
|
.IP "\fBdh_rfc5114\fR:\fInum\fR" 4
|
||
|
|
.IX Item "dh_rfc5114:num"
|
||
|
|
If this option is set, then the appropriate \s-1RFC5114\s0 parameters are used
|
||
|
|
instead of generating new parameters. The value \fInum\fR can be one of
|
||
|
|
1, 2 or 3 that are equivalent to using the option \fBgroup\fR with one of
|
||
|
|
\&\*(L"dh_1024_160\*(R", \*(L"dh_2048_224\*(R" or \*(L"dh_2048_256\*(R".
|
||
|
|
All other options will be ignored if this value is set.
|
||
|
|
.IP "\fBpbits\fR:\fInumbits\fR" 4
|
||
|
|
.IX Item "pbits:numbits"
|
||
|
|
.PD 0
|
||
|
|
.IP "\fBdh_paramgen_prime_len\fR:\fInumbits\fR" 4
|
||
|
|
.IX Item "dh_paramgen_prime_len:numbits"
|
||
|
|
.PD
|
||
|
|
The number of bits in the prime parameter \fIp\fR. The default is 2048.
|
||
|
|
.IP "\fBqbits\fR:\fInumbits\fR" 4
|
||
|
|
.IX Item "qbits:numbits"
|
||
|
|
.PD 0
|
||
|
|
.IP "\fBdh_paramgen_subprime_len\fR:\fInumbits\fR" 4
|
||
|
|
.IX Item "dh_paramgen_subprime_len:numbits"
|
||
|
|
.PD
|
||
|
|
The number of bits in the sub prime parameter \fIq\fR. The default is 224.
|
||
|
|
Only relevant if used in conjunction with the \fBdh_paramgen_type\fR option to
|
||
|
|
generate \s-1DHX\s0 parameters.
|
||
|
|
.IP "\fBsafeprime-generator\fR:\fIvalue\fR" 4
|
||
|
|
.IX Item "safeprime-generator:value"
|
||
|
|
.PD 0
|
||
|
|
.IP "\fBdh_paramgen_generator\fR:\fIvalue\fR" 4
|
||
|
|
.IX Item "dh_paramgen_generator:value"
|
||
|
|
.PD
|
||
|
|
The value to use for the generator \fIg\fR. The default is 2.
|
||
|
|
The \fBalgorithm\fR option must be \fB\*(L"\s-1DH\*(R"\s0\fR for this parameter to be used.
|
||
|
|
.IP "\fBtype\fR:\fIstring\fR" 4
|
||
|
|
.IX Item "type:string"
|
||
|
|
The type name of \s-1DH\s0 parameters to generate. Valid values are:
|
||
|
|
.RS 4
|
||
|
|
.ie n .IP """generator""" 4
|
||
|
|
.el .IP "``generator''" 4
|
||
|
|
.IX Item "generator"
|
||
|
|
Use a safe prime generator with the option \fBsafeprime_generator\fR
|
||
|
|
The \fBalgorithm\fR option must be \fB\*(L"\s-1DH\*(R"\s0\fR.
|
||
|
|
.ie n .IP """fips186_4""" 4
|
||
|
|
.el .IP "``fips186_4''" 4
|
||
|
|
.IX Item "fips186_4"
|
||
|
|
\&\s-1FIPS186\-4\s0 parameter generation.
|
||
|
|
The \fBalgorithm\fR option must be \fB\*(L"\s-1DHX\*(R"\s0\fR.
|
||
|
|
.ie n .IP """fips186_2""" 4
|
||
|
|
.el .IP "``fips186_2''" 4
|
||
|
|
.IX Item "fips186_2"
|
||
|
|
\&\s-1FIPS186\-4\s0 parameter generation.
|
||
|
|
The \fBalgorithm\fR option must be \fB\*(L"\s-1DHX\*(R"\s0\fR.
|
||
|
|
.ie n .IP """group""" 4
|
||
|
|
.el .IP "``group''" 4
|
||
|
|
.IX Item "group"
|
||
|
|
Can be used with the option \fBpbits\fR to select one of
|
||
|
|
\&\*(L"ffdhe2048\*(R", \*(L"ffdhe3072\*(R", \*(L"ffdhe4096\*(R", \*(L"ffdhe6144\*(R" or \*(L"ffdhe8192\*(R".
|
||
|
|
The \fBalgorithm\fR option must be \fB\*(L"\s-1DH\*(R"\s0\fR.
|
||
|
|
.ie n .IP """default""" 4
|
||
|
|
.el .IP "``default''" 4
|
||
|
|
.IX Item "default"
|
||
|
|
Selects a default type based on the \fBalgorithm\fR. This is used by the
|
||
|
|
OpenSSL default provider to set the type for backwards compatibility.
|
||
|
|
If \fBalgorithm\fR is \fB\*(L"\s-1DH\*(R"\s0\fR then \fB\*(L"generator\*(R"\fR is used.
|
||
|
|
If \fBalgorithm\fR is \fB\*(L"\s-1DHX\*(R"\s0\fR then \fB\*(L"fips186_2\*(R"\fR is used.
|
||
|
|
.RE
|
||
|
|
.RS 4
|
||
|
|
.RE
|
||
|
|
.IP "\fBdh_paramgen_type\fR:\fIvalue\fR" 4
|
||
|
|
.IX Item "dh_paramgen_type:value"
|
||
|
|
The type of \s-1DH\s0 parameters to generate. Valid values are 0, 1, 2 or 3
|
||
|
|
which correspond to setting the option \fBtype\fR to
|
||
|
|
\&\*(L"generator\*(R", \*(L"fips186_2\*(R", \*(L"fips186_4\*(R" or \*(L"group\*(R".
|
||
|
|
.IP "\fBdigest\fR:\fIdigest\fR" 4
|
||
|
|
.IX Item "digest:digest"
|
||
|
|
The digest to use during parameter generation. Must be one of \fBsha1\fR, \fBsha224\fR
|
||
|
|
or \fBsha256\fR. If set, then the number of bits in \fBqbits\fR will match the output
|
||
|
|
size of the specified digest and the \fBqbits\fR parameter will be
|
||
|
|
ignored. If not set, then a digest will be used that gives an output matching
|
||
|
|
the number of bits in \fBq\fR, i.e. \fBsha1\fR if q length is 160, \fBsha224\fR if it is
|
||
|
|
224 or \fBsha256\fR if it is 256.
|
||
|
|
This is only used by \*(L"fips186_4\*(R" and \*(L"fips186_2\*(R" key generation.
|
||
|
|
.IP "\fBproperties\fR:\fIquery\fR" 4
|
||
|
|
.IX Item "properties:query"
|
||
|
|
The \fIdigest\fR property \fIquery\fR string to use when fetching a digest from a provider.
|
||
|
|
This is only used by \*(L"fips186_4\*(R" and \*(L"fips186_2\*(R" key generation.
|
||
|
|
.IP "\fBgindex\fR:\fIindex\fR" 4
|
||
|
|
.IX Item "gindex:index"
|
||
|
|
The index to use for canonical generation and verification of the generator g.
|
||
|
|
Set this to a positive value ranging from 0..255 to use this mode. Larger values
|
||
|
|
will only use the bottom byte.
|
||
|
|
This \fIindex\fR must then be reused during key validation to verify the value of g.
|
||
|
|
If this value is not set then g is not verifiable. The default value is \-1.
|
||
|
|
This is only used by \*(L"fips186_4\*(R" and \*(L"fips186_2\*(R" key generation.
|
||
|
|
.IP "\fBhexseed\fR:\fIseed\fR" 4
|
||
|
|
.IX Item "hexseed:seed"
|
||
|
|
The seed \fIseed\fR data to use instead of generating a random seed internally.
|
||
|
|
This should be used for testing purposes only. This will either produced fixed
|
||
|
|
values for the generated parameters \s-1OR\s0 it will fail if the seed did not
|
||
|
|
generate valid primes.
|
||
|
|
This is only used by \*(L"fips186_4\*(R" and \*(L"fips186_2\*(R" key generation.
|
||
|
|
.SS "\s-1EC\s0 Parameter Generation Options"
|
||
|
|
.IX Subsection "EC Parameter Generation Options"
|
||
|
|
The \s-1EC\s0 parameter generation options are the same as for key generation. See
|
||
|
|
\&\*(L"\s-1EC\s0 Key Generation Options\*(R" above.
|
||
|
|
.SH "NOTES"
|
||
|
|
.IX Header "NOTES"
|
||
|
|
The use of the genpkey program is encouraged over the algorithm specific
|
||
|
|
utilities because additional algorithm options and \s-1ENGINE\s0 provided algorithms
|
||
|
|
can be used.
|
||
|
|
.SH "EXAMPLES"
|
||
|
|
.IX Header "EXAMPLES"
|
||
|
|
Generate an \s-1RSA\s0 private key using default parameters:
|
||
|
|
.PP
|
||
|
|
.Vb 1
|
||
|
|
\& openssl genpkey \-algorithm RSA \-out key.pem
|
||
|
|
.Ve
|
||
|
|
.PP
|
||
|
|
Encrypt output private key using 128 bit \s-1AES\s0 and the passphrase \*(L"hello\*(R":
|
||
|
|
.PP
|
||
|
|
.Vb 1
|
||
|
|
\& openssl genpkey \-algorithm RSA \-out key.pem \-aes\-128\-cbc \-pass pass:hello
|
||
|
|
.Ve
|
||
|
|
.PP
|
||
|
|
Generate a 2048 bit \s-1RSA\s0 key using 3 as the public exponent:
|
||
|
|
.PP
|
||
|
|
.Vb 2
|
||
|
|
\& openssl genpkey \-algorithm RSA \-out key.pem \e
|
||
|
|
\& \-pkeyopt rsa_keygen_bits:2048 \-pkeyopt rsa_keygen_pubexp:3
|
||
|
|
.Ve
|
||
|
|
.PP
|
||
|
|
Generate 2048 bit \s-1DSA\s0 parameters that can be validated: The output values for
|
||
|
|
gindex and seed are required for key validation purposes and are not saved to
|
||
|
|
the output pem file).
|
||
|
|
.PP
|
||
|
|
.Vb 2
|
||
|
|
\& openssl genpkey \-genparam \-algorithm DSA \-out dsap.pem \-pkeyopt pbits:2048 \e
|
||
|
|
\& \-pkeyopt qbits:224 \-pkeyopt digest:SHA256 \-pkeyopt gindex:1 \-text
|
||
|
|
.Ve
|
||
|
|
.PP
|
||
|
|
Generate \s-1DSA\s0 key from parameters:
|
||
|
|
.PP
|
||
|
|
.Vb 1
|
||
|
|
\& openssl genpkey \-paramfile dsap.pem \-out dsakey.pem
|
||
|
|
.Ve
|
||
|
|
.PP
|
||
|
|
Generate 4096 bit \s-1DH\s0 Key using safe prime group ffdhe4096:
|
||
|
|
.PP
|
||
|
|
.Vb 1
|
||
|
|
\& openssl genpkey \-algorithm DH \-out dhkey.pem \-pkeyopt group:ffdhe4096
|
||
|
|
.Ve
|
||
|
|
.PP
|
||
|
|
Generate 2048 bit X9.42 \s-1DH\s0 key with 256 bit subgroup using \s-1RFC5114\s0 group3:
|
||
|
|
.PP
|
||
|
|
.Vb 1
|
||
|
|
\& openssl genpkey \-algorithm DHX \-out dhkey.pem \-pkeyopt dh_rfc5114:3
|
||
|
|
.Ve
|
||
|
|
.PP
|
||
|
|
Generate a \s-1DH\s0 key using a \s-1DH\s0 parameters file:
|
||
|
|
.PP
|
||
|
|
.Vb 1
|
||
|
|
\& openssl genpkey \-paramfile dhp.pem \-out dhkey.pem
|
||
|
|
.Ve
|
||
|
|
.PP
|
||
|
|
Output \s-1DH\s0 parameters for safe prime group ffdhe2048:
|
||
|
|
.PP
|
||
|
|
.Vb 1
|
||
|
|
\& openssl genpkey \-genparam \-algorithm DH \-out dhp.pem \-pkeyopt group:ffdhe2048
|
||
|
|
.Ve
|
||
|
|
.PP
|
||
|
|
Output 2048 bit X9.42 \s-1DH\s0 parameters with 224 bit subgroup using \s-1RFC5114\s0 group2:
|
||
|
|
.PP
|
||
|
|
.Vb 1
|
||
|
|
\& openssl genpkey \-genparam \-algorithm DHX \-out dhp.pem \-pkeyopt dh_rfc5114:2
|
||
|
|
.Ve
|
||
|
|
.PP
|
||
|
|
Output 2048 bit X9.42 \s-1DH\s0 parameters with 224 bit subgroup using \s-1FIP186\-4\s0 keygen:
|
||
|
|
.PP
|
||
|
|
.Vb 3
|
||
|
|
\& openssl genpkey \-genparam \-algorithm DHX \-out dhp.pem \-text \e
|
||
|
|
\& \-pkeyopt pbits:2048 \-pkeyopt qbits:224 \-pkeyopt digest:SHA256 \e
|
||
|
|
\& \-pkeyopt gindex:1 \-pkeyopt dh_paramgen_type:2
|
||
|
|
.Ve
|
||
|
|
.PP
|
||
|
|
Output 1024 bit X9.42 \s-1DH\s0 parameters with 160 bit subgroup using \s-1FIP186\-2\s0 keygen:
|
||
|
|
.PP
|
||
|
|
.Vb 3
|
||
|
|
\& openssl genpkey \-genparam \-algorithm DHX \-out dhp.pem \-text \e
|
||
|
|
\& \-pkeyopt pbits:1024 \-pkeyopt qbits:160 \-pkeyopt digest:SHA1 \e
|
||
|
|
\& \-pkeyopt gindex:1 \-pkeyopt dh_paramgen_type:1
|
||
|
|
.Ve
|
||
|
|
.PP
|
||
|
|
Output 2048 bit \s-1DH\s0 parameters:
|
||
|
|
.PP
|
||
|
|
.Vb 2
|
||
|
|
\& openssl genpkey \-genparam \-algorithm DH \-out dhp.pem \e
|
||
|
|
\& \-pkeyopt dh_paramgen_prime_len:2048
|
||
|
|
.Ve
|
||
|
|
.PP
|
||
|
|
Output 2048 bit \s-1DH\s0 parameters using a generator:
|
||
|
|
.PP
|
||
|
|
.Vb 3
|
||
|
|
\& openssl genpkey \-genparam \-algorithm DH \-out dhpx.pem \e
|
||
|
|
\& \-pkeyopt dh_paramgen_prime_len:2048 \e
|
||
|
|
\& \-pkeyopt dh_paramgen_type:1
|
||
|
|
.Ve
|
||
|
|
.PP
|
||
|
|
Generate \s-1EC\s0 parameters:
|
||
|
|
.PP
|
||
|
|
.Vb 3
|
||
|
|
\& openssl genpkey \-genparam \-algorithm EC \-out ecp.pem \e
|
||
|
|
\& \-pkeyopt ec_paramgen_curve:secp384r1 \e
|
||
|
|
\& \-pkeyopt ec_param_enc:named_curve
|
||
|
|
.Ve
|
||
|
|
.PP
|
||
|
|
Generate \s-1EC\s0 key from parameters:
|
||
|
|
.PP
|
||
|
|
.Vb 1
|
||
|
|
\& openssl genpkey \-paramfile ecp.pem \-out eckey.pem
|
||
|
|
.Ve
|
||
|
|
.PP
|
||
|
|
Generate \s-1EC\s0 key directly:
|
||
|
|
.PP
|
||
|
|
.Vb 3
|
||
|
|
\& openssl genpkey \-algorithm EC \-out eckey.pem \e
|
||
|
|
\& \-pkeyopt ec_paramgen_curve:P\-384 \e
|
||
|
|
\& \-pkeyopt ec_param_enc:named_curve
|
||
|
|
.Ve
|
||
|
|
.PP
|
||
|
|
Generate an X25519 private key:
|
||
|
|
.PP
|
||
|
|
.Vb 1
|
||
|
|
\& openssl genpkey \-algorithm X25519 \-out xkey.pem
|
||
|
|
.Ve
|
||
|
|
.PP
|
||
|
|
Generate an \s-1ED448\s0 private key:
|
||
|
|
.PP
|
||
|
|
.Vb 1
|
||
|
|
\& openssl genpkey \-algorithm ED448 \-out xkey.pem
|
||
|
|
.Ve
|
||
|
|
.SH "HISTORY"
|
||
|
|
.IX Header "HISTORY"
|
||
|
|
The ability to use \s-1NIST\s0 curve names, and to generate an \s-1EC\s0 key directly,
|
||
|
|
were added in OpenSSL 1.0.2.
|
||
|
|
The ability to generate X25519 keys was added in OpenSSL 1.1.0.
|
||
|
|
The ability to generate X448, \s-1ED25519\s0 and \s-1ED448\s0 keys was added in OpenSSL 1.1.1.
|
||
|
|
.PP
|
||
|
|
The \fB\-engine\fR option was deprecated in OpenSSL 3.0.
|
||
|
|
.SH "COPYRIGHT"
|
||
|
|
.IX Header "COPYRIGHT"
|
||
|
|
Copyright 2006\-2023 The OpenSSL Project Authors. All Rights Reserved.
|
||
|
|
.PP
|
||
|
|
Licensed under the Apache License 2.0 (the \*(L"License\*(R"). You may not use
|
||
|
|
this file except in compliance with the License. You can obtain a copy
|
||
|
|
in the file \s-1LICENSE\s0 in the source distribution or at
|
||
|
|
<https://www.openssl.org/source/license.html>.
|