236 lines
8.5 KiB
Groff
Executable File
236 lines
8.5 KiB
Groff
Executable File
.\" Automatically generated by Pod::Man 2.25 (Pod::Simple 3.16)
|
|
.\"
|
|
.\" Standard preamble:
|
|
.\" ========================================================================
|
|
.de Sp \" Vertical space (when we can't use .PP)
|
|
.if t .sp .5v
|
|
.if n .sp
|
|
..
|
|
.de Vb \" Begin verbatim text
|
|
.ft CW
|
|
.nf
|
|
.ne \\$1
|
|
..
|
|
.de Ve \" End verbatim text
|
|
.ft R
|
|
.fi
|
|
..
|
|
.\" 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 C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
|
|
.ie n \{\
|
|
. 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\}
|
|
.el\{\
|
|
. ds -- \|\(em\|
|
|
. ds PI \(*p
|
|
. ds L" ``
|
|
. ds R" ''
|
|
'br\}
|
|
.\"
|
|
.\" Escape single quotes in literal strings from groff's Unicode transform.
|
|
.ie \n(.g .ds Aq \(aq
|
|
.el .ds Aq '
|
|
.\"
|
|
.\" If the F register is turned on, 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.
|
|
.ie \nF \{\
|
|
. de IX
|
|
. tm Index:\\$1\t\\n%\t"\\$2"
|
|
..
|
|
. nr % 0
|
|
. rr F
|
|
.\}
|
|
.el \{\
|
|
. de IX
|
|
..
|
|
.\}
|
|
.\"
|
|
.\" 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
|
|
.if n \{\
|
|
. ds #H 0
|
|
. ds #V .8m
|
|
. ds #F .3m
|
|
. ds #[ \f1
|
|
. ds #] \fP
|
|
.\}
|
|
.if t \{\
|
|
. ds #H ((1u-(\\\\n(.fu%2u))*.13m)
|
|
. ds #V .6m
|
|
. ds #F 0
|
|
. ds #[ \&
|
|
. ds #] \&
|
|
.\}
|
|
. \" simple accents for nroff and troff
|
|
.if n \{\
|
|
. ds ' \&
|
|
. ds ` \&
|
|
. ds ^ \&
|
|
. ds , \&
|
|
. ds ~ ~
|
|
. ds /
|
|
.\}
|
|
.if t \{\
|
|
. 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
|
|
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
|
|
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
|
|
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
|
|
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
|
|
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
|
|
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
|
|
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
|
|
.ds ae a\h'-(\w'a'u*4/10)'e
|
|
.ds Ae A\h'-(\w'A'u*4/10)'E
|
|
. \" corrections for vroff
|
|
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
|
|
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
|
|
. \" for low resolution devices (crt and lpr)
|
|
.if \n(.H>23 .if \n(.V>19 \
|
|
\{\
|
|
. 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
|
|
.\}
|
|
.rm #[ #] #H #V #F C
|
|
.\" ========================================================================
|
|
.\"
|
|
.IX Title "RSA_PUBLIC_ENCRYPT 3"
|
|
.TH RSA_PUBLIC_ENCRYPT 3 "2020-03-02" "3.0.0-dev" "OpenSSL"
|
|
.\" For nroff, turn off justification. Always turn off hyphenation; it makes
|
|
.\" way too many mistakes in technical documents.
|
|
.if n .ad l
|
|
.nh
|
|
.SH "NAME"
|
|
RSA_public_encrypt, RSA_private_decrypt \- RSA public key cryptography
|
|
.SH "SYNOPSIS"
|
|
.IX Header "SYNOPSIS"
|
|
.Vb 1
|
|
\& #include <openssl/rsa.h>
|
|
.Ve
|
|
.PP
|
|
Deprecated since OpenSSL 3.0, can be hidden entirely by defining
|
|
\&\fB\s-1OPENSSL_API_COMPAT\s0\fR with a suitable version value, see
|
|
\&\fIopenssl_user_macros\fR\|(7):
|
|
.PP
|
|
.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
|
|
.SH "DESCRIPTION"
|
|
.IX Header "DESCRIPTION"
|
|
Both of the functions described on this page are deprecated.
|
|
Applications should instead use \fIEVP_PKEY_encrypt_init\fR\|(3),
|
|
\&\fIEVP_PKEY_encrypt\fR\|(3), \fIEVP_PKEY_decrypt_init\fR\|(3) and \fIEVP_PKEY_decrypt\fR\|(3).
|
|
.PP
|
|
\&\fIRSA_public_encrypt()\fR encrypts the \fBflen\fR bytes at \fBfrom\fR (usually a
|
|
session key) using the public key \fBrsa\fR and stores the ciphertext in
|
|
\&\fBto\fR. \fBto\fR must point to RSA_size(\fBrsa\fR) bytes of memory.
|
|
.PP
|
|
\&\fBpadding\fR denotes one of the following modes:
|
|
.IP "\s-1RSA_PKCS1_PADDING\s0" 4
|
|
.IX 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\s0 \s-1WARNING\s0 \s-1BELOW\s0.
|
|
.IP "\s-1RSA_PKCS1_OAEP_PADDING\s0" 4
|
|
.IX Item "RSA_PKCS1_OAEP_PADDING"
|
|
EME-OAEP as defined in \s-1PKCS\s0 #1 v2.0 with \s-1SHA\-1\s0, \s-1MGF1\s0 and an empty
|
|
encoding parameter. This mode is recommended for all new applications.
|
|
.IP "\s-1RSA_SSLV23_PADDING\s0" 4
|
|
.IX Item "RSA_SSLV23_PADDING"
|
|
\&\s-1PKCS\s0 #1 v1.5 padding with an SSL-specific modification that denotes
|
|
that the server is \s-1SSL3\s0 capable.
|
|
.IP "\s-1RSA_NO_PADDING\s0" 4
|
|
.IX Item "RSA_NO_PADDING"
|
|
Raw \s-1RSA\s0 encryption. This mode should \fIonly\fR be used to implement
|
|
cryptographically sound padding modes in the application code.
|
|
Encrypting user data directly with \s-1RSA\s0 is insecure.
|
|
.PP
|
|
\&\fBflen\fR must not be more than RSA_size(\fBrsa\fR) \- 11 for the \s-1PKCS\s0 #1 v1.5
|
|
based padding modes, not more than RSA_size(\fBrsa\fR) \- 42 for
|
|
\&\s-1RSA_PKCS1_OAEP_PADDING\s0 and exactly RSA_size(\fBrsa\fR) for \s-1RSA_NO_PADDING\s0.
|
|
When a padding mode other than \s-1RSA_NO_PADDING\s0 is in use, then
|
|
\&\fIRSA_public_encrypt()\fR 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 \fBto\fR will always be zero padded to exactly
|
|
RSA_size(\fBrsa\fR) bytes.
|
|
\&\fBto\fR and \fBfrom\fR may overlap.
|
|
.PP
|
|
\&\fIRSA_private_decrypt()\fR decrypts the \fBflen\fR bytes at \fBfrom\fR using the
|
|
private key \fBrsa\fR and stores the plaintext in \fBto\fR. \fBflen\fR should
|
|
be equal to RSA_size(\fBrsa\fR) but may be smaller, when leading zero
|
|
bytes are in the ciphertext. Those are not important and may be removed,
|
|
but \fIRSA_public_encrypt()\fR does not do that. \fBto\fR must point
|
|
to a memory section large enough to hold the maximal possible decrypted
|
|
data (which is equal to RSA_size(\fBrsa\fR) for \s-1RSA_NO_PADDING\s0,
|
|
RSA_size(\fBrsa\fR) \- 11 for the \s-1PKCS\s0 #1 v1.5 based padding modes and
|
|
RSA_size(\fBrsa\fR) \- 42 for \s-1RSA_PKCS1_OAEP_PADDING\s0).
|
|
\&\fBpadding\fR is the padding mode that was used to encrypt the data.
|
|
\&\fBto\fR and \fBfrom\fR may overlap.
|
|
.SH "RETURN VALUES"
|
|
.IX Header "RETURN VALUES"
|
|
\&\fIRSA_public_encrypt()\fR returns the size of the encrypted data (i.e.,
|
|
RSA_size(\fBrsa\fR)). \fIRSA_private_decrypt()\fR returns the size of the
|
|
recovered plaintext. A return value of 0 is not an error and
|
|
means only that the plaintext was empty.
|
|
.PP
|
|
On error, \-1 is returned; the error codes can be
|
|
obtained by \fIERR_get_error\fR\|(3).
|
|
.SH "WARNINGS"
|
|
.IX 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.
|
|
.SH "CONFORMING TO"
|
|
.IX Header "CONFORMING TO"
|
|
\&\s-1SSL\s0, \s-1PKCS\s0 #1 v2.0
|
|
.SH "SEE ALSO"
|
|
.IX Header "SEE ALSO"
|
|
\&\fIERR_get_error\fR\|(3), \fIRAND_bytes\fR\|(3),
|
|
\&\fIRSA_size\fR\|(3)
|
|
.SH "HISTORY"
|
|
.IX Header "HISTORY"
|
|
Both of these functions were deprecated in OpenSSL 3.0.
|
|
.SH "COPYRIGHT"
|
|
.IX Header "COPYRIGHT"
|
|
Copyright 2000\-2019 The OpenSSL Project Authors. All Rights Reserved.
|
|
.PP
|
|
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>.
|