Added AOT compatibility to HTTP Client authentication.

prochnowc · prochnowc · commit 86da59b61ef0 · 2025-06-20T08:18:39.000+02:00
diff --git a/Http/src/AppCoreNet.Extensions.Http.Authentication.OAuth.AspNetCore/AppCoreNet.Extensions.Http.Authentication.OAuth.AspNetCore.csproj b/Http/src/AppCoreNet.Extensions.Http.Authentication.OAuth.AspNetCore/AppCoreNet.Extensions.Http.Authentication.OAuth.AspNetCore.csproj
@@ -7,6 +7,8 @@
       from ASP.NET Core authentication schemes.
     </Description>
     <PackageTags>$(PackageTags);Security;Authentication;OAuth;OAuth2;OAuth 2.0;IdentityModel;ASP.NET Core</PackageTags>
+    <!-- Without this, ILLink analyzers are not added, even though 'IsAotComptabile' is set in the parent 'Directory.Build.props' -->
+    <IsAotCompatible Condition="$([MSBuild]::IsTargetFrameworkCompatible('$(TargetFramework)', 'net8.0'))">true</IsAotCompatible>
   </PropertyGroup>
 
   <ItemGroup>
diff --git a/Http/src/AppCoreNet.Extensions.Http.Authentication.OAuth.AspNetCore/AuthenticationSchemeOAuthClientOptionsResolver.cs b/Http/src/AppCoreNet.Extensions.Http.Authentication.OAuth.AspNetCore/AuthenticationSchemeOAuthClientOptionsResolver.cs
@@ -2,6 +2,7 @@
 // Copyright (c) The AppCore .NET project.
 
 using System;
+using System.Diagnostics.CodeAnalysis;
 using System.Threading.Tasks;
 using AppCoreNet.Diagnostics;
 using Microsoft.AspNetCore.Authentication;
@@ -16,7 +17,11 @@ namespace AppCoreNet.Extensions.Http.Authentication.OAuth.AspNetCore;
 /// <typeparam name="TClientOptions">The type of the <see cref="AuthenticationSchemeOptions"/>.</typeparam>
 /// <typeparam name="TOptions">The type of the <see cref="RemoteAuthenticationOptions"/>.</typeparam>
 /// <typeparam name="THandler">The type of the <see cref="IAuthenticationHandler"/>.</typeparam>
-public abstract class AuthenticationSchemeOAuthClientOptionsResolver<TClientOptions, TOptions, THandler> : IOAuthOptionsResolver
+public abstract class AuthenticationSchemeOAuthClientOptionsResolver<
+    [DynamicallyAccessedMembers(DynamicallyAccessedMemberTypes.PublicParameterlessConstructor)] TClientOptions,
+    [DynamicallyAccessedMembers(DynamicallyAccessedMemberTypes.PublicParameterlessConstructor)] TOptions,
+    THandler>
+    : IOAuthOptionsResolver
     where TClientOptions : AuthenticationSchemeOptions
     where TOptions : RemoteAuthenticationOptions
     where THandler : IAuthenticationHandler
diff --git a/Http/src/AppCoreNet.Extensions.Http.Authentication.OAuth.AspNetCore/AuthenticationSessionOAuthUserTokenStore.cs b/Http/src/AppCoreNet.Extensions.Http.Authentication.OAuth.AspNetCore/AuthenticationSessionOAuthUserTokenStore.cs
@@ -2,6 +2,7 @@
 // Copyright (c) The AppCore .NET project.
 
 using System.Collections.Generic;
+using System.Diagnostics.CodeAnalysis;
 using System.Security.Authentication;
 using System.Security.Claims;
 using System.Threading;
@@ -20,7 +21,9 @@ namespace AppCoreNet.Extensions.Http.Authentication.OAuth.AspNetCore;
 /// session.
 /// </summary>
 /// <typeparam name="TOptions">The type of the <see cref="OAuthUserOptions"/>.</typeparam>
