RSAPKCS1KeyExchangeFormatter Class

Creates the PKCS#1 key exchange data using RSA.

System.Object
  System.Security.Cryptography.AsymmetricKeyExchangeFormatter
    System.Security.Cryptography.RSAPKCS1KeyExchangeFormatter

Namespace:  System.Security.Cryptography
Assembly:  mscorlib (in mscorlib.dll)

[ComVisibleAttribute(true)]
public class RSAPKCS1KeyExchangeFormatter : AsymmetricKeyExchangeFormatter

The RSAPKCS1KeyExchangeFormatter type exposes the following members.

  NameDescription
Public methodRSAPKCS1KeyExchangeFormatter()Initializes a new instance of the RSAPKCS1KeyExchangeFormatter class.
Public methodRSAPKCS1KeyExchangeFormatter(AsymmetricAlgorithm)Initializes a new instance of the RSAPKCS1KeyExchangeFormatter class with the specified key.
Top

  NameDescription
Public propertyParametersGets the parameters for the PKCS #1 key exchange. (Overrides AsymmetricKeyExchangeFormatter.Parameters.)
Public propertyRngGets or sets the random number generator algorithm to use in the creation of the key exchange.
Top

  NameDescription
Public methodCreateKeyExchange(Byte[])Creates the encrypted key exchange data from the specified input data. (Overrides AsymmetricKeyExchangeFormatter.CreateKeyExchange(Byte[]).)
Public methodCreateKeyExchange(Byte[], Type)Creates the encrypted key exchange data from the specified input data. (Overrides AsymmetricKeyExchangeFormatter.CreateKeyExchange(Byte[], Type).)
Public methodEquals(Object)Determines whether the specified object is equal to the current object. (Inherited from Object.)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public methodGetHashCodeServes as the default hash function. (Inherited from Object.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodSetKeySets the public key to use for encrypting the key exchange data. (Overrides AsymmetricKeyExchangeFormatter.SetKey(AsymmetricAlgorithm).)
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)
Top

Key exchange allows a sender to create secret information (such as random data that can be used as a key in a symmetric encryption algorithm) and use encryption to send it to the intended recipient.

Use RSAPKCS1KeyExchangeDeformatter to receive the key exchange and extract the secret information from it.

Caution noteCaution

We recommend that you do not attempt to create your own key exchange method from the basic functionality provided, because many details of the operation must be performed carefully in order for the key exchange to be successful.

The following example shows how to use the RSAPKCS1KeyExchangeFormatter class to create an exchange key for a message recipient.

using System;
using System.IO;
using System.Security.Cryptography;
using System.Text;


class Alice
{
    public static void Main(string[] args)
    {
        using (Bob bob = new Bob())
        {
            using (RSACryptoServiceProvider rsaKey = new RSACryptoServiceProvider())
            {
                // Get Bob's public key
                rsaKey.ImportCspBlob(bob.key);
                byte[] encryptedSessionKey = null;
                byte[] encryptedMessage = null;
                byte[] iv = null;
                Send(rsaKey, "Secret message", out iv, out encryptedSessionKey, out encryptedMessage);
                bob.Receive(iv, encryptedSessionKey, encryptedMessage);
            }
        }
    }

    private static void Send(RSA key, string secretMessage, out byte[] iv, out byte[] encryptedSessionKey, out byte[] encryptedMessage)
    {
        using (Aes aes = new AesCryptoServiceProvider())
        {
            iv = aes.IV;

            // Encrypt the session key
            RSAPKCS1KeyExchangeFormatter keyFormatter = new RSAPKCS1KeyExchangeFormatter(key);
            encryptedSessionKey = keyFormatter.CreateKeyExchange(aes.Key, typeof(Aes));

            // Encrypt the message 
            using (MemoryStream ciphertext = new MemoryStream())
            using (CryptoStream cs = new CryptoStream(ciphertext, aes.CreateEncryptor(), CryptoStreamMode.Write))
            {
                byte[] plaintextMessage = Encoding.UTF8.GetBytes(secretMessage);
                cs.Write(plaintextMessage, 0, plaintextMessage.Length);
                cs.Close();

                encryptedMessage = ciphertext.ToArray();
            }
        }
    }

}
public class Bob : IDisposable
{
    public byte[] key;
    private RSACryptoServiceProvider rsaKey = new RSACryptoServiceProvider();
    public Bob()
    {
        key = rsaKey.ExportCspBlob(false);
    }
    public void Receive(byte[] iv, byte[] encryptedSessionKey, byte[] encryptedMessage)
    {

        using (Aes aes = new AesCryptoServiceProvider())
        {
            aes.IV = iv;

            // Decrypt the session key
            RSAPKCS1KeyExchangeDeformatter keyDeformatter = new RSAPKCS1KeyExchangeDeformatter(rsaKey);
            aes.Key = keyDeformatter.DecryptKeyExchange(encryptedSessionKey);

            // Decrypt the message 
            using (MemoryStream plaintext = new MemoryStream())
            using (CryptoStream cs = new CryptoStream(plaintext, aes.CreateDecryptor(), CryptoStreamMode.Write))
            {
                cs.Write(encryptedMessage, 0, encryptedMessage.Length);
                cs.Close();

                string message = Encoding.UTF8.GetString(plaintext.ToArray());
                Console.WriteLine(message);
            }
        }
    }
    public void Dispose()
    {
        rsaKey.Dispose();
    }
}

.NET Framework

Supported in: 4.6, 4.5, 4, 3.5, 3.0, 2.0, 1.1, 1.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Supported in: Windows Phone 8.1

Supported in: Windows Phone Silverlight 8.1

Supported in: Windows Phone Silverlight 8

Windows Phone 8.1, Windows Phone 8, Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft