Debian Codegraph @

upstream/debian-unstable/man3/RSA_sign_ASN1_OCTET_STRING.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_ASN1_OCTET_STRING 3SSL"
58 .TH RSA_SIGN_ASN1_OCTET_STRING 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_ASN1_OCTET_STRING, RSA_verify_ASN1_OCTET_STRING \- 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 3
76 \& int RSA_sign_ASN1_OCTET_STRING(int dummy, unsigned char *m,
77 \& unsigned int m_len, unsigned char *sigret,
78 \& unsigned int *siglen, RSA *rsa);
79 \&
80 \& int RSA_verify_ASN1_OCTET_STRING(int dummy, unsigned char *m,
81 \& unsigned int m_len, unsigned char *sigbuf,
82 \& unsigned int siglen, RSA *rsa);
83 .Ve
84 .SH DESCRIPTION
85 .IX Header "DESCRIPTION"
86 All of the functions described on this page are deprecated.
87 Applications should instead use EVP PKEY APIs.
88 .PP
89 \&\fBRSA_sign_ASN1_OCTET_STRING()\fR signs the octet string \fBm\fR of size
90 \&\fBm_len\fR using the private key \fBrsa\fR represented in DER using PKCS #1
91 padding. It stores the signature in \fBsigret\fR and the signature size
92 in \fBsiglen\fR. \fBsigret\fR must point to \fBRSA_size(rsa)\fR bytes of
93 memory.
94 .PP
95 \&\fBdummy\fR is ignored.
96 .PP
97 The random number generator must be seeded when calling
98 \&\fBRSA_sign_ASN1_OCTET_STRING()\fR.
99 If the automatic seeding or reseeding of the OpenSSL CSPRNG fails due to
100 external circumstances (see \fBRAND\fR\|(7)), the operation will fail.
101 .PP
102 \&\fBRSA_verify_ASN1_OCTET_STRING()\fR verifies that the signature \fBsigbuf\fR
103 of size \fBsiglen\fR is the DER representation of a given octet string
104 \&\fBm\fR of size \fBm_len\fR. \fBdummy\fR is ignored. \fBrsa\fR is the signer's
105 public key.
106 .SH "RETURN VALUES"
107 .IX Header "RETURN VALUES"
108 \&\fBRSA_sign_ASN1_OCTET_STRING()\fR returns 1 on success, 0 otherwise.
109 \&\fBRSA_verify_ASN1_OCTET_STRING()\fR returns 1 on successful verification, 0
110 otherwise.
111 .PP
112 The error codes can be obtained by \fBERR_get_error\fR\|(3).
113 .SH BUGS
114 .IX Header "BUGS"
115 These functions serve no recognizable purpose.
116 .SH "SEE ALSO"
117 .IX Header "SEE ALSO"
118 \&\fBERR_get_error\fR\|(3),
119 \&\fBRAND_bytes\fR\|(3), \fBRSA_sign\fR\|(3),
120 \&\fBRSA_verify\fR\|(3),
121 \&\fBRAND\fR\|(7)
122 .SH HISTORY
123 .IX Header "HISTORY"
124 All of these functions were deprecated in OpenSSL 3.0.
125 .SH COPYRIGHT
126 .IX Header "COPYRIGHT"
127 Copyright 2000\-2020 The OpenSSL Project Authors. All Rights Reserved.
128 .PP
129 Licensed under the Apache License 2.0 (the "License"). You may not use
130 this file except in compliance with the License. You can obtain a copy
131 in the file LICENSE in the source distribution or at
132 <https://www.openssl.org/source/license.html>.