Export (0) Print
Expand All

ServiceModelSecurityTokenRequirement Class

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

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

public abstract class ServiceModelSecurityTokenRequirement : SecurityTokenRequirement

The ServiceModelSecurityTokenRequirement type exposes the following members.

  NameDescription
Protected methodServiceModelSecurityTokenRequirementInitializes a new instance of the ServiceModelSecurityTokenRequirement class.
Top

  NameDescription
Public propertyStatic memberAuditLogLocationPropertyGets 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).
Public propertyStatic memberChannelParametersCollectionPropertyGets the token requirement property name whose value is the channel parameters collection (client only).
Public propertyStatic memberDuplexClientLocalAddressPropertyGets a value that specifies the name of the index in the Properties collection for the DuplexClientLocalAddress property.
Public propertyStatic memberEndpointFilterTablePropertyGets 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.
Public propertyStatic memberExtendedProtectionPolicyGets the protection policy used by the server to validate incoming client connections.
Public propertyStatic memberHttpAuthenticationSchemePropertyGets 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.
Public propertyIsInitiatorGets a value that indicates whether the endpoint that is creating the security token requirement is an initiator or a recipient.
Public propertyStatic memberIsInitiatorPropertyGets 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.
Public propertyStatic memberIsOutOfBandTokenPropertyGets 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.
Public propertyStatic memberIssuedSecurityTokenParametersPropertyGets 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.
Public propertyIssuerAddressIf the token requirement is for an issued token, this property contains the endpoint address of the issuer.
Public propertyStatic memberIssuerAddressPropertyGets the key for the token requirement property whose value is the EndpointAddress of the issuing party if the requirement is for an issued token.
Public propertyIssuerBindingIf the token requirement is for an issued token, this property contains the binding to use to communicate with the issuer.
Public propertyStatic memberIssuerBindingContextPropertyGets 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.
Public propertyStatic memberIssuerBindingPropertyGets 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.
Public propertyKeySizeGets or sets the required size of the key associated with a security token. (Inherited from SecurityTokenRequirement.)
Public propertyKeyTypeGets or sets the type of key (asymmetric or symmetric) associated with a security token. (Inherited from SecurityTokenRequirement.)
Public propertyKeyUsageGets or sets a value that specifies how the key associated with a security token can be used. (Inherited from SecurityTokenRequirement.)
Public propertyStatic memberListenUriPropertyGets the key for the token requirement property whose value is the URI that the service endpoint making the request is listening at (service only).
Public propertyStatic memberMessageAuthenticationAuditLevelPropertyGets the key for the token requirement property whose value is the audit level to use when recording the results of the authentication (service only).
Public propertyStatic memberMessageDirectionPropertyGets 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.
Public propertyMessageSecurityVersionGets or sets the message security version to be used (if necessary).
Public propertyStatic memberMessageSecurityVersionPropertyGets the key for the token requirement property whose value is the MessageVersion that the channel is configured with.
Public propertyStatic memberPrivacyNoticeUriPropertyGets 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.
Public propertyStatic memberPrivacyNoticeVersionPropertyGets the key for the token requirement property whose value is a string that represents the privacy notice version.
Public propertyPropertiesGets a collection of the non-static properties for the current SecurityTokenRequirement instance. (Inherited from SecurityTokenRequirement.)
Public propertyRequireCryptographicTokenGets or sets a value that indicates whether the security token must be capable of performing cryptographic operations, such as encryption. (Inherited from SecurityTokenRequirement.)
Public propertySecureConversationSecurityBindingElementGets or sets a security binding element used for securing the secure conversation bootstrap messages.
Public propertyStatic memberSecureConversationSecurityBindingElementPropertyGets the key for the token requirement property whose value is the security binding element used to secure the secure conversation bootstrap messages.
Public propertySecurityAlgorithmSuiteGets or sets the security algorithm suite to be used (if necessary).
Public propertyStatic memberSecurityAlgorithmSuitePropertyGets the key for the token requirement property whose value is the algorithm suite that the channel uses to perform message security.
Public propertySecurityBindingElementGets or sets the security binding element.
Public propertyStatic memberSecurityBindingElementPropertyGets the key for the token requirement property whose value is the security binding element used to create the channel.
Public propertyStatic memberSupportingTokenAttachmentModePropertyGets the key for the token requirement property whose value is the associated SecurityTokenAttachmentMode enumeration member if the request is for a supporting token.
Public propertyStatic memberSupportSecurityContextCancellationPropertyGets 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.
Public propertyStatic memberSuppressAuditFailurePropertyGets 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).
Public propertyStatic memberTargetAddressPropertyGets the key for the token requirement property whose value is the endpoint address that the channel is talking to (client only).
Public propertyTokenTypeGets or sets the required security token type. (Inherited from SecurityTokenRequirement.)
Public propertyTransportSchemeGets or sets the transport scheme.
Public propertyStatic memberTransportSchemePropertyIf 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.
Public propertyStatic memberViaPropertyGets the key for the token requirement property whose value is the Via URI that the channel is connecting to (client only).
Top

  NameDescription
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 methodGetHashCodeServes as a hash function for a particular type. (Inherited from Object.)
Public methodGetProperty<TValue>Gets the specified property for the current SecurityTokenRequirement instance. (Inherited from SecurityTokenRequirement.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)
Public methodTryGetProperty<TValue>Gets the specified property for the current SecurityTokenRequirement instance. (Inherited from SecurityTokenRequirement.)
Top

  NameDescription
Protected fieldStatic memberNamespaceThe current namespace.
Top

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

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:
© 2014 Microsoft