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

   1 .\" Automatically generated by Pod::Man 4.11 (Pod::Simple 3.39)
   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_PUBLIC_ENCRYPT 3"
 136 .TH RSA_PUBLIC_ENCRYPT 3 "2019-09-10" "1.1.1d" "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_public_encrypt, RSA_private_decrypt \- RSA public key cryptography
 143 .SH "SYNOPSIS"
 144 .IX Header "SYNOPSIS"
 145 .Vb 1
 146 \& #include <openssl/rsa.h>
 147 \&
 148 \& int RSA_public_encrypt(int flen, const unsigned char *from,
 149 \&                        unsigned char *to, RSA *rsa, int padding);
 150 \&
 151 \& int RSA_private_decrypt(int flen, const unsigned char *from,
 152 \&                         unsigned char *to, RSA *rsa, int padding);
 153 .Ve
 154 .SH "DESCRIPTION"
 155 .IX Header "DESCRIPTION"
 156 \&\fBRSA_public_encrypt()\fR encrypts the \fBflen\fR bytes at \fBfrom\fR (usually a
 157 session key) using the public key \fBrsa\fR and stores the ciphertext in
 158 \&\fBto\fR. \fBto\fR must point to RSA_size(\fBrsa\fR) bytes of memory.
 159 .PP
 160 \&\fBpadding\fR denotes one of the following modes:
 161 .IP "\s-1RSA_PKCS1_PADDING\s0" 4
 162 .IX Item "RSA_PKCS1_PADDING"
 163 \&\s-1PKCS\s0 #1 v1.5 padding. This currently is the most widely used mode.
 164 However, it is highly recommended to use \s-1RSA_PKCS1_OAEP_PADDING\s0 in
 165 new applications. \s-1SEE WARNING BELOW.\s0
 166 .IP "\s-1RSA_PKCS1_OAEP_PADDING\s0" 4
 167 .IX Item "RSA_PKCS1_OAEP_PADDING"
 168 EME-OAEP as defined in \s-1PKCS\s0 #1 v2.0 with \s-1SHA\-1, MGF1\s0 and an empty
 169 encoding parameter. This mode is recommended for all new applications.
 170 .IP "\s-1RSA_SSLV23_PADDING\s0" 4
 171 .IX Item "RSA_SSLV23_PADDING"
 172 \&\s-1PKCS\s0 #1 v1.5 padding with an SSL-specific modification that denotes
 173 that the server is \s-1SSL3\s0 capable.
 174 .IP "\s-1RSA_NO_PADDING\s0" 4
 175 .IX Item "RSA_NO_PADDING"
 176 Raw \s-1RSA\s0 encryption. This mode should \fIonly\fR be used to implement
 177 cryptographically sound padding modes in the application code.
 178 Encrypting user data directly with \s-1RSA\s0 is insecure.
 179 .PP
 180 \&\fBflen\fR must not be more than RSA_size(\fBrsa\fR) \- 11 for the \s-1PKCS\s0 #1 v1.5
 181 based padding modes, not more than RSA_size(\fBrsa\fR) \- 42 for
 182 \&\s-1RSA_PKCS1_OAEP_PADDING\s0 and exactly RSA_size(\fBrsa\fR) for \s-1RSA_NO_PADDING.\s0
 183 When a padding mode other than \s-1RSA_NO_PADDING\s0 is in use, then
 184 \&\fBRSA_public_encrypt()\fR will include some random bytes into the ciphertext
 185 and therefore the ciphertext will be different each time, even if the
 186 plaintext and the public key are exactly identical.
 187 The returned ciphertext in \fBto\fR will always be zero padded to exactly
 188 RSA_size(\fBrsa\fR) bytes.
 189 \&\fBto\fR and \fBfrom\fR may overlap.
 190 .PP
 191 \&\fBRSA_private_decrypt()\fR decrypts the \fBflen\fR bytes at \fBfrom\fR using the
 192 private key \fBrsa\fR and stores the plaintext in \fBto\fR. \fBflen\fR should
 193 be equal to RSA_size(\fBrsa\fR) but may be smaller, when leading zero
 194 bytes are in the ciphertext. Those are not important and may be removed,
 195 but \fBRSA_public_encrypt()\fR does not do that. \fBto\fR must point
 196 to a memory section large enough to hold the maximal possible decrypted
 197 data (which is equal to RSA_size(\fBrsa\fR) for \s-1RSA_NO_PADDING,\s0
 198 RSA_size(\fBrsa\fR) \- 11 for the \s-1PKCS\s0 #1 v1.5 based padding modes and
 199 RSA_size(\fBrsa\fR) \- 42 for \s-1RSA_PKCS1_OAEP_PADDING\s0).
 200 \&\fBpadding\fR is the padding mode that was used to encrypt the data.
 201 \&\fBto\fR and \fBfrom\fR may overlap.
 202 .SH "RETURN VALUES"
 203 .IX Header "RETURN VALUES"
 204 \&\fBRSA_public_encrypt()\fR returns the size of the encrypted data (i.e.,
 205 RSA_size(\fBrsa\fR)). \fBRSA_private_decrypt()\fR returns the size of the
 206 recovered plaintext. A return value of 0 is not an error and
 207 means only that the plaintext was empty.
 208 .PP
 209 On error, \-1 is returned; the error codes can be
 210 obtained by \fBERR_get_error\fR\|(3).
 211 .SH "WARNINGS"
 212 .IX Header "WARNINGS"
 213 Decryption failures in the \s-1RSA_PKCS1_PADDING\s0 mode leak information
 214 which can potentially be used to mount a Bleichenbacher padding oracle
 215 attack. This is an inherent weakness in the \s-1PKCS\s0 #1 v1.5 padding
 216 design. Prefer \s-1RSA_PKCS1_OAEP_PADDING.\s0
 217 .SH "CONFORMING TO"
 218 .IX Header "CONFORMING TO"
 219 \&\s-1SSL, PKCS\s0 #1 v2.0
 220 .SH "SEE ALSO"
 221 .IX Header "SEE ALSO"
 222 \&\fBERR_get_error\fR\|(3), \fBRAND_bytes\fR\|(3),
 223 \&\fBRSA_size\fR\|(3)
 224 .SH "COPYRIGHT"
 225 .IX Header "COPYRIGHT"
 226 Copyright 2000\-2019 The OpenSSL Project Authors. All Rights Reserved.
 227 .PP
 228 Licensed under the OpenSSL license (the \*(L"License\*(R").  You may not use
 229 this file except in compliance with the License.  You can obtain a copy
 230 in the file \s-1LICENSE\s0 in the source distribution or at
 231 <https://www.openssl.org/source/license.html>.