This topic has not yet been rated - Rate this topic

RSAOAEPKeyExchangeFormatter Class

Updated: March 2011

Creates Optimal Asymmetric Encryption Padding (OAEP) key exchange data using RSA.

System.Object
  System.Security.Cryptography.AsymmetricKeyExchangeFormatter
    System.Security.Cryptography.RSAOAEPKeyExchangeFormatter

Namespace:  System.Security.Cryptography
Assembly:  mscorlib (in mscorlib.dll)
[ComVisibleAttribute(true)]
public class RSAOAEPKeyExchangeFormatter : AsymmetricKeyExchangeFormatter

The RSAOAEPKeyExchangeFormatter type exposes the following members.

  Name Description
Public method RSAOAEPKeyExchangeFormatter() Initializes a new instance of the RSAOAEPKeyExchangeFormatter class.
Public method RSAOAEPKeyExchangeFormatter(AsymmetricAlgorithm) Initializes a new instance of the RSAOAEPKeyExchangeFormatter class with the specified key.
Top
  Name Description
Public property Parameter Infrastructure. Gets or sets the parameter used to create padding in the key exchange creation process.
Public property Parameters Infrastructure. Gets the parameters for the Optimal Asymmetric Encryption Padding (OAEP) key exchange. (Overrides AsymmetricKeyExchangeFormatter.Parameters.)
Public property Rng Gets or sets the random number generator algorithm to use in the creation of the key exchange.
Top
  Name Description
Public method CreateKeyExchange(Byte[]) Creates the encrypted key exchange data from the specified input data. (Overrides AsymmetricKeyExchangeFormatter.CreateKeyExchange(Byte[]).)
Public method CreateKeyExchange(Byte[], Type) Creates the encrypted key exchange data from the specified input data. (Overrides AsymmetricKeyExchangeFormatter.CreateKeyExchange(Byte[], Type).)
Public method Equals(Object) Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Protected method Finalize Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public method GetHashCode Serves as a hash function for a particular type. (Inherited from Object.)
Public method GetType Gets the Type of the current instance. (Inherited from Object.)
Protected method MemberwiseClone Creates a shallow copy of the current Object. (Inherited from Object.)
Public method SetKey Sets the public key to use for encrypting the key exchange data. (Overrides AsymmetricKeyExchangeFormatter.SetKey(AsymmetricAlgorithm).)
Public method ToString Returns a string that represents the current object. (Inherited from Object.)
Top

Key exchange allows a sender to create secret information, for example, 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 RSAOAEPKeyExchangeDeformatter to receive the key exchange and extract the secret information from it.

Caution note Caution

It is highly recommended that you 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 RSAOAEPKeyExchangeFormatter 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
            RSAOAEPKeyExchangeFormatter keyFormatter = new RSAOAEPKeyExchangeFormatter(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
            RSAOAEPKeyExchangeDeformatter keyDeformatter = new RSAOAEPKeyExchangeDeformatter(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, 3.5, 3.0, 2.0, 1.1, 1.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

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.

Date

History

Reason

March 2011

Replaced the example.

Customer feedback.

Did you find this helpful?
(1500 characters remaining)
Community Content Add
Annotations FAQ
Does not compile due to Dispose
The example above does not compile because it says that rsaKey.Dispose() is not accessible due to its protection level. That is true because Dispose() of RSACryptoServiceProvider is not public. One must replace the call with rsaKey.Clear().