Was this page helpful?
Your feedback about this content is important. Let us know what you think.
Additional feedback?
1500 characters remaining
Export (0) Print
Expand All

EncryptedKeyIdentifierClause Class

Represents a key identifier clause that identifies an encrypted key.

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

public sealed class EncryptedKeyIdentifierClause : BinaryKeyIdentifierClause

The EncryptedKeyIdentifierClause type exposes the following members.

  NameDescription
Public methodEncryptedKeyIdentifierClause(Byte[], String)Initializes a new instance of the EncryptedKeyIdentifierClause class using the specified key that is encrypted and the cryptographic algorithm used to encrypt the key.
Public methodEncryptedKeyIdentifierClause(Byte[], String, SecurityKeyIdentifier)Initializes a new instance of the EncryptedKeyIdentifierClause class using the specified key that is encrypted, the cryptographic algorithm used to encrypt the key, and a key identifier for the encrypting key.
Public methodEncryptedKeyIdentifierClause(Byte[], String, SecurityKeyIdentifier, String)Initializes a new instance of the EncryptedKeyIdentifierClause class using the specified key that is encrypted, the cryptographic algorithm used to encrypt the key, a key identifier for the encrypting key and a user-readable name.
Public methodEncryptedKeyIdentifierClause(Byte[], String, SecurityKeyIdentifier, String, Byte[], Int32)Initializes a new instance of the EncryptedKeyIdentifierClause class using the specified key that is encrypted, the cryptographic algorithm used to encrypt the key, a key identifier for the key and a user-readable name.
Top

  NameDescription
Public propertyCanCreateKeyGets a value that indicates whether a key can be created. (Inherited from SecurityKeyIdentifierClause.)
Public propertyCarriedKeyNameGets a user-readable name that is associated with the encrypted key.
Public propertyClauseTypeGets the key identifier clause type. (Inherited from SecurityKeyIdentifierClause.)
Public propertyDerivationLengthGets the size of the derived key. (Inherited from SecurityKeyIdentifierClause.)
Public propertyEncryptingKeyIdentifierGets a key identifier for the encrypting key.
Public propertyEncryptionMethodGets the cryptographic algorithm that is used to encrypt the key.
Top

  NameDescription
Public methodCreateKeyCreates a key based on the parameters passed into the constructor. (Inherited from SecurityKeyIdentifierClause.)
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 methodGetBufferGets the binary data that represents the key identifier. (Inherited from BinaryKeyIdentifierClause.)
Public methodGetDerivationNonceGets the nonce that was used to generate the derived key. (Inherited from SecurityKeyIdentifierClause.)
Public methodGetEncryptedKeyGets the encrypted key.
Public methodGetHashCodeServes as a hash function for a particular type. (Inherited from Object.)
Protected methodGetRawBufferGets the binary data that represents the key identifier. (Inherited from BinaryKeyIdentifierClause.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Public methodMatches(Byte[])Returns a value that indicates whether the binary data for the current instance matches the specified binary data. (Inherited from BinaryKeyIdentifierClause.)
Public methodMatches(SecurityKeyIdentifierClause)Returns a value that indicates whether the key identifier for this instance is equivalent to the specified key identifier clause. (Overrides BinaryKeyIdentifierClause.Matches(SecurityKeyIdentifierClause).)
Public methodMatches(Byte[], Int32)Returns a value that indicates whether the binary data for the current instance is equivalent to the specified binary data at the specified offset. (Inherited from BinaryKeyIdentifierClause.)
Public methodMatches(Byte[], String, String)Returns a value that indicates whether the key identifier for this instance is equivalent to the specified encrypted key, encryption method and user-readable name.
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodToStringReturns a string that represents the current object. (Overrides Object.ToString().)
Top

Typically, the EncryptedKeyIdentifierClause does not need to be used, other than when a custom security token service is created. When a security token service returns a security token, the issued security token contains references to attached and unattached security tokens. Attached references refer to security tokens that are contained within the security header of a SOAP message and unattached references are security tokens that are not included within the security header of a SOAP message. These references typically affirm the authenticity of the issued security token. Use the EncryptedKeyIdentifierClause class to reference an encrypted key. The GetEncryptedKey method returns the encrypted key.

accepts wrapped keys that are well formed with respect to the wire format. The key wrap algorithm specified on the wire is accepted and used. It is not verified to be compatible with the SecurityAlgorithmSuite specified by the endpoint.

.NET Framework

Supported in: 4, 3.5, 3.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 7, Windows Vista SP1 or later, Windows XP SP3, 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.

Community Additions

ADD
Show:
© 2015 Microsoft