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_NO_PADDING
  47
  48 Raw RSA encryption. This mode should I<only> be used to implement
  49 cryptographically sound padding modes in the application code.
  50 Encrypting user data directly with RSA is insecure.
  51
  52 =back
  53
  54 B<flen> must not be more than RSA_size(B<rsa>) - 11 for the PKCS #1 v1.5
  55 based padding modes, not more than RSA_size(B<rsa>) - 42 for
  56 RSA_PKCS1_OAEP_PADDING and exactly RSA_size(B<rsa>) for RSA_NO_PADDING.
  57 When a padding mode other than RSA_NO_PADDING is in use, then
  58 RSA_public_encrypt() will include some random bytes into the ciphertext
  59 and therefore the ciphertext will be different each time, even if the
  60 plaintext and the public key are exactly identical.
  61 The returned ciphertext in B<to> will always be zero padded to exactly
  62 RSA_size(B<rsa>) bytes.
  63 B<to> and B<from> may overlap.
  64
  65 RSA_private_decrypt() decrypts the B<flen> bytes at B<from> using the
  66 private key B<rsa> and stores the plaintext in B<to>. B<flen> should
  67 be equal to RSA_size(B<rsa>) but may be smaller, when leading zero
  68 bytes are in the ciphertext. Those are not important and may be removed,
  69 but RSA_public_encrypt() does not do that. B<to> must point
  70 to a memory section large enough to hold the maximal possible decrypted
  71 data (which is equal to RSA_size(B<rsa>) for RSA_NO_PADDING,
  72 RSA_size(B<rsa>) - 11 for the PKCS #1 v1.5 based padding modes and
  73 RSA_size(B<rsa>) - 42 for RSA_PKCS1_OAEP_PADDING).
  74 B<padding> is the padding mode that was used to encrypt the data.
  75 B<to> and B<from> may overlap.
  76
  77 =head1 RETURN VALUES
  78
  79 RSA_public_encrypt() returns the size of the encrypted data (i.e.,
  80 RSA_size(B<rsa>)). RSA_private_decrypt() returns the size of the
  81 recovered plaintext. A return value of 0 is not an error and
  82 means only that the plaintext was empty.
  83
  84 On error, -1 is returned; the error codes can be
  85 obtained by L<ERR_get_error(3)>.
  86
  87 =head1 WARNINGS
  88
  89 Decryption failures in the RSA_PKCS1_PADDING mode leak information
  90 which can potentially be used to mount a Bleichenbacher padding oracle
  91 attack. This is an inherent weakness in the PKCS #1 v1.5 padding
  92 design. Prefer RSA_PKCS1_OAEP_PADDING.
  93
  94 =head1 CONFORMING TO
  95
  96 SSL, PKCS #1 v2.0
  97
  98 =head1 SEE ALSO
  99
 100 L<ERR_get_error(3)>, L<RAND_bytes(3)>,
 101 L<RSA_size(3)>
 102
 103 =head1 HISTORY
 104
 105 Both of these functions were deprecated in OpenSSL 3.0.
 106
 107 =head1 COPYRIGHT
 108
 109 Copyright 2000-2020 The OpenSSL Project Authors. All Rights Reserved.
 110
 111 Licensed under the Apache License 2.0 (the "License").  You may not use
 112 this file except in compliance with the License.  You can obtain a copy
 113 in the file LICENSE in the source distribution or at
 114 L<https://www.openssl.org/source/license.html>.
 115
 116 =cut