secure/lib/libcrypto/man/RSA_generate_key.3

   1 .\" Automatically generated by Pod::Man 4.09 (Pod::Simple 3.35)
   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 .if !\nF .nr F 0
  58 .if \nF>0 \{\
  59 .    de IX
  60 .    tm Index:\\$1\t\\n%\t"\\$2"
  61 ..
  62 .    if !\nF==2 \{\
  63 .        nr % 0
  64 .        nr F 2
  65 .    \}
  66 .\}
  67 .\"
  68 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
  69 .\" Fear.  Run.  Save yourself.  No user-serviceable parts.
  70 .    \" fudge factors for nroff and troff
  71 .if n \{\
  72 .    ds #H 0
  73 .    ds #V .8m
  74 .    ds #F .3m
  75 .    ds #[ \f1
  76 .    ds #] \fP
  77 .\}
  78 .if t \{\
  79 .    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
  80 .    ds #V .6m
  81 .    ds #F 0
  82 .    ds #[ \&
  83 .    ds #] \&
  84 .\}
  85 .    \" simple accents for nroff and troff
  86 .if n \{\
  87 .    ds ' \&
  88 .    ds ` \&
  89 .    ds ^ \&
  90 .    ds , \&
  91 .    ds ~ ~
  92 .    ds /
  93 .\}
  94 .if t \{\
  95 .    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
  96 .    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
  97 .    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
  98 .    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
  99 .    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
 100 .    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
 101 .\}
 102 .    \" troff and (daisy-wheel) nroff accents
 103 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
 104 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
 105 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
 106 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
 107 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
 108 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
 109 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
 110 .ds ae a\h'-(\w'a'u*4/10)'e
 111 .ds Ae A\h'-(\w'A'u*4/10)'E
 112 .    \" corrections for vroff
 113 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
 114 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
 115 .    \" for low resolution devices (crt and lpr)
 116 .if \n(.H>23 .if \n(.V>19 \
 117 \{\
 118 .    ds : e
 119 .    ds 8 ss
 120 .    ds o a
 121 .    ds d- d\h'-1'\(ga
 122 .    ds D- D\h'-1'\(hy
 123 .    ds th \o'bp'
 124 .    ds Th \o'LP'
 125 .    ds ae ae
 126 .    ds Ae AE
 127 .\}
 128 .rm #[ #] #H #V #F C
 129 .\" ========================================================================
 130 .\"
 131 .IX Title "RSA_GENERATE_KEY 3"
 132 .TH RSA_GENERATE_KEY 3 "2018-11-20" "1.1.1a" "OpenSSL"
 133 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
 134 .\" way too many mistakes in technical documents.
 135 .if n .ad l
 136 .nh
 137 .SH "NAME"
 138 RSA_generate_key_ex, RSA_generate_key, RSA_generate_multi_prime_key \- generate RSA key pair
 139 .SH "SYNOPSIS"
 140 .IX Header "SYNOPSIS"
 141 .Vb 1
 142 \& #include <openssl/rsa.h>
 143 \&
 144 \& int RSA_generate_key_ex(RSA *rsa, int bits, BIGNUM *e, BN_GENCB *cb);
 145 \& int RSA_generate_multi_prime_key(RSA *rsa, int bits, int primes, BIGNUM *e, BN_GENCB *cb);
 146 .Ve
 147 .PP
 148 Deprecated:
 149 .PP
 150 .Vb 4
 151 \& #if OPENSSL_API_COMPAT < 0x00908000L
 152 \& RSA *RSA_generate_key(int num, unsigned long e,
 153 \&                       void (*callback)(int, int, void *), void *cb_arg);
 154 \& #endif
 155 .Ve
 156 .SH "DESCRIPTION"
 157 .IX Header "DESCRIPTION"
 158 \&\fIRSA_generate_key_ex()\fR generates a 2\-prime \s-1RSA\s0 key pair and stores it in the
 159 \&\fB\s-1RSA\s0\fR structure provided in \fBrsa\fR. The pseudo-random number generator must
 160 be seeded prior to calling \fIRSA_generate_key_ex()\fR.
 161 .PP
 162 \&\fIRSA_generate_multi_prime_key()\fR generates a multi-prime \s-1RSA\s0 key pair and stores
 163 it in the \fB\s-1RSA\s0\fR structure provided in \fBrsa\fR. The number of primes is given by
 164 the \fBprimes\fR parameter. The pseudo-random number generator must be seeded prior
 165 to calling \fIRSA_generate_multi_prime_key()\fR.
 166 .PP
 167 The modulus size will be of length \fBbits\fR, the number of primes to form the
 168 modulus will be \fBprimes\fR, and the public exponent will be \fBe\fR. Key sizes
 169 with \fBnum\fR < 1024 should be considered insecure. The exponent is an odd
 170 number, typically 3, 17 or 65537.
 171 .PP
 172 In order to maintain adequate security level, the maximum number of permitted
 173 \&\fBprimes\fR depends on modulus bit length:
 174 .PP
 175 .Vb 3
 176 \&   <1024 | >=1024 | >=4096 | >=8192
 177 \&   \-\-\-\-\-\-+\-\-\-\-\-\-\-\-+\-\-\-\-\-\-\-\-+\-\-\-\-\-\-\-
 178 \&     2   |   3    |   4    |   5
 179 .Ve
 180 .PP
 181 A callback function may be used to provide feedback about the
 182 progress of the key generation. If \fBcb\fR is not \fB\s-1NULL\s0\fR, it
 183 will be called as follows using the \fIBN_GENCB_call()\fR function
 184 described on the \fIBN_generate_prime\fR\|(3) page.
 185 .PP
 186 \&\fIRSA_generate_prime()\fR is similar to \fIRSA_generate_prime_ex()\fR but
 187 expects an old-style callback function; see
 188 \&\fIBN_generate_prime\fR\|(3) for information on the old-style callback.
 189 .IP "\(bu" 2
 190 While a random prime number is generated, it is called as
 191 described in \fIBN_generate_prime\fR\|(3).
 192 .IP "\(bu" 2
 193 When the n\-th randomly generated prime is rejected as not
 194 suitable for the key, \fBBN_GENCB_call(cb, 2, n)\fR is called.
 195 .IP "\(bu" 2
 196 When a random p has been found with p\-1 relatively prime to \fBe\fR,
 197 it is called as \fBBN_GENCB_call(cb, 3, 0)\fR.
 198 .PP
 199 The process is then repeated for prime q and other primes (if any)
 200 with \fBBN_GENCB_call(cb, 3, i)\fR where \fBi\fR indicates the i\-th prime.
 201 .SH "RETURN VALUES"
 202 .IX Header "RETURN VALUES"
 203 \&\fIRSA_generate_multi_prime_key()\fR returns 1 on success or 0 on error.
 204 \&\fIRSA_generate_key_ex()\fR returns 1 on success or 0 on error.
 205 The error codes can be obtained by \fIERR_get_error\fR\|(3).
 206 .PP
 207 \&\fIRSA_generate_key()\fR returns a pointer to the \s-1RSA\s0 structure or
 208 \&\fB\s-1NULL\s0\fR if the key generation fails.
 209 .SH "BUGS"
 210 .IX Header "BUGS"
 211 \&\fBBN_GENCB_call(cb, 2, x)\fR is used with two different meanings.
 212 .SH "SEE ALSO"
 213 .IX Header "SEE ALSO"
 214 \&\fIERR_get_error\fR\|(3), \fIRAND_bytes\fR\|(3), \fIBN_generate_prime\fR\|(3)
 215 .SH "HISTORY"
 216 .IX Header "HISTORY"
 217 \&\fIRSA_generate_key()\fR was deprecated in OpenSSL 0.9.8; use
 218 \&\fIRSA_generate_key_ex()\fR instead.
 219 .SH "COPYRIGHT"
 220 .IX Header "COPYRIGHT"
 221 Copyright 2000\-2018 The OpenSSL Project Authors. All Rights Reserved.
 222 .PP
 223 Licensed under the OpenSSL license (the \*(L"License\*(R").  You may not use
 224 this file except in compliance with the License.  You can obtain a copy
 225 in the file \s-1LICENSE\s0 in the source distribution or at
 226 <https://www.openssl.org/source/license.html>.