refactor: make statestorage non-generic

Author: Zonnex

src/ActiveLogin.Authentication.BankId.AspNetCore/Areas/ActiveLogin/Controllers/BankIdUiAuthController.cs

@@ -22,24 +22,13 @@ public class BankIdUiAuthController(
     IBankIdUserMessageLocalizer bankIdUserMessageLocalizer,
     IBankIdUiOptionsProtector uiOptionsProtector,
     IBankIdInvalidStateHandler bankIdInvalidStateHandler,
-    IStateStorage<BankIdUiAuthState> stateStorage
-) : BankIdUiControllerBase<BankIdUiAuthState>(antiforgery, localizer, bankIdUserMessageLocalizer, uiOptionsProtector, bankIdInvalidStateHandler)
+    IStateStorage stateStorage
+) : BankIdUiControllerBase<BankIdUiAuthState>(antiforgery, localizer, bankIdUserMessageLocalizer, uiOptionsProtector, bankIdInvalidStateHandler, stateStorage)
 {
     [HttpGet]
     [Route($"/[area]/{BankIdConstants.Routes.BankIdPathName}/{BankIdConstants.Routes.BankIdAuthControllerPath}")]
     public Task<ActionResult> Init(string returnUrl, [FromQuery(Name = BankIdConstants.QueryStringParameters.UiOptions)] string protectedUiOptions)
     {
         return Initialize(returnUrl, BankIdConstants.Routes.BankIdAuthApiControllerName, protectedUiOptions, "Init");
     }
-
-    protected override Task<BankIdUiAuthState?> GetUIState(BankIdUiOptions uiOptions)
-    {
-        var cookie = HttpContext.Request.Cookies[uiOptions.StateKeyCookieName];
-        if (cookie is null)
-        {
-            return Task.FromResult<BankIdUiAuthState?>(null);
-        }
-        var stateKey = new StateKey(cookie);
-        return stateStorage.RemoveAsync(stateKey);
-    }
 }

src/ActiveLogin.Authentication.BankId.AspNetCore/Areas/ActiveLogin/Controllers/BankIdUiControllerBase.cs

