RSA.TryEncrypt Method

Reference

Definition

Namespace:: System.Security.Cryptography

Assemblies:: netstandard.dll, System.Security.Cryptography.dll

Assemblies:: netstandard.dll, System.Security.Cryptography.Algorithms.dll

Assembly:: System.Security.Cryptography.Algorithms.dll

Assembly:: netstandard.dll

Source:: RSA.cs

Source:: RSA.cs

Source:: RSA.cs

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Attempts to encrypt the input data with a specified padding mode into a provided buffer.

public:
 virtual bool TryEncrypt(ReadOnlySpan<System::Byte> data, Span<System::Byte> destination, System::Security::Cryptography::RSAEncryptionPadding ^ padding, [Runtime::InteropServices::Out] int % bytesWritten);

public virtual bool TryEncrypt(ReadOnlySpan<byte> data, Span<byte> destination, System.Security.Cryptography.RSAEncryptionPadding padding, out int bytesWritten);

abstract member TryEncrypt : ReadOnlySpan<byte> * Span<byte> * System.Security.Cryptography.RSAEncryptionPadding * int -> bool
override this.TryEncrypt : ReadOnlySpan<byte> * Span<byte> * System.Security.Cryptography.RSAEncryptionPadding * int -> bool

Public Overridable Function TryEncrypt (data As ReadOnlySpan(Of Byte), destination As Span(Of Byte), padding As RSAEncryptionPadding, ByRef bytesWritten As Integer) As Boolean

Parameters

data: ReadOnlySpan<Byte>

The data to encrypt.

destination: Span<Byte>

The buffer to receive the encrypted data.

padding: RSAEncryptionPadding

The padding mode.

bytesWritten: Int32

When this method returns, the total number of bytes written into destination. This parameter is treated as uninitialized.

Returns

Boolean

true if destination is long enough to receive the encrypted data; otherwise, false.

Exceptions

ArgumentNullException

padding is null.

CryptographicException

padding is unknown, or not supported by this implementation.

-or-

The length of data is too long for the combination of KeySize and the selected padding.

-or-

The encryption operation failed.

Remarks

The default implementation of this method calls Encrypt(Byte[], RSAEncryptionPadding) and copies the result to destination. Derived types should override this method to avoid the intermediate array creation.

The RSA encryption algorithm will always produce an output equal to the number of bytes required for KeySize bits.

Applies to

Product	Versions
.NET	Core 2.1, Core 2.2, Core 3.0, Core 3.1, 5, 6, 7, 8, 9, 10
.NET Standard	2.1

Share via