RSACng Class

Definition

Namespace:

System.Security.Cryptography

Assembly:

System.Security.Cryptography.dll

Source:

Cng.NotSupported.cs

Provides a Cryptography Next Generation (CNG) implementation of the RSA algorithm.

public ref class RSACng sealed : System::Security::Cryptography::RSA

public sealed class RSACng : System.Security.Cryptography.RSA

type RSACng = class
    inherit RSA

Public NotInheritable Class RSACng
Inherits RSA

Inheritance

Object

AsymmetricAlgorithm

RSA

RSACng

Remarks

The RSACng class is derived from the RSA class. Therefore, it is not a drop-in replacement for existing uses of RSACryptoServiceProvider.

RSACng uses a programming model that is similar to the ECDsaCng class rather than the RSACryptoServiceProvider class. For example:

• The key used by RSACng is managed by a separate CngKey object. In contrast, RSACryptoServiceProvider has a key that is directly tied to the operations of the type itself.

• RSACng performs such operations as signing and verifying signatures by using properties of the RSACng object, just as ECDsaCng uses its object properties to control signing and verification operations.

Note

The RSACng class is an implementation of the RSA algorithm using the Windows CNG libraries and isn't available on operating systems other than Windows. For applications which aren't doing Windows interop, you're encouraged to use RSA.Create instead of referencing this type directly.

Constructors

RSACng()	Initializes a new instance of the RSACng class with a random 2,048-bit key pair.
RSACng(CngKey)	Initializes a new instance of the RSACng class with the specified key.
RSACng(Int32)	Initializes a new instance of the RSACng class with a randomly generated key of the specified size.

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

Key	Gets the key that will be used by the RSACng object for any cryptographic operation that it performs.
KeyExchangeAlgorithm	Gets the name of the key exchange algorithm available with this implementation of RSA. (Inherited from RSA)
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, in bits, that are supported by this implementation of RSA.
SignatureAlgorithm	Gets the name of the signature algorithm available with this implementation of RSA. (Inherited from RSA)

Methods