@@ -20,7 +20,8 @@ public abstract class BankIdUiControllerBase<T>(
     IStringLocalizer<ActiveLoginResources> localizer,
     IBankIdUserMessageLocalizer bankIdUserMessageLocalizer,
     IBankIdUiOptionsProtector uiOptionsProtector,
-    IBankIdInvalidStateHandler bankIdInvalidStateHandler
+    IBankIdInvalidStateHandler bankIdInvalidStateHandler,
+    IStateStorage stateStorage
 ) : Controller
     where T : BankIdUiState
 {
@@ -30,7 +31,16 @@ IBankIdInvalidStateHandler bankIdInvalidStateHandler
     private readonly IBankIdUiOptionsProtector _uiOptionsProtector = uiOptionsProtector;
     private readonly IBankIdInvalidStateHandler _bankIdInvalidStateHandler = bankIdInvalidStateHandler;
 
-    protected abstract Task<T?> GetUIState(BankIdUiOptions uiOptions);
+    protected async Task<T?> GetUIState(BankIdUiOptions uiOptions)
+    {
+        var cookie = HttpContext.Request.Cookies[uiOptions.StateKeyCookieName];
+        if (cookie is null)
+        {
+            return default;
+        }
+        var stateKey = new StateKey(cookie);
+        return await stateStorage.ReadAsync(stateKey) as T;
+    }
 
     protected async Task<ActionResult> Initialize(string returnUrl, string apiControllerName, string protectedUiOptions, string viewName)
     {

src/ActiveLogin.Authentication.BankId.AspNetCore/Areas/ActiveLogin/Controllers/BankIdUiSignApiController.cs

@@ -28,7 +28,7 @@ public class BankIdUiSignApiController(
     IBankIdUserMessage bankIdUserMessage,
     IBankIdUserMessageLocalizer bankIdUserMessageLocalizer,
     IBankIdUiResultProtector uiAuthResultProtector,
-    IStateStorage<BankIdUiSignState> stateStorage
+    IStateStorage stateStorage
 ) : BankIdUiApiControllerBase(bankIdFlowService, orderRefProtector, qrStartStateProtector, uiOptionsProtector, bankIdUserMessage, bankIdUserMessageLocalizer, uiAuthResultProtector)
 {
     [ValidateAntiForgeryToken]
@@ -106,6 +106,6 @@ public async Task<ActionResult<BankIdUiApiInitializeResponse>> Initialize(BankId
         }
 
         var stateKey = new StateKey(cookie);
-        return stateStorage.ReadAsync(stateKey);
+        return stateStorage.ReadAsync<BankIdUiSignState>(stateKey);
     }
 }

src/ActiveLogin.Authentication.BankId.AspNetCore/Areas/ActiveLogin/Controllers/BankIdUiSignController.cs

@@ -23,8 +23,8 @@ public class BankIdUiSignController(
     IBankIdUserMessageLocalizer bankIdUserMessageLocalizer,
     IBankIdUiOptionsProtector uiOptionsProtector,
     IBankIdInvalidStateHandler bankIdInvalidStateHandler,
-    IStateStorage<BankIdUiSignState> stateStorage
-) : BankIdUiControllerBase<BankIdUiSignState>(antiforgery, localizer, bankIdUserMessageLocalizer, uiOptionsProtector, bankIdInvalidStateHandler)
+    IStateStorage stateStorage
+) : BankIdUiControllerBase<BankIdUiSignState>(antiforgery, localizer, bankIdUserMessageLocalizer, uiOptionsProtector, bankIdInvalidStateHandler, stateStorage)
 {
     [HttpGet]
     [AllowAnonymous]
@@ -33,15 +33,4 @@ public Task<ActionResult> Init(string returnUrl, [FromQuery(Name = BankIdConstan
     {
         return Initialize(returnUrl, BankIdConstants.Routes.BankIdSignApiControllerName, protectedUiOptions, "Init");
     }
-
-    protected override Task<BankIdUiSignState?> GetUIState(BankIdUiOptions uiOptions)
-    {
-        var cookie = HttpContext.Request.Cookies[uiOptions.StateKeyCookieName];
-        if (cookie is null)
-        {
-            return Task.FromResult<BankIdUiSignState?>(null);
-        }
-        var stateKey = new StateKey(cookie);
-        return stateStorage.RemoveAsync(stateKey);
-    }
 }

src/ActiveLogin.Authentication.BankId.AspNetCore/Auth/AuthenticationBuilderBankIdExtensions.cs

@@ -74,7 +74,7 @@ private static void AddBankIdAuthDefaultServices(IBankIdAuthBuilder builder)
         BankIdCommonConfiguration.AddDefaultServices(services);
 
         // services.AddTransient<IBankIdUiStateProtector, BankIdUiStateProtector>();
-        services.AddSingleton<IStateStorage<BankIdUiAuthState>, InMemoryStateStorage<BankIdUiAuthState>>();
+        services.AddSingleton<IStateStorage, InMemoryStateStorage>();
         services.AddTransient<IBankIdUiResultProtector, BankIdUiResultProtector>();
 
         builder.AddClaimsTransformer<BankIdDefaultClaimsTransformer>();

src/ActiveLogin.Authentication.BankId.AspNetCore/Auth/BankIdAuthHandler.cs

@@ -1,7 +1,6 @@
 using System.Security.Claims;
 using System.Text.Encodings.Web;
 
-using ActiveLogin.Authentication.BankId.Api.Models;
 using ActiveLogin.Authentication.BankId.AspNetCore.ClaimsTransformation;
 using ActiveLogin.Authentication.BankId.AspNetCore.DataProtection;
 using ActiveLogin.Authentication.BankId.AspNetCore.Helpers;
@@ -33,49 +32,40 @@ public class BankIdAuthHandler(
     IBankIdEventTrigger bankIdEventTrigger,
     IBankIdSupportedDeviceDetector bankIdSupportedDeviceDetector,
     IEnumerable<IBankIdClaimsTransformer> bankIdClaimsTransformers,
-    IStateStorage<BankIdUiAuthState> stateStorage
+    IStateStorage stateStorage
 ) : RemoteAuthenticationHandler<BankIdAuthOptions>(options, loggerFactory, encoder)
 {
-    private const string StateCookieNameParameterName = "StateCookie.Name";
     private readonly PathString _authPath = new($"/{BankIdConstants.Routes.ActiveLoginAreaName}/{BankIdConstants.Routes.BankIdPathName}/{BankIdConstants.Routes.BankIdAuthControllerPath}");
-
-    private readonly IHttpContextAccessor _httpContextAccessor = httpContextAccessor;
-    private readonly IAntiforgery _antiforgery = antiforgery;
-    private readonly IBankIdUiOptionsProtector _uiOptionsProtector = uiOptionsProtector;
-    private readonly IBankIdUiResultProtector _uiResultProtector = uiResultProtector;
-    private readonly IBankIdEventTrigger _bankIdEventTrigger = bankIdEventTrigger;
-    private readonly IBankIdSupportedDeviceDetector _bankIdSupportedDeviceDetector = bankIdSupportedDeviceDetector;
-    private readonly IStateStorage<BankIdUiAuthState> _stateStorage = stateStorage;
-    private readonly List<IBankIdClaimsTransformer> _bankIdClaimsTransformers = bankIdClaimsTransformers.ToList();
+    private readonly List<IBankIdClaimsTransformer> bankIdClaimsTransformers = bankIdClaimsTransformers.ToList();
 
     protected override async Task<HandleRequestResult> HandleRemoteAuthenticateAsync()
     {
-        var detectedDevice = _bankIdSupportedDeviceDetector.Detect();
+        var detectedDevice = bankIdSupportedDeviceDetector.Detect();
 
         var state = await GetStateFromCookie();
         if (state == null)
         {
             return await HandleRemoteAuthenticateFail(BankIdConstants.ErrorMessages.InvalidStateCookie, detectedDevice);
         }
 
-        DeleteStateCookie();
+        await DeleteStateCookie();
 
         if (!Request.HasFormContentType)
         {
             await HandleRemoteAuthenticateFail(BankIdConstants.ErrorMessages.InvalidUiResult, detectedDevice);
             throw new ArgumentException(BankIdConstants.ErrorMessages.InvalidUiResult);
         }
 
-        var httpContext = _httpContextAccessor.HttpContext ?? throw new InvalidOperationException(BankIdConstants.ErrorMessages.CouldNotAccessHttpContext);
-        await _antiforgery.ValidateRequestAsync(httpContext);
+        var httpContext = httpContextAccessor.HttpContext ?? throw new InvalidOperationException(BankIdConstants.ErrorMessages.CouldNotAccessHttpContext);
+        await antiforgery.ValidateRequestAsync(httpContext);
 
         var protectedUiResult = Request.Form[BankIdConstants.FormParameters.UiResult];
         if (StringValues.IsNullOrEmpty(protectedUiResult))
         {
             return await HandleRemoteAuthenticateFail(BankIdConstants.ErrorMessages.InvalidUiResult, detectedDevice);
         }
 
-        var uiResult = _uiResultProtector.Unprotect(protectedUiResult.ToString());
+        var uiResult = uiResultProtector.Unprotect(protectedUiResult.ToString());
         if (!uiResult.IsSuccessful)
         {
             return await HandleRemoteAuthenticateFail(BankIdConstants.ErrorMessages.InvalidUiResult, detectedDevice);
@@ -84,7 +74,7 @@ protected override async Task<HandleRequestResult> HandleRemoteAuthenticateAsync
         var properties = state.AuthenticationProperties;
         var ticket = await GetAuthenticationTicket(uiResult, properties);
 
-        await _bankIdEventTrigger.TriggerAsync(new BankIdAspNetAuthenticateSuccessEvent(
+        await bankIdEventTrigger.TriggerAsync(new BankIdAspNetAuthenticateSuccessEvent(
             PersonalIdentityNumber.Parse(uiResult.PersonalIdentityNumber),
             detectedDevice
         ));
@@ -94,7 +84,7 @@ await _bankIdEventTrigger.TriggerAsync(new BankIdAspNetAuthenticateSuccessEvent(
 
     private async Task<HandleRequestResult> HandleRemoteAuthenticateFail(string reason, BankIdSupportedDevice detectedDevice)
     {
-        await _bankIdEventTrigger.TriggerAsync(new BankIdAspNetAuthenticateFailureEvent(reason, detectedDevice));
+        await bankIdEventTrigger.TriggerAsync(new BankIdAspNetAuthenticateFailureEvent(reason, detectedDevice));
 
         return HandleRequestResult.Fail(reason);
     }
@@ -134,7 +124,7 @@ private async Task<IEnumerable<Claim>> GetClaims(BankIdUiResult uiAuthResult)
             uiAuthResult.GetCompletionData()
         );
 
-        foreach (var transformer in _bankIdClaimsTransformers)
+        foreach (var transformer in bankIdClaimsTransformers)
         {
             await transformer.TransformClaims(context);
         }
@@ -157,8 +147,8 @@ protected override async Task HandleChallengeAsync(AuthenticationProperties prop
             Options.StateCookie.Name ?? string.Empty
         );
 
-        var detectedDevice = _bankIdSupportedDeviceDetector.Detect();
-        await _bankIdEventTrigger.TriggerAsync(new BankIdAspNetChallengeSuccessEvent(detectedDevice, uiOptions.ToBankIdFlowOptions()));
+        var detectedDevice = bankIdSupportedDeviceDetector.Detect();
+        await bankIdEventTrigger.TriggerAsync(new BankIdAspNetChallengeSuccessEvent(detectedDevice, uiOptions.ToBankIdFlowOptions()));
 
         var loginUrl = GetInitUiUrl(uiOptions);
         Response.Redirect(loginUrl);
@@ -169,7 +159,7 @@ private string GetInitUiUrl(BankIdUiOptions uiOptions)
         var pathBase = Context.Request.PathBase;
         var authUrl = pathBase.Add(_authPath);
         var returnUrl = pathBase.Add(Options.CallbackPath);
-        var protectedUiOptions = _uiOptionsProtector.Protect(uiOptions);
+        var protectedUiOptions = uiOptionsProtector.Protect(uiOptions);
 
         var queryBuilder = new QueryBuilder(new Dictionary<string, string>
         {
@@ -182,42 +172,45 @@ private string GetInitUiUrl(BankIdUiOptions uiOptions)
 
     private async Task AppendStateCookie(AuthenticationProperties properties)
     {
-        Validators.ThrowIfNullOrWhitespace(Options.StateCookie.Name, StateCookieNameParameterName);
+        Validators.ThrowIfNullOrWhitespace(Options.StateCookie.Name, BankIdConstants.AuthStateKey);
 
         if (Options.TimeProvider == null)
         {
             throw new InvalidOperationException(BankIdConstants.ErrorMessages.TimeProviderNotSet);
         }
 
         var state = new BankIdUiAuthState(properties);
-        var stateKey = await _stateStorage.WriteAsync(state);
+        var stateKey = await stateStorage.WriteAsync(state);
 
         var cookieOptions = Options.StateCookie.Build(Context, Options.TimeProvider.GetUtcNow());
         Response.Cookies.Append(Options.StateCookie.Name, stateKey, cookieOptions);
     }
 
     private Task<BankIdUiAuthState?> GetStateFromCookie()
     {
-        Validators.ThrowIfNullOrWhitespace(Options.StateCookie.Name, StateCookieNameParameterName);
+        Validators.ThrowIfNullOrWhitespace(Options.StateCookie.Name, BankIdConstants.AuthStateKey);
 
         var stateKey = Request.Cookies[Options.StateCookie.Name];
         if (string.IsNullOrEmpty(stateKey))
         {
             return Task.FromResult<BankIdUiAuthState?>(null);
         }
 
-        return _stateStorage.ReadAsync(new(stateKey));
+        return stateStorage.ReadAsync<BankIdUiAuthState>(new(stateKey));
     }
 
-    private void DeleteStateCookie()
+    private async Task DeleteStateCookie()
     {
-        Validators.ThrowIfNullOrWhitespace(Options.StateCookie.Name, StateCookieNameParameterName);
+        Validators.ThrowIfNullOrWhitespace(Options.StateCookie.Name, BankIdConstants.AuthStateKey);
 
         if (Options.TimeProvider == null)
         {
             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);
     }

src/ActiveLogin.Authentication.BankId.AspNetCore/Auth/IBankIdAuthBuilderExtensions.cs

@@ -1,4 +1,5 @@
 using ActiveLogin.Authentication.BankId.AspNetCore.ClaimsTransformation;
+using ActiveLogin.Authentication.BankId.Core;
 using ActiveLogin.Authentication.BankId.Core.Requirements;
 using ActiveLogin.Authentication.BankId.Core.UserData;
 
@@ -182,4 +183,24 @@ internal static IBankIdAuthBuilder AddScheme(this IBankIdAuthBuilder builder, st
 
         return builder;
     }
+
+    public static IBankIdAuthBuilder AddStateStorage<T>(this IBankIdAuthBuilder builder, T storage)
+        where T : class, IStateStorage
+    {
+        builder.Services.AddSingleton(storage);
+        return builder;
+    }
+
+    public static IBankIdAuthBuilder AddStateStorage<T>(this IBankIdAuthBuilder builder)
+        where T : class, IStateStorage
+    {
+        builder.Services.AddSingleton<IStateStorage, T>();
+        return builder;
+    }
+
+    public static IBankIdAuthBuilder AddStateStorage(this IBankIdAuthBuilder builder, Func<IServiceProvider, IStateStorage> factory)
+    {
+        builder.Services.AddSingleton(factory);
+        return builder;
+    }
 }