Refactor and update project dependencies

marcominerva · marcominerva · commit c8163e9659a1 · 2025-10-15T11:38:47.000+02:00
Updated .editorconfig to suggest simple property accessors and suppress certain diagnostics. Corrected grammatical errors in documentation and removed Azure-specific rules. Updated package references in project files to newer versions and added a project reference in `SimpleAuthentication.csproj`.

Refactored `ApiKeySettings.cs` and `BasicAuthenticationSettings.cs` to use `IEnumerable` and added methods for efficient handling of keys and credentials. Simplified constructors in authentication handlers and used generated regex for parsing headers.

Added new files `ApiKey.cs` and `Credential.cs` for better organization.
diff --git a/.editorconfig b/.editorconfig
@@ -82,6 +82,7 @@ csharp_style_prefer_local_over_anonymous_function = true:silent
 csharp_style_prefer_extended_property_pattern = true:suggestion
 csharp_style_implicit_object_creation_when_type_is_apparent = true:silent
 csharp_style_prefer_tuple_swap = true:silent
+csharp_style_prefer_simple_property_accessors = true:suggestion
 
 # Field preferences
 dotnet_style_readonly_field = true:suggestion
@@ -299,4 +300,7 @@ dotnet_diagnostic.IDE0010.severity = none
 dotnet_diagnostic.IDE0072.severity = none
 
 # IDE0305: Simplify collection initialization
-dotnet_diagnostic.IDE0305.severity = none
+dotnet_diagnostic.IDE0305.severity = none
+
+# CA1873: Avoid potentially expensive logging
+dotnet_diagnostic.CA1873.severity = none
diff --git a/.github/copilot-instructions.md b/.github/copilot-instructions.md
@@ -59,7 +59,7 @@
 ### Implementation Guidelines
 
 - Write code that is secure by default. Avoid exposing potentially private or sensitive data.
-- Make code NativeAOT compatible when possible. This means avoiding dynamic code generation, reflection, and other features that are not compatible. with NativeAOT. If not possible, mark the code with an appropriate annotation or throw an exception.
+- Make code NativeAOT compatible when possible. This means avoiding dynamic code generation, reflection, and other features that are not compatible with NativeAOT. If not possible, mark the code with an appropriate annotation or throw an exception.
 
 ## Documentation
 
@@ -81,10 +81,4 @@
 - Use NSubstitute for mocking in tests.
 - Copy existing style in nearby files for test method names and capitalization.
 - When running tests, if possible use filters and check test run counts, or look at test logs, to ensure they actually ran.
