xref: /freebsd/secure/lib/libcrypto/man/man3/RSA_public_encrypt.3 (revision ba3c1f5972d7b90feb6e6da47905ff2757e0fe57)
Automatically generated by Pod::Man 4.14 (Pod::Simple 3.40)

Standard preamble:
========================================================================
..
..
.. Set up some character translations and predefined strings. \*(-- will
give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
double quote, and \*(R" will give a right double quote. \*(C+ will
give a nicer C++. Capital omega is used to do unbreakable dashes and
therefore won't be available. \*(C` and \*(C' expand to `' in nroff,
nothing in troff, for use with C<>.
.tr \(*W- . ds -- \(*W- . ds PI pi . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch . ds L" "" . ds R" "" . ds C` "" . ds C' "" 'br\} . ds -- \|\(em\| . ds PI \(*p . ds L" `` . ds R" '' . ds C` . ds C' 'br\}
Escape single quotes in literal strings from groff's Unicode transform.

If the F register is >0, we'll generate index entries on stderr for
titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
entries marked with X<> in POD. Of course, you'll have to process the
output yourself in some meaningful fashion.

Avoid warning from groff about undefined register 'F'.
.. .nr rF 0 . if \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{\ . nr % 0 . nr F 2 . \} . \} .\} .rr rF
Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
Fear. Run. Save yourself. No user-serviceable parts.
. \" fudge factors for nroff and troff . ds #H 0 . ds #V .8m . ds #F .3m . ds #[ \f1 . ds #] .\} . ds #H ((1u-(\\\\n(.fu%2u))*.13m) . ds #V .6m . ds #F 0 . ds #[ \& . ds #] \& .\} . \" simple accents for nroff and troff . ds ' \& . ds ` \& . ds ^ \& . ds , \& . ds ~ ~ . ds / .\} . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' .\} . \" troff and (daisy-wheel) nroff accents . \" corrections for vroff . \" for low resolution devices (crt and lpr) \{\ . ds : e . ds 8 ss . ds o a . ds d- d\h'-1'\(ga . ds D- D\h'-1'\(hy . ds th \o'bp' . ds Th \o'LP' . ds ae ae . ds Ae AE .\} ========================================================================

Title "RSA_PUBLIC_ENCRYPT 3"
RSA_PUBLIC_ENCRYPT 3 "2023-05-30" "3.0.9" "OpenSSL"
For nroff, turn off justification. Always turn off hyphenation; it makes
way too many mistakes in technical documents.
"NAME"
RSA_public_encrypt, RSA_private_decrypt - RSA public key cryptography
"SYNOPSIS"
Header "SYNOPSIS" .Vb 1 #include <openssl/rsa.h> .Ve

The following functions have been deprecated since OpenSSL 3.0, and can be hidden entirely by defining \s-1OPENSSL_API_COMPAT\s0 with a suitable version value, see openssl_user_macros\|(7):

.Vb 2 int RSA_public_encrypt(int flen, const unsigned char *from, unsigned char *to, RSA *rsa, int padding); \& int RSA_private_decrypt(int flen, const unsigned char *from, unsigned char *to, RSA *rsa, int padding); .Ve

"DESCRIPTION"
Header "DESCRIPTION" Both of the functions described on this page are deprecated. Applications should instead use EVP_PKEY_encrypt_init_ex\|(3), \fBEVP_PKEY_encrypt\|(3), EVP_PKEY_decrypt_init_ex\|(3) and \fBEVP_PKEY_decrypt\|(3).

\fBRSA_public_encrypt() encrypts the flen bytes at from (usually a session key) using the public key rsa and stores the ciphertext in \fBto. to must point to RSA_size(rsa) bytes of memory.

\fBpadding denotes one of the following modes:

"\s-1RSA_PKCS1_PADDING\s0" 4
Item "RSA_PKCS1_PADDING" \s-1PKCS\s0 #1 v1.5 padding. This currently is the most widely used mode. However, it is highly recommended to use \s-1RSA_PKCS1_OAEP_PADDING\s0 in new applications. \s-1SEE WARNING BELOW.\s0
"\s-1RSA_PKCS1_OAEP_PADDING\s0" 4
Item "RSA_PKCS1_OAEP_PADDING" EME-OAEP as defined in \s-1PKCS\s0 #1 v2.0 with \s-1SHA-1, MGF1\s0 and an empty encoding parameter. This mode is recommended for all new applications.
"\s-1RSA_NO_PADDING\s0" 4
Item "RSA_NO_PADDING" Raw \s-1RSA\s0 encryption. This mode should only be used to implement cryptographically sound padding modes in the application code. Encrypting user data directly with \s-1RSA\s0 is insecure.

\fBflen must not be more than RSA_size(rsa) - 11 for the \s-1PKCS\s0 #1 v1.5 based padding modes, not more than RSA_size(rsa) - 42 for \s-1RSA_PKCS1_OAEP_PADDING\s0 and exactly RSA_size(rsa) for \s-1RSA_NO_PADDING.\s0 When a padding mode other than \s-1RSA_NO_PADDING\s0 is in use, then \fBRSA_public_encrypt() will include some random bytes into the ciphertext and therefore the ciphertext will be different each time, even if the plaintext and the public key are exactly identical. The returned ciphertext in to will always be zero padded to exactly RSA_size(rsa) bytes. \fBto and from may overlap.

\fBRSA_private_decrypt() decrypts the flen bytes at from using the private key rsa and stores the plaintext in to. flen should be equal to RSA_size(rsa) but may be smaller, when leading zero bytes are in the ciphertext. Those are not important and may be removed, but RSA_public_encrypt() does not do that. to must point to a memory section large enough to hold the maximal possible decrypted data (which is equal to RSA_size(rsa) for \s-1RSA_NO_PADDING,\s0 RSA_size(rsa) - 11 for the \s-1PKCS\s0 #1 v1.5 based padding modes and RSA_size(rsa) - 42 for \s-1RSA_PKCS1_OAEP_PADDING\s0). \fBpadding is the padding mode that was used to encrypt the data. \fBto and from may overlap.

"RETURN VALUES"
Header "RETURN VALUES" \fBRSA_public_encrypt() returns the size of the encrypted data (i.e., RSA_size(rsa)). RSA_private_decrypt() returns the size of the recovered plaintext. A return value of 0 is not an error and means only that the plaintext was empty.

On error, -1 is returned; the error codes can be obtained by ERR_get_error\|(3).

"WARNINGS"
Header "WARNINGS" Decryption failures in the \s-1RSA_PKCS1_PADDING\s0 mode leak information which can potentially be used to mount a Bleichenbacher padding oracle attack. This is an inherent weakness in the \s-1PKCS\s0 #1 v1.5 padding design. Prefer \s-1RSA_PKCS1_OAEP_PADDING.\s0
"CONFORMING TO"
Header "CONFORMING TO" \s-1SSL, PKCS\s0 #1 v2.0
"SEE ALSO"
Header "SEE ALSO" \fBERR_get_error\|(3), RAND_bytes\|(3), \fBRSA_size\|(3)
"HISTORY"
Header "HISTORY" Both of these functions were deprecated in OpenSSL 3.0.
"COPYRIGHT"
Header "COPYRIGHT" Copyright 2000-2021 The OpenSSL Project Authors. All Rights Reserved.

Licensed under the Apache License 2.0 (the \*(L"License\*(R"). You may not use this file except in compliance with the License. You can obtain a copy in the file \s-1LICENSE\s0 in the source distribution or at <https://www.openssl.org/source/license.html>.