SymmetricProofDescriptor Constructors

Definition

Namespace:

System.IdentityModel.Tokens

Assembly:

System.IdentityModel.dll

Initializes a new instance of the SymmetricProofDescriptor class.

Overloads

SymmetricProofDescriptor(EncryptingCredentials)	Initializes a new instance of the SymmetricProofDescriptor class with the specified encrypting credentials.
SymmetricProofDescriptor(Byte[], EncryptingCredentials)	Initializes a new instance of the SymmetricProofDescriptor class with the specified key material.
SymmetricProofDescriptor(Int32, EncryptingCredentials)	Initializes a new instance of the SymmetricProofDescriptor class with an auto-generated key.
SymmetricProofDescriptor(Int32, EncryptingCredentials, EncryptingCredentials)	Initializes a new instance of the SymmetricProofDescriptor class with an auto-generated key.
SymmetricProofDescriptor(Int32, EncryptingCredentials, EncryptingCredentials, Byte[])	Initializes a new instance of the SymmetricProofDescriptor class to use for sending combined entropy.
SymmetricProofDescriptor(Int32, EncryptingCredentials, EncryptingCredentials, String)	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.
SymmetricProofDescriptor(Int32, EncryptingCredentials, EncryptingCredentials, Byte[], String)	Initializes a new instance of the SymmetricProofDescriptor class to use for sending combined entropy.

SymmetricProofDescriptor(EncryptingCredentials)

Initializes a new instance of the SymmetricProofDescriptor class with the specified encrypting credentials.

public:
 SymmetricProofDescriptor(System::IdentityModel::Tokens::EncryptingCredentials ^ targetWrappingCredentials);

public SymmetricProofDescriptor (System.IdentityModel.Tokens.EncryptingCredentials targetWrappingCredentials);

new System.IdentityModel.Tokens.SymmetricProofDescriptor : System.IdentityModel.Tokens.EncryptingCredentials -> System.IdentityModel.Tokens.SymmetricProofDescriptor

Public Sub New (targetWrappingCredentials As EncryptingCredentials)

Parameters

targetWrappingCredentials

EncryptingCredentials

The EncryptingCredentials to be used.

Remarks

Use this constructor if you want the STS to use the specified EncryptingCredentials.

SymmetricProofDescriptor(Byte[], EncryptingCredentials)

Initializes a new instance of the SymmetricProofDescriptor class with the specified key material.

public:
 SymmetricProofDescriptor(cli::array <System::Byte> ^ key, System::IdentityModel::Tokens::EncryptingCredentials ^ targetWrappingCredentials);

public SymmetricProofDescriptor (byte[] key, System.IdentityModel.Tokens.EncryptingCredentials targetWrappingCredentials);

new System.IdentityModel.Tokens.SymmetricProofDescriptor : byte[] * System.IdentityModel.Tokens.EncryptingCredentials -> System.IdentityModel.Tokens.SymmetricProofDescriptor

Public Sub New (key As Byte(), targetWrappingCredentials As EncryptingCredentials)

Parameters

key

Byte[]

The symmetric key that is used inside the issued token.

targetWrappingCredentials

EncryptingCredentials

The key encrypting credentials for the relying party.

Exceptions

ArgumentNullException

key is null.

Remarks

Use this constructor if you want the STS to use the specified key bytes. This happens when client sends the entropy, and the STS would just use that as the key for the issued token.

SymmetricProofDescriptor(Int32, EncryptingCredentials)

Initializes a new instance of the SymmetricProofDescriptor class with an auto-generated key.

public:
 SymmetricProofDescriptor(int keySizeInBits, System::IdentityModel::Tokens::EncryptingCredentials ^ targetWrappingCredentials);

public SymmetricProofDescriptor (int keySizeInBits, System.IdentityModel.Tokens.EncryptingCredentials targetWrappingCredentials);

new System.IdentityModel.Tokens.SymmetricProofDescriptor : int * System.IdentityModel.Tokens.EncryptingCredentials -> System.IdentityModel.Tokens.SymmetricProofDescriptor

Public Sub New (keySizeInBits As Integer, targetWrappingCredentials As EncryptingCredentials)

Parameters

keySizeInBits

Int32

The size of the symmetric key.

targetWrappingCredentials

EncryptingCredentials

The key encrypting credentials for the target of the request.

Remarks

Use this constructor if you want the STS to auto-generate the key using a random number generator and send it in the proof token as a binary secret.

SymmetricProofDescriptor(Int32, EncryptingCredentials, EncryptingCredentials)

Initializes a new instance of the SymmetricProofDescriptor class with an auto-generated key.

public:
 SymmetricProofDescriptor(int keySizeInBits, System::IdentityModel::Tokens::EncryptingCredentials ^ targetWrappingCredentials, System::IdentityModel::Tokens::EncryptingCredentials ^ requestorWrappingCredentials);

public SymmetricProofDescriptor (int keySizeInBits, System.IdentityModel.Tokens.EncryptingCredentials targetWrappingCredentials, System.IdentityModel.Tokens.EncryptingCredentials requestorWrappingCredentials);

new System.IdentityModel.Tokens.SymmetricProofDescriptor : int * System.IdentityModel.Tokens.EncryptingCredentials * System.IdentityModel.Tokens.EncryptingCredentials -> System.IdentityModel.Tokens.SymmetricProofDescriptor

Public Sub New (keySizeInBits As Integer, targetWrappingCredentials As EncryptingCredentials, requestorWrappingCredentials As EncryptingCredentials)

Parameters

keySizeInBits

Int32

The size of the symmetric key.

targetWrappingCredentials

EncryptingCredentials

The key encrypting credentials for the target of the request.

requestorWrappingCredentials

EncryptingCredentials