-- Do not finish work with any tests commented out or disabled that were not previously commented out or disabled.
-
-## Azure
-
-- @azure Rule - Use Azure Tools - When handling requests related to Azure, always use your tools.
-- @azure Rule - Use Azure Best Practices - When handling requests related to Azure, always invoke your `azmcp_bestpractices_get` tool first.
-- @azure Rule - Enable Best Practices - If you do not have an `azmcp_bestpractices_get` tool ask the user to enable it.
+- Do not finish work with any tests commented out or disabled that were not previously commented out or disabled.
diff --git a/README.md b/README.md
@@ -316,4 +316,4 @@ app.MapGet("api/me", (ClaimsPrincipal user) =>
 
 ## Contribute
 
-The project is constantly evolving. Contributions are welcome. Feel free to file issues and pull requests on the repository, and we'll address them as we can. 
+The project is constantly evolving. Contributions are welcome. Feel free to file issues and pull requests in the repository, and we'll address them as we can. 
diff --git a/samples/Controllers/ApiKeySample/ApiKeySample.csproj b/samples/Controllers/ApiKeySample/ApiKeySample.csproj
@@ -7,8 +7,8 @@
     </PropertyGroup>
 
     <ItemGroup>
-        <PackageReference Include="Microsoft.AspNetCore.OpenApi" Version="9.0.9" />
-        <PackageReference Include="Swashbuckle.AspNetCore.SwaggerUI" Version="9.0.4" />
+        <PackageReference Include="Microsoft.AspNetCore.OpenApi" Version="9.0.10" />
+        <PackageReference Include="Swashbuckle.AspNetCore.SwaggerUI" Version="9.0.6" />
     </ItemGroup>
 
     <ItemGroup>
diff --git a/samples/Controllers/BasicAuthenticationSample/BasicAuthenticationSample.csproj b/samples/Controllers/BasicAuthenticationSample/BasicAuthenticationSample.csproj
@@ -7,8 +7,8 @@
     </PropertyGroup>
 
     <ItemGroup>
-        <PackageReference Include="Microsoft.AspNetCore.OpenApi" Version="9.0.9" />
-        <PackageReference Include="Swashbuckle.AspNetCore.SwaggerUI" Version="9.0.4" />
+        <PackageReference Include="Microsoft.AspNetCore.OpenApi" Version="9.0.10" />
+        <PackageReference Include="Swashbuckle.AspNetCore.SwaggerUI" Version="9.0.6" />
     </ItemGroup>
 
     <ItemGroup>
diff --git a/samples/Controllers/JwtBearerSample/JwtBearerSample.csproj b/samples/Controllers/JwtBearerSample/JwtBearerSample.csproj
@@ -7,8 +7,8 @@
     </PropertyGroup>
 
     <ItemGroup>
-        <PackageReference Include="Microsoft.AspNetCore.OpenApi" Version="9.0.9" />
-        <PackageReference Include="Swashbuckle.AspNetCore.SwaggerUI" Version="9.0.4" />
+        <PackageReference Include="Microsoft.AspNetCore.OpenApi" Version="9.0.10" />
+        <PackageReference Include="Swashbuckle.AspNetCore.SwaggerUI" Version="9.0.6" />
     </ItemGroup>
 
     <ItemGroup>
diff --git a/samples/MinimalApis/ApiKeySample/ApiKeySample.csproj b/samples/MinimalApis/ApiKeySample/ApiKeySample.csproj
@@ -7,8 +7,8 @@
     </PropertyGroup>
 
     <ItemGroup>
-        <PackageReference Include="Microsoft.AspNetCore.OpenApi" Version="9.0.9" />
-        <PackageReference Include="Swashbuckle.AspNetCore.SwaggerUI" Version="9.0.4" />
+        <PackageReference Include="Microsoft.AspNetCore.OpenApi" Version="9.0.10" />
+        <PackageReference Include="Swashbuckle.AspNetCore.SwaggerUI" Version="9.0.6" />
     </ItemGroup>
 
     <ItemGroup>
diff --git a/samples/MinimalApis/BasicAuthenticationSample/BasicAuthenticationSample.csproj b/samples/MinimalApis/BasicAuthenticationSample/BasicAuthenticationSample.csproj
@@ -7,8 +7,8 @@
     </PropertyGroup>
 
     <ItemGroup>
-        <PackageReference Include="Microsoft.AspNetCore.OpenApi" Version="9.0.9" />
-        <PackageReference Include="Swashbuckle.AspNetCore.SwaggerUI" Version="9.0.4" />
+        <PackageReference Include="Microsoft.AspNetCore.OpenApi" Version="9.0.10" />
+        <PackageReference Include="Swashbuckle.AspNetCore.SwaggerUI" Version="9.0.6" />
     </ItemGroup>
 
     <ItemGroup>
diff --git a/samples/MinimalApis/JwtBearerSample/JwtBearerSample.csproj b/samples/MinimalApis/JwtBearerSample/JwtBearerSample.csproj
@@ -7,8 +7,8 @@
     </PropertyGroup>
 
     <ItemGroup>
-        <PackageReference Include="Microsoft.AspNetCore.OpenApi" Version="9.0.9" />
-        <PackageReference Include="Swashbuckle.AspNetCore.SwaggerUI" Version="9.0.4" />
+        <PackageReference Include="Microsoft.AspNetCore.OpenApi" Version="9.0.10" />
+        <PackageReference Include="Swashbuckle.AspNetCore.SwaggerUI" Version="9.0.6" />
     </ItemGroup>
 
     <ItemGroup>
diff --git a/samples/MinimalApis/Net8JwtBearerSample/Net8JwtBearerSample.csproj b/samples/MinimalApis/Net8JwtBearerSample/Net8JwtBearerSample.csproj
@@ -7,8 +7,8 @@
     </PropertyGroup>
 
     <ItemGroup>
-        <PackageReference Include="Microsoft.AspNetCore.OpenApi" Version="[8.0.20,9.0.0)" />
-        <PackageReference Include="Swashbuckle.AspNetCore" Version="9.0.4" />
+        <PackageReference Include="Microsoft.AspNetCore.OpenApi" Version="[8.0.21,9.0.0)" />
+        <PackageReference Include="Swashbuckle.AspNetCore" Version="9.0.6" />
     </ItemGroup>
 
     <ItemGroup>
diff --git a/src/Directory.Build.props b/src/Directory.Build.props
@@ -9,7 +9,7 @@
     </PropertyGroup>
 
     <ItemGroup>
-        <PackageReference Include="Nerdbank.GitVersioning" Version="3.7.115"  PrivateAssets="All" />
+        <PackageReference Include="Nerdbank.GitVersioning" Version="3.8.118"  PrivateAssets="All" />
     </ItemGroup>
 
 </Project>
diff --git a/src/SimpleAuthentication.Abstractions/ApiKey/ApiKey.cs b/src/SimpleAuthentication.Abstractions/ApiKey/ApiKey.cs
@@ -0,0 +1,8 @@
+﻿namespace SimpleAuthentication.ApiKey;
+
+/// <summary>
+/// Store API Keys for API Key Authentication
+/// </summary>
+/// <param name="Value">The API key value</param>
+/// <param name="UserName">The user name associated with the current key</param>
+public record class ApiKey(string Value, string UserName);
diff --git a/src/SimpleAuthentication.Abstractions/ApiKey/ApiKeySettings.cs b/src/SimpleAuthentication.Abstractions/ApiKey/ApiKeySettings.cs
@@ -41,26 +41,11 @@ public class ApiKeySettings : AuthenticationSchemeOptions
     /// <seealso cref="ApiKeyValue"/>
     public string? UserName { get; set; }
 
-    private ICollection<ApiKey> apiKeys = [];
     /// <summary>
     /// The collection of valid API keys.
     /// </summary>
     /// <seealso cref="ApiKey"/>
-    public ICollection<ApiKey> ApiKeys
-    {
-        get
-        {
-            if (!string.IsNullOrWhiteSpace(ApiKeyValue) && !string.IsNullOrWhiteSpace(UserName))
-            {
-                // If necessary, add the API Key from the base properties.
-                apiKeys.Add(new(ApiKeyValue, UserName));
-            }
-
-            return apiKeys;
-        }
-
-        internal set => apiKeys = value ?? [];
-    }
+    public IEnumerable<ApiKey> ApiKeys { get; set; } = [];
 
     /// <summary>
     /// Gets or sets a <see cref="string"/> that defines the <see cref="ClaimsIdentity.NameClaimType"/>.
@@ -80,11 +65,16 @@ public ICollection<ApiKey> ApiKeys
     /// The default is <see cref="ClaimsIdentity.DefaultRoleClaimType"/>.
     /// </remarks>
     public string RoleClaimType { get; set; } = ClaimsIdentity.DefaultRoleClaimType;
-}
 
