Export (0) Print
Expand All
This topic has not yet been rated - Rate this topic

RSAOAEPKeyExchangeFormatter Class

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)
'Declaration
<ComVisibleAttribute(True)> _
Public Class RSAOAEPKeyExchangeFormatter _
	Inherits AsymmetricKeyExchangeFormatter

The RSAOAEPKeyExchangeFormatter type exposes the following members.

  NameDescription
Public methodRSAOAEPKeyExchangeFormatterInitializes a new instance of the RSAOAEPKeyExchangeFormatter class.
Public methodRSAOAEPKeyExchangeFormatter(AsymmetricAlgorithm)Initializes a new instance of the RSAOAEPKeyExchangeFormatter class with the specified key.
Top
  NameDescription
Public propertyParameterInfrastructure. Gets or sets the parameter used to create padding in the key exchange creation process.
Public propertyParametersInfrastructure. Gets the parameters for the Optimal Asymmetric Encryption Padding (OAEP) 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, 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 noteCaution

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.

Imports System
Imports System.IO
Imports System.Security.Cryptography
Imports System.Text




Class Alice

    Public Shared Sub Main(ByVal args() As String)
        Using bob As New Bob()
            Using rsaKey As New RSACryptoServiceProvider()
                    ' Get Bob's public key
                    rsaKey.ImportCspBlob(bob.key)
                    Dim encryptedSessionKey As Byte() = Nothing 
                    Dim encryptedMessage As Byte() = Nothing 
                    Dim iv As Byte() = Nothing
                    Send(rsaKey, "Secret message", iv, encryptedSessionKey, encryptedMessage)
                    bob.Receive(iv, encryptedSessionKey, encryptedMessage)
            End Using 
        End Using 

    End Sub 'Main


    Private Shared Sub Send(ByVal key As RSA, ByVal secretMessage As String, ByRef iv() As Byte, ByRef encryptedSessionKey() As Byte, ByRef encryptedMessage() As Byte)
        Using aes = New AesCryptoServiceProvider()

            iv = aes.IV

            ' Encrypt the session key 
            Dim keyFormatter As New RSAOAEPKeyExchangeFormatter(key)
            encryptedSessionKey = keyFormatter.CreateKeyExchange(aes.Key, GetType(Aes))

            ' Encrypt the message 
            Using ciphertext As New MemoryStream()
                Using cs As New CryptoStream(ciphertext, aes.CreateEncryptor(), CryptoStreamMode.Write)
                    Dim plaintextMessage As Byte() = Encoding.UTF8.GetBytes(secretMessage)
                    cs.Write(plaintextMessage, 0, plaintextMessage.Length)
                    cs.Close()

                    encryptedMessage = ciphertext.ToArray()
                End Using 
            End Using 
        End Using 

    End Sub 'Send 
End Class 'Alice

Public Class Bob
    Implements IDisposable
    Public key() As Byte 
    Private rsaKey As New RSACryptoServiceProvider()

    Public Sub New()
        key = rsaKey.ExportCspBlob(False)

    End Sub 'New 

    Public Sub Receive(ByVal iv() As Byte, ByVal encryptedSessionKey() As Byte, ByVal encryptedMessage() As Byte)

        Using aes = New AesCryptoServiceProvider()

            aes.IV = iv

            ' Decrypt the session key 
            Dim keyDeformatter As New RSAOAEPKeyExchangeDeformatter(rsaKey)
            aes.Key = keyDeformatter.DecryptKeyExchange(encryptedSessionKey)

            ' Decrypt the message 
            Using plaintext As New MemoryStream()
                Using cs As New CryptoStream(plaintext, aes.CreateDecryptor(), CryptoStreamMode.Write)
                        cs.Write(encryptedMessage, 0, encryptedMessage.Length)
                        cs.Close()

                        Dim message As String = Encoding.UTF8.GetString(plaintext.ToArray())
                        Console.WriteLine(message)
                End Using 
            End Using 
        End Using 

    End Sub 'Receive
    Public Overloads Sub Dispose() Implements IDisposable.Dispose
        rsaKey.Dispose()
    End Sub 'Dispose
End Class 'Bob

.NET Framework

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

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

.NET for Windows Phone apps

Supported in: Windows Phone 8.1, Windows Phone 8, Silverlight 8.1

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.
Did you find this helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft. All rights reserved.