238 lines
8.1 KiB
Groff
238 lines
8.1 KiB
Groff
|
.\" Automatically generated by Pod::Man 2.25 (Pod::Simple 3.16)
|
||
|
|
.\"
|
||
|
|
.\" 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" ''
|
||
|
|
'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.
|
||
|
|
.ie \nF \{\
|
||
|
|
. de IX
|
||
|
|
. tm Index:\\$1\t\\n%\t"\\$2"
|
||
|
|
..
|
||
|
|
. nr % 0
|
||
|
|
. rr F
|
||
|
|
.\}
|
||
|
|
.el \{\
|
||
|
|
. de IX
|
||
|
|
..
|
||
|
|
.\}
|
||
|
|
.\"
|
||
|
|
.\" 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 "RSA_GENERATE_KEY 3"
|
||
|
|
.TH RSA_GENERATE_KEY 3 "2020-03-02" "3.0.0-dev" "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"
|
||
|
|
RSA_generate_key_ex, RSA_generate_key,
|
||
|
|
RSA_generate_multi_prime_key \- generate RSA key pair
|
||
|
|
.SH "SYNOPSIS"
|
||
|
|
.IX Header "SYNOPSIS"
|
||
|
|
.Vb 1
|
||
|
|
\& #include <openssl/rsa.h>
|
||
|
|
.Ve
|
||
|
|
.PP
|
||
|
|
Deprecated since OpenSSL 3.0, can be hidden entirely by defining
|
||
|
|
\&\fB\s-1OPENSSL_API_COMPAT\s0\fR with a suitable version value, see
|
||
|
|
\&\fIopenssl_user_macros\fR\|(7):
|
||
|
|
.PP
|
||
|
|
.Vb 2
|
||
|
|
\& int RSA_generate_key_ex(RSA *rsa, int bits, BIGNUM *e, BN_GENCB *cb);
|
||
|
|
\& int RSA_generate_multi_prime_key(RSA *rsa, int bits, int primes, BIGNUM *e, BN_GENCB *cb);
|
||
|
|
.Ve
|
||
|
|
.PP
|
||
|
|
Deprecated since OpenSSL 0.9.8, can be hidden entirely by defining
|
||
|
|
\&\fB\s-1OPENSSL_API_COMPAT\s0\fR with a suitable version value, see
|
||
|
|
\&\fIopenssl_user_macros\fR\|(7):
|
||
|
|
.PP
|
||
|
|
.Vb 2
|
||
|
|
\& RSA *RSA_generate_key(int bits, unsigned long e,
|
||
|
|
\& void (*callback)(int, int, void *), void *cb_arg);
|
||
|
|
.Ve
|
||
|
|
.SH "DESCRIPTION"
|
||
|
|
.IX Header "DESCRIPTION"
|
||
|
|
All of the functions described on this page are deprecated.
|
||
|
|
Applications should instead use \fIEVP_PKEY_keygen_init\fR\|(3) and
|
||
|
|
\&\fIEVP_PKEY_keygen\fR\|(3).
|
||
|
|
.PP
|
||
|
|
\&\fIRSA_generate_key_ex()\fR generates a 2\-prime \s-1RSA\s0 key pair and stores it in the
|
||
|
|
\&\fB\s-1RSA\s0\fR structure provided in \fBrsa\fR. The pseudo-random number generator must
|
||
|
|
be seeded prior to calling \fIRSA_generate_key_ex()\fR.
|
||
|
|
.PP
|
||
|
|
\&\fIRSA_generate_multi_prime_key()\fR generates a multi-prime \s-1RSA\s0 key pair and stores
|
||
|
|
it in the \fB\s-1RSA\s0\fR structure provided in \fBrsa\fR. The number of primes is given by
|
||
|
|
the \fBprimes\fR parameter. The random number generator must be seeded when
|
||
|
|
calling \fIRSA_generate_multi_prime_key()\fR.
|
||
|
|
If the automatic seeding or reseeding of the OpenSSL \s-1CSPRNG\s0 fails due to
|
||
|
|
external circumstances (see \s-1\fIRAND\s0\fR\|(7)), the operation will fail.
|
||
|
|
.PP
|
||
|
|
The modulus size will be of length \fBbits\fR, the number of primes to form the
|
||
|
|
modulus will be \fBprimes\fR, and the public exponent will be \fBe\fR. Key sizes
|
||
|
|
with \fBnum\fR < 1024 should be considered insecure. The exponent is an odd
|
||
|
|
number, typically 3, 17 or 65537.
|
||
|
|
.PP
|
||
|
|
In order to maintain adequate security level, the maximum number of permitted
|
||
|
|
\&\fBprimes\fR depends on modulus bit length:
|
||
|
|
.PP
|
||
|
|
.Vb 3
|
||
|
|
\& <1024 | >=1024 | >=4096 | >=8192
|
||
|
|
\& \-\-\-\-\-\-+\-\-\-\-\-\-\-\-+\-\-\-\-\-\-\-\-+\-\-\-\-\-\-\-
|
||
|
|
\& 2 | 3 | 4 | 5
|
||
|
|
.Ve
|
||
|
|
.PP
|
||
|
|
A callback function may be used to provide feedback about the
|
||
|
|
progress of the key generation. If \fBcb\fR is not \fB\s-1NULL\s0\fR, it
|
||
|
|
will be called as follows using the \fIBN_GENCB_call()\fR function
|
||
|
|
described on the \fIBN_generate_prime\fR\|(3) page.
|
||
|
|
.PP
|
||
|
|
\&\fIRSA_generate_key()\fR is similar to \fIRSA_generate_key_ex()\fR but
|
||
|
|
expects an old-style callback function; see
|
||
|
|
\&\fIBN_generate_prime\fR\|(3) for information on the old-style callback.
|
||
|
|
.IP "\(bu" 2
|
||
|
|
While a random prime number is generated, it is called as
|
||
|
|
described in \fIBN_generate_prime\fR\|(3).
|
||
|
|
.IP "\(bu" 2
|
||
|
|
When the n\-th randomly generated prime is rejected as not
|
||
|
|
suitable for the key, \fBBN_GENCB_call(cb, 2, n)\fR is called.
|
||
|
|
.IP "\(bu" 2
|
||
|
|
When a random p has been found with p\-1 relatively prime to \fBe\fR,
|
||
|
|
it is called as \fBBN_GENCB_call(cb, 3, 0)\fR.
|
||
|
|
.PP
|
||
|
|
The process is then repeated for prime q and other primes (if any)
|
||
|
|
with \fBBN_GENCB_call(cb, 3, i)\fR where \fBi\fR indicates the i\-th prime.
|
||
|
|
.SH "RETURN VALUES"
|
||
|
|
.IX Header "RETURN VALUES"
|
||
|
|
\&\fIRSA_generate_multi_prime_key()\fR returns 1 on success or 0 on error.
|
||
|
|
\&\fIRSA_generate_key_ex()\fR returns 1 on success or 0 on error.
|
||
|
|
The error codes can be obtained by \fIERR_get_error\fR\|(3).
|
||
|
|
.PP
|
||
|
|
\&\fIRSA_generate_key()\fR returns a pointer to the \s-1RSA\s0 structure or
|
||
|
|
\&\fB\s-1NULL\s0\fR if the key generation fails.
|
||
|
|
.SH "BUGS"
|
||
|
|
.IX Header "BUGS"
|
||
|
|
\&\fBBN_GENCB_call(cb, 2, x)\fR is used with two different meanings.
|
||
|
|
.SH "SEE ALSO"
|
||
|
|
.IX Header "SEE ALSO"
|
||
|
|
\&\fIERR_get_error\fR\|(3), \fIRAND_bytes\fR\|(3), \fIBN_generate_prime\fR\|(3),
|
||
|
|
\&\s-1\fIRAND\s0\fR\|(7)
|
||
|
|
.SH "HISTORY"
|
||
|
|
.IX Header "HISTORY"
|
||
|
|
All of these functions were deprecated in OpenSSL 3.0.
|
||
|
|
.PP
|
||
|
|
\&\fIRSA_generate_key()\fR was deprecated in OpenSSL 0.9.8; use
|
||
|
|
\&\fIRSA_generate_key_ex()\fR instead.
|
||
|
|
.SH "COPYRIGHT"
|
||
|
|
.IX Header "COPYRIGHT"
|
||
|
|
Copyright 2000\-2018 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>.
|