RSA Class

Reference

Definition

Namespace:: System.Security.Cryptography

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

Assembly:: System.Security.Cryptography.dll

Assembly:: mscorlib.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.

Represents the base class from which all implementations of the RSA algorithm inherit.

public ref class RSA abstract : System::Security::Cryptography::AsymmetricAlgorithm

[System.Runtime.Versioning.UnsupportedOSPlatform("browser")]
public abstract class RSA : System.Security.Cryptography.AsymmetricAlgorithm

public abstract class RSA : System.Security.Cryptography.AsymmetricAlgorithm

[System.Runtime.InteropServices.ComVisible(true)]
public abstract class RSA : System.Security.Cryptography.AsymmetricAlgorithm

[<System.Runtime.Versioning.UnsupportedOSPlatform("browser")>]
type RSA = class
    inherit AsymmetricAlgorithm

type RSA = class
    inherit AsymmetricAlgorithm

[<System.Runtime.InteropServices.ComVisible(true)>]
type RSA = class
    inherit AsymmetricAlgorithm

Public MustInherit Class RSA
Inherits AsymmetricAlgorithm

Inheritance: Object

AsymmetricAlgorithm
RSA

Derived: System.Security.Cryptography.RSACng

System.Security.Cryptography.RSACryptoServiceProvider

System.Security.Cryptography.RSAOpenSsl

Attributes: UnsupportedOSPlatformAttribute ComVisibleAttribute

Remarks

Developers are encouraged to program against the RSA base class rather than any specific derived class. The derived classes are intended for interop with the underlying system cryptographic libraries.

Constructors

RSA()

Initializes a new instance of the RSA class.

Fields

KeySizeValue	Represents the size, in bits, of the key modulus used by the asymmetric algorithm. (Inherited from AsymmetricAlgorithm)
LegalKeySizesValue	Specifies the key sizes that are supported by the asymmetric algorithm. (Inherited from AsymmetricAlgorithm)

Properties

KeyExchangeAlgorithm	Gets the name of the key exchange algorithm available with this implementation of RSA.
KeyExchangeAlgorithm	When overridden in a derived class, gets the name of the key exchange algorithm. Otherwise, throws an NotImplementedException. (Inherited from AsymmetricAlgorithm)
KeySize	Gets or sets the size, in bits, of the key modulus used by the asymmetric algorithm. (Inherited from AsymmetricAlgorithm)
LegalKeySizes	Gets the key sizes that are supported by the asymmetric algorithm. (Inherited from AsymmetricAlgorithm)
SignatureAlgorithm	Gets the name of the signature algorithm available with this implementation of RSA.
SignatureAlgorithm	When implemented in a derived class, gets the name of the signature algorithm. Otherwise, always throws a NotImplementedException. (Inherited from AsymmetricAlgorithm)

Methods

