RSACryptoServiceProvider Class
[ This article is for Windows Phone 8 developers. If you’re developing for Windows 10, see the latest documentation. ]
Performs asymmetric encryption and decryption using the implementation of the RSA algorithm provided by the cryptographic service provider (CSP). This class cannot be inherited.
System::Object
System.Security.Cryptography::AsymmetricAlgorithm
System.Security.Cryptography::RSA
System.Security.Cryptography::RSACryptoServiceProvider
System.Security.Cryptography::AsymmetricAlgorithm
System.Security.Cryptography::RSA
System.Security.Cryptography::RSACryptoServiceProvider
Assembly: mscorlib (in mscorlib.dll)
The RSACryptoServiceProvider type exposes the following members.
| Name | Description | |
|---|---|---|
 | RSACryptoServiceProvider() | Initializes a new instance of the RSACryptoServiceProvider class using the default key. |
| RSACryptoServiceProvider(CspParameters) | Initializes a new instance of the RSACryptoServiceProvider class with the specified parameters. |
| RSACryptoServiceProvider(Int32) | Initializes a new instance of the RSACryptoServiceProvider class with the specified key size. |
| RSACryptoServiceProvider(Int32, CspParameters) | Initializes a new instance of the RSACryptoServiceProvider class with the specified key size and parameters. |
| Name | Description | |
|---|---|---|
 | CspKeyContainerInfo | Gets a CspKeyContainerInfo object that describes additional information about a cryptographic key pair. |
| KeyExchangeAlgorithm | Gets the name of the key exchange algorithm available with this implementation of RSA. (Overrides AsymmetricAlgorithm::KeyExchangeAlgorithm.) |
| KeySize | Gets the size of the current key. (Overrides AsymmetricAlgorithm::KeySize.) |
| LegalKeySizes | (Inherited from AsymmetricAlgorithm.) |
| PersistKeyInCsp | Gets or sets a value indicating whether the key should be persisted in the cryptographic service provider (CSP). |
| PublicOnly | Gets a value that indicates whether the RSACryptoServiceProvider object contains only a public key. |
| SignatureAlgorithm | Gets the name of the signature algorithm available with this implementation of RSA. (Overrides AsymmetricAlgorithm::SignatureAlgorithm.) |
 | UseMachineKeyStore | Gets or sets a value indicating whether the key should be persisted in the computer's key store instead of the user profile store. |
| Name | Description | |
|---|---|---|
| Clear | (Inherited from AsymmetricAlgorithm.) |
| Decrypt | Decrypts data with the RSA algorithm. |
| DecryptValue | This method is not supported in the current version. (Overrides RSA::DecryptValue(array<Byte>).) |
| Dispose() | (Inherited from AsymmetricAlgorithm.) |
 | Dispose(Boolean) | (Inherited from AsymmetricAlgorithm.) |
| Encrypt | Encrypts data with the RSA algorithm. |
| EncryptValue | This method is not supported in the current version. (Overrides RSA::EncryptValue(array<Byte>).) |
| Equals(Object) | Determines whether the specified Object is equal to the current Object. (Inherited from Object.) |
| ExportCspBlob | Security Critical. Exports a blob containing the key information associated with an RSACryptoServiceProvider object. |
| ExportParameters | Exports the RSAParameters. (Overrides RSA::ExportParameters(Boolean).) |
| Finalize | Allows an object to try to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection. (Inherited from Object.) |
| FromXmlString | Initializes an RSA object from the key information from an XML string. (Inherited from RSA.) |
| GetHashCode | Serves as a hash function for a particular type. (Inherited from Object.) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| ImportCspBlob | Security Critical. Imports a blob that represents RSA key information. |
| ImportParameters | Imports the specified RSAParameters. (Overrides RSA::ImportParameters(RSAParameters).) |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
| SignData(array<Byte>, Object) | Computes the hash value of the specified byte array using the specified hash algorithm, and signs the resulting hash value. |
| SignData(Stream, Object) | Computes the hash value of the specified input stream using the specified hash algorithm, and signs the resulting hash value. |
| SignData(array<Byte>, Int32, Int32, Object) | Computes the hash value of a subset of the specified byte array using the specified hash algorithm, and signs the resulting hash value. |
| SignHash | Computes the signature for the specified hash value by encrypting it with the private key. |
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
| ToXmlString | Creates and returns an XML string containing the key of the current RSA object. (Inherited from RSA.) |
| VerifyData | Verifies that a digital signature is valid by determining the hash value in the signature using the provided public key and comparing it to the hash value of the provided data. |
| VerifyHash | Verifies that a digital signature is valid by determining the hash value in the signature using the provided public key and comparing it to the provided hash value. |
| Name | Description | |
|---|---|---|
 | KeySizeValue | (Inherited from AsymmetricAlgorithm.) |
| LegalKeySizesValue | (Inherited from AsymmetricAlgorithm.) |
This is the default implementation of RSA.
In Windows Phone, the RSACryptoServiceProvider supports key lengths from 384 bits to 4800 bits in increments of 8 bits.
Interoperation with the Microsoft Cryptographic API (CAPI)
Unlike the RSA implementation in unmanaged CAPI, the RSACryptoServiceProvider class reverses the order of an encrypted array of bytes after encryption and before decryption. By default, data encrypted by the RSACryptoServiceProvider class cannot be decrypted by the CAPI CryptDecrypt function and data encrypted by the CAPI CryptEncrypt method cannot be decrypted by the RSACryptoServiceProvider class.
If you do not compensate for the reverse ordering when interoperating between APIs, the RSACryptoServiceProvider class throws a CryptographicException.
To interoperate with CAPI, you must manually reverse the order of encrypted bytes before the encrypted data interoperates with another API. You can easily reverse the order of a managed byte array by calling the Array::Reverse method.
| Topic | Location |
|---|---|
| How to: Store Asymmetric Keys in a Key Container | .NET Framework: Security |
| How to: Sign XML Documents with Digital Signatures | .NET Framework: Security |
| How to: Encrypt XML Elements with Asymmetric Keys | .NET Framework: Security |
| How to: Verify the Digital Signatures of XML Documents | .NET Framework: Security |
| How to: Decrypt XML Elements with Asymmetric Keys | .NET Framework: Security |
| How to: Store Asymmetric Keys in a Key Container | .NET Framework: Security |
| How to: Sign XML Documents with Digital Signatures | .NET Framework: Security |
| How to: Encrypt XML Elements with Asymmetric Keys | .NET Framework: Security |
| How to: Verify the Digital Signatures of XML Documents | .NET Framework: Security |
| How to: Decrypt XML Elements with Asymmetric Keys | .NET Framework: Security |
Show: