reduce logging

Author: pwelter34

src/AspNetCore.SecurityKey/ApplicationBuilderExtensions.cs

@@ -17,8 +17,7 @@ public static class ApplicationBuilderExtensions
     /// <exception cref="System.ArgumentNullException">builder is null</exception>
     public static IApplicationBuilder UseSecurityKey(this IApplicationBuilder builder)
     {
-        if (builder is null)
-            throw new ArgumentNullException(nameof(builder));
+        ArgumentNullException.ThrowIfNull(builder);
 
         return builder.UseMiddleware<SecurityKeyMiddleware>();
     }

src/AspNetCore.SecurityKey/AuthenticationBuilderExtensions.cs

@@ -24,7 +24,7 @@ public static AuthenticationBuilder AddSecurityKey(this AuthenticationBuilder bu
     /// <param name="authenticationScheme">The authentication scheme.</param>
     /// <returns>A reference to <paramref name="builder"/> after the operation has completed.</returns>
     public static AuthenticationBuilder AddSecurityKey(this AuthenticationBuilder builder, string authenticationScheme)
-        => builder.AddSecurityKey(authenticationScheme, configureOptions: null!);
+        => builder.AddSecurityKey(authenticationScheme, configureOptions: null);
 
     /// <summary>
     /// Adds security API key authentication to <see cref="AuthenticationBuilder"/> using the default scheme.
@@ -33,7 +33,7 @@ public static AuthenticationBuilder AddSecurityKey(this AuthenticationBuilder bu
     /// <param name="builder">The <see cref="AuthenticationBuilder"/>.</param>
     /// <param name="configureOptions">A delegate to configure <see cref="SecurityKeyAuthenticationSchemeOptions"/>.</param>
     /// <returns>A reference to <paramref name="builder"/> after the operation has completed.</returns>
-    public static AuthenticationBuilder AddSecurityKey(this AuthenticationBuilder builder, Action<SecurityKeyAuthenticationSchemeOptions> configureOptions)
+    public static AuthenticationBuilder AddSecurityKey(this AuthenticationBuilder builder, Action<SecurityKeyAuthenticationSchemeOptions>? configureOptions)
         => builder.AddSecurityKey(SecurityKeyAuthenticationDefaults.AuthenticationScheme, configureOptions);
 
     /// <summary>
@@ -43,7 +43,7 @@ public static AuthenticationBuilder AddSecurityKey(this AuthenticationBuilder bu
     /// <param name="authenticationScheme">The authentication scheme.</param>
     /// <param name="configureOptions">A delegate to configure <see cref="SecurityKeyAuthenticationSchemeOptions"/>.</param>
     /// <returns>A reference to <paramref name="builder"/> after the operation has completed.</returns>
-    public static AuthenticationBuilder AddSecurityKey(this AuthenticationBuilder builder, string authenticationScheme, Action<SecurityKeyAuthenticationSchemeOptions> configureOptions)
+    public static AuthenticationBuilder AddSecurityKey(this AuthenticationBuilder builder, string authenticationScheme, Action<SecurityKeyAuthenticationSchemeOptions>? configureOptions)
         => builder.AddSecurityKey(authenticationScheme, displayName: null, configureOptions: configureOptions);
 
     /// <summary>
@@ -54,8 +54,10 @@ public static AuthenticationBuilder AddSecurityKey(this AuthenticationBuilder bu
     /// <param name="displayName">A display name for the authentication handler.</param>
     /// <param name="configureOptions">A delegate to configure <see cref="SecurityKeyAuthenticationSchemeOptions"/>.</param>
     /// <returns>A reference to <paramref name="builder"/> after the operation has completed.</returns>
-    public static AuthenticationBuilder AddSecurityKey(this AuthenticationBuilder builder, string authenticationScheme, string? displayName, Action<SecurityKeyAuthenticationSchemeOptions> configureOptions)
+    public static AuthenticationBuilder AddSecurityKey(this AuthenticationBuilder builder, string authenticationScheme, string? displayName, Action<SecurityKeyAuthenticationSchemeOptions>? configureOptions)
     {
+        ArgumentNullException.ThrowIfNull(builder);
+
         builder.Services.AddOptions<SecurityKeyAuthenticationSchemeOptions>(authenticationScheme);
         return builder.AddScheme<SecurityKeyAuthenticationSchemeOptions, SecurityKeyAuthenticationHandler>(authenticationScheme, displayName, configureOptions);
     }

src/AspNetCore.SecurityKey/DependencyInjectionExtensions.cs

@@ -18,9 +18,7 @@ public static class DependencyInjectionExtensions
     /// The <see cref="IServiceCollection"/> so that additional calls can be chained.
     /// </returns>
     public static IServiceCollection AddSecurityKey(this IServiceCollection services, Action<SecurityKeyOptions>? configure = null)
-    {
-        return AddSecurityKey<SecurityKeyValidator, SecurityKeyExtractor>(services, configure);
-    }
+        => AddSecurityKey<SecurityKeyValidator, SecurityKeyExtractor>(services, configure);
 
     /// <summary>
     /// Adds the security API key services to the specified <see cref="IServiceCollection" />.
@@ -33,9 +31,7 @@ public static IServiceCollection AddSecurityKey(this IServiceCollection services
     /// </returns>
     public static IServiceCollection AddSecurityKey<TValidator>(this IServiceCollection services, Action<SecurityKeyOptions>? configure = null)
         where TValidator : class, ISecurityKeyValidator
-    {
-        return AddSecurityKey<TValidator, SecurityKeyExtractor>(services, configure);
-    }
+        => AddSecurityKey<TValidator, SecurityKeyExtractor>(services, configure);
 
     /// <summary>
     /// Adds the security API key services to the specified <see cref="IServiceCollection" />.
@@ -51,6 +47,8 @@ public static IServiceCollection AddSecurityKey<TValidator, TExtractor>(this ISe
         where TValidator : class, ISecurityKeyValidator
         where TExtractor : class, ISecurityKeyExtractor
     {
+        ArgumentNullException.ThrowIfNull(services);
+
         services.AddHttpContextAccessor();
 
         services.AddOptions<SecurityKeyOptions>();

src/AspNetCore.SecurityKey/EndpointFilterExtensions.cs

@@ -18,6 +18,8 @@ public static class EndpointFilterExtensions
     /// </returns>
     public static RouteHandlerBuilder RequireSecurityKey(this RouteHandlerBuilder builder)
     {
+        ArgumentNullException.ThrowIfNull(builder);
+
         builder.AddEndpointFilter<SecurityKeyEndpointFilter>();
         return builder;
     }

src/AspNetCore.SecurityKey/SecurityKeyAuthenticationHandler.cs

@@ -48,10 +48,7 @@ protected override async Task<AuthenticateResult> HandleAuthenticateAsync()
         var identity = await _securityKeyValidator.Authenticate(securityKey);
 
         if (!identity.IsAuthenticated)
-        {
-            SecurityKeyLogger.InvalidSecurityKey(Logger, securityKey);
             return AuthenticateResult.Fail("Invalid Security Key");
-        }
 
         // create a user claim for the security key
         var principal = new ClaimsPrincipal(identity);

src/AspNetCore.SecurityKey/SecurityKeyAuthorizationFilter.cs

@@ -43,8 +43,6 @@ public async Task OnAuthorizationAsync(AuthorizationFilterContext context)
         if (await _securityKeyValidator.Validate(securityKey))
             return;
 
-        SecurityKeyLogger.InvalidSecurityKey(_logger, securityKey);
-
         context.Result = new UnauthorizedResult();
     }
 }

src/AspNetCore.SecurityKey/SecurityKeyEndpointFilter.cs

@@ -41,8 +41,6 @@ public SecurityKeyEndpointFilter(
         if (await _securityKeyValidator.Validate(securityKey))
             return await next(context);
 
-        SecurityKeyLogger.InvalidSecurityKey(_logger, securityKey);
-
         return Results.Unauthorized();
     }
 }

src/AspNetCore.SecurityKey/SecurityKeyExtractor.cs

@@ -18,8 +18,7 @@ public class SecurityKeyExtractor : ISecurityKeyExtractor
     /// <exception cref="System.ArgumentNullException">securityKeyOptions</exception>
     public SecurityKeyExtractor(IOptions<SecurityKeyOptions> securityKeyOptions)
     {
-        if (securityKeyOptions == null)
-            throw new ArgumentNullException(nameof(securityKeyOptions));
+        ArgumentNullException.ThrowIfNull(securityKeyOptions);
 
         _securityKeyOptions = securityKeyOptions.Value;
     }

src/AspNetCore.SecurityKey/SecurityKeyLogger.cs

@@ -4,7 +4,7 @@ namespace AspNetCore.Extensions.Authentication;
 
 internal partial class SecurityKeyLogger
 {
-    [LoggerMessage(1001, LogLevel.Error, "Invalid Security Key '{SecurityKey}'")]
+    [LoggerMessage(1001, LogLevel.Warning, "Invalid Security Key '{SecurityKey}'")]
     internal static partial void InvalidSecurityKey(ILogger logger, string? securityKey);
 
     [LoggerMessage(1002, LogLevel.Debug, "Using Security Keys '{SecurityKey}' from configuration '{ConfigurationName}'")]

src/AspNetCore.SecurityKey/SecurityKeyMiddleware.cs

@@ -39,8 +39,6 @@ public async Task InvokeAsync(HttpContext context)
             return;
         }
 
-        SecurityKeyLogger.InvalidSecurityKey(_logger, securityKey);
-
         context.Response.StatusCode = (int)HttpStatusCode.Unauthorized;
     }
 }