SymmetricProofDescriptor Constructor (Int32, EncryptingCredentials, EncryptingCredentials, String)

Article
10/05/2012

[Starting with the .NET Framework 4.5, Windows Identity Foundation (WIF) has been fully integrated into the .NET Framework. The version of WIF addressed by this topic, WIF 3.5, is deprecated and should only be used when developing against the .NET Framework 3.5 SP1 or the .NET Framework 4. For more information about WIF in the .NET Framework 4.5, also known as WIF 4.5, see the Windows Identity Foundation documentation in the .NET Framework 4.5 Development Guide.]

Use this constructor to have the STS autogenerate a key and send it in the proof token as encrypted key. Two cases are covered here 1. client sends the entropy, but server rejects it 2. client did not send a entropy, so just use server's entropy

Namespace: Microsoft.IdentityModel.Tokens
Assembly: Microsoft.IdentityModel (in Microsoft.IdentityModel.dll)

Usage

'Usage
Dim keySizeInBits As Integer
Dim targetWrappingCredentials As EncryptingCredentials
Dim requestorWrappingCredentials As EncryptingCredentials
Dim encryptWith As String

Dim instance As New SymmetricProofDescriptor(keySizeInBits, targetWrappingCredentials, requestorWrappingCredentials, encryptWith)

Syntax

'Declaration
Public Sub New ( _
    keySizeInBits As Integer, _
    targetWrappingCredentials As EncryptingCredentials, _
    requestorWrappingCredentials As EncryptingCredentials, _
    encryptWith As String _
)

public SymmetricProofDescriptor (
    int keySizeInBits,
    EncryptingCredentials targetWrappingCredentials,
    EncryptingCredentials requestorWrappingCredentials,
    string encryptWith
)

public:
SymmetricProofDescriptor (
    int keySizeInBits, 
    EncryptingCredentials^ targetWrappingCredentials, 
    EncryptingCredentials^ requestorWrappingCredentials, 
    String^ encryptWith
)

public SymmetricProofDescriptor (
    int keySizeInBits, 
    EncryptingCredentials targetWrappingCredentials, 
    EncryptingCredentials requestorWrappingCredentials, 
    String encryptWith
)

public function SymmetricProofDescriptor (
    keySizeInBits : int, 
    targetWrappingCredentials : EncryptingCredentials, 
    requestorWrappingCredentials : EncryptingCredentials, 
    encryptWith : String
)

Parameters

keySizeInBits
the size of the symmetric key

targetWrappingCredentials
The key encrypting credentials for the relying party.

requestorWrappingCredentials
The key encrypting credentials for the requestor.

encryptWith
The agorithm specified in the EncryptWith element of the RST.

Exceptions

Exception type	Condition
ArgumentOutOfRangeException	When keySizeInBits is less than or equal to zero.

Remarks

If EncryptWith is a DES algorithm, the key is guaranteed not to be a weak DES key.

Platforms

Target Platforms

Windows 7, Windows Server 2008 R2, Windows Vista SP2, Windows Server 2008 SP2, Windows Server 2003 SP2 (32-bit or 64-bit)