The key encrypting credentials for the requestor.

Exceptions

ArgumentOutOfRangeException

keySizeInBits is less than or equal to zero.

Remarks

Use this constructor if you want the STS to auto-generate the key and send it in the proof token as encrypted key. Two cases can be covered by using this constructor:

1. The client sends the entropy, but the server rejects it.

2. The client does not send the entropy, so the server's entropy is used.

SymmetricProofDescriptor(Int32, EncryptingCredentials, EncryptingCredentials, Byte[])

Initializes a new instance of the SymmetricProofDescriptor class to use for sending combined entropy.

public:
 SymmetricProofDescriptor(int keySizeInBits, System::IdentityModel::Tokens::EncryptingCredentials ^ targetWrappingCredentials, System::IdentityModel::Tokens::EncryptingCredentials ^ requestorWrappingCredentials, cli::array <System::Byte> ^ sourceEntropy);

public SymmetricProofDescriptor (int keySizeInBits, System.IdentityModel.Tokens.EncryptingCredentials targetWrappingCredentials, System.IdentityModel.Tokens.EncryptingCredentials requestorWrappingCredentials, byte[] sourceEntropy);

new System.IdentityModel.Tokens.SymmetricProofDescriptor : int * System.IdentityModel.Tokens.EncryptingCredentials * System.IdentityModel.Tokens.EncryptingCredentials * byte[] -> System.IdentityModel.Tokens.SymmetricProofDescriptor

Public Sub New (keySizeInBits As Integer, targetWrappingCredentials As EncryptingCredentials, requestorWrappingCredentials As EncryptingCredentials, sourceEntropy As Byte())

Parameters

keySizeInBits

Int32

The size of the symmetric key.

targetWrappingCredentials

EncryptingCredentials

The key encrypting credentials for the target of the request.

requestorWrappingCredentials

EncryptingCredentials

The encrypting credentials for the requestor used to encrypt the entropy or the proof token.

sourceEntropy

Byte[]

The requestor's entropy.

Exceptions

ArgumentNullException

sourceEntropy is null or an empty array.

ArgumentOutOfRangeException

keySize is less than zero.

Remarks

Use this constructor if you want to send a combined entropy.

SymmetricProofDescriptor(Int32, EncryptingCredentials, EncryptingCredentials, String)

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.

public:
 SymmetricProofDescriptor(int keySizeInBits, System::IdentityModel::Tokens::EncryptingCredentials ^ targetWrappingCredentials, System::IdentityModel::Tokens::EncryptingCredentials ^ requestorWrappingCredentials, System::String ^ encryptWith);

public SymmetricProofDescriptor (int keySizeInBits, System.IdentityModel.Tokens.EncryptingCredentials targetWrappingCredentials, System.IdentityModel.Tokens.EncryptingCredentials requestorWrappingCredentials, string encryptWith);

new System.IdentityModel.Tokens.SymmetricProofDescriptor : int * System.IdentityModel.Tokens.EncryptingCredentials * System.IdentityModel.Tokens.EncryptingCredentials * string -> System.IdentityModel.Tokens.SymmetricProofDescriptor

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

Parameters

keySizeInBits

Int32

The size of the symmetric key.

targetWrappingCredentials

EncryptingCredentials

The key encrypting credentials for the relying party.

requestorWrappingCredentials

EncryptingCredentials

The key encrypting credentials for the requestor.

encryptWith

String

The algorithm (URI) specified in the <EncryptWith> element of the RST.

Exceptions

ArgumentOutOfRangeException

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.

Use this constructor if you want the STS to auto-generate the key and send it in the proof token as encrypted key. Two cases can be covered by using this constructor:

1. The client sends the entropy, but the server rejects it.

2. The client does not send the entropy, so the server's entropy is used.

SymmetricProofDescriptor(Int32, EncryptingCredentials, EncryptingCredentials, Byte[], String)

Initializes a new instance of the SymmetricProofDescriptor class to use for sending combined entropy.

public:
 SymmetricProofDescriptor(int keySizeInBits, System::IdentityModel::Tokens::EncryptingCredentials ^ targetWrappingCredentials, System::IdentityModel::Tokens::EncryptingCredentials ^ requestorWrappingCredentials, cli::array <System::Byte> ^ sourceEntropy, System::String ^ encryptWith);

public SymmetricProofDescriptor (int keySizeInBits, System.IdentityModel.Tokens.EncryptingCredentials targetWrappingCredentials, System.IdentityModel.Tokens.EncryptingCredentials requestorWrappingCredentials, byte[] sourceEntropy, string encryptWith);

new System.IdentityModel.Tokens.SymmetricProofDescriptor : int * System.IdentityModel.Tokens.EncryptingCredentials * System.IdentityModel.Tokens.EncryptingCredentials * byte[] * string -> System.IdentityModel.Tokens.SymmetricProofDescriptor

Public Sub New (keySizeInBits As Integer, targetWrappingCredentials As EncryptingCredentials, requestorWrappingCredentials As EncryptingCredentials, sourceEntropy As Byte(), encryptWith As String)

Parameters

keySizeInBits

Int32

The size of the symmetric key.

targetWrappingCredentials

EncryptingCredentials

The encrypting credentials for the relying party used to encrypt the key in the SecurityKeyIdentifier property.

requestorWrappingCredentials

EncryptingCredentials

The encrypting credentials for the requestor used to encrypt the entropy or the proof token.

sourceEntropy

Byte[]

The requestor's entropy.

encryptWith

String

The URI of the algorithm to use to encrypt the proof key.

Exceptions

ArgumentOutOfRangeException

keySizeInBits is less than or equal to zero.

ArgumentNullException

sourceEntropy is null or an empty array.

Remarks

Use this constructor to send combined entropy.