replace implementation

Zonnex · Zonnex · commit 5d686363649e · 2025-03-26T15:59:17.000+01:00
diff --git a/samples/Standalone.MvcSample/Standalone.MvcSample.csproj b/samples/Standalone.MvcSample/Standalone.MvcSample.csproj
@@ -31,6 +31,6 @@
     </ItemGroup>
 
     <ItemGroup>
-        <PackageReference Include="Microsoft.ApplicationInsights.AspNetCore" Version="2.22.0" />
+        <PackageReference Include="Microsoft.ApplicationInsights.AspNetCore" Version="2.23.0" />
     </ItemGroup>
 </Project>
diff --git a/src/ActiveLogin.Authentication.BankId.AspNetCore/Areas/ActiveLogin/Controllers/BankIdUiControllerBase.cs b/src/ActiveLogin.Authentication.BankId.AspNetCore/Areas/ActiveLogin/Controllers/BankIdUiControllerBase.cs
@@ -50,7 +50,7 @@ IStateStorage stateStorage
             return default;
         }
         var stateKey = new StateKey(cookie);
-        return await stateStorage.ReadAsync(stateKey) as T;
+        return await stateStorage.GetAsync<T>(stateKey);
     }
 
     protected async Task<ActionResult> Initialize(string returnUrl, string apiControllerName, string protectedUiOptions, string viewName)
diff --git a/src/ActiveLogin.Authentication.BankId.AspNetCore/Areas/ActiveLogin/Controllers/BankIdUiSignApiController.cs b/src/ActiveLogin.Authentication.BankId.AspNetCore/Areas/ActiveLogin/Controllers/BankIdUiSignApiController.cs
@@ -115,6 +115,6 @@ public async Task<ActionResult<BankIdUiApiInitializeResponse>> Initialize(BankId
         }
 
         var stateKey = new StateKey(cookie);
-        return stateStorage.ReadAsync<BankIdUiSignState>(stateKey);
+        return stateStorage.GetAsync<BankIdUiSignState>(stateKey);
     }
 }
diff --git a/src/ActiveLogin.Authentication.BankId.AspNetCore/Auth/BankIdAuthHandler.cs b/src/ActiveLogin.Authentication.BankId.AspNetCore/Auth/BankIdAuthHandler.cs
@@ -67,7 +67,7 @@ protected override async Task<HandleRequestResult> HandleRemoteAuthenticateAsync
             return await HandleRemoteAuthenticateFail(BankIdConstants.ErrorMessages.InvalidStateCookie, detectedDevice);
         }
 
-        await DeleteStateCookie();
+        DeleteStateCookie();
 
         if (!Request.HasFormContentType)
         {
@@ -199,7 +199,7 @@ private async Task AppendStateCookie(AuthenticationProperties properties)
         }
 
         var state = new BankIdUiAuthState(properties);
-        var stateKey = await _stateStorage.WriteAsync(state);
+        var stateKey = await _stateStorage.SetAsync(state);
 
         var cookieOptions = Options.StateCookie.Build(Context, Options.TimeProvider.GetUtcNow());
         Response.Cookies.Append(Options.StateCookie.Name, stateKey, cookieOptions);
@@ -215,10 +215,10 @@ private async Task AppendStateCookie(AuthenticationProperties properties)
             return Task.FromResult<BankIdUiAuthState?>(null);
         }
 
-        return _stateStorage.ReadAsync<BankIdUiAuthState>(new(stateKey));
+        return _stateStorage.GetAsync<BankIdUiAuthState>(new(stateKey));
     }
 
-    private async Task DeleteStateCookie()
+    private void DeleteStateCookie()
     {
         Validators.ThrowIfNullOrWhitespace(Options.StateCookie.Name, BankIdConstants.AuthStateKey);
 
@@ -227,9 +227,6 @@ private async Task DeleteStateCookie()
             throw new InvalidOperationException(BankIdConstants.ErrorMessages.TimeProviderNotSet);
         }
 
-        var stateKey = Request.Cookies[Options.StateCookie.Name]!;
-        _ = await _stateStorage.RemoveAsync(new(stateKey));
-
         var cookieOptions = Options.StateCookie.Build(Context, Options.TimeProvider.GetUtcNow());
         Response.Cookies.Delete(Options.StateCookie.Name, cookieOptions);
     }
