secure/lib/libcrypto/man/man3/RSA_generate_key.3

   1 .\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.41)
   2 .\"
   3 .\" Standard preamble:
   4 .\" ========================================================================
   5 .de Sp \" Vertical space (when we can't use .PP)
   6 .if t .sp .5v
   7 .if n .sp
   8 ..
   9 .de Vb \" Begin verbatim text
  10 .ft CW
  11 .nf
  12 .ne \\$1
  13 ..
  14 .de Ve \" End verbatim text
  15 .ft R
  16 .fi
  17 ..
  18 .\" Set up some character translations and predefined strings.  \*(-- will
  19 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
  20 .\" double quote, and \*(R" will give a right double quote.  \*(C+ will
  21 .\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
  22 .\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
  23 .\" nothing in troff, for use with C<>.
  24 .tr \(*W-
  25 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
  26 .ie n \{\
  27 .    ds -- \(*W-
  28 .    ds PI pi
  29 .    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
  30 .    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
  31 .    ds L" ""
  32 .    ds R" ""
  33 .    ds C` ""
  34 .    ds C' ""
  35 'br\}
  36 .el\{\
  37 .    ds -- \|\(em\|
  38 .    ds PI \(*p
  39 .    ds L" ``
  40 .    ds R" ''
  41 .    ds C`
  42 .    ds C'
  43 'br\}
  44 .\"
  45 .\" Escape single quotes in literal strings from groff's Unicode transform.
  46 .ie \n(.g .ds Aq \(aq
  47 .el       .ds Aq '
  48 .\"
  49 .\" If the F register is >0, we'll generate index entries on stderr for
  50 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
  51 .\" entries marked with X<> in POD.  Of course, you'll have to process the
  52 .\" output yourself in some meaningful fashion.
  53 .\"
  54 .\" Avoid warning from groff about undefined register 'F'.
  55 .de IX
  56 ..
  57 .nr rF 0
  58 .if \n(.g .if rF .nr rF 1
  59 .if (\n(rF:(\n(.g==0)) \{\
  60 .    if \nF \{\
  61 .        de IX
  62 .        tm Index:\\$1\t\\n%\t"\\$2"
  63 ..
  64 .        if !\nF==2 \{\
  65 .            nr % 0
  66 .            nr F 2
  67 .        \}
  68 .    \}
  69 .\}
  70 .rr rF
  71 .\"
  72 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
  73 .\" Fear.  Run.  Save yourself.  No user-serviceable parts.
  74 .    \" fudge factors for nroff and troff
  75 .if n \{\
  76 .    ds #H 0
  77 .    ds #V .8m
  78 .    ds #F .3m
  79 .    ds #[ \f1
  80 .    ds #] \fP
  81 .\}
  82 .if t \{\
  83 .    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
  84 .    ds #V .6m
  85 .    ds #F 0
  86 .    ds #[ \&
  87 .    ds #] \&
  88 .\}
  89 .    \" simple accents for nroff and troff
  90 .if n \{\
  91 .    ds ' \&
  92 .    ds ` \&
  93 .    ds ^ \&
  94 .    ds , \&
  95 .    ds ~ ~
  96 .    ds /
  97 .\}
  98 .if t \{\
  99 .    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
 100 .    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
 101 .    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
 102 .    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
 103 .    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
 104 .    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
 105 .\}
 106 .    \" troff and (daisy-wheel) nroff accents
 107 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
 108 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
 109 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
 110 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
 111 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
 112 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
 113 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
 114 .ds ae a\h'-(\w'a'u*4/10)'e
 115 .ds Ae A\h'-(\w'A'u*4/10)'E
 116 .    \" corrections for vroff
 117 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
 118 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
 119 .    \" for low resolution devices (crt and lpr)
 120 .if \n(.H>23 .if \n(.V>19 \
 121 \{\
 122 .    ds : e
 123 .    ds 8 ss
 124 .    ds o a
 125 .    ds d- d\h'-1'\(ga
 126 .    ds D- D\h'-1'\(hy
 127 .    ds th \o'bp'
 128 .    ds Th \o'LP'
 129 .    ds ae ae
 130 .    ds Ae AE
 131 .\}
 132 .rm #[ #] #H #V #F C
 133 .\" ========================================================================
 134 .\"
 135 .IX Title "RSA_GENERATE_KEY 3"
 136 .TH RSA_GENERATE_KEY 3 "2020-12-08" "1.1.1i" "OpenSSL"
 137 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
 138 .\" way too many mistakes in technical documents.
 139 .if n .ad l
 140 .nh
 141 .SH "NAME"
 142 RSA_generate_key_ex, RSA_generate_key, RSA_generate_multi_prime_key \- generate RSA key pair
 143 .SH "SYNOPSIS"
 144 .IX Header "SYNOPSIS"
 145 .Vb 1
 146 \& #include <openssl/rsa.h>
 147 \&
 148 \& int RSA_generate_key_ex(RSA *rsa, int bits, BIGNUM *e, BN_GENCB *cb);
 149 \& int RSA_generate_multi_prime_key(RSA *rsa, int bits, int primes, BIGNUM *e, BN_GENCB *cb);
 150 .Ve
 151 .PP
 152 Deprecated:
 153 .PP
 154 .Vb 4
 155 \& #if OPENSSL_API_COMPAT < 0x00908000L
 156 \& RSA *RSA_generate_key(int bits, unsigned long e,
 157 \&                       void (*callback)(int, int, void *), void *cb_arg);
 158 \& #endif
 159 .Ve
 160 .SH "DESCRIPTION"
 161 .IX Header "DESCRIPTION"
 162 \&\fBRSA_generate_key_ex()\fR generates a 2\-prime \s-1RSA\s0 key pair and stores it in the
 163 \&\fB\s-1RSA\s0\fR structure provided in \fBrsa\fR. The pseudo-random number generator must
 164 be seeded prior to calling \fBRSA_generate_key_ex()\fR.
 165 .PP
 166 \&\fBRSA_generate_multi_prime_key()\fR generates a multi-prime \s-1RSA\s0 key pair and stores
 167 it in the \fB\s-1RSA\s0\fR structure provided in \fBrsa\fR. The number of primes is given by
 168 the \fBprimes\fR parameter. The random number generator must be seeded when
 169 calling \fBRSA_generate_multi_prime_key()\fR.
 170 If the automatic seeding or reseeding of the OpenSSL \s-1CSPRNG\s0 fails due to
 171 external circumstances (see \s-1\fBRAND\s0\fR\|(7)), the operation will fail.
 172 .PP
 173 The modulus size will be of length \fBbits\fR, the number of primes to form the
 174 modulus will be \fBprimes\fR, and the public exponent will be \fBe\fR. Key sizes
 175 with \fBnum\fR < 1024 should be considered insecure. The exponent is an odd
 176 number, typically 3, 17 or 65537.
 177 .PP
 178 In order to maintain adequate security level, the maximum number of permitted
 179 \&\fBprimes\fR depends on modulus bit length:
 180 .PP
 181 .Vb 3
 182 \&   <1024 | >=1024 | >=4096 | >=8192
 183 \&   \-\-\-\-\-\-+\-\-\-\-\-\-\-\-+\-\-\-\-\-\-\-\-+\-\-\-\-\-\-\-
 184 \&     2   |   3    |   4    |   5
 185 .Ve
 186 .PP
 187 A callback function may be used to provide feedback about the
 188 progress of the key generation. If \fBcb\fR is not \fB\s-1NULL\s0\fR, it
 189 will be called as follows using the \fBBN_GENCB_call()\fR function
 190 described on the \fBBN_generate_prime\fR\|(3) page.
 191 .PP
 192 \&\fBRSA_generate_key()\fR is similar to \fBRSA_generate_key_ex()\fR but
 193 expects an old-style callback function; see
 194 \&\fBBN_generate_prime\fR\|(3) for information on the old-style callback.
 195 .IP "\(bu" 2
 196 While a random prime number is generated, it is called as
 197 described in \fBBN_generate_prime\fR\|(3).
 198 .IP "\(bu" 2
 199 When the n\-th randomly generated prime is rejected as not
 200 suitable for the key, \fBBN_GENCB_call(cb, 2, n)\fR is called.
 201 .IP "\(bu" 2
 202 When a random p has been found with p\-1 relatively prime to \fBe\fR,
 203 it is called as \fBBN_GENCB_call(cb, 3, 0)\fR.
 204 .PP
 205 The process is then repeated for prime q and other primes (if any)
 206 with \fBBN_GENCB_call(cb, 3, i)\fR where \fBi\fR indicates the i\-th prime.
 207 .SH "RETURN VALUES"
 208 .IX Header "RETURN VALUES"
 209 \&\fBRSA_generate_multi_prime_key()\fR returns 1 on success or 0 on error.
 210 \&\fBRSA_generate_key_ex()\fR returns 1 on success or 0 on error.
 211 The error codes can be obtained by \fBERR_get_error\fR\|(3).
 212 .PP
 213 \&\fBRSA_generate_key()\fR returns a pointer to the \s-1RSA\s0 structure or
 214 \&\fB\s-1NULL\s0\fR if the key generation fails.
 215 .SH "BUGS"
 216 .IX Header "BUGS"
 217 \&\fBBN_GENCB_call(cb, 2, x)\fR is used with two different meanings.
 218 .SH "SEE ALSO"
 219 .IX Header "SEE ALSO"
 220 \&\fBERR_get_error\fR\|(3), \fBRAND_bytes\fR\|(3), \fBBN_generate_prime\fR\|(3),
 221 \&\s-1\fBRAND\s0\fR\|(7)
 222 .SH "HISTORY"
 223 .IX Header "HISTORY"
 224 \&\fBRSA_generate_key()\fR was deprecated in OpenSSL 0.9.8; use
 225 \&\fBRSA_generate_key_ex()\fR instead.
 226 .SH "COPYRIGHT"
 227 .IX Header "COPYRIGHT"
 228 Copyright 2000\-2019 The OpenSSL Project Authors. All Rights Reserved.
 229 .PP
 230 Licensed under the OpenSSL license (the \*(L"License\*(R").  You may not use
 231 this file except in compliance with the License.  You can obtain a copy
 232 in the file \s-1LICENSE\s0 in the source distribution or at
 233 <https://www.openssl.org/source/license.html>.