ServiceModelSecurityTokenRequirement Class

 
System_CAPS_noteNote

The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience.

An abstract class that when implemented specifies security property requirements of the token being requested or authenticated that are specific to Windows Communication Foundation (WCF). The security token manager constructs security token providers and security token authenticators that are used by the WCF security processor based on the token requirement.

Namespace:   System.ServiceModel.Security.Tokens
Assembly:  System.ServiceModel (in System.ServiceModel.dll)


public abstract class ServiceModelSecurityTokenRequirement : SecurityTokenRequirement

NameDescription
System_CAPS_protmethodServiceModelSecurityTokenRequirement()

Initializes a new instance of the ServiceModelSecurityTokenRequirement class.

NameDescription
System_CAPS_pubpropertySystem_CAPS_staticAuditLogLocationProperty

Gets the token requirement property name whose value is the location of the audit log to use when recording the results of the authentication (service only).

System_CAPS_pubpropertySystem_CAPS_staticChannelParametersCollectionProperty

Gets the token requirement property name whose value is the channel parameters collection (client only).

System_CAPS_pubpropertySystem_CAPS_staticDuplexClientLocalAddressProperty

Gets a value that specifies the name of the index in the Properties collection for the DuplexClientLocalAddress property.

System_CAPS_pubpropertySystem_CAPS_staticEndpointFilterTableProperty

Gets the key for the token requirement property whose value is the endpoint filter table that contains the filters for messages that a service endpoint accepts. This is a service property.

System_CAPS_pubpropertySystem_CAPS_staticExtendedProtectionPolicy

Gets the protection policy used by the server to validate incoming client connections.

System_CAPS_pubpropertySystem_CAPS_staticHttpAuthenticationSchemeProperty

Gets the key of the token requirement property whose value is the HTTP authentication scheme if this request is for a token provider or token authenticator to be used in HTTP authentication.

System_CAPS_pubpropertyIsInitiator

Gets a value that indicates whether the endpoint that is creating the security token requirement is an initiator or a recipient.

System_CAPS_pubpropertySystem_CAPS_staticIsInitiatorProperty

Gets the key for the token requirement property whose value indicates whether the request is made by the initiator of the channel or the recipient of the channel.

System_CAPS_pubpropertySystem_CAPS_staticIsOutOfBandTokenProperty

Gets the key for the token requirement property whose value indicates whether this is the request for a token that is configured on the client or service.

System_CAPS_pubpropertySystem_CAPS_staticIssuedSecurityTokenParametersProperty

Gets the key for the token requirement property whose value is the IssuedSecurityTokenParameters that contains information about the token if the requirement is for an issued token.

System_CAPS_pubpropertyIssuerAddress

If the token requirement is for an issued token, this property contains the endpoint address of the issuer.

System_CAPS_pubpropertySystem_CAPS_staticIssuerAddressProperty

Gets the key for the token requirement property whose value is the EndpointAddress of the issuing party if the requirement is for an issued token.

System_CAPS_pubpropertyIssuerBinding

If the token requirement is for an issued token, this property contains the binding to use to communicate with the issuer.

System_CAPS_pubpropertySystem_CAPS_staticIssuerBindingContextProperty

Gets the key for the token requirement property whose value is the BindingContext to use to talk to the issuing party if the requirement is for an issued token.

System_CAPS_pubpropertySystem_CAPS_staticIssuerBindingProperty

Gets the key for the token requirement property whose value is the binding to use to talk to the issuing party when the requirement is for an issued token.

System_CAPS_pubpropertyKeySize

Gets or sets the required size of the key associated with a security token.(Inherited from SecurityTokenRequirement.)

System_CAPS_pubpropertyKeyType

Gets or sets the type of key (asymmetric or symmetric) associated with a security token.(Inherited from SecurityTokenRequirement.)

System_CAPS_pubpropertyKeyUsage

Gets or sets a value that specifies how the key associated with a security token can be used.(Inherited from SecurityTokenRequirement.)

System_CAPS_pubpropertySystem_CAPS_staticListenUriProperty

Gets the key for the token requirement property whose value is the URI that the service endpoint making the request is listening at (service only).

System_CAPS_pubpropertySystem_CAPS_staticMessageAuthenticationAuditLevelProperty

Gets the key for the token requirement property whose value is the audit level to use when recording the results of the authentication (service only).

System_CAPS_pubpropertySystem_CAPS_staticMessageDirectionProperty

Gets the key for the token requirement property whose value is the member of the MessageDirection enumeration to use and that indicates whether the token provider is needed for messages sent from client to server or server to client.

System_CAPS_pubpropertyMessageSecurityVersion

Gets or sets the message security version to be used (if necessary).

System_CAPS_pubpropertySystem_CAPS_staticMessageSecurityVersionProperty

Gets the key for the token requirement property whose value is the MessageVersion that the channel is configured with.