diff --git a/src/ActiveLogin.Authentication.BankId.AspNetCore/Sign/BankIdSignService.cs b/src/ActiveLogin.Authentication.BankId.AspNetCore/Sign/BankIdSignService.cs
@@ -169,13 +169,13 @@ private string GetUiInitUrl(HttpContext httpContext, string callbackPath, BankId
         }
 
         var stateKey = new StateKey(cookie);
-        return _bankIdStateStorage.RemoveAsync<BankIdUiSignState>(stateKey);
+        return _bankIdStateStorage.GetAsync<BankIdUiSignState>(stateKey);
     }
 
     private Task<StateKey> SaveState(BankIdSignProperties properties, string configKey)
     {
         var state = new BankIdUiSignState(configKey, properties);
-        return _bankIdStateStorage.WriteAsync(state);
+        return _bankIdStateStorage.SetAsync(state);
     }
 
     private void DeleteCookie(HttpContext httpContext, BankIdSignOptions options)
diff --git a/src/ActiveLogin.Authentication.BankId.AspNetCore/Sign/ServiceCollectionBankIdExtensions.cs b/src/ActiveLogin.Authentication.BankId.AspNetCore/Sign/ServiceCollectionBankIdExtensions.cs
@@ -3,6 +3,7 @@
 using ActiveLogin.Authentication.BankId.AspNetCore.DataProtection;
 using ActiveLogin.Authentication.BankId.Core;
 
+using Microsoft.Extensions.Caching.Memory;
 using Microsoft.Extensions.DependencyInjection;
 
 namespace ActiveLogin.Authentication.BankId.AspNetCore.Sign;
@@ -70,6 +71,7 @@ private static void AddBankIdAuthDefaultServices(IBankIdSignBuilder builder)
 
         BankIdCommonConfiguration.AddDefaultServices(services);
 
+        services.AddSingleton<IMemoryCache, MemoryCache>();
         services.AddSingleton<IStateStorage, InMemoryStateStorage>();
         services.AddTransient<IBankIdUiResultProtector, BankIdUiResultProtector>();
 
diff --git a/src/ActiveLogin.Authentication.BankId.AspNetCore/StateStorageExtensions.cs b/src/ActiveLogin.Authentication.BankId.AspNetCore/StateStorageExtensions.cs
@@ -5,15 +5,15 @@ namespace ActiveLogin.Authentication.BankId.AspNetCore;
 
 internal static class StateStorageExtensions
 {
-    public static Task<T?> ReadAsync<T>(this IStateStorage stateStorage, StateKey key)
-        where T : BankIdUiState
-    {
-        return stateStorage.ReadAsync(key).ContinueWith(t => t.Result as T);
-    }
+    // public static Task<T?> ReadAsync<T>(this IStateStorage stateStorage, StateKey key)
+    //     where T : BankIdUiState
+    // {
+    //     return stateStorage.GetAsync(key);
+    // }
 
-    public static Task<T?> RemoveAsync<T>(this IStateStorage stateStorage, StateKey key)
-        where T : BankIdUiState
-    {
-        return stateStorage.RemoveAsync(key).ContinueWith(t => t.Result as T);
-    }
+    // public static Task<T?> RemoveAsync<T>(this IStateStorage stateStorage, StateKey key)
+    //     where T : BankIdUiState
+    // {
+    //     return stateStorage.TryGetAsync(key);
+    // }
 }
diff --git a/src/ActiveLogin.Authentication.BankId.AzureMonitor/ActiveLogin.Authentication.BankId.AzureMonitor.csproj b/src/ActiveLogin.Authentication.BankId.AzureMonitor/ActiveLogin.Authentication.BankId.AzureMonitor.csproj
@@ -12,7 +12,7 @@
 
     <ItemGroup>
         <FrameworkReference Include="Microsoft.AspNetCore.App" />
-        <PackageReference Include="Microsoft.ApplicationInsights" Version="2.22.0" />
+        <PackageReference Include="Microsoft.ApplicationInsights" Version="2.23.0" />
     </ItemGroup>
 
     <ItemGroup>
diff --git a/src/ActiveLogin.Authentication.BankId.Core/ActiveLogin.Authentication.BankId.Core.csproj b/src/ActiveLogin.Authentication.BankId.Core/ActiveLogin.Authentication.BankId.Core.csproj
@@ -16,6 +16,7 @@
 
     <ItemGroup>
         <PackageReference Include="Microsoft.Bcl.Cryptography" Version="9.0.2" />
