doc/man3/RSA_public_encrypt.pod

   1 =pod
   2
   3 =head1 NAME
   4
   5 RSA_public_encrypt, RSA_private_decrypt - RSA public key cryptography
   6
   7 =head1 SYNOPSIS
   8
   9  #include <openssl/rsa.h>
  10
  11 Deprecated since OpenSSL 3.0, can be hidden entirely by defining
  12 B<OPENSSL_API_COMPAT> with a suitable version value, see
  13 L<openssl_user_macros(7)>:
  14
  15  int RSA_public_encrypt(int flen, const unsigned char *from,
  16                         unsigned char *to, RSA *rsa, int padding);
  17
  18  int RSA_private_decrypt(int flen, const unsigned char *from,
  19                          unsigned char *to, RSA *rsa, int padding);
  20
  21 =head1 DESCRIPTION
  22
  23 Both of the functions described on this page are deprecated.
  24 Applications should instead use L<EVP_PKEY_encrypt_init(3)>,
  25 L<EVP_PKEY_encrypt(3)>, L<EVP_PKEY_decrypt_init(3)> and L<EVP_PKEY_decrypt(3)>.
  26
  27 RSA_public_encrypt() encrypts the B<flen> bytes at B<from> (usually a
  28 session key) using the public key B<rsa> and stores the ciphertext in
  29 B<to>. B<to> must point to RSA_size(B<rsa>) bytes of memory.
  30
  31 B<padding> denotes one of the following modes:
  32
  33 =over 4
  34
  35 =item RSA_PKCS1_PADDING
  36
  37 PKCS #1 v1.5 padding. This currently is the most widely used mode.
  38 However, it is highly recommended to use RSA_PKCS1_OAEP_PADDING in
  39 new applications. SEE WARNING BELOW.
  40
  41 =item RSA_PKCS1_OAEP_PADDING
  42
  43 EME-OAEP as defined in PKCS #1 v2.0 with SHA-1, MGF1 and an empty
  44 encoding parameter. This mode is recommended for all new applications.
  45
  46 =item RSA_SSLV23_PADDING
  47
  48 PKCS #1 v1.5 padding with an SSL-specific modification that denotes
  49 that the server is SSL3 capable.
  50
  51 =item RSA_NO_PADDING
  52
  53 Raw RSA encryption. This mode should I<only> be used to implement
  54 cryptographically sound padding modes in the application code.
  55 Encrypting user data directly with RSA is insecure.
  56
  57 =back
  58
  59 B<flen> must not be more than RSA_size(B<rsa>) - 11 for the PKCS #1 v1.5
  60 based padding modes, not more than RSA_size(B<rsa>) - 42 for
  61 RSA_PKCS1_OAEP_PADDING and exactly RSA_size(B<rsa>) for RSA_NO_PADDING.
  62 When a padding mode other than RSA_NO_PADDING is in use, then
  63 RSA_public_encrypt() will include some random bytes into the ciphertext
  64 and therefore the ciphertext will be different each time, even if the
  65 plaintext and the public key are exactly identical.
  66 The returned ciphertext in B<to> will always be zero padded to exactly
  67 RSA_size(B<rsa>) bytes.
  68 B<to> and B<from> may overlap.
  69
  70 RSA_private_decrypt() decrypts the B<flen> bytes at B<from> using the
  71 private key B<rsa> and stores the plaintext in B<to>. B<flen> should
  72 be equal to RSA_size(B<rsa>) but may be smaller, when leading zero
  73 bytes are in the ciphertext. Those are not important and may be removed,
  74 but RSA_public_encrypt() does not do that. B<to> must point
  75 to a memory section large enough to hold the maximal possible decrypted
  76 data (which is equal to RSA_size(B<rsa>) for RSA_NO_PADDING,
  77 RSA_size(B<rsa>) - 11 for the PKCS #1 v1.5 based padding modes and
  78 RSA_size(B<rsa>) - 42 for RSA_PKCS1_OAEP_PADDING).
  79 B<padding> is the padding mode that was used to encrypt the data.
  80 B<to> and B<from> may overlap.
  81
  82 =head1 RETURN VALUES
  83
  84 RSA_public_encrypt() returns the size of the encrypted data (i.e.,
  85 RSA_size(B<rsa>)). RSA_private_decrypt() returns the size of the
  86 recovered plaintext. A return value of 0 is not an error and
  87 means only that the plaintext was empty.
  88
  89 On error, -1 is returned; the error codes can be
  90 obtained by L<ERR_get_error(3)>.
  91
  92 =head1 WARNINGS
  93
  94 Decryption failures in the RSA_PKCS1_PADDING mode leak information
  95 which can potentially be used to mount a Bleichenbacher padding oracle
  96 attack. This is an inherent weakness in the PKCS #1 v1.5 padding
  97 design. Prefer RSA_PKCS1_OAEP_PADDING.
  98
  99 =head1 CONFORMING TO
 100
 101 SSL, PKCS #1 v2.0
 102
 103 =head1 SEE ALSO
 104
 105 L<ERR_get_error(3)>, L<RAND_bytes(3)>,
 106 L<RSA_size(3)>
 107
 108 =head1 HISTORY
 109
 110 Both of these functions were deprecated in OpenSSL 3.0.
 111
 112 =head1 COPYRIGHT
 113
 114 Copyright 2000-2019 The OpenSSL Project Authors. All Rights Reserved.
 115
 116 Licensed under the Apache License 2.0 (the "License").  You may not use
 117 this file except in compliance with the License.  You can obtain a copy
 118 in the file LICENSE in the source distribution or at
 119 L<https://www.openssl.org/source/license.html>.
 120
 121 =cut