System_CAPS_pubpropertySystem_CAPS_staticPreferSslCertificateAuthenticatorProperty

Gets the key for the token requirement property whose value is used to create SSL security token authenticator.

System_CAPS_pubpropertySystem_CAPS_staticPrivacyNoticeUriProperty

Gets the key for the token requirement property whose value is the link to the URI that points to the service's privacy policy if the service has one.

System_CAPS_pubpropertySystem_CAPS_staticPrivacyNoticeVersionProperty

Gets the key for the token requirement property whose value is a string that represents the privacy notice version.

System_CAPS_pubpropertyProperties

Gets a collection of the non-static properties for the current SecurityTokenRequirement instance.(Inherited from SecurityTokenRequirement.)

System_CAPS_pubpropertyRequireCryptographicToken

Gets or sets a value that indicates whether the security token must be capable of performing cryptographic operations, such as encryption.(Inherited from SecurityTokenRequirement.)

System_CAPS_pubpropertySecureConversationSecurityBindingElement

Gets or sets a security binding element used for securing the secure conversation bootstrap messages.

System_CAPS_pubpropertySystem_CAPS_staticSecureConversationSecurityBindingElementProperty

Gets the key for the token requirement property whose value is the security binding element used to secure the secure conversation bootstrap messages.

System_CAPS_pubpropertySecurityAlgorithmSuite

Gets or sets the security algorithm suite to be used (if necessary).

System_CAPS_pubpropertySystem_CAPS_staticSecurityAlgorithmSuiteProperty

Gets the key for the token requirement property whose value is the algorithm suite that the channel uses to perform message security.

System_CAPS_pubpropertySecurityBindingElement

Gets or sets the security binding element.

System_CAPS_pubpropertySystem_CAPS_staticSecurityBindingElementProperty

Gets the key for the token requirement property whose value is the security binding element used to create the channel.

System_CAPS_pubpropertySystem_CAPS_staticSupportingTokenAttachmentModeProperty

Gets the key for the token requirement property whose value is the associated SecurityTokenAttachmentMode enumeration member if the request is for a supporting token.

System_CAPS_pubpropertySystem_CAPS_staticSupportSecurityContextCancellationProperty

Gets the key for the token requirement property whose value indicates whether the secure conversation token is for a security session (in which case its lifetime is tied to the lifetime of the user’s channel) or for a datagram security channel.

System_CAPS_pubpropertySystem_CAPS_staticSuppressAuditFailureProperty

Gets the key for the token requirement property whose value indicates whether to ignore errors that occur when recording the results of the authentication (service only).

System_CAPS_pubpropertySystem_CAPS_staticTargetAddressProperty

Gets the key for the token requirement property whose value is the endpoint address that the channel is talking to (client only).

System_CAPS_pubpropertyTokenType

Gets or sets the required security token type.(Inherited from SecurityTokenRequirement.)

System_CAPS_pubpropertyTransportScheme

Gets or sets the transport scheme.

System_CAPS_pubpropertySystem_CAPS_staticTransportSchemeProperty

If the request is made for a token provider/authenticator to be used with transport security, this string is the key for the token requirement property whose value is the transport scheme.

System_CAPS_pubpropertySystem_CAPS_staticViaProperty

Gets the key for the token requirement property whose value is the Via URI that the channel is connecting to (client only).

NameDescription
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_pubmethodGetProperty<TValue>(String)

Gets the specified property for the current SecurityTokenRequirement instance.(Inherited from SecurityTokenRequirement.)

System_CAPS_pubmethodGetType()

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

System_CAPS_protmethodMemberwiseClone()

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

System_CAPS_pubmethodToString()

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

System_CAPS_pubmethodTryGetProperty<TValue>(String, TValue)

Gets the specified property for the current SecurityTokenRequirement instance.(Inherited from SecurityTokenRequirement.)

NameDescription
System_CAPS_protfieldSystem_CAPS_staticNamespace

Specifies the current namespace.

A security token is a cryptographically signed data unit that transfers authentication and authorization information, based on a credential. The derived class is used by a security token manager to specify what is required of a security token, such as the key size, key type, and how the key can be used. When a security token can be identified that matches the specified criteria, a SecurityTokenProvider and SecurityTokenAuthenticator can be created to provide security tokens for outgoing SOAP messages and to authenticate security tokens for incoming SOAP messages, respectively. For example, the default security token manager for outgoing SOAP messages has the CreateSecurityTokenProvider method that takes a SecurityTokenRequirement parameter that can be called to obtain a security token provider that matches the security token provider.

This class's base class, SecurityTokenRequirement, contains a dictionary, Properties, which maps property names to their values. This class has numerous properties whose name ends in the word "Property". These properties return a string, which is the key used to get or set the corresponding value from the dictionary. For example, AuditLogLocationProperty is the key for the value of the AuditLogLocation property.

.NET Framework
Available since 3.0

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: