SecurityTokenServiceConfiguration Class

Article
10/05/2012

[Starting with the .NET Framework 4.5, Windows Identity Foundation (WIF) has been fully integrated into the .NET Framework. The version of WIF addressed by this topic, WIF 3.5, is deprecated and should only be used when developing against the .NET Framework 3.5 SP1 or the .NET Framework 4. For more information about WIF in the .NET Framework 4.5, also known as WIF 4.5, see the Windows Identity Foundation documentation in the .NET Framework 4.5 Development Guide.]

Defines the configuration specific to a security token service (STS).

Namespace: Microsoft.IdentityModel.Configuration
Assembly: Microsoft.IdentityModel (in Microsoft.IdentityModel.dll)

Usage

'Usage
Dim instance As SecurityTokenServiceConfiguration

Syntax

'Declaration
Public Class SecurityTokenServiceConfiguration
    Inherits ServiceConfiguration

public class SecurityTokenServiceConfiguration : ServiceConfiguration

public ref class SecurityTokenServiceConfiguration : public ServiceConfiguration

public class SecurityTokenServiceConfiguration extends ServiceConfiguration

public class SecurityTokenServiceConfiguration extends ServiceConfiguration

Remarks

Security token service configuration class derives from Service Configuration class, which is the base class that contains several properties such as Issuer Name, which is the name of the STS, Signing Credentials, that is the certificate used for signing the token before delivering it to relying party applications.

Security token service configuration defines the following settings that pertain to a security token service:

_defaultTokenLifetime
Type: TimeSpan Description: Defines the token life time. Default value is 10 hours.

_maximumTokenLifetime
Type: TimeSpan Description: Defines the maximum life time of a token issued by the STS. Default is 1 day.

_defaultTokenType
Type: string Description: Defines the type of tokens issued by the STS. WIF has built-in support for SAML 1.1 and SAML 2 tokens. Default token type is set to SAML 1.1.

_defaultSymmetricKeySizeInBits
Type: int Description: Defines the default symmetric key size, in bits. Default value is 256.

_defaultMaxSymmetricKeySizeInBits
Type: int Description: Defines the default maximum symmetric key size, in bits. Default value is 1024.

_endpoints
Type: Collection<ServiceHostEndpointConfiguration> Description: Collection of service host endpoints.

_securityTokenServiceType
Type: Type Description: Defines the type of service, this property must be set to the type of Security Token Service. Or else an ThrowHelperArgument exception is thrown with a message that type of Security Token Service is expected.

_tokenElementRequirement
Type: SecurityTokenRequirement Description: Defines the current token requirements.

_tokenElementHandlers Type: SecurityTokenHandlerCollection Description: Defines the collection of security token handlers.

_tokenElementSerializer
Type: SecurityTokenSerializer Description: Defines the security token serializer that can read and write key identifiers, key identifier clauses, and security tokens.

_tokenElementResolver
Type: SecurityTokenResolver Description: Defines the security token resolver, which is a utility class that can retrieve security tokens or keys when you have a key identifier.

_wsTrust13RequestSerializer
Type: WSTrust13RequestSerializer Description: Defines the WS-Trust 1.3 Request (RST) Serializer.

_wsTrust13ResponseSerializer
Type: WSTrust13ResponseSerializer Description: Defines the WS-Trust 1.3 Response (RSTR) Serializer.

_wsTrustFeb2005RequestSerializer
Type: WSTrustFeb2005RequestSerializer Description: Instance of the early version of WS-Trust protocol request serializer (WS-Trust Feb 2005).

_wsTrustFeb2005ResponseSerializer
Type: WSTrustFeb2005ResponseSerializer Description: Instance of the early version WS-Trust protocol response serializer.

Inheritance Hierarchy

System.Object
Microsoft.IdentityModel.Configuration.ServiceConfiguration
Microsoft.IdentityModel.Configuration.SecurityTokenServiceConfiguration

Thread Safety

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

Platforms

Target Platforms

Windows 7, Windows Server 2008 R2, Windows Vista SP2, Windows Server 2008 SP2, Windows Server 2003 SP2 (32-bit or 64-bit)