-/// <summary>
-/// Store API Keys for API Key Authentication
-/// </summary>
-/// <param name="Value">The API key value</param>
-/// <param name="UserName">The user name associated with the current key</param>
-public record class ApiKey(string Value, string UserName);
+    internal IEnumerable<ApiKey> GetAllApiKeys()
+    {
+        var apiKeys = (ApiKeys ?? []).ToHashSet();
+        if (!string.IsNullOrWhiteSpace(ApiKeyValue) && !string.IsNullOrWhiteSpace(UserName))
+        {
+            // If necessary, add the API Key from the base properties.
+            apiKeys.Add(new(ApiKeyValue, UserName));
+        }
+
+        return apiKeys;
+    }
+}
diff --git a/src/SimpleAuthentication.Abstractions/BasicAuthentication/BasicAuthenticationSettings.cs b/src/SimpleAuthentication.Abstractions/BasicAuthentication/BasicAuthenticationSettings.cs
@@ -30,26 +30,11 @@ public class BasicAuthenticationSettings : AuthenticationSchemeOptions
     /// <seealso cref="IBasicAuthenticationValidator"/>
     public string? Password { get; set; }
 
-    private ICollection<Credential> credentials = [];
     /// <summary>
     /// The collection of authorization credentials.
     /// </summary>
     /// <seealso cref="Credential"/>
