This topic has not yet been rated - Rate this topic

SecurityTokenRequirement Class

Specifies security token requirements.

System.Object
  System.IdentityModel.Selectors.SecurityTokenRequirement
    System.ServiceModel.Security.Tokens.ServiceModelSecurityTokenRequirement

Namespace:  System.IdentityModel.Selectors
Assembly:  System.IdentityModel (in System.IdentityModel.dll)
public class SecurityTokenRequirement

The SecurityTokenRequirement type exposes the following members.

  Name Description
Public method SecurityTokenRequirement Initializes a new instance of the SecurityTokenRequirement class.
Top
  Name Description
Public property KeySize Gets or sets the required size of the key associated with a security token.
Public property Static member KeySizeProperty Gets a value that specifies the name of the index in the Properties collection for the KeySize property.
Public property KeyType Gets or sets the type of key (asymmetric or symmetric) associated with a security token.
Public property Static member KeyTypeProperty Gets a value that specifies the name of the index in the Properties collection for the KeyType property.
Public property KeyUsage Gets or sets a value that specifies how the key associated with a security token can be used.
Public property Static member KeyUsageProperty Gets a value that specifies the name of the index in the Properties collection for the KeyUsage property.
Public property Static member PeerAuthenticationMode Gets the name of the index in the Properties collection for a property that specifies the peer authentication method.
Public property Properties Gets a collection of the non-static properties for the current SecurityTokenRequirement instance.
Public property RequireCryptographicToken Gets or sets a value that indicates whether the security token must be capable of performing cryptographic operations, such as encryption.
Public property Static member RequireCryptographicTokenProperty Gets the name of the index in the Properties collection for the RequireCryptographicToken property.
Public property TokenType Gets or sets the required security token type.
Public property Static member TokenTypeProperty Gets a value that specifies the name of the index in the Properties collection for the TokenType property.
Top
  Name Description
Public method Equals(Object) Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Protected method Finalize Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public method GetHashCode Serves as a hash function for a particular type. (Inherited from Object.)
Public method GetProperty<TValue> Gets the specified property for the current SecurityTokenRequirement instance.
Public method GetType Gets the Type of the current instance. (Inherited from Object.)
Protected method MemberwiseClone Creates a shallow copy of the current Object. (Inherited from Object.)
Public method ToString Returns a string that represents the current object. (Inherited from Object.)
Public method TryGetProperty<TValue> Gets the specified property for the current SecurityTokenRequirement instance.
Top

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.

.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.
Did you find this helpful?
(1500 characters remaining)
Community Content Add
Annotations FAQ