EncryptedSecurityTokenHandler Class

Definition

A token handler for encrypted security tokens. Handles tokens of type EncryptedSecurityToken.

public ref class EncryptedSecurityTokenHandler : System::IdentityModel::Tokens::SecurityTokenHandler
public class EncryptedSecurityTokenHandler : System.IdentityModel.Tokens.SecurityTokenHandler
type EncryptedSecurityTokenHandler = class
    inherit SecurityTokenHandler
Public Class EncryptedSecurityTokenHandler
Inherits SecurityTokenHandler
Inheritance
EncryptedSecurityTokenHandler

Remarks

A token handler that serializes and deserializes EncryptedSecurityToken objects from <xenc:EncryptedData> elements and EncryptedKeyIdentifierClause objects from <xenc:EncryptedKey> elements as defined in the XML Encryption Syntax and Processing specification.

Constructors

EncryptedSecurityTokenHandler()

Initializes a new instance of the EncryptedSecurityTokenHandler class.

Properties

CanValidateToken

Gets a value that indicates whether the handler supports validation of security tokens.

(Inherited from SecurityTokenHandler)
CanWriteToken

Gets a value that indicates whether the handler provides serialization functionality for tokens.

Configuration

Gets or sets the SecurityTokenHandlerConfiguration object that provides configuration for the current instance.

(Inherited from SecurityTokenHandler)
ContainingCollection

Gets the token handler collection that contains the current instance.

(Inherited from SecurityTokenHandler)
KeyInfoSerializer

Gets or sets the SecurityTokenSerializer that will be used to serialize and deserialize key identifiers from the <xenc:EncryptedData> element.

TokenType

Gets the type of the token handled by the current instance.

Methods

CanReadKeyIdentifierClause(XmlReader)

Returns a value that indicates whether the current XML element is pointing to an <xenc:EncryptedKey> element that can be deserialized to a SecurityKeyIdentifierClause by this instance.

CanReadToken(String)

Returns a value that indicates whether the specified string can be deserialized as a token of the type processed by this instance.

(Inherited from SecurityTokenHandler)
CanReadToken(XmlReader)

Returns a value that indicates whether the reader is pointing to an <xenc:EncryptedData> element.

CanWriteKeyIdentifierClause(SecurityKeyIdentifierClause)

Returns a value that indicates whether the specified key identifier clause can be serialized by this instance.

(Inherited from SecurityTokenHandler)
CreateSecurityTokenReference(SecurityToken, Boolean)

When overridden in a derived class, creates the security token reference for tokens processed by that class. This method is typically called by a security token service (STS).

(Inherited from SecurityTokenHandler)
CreateToken(SecurityTokenDescriptor)

When overridden in a derived class, creates a security token using the specified token descriptor. This method is called by a security token service (STS).

(Inherited from SecurityTokenHandler)
DetectReplayedToken(SecurityToken)

When overridden in a derived class, throws an exception if the specified token is detected as being replayed.

(Inherited from SecurityTokenHandler)
Equals(Object)

Determines whether the specified object is equal to the current object.

(Inherited from Object)
GetHashCode()

Serves as the default hash function.

(Inherited from Object)
GetTokenTypeIdentifiers()

Gets the type identifier URIs for tokens handled by the current instance.

GetType()

Gets the Type of the current instance.

(Inherited from Object)
LoadCustomConfiguration(XmlNodeList)

When overridden in a derived class, loads custom configuration from XML.

(Inherited from SecurityTokenHandler)
MemberwiseClone()

Creates a shallow copy of the current Object.

(Inherited from Object)
ReadKeyIdentifierClause(XmlReader)

Reads an EncryptedKeyIdentifierClause from an XML stream.

ReadToken(String)

When overridden in a derived class, deserializes the specified string to a token of the type processed by the derived class.

(Inherited from SecurityTokenHandler)
ReadToken(XmlReader)

Reads an encrypted security token.

ReadToken(XmlReader, SecurityTokenResolver)

When overridden in a derived class, deserializes the XML referenced by the specified XML reader to a token of the type processed by the derived class by using the specified token resolver.

(Inherited from SecurityTokenHandler)
ToString()

Returns a string that represents the current object.

(Inherited from Object)
TraceTokenValidationFailure(SecurityToken, String)

Traces the failure event during the validation of security tokens when tracing is enabled.

(Inherited from SecurityTokenHandler)
TraceTokenValidationSuccess(SecurityToken)

Traces the successful validation of security tokens event when tracing is enabled.

(Inherited from SecurityTokenHandler)
ValidateToken(SecurityToken)

When overridden in a derived class, validates the specified security token. The token must be of the type processed by the derived class.

(Inherited from SecurityTokenHandler)
WriteKeyIdentifierClause(XmlWriter, SecurityKeyIdentifierClause)

When overridden in a derived class, serializes the specified key identifier clause to XML. The key identifier clause must be of the type supported by the derived class.

(Inherited from SecurityTokenHandler)
WriteToken(SecurityToken)

When overridden in a derived class, serializes the specified security token to a string. The token must be of the type processed by the derived class.

(Inherited from SecurityTokenHandler)
WriteToken(XmlWriter, SecurityToken)

Writes an encrypted security token using the XML writer.

Applies to