+        <PackageReference Include="Microsoft.Extensions.Caching.Memory" Version="9.0.2" />
         <PackageReference Include="Microsoft.Extensions.Http" Version="9.0.2" />
         <PackageReference Include="Microsoft.Extensions.Logging.Abstractions" Version="9.0.2" />
         <PackageReference Include="Microsoft.SourceLink.GitHub" Version="8.0.0" PrivateAssets="all" />
diff --git a/src/ActiveLogin.Authentication.BankId.Core/IStateStorage.cs b/src/ActiveLogin.Authentication.BankId.Core/IStateStorage.cs
@@ -1,3 +1,5 @@
+using System.Diagnostics.CodeAnalysis;
+
 using Microsoft.Extensions.DependencyInjection;
 
 namespace ActiveLogin.Authentication.BankId.Core;
@@ -9,9 +11,9 @@ public readonly record struct StateKey(string Key)
 
 public interface IStateStorage
 {
-    Task<StateKey> WriteAsync(object value);
-    Task<object?> ReadAsync(StateKey key);
-    Task<object?> RemoveAsync(StateKey key);
+    Task<T?> GetAsync<T>(StateKey key);
+    Task<bool> TryGetAsync<T>(StateKey key, [NotNullWhen(true)] out T? value);
+    Task<StateKey> SetAsync<T>(T value);
 }
 
 public static class BankIdBuilderStateStorageExtensions
diff --git a/src/ActiveLogin.Authentication.BankId.Core/InMemoryStateStorage.cs b/src/ActiveLogin.Authentication.BankId.Core/InMemoryStateStorage.cs
@@ -1,28 +1,37 @@
-using System.Collections.Concurrent;
+using System.Diagnostics.CodeAnalysis;
+
+using Microsoft.Extensions.Caching.Memory;
 
 namespace ActiveLogin.Authentication.BankId.Core;
 
-public class InMemoryStateStorage : IStateStorage
+public class InMemoryStateStorage(IMemoryCache cache, TimeSpan slidingExpiration) : IStateStorage
 {
-    private static readonly ConcurrentDictionary<string, object> _storage = new();
+    public InMemoryStateStorage(IMemoryCache cache) : this(cache, TimeSpan.FromMinutes(5)) { }
 
-    public Task<StateKey> WriteAsync(object value)
+    private readonly MemoryCacheEntryOptions _memoryCacheEntryOptions = new()
     {
-        var key = Guid.NewGuid().ToString();
-        _ = _storage.TryAdd(key, value);
-        var stateKey = new StateKey(key);
-        return Task.FromResult(stateKey);
+        SlidingExpiration = slidingExpiration
+    };
+
+    public Task<T?> GetAsync<T>(StateKey key)
+    {
+        return cache.TryGetValue(key, out T? value)
+            ? Task.FromResult(value)
+            : Task.FromResult<T?>(default);
     }
 
-    public Task<object?> RemoveAsync(StateKey key)
+    public Task<bool> TryGetAsync<T>(StateKey key, [NotNullWhen(true)] out T? value)
     {
-        _ = _storage.TryRemove(key, out var value);
-        return Task.FromResult(value);
+        return cache.TryGetValue(key, out value)
+            ? Task.FromResult(true)
+            : Task.FromResult(false);
     }
 
-    public Task<object?> ReadAsync(StateKey key)
+    public Task<StateKey> SetAsync<T>(T value)
     {
-        _ = _storage.TryGetValue(key, out var value);
-        return Task.FromResult(value);
+        var key = Guid.NewGuid().ToString();
+        var stateKey = new StateKey(key);
+        cache.Set(stateKey, value, _memoryCacheEntryOptions);
+        return Task.FromResult(stateKey);
     }
 }
diff --git a/test/ActiveLogin.Authentication.BankId.AspNetCore.Test/BankId_Ui_Tests_Base.cs b/test/ActiveLogin.Authentication.BankId.AspNetCore.Test/BankId_Ui_Tests_Base.cs
@@ -1,3 +1,4 @@
+using System;
 using System.Collections.Generic;
 using System.Linq;
 using System.Net.Http;
@@ -10,6 +11,8 @@
 using ActiveLogin.Authentication.BankId.Core;
 
 using Microsoft.AspNetCore.TestHost;
+using Microsoft.Extensions.Caching.Memory;
+using Microsoft.Extensions.Options;
 
 namespace ActiveLogin.Authentication.BankId.AspNetCore.Test;
 