Clear()	Releases all resources used by the AsymmetricAlgorithm class. (Inherited from AsymmetricAlgorithm)
Decrypt(Byte[], RSAEncryptionPadding)	Decrypts input data using the specified padding mode.
Decrypt(ReadOnlySpan<Byte>, RSAEncryptionPadding)	Decrypts the input data using the specified padding mode. (Inherited from RSA)
Decrypt(ReadOnlySpan<Byte>, Span<Byte>, RSAEncryptionPadding)	Decrypts the input data using the specified padding mode. (Inherited from RSA)
DecryptValue(Byte[])	Obsolete. When overridden in a derived class, decrypts the input data using the private key. (Inherited from RSA)
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)	Encrypts the input data using the specified padding.
Encrypt(ReadOnlySpan<Byte>, RSAEncryptionPadding)	Encrypts the input data using the specified padding mode. (Inherited from RSA)
Encrypt(ReadOnlySpan<Byte>, Span<Byte>, RSAEncryptionPadding)	Encrypts the input data using the specified padding mode. (Inherited from RSA)
EncryptValue(Byte[])	Obsolete. When overridden in a derived class, encrypts the input data using the public key. (Inherited from RSA)
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.
ExportEncryptedPkcs8PrivateKey(ReadOnlySpan<Char>, PbeParameters)	Exports the current key in the PKCS#8 EncryptedPrivateKeyInfo format with a char-based password.
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)	Exports the key used by the RSA object into a RSAParameters object.
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. (Inherited from RSA)
ExportRSAPrivateKeyPem()	Exports the current key in the PKCS#1 RSAPrivateKey format, PEM encoded. (Inherited from RSA)
ExportRSAPublicKey()	Exports the public-key portion of the current key in the PKCS#1 RSAPublicKey format. (Inherited from RSA)
ExportRSAPublicKeyPem()	Exports the public-key portion of the current key in the PKCS#1 RSAPublicKey format, PEM encoded. (Inherited from RSA)
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. (Inherited from RSA)
GetHashCode()	Serves as the default hash function. (Inherited from Object)
GetMaxOutputSize()	Gets the maximum number of bytes an RSA operation can produce. (Inherited from RSA)
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. (Inherited from RSA)
HashData(Stream, HashAlgorithmName)	When overridden in a derived class, computes the hash value of a specified binary stream by using a specified hashing algorithm. (Inherited from RSA)
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<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.
ImportFromEncryptedPem(ReadOnlySpan<Char>, ReadOnlySpan<Byte>)	Imports an encrypted RFC 7468 PEM-encoded private key, replacing the keys for this object. (Inherited from RSA)
ImportFromEncryptedPem(ReadOnlySpan<Char>, ReadOnlySpan<Char>)	Imports an encrypted RFC 7468 PEM-encoded private key, replacing the keys for this object. (Inherited from RSA)
ImportFromPem(ReadOnlySpan<Char>)	Imports an RFC 7468 PEM-encoded key, replacing the keys for this object. (Inherited from RSA)
ImportParameters(RSAParameters)	Replaces the existing key that the current instance is working with by creating a new CngKey for the parameters structure.
ImportPkcs8PrivateKey(ReadOnlySpan<Byte>, Int32)	Imports the public/private keypair from a PKCS#8 PrivateKeyInfo structure after decryption, replacing the keys for this object.
ImportRSAPrivateKey(ReadOnlySpan<Byte>, Int32)	Imports the public/private keypair from a PKCS#1 RSAPrivateKey structure after decryption, replacing the keys for this object. (Inherited from RSA)
ImportRSAPublicKey(ReadOnlySpan<Byte>, Int32)	Imports the public key from a PKCS#1 RSAPublicKey structure after decryption, replacing the keys for this object. (Inherited from RSA)
ImportSubjectPublicKeyInfo(ReadOnlySpan<Byte>, Int32)	Imports the public key from an X.509 SubjectPublicKeyInfo structure after decryption, replacing the keys for this object. (Inherited from RSA)
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. (Inherited from RSA)
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. (Inherited from RSA)
SignData(ReadOnlySpan<Byte>, HashAlgorithmName, RSASignaturePadding)	Computes the hash value of the specified data and signs it. (Inherited from RSA)
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. (Inherited from RSA)
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. (Inherited from RSA)
SignHash(Byte[], HashAlgorithmName, RSASignaturePadding)	Signs data that was hashed by using the specified hashing algorithm and padding mode.
SignHash(ReadOnlySpan<Byte>, HashAlgorithmName, RSASignaturePadding)	Computes the signature for the specified hash value using the specified padding. (Inherited from RSA)
SignHash(ReadOnlySpan<Byte>, Span<Byte>, HashAlgorithmName, RSASignaturePadding)	Signs the hash with the current key, writing the signature into a provided buffer. (Inherited from RSA)
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. (Inherited from RSA)
TryDecrypt(ReadOnlySpan<Byte>, Span<Byte>, RSAEncryptionPadding, Int32)	Decrypts data using the private key.
TryEncrypt(ReadOnlySpan<Byte>, Span<Byte>, RSAEncryptionPadding, Int32)	Encrypts data using the public key.
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<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.
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.
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. (Inherited from RSA)
TryExportRSAPrivateKeyPem(Span<Char>, Int32)	Attempts to export the current key in the PEM-encoded PKCS#1 RSAPrivateKey format into a provided buffer. (Inherited from RSA)
TryExportRSAPublicKey(Span<Byte>, Int32)	Attempts to export the current key in the PKCS#1 RSAPublicKey format into a provided buffer. (Inherited from RSA)
TryExportRSAPublicKeyPem(Span<Char>, Int32)	Attempts to export the current key in the PEM-encoded PKCS#1 RSAPublicKey format into a provided buffer. (Inherited from RSA)
TryExportSubjectPublicKeyInfo(Span<Byte>, Int32)	Attempts to export the current key in the X.509 SubjectPublicKeyInfo format into a provided buffer. (Inherited from RSA)
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. (Inherited from RSA)
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. (Inherited from RSA)
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. (Inherited from RSA)
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. (Inherited from RSA)
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. (Inherited from RSA)
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. (Inherited from RSA)
VerifyHash(Byte[], Byte[], HashAlgorithmName, RSASignaturePadding)	Verifies data that was signed and already hashed with the specified algorithm and padding mode.
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.