xref: /netbsd-src/crypto/external/bsd/openssl/lib/libcrypto/man/RSA_sign.3 (revision 7d9ffdb3e9da593a05c5e2169f72fc7bada08bc9)
$NetBSD: RSA_sign.3,v 1.25 2024/09/08 13:08:30 christos Exp $

-*- mode: troff; coding: utf-8 -*-
Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)

Standard preamble:
========================================================================
..
..
.. \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
. ds C` "" . ds C' "" 'br\} . 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 ========================================================================

Title "RSA_sign 3"
RSA_sign 3 2024-09-03 3.0.15 OpenSSL
For nroff, turn off justification. Always turn off hyphenation; it makes
way too many mistakes in technical documents.
NAME
RSA_sign, RSA_verify - RSA signatures
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 OPENSSL_API_COMPAT with a suitable version value, see openssl_user_macros\|(7):

.Vb 2 int RSA_sign(int type, const unsigned char *m, unsigned int m_len, unsigned char *sigret, unsigned int *siglen, RSA *rsa); \& int RSA_verify(int type, const unsigned char *m, unsigned int m_len, unsigned char *sigbuf, unsigned int siglen, RSA *rsa); .Ve

DESCRIPTION
Header "DESCRIPTION" All of the functions described on this page are deprecated. Applications should instead use EVP_PKEY_sign_init\|(3), EVP_PKEY_sign\|(3), \fBEVP_PKEY_verify_init\|(3) and EVP_PKEY_verify\|(3).

\fBRSA_sign() signs the message digest m of size m_len using the private key rsa using RSASSA-PKCS1-v1_5 as specified in RFC 3447. It stores the signature in sigret and the signature size in siglen. \fBsigret must point to RSA_size(rsa) bytes of memory. Note that PKCS #1 adds meta-data, placing limits on the size of the key that can be used. See RSA_private_encrypt\|(3) for lower-level operations.

\fBtype denotes the message digest algorithm that was used to generate \fBm. If type is NID_md5_sha1, an SSL signature (MD5 and SHA1 message digests with PKCS #1 padding and no algorithm identifier) is created.

\fBRSA_verify() verifies that the signature sigbuf of size siglen matches a given message digest m of size m_len. type denotes the message digest algorithm that was used to generate the signature. \fBrsa is the signer's public key.

"RETURN VALUES"
Header "RETURN VALUES" \fBRSA_sign() returns 1 on success and 0 for failure. \fBRSA_verify() returns 1 on successful verification and 0 for failure.

The error codes can be obtained by ERR_get_error\|(3).

"CONFORMING TO"
Header "CONFORMING TO" SSL, PKCS #1 v2.0
"SEE ALSO"
Header "SEE ALSO" \fBERR_get_error\|(3), \fBRSA_private_encrypt\|(3), \fBRSA_public_decrypt\|(3)
HISTORY
Header "HISTORY" All 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 "License"). You may not use this file except in compliance with the License. You can obtain a copy in the file LICENSE in the source distribution or at <https://www.openssl.org/source/license.html>.