Edit

SecurityTokenRequirement Class

  • Reference

Definition

Namespace:
System.IdentityModel.Selectors
Assembly:
System.ServiceModel.Primitives.dll
Assembly:
System.IdentityModel.dll
Package:
System.ServiceModel.Primitives v6.0.0
Package:
System.ServiceModel.Primitives v6.2.0
Package:
System.ServiceModel.Primitives v8.0.0
Source:
SecurityTokenRequirement.cs
Source:
SecurityTokenRequirement.cs
Source:
SecurityTokenRequirement.cs

Specifies security token requirements.

public ref class SecurityTokenRequirement
public class SecurityTokenRequirement
type SecurityTokenRequirement = class
Public Class SecurityTokenRequirement
Inheritance
Object
SecurityTokenRequirement
Derived

Examples

ClientCredentialsSecurityTokenManager

ServiceCredentialsSecurityTokenManager

SecurityTokenProvider

SecurityTokenAuthenticator

CreateSecurityTokenAuthenticator(SecurityTokenRequirement, SecurityTokenResolver)

CreateSecurityTokenProvider(SecurityTokenRequirement)

CreateSecurityTokenAuthenticator(SecurityTokenRequirement, SecurityTokenResolver)

CreateSecurityTokenProvider(SecurityTokenRequirement)

Remarks

Application code typically does not need to use the SecurityTokenRequirement class, unless a custom security token, security token manager, security token provider, or security token authenticator are created. The SecurityTokenRequirement 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 obtained 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(SecurityTokenRequirement) method that takes a SecurityTokenRequirement parameter that can be called to obtain a security token provider that matches the criteria specified in the security token requirement.

Constructors

SecurityTokenRequirement()

Initializes a new instance of the SecurityTokenRequirement class.

Properties

IsOptionalTokenProperty

Gets a value of the token property if it is optional.
KeySize

Gets or sets the required size of the key associated with a security token.
KeySizeProperty

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

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

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

Gets or sets a value that specifies how the key associated with a security token can be used.
KeyUsageProperty

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

Gets the name of the index in the Properties collection for a property that specifies the peer authentication method.
Properties

Gets a collection of the non-static properties for the current SecurityTokenRequirement instance.
RequireCryptographicToken

Gets or sets a value that indicates whether the security token must be capable of performing cryptographic operations, such as encryption.
RequireCryptographicTokenProperty

Gets the name of the index in the Properties collection for the RequireCryptographicToken property.
TokenType

Gets or sets the required security token type.
TokenTypeProperty

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

Methods

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

Gets the specified property for the current SecurityTokenRequirement instance.
GetType()

Gets the Type of the current instance.

(Inherited from Object)
MemberwiseClone()

Creates a shallow copy of the current Object.

(Inherited from Object)
ToString()

Returns a string that represents the current object.

(Inherited from Object)
TryGetProperty<TValue>(String, TValue)

Gets the specified property for the current SecurityTokenRequirement instance.

Applies to