File: KeyManagement\Internal\CacheableKeyRing.cs
Web Access
Project: src\src\DataProtection\DataProtection\src\Microsoft.AspNetCore.DataProtection.csproj (Microsoft.AspNetCore.DataProtection)
// Licensed to the .NET Foundation under one or more agreements.
// The .NET Foundation licenses this file to you under the MIT license.
 
using System;
using System.Collections.Generic;
using System.Diagnostics.CodeAnalysis;
using System.Threading;
 
namespace Microsoft.AspNetCore.DataProtection.KeyManagement.Internal;
 
/// <summary>
/// Wraps both a keyring and its expiration policy.
/// </summary>
public sealed class CacheableKeyRing
{
    private readonly CancellationToken _expirationToken;
 
    internal CacheableKeyRing(CancellationToken expirationToken, DateTimeOffset expirationTime, IKey defaultKey, IEnumerable<IKey> allKeys)
        : this(expirationToken, expirationTime, keyRing: new KeyRing(defaultKey, allKeys))
    {
    }
 
    internal CacheableKeyRing(CancellationToken expirationToken, DateTimeOffset expirationTime, IKeyRing keyRing)
    {
        _expirationToken = expirationToken;
        ExpirationTimeUtc = expirationTime.UtcDateTime;
        KeyRing = keyRing;
    }
 
    internal DateTime ExpirationTimeUtc { get; }
 
    internal IKeyRing KeyRing { get; }
 
    internal static bool IsValid([NotNullWhen(true)] CacheableKeyRing? keyRing, DateTime utcNow)
    {
        return keyRing != null
            && !keyRing._expirationToken.IsCancellationRequested
            && keyRing.ExpirationTimeUtc > utcNow;
    }
 
    /// <summary>
    /// Returns a new <see cref="CacheableKeyRing"/> which is identical to 'this' but with a
    /// lifetime extended 2 minutes from <paramref name="now"/>. The inner cancellation token
    /// is also disconnected.
    /// </summary>
    internal CacheableKeyRing WithTemporaryExtendedLifetime(DateTimeOffset now)
    {
        var extension = TimeSpan.FromMinutes(2);
        return new CacheableKeyRing(CancellationToken.None, now + extension, KeyRing);
    }
}