Clear()	Releases all resources used by the AsymmetricAlgorithm class. (Inherited from AsymmetricAlgorithm)
Create()	Creates an instance of the default implementation of the RSA algorithm.
Create(Int32)	Creates a new ephemeral RSA key with the specified key size.
Create(RSAParameters)	Creates a new ephemeral RSA key with the specified RSA key parameters.
Create(String)	Obsolete. Creates an instance of the specified implementation of RSA.
Decrypt(Byte[], RSAEncryptionPadding)	When overridden in a derived class, decrypts the input data using the specified padding mode.
Decrypt(ReadOnlySpan<Byte>, RSAEncryptionPadding)	Decrypts the input data using the specified padding mode.
Decrypt(ReadOnlySpan<Byte>, Span<Byte>, RSAEncryptionPadding)	Decrypts the input data using the specified padding mode.
DecryptValue(Byte[])	Obsolete. When overridden in a derived class, decrypts the input data using the private key.
Dispose()	Releases all resources used by the current instance of the AsymmetricAlgorithm class. (Inherited from AsymmetricAlgorithm)
Dispose(Boolean)	Releases the unmanaged resources used by the AsymmetricAlgorithm class and optionally releases the managed resources. (Inherited from AsymmetricAlgorithm)
Encrypt(Byte[], RSAEncryptionPadding)	When overridden in a derived class, encrypts the input data using the specified padding mode.
Encrypt(ReadOnlySpan<Byte>, RSAEncryptionPadding)	Encrypts the input data using the specified padding mode.
Encrypt(ReadOnlySpan<Byte>, Span<Byte>, RSAEncryptionPadding)	Encrypts the input data using the specified padding mode.
EncryptValue(Byte[])	Obsolete. When overridden in a derived class, encrypts the input data using the public key.
Equals(Object)	Determines whether the specified object is equal to the current object. (Inherited from Object)
ExportEncryptedPkcs8PrivateKey(ReadOnlySpan<Byte>, PbeParameters)	Exports the current key in the PKCS#8 EncryptedPrivateKeyInfo format with a byte-based password. (Inherited from AsymmetricAlgorithm)
ExportEncryptedPkcs8PrivateKey(ReadOnlySpan<Char>, PbeParameters)	Exports the current key in the PKCS#8 EncryptedPrivateKeyInfo format with a char-based password. (Inherited from AsymmetricAlgorithm)
ExportEncryptedPkcs8PrivateKeyPem(ReadOnlySpan<Byte>, PbeParameters)	Exports the current key in the PKCS#8 EncryptedPrivateKeyInfo format with a byte-based password, PEM encoded. (Inherited from AsymmetricAlgorithm)
ExportEncryptedPkcs8PrivateKeyPem(ReadOnlySpan<Char>, PbeParameters)	Exports the current key in the PKCS#8 EncryptedPrivateKeyInfo format with a char-based password, PEM encoded. (Inherited from AsymmetricAlgorithm)
ExportParameters(Boolean)	When overridden in a derived class, exports the RSAParameters.
ExportPkcs8PrivateKey()	Exports the current key in the PKCS#8 PrivateKeyInfo format. (Inherited from AsymmetricAlgorithm)
ExportPkcs8PrivateKeyPem()	Exports the current key in the PKCS#8 PrivateKeyInfo format, PEM encoded. (Inherited from AsymmetricAlgorithm)
ExportRSAPrivateKey()	Exports the current key in the PKCS#1 RSAPrivateKey format.
ExportRSAPrivateKeyPem()	Exports the current key in the PKCS#1 RSAPrivateKey format, PEM encoded.
ExportRSAPublicKey()	Exports the public-key portion of the current key in the PKCS#1 RSAPublicKey format.
ExportRSAPublicKeyPem()	Exports the public-key portion of the current key in the PKCS#1 RSAPublicKey format, PEM encoded.
ExportSubjectPublicKeyInfo()	Exports the public-key portion of the current key in the X.509 SubjectPublicKeyInfo format. (Inherited from AsymmetricAlgorithm)
ExportSubjectPublicKeyInfoPem()	Exports the public-key portion of the current key in the X.509 SubjectPublicKeyInfo format, PEM encoded. (Inherited from AsymmetricAlgorithm)
FromXmlString(String)	Initializes an RSA object from the key information from an XML string.
FromXmlString(String)	When overridden in a derived class, reconstructs an AsymmetricAlgorithm object from an XML string. Otherwise, throws a NotImplementedException. (Inherited from AsymmetricAlgorithm)
GetHashCode()	Serves as the default hash function. (Inherited from Object)
GetMaxOutputSize()	Gets the maximum number of bytes an RSA operation can produce.
GetType()	Gets the Type of the current instance. (Inherited from Object)
HashData(Byte[], Int32, Int32, HashAlgorithmName)	When overridden in a derived class, computes the hash value of a specified portion of a byte array by using a specified hashing algorithm.
HashData(Stream, HashAlgorithmName)	When overridden in a derived class, computes the hash value of a specified binary stream by using a specified hashing algorithm.
ImportEncryptedPkcs8PrivateKey(ReadOnlySpan<Byte>, ReadOnlySpan<Byte>, Int32)	Imports the public/private keypair from a PKCS#8 EncryptedPrivateKeyInfo structure after decrypting with a byte-based password, replacing the keys for this object.
ImportEncryptedPkcs8PrivateKey(ReadOnlySpan<Byte>, ReadOnlySpan<Byte>, Int32)	When overridden in a derived class, imports the public/private keypair from a PKCS#8 EncryptedPrivateKeyInfo structure after decrypting with a byte-based password, replacing the keys for this object. (Inherited from AsymmetricAlgorithm)
ImportEncryptedPkcs8PrivateKey(ReadOnlySpan<Char>, ReadOnlySpan<Byte>, Int32)	Imports the public/private keypair from a PKCS#8 EncryptedPrivateKeyInfo structure after decrypting with a char-based password, replacing the keys for this object.
ImportEncryptedPkcs8PrivateKey(ReadOnlySpan<Char>, ReadOnlySpan<Byte>, Int32)	When overridden in a derived class, imports the public/private keypair from a PKCS#8 EncryptedPrivateKeyInfo structure after decrypting with a char-based password, replacing the keys for this object. (Inherited from AsymmetricAlgorithm)
ImportFromEncryptedPem(ReadOnlySpan<Char>, ReadOnlySpan<Byte>)	Imports an encrypted RFC 7468 PEM-encoded private key, replacing the keys for this object.
ImportFromEncryptedPem(ReadOnlySpan<Char>, ReadOnlySpan<Byte>)	When overridden in a derived class, imports an encrypted RFC 7468 PEM-encoded key, replacing the keys for this object. (Inherited from AsymmetricAlgorithm)
ImportFromEncryptedPem(ReadOnlySpan<Char>, ReadOnlySpan<Char>)	Imports an encrypted RFC 7468 PEM-encoded private key, replacing the keys for this object.
ImportFromEncryptedPem(ReadOnlySpan<Char>, ReadOnlySpan<Char>)	When overridden in a derived class, imports an encrypted RFC 7468 PEM-encoded key, replacing the keys for this object. (Inherited from AsymmetricAlgorithm)
ImportFromPem(ReadOnlySpan<Char>)	Imports an RFC 7468 PEM-encoded key, replacing the keys for this object.
ImportFromPem(ReadOnlySpan<Char>)	When overridden in a derived class, imports an RFC 7468 textually encoded key, replacing the keys for this object. (Inherited from AsymmetricAlgorithm)
ImportParameters(RSAParameters)	When overridden in a derived class, imports the specified RSAParameters.
ImportPkcs8PrivateKey(ReadOnlySpan<Byte>, Int32)	Imports the public/private keypair from a PKCS#8 PrivateKeyInfo structure after decryption, replacing the keys for this object.
ImportPkcs8PrivateKey(ReadOnlySpan<Byte>, Int32)	When overriden in a derived class, imports the public/private keypair from a PKCS#8 PrivateKeyInfo structure after decryption, replacing the keys for this object. (Inherited from AsymmetricAlgorithm)
ImportRSAPrivateKey(ReadOnlySpan<Byte>, Int32)	Imports the public/private keypair from a PKCS#1 RSAPrivateKey structure after decryption, replacing the keys for this object.
ImportRSAPublicKey(ReadOnlySpan<Byte>, Int32)	Imports the public key from a PKCS#1 RSAPublicKey structure after decryption, replacing the keys for this object.
ImportSubjectPublicKeyInfo(ReadOnlySpan<Byte>, Int32)	Imports the public key from an X.509 SubjectPublicKeyInfo structure after decryption, replacing the keys for this object.
ImportSubjectPublicKeyInfo(ReadOnlySpan<Byte>, Int32)	When overriden in a derived class, imports the public key from an X.509 SubjectPublicKeyInfo structure after decryption, replacing the keys for this object. (Inherited from AsymmetricAlgorithm)
MemberwiseClone()	Creates a shallow copy of the current Object. (Inherited from Object)
SignData(Byte[], HashAlgorithmName, RSASignaturePadding)	Computes the hash value of the specified byte array using the specified hash algorithm and padding mode, and signs the resulting hash value.
SignData(Byte[], Int32, Int32, HashAlgorithmName, RSASignaturePadding)	Computes the hash value of a portion of the specified byte array using the specified hash algorithm and padding mode, and signs the resulting hash value.
SignData(ReadOnlySpan<Byte>, HashAlgorithmName, RSASignaturePadding)	Computes the hash value of the specified data and signs it.
SignData(ReadOnlySpan<Byte>, Span<Byte>, HashAlgorithmName, RSASignaturePadding)	Computes the hash of the provided data with the specified algorithm and sign the hash with the current key, writing the signature into a provided buffer.
SignData(Stream, HashAlgorithmName, RSASignaturePadding)	Computes the hash value of the specified stream using the specified hash algorithm and padding mode, and signs the resulting hash value.
SignHash(Byte[], HashAlgorithmName, RSASignaturePadding)	When overridden in a derived class, computes the signature for the specified hash value using the specified padding.
SignHash(ReadOnlySpan<Byte>, HashAlgorithmName, RSASignaturePadding)	Computes the signature for the specified hash value using the specified padding.
SignHash(ReadOnlySpan<Byte>, Span<Byte>, HashAlgorithmName, RSASignaturePadding)	Signs the hash with the current key, writing the signature into a provided buffer.
ToString()	Returns a string that represents the current object. (Inherited from Object)
ToXmlString(Boolean)	Creates and returns an XML string containing the key of the current RSA object.
ToXmlString(Boolean)	When overridden in a derived class, creates and returns an XML string representation of the current AsymmetricAlgorithm object. Otherwise, throws a NotImplementedException. (Inherited from AsymmetricAlgorithm)
TryDecrypt(ReadOnlySpan<Byte>, Span<Byte>, RSAEncryptionPadding, Int32)	Attempts to decrypt the input data using the specified padding mode, writing the result into a provided buffer.
TryEncrypt(ReadOnlySpan<Byte>, Span<Byte>, RSAEncryptionPadding, Int32)	Attempts to encrypt the input data with a specified padding mode into a provided buffer.
TryExportEncryptedPkcs8PrivateKey(ReadOnlySpan<Byte>, PbeParameters, Span<Byte>, Int32)	Attempts to export the current key in the PKCS#8 EncryptedPrivateKeyInfo format into a provided buffer, using a byte-based password.
TryExportEncryptedPkcs8PrivateKey(ReadOnlySpan<Byte>, PbeParameters, Span<Byte>, Int32)	When overridden in a derived class, attempts to export the current key in the PKCS#8 EncryptedPrivateKeyInfo format into a provided buffer, using a byte-based password. (Inherited from AsymmetricAlgorithm)
TryExportEncryptedPkcs8PrivateKey(ReadOnlySpan<Char>, PbeParameters, Span<Byte>, Int32)	Attempts to export the current key in the PKCS#8 EncryptedPrivateKeyInfo format into a provided buffer, using a char-based password.
TryExportEncryptedPkcs8PrivateKey(ReadOnlySpan<Char>, PbeParameters, Span<Byte>, Int32)	When overriden in a derived class, attempts to export the current key in the PKCS#8 EncryptedPrivateKeyInfo format into a provided buffer, using a char-based password. (Inherited from AsymmetricAlgorithm)
TryExportEncryptedPkcs8PrivateKeyPem(ReadOnlySpan<Byte>, PbeParameters, Span<Char>, Int32)	Attempts to export the current key in the PKCS#8 EncryptedPrivateKeyInfo format with a byte-based password, PEM encoded. (Inherited from AsymmetricAlgorithm)
TryExportEncryptedPkcs8PrivateKeyPem(ReadOnlySpan<Char>, PbeParameters, Span<Char>, Int32)	Exports the current key in the PKCS#8 EncryptedPrivateKeyInfo format with a char-based password, PEM encoded. (Inherited from AsymmetricAlgorithm)
TryExportPkcs8PrivateKey(Span<Byte>, Int32)	Attempts to export the current key in the PKCS#8 PrivateKeyInfo format into a provided buffer.
TryExportPkcs8PrivateKey(Span<Byte>, Int32)	When overridden in a derived class, attempts to export the current key in the PKCS#8 PrivateKeyInfo format into a provided buffer. (Inherited from AsymmetricAlgorithm)
TryExportPkcs8PrivateKeyPem(Span<Char>, Int32)	Attempts to export the current key in the PEM-encoded PKCS#8 PrivateKeyInfo format into a provided buffer. (Inherited from AsymmetricAlgorithm)
TryExportRSAPrivateKey(Span<Byte>, Int32)	Attempts to export the current key in the PKCS#1 RSAPrivateKey format into a provided buffer.
TryExportRSAPrivateKeyPem(Span<Char>, Int32)	Attempts to export the current key in the PEM-encoded PKCS#1 RSAPrivateKey format into a provided buffer.
TryExportRSAPublicKey(Span<Byte>, Int32)	Attempts to export the current key in the PKCS#1 RSAPublicKey format into a provided buffer.
TryExportRSAPublicKeyPem(Span<Char>, Int32)	Attempts to export the current key in the PEM-encoded PKCS#1 RSAPublicKey format into a provided buffer.
TryExportSubjectPublicKeyInfo(Span<Byte>, Int32)	Attempts to export the current key in the X.509 SubjectPublicKeyInfo format into a provided buffer.
TryExportSubjectPublicKeyInfo(Span<Byte>, Int32)	When overridden in a derived class, attempts to export the current key in the X.509 SubjectPublicKeyInfo format into a provided buffer. (Inherited from AsymmetricAlgorithm)
TryExportSubjectPublicKeyInfoPem(Span<Char>, Int32)	Attempts to export the current key in the PEM-encoded X.509 SubjectPublicKeyInfo format into a provided buffer. (Inherited from AsymmetricAlgorithm)
TryHashData(ReadOnlySpan<Byte>, Span<Byte>, HashAlgorithmName, Int32)	Attempts to compute the hash of the provided data by using the specified algorithm, writing the results into a provided buffer.
TrySignData(ReadOnlySpan<Byte>, Span<Byte>, HashAlgorithmName, RSASignaturePadding, Int32)	Attempts to hash the provided data with the specified algorithm and sign the hash with the current key, writing the signature into a provided buffer.
TrySignHash(ReadOnlySpan<Byte>, Span<Byte>, HashAlgorithmName, RSASignaturePadding, Int32)	Attempts to sign the hash with the current key, writing the signature into a provided buffer.
VerifyData(Byte[], Byte[], HashAlgorithmName, RSASignaturePadding)	Verifies that a digital signature is valid by calculating the hash value of the specified data using the specified hash algorithm and padding, and comparing it to the provided signature.
VerifyData(Byte[], Int32, Int32, Byte[], HashAlgorithmName, RSASignaturePadding)	Verifies that a digital signature is valid by calculating the hash value of the data in a portion of a byte array using the specified hash algorithm and padding, and comparing it to the provided signature.
VerifyData(ReadOnlySpan<Byte>, ReadOnlySpan<Byte>, HashAlgorithmName, RSASignaturePadding)	Verifies that a digital signature is valid by calculating the hash value of the specified data using the specified hash algorithm and padding, and comparing it to the provided signature.
VerifyData(Stream, Byte[], HashAlgorithmName, RSASignaturePadding)	Verifies that a digital signature is valid by calculating the hash value of the specified stream using the specified hash algorithm and padding, and comparing it to the provided signature.
VerifyHash(Byte[], Byte[], HashAlgorithmName, RSASignaturePadding)	Verifies that a digital signature is valid by determining the hash value in the signature using the specified hash algorithm and padding, and comparing it to the provided hash value.
VerifyHash(ReadOnlySpan<Byte>, ReadOnlySpan<Byte>, HashAlgorithmName, RSASignaturePadding)	Verifies that a digital signature is valid by determining the hash value in the signature using the specified hash algorithm and padding, and comparing it to the provided hash value.

Explicit Interface Implementations

IDisposable.Dispose()

This API supports the product infrastructure and is not intended to be used directly from your code.

For a description of this member, see Dispose().

(Inherited from AsymmetricAlgorithm)

Applies to

Jaa