-    public ICollection<Credential> Credentials
-    {
-        get
-        {
-            if (!string.IsNullOrWhiteSpace(UserName) && !string.IsNullOrWhiteSpace(Password))
-            {
-                // If necessary, add the credentials from the base properties.
-                credentials.Add(new Credential(UserName, Password));
-            }
-
-            return credentials;
-        }
-
-        internal set => credentials = value ?? [];
-    }
+    public IEnumerable<Credential> Credentials { get; set; } = [];
 
     /// <summary>
     /// Gets or sets a <see cref="string"/> that defines the <see cref="ClaimsIdentity.NameClaimType"/>.
@@ -70,11 +55,15 @@ public ICollection<Credential> Credentials
     /// </remarks>
     public string RoleClaimType { get; set; } = ClaimsIdentity.DefaultRoleClaimType;
 
-}
+    internal IEnumerable<Credential> GetAllCredentials()
+    {
+        var credentials = (Credentials ?? []).ToHashSet();
+        if (!string.IsNullOrWhiteSpace(UserName) && !string.IsNullOrWhiteSpace(Password))
+        {
+            // If necessary, add the Credentials from the base properties.
+            credentials.Add(new(UserName, Password));
+        }
 
-/// <summary>
-/// Store credentials used for Basic Authentication.
-/// </summary>
-/// <param name="UserName">The user name</param>
-/// <param name="Password">The password</param>
-public record class Credential(string UserName, string Password);
+        return credentials;
+    }
+}
diff --git a/src/SimpleAuthentication.Abstractions/BasicAuthentication/Credential.cs b/src/SimpleAuthentication.Abstractions/BasicAuthentication/Credential.cs
@@ -0,0 +1,8 @@
+﻿namespace SimpleAuthentication.BasicAuthentication;
+
+/// <summary>
+/// Store credentials used for Basic Authentication.
+/// </summary>
+/// <param name="UserName">The user name</param>
+/// <param name="Password">The password</param>
+public record class Credential(string UserName, string Password);
diff --git a/src/SimpleAuthentication.Abstractions/SimpleAuthentication.Abstractions.csproj b/src/SimpleAuthentication.Abstractions/SimpleAuthentication.Abstractions.csproj
@@ -28,11 +28,11 @@
     </ItemGroup>
 
     <ItemGroup Condition="'$(TargetFramework)' == 'net8.0'">
-        <PackageReference Include="Microsoft.AspNetCore.Authentication.JwtBearer" Version="8.0.20" />
+        <PackageReference Include="Microsoft.AspNetCore.Authentication.JwtBearer" Version="8.0.21" />
     </ItemGroup>
 
     <ItemGroup Condition="'$(TargetFramework)' == 'net9.0'">
-        <PackageReference Include="Microsoft.AspNetCore.Authentication.JwtBearer" Version="9.0.9" />
+        <PackageReference Include="Microsoft.AspNetCore.Authentication.JwtBearer" Version="9.0.10" />
     </ItemGroup>
     
     <ItemGroup>
