blob: 910c4752b8d5c2c0be5197f0e5f64ea2f8aa1324 [file] [log] [blame]
Ulf Möller2186cd82000-01-11 22:35:21 +00001=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
11 int RSA_public_encrypt(int flen, unsigned char *from,
12 unsigned char *to, RSA *rsa, int padding);
13
14 int RSA_private_decrypt(int flen, unsigned char *from,
15 unsigned char *to, RSA *rsa, int padding);
16
17=head1 DESCRIPTION
18
19RSA_public_encrypt() encrypts the B<flen> bytes at B<from> (usually a
20session key) using the public key B<rsa> and stores the ciphertext in
Ulf Möller41010542000-02-25 14:19:17 +000021B<to>. B<to> must point to RSA_size(B<rsa>) bytes of memory.
Ulf Möller2186cd82000-01-11 22:35:21 +000022
23B<padding> denotes one of the following modes:
24
25=over 4
26
27=item RSA_PKCS1_PADDING
28
29PKCS #1 v1.5 padding. This currently is the most widely used mode.
30
31=item RSA_PKCS1_OAEP_PADDING
32
33EME-OAEP as defined in PKCS #1 v2.0 with SHA-1, MGF1 and an empty
34encoding parameter. This mode is recommended for all new applications.
35
36=item RSA_SSLV23_PADDING
37
38PKCS #1 v1.5 padding with an SSL-specific modification that denotes
39that the server is SSL3 capable.
40
41=item RSA_NO_PADDING
42
43Raw RSA encryption. This mode should I<only> be used to implement
44cryptographically sound padding modes in the application code.
45Encrypting user data directly with RSA is insecure.
46
47=back
48
Ulf Möller41010542000-02-25 14:19:17 +000049B<flen> must be less than RSA_size(B<rsa>) - 11 for the PKCS #1 v1.5
50based padding modes, and less than RSA_size(B<rsa>) - 21 for
Ulf Möller2186cd82000-01-11 22:35:21 +000051RSA_PKCS1_OAEP_PADDING. The random number generator must be seeded
52prior to calling RSA_public_encrypt().
53
54RSA_private_decrypt() decrypts the B<flen> bytes at B<from> using the
55private key B<rsa> and stores the plaintext in B<to>. B<to> must point
56to a memory section large enough to hold the decrypted data (which is
Ulf Möller41010542000-02-25 14:19:17 +000057smaller than RSA_size(B<rsa>)). B<padding> is the padding mode that
Ulf Möller2186cd82000-01-11 22:35:21 +000058was used to encrypt the data.
59
60=head1 RETURN VALUES
61
62RSA_public_encrypt() returns the size of the encrypted data (i.e.,
Ulf Möller41010542000-02-25 14:19:17 +000063RSA_size(B<rsa>)). RSA_private_decrypt() returns the size of the
Ulf Möller2186cd82000-01-11 22:35:21 +000064recovered plaintext.
65
66On error, -1 is returned; the error codes can be
Richard Levittebb075f82000-01-27 01:25:31 +000067obtained by L<ERR_get_error(3)|ERR_get_error(3)>.
Ulf Möller2186cd82000-01-11 22:35:21 +000068
69=head1 CONFORMING TO
70
71SSL, PKCS #1 v2.0
72
73=head1 SEE ALSO
74
Richard Levittebb075f82000-01-27 01:25:31 +000075L<err(3)|err(3)>, L<rand(3)|rand(3)>, L<rsa(3)|rsa(3)>, L<RSA_size(3)|RSA_size(3)>
Ulf Möller2186cd82000-01-11 22:35:21 +000076
77=head1 NOTES
78
Richard Levittebb075f82000-01-27 01:25:31 +000079The L<RSA_PKCS1_RSAref(3)|RSA_PKCS1_RSAref(3)> method supports only the RSA_PKCS1_PADDING mode.
Ulf Möller2186cd82000-01-11 22:35:21 +000080
81=head1 HISTORY
82
83The B<padding> argument was added in SSLeay 0.8. RSA_NO_PADDING is
84available since SSLeay 0.9.0, OAEP was added in OpenSSL 0.9.2b.
85
86=cut