@@ -134,8 +137,10 @@ protected static string GetInlineJsonValue(string html, string key)
     protected async Task<(IStateStorage, StateKey)> SetupStateStorage<T>(T state)
         where T : Models.BankIdUiState
     {
-        var stateStorage = new InMemoryStateStorage();
-        var stateKey = await stateStorage.WriteAsync(state);
+        var options = Options.Create(new MemoryCacheOptions());
+        var memoryCache = new MemoryCache(options);
+        var stateStorage = new InMemoryStateStorage(memoryCache, TimeSpan.FromMinutes(5));
+        var stateKey = await stateStorage.SetAsync(state);
         return (stateStorage, stateKey);
     }
 }
diff --git a/test/ActiveLogin.Authentication.BankId.Core.Test/InMemoryStateStorage/InMemoryStateStorage_Tests.cs b/test/ActiveLogin.Authentication.BankId.Core.Test/InMemoryStateStorage/InMemoryStateStorage_Tests.cs
@@ -0,0 +1,99 @@
+using System;
+using System.Threading.Tasks;
+
+using Microsoft.Extensions.Caching.Memory;
+using Microsoft.Extensions.Options;
+
+using Xunit;
+
+using StateStorage = ActiveLogin.Authentication.BankId.Core.InMemoryStateStorage;
+
+namespace ActiveLogin.Authentication.BankId.Core.Test.InMemoryStateStorage;
+
+record TestState<T>(int A, string B, T C);
+
+public class InMemoryStateStorageTests
+{
+    private readonly StateStorage _storage;
+
+    public InMemoryStateStorageTests()
+    {
+        var options = Options.Create(new MemoryCacheOptions());
+        var memoryCache = new MemoryCache(options);
+        _storage = new StateStorage(memoryCache, TimeSpan.FromSeconds(1));
+    }
+
+    [Fact]
+    public async Task SaveState_SimpleObject_AndGetState_ReturnsValue()
+    {
+        // Arrange
+        var value = "testState";
+
+        // Act
+        var key = await _storage.SetAsync(value);
+        var storedState = await _storage.GetAsync<string>(key);
+
+        // Assert
+        Assert.Equal(value, storedState);
+    }
+
+    [Fact]
+    public async Task SaveState_ComplexObject_AndGetState_ReturnsValue()
+    {
+        // Arrange
+        TestState<TestState<bool>> value = new(1, "test", new(2, "whatev", true));
+
+        // Act
+        var key = await _storage.SetAsync(value);
+        var storedState = await _storage.GetAsync<TestState<TestState<bool>>>(key);
+
+        // Assert
+        Assert.Equal(value, storedState);
+    }
+
+    [Fact]
+    public async Task GetStateAsync_ReturnsNull_ForNonExistingKey()
+    {
+        // Arrange
+        var key = "nonExistingKey";
+
+        // Act
+        var storedState = await _storage.GetAsync<string>(new(key));
+
+        // Assert
+        Assert.Null(storedState);
+    }
+
+    [Fact]
+    public async Task Eviction_Works()
+    {
+        const int eviction_time = 100;
+        var options = Options.Create(new MemoryCacheOptions());
+        var memoryCache = new MemoryCache(options);
+        var storage = new StateStorage(memoryCache, TimeSpan.FromMilliseconds(eviction_time));
+
+        // Arrange
+        var value = "testState";
+        var start = DateTime.Now;
+        var key = await storage.SetAsync(value);
+        if (!await storage.TryGetAsync<string>(key, out _))
+        {
+            Assert.Fail("Could not get value");
+        }
+
+        // Act
+        await Task.Delay(eviction_time);
+        while (await storage.TryGetAsync<string>(key, out _))
+        {
+            await Task.Delay(5);
+            if ((DateTime.Now - start).TotalMilliseconds > (10 * eviction_time))
+            {
+                Assert.Fail($"Eviction did not work {DateTime.Now - start}");
+            }
+        }
+
+        var time = (DateTime.Now - start).TotalMilliseconds;
+
+        Assert.True(time >= eviction_time);
+    }
+}

Original file line number	Diff line number	Diff line change
`@@ -50,7 +50,7 @@ IStateStorage stateStorage`
`50`	`50`	`return default;`
`51`	`51`	`}`
`52`	`52`	`var stateKey = new StateKey(cookie);`
`53`		`- return await stateStorage.ReadAsync(stateKey) as T;`
	`53`	`+ return await stateStorage.GetAsync<T>(stateKey);`
