Debian Codegraph @

upstream/debian-unstable/man3/RSA_private_encrypt.3ssl

raw
1 .\" -*- mode: troff; coding: utf-8 -*-
2 .\" Automatically generated by Pod::Man 5.0102 (Pod::Simple 3.45)
3 .\"
4 .\" Standard preamble:
5 .\" ========================================================================
6 .de Sp \" Vertical space (when we can't use .PP)
7 .if t .sp .5v
8 .if n .sp
9 ..
10 .de Vb \" Begin verbatim text
11 .ft CW
12 .nf
13 .ne \\$1
14 ..
15 .de Ve \" End verbatim text
16 .ft R
17 .fi
18 ..
19 .\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
20 .ie n \{\
21 . ds C` ""
22 . ds C' ""
23 'br\}
24 .el\{\
25 . ds C`
26 . ds C'
27 'br\}
28 .\"
29 .\" Escape single quotes in literal strings from groff's Unicode transform.
30 .ie \n(.g .ds Aq \(aq
31 .el .ds Aq '
32 .\"
33 .\" If the F register is >0, we'll generate index entries on stderr for
34 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
35 .\" entries marked with X<> in POD. Of course, you'll have to process the
36 .\" output yourself in some meaningful fashion.
37 .\"
38 .\" Avoid warning from groff about undefined register 'F'.
39 .de IX
40 ..
41 .nr rF 0
42 .if \n(.g .if rF .nr rF 1
43 .if (\n(rF:(\n(.g==0)) \{\
44 . if \nF \{\
45 . de IX
46 . tm Index:\\$1\t\\n%\t"\\$2"
47 ..
48 . if !\nF==2 \{\
49 . nr % 0
50 . nr F 2
51 . \}
52 . \}
53 .\}
54 .rr rF
55 .\" ========================================================================
56 .\"
57 .IX Title "RSA_PRIVATE_ENCRYPT 3SSL"
58 .TH RSA_PRIVATE_ENCRYPT 3SSL 2026-04-07 3.6.2 OpenSSL
59 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
60 .\" way too many mistakes in technical documents.
61 .if n .ad l
62 .nh
63 .SH NAME
64 RSA_private_encrypt, RSA_public_decrypt \- low\-level signature operations
65 .SH SYNOPSIS
66 .IX Header "SYNOPSIS"
67 .Vb 1
68 \& #include <openssl/rsa.h>
69 .Ve
70 .PP
71 The following functions have been deprecated since OpenSSL 3.0, and can be
72 hidden entirely by defining \fBOPENSSL_API_COMPAT\fR with a suitable version value,
73 see \fBopenssl_user_macros\fR\|(7):
74 .PP
75 .Vb 2
76 \& int RSA_private_encrypt(int flen, unsigned char *from,
77 \& unsigned char *to, RSA *rsa, int padding);
78 \&
79 \& int RSA_public_decrypt(int flen, unsigned char *from,
80 \& unsigned char *to, RSA *rsa, int padding);
81 .Ve
82 .SH DESCRIPTION
83 .IX Header "DESCRIPTION"
84 Both of the functions described on this page are deprecated.
85 Applications should instead use \fBEVP_PKEY_sign_init_ex\fR\|(3),
86 \&\fBEVP_PKEY_sign\fR\|(3), \fBEVP_PKEY_verify_recover_init\fR\|(3), and
87 \&\fBEVP_PKEY_verify_recover\fR\|(3).
88 .PP
89 These functions handle RSA signatures at a low-level.
90 .PP
91 \&\fBRSA_private_encrypt()\fR signs the \fBflen\fR bytes at \fBfrom\fR (usually a
92 message digest with an algorithm identifier) using the private key
93 \&\fBrsa\fR and stores the signature in \fBto\fR. \fBto\fR must point to
94 \&\fBRSA_size(rsa)\fR bytes of memory.
95 .PP
96 \&\fBpadding\fR denotes one of the following modes:
97 .IP RSA_PKCS1_PADDING 4
98 .IX Item "RSA_PKCS1_PADDING"
99 PKCS #1 v1.5 padding. This function does not handle the
100 \&\fBalgorithmIdentifier\fR specified in PKCS #1. When generating or
101 verifying PKCS #1 signatures, \fBRSA_sign\fR\|(3) and \fBRSA_verify\fR\|(3) should be
102 used.
103 .IP RSA_NO_PADDING 4
104 .IX Item "RSA_NO_PADDING"
105 Raw RSA signature. This mode should \fIonly\fR be used to implement
106 cryptographically sound padding modes in the application code.
107 Signing user data directly with RSA is insecure.
108 .PP
109 \&\fBRSA_public_decrypt()\fR recovers the message digest from the \fBflen\fR
110 bytes long signature at \fBfrom\fR using the signer's public key
111 \&\fBrsa\fR. \fBto\fR must point to a memory section large enough to hold the
112 message digest (which is smaller than \fBRSA_size(rsa) \-
113 11\fR). \fBpadding\fR is the padding mode that was used to sign the data.
114 .SH "RETURN VALUES"
115 .IX Header "RETURN VALUES"
116 \&\fBRSA_private_encrypt()\fR returns the size of the signature (i.e.,
117 RSA_size(rsa)). \fBRSA_public_decrypt()\fR returns the size of the
118 recovered message digest.
119 .PP
120 On error, \-1 is returned; the error codes can be
121 obtained by \fBERR_get_error\fR\|(3).
122 .SH "SEE ALSO"
123 .IX Header "SEE ALSO"
124 \&\fBERR_get_error\fR\|(3),
125 \&\fBRSA_sign\fR\|(3), \fBRSA_verify\fR\|(3),
126 \&\fBEVP_PKEY_sign\fR\|(3), \fBEVP_PKEY_verify_recover\fR\|(3)
127 .SH HISTORY
128 .IX Header "HISTORY"
129 Both of these functions were deprecated in OpenSSL 3.0.
130 .SH COPYRIGHT
131 .IX Header "COPYRIGHT"
132 Copyright 2000\-2021 The OpenSSL Project Authors. All Rights Reserved.
133 .PP
134 Licensed under the Apache License 2.0 (the "License"). You may not use
135 this file except in compliance with the License. You can obtain a copy
136 in the file LICENSE in the source distribution or at
137 <https://www.openssl.org/source/license.html>.