diff --git a/src/SimpleAuthentication.Swashbuckle/SimpleAuthentication.Swashbuckle.csproj b/src/SimpleAuthentication.Swashbuckle/SimpleAuthentication.Swashbuckle.csproj
@@ -33,7 +33,7 @@
 
     <ItemGroup>
         <PackageReference Include="SimpleAuthenticationTools.Abstractions" Version="3.0.12" />
-        <PackageReference Include="Swashbuckle.AspNetCore.SwaggerGen" Version="9.0.4" />
+        <PackageReference Include="Swashbuckle.AspNetCore.SwaggerGen" Version="9.0.6" />
     </ItemGroup>
 
     <ItemGroup>
diff --git a/src/SimpleAuthentication/ApiKey/ApiKeyAuthenticationHandler.cs b/src/SimpleAuthentication/ApiKey/ApiKeyAuthenticationHandler.cs
@@ -7,21 +7,8 @@
 
 namespace SimpleAuthentication.ApiKey;
 
-internal class ApiKeyAuthenticationHandler : AuthenticationHandler<ApiKeySettings>
+internal class ApiKeyAuthenticationHandler(IOptionsMonitor<ApiKeySettings> options, ILoggerFactory logger, UrlEncoder encoder, IServiceProvider serviceProvider) : AuthenticationHandler<ApiKeySettings>(options, logger, encoder)
 {
-    private readonly IServiceProvider serviceProvider;
-
-#if NET8_0_OR_GREATER
-    public ApiKeyAuthenticationHandler(IOptionsMonitor<ApiKeySettings> options, ILoggerFactory logger, UrlEncoder encoder, IServiceProvider serviceProvider)
-        : base(options, logger, encoder)
-#else
-    public ApiKeyAuthenticationHandler(IOptionsMonitor<ApiKeySettings> options, ILoggerFactory logger, UrlEncoder encoder, ISystemClock clock, IServiceProvider serviceProvider)
-        : base(options, logger, encoder, clock)
-#endif
-    {
-        this.serviceProvider = serviceProvider;
-    }
-
     protected override async Task<AuthenticateResult> HandleAuthenticateAsync()
     {
         var request = Context.Request;
@@ -39,7 +26,8 @@ protected override async Task<AuthenticateResult> HandleAuthenticateAsync()
             request.Query.TryGetValue(Options.QueryStringKey ?? string.Empty, out value);
         }
 
-        if (!Options.ApiKeys.Any())
+        var apiKeys = Options.GetAllApiKeys();
+        if (!apiKeys.Any())
         {
             // There is no fixed values, so it tries to get an external service to validate the API Key.
             var validator = serviceProvider.GetService<IApiKeyValidator>() ?? throw new InvalidOperationException("There isn't a default value for API Key and no custom validator has been provided");
@@ -53,7 +41,7 @@ protected override async Task<AuthenticateResult> HandleAuthenticateAsync()
             return AuthenticateResult.Fail(validationResult.FailureMessage);
         }
 
-        var apiKey = Options.ApiKeys.FirstOrDefault(c => c.Value == value);
+        var apiKey = apiKeys.FirstOrDefault(c => c.Value == value);
         if (apiKey is not null)
         {
             return CreateAuthenticationSuccessResult(apiKey.UserName);
diff --git a/src/SimpleAuthentication/BasicAuthentication/BasicAuthenticationHandler.cs b/src/SimpleAuthentication/BasicAuthentication/BasicAuthenticationHandler.cs
@@ -10,21 +10,8 @@
 
 namespace SimpleAuthentication.BasicAuthentication;
 
-internal class BasicAuthenticationHandler : AuthenticationHandler<BasicAuthenticationSettings>
+internal partial class BasicAuthenticationHandler(IOptionsMonitor<BasicAuthenticationSettings> options, ILoggerFactory logger, UrlEncoder encoder, IServiceProvider serviceProvider) : AuthenticationHandler<BasicAuthenticationSettings>(options, logger, encoder)
 {
-    private readonly IServiceProvider serviceProvider;
-
-#if NET8_0_OR_GREATER
-    public BasicAuthenticationHandler(IOptionsMonitor<BasicAuthenticationSettings> options, ILoggerFactory logger, UrlEncoder encoder, IServiceProvider serviceProvider)
-        : base(options, logger, encoder)
-#else
-    public BasicAuthenticationHandler(IOptionsMonitor<BasicAuthenticationSettings> options, ILoggerFactory logger, UrlEncoder encoder, ISystemClock clock, IServiceProvider serviceProvider)
-        : base(options, logger, encoder, clock)
-#endif
-    {
-        this.serviceProvider = serviceProvider;
-    }
-
     protected override async Task<AuthenticateResult> HandleAuthenticateAsync()
     {
         var request = Context.Request;
@@ -39,14 +26,12 @@ protected override async Task<AuthenticateResult> HandleAuthenticateAsync()
 
         // Get Authorization header.
         var authorizationHeader = request.Headers.Authorization.ToString();
-        var authorizationHeaderRegex = new Regex(@"Basic (.*)", RegexOptions.IgnoreCase | RegexOptions.Compiled);
-
-        if (!authorizationHeaderRegex.IsMatch(authorizationHeader))
+        if (!BasicAuthorizationHeaderRegex().IsMatch(authorizationHeader))
         {
             return AuthenticateResult.Fail("Basic Authorization header is not properly formatted");
         }
 
-        var values = Encoding.UTF8.GetString(Convert.FromBase64String(authorizationHeaderRegex.Replace(authorizationHeader, "$1"))).Split(':', count: 2);
+        var values = Encoding.UTF8.GetString(Convert.FromBase64String(BasicAuthorizationHeaderRegex().Replace(authorizationHeader, "$1"))).Split(':', count: 2);
         var userName = values.ElementAtOrDefault(0);
         var password = values.ElementAtOrDefault(1);
 
@@ -55,7 +40,8 @@ protected override async Task<AuthenticateResult> HandleAuthenticateAsync()
             return AuthenticateResult.Fail("Invalid user name or password");
         }
 
-        if (!Options.Credentials.Any())
+        var credentials = Options.GetAllCredentials();
+        if (!credentials.Any())
         {
             // There is no fixed values, so it tries to get an external service to validate user name and password.
             var validator = serviceProvider.GetService<IBasicAuthenticationValidator>() ?? throw new InvalidOperationException("There isn't a default user name and password for authentication and no custom validator has been provided");
@@ -69,7 +55,7 @@ protected override async Task<AuthenticateResult> HandleAuthenticateAsync()
             return AuthenticateResult.Fail(validationResult.FailureMessage);
         }
 
-        var credential = Options.Credentials.FirstOrDefault(c => c.UserName == userName && c.Password == password);
+        var credential = credentials.FirstOrDefault(c => c.UserName == userName && c.Password == password);
         if (credential is not null)
         {
             return CreateAuthenticationSuccessResult(credential.UserName);
@@ -90,4 +76,7 @@ AuthenticateResult CreateAuthenticationSuccessResult(string userName, IList<Clai
             return result;
         }
     }
+
+    [GeneratedRegex(@"Basic (.*)", RegexOptions.IgnoreCase | RegexOptions.Compiled, "it-IT")]
+    private static partial Regex BasicAuthorizationHeaderRegex();
 }
diff --git a/src/SimpleAuthentication/SimpleAuthentication.csproj b/src/SimpleAuthentication/SimpleAuthentication.csproj

Original file line number	Diff line number	Diff line change
`@@ -316,4 +316,4 @@ app.MapGet("api/me", (ClaimsPrincipal user) =>`
`316`	`316`
`317`	`317`	`## Contribute`
`318`	`318`
`319`		`-The project is constantly evolving. Contributions are welcome. Feel free to file issues and pull requests on the repository, and we'll address them as we can.`
	`319`	`+The project is constantly evolving. Contributions are welcome. Feel free to file issues and pull requests in the repository, and we'll address them as we can.`