Export (0) Print
Expand All

SecurityToken.ValidTo Property

Gets the last instant in time at which this security token is valid.

Namespace:  System.IdentityModel.Tokens
Assembly:  System.IdentityModel (in System.IdentityModel.dll)

public abstract DateTime ValidTo { get; }

Property Value

Type: System.DateTime
A DateTime that represents the last instant in time at which this security token is valid.

Use the ValidFrom and ValidTo properties to determine the time period in which a SecurityToken token is valid. The ValidFrom and ValidTo properties represent the first and last instants in time in which the security token is valid, respectively.

Notes to Inheritors

You must override the ValidTo property.

The code examples that are used in the SecurityToken topics are taken from the Custom Token sample. This sample provides custom classes that enable processing of Simple Web Tokens (SWT). It includes an implementation of a SimpleWebToken class and a SimpleWebTokenHandler class, as well as other classes that support SWT tokens. For information about this sample and other samples available for WIF and about where to download them, see WIF Code Sample Index. The following code shows the override of the ValidTo property.

/// <summary> 
/// Defines the set of constants for the Simple Web Token. 
/// </summary> 
public static class SimpleWebTokenConstants
    public const string Audience = "Audience";
    public const string ExpiresOn = "ExpiresOn";
    public const string Id = "Id";
    public const string Issuer = "Issuer";
    public const string Signature = "HMACSHA256";
    public const string ValidFrom = "ValidFrom";
    public const string ValueTypeUri = "http://schemas.xmlsoap.org/ws/2009/11/swt-token-profile-1.0";     


public static DateTime SwtBaseTime = new DateTime( 1970, 1, 1, 0, 0, 0, 0 ); // per SWT psec

NameValueCollection _properties;


/// <summary> 
/// Gets the time when the token expires. 
/// </summary> 
/// <value>The time upto which the token is valid.</value> 
public override DateTime ValidTo
        string expiryTime = _properties[SimpleWebTokenConstants.ExpiresOn];
        return GetTimeAsDateTime( String.IsNullOrEmpty( expiryTime ) ? "0" : expiryTime );


/// <summary> 
/// Convert the time in seconds to a <see cref="DateTime"/> object based on the base time 
/// defined by the Simple Web Token. 
/// </summary> 
/// <param name="expiryTime">The time in seconds.</param>
/// <returns>The time as a <see cref="DateTime"/> object.</returns>
protected virtual DateTime GetTimeAsDateTime( string expiryTime )
    long totalSeconds = 0;
    if ( !long.TryParse( expiryTime, out totalSeconds ) )
        throw new SecurityTokenException("Invalid expiry time. Expected the time to be in seconds passed from 1 January 1970.");

    long maxSeconds = (long)( DateTime.MaxValue - SwtBaseTime ).TotalSeconds - 1;
    if ( totalSeconds > maxSeconds )
        totalSeconds = maxSeconds;

    return SwtBaseTime.AddSeconds( totalSeconds );

.NET Framework

Supported in: 4.5.2, 4.5.1, 4.5, 4, 3.5, 3.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

© 2014 Microsoft