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