X509SecurityTokenHandler Class

.NET Framework (current version)
 

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.

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

System::Object
  System.IdentityModel.Tokens::SecurityTokenHandler
    System.IdentityModel.Tokens::X509SecurityTokenHandler

public ref class X509SecurityTokenHandler : SecurityTokenHandler

NameDescription
System_CAPS_pubmethodX509SecurityTokenHandler()

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

System_CAPS_pubmethodX509SecurityTokenHandler(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.

System_CAPS_pubmethodX509SecurityTokenHandler(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.

System_CAPS_pubmethodX509SecurityTokenHandler(X509CertificateValidator^)

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

NameDescription
System_CAPS_pubpropertyCanValidateToken

Gets a value that indicates whether this handler supports validation of tokens of type X509SecurityToken.(Overrides SecurityTokenHandler::CanValidateToken.)

System_CAPS_pubpropertyCanWriteToken

Gets a value that indicates whether this handler can write tokens of type X509SecurityToken.(Overrides SecurityTokenHandler::CanWriteToken.)

System_CAPS_pubpropertyCertificateValidator

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

System_CAPS_pubpropertyConfiguration

Gets or sets the SecurityTokenHandlerConfiguration object that provides configuration for the current instance.(Inherited from SecurityTokenHandler.)

System_CAPS_pubpropertyContainingCollection

Gets the token handler collection that contains the current instance.(Inherited from SecurityTokenHandler.)

System_CAPS_pubpropertyMapToWindows

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

System_CAPS_pubpropertyTokenType

Gets the Type of the tokens that this handler processes.(Overrides SecurityTokenHandler::TokenType.)

System_CAPS_pubpropertyWriteXmlDSigDefinedClauseTypes

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

System_CAPS_pubpropertyX509NTAuthChainTrustValidator

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.

NameDescription
System_CAPS_pubmethodCanReadKeyIdentifierClause(XmlReader^)

Returns a value that indicates whether the specified reader is referring to an <ds:X509Data> element.(Overrides SecurityTokenHandler::CanReadKeyIdentifierClause(XmlReader^).)

System_CAPS_pubmethodCanReadToken(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.)

System_CAPS_pubmethodCanReadToken(XmlReader^)

Returns a value that indicates whether the reader points to an X.509 security token as defined in the WS-Security specification.(Overrides SecurityTokenHandler::CanReadToken(XmlReader^).)

System_CAPS_pubmethodCanWriteKeyIdentifierClause(SecurityKeyIdentifierClause^)

Returns a value that indicates whether the specified key identifier clause can be serialized by this handler.(Overrides SecurityTokenHandler::CanWriteKeyIdentifierClause(SecurityKeyIdentifierClause^).)

System_CAPS_pubmethodCreateSecurityTokenReference(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.)

System_CAPS_pubmethodCreateToken(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.)

System_CAPS_protmethodDetectReplayedToken(SecurityToken^)

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

System_CAPS_pubmethodEquals(Object^)

Determines whether the specified object is equal to the current object.(Inherited from Object.)

System_CAPS_protmethodFinalize()

Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.(Inherited from Object.)

System_CAPS_pubmethodGetHashCode()

Serves as the default hash function. (Inherited from Object.)

System_CAPS_pubmethodGetTokenTypeIdentifiers()

Gets the X.509 security token type defined in the WS-Security X.509 Token Profile.(Overrides SecurityTokenHandler::GetTokenTypeIdentifiers().)

System_CAPS_pubmethodGetType()

Gets the Type of the current instance.(Inherited from Object.)

System_CAPS_pubmethodLoadCustomConfiguration(XmlNodeList^)

Loads custom configuration from XML.(Overrides SecurityTokenHandler::LoadCustomConfiguration(XmlNodeList^).)

System_CAPS_protmethodMemberwiseClone()

Creates a shallow copy of the current Object.(Inherited from Object.)

System_CAPS_pubmethodReadKeyIdentifierClause(XmlReader^)

Deserializes a key identifier clause referenced by the specified XML reader.(Overrides SecurityTokenHandler::ReadKeyIdentifierClause(XmlReader^).)

System_CAPS_pubmethodReadToken(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.)

System_CAPS_pubmethodReadToken(XmlReader^)

Deserializes the X.509 security token referenced by the specified XML reader.(Overrides SecurityTokenHandler::ReadToken(XmlReader^).)

System_CAPS_pubmethodReadToken(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.)

System_CAPS_pubmethodToString()

Returns a string that represents the current object.(Inherited from Object.)

System_CAPS_protmethodTraceTokenValidationFailure(SecurityToken^, String^)

Traces the failure event during the validation of security tokens when tracing is enabled.(Inherited from SecurityTokenHandler.)

System_CAPS_protmethodTraceTokenValidationSuccess(SecurityToken^)

Traces the successful validation of security tokens event when tracing is enabled.(Inherited from SecurityTokenHandler.)

System_CAPS_pubmethodValidateToken(SecurityToken^)

Validates the specified X.509 security token.(Overrides SecurityTokenHandler::ValidateToken(SecurityToken^).)

System_CAPS_pubmethodWriteKeyIdentifierClause(XmlWriter^, SecurityKeyIdentifierClause^)

Serializes the specified key identifier clause to the XML writer.(Overrides SecurityTokenHandler::WriteKeyIdentifierClause(XmlWriter^, SecurityKeyIdentifierClause^).)

System_CAPS_pubmethodWriteToken(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.)

System_CAPS_pubmethodWriteToken(XmlWriter^, SecurityToken^)

Serializes the specified X.509 security token to the specified XML writer.(Overrides SecurityTokenHandler::WriteToken(XmlWriter^, SecurityToken^).)

.NET Framework
Available since 4.5

Any public static ( Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Return to top
Show: