xref: /netbsd-src/crypto/external/bsd/openssl/lib/libcrypto/man/RSA_private_encrypt.3 (revision 7d9ffdb3e9da593a05c5e2169f72fc7bada08bc9)
$NetBSD: RSA_private_encrypt.3,v 1.25 2024/09/08 13:08:29 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_private_encrypt 3"
RSA_private_encrypt 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_private_encrypt, RSA_public_decrypt - low-level signature operations
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_private_encrypt(int flen, unsigned char *from, unsigned char *to, RSA *rsa, int padding); \& int RSA_public_decrypt(int flen, unsigned char *from, unsigned char *to, RSA *rsa, int padding); .Ve

DESCRIPTION
Header "DESCRIPTION" Both of the functions described on this page are deprecated. Applications should instead use EVP_PKEY_sign_init_ex\|(3), \fBEVP_PKEY_sign\|(3), EVP_PKEY_verify_recover_init\|(3), and \fBEVP_PKEY_verify_recover\|(3).

These functions handle RSA signatures at a low-level.

\fBRSA_private_encrypt() signs the flen bytes at from (usually a message digest with an algorithm identifier) using the private key \fBrsa and stores the signature in to. to must point to \fBRSA_size(rsa) bytes of memory.

\fBpadding denotes one of the following modes:

RSA_PKCS1_PADDING 4
Item "RSA_PKCS1_PADDING" PKCS #1 v1.5 padding. This function does not handle the \fBalgorithmIdentifier specified in PKCS #1. When generating or verifying PKCS #1 signatures, RSA_sign\|(3) and RSA_verify\|(3) should be used.
RSA_NO_PADDING 4
Item "RSA_NO_PADDING" Raw RSA signature. This mode should only be used to implement cryptographically sound padding modes in the application code. Signing user data directly with RSA is insecure.

\fBRSA_public_decrypt() recovers the message digest from the flen bytes long signature at from using the signer's public key \fBrsa. to must point to a memory section large enough to hold the message digest (which is smaller than RSA_size(rsa) - 11). padding is the padding mode that was used to sign the data.

"RETURN VALUES"
Header "RETURN VALUES" \fBRSA_private_encrypt() returns the size of the signature (i.e., RSA_size(rsa)). RSA_public_decrypt() returns the size of the recovered message digest.

On error, -1 is returned; the error codes can be obtained by ERR_get_error\|(3).

"SEE ALSO"
Header "SEE ALSO" \fBERR_get_error\|(3), \fBRSA_sign\|(3), RSA_verify\|(3), \fBEVP_PKEY_sign\|(3), EVP_PKEY_verify_recover\|(3)
HISTORY
Header "HISTORY" Both 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>.