`54`	`54`	`}`
`55`	`55`
`56`	`56`	`protected async Task<ActionResult> Initialize(string returnUrl, string apiControllerName, string protectedUiOptions, string viewName)`
Original file line number	Diff line number	Diff line change
`@@ -115,6 +115,6 @@ public async Task<ActionResult<BankIdUiApiInitializeResponse>> Initialize(BankId`
`115`	`115`	`}`
`116`	`116`
`117`	`117`	`var stateKey = new StateKey(cookie);`
`118`		`- return stateStorage.ReadAsync<BankIdUiSignState>(stateKey);`
	`118`	`+ return stateStorage.GetAsync<BankIdUiSignState>(stateKey);`
`119`	`119`	`}`
`120`	`120`	`}`
Original file line number	Diff line number	Diff line change
`@@ -67,7 +67,7 @@ protected override async Task<HandleRequestResult> HandleRemoteAuthenticateAsync`
`67`	`67`	`return await HandleRemoteAuthenticateFail(BankIdConstants.ErrorMessages.InvalidStateCookie, detectedDevice);`
`68`	`68`	`}`
`69`	`69`
`70`		`- await DeleteStateCookie();`
	`70`	`+ DeleteStateCookie();`
`71`	`71`
`72`	`72`	`if (!Request.HasFormContentType)`
`73`	`73`	`{`
`@@ -199,7 +199,7 @@ private async Task AppendStateCookie(AuthenticationProperties properties)`
`199`	`199`	`}`
`200`	`200`
`201`	`201`	`var state = new BankIdUiAuthState(properties);`
`202`		`- var stateKey = await _stateStorage.WriteAsync(state);`
	`202`	`+ var stateKey = await _stateStorage.SetAsync(state);`
`203`	`203`
`204`	`204`	`var cookieOptions = Options.StateCookie.Build(Context, Options.TimeProvider.GetUtcNow());`
`205`	`205`	`Response.Cookies.Append(Options.StateCookie.Name, stateKey, cookieOptions);`
`@@ -215,10 +215,10 @@ private async Task AppendStateCookie(AuthenticationProperties properties)`
`215`	`215`	`return Task.FromResult<BankIdUiAuthState?>(null);`
`216`	`216`	`}`
`217`	`217`
`218`		`- return _stateStorage.ReadAsync<BankIdUiAuthState>(new(stateKey));`
	`218`	`+ return _stateStorage.GetAsync<BankIdUiAuthState>(new(stateKey));`
`219`	`219`	`}`
`220`	`220`
`221`		`- private async Task DeleteStateCookie()`
	`221`	`+ private void DeleteStateCookie()`
`222`	`222`	`{`
`223`	`223`	`Validators.ThrowIfNullOrWhitespace(Options.StateCookie.Name, BankIdConstants.AuthStateKey);`
`224`	`224`
`@@ -227,9 +227,6 @@ private async Task DeleteStateCookie()`
`227`	`227`	`throw new InvalidOperationException(BankIdConstants.ErrorMessages.TimeProviderNotSet);`
`228`	`228`	`}`
`229`	`229`
`230`		`- var stateKey = Request.Cookies[Options.StateCookie.Name]!;`
`231`		`- _ = await _stateStorage.RemoveAsync(new(stateKey));`
`232`		`-`
`233`	`230`	`var cookieOptions = Options.StateCookie.Build(Context, Options.TimeProvider.GetUtcNow());`
`234`	`231`	`Response.Cookies.Delete(Options.StateCookie.Name, cookieOptions);`
`235`	`232`	`}`
Original file line number	Diff line number	Diff line change
`@@ -169,13 +169,13 @@ private string GetUiInitUrl(HttpContext httpContext, string callbackPath, BankId`
`169`	`169`	`}`
`170`	`170`
`171`	`171`	`var stateKey = new StateKey(cookie);`
`172`		`- return _bankIdStateStorage.RemoveAsync<BankIdUiSignState>(stateKey);`
	`172`	`+ return _bankIdStateStorage.GetAsync<BankIdUiSignState>(stateKey);`
`173`	`173`	`}`
`174`	`174`
`175`	`175`	`private Task<StateKey> SaveState(BankIdSignProperties properties, string configKey)`
`176`	`176`	`{`
`177`	`177`	`var state = new BankIdUiSignState(configKey, properties);`
`178`		`- return _bankIdStateStorage.WriteAsync(state);`
	`178`	`+ return _bankIdStateStorage.SetAsync(state);`
`179`	`179`	`}`
`180`	`180`
`181`	`181`	`private void DeleteCookie(HttpContext httpContext, BankIdSignOptions options)`