X509SecurityTokenHandler X509SecurityTokenHandler X509SecurityTokenHandler X509SecurityTokenHandler Class

Definition

Represents a security token handler that processes tokens of type X509SecurityToken. By default, the handler will perform chain-trust validation of the X.509 certificate.

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

Constructors

X509SecurityTokenHandler() X509SecurityTokenHandler() X509SecurityTokenHandler() X509SecurityTokenHandler()

Initializes a new instance of the X509SecurityTokenHandler class with default values.

X509SecurityTokenHandler(Boolean) X509SecurityTokenHandler(Boolean) X509SecurityTokenHandler(Boolean) X509SecurityTokenHandler(Boolean)

Initializes a new instance of the X509SecurityTokenHandler class by using a value that indicates whether the certificate should be mapped to a Windows account.

X509SecurityTokenHandler(Boolean, X509CertificateValidator) X509SecurityTokenHandler(Boolean, X509CertificateValidator) X509SecurityTokenHandler(Boolean, X509CertificateValidator) X509SecurityTokenHandler(Boolean, X509CertificateValidator)

Initializes a new instance of the X509SecurityTokenHandler class by using a value that indicates whether the certificate should be mapped to a Windows account and the specified certificate validator.

X509SecurityTokenHandler(X509CertificateValidator) X509SecurityTokenHandler(X509CertificateValidator) X509SecurityTokenHandler(X509CertificateValidator) X509SecurityTokenHandler(X509CertificateValidator)

Initializes a new instance of the X509SecurityTokenHandler class by using the specified certificate validator.

Properties

CanValidateToken CanValidateToken CanValidateToken CanValidateToken

Gets a value that indicates whether this handler supports validation of tokens of type X509SecurityToken.

CanWriteToken CanWriteToken CanWriteToken CanWriteToken

Gets a value that indicates whether this handler can write tokens of type X509SecurityToken.

CertificateValidator CertificateValidator CertificateValidator CertificateValidator

Gets or sets the X509CertificateValidator that is used by the current instance.

Configuration Configuration Configuration Configuration

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

(Inherited from SecurityTokenHandler)
ContainingCollection ContainingCollection ContainingCollection ContainingCollection

Gets the token handler collection that contains the current instance.

(Inherited from SecurityTokenHandler)
MapToWindows MapToWindows MapToWindows MapToWindows

Gets or sets a value that indicates whether the validating token should be mapped to a Windows account.

TokenType TokenType TokenType TokenType

Gets the Type of the tokens that this handler processes.

WriteXmlDSigDefinedClauseTypes WriteXmlDSigDefinedClauseTypes WriteXmlDSigDefinedClauseTypes WriteXmlDSigDefinedClauseTypes

Gets or Sets the value that specifies whether XmlDsig-defined clause types are preferred.

X509NTAuthChainTrustValidator X509NTAuthChainTrustValidator X509NTAuthChainTrustValidator X509NTAuthChainTrustValidator

Gets or sets the X509NTAuthChainTrustValidator that is used by the current instance during certificate validation when the incoming X.509 certificate is mapped to a Windows account.

Methods

CanReadKeyIdentifierClause(XmlReader) CanReadKeyIdentifierClause(XmlReader) CanReadKeyIdentifierClause(XmlReader) CanReadKeyIdentifierClause(XmlReader)

Returns a value that indicates whether the specified reader is referring to an <ds:X509Data> element.

CanReadToken(String) CanReadToken(String) CanReadToken(String) 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) CanReadToken(XmlReader) CanReadToken(XmlReader) CanReadToken(XmlReader)

Returns a value that indicates whether the reader points to an X.509 security token as defined in the WS-Security specification.

CanWriteKeyIdentifierClause(SecurityKeyIdentifierClause) CanWriteKeyIdentifierClause(SecurityKeyIdentifierClause) CanWriteKeyIdentifierClause(SecurityKeyIdentifierClause) CanWriteKeyIdentifierClause(SecurityKeyIdentifierClause)

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

CreateSecurityTokenReference(SecurityToken, Boolean) CreateSecurityTokenReference(SecurityToken, Boolean) CreateSecurityTokenReference(SecurityToken, Boolean) 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) CreateToken(SecurityTokenDescriptor) CreateToken(SecurityTokenDescriptor) 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) DetectReplayedToken(SecurityToken) DetectReplayedToken(SecurityToken) 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) Equals(Object) Equals(Object) Equals(Object)

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

(Inherited from Object)
GetHashCode() GetHashCode() GetHashCode() GetHashCode()

Serves as the default hash function.

(Inherited from Object)
GetTokenTypeIdentifiers() GetTokenTypeIdentifiers() GetTokenTypeIdentifiers() GetTokenTypeIdentifiers()

Gets the X.509 security token type defined in the WS-Security X.509 Token Profile.

GetType() GetType() GetType() GetType()

Gets the Type of the current instance.

(Inherited from Object)
LoadCustomConfiguration(XmlNodeList) LoadCustomConfiguration(XmlNodeList) LoadCustomConfiguration(XmlNodeList) LoadCustomConfiguration(XmlNodeList)

Loads custom configuration from XML.

MemberwiseClone() MemberwiseClone() MemberwiseClone() MemberwiseClone()

Creates a shallow copy of the current Object.

(Inherited from Object)
ReadKeyIdentifierClause(XmlReader) ReadKeyIdentifierClause(XmlReader) ReadKeyIdentifierClause(XmlReader) ReadKeyIdentifierClause(XmlReader)

Deserializes a key identifier clause referenced by the specified XML reader.

ReadToken(String) ReadToken(String) ReadToken(String) 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) ReadToken(XmlReader) ReadToken(XmlReader) ReadToken(XmlReader)

Deserializes the X.509 security token referenced by the specified XML reader.

ReadToken(XmlReader, SecurityTokenResolver) ReadToken(XmlReader, SecurityTokenResolver) ReadToken(XmlReader, SecurityTokenResolver) 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() ToString() ToString() ToString()

Returns a string that represents the current object.

(Inherited from Object)
TraceTokenValidationFailure(SecurityToken, String) TraceTokenValidationFailure(SecurityToken, String) TraceTokenValidationFailure(SecurityToken, String) TraceTokenValidationFailure(SecurityToken, String)

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

(Inherited from SecurityTokenHandler)
TraceTokenValidationSuccess(SecurityToken) TraceTokenValidationSuccess(SecurityToken) TraceTokenValidationSuccess(SecurityToken) TraceTokenValidationSuccess(SecurityToken)

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

(Inherited from SecurityTokenHandler)
ValidateToken(SecurityToken) ValidateToken(SecurityToken) ValidateToken(SecurityToken) ValidateToken(SecurityToken)

Validates the specified X.509 security token.

WriteKeyIdentifierClause(XmlWriter, SecurityKeyIdentifierClause) WriteKeyIdentifierClause(XmlWriter, SecurityKeyIdentifierClause) WriteKeyIdentifierClause(XmlWriter, SecurityKeyIdentifierClause) WriteKeyIdentifierClause(XmlWriter, SecurityKeyIdentifierClause)

Serializes the specified key identifier clause to the XML writer.

WriteToken(SecurityToken) WriteToken(SecurityToken) WriteToken(SecurityToken) 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) WriteToken(XmlWriter, SecurityToken) WriteToken(XmlWriter, SecurityToken) WriteToken(XmlWriter, SecurityToken)

Serializes the specified X.509 security token to the specified XML writer.

Applies to

See also