Debian Codegraph @

upstream/debian-unstable/man3/RSA_sign.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_SIGN 3SSL"
58 .TH RSA_SIGN 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_sign, RSA_verify \- RSA signatures
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_sign(int type, const unsigned char *m, unsigned int m_len,
77 \& unsigned char *sigret, unsigned int *siglen, RSA *rsa);
78 \&
79 \& int RSA_verify(int type, const unsigned char *m, unsigned int m_len,
80 \& unsigned char *sigbuf, unsigned int siglen, RSA *rsa);
81 .Ve
82 .SH DESCRIPTION
83 .IX Header "DESCRIPTION"
84 All of the functions described on this page are deprecated.
85 Applications should instead use \fBEVP_PKEY_sign_init\fR\|(3), \fBEVP_PKEY_sign\fR\|(3),
86 \&\fBEVP_PKEY_verify_init\fR\|(3) and \fBEVP_PKEY_verify\fR\|(3).
87 .PP
88 \&\fBRSA_sign()\fR signs the message digest \fBm\fR of size \fBm_len\fR using the
89 private key \fBrsa\fR using RSASSA\-PKCS1\-v1_5 as specified in RFC 3447. It
90 stores the signature in \fBsigret\fR and the signature size in \fBsiglen\fR.
91 \&\fBsigret\fR must point to RSA_size(\fBrsa\fR) bytes of memory.
92 Note that PKCS #1 adds meta-data, placing limits on the size of the
93 key that can be used.
94 See \fBRSA_private_encrypt\fR\|(3) for lower-level
95 operations.
96 .PP
97 \&\fBtype\fR denotes the message digest algorithm that was used to generate
98 \&\fBm\fR.
99 If \fBtype\fR is \fBNID_md5_sha1\fR,
100 an SSL signature (MD5 and SHA1 message digests with PKCS #1 padding
101 and no algorithm identifier) is created.
102 .PP
103 \&\fBRSA_verify()\fR verifies that the signature \fBsigbuf\fR of size \fBsiglen\fR
104 matches a given message digest \fBm\fR of size \fBm_len\fR. \fBtype\fR denotes
105 the message digest algorithm that was used to generate the signature.
106 \&\fBrsa\fR is the signer's public key.
107 .SH "RETURN VALUES"
108 .IX Header "RETURN VALUES"
109 \&\fBRSA_sign()\fR returns 1 on success and 0 for failure.
110 \&\fBRSA_verify()\fR returns 1 on successful verification and 0 for failure.
111 .PP
112 The error codes can be obtained by \fBERR_get_error\fR\|(3).
113 .SH "CONFORMING TO"
114 .IX Header "CONFORMING TO"
115 SSL, PKCS #1 v2.0
116 .SH "SEE ALSO"
117 .IX Header "SEE ALSO"
118 \&\fBERR_get_error\fR\|(3),
119 \&\fBRSA_private_encrypt\fR\|(3),
120 \&\fBRSA_public_decrypt\fR\|(3)
121 .SH HISTORY
122 .IX Header "HISTORY"
123 All of these functions were deprecated in OpenSSL 3.0.
124 .SH COPYRIGHT
125 .IX Header "COPYRIGHT"
126 Copyright 2000\-2020 The OpenSSL Project Authors. All Rights Reserved.
127 .PP
128 Licensed under the Apache License 2.0 (the "License"). You may not use
129 this file except in compliance with the License. You can obtain a copy
130 in the file LICENSE in the source distribution or at
131 <https://www.openssl.org/source/license.html>.