-public abstract class AuthenticationSessionOAuthUserTokenStore<TOptions> : IOAuthUserTokenStore
+public abstract class AuthenticationSessionOAuthUserTokenStore<
+    [DynamicallyAccessedMembers(DynamicallyAccessedMemberTypes.PublicParameterlessConstructor)] TOptions>
+    : IOAuthUserTokenStore
     where TOptions : OAuthUserOptions
 {
     private readonly IHttpContextAccessor _httpContextAccessor;
diff --git a/Http/src/AppCoreNet.Extensions.Http.Authentication.OAuth.AspNetCore/OAuthUserHandler.cs b/Http/src/AppCoreNet.Extensions.Http.Authentication.OAuth.AspNetCore/OAuthUserHandler.cs
@@ -16,7 +16,7 @@ namespace AppCoreNet.Extensions.Http.Authentication.OAuth.AspNetCore;
 /// Provides a base class for a OAuth user authentication handler.
 /// </summary>
 /// <typeparam name="TParameters">The type of the <see cref="OAuthUserParameters"/>.</typeparam>
-public abstract class OAuthUserHandler<TParameters> : IAuthenticationSchemeHandler<TParameters>
+public abstract class OAuthUserHandler<TParameters> : IAuthenticationSchemeHandler
     where TParameters : OAuthUserParameters
 {
     private readonly IHttpContextAccessor _httpContextAccessor;
@@ -42,7 +42,14 @@ protected OAuthUserHandler(IHttpContextAccessor httpContextAccessor, IOAuthUserT
     /// <param name="scheme">The <see cref="AuthenticationScheme"/>.</param>
     protected abstract void EnsureCompatibleScheme(AuthenticationScheme scheme);
 
-    /// <inheritdoc />
+    /// <summary>
+    /// Authenticates a <see cref="HttpRequestMessage"/> with the specified OAuth user scheme and parameters.
+    /// </summary>
+    /// <param name="scheme">The <see cref="AuthenticationScheme"/>.</param>
+    /// <param name="request">The <see cref="HttpRequestMessage"/>.</param>
+    /// <param name="parameters">The <see cref="OAuthUserParameters"/>.</param>
+    /// <param name="cancellationToken">A <see cref="CancellationToken"/>.</param>
+    /// <returns>The asynchronous operation.</returns>
     public async Task AuthenticateAsync(
         AuthenticationScheme scheme,
         HttpRequestMessage request,
@@ -64,4 +71,18 @@ await _authTokenService.GetAccessTokenAsync(scheme, user, parameters, cancellati
 
         request.Headers.Authorization = new AuthenticationHeaderValue("Bearer", accessToken.AccessToken);
     }
+
+    async Task IAuthenticationSchemeHandler.AuthenticateAsync(
+        AuthenticationScheme scheme,
+        HttpRequestMessage request,
+        AuthenticationParameters? parameters,
+        CancellationToken cancellationToken)
+    {
+        await AuthenticateAsync(
+                scheme,
+                request,
+                (TParameters?)parameters,
+                cancellationToken)
+            .ConfigureAwait(false);
+    }
 }
diff --git a/Http/src/AppCoreNet.Extensions.Http.Authentication.OAuth.AspNetCore/OAuthUserTokenService.cs b/Http/src/AppCoreNet.Extensions.Http.Authentication.OAuth.AspNetCore/OAuthUserTokenService.cs
@@ -20,7 +20,9 @@ namespace AppCoreNet.Extensions.Http.Authentication.OAuth.AspNetCore;
 /// Provides the base class for see <see cref="IOAuthUserTokenService"/>.
 /// </summary>
 /// <typeparam name="TOptions">The type of the <see cref="OAuthUserOptions"/>.</typeparam>
-public abstract class OAuthUserTokenService<TOptions> : IOAuthUserTokenService
+public abstract class OAuthUserTokenService<
+    [DynamicallyAccessedMembers(DynamicallyAccessedMemberTypes.PublicParameterlessConstructor)] TOptions>
+    : IOAuthUserTokenService
     where TOptions : OAuthUserOptions
 {
     private static readonly ConcurrentDictionary<string, Lazy<Task<OAuthUserToken>>> _sync = new();
diff --git a/Http/src/AppCoreNet.Extensions.Http.Authentication.OAuth.OpenIdConnect/AppCoreNet.Extensions.Http.Authentication.OAuth.OpenIdConnect.csproj b/Http/src/AppCoreNet.Extensions.Http.Authentication.OAuth.OpenIdConnect/AppCoreNet.Extensions.Http.Authentication.OAuth.OpenIdConnect.csproj
@@ -7,6 +7,8 @@
       from ASP.NET Core OpenID connect authentication schemes.
     </Description>
     <PackageTags>$(PackageTags);Security;Authentication;OAuth;OAuth2;OAuth 2.0;IdentityModel;ASP.NET Core;OpenID Connect</PackageTags>
+    <!-- Without this, ILLink analyzers are not added, even though 'IsAotComptabile' is set in the parent 'Directory.Build.props' -->
+    <IsAotCompatible Condition="$([MSBuild]::IsTargetFrameworkCompatible('$(TargetFramework)', 'net8.0'))">true</IsAotCompatible>
   </PropertyGroup>
 
   <ItemGroup>
diff --git a/Http/src/AppCoreNet.Extensions.Http.Authentication.OAuth/OAuthClientHandler.cs b/Http/src/AppCoreNet.Extensions.Http.Authentication.OAuth/OAuthClientHandler.cs
@@ -12,7 +12,7 @@ namespace AppCoreNet.Extensions.Http.Authentication.OAuth;
 /// <summary>
 /// Provides a OAuth client authentication handler.
 /// </summary>
-public class OAuthClientHandler : IAuthenticationSchemeHandler<OAuthParameters>
+public class OAuthClientHandler : IAuthenticationSchemeHandler
 {
     private readonly IOAuthTokenService _authTokenService;
 
@@ -26,7 +26,14 @@ public OAuthClientHandler(IOAuthTokenService authTokenService)
         _authTokenService = authTokenService;
     }
 
-    /// <inheritdoc />
+    /// <summary>
+    /// Authenticates a <see cref="HttpRequestMessage"/> with the specified OAuth client scheme and parameters.
+    /// </summary>
+    /// <param name="scheme">The <see cref="AuthenticationScheme"/>.</param>
+    /// <param name="request">The <see cref="HttpRequestMessage"/>.</param>
+    /// <param name="parameters">The <see cref="OAuthParameters"/>.</param>
+    /// <param name="cancellationToken">A <see cref="CancellationToken"/>.</param>
+    /// <returns>The asynchronous operation.</returns>
     public async Task AuthenticateAsync(
         AuthenticationScheme scheme,
         HttpRequestMessage request,
@@ -39,4 +46,18 @@ await _authTokenService.GetClientAccessTokenAsync(scheme, parameters, cancellati
 
         request.Headers.Authorization = new AuthenticationHeaderValue("Bearer", accessToken.AccessToken);
     }
+
+    async Task IAuthenticationSchemeHandler.AuthenticateAsync(
+        AuthenticationScheme scheme,
+        HttpRequestMessage request,
+        AuthenticationParameters? parameters,
+        CancellationToken cancellationToken)
+    {
+        await AuthenticateAsync(
+                scheme,
+                request,
+                (OAuthParameters?)parameters,
+                cancellationToken)
+            .ConfigureAwait(false);
+    }
 }
diff --git a/Http/src/AppCoreNet.Extensions.Http.Authentication.OAuth/OAuthOptionsResolver.cs b/Http/src/AppCoreNet.Extensions.Http.Authentication.OAuth/OAuthOptionsResolver.cs
@@ -2,12 +2,15 @@
 // Copyright (c) The AppCore .NET project.
 
 using System;
+using System.Diagnostics.CodeAnalysis;
 using System.Threading.Tasks;
 using Microsoft.Extensions.Options;
 
 namespace AppCoreNet.Extensions.Http.Authentication.OAuth;
 
-internal sealed class OAuthOptionsResolver<TOptions> : IOAuthOptionsResolver
+internal sealed class OAuthOptionsResolver<
+    [DynamicallyAccessedMembers(DynamicallyAccessedMemberTypes.PublicParameterlessConstructor)] TOptions>
+    : IOAuthOptionsResolver
     where TOptions : OAuthOptions
 {
     private readonly IOptionsMonitor<TOptions> _options;
diff --git a/Http/src/AppCoreNet.Extensions.Http.Authentication.OAuth/OAuthPasswordHandler.cs b/Http/src/AppCoreNet.Extensions.Http.Authentication.OAuth/OAuthPasswordHandler.cs
@@ -1,4 +1,7 @@
-﻿using System.Net.Http;
+﻿// Licensed under the MIT license.
+// Copyright (c) The AppCore .NET project.
+
+using System.Net.Http;
 using System.Net.Http.Headers;
 using System.Threading;
 using System.Threading.Tasks;
@@ -9,7 +12,7 @@ namespace AppCoreNet.Extensions.Http.Authentication.OAuth;
 /// <summary>
 /// Provides a OAuth password authentication handler.
 /// </summary>
-public class OAuthPasswordHandler : IAuthenticationSchemeHandler<OAuthParameters>
+public class OAuthPasswordHandler : IAuthenticationSchemeHandler
 {
     private readonly IOAuthTokenService _authTokenService;
 
@@ -23,7 +26,14 @@ public OAuthPasswordHandler(IOAuthTokenService authTokenService)
         _authTokenService = authTokenService;
     }
 
-    /// <inheritdoc />
+    /// <summary>
+    /// Authenticates a <see cref="HttpRequestMessage"/> with the specified OAuth password scheme and parameters.
+    /// </summary>
+    /// <param name="scheme">The <see cref="AuthenticationScheme"/>.</param>
+    /// <param name="request">The <see cref="HttpRequestMessage"/>.</param>
+    /// <param name="parameters">The <see cref="OAuthParameters"/>.</param>
+    /// <param name="cancellationToken">A <see cref="CancellationToken"/>.</param>
+    /// <returns>The asynchronous operation.</returns>
     public async Task AuthenticateAsync(
         AuthenticationScheme scheme,
         HttpRequestMessage request,
@@ -36,4 +46,18 @@ await _authTokenService.GetPasswordAccessTokenAsync(scheme, parameters, cancella
 
         request.Headers.Authorization = new AuthenticationHeaderValue("Bearer", accessToken.AccessToken);
     }
+
+    async Task IAuthenticationSchemeHandler.AuthenticateAsync(
+        AuthenticationScheme scheme,
+        HttpRequestMessage request,
+        AuthenticationParameters? parameters,
+        CancellationToken cancellationToken)
+    {
+        await AuthenticateAsync(
+                scheme,
+                request,
+                (OAuthParameters?)parameters,
+                cancellationToken)
+            .ConfigureAwait(false);
+    }
 }
diff --git a/Http/src/AppCoreNet.Extensions.Http.Authentication/AuthenticationHandler.cs b/Http/src/AppCoreNet.Extensions.Http.Authentication/AuthenticationHandler.cs
@@ -16,14 +16,14 @@ namespace AppCoreNet.Extensions.Http.Authentication;
 /// authentication to the request.
 /// </summary>
 /// <typeparam name="TParameters">The type of the <see cref="AuthenticationParameters"/>.</typeparam>
-/// <typeparam name="THandler">The type of the <see cref="IAuthenticationSchemeHandler{TParameters}"/>.</typeparam>
+/// <typeparam name="THandler">The type of the <see cref="IAuthenticationSchemeHandler"/>.</typeparam>
 public class AuthenticationHandler<TParameters, THandler> : DelegatingHandler
     where TParameters : AuthenticationParameters, new()
-    where THandler : IAuthenticationSchemeHandler<TParameters>
+    where THandler : IAuthenticationSchemeHandler
 {
     private readonly string _scheme;
     private readonly IAuthenticationSchemeProvider _schemes;
-    private readonly IAuthenticationSchemeHandler<TParameters> _schemeHandler;
+    private readonly IAuthenticationSchemeHandler _schemeHandler;
     private readonly TParameters? _parameters;
     private readonly ILogger _logger;
 
diff --git a/Http/src/AppCoreNet.Extensions.Http.Authentication/AuthenticationScheme.cs b/Http/src/AppCoreNet.Extensions.Http.Authentication/AuthenticationScheme.cs
@@ -17,7 +17,7 @@ public sealed class AuthenticationScheme
     public string Name { get; }
 
     /// <summary>
-    /// Gets the type of the <see cref="IAuthenticationSchemeHandler{TParameters}"/> which handles the scheme.
+    /// Gets the type of the <see cref="IAuthenticationSchemeHandler"/> which handles the scheme.
     /// </summary>
     public Type HandlerType { get; }
 
@@ -26,22 +26,31 @@ public sealed class AuthenticationScheme
     /// </summary>
     public Type OptionsType { get; }
 
+    /// <summary>
+    /// Gets the type of the <see cref="AuthenticationParameters"/>.
+    /// </summary>
+    public Type ParametersType { get; }
+
     /// <summary>
     /// Initializes a new instance of the <see cref="AuthenticationScheme"/> class.
     /// </summary>
     /// <param name="name">The name of the authentication scheme.</param>
-    /// <param name="handlerType">The type of the <see cref="IAuthenticationSchemeHandler{TParameters}"/> which handles the scheme.</param>
+    /// <param name="handlerType">The type of the <see cref="IAuthenticationSchemeHandler"/> which handles the scheme.</param>
     /// <param name="optionsType">The type of the <see cref="AuthenticationSchemeOptions"/>.</param>
-    public AuthenticationScheme(string name, Type handlerType, Type optionsType)
+    /// <param name="parametersType">The type of the <see cref="AuthenticationParameters"/>.</param>
+    public AuthenticationScheme(string name, Type handlerType, Type optionsType, Type parametersType)
     {
         Ensure.Arg.NotNull(name);
         Ensure.Arg.NotNull(handlerType);
-        Ensure.Arg.OfType(handlerType, typeof(IAuthenticationSchemeHandler<>));
+        Ensure.Arg.OfType<IAuthenticationSchemeHandler>(handlerType);
         Ensure.Arg.NotNull(optionsType);
-        Ensure.Arg.OfType(optionsType, typeof(AuthenticationSchemeOptions));
+        Ensure.Arg.OfType<AuthenticationSchemeOptions>(optionsType);
+        Ensure.Arg.NotNull(parametersType);
+        Ensure.Arg.OfType<AuthenticationParameters>(parametersType);
 
         Name = name;
         HandlerType = handlerType;
         OptionsType = optionsType;
+        ParametersType = parametersType;
     }
 }
diff --git a/Http/src/AppCoreNet.Extensions.Http.Authentication/AuthenticationSchemeHandler.cs b/Http/src/AppCoreNet.Extensions.Http.Authentication/AuthenticationSchemeHandler.cs
@@ -1,6 +1,7 @@
 ﻿// Licensed under the MIT license.
 // Copyright (c) The AppCore .NET project.
 
+using System.Diagnostics.CodeAnalysis;
 using System.Net.Http;
 using System.Threading;
 using System.Threading.Tasks;
@@ -10,11 +11,13 @@
 namespace AppCoreNet.Extensions.Http.Authentication;
 
 /// <summary>
-/// Provides a base class for <see cref="IAuthenticationSchemeHandler{TParameters}"/>.
+/// Provides a base class for <see cref="IAuthenticationSchemeHandler"/>.
 /// </summary>
 /// <typeparam name="TOptions">The type of the <see cref="AuthenticationSchemeOptions"/>.</typeparam>
 /// <typeparam name="TParameters">The type of the <see cref="AuthenticationParameters"/>.</typeparam>
-public abstract class AuthenticationSchemeHandler<TOptions, TParameters> : IAuthenticationSchemeHandler<TParameters>
+public abstract class AuthenticationSchemeHandler<
+    [DynamicallyAccessedMembers(DynamicallyAccessedMemberTypes.PublicParameterlessConstructor)] TOptions, TParameters>
+    : IAuthenticationSchemeHandler
     where TOptions : AuthenticationSchemeOptions
     where TParameters : AuthenticationParameters, new()
 {
@@ -46,13 +49,18 @@ protected abstract Task AuthenticateAsync(
         HttpRequestMessage request,
         CancellationToken cancellationToken);
 
-    async Task IAuthenticationSchemeHandler<TParameters>.AuthenticateAsync(
+    async Task IAuthenticationSchemeHandler.AuthenticateAsync(
         AuthenticationScheme scheme,
         HttpRequestMessage request,
-        TParameters? parameters,
+        AuthenticationParameters? parameters,
         CancellationToken cancellationToken)
     {
-        await AuthenticateAsync(scheme, _optionsMonitor.Get(scheme.Name), parameters, request, cancellationToken)
+        await AuthenticateAsync(
+                scheme,
+                _optionsMonitor.Get(scheme.Name),
+                (TParameters?)parameters,
+                request,
+                cancellationToken)
             .ConfigureAwait(false);
     }
 }
diff --git a/Http/src/AppCoreNet.Extensions.Http.Authentication/DependencyInjection/AuthenticationHttpClientBuilderExtensions.cs b/Http/src/AppCoreNet.Extensions.Http.Authentication/DependencyInjection/AuthenticationHttpClientBuilderExtensions.cs
@@ -26,14 +26,14 @@ private static string GetLoggerName(IHttpClientBuilder builder)
     /// <param name="scheme">The authentication scheme.</param>
     /// <param name="parameters">Additional authentication parameters.</param>
     /// <typeparam name="TParameters">The type of the <see cref="AuthenticationParameters"/>.</typeparam>
-    /// <typeparam name="THandler">The type of the <see cref="IAuthenticationSchemeHandler{TParameters}"/>.</typeparam>
+    /// <typeparam name="THandler">The type of the <see cref="IAuthenticationSchemeHandler"/>.</typeparam>
     /// <returns>The passed <see cref="IHttpClientBuilder"/>.</returns>
     public static IHttpClientBuilder AddAuthentication<TParameters, THandler>(
         this IHttpClientBuilder builder,
         string scheme,
         TParameters? parameters)
         where TParameters : AuthenticationParameters, new()
-        where THandler : IAuthenticationSchemeHandler<TParameters>
+        where THandler : IAuthenticationSchemeHandler
     {
         Ensure.Arg.NotNull(builder);
         Ensure.Arg.NotNull(scheme);
diff --git a/Http/src/AppCoreNet.Extensions.Http.Authentication/DependencyInjection/HttpClientAuthenticationBuilderExtensions.cs b/Http/src/AppCoreNet.Extensions.Http.Authentication/DependencyInjection/HttpClientAuthenticationBuilderExtensions.cs
diff --git a/Http/src/AppCoreNet.Extensions.Http.Authentication/HttpClientAuthenticationOptions.cs b/Http/src/AppCoreNet.Extensions.Http.Authentication/HttpClientAuthenticationOptions.cs
diff --git a/Http/src/AppCoreNet.Extensions.Http.Authentication/IAuthenticationSchemeHandler.cs b/Http/src/AppCoreNet.Extensions.Http.Authentication/IAuthenticationSchemeHandler.cs
diff --git a/Http/src/Directory.Build.props b/Http/src/Directory.Build.props
diff --git a/Http/test/AppCoreNet.Extensions.Http.Authentication.Tests/AuthenticationSchemeProviderTests.cs b/Http/test/AppCoreNet.Extensions.Http.Authentication.Tests/AuthenticationSchemeProviderTests.cs
