Added OpenID Connect user authentication.

Author: prochnowc

AppCore.Extensions.sln

@@ -64,7 +64,7 @@ Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "WorkerService", "Http\sampl
 EndProject
 Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "AppCore.Extensions.Http.Authentication.OAuth.AspNetCore", "Http\src\AppCore.Extensions.Http.Authentication.OAuth.AspNetCore\AppCore.Extensions.Http.Authentication.OAuth.AspNetCore.csproj", "{9301436D-85F6-4845-AAD6-33103F49F018}"
 EndProject
-Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "AppCore.Extensions.Http.Authentication.OAuth.AspNetCore.OpenIdConnect", "Http\src\AppCore.Extensions.Http.Authentication.OAuth.AspNetCore.OpenIdConnect\AppCore.Extensions.Http.Authentication.OAuth.AspNetCore.OpenIdConnect.csproj", "{91754F75-CC7A-48C8-A133-9F087BE10CFE}"
+Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "AppCore.Extensions.Http.Authentication.OAuth.OpenIdConnect", "Http\src\AppCore.Extensions.Http.Authentication.OAuth.OpenIdConnect\AppCore.Extensions.Http.Authentication.OAuth.OpenIdConnect.csproj", "{91754F75-CC7A-48C8-A133-9F087BE10CFE}"
 EndProject
 Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Web", "Http\samples\Web\Web.csproj", "{7D72ABA6-5EBE-491A-A599-65D15FD10308}"
 EndProject

Http/samples/Web/Web.csproj

@@ -6,7 +6,7 @@
     </PropertyGroup>
 
     <ItemGroup>
-      <ProjectReference Include="..\..\src\AppCore.Extensions.Http.Authentication.OAuth.AspNetCore.OpenIdConnect\AppCore.Extensions.Http.Authentication.OAuth.AspNetCore.OpenIdConnect.csproj" />
+      <ProjectReference Include="..\..\src\AppCore.Extensions.Http.Authentication.OAuth.OpenIdConnect\AppCore.Extensions.Http.Authentication.OAuth.OpenIdConnect.csproj" />
     </ItemGroup>
 
 </Project>

Http/src/AppCore.Extensions.Http.Authentication.OAuth.AspNetCore.OpenIdConnect/OpenIdConnectUserHandler.cs

@@ -1,4 +1,7 @@
-using System.Collections.Generic;
+// Licensed under the MIT License.
+// Copyright (c) 2018-2022 the AppCore .NET project.
+
+using System.Collections.Generic;
 using System.Security.Authentication;
 using System.Security.Claims;
 using System.Threading;
@@ -12,6 +15,11 @@
 
 namespace AppCore.Extensions.Http.Authentication.OAuth.AspNetCore;
 
+/// <summary>
+/// Provides the base class for <see cref="IOAuthUserTokenStore"/> which stores tokens in the authentication
+/// session.
+/// </summary>
+/// <typeparam name="TOptions">The type of the <see cref="OAuthUserOptions"/>.</typeparam>
 public abstract class AuthenticationSessionOAuthUserTokenStore<TOptions> : IOAuthUserTokenStore
     where TOptions : OAuthUserOptions
 {
@@ -23,6 +31,12 @@ public abstract class AuthenticationSessionOAuthUserTokenStore<TOptions> : IOAut
     // this requires this service to be added as scoped to the DI system
     private readonly Dictionary<string, AuthenticateResult> _cache = new();
 
+    /// <summary>
+    /// Initializes a new instance of the <see cref="AuthenticationSessionOAuthUserTokenStore{TOptions}"/> class.
+    /// </summary>
+    /// <param name="httpContextAccessor">The <see cref="IHttpContextAccessor"/>.</param>
+    /// <param name="optionsMonitor">The <see cref="IOptionsMonitor{TOptions}"/>.</param>
+    /// <param name="logger">The <see cref="ILogger{TCategoryName}"/>.</param>
     protected AuthenticationSessionOAuthUserTokenStore(
         IHttpContextAccessor httpContextAccessor,
         IOptionsMonitor<TOptions> optionsMonitor,
@@ -67,7 +81,7 @@ private async Task<string> GetSignInScheme(HttpContext context, TOptions options
         return scheme;
     }
 
-    private async Task<AuthenticateResult?> TryAuthenticateAsync(HttpContext httpContext, string signInScheme, TOptions options)
+    private async Task<AuthenticateResult?> TryAuthenticateAsync(HttpContext httpContext, string signInScheme)
     {
         // check the cache in case the token was re-issued via StoreTokenAsync
         if (!_cache.TryGetValue(signInScheme, out AuthenticateResult? result))
@@ -92,13 +106,17 @@ private async Task<string> GetSignInScheme(HttpContext context, TOptions options
         return result;
     }
 
+    /// <summary>
+    /// Ensures that the <paramref name="scheme"/> is compatible.
+    /// </summary>
+    /// <param name="scheme">The <see cref="AuthenticationScheme"/>.</param>
     protected abstract void EnsureCompatibleScheme(AuthenticationScheme scheme);
 
+    /// <inheritdoc />
     public async Task StoreTokenAsync(
         AuthenticationScheme scheme,
         ClaimsPrincipal user,
         OAuthUserToken token,
-        OAuthUserParameters? parameters = null,
         CancellationToken cancellationToken = default)
     {
         Ensure.Arg.NotNull(scheme);
@@ -111,12 +129,12 @@ public async Task StoreTokenAsync(
         TOptions options = _optionsMonitor.Get(scheme.Name);
         string signInScheme = await GetSignInScheme(httpContext, options);
 
-        AuthenticateResult? result = await TryAuthenticateAsync(httpContext, signInScheme, options);
+        AuthenticateResult? result = await TryAuthenticateAsync(httpContext, signInScheme);
         if (result == null)
             throw new AuthenticationException("User is not authenticated, cannot store tokens.");
 
         ClaimsPrincipal principal = result.Principal!;
-        SetUserToken(principal, result.Properties!, token, options);
+        StoreToken(principal, result.Properties!, token, options);
 
         if (result.Properties!.AllowRefresh.GetValueOrDefault(true))
         {
@@ -128,16 +146,23 @@ public async Task StoreTokenAsync(
         _cache[signInScheme] = AuthenticateResult.Success(new AuthenticationTicket(principal, result.Properties, signInScheme));
     }
 
-    protected abstract void SetUserToken(
+    /// <summary>
+    /// Stores the token in the authentication session.
+    /// </summary>
+    /// <param name="principal"></param>
+    /// <param name="properties"></param>
+    /// <param name="token"></param>
+    /// <param name="options"></param>
+    protected abstract void StoreToken(
         ClaimsPrincipal principal,
         AuthenticationProperties properties,
         OAuthUserToken token,
         TOptions options);
 
+    /// <inheritdoc />
     public async Task<OAuthUserToken> GetTokenAsync(
         AuthenticationScheme scheme,
         ClaimsPrincipal user,
-        OAuthUserParameters? parameters = null,
         CancellationToken cancellationToken = default)
     {
         Ensure.Arg.NotNull(scheme);
@@ -149,22 +174,29 @@ public async Task<OAuthUserToken> GetTokenAsync(
         TOptions options = _optionsMonitor.Get(scheme.Name);
         string signInScheme = await GetSignInScheme(httpContext, options);
 
-        AuthenticateResult? result = await TryAuthenticateAsync(httpContext, signInScheme, options);
+        AuthenticateResult? result = await TryAuthenticateAsync(httpContext, signInScheme);
         if (result == null)
             throw new AuthenticationException("User is not authenticated, cannot get tokens.");
 
-        return GetUserToken(result.Principal!, result.Properties!, options);
+        return GetToken(result.Principal!, result.Properties!, options);
     }
 
-    protected abstract OAuthUserToken GetUserToken(
+    /// <summary>
+    /// Gets the token from the authentication session.
+    /// </summary>
+    /// <param name="principal"></param>
+    /// <param name="properties"></param>
+    /// <param name="options"></param>
+    /// <returns></returns>
+    protected abstract OAuthUserToken GetToken(
         ClaimsPrincipal principal,
         AuthenticationProperties properties,
         TOptions options);
 
+    /// <inheritdoc />
     public Task ClearTokenAsync(
         AuthenticationScheme scheme,
         ClaimsPrincipal user,
-        OAuthUserParameters? parameters = null,
         CancellationToken cancellationToken = default)
     {
         Ensure.Arg.NotNull(scheme);

Http/src/AppCore.Extensions.Http.Authentication.OAuth.AspNetCore.OpenIdConnect/OpenIdConnectUserOptions.cs

@@ -32,11 +32,9 @@ Task<OAuthUserToken> GetAccessTokenAsync(
     /// </summary>
     /// <param name="scheme">The <see cref="AuthenticationScheme"/>.</param>
     /// <param name="user">The user.</param>
-    /// <param name="parameters">Optional parameters.</param>
     /// <param name="cancellationToken"></param>
     Task RevokeRefreshTokenAsync(
         AuthenticationScheme scheme,
         ClaimsPrincipal user,
-        OAuthUserParameters? parameters = null,
         CancellationToken cancellationToken = default);
 }

Http/src/AppCore.Extensions.Http.Authentication.OAuth.AspNetCore.OpenIdConnect/OpenIdConnectUserParameters.cs

@@ -1,27 +1,49 @@
-using System.Security.Claims;
+// Licensed under the MIT License.
+// Copyright (c) 2018-2022 the AppCore .NET project.
+
+using System.Security.Claims;
 using System.Threading;
 using System.Threading.Tasks;
 
 namespace AppCore.Extensions.Http.Authentication.OAuth.AspNetCore;
 
+/// <summary>
+/// Abstraction for the OAuth user token store.
+/// </summary>
 public interface IOAuthUserTokenStore
 {
+    /// <summary>
+    /// Stores the token for the specified authentication scheme and user.
+    /// </summary>
+    /// <param name="scheme">The <see cref="AuthenticationScheme"/>.</param>
+    /// <param name="user">The <see cref="ClaimsPrincipal"/>.</param>
+    /// <param name="token">The <see cref="OAuthUserToken"/>.</param>
+    /// <param name="cancellationToken">Optional <see cref="CancellationToken"/>.</param>
     Task StoreTokenAsync(
         AuthenticationScheme scheme,
         ClaimsPrincipal user,
         OAuthUserToken token,
-        OAuthUserParameters? parameters = null,
         CancellationToken cancellationToken = default);
 
+    /// <summary>
+    /// Gets the token for the specified authentication scheme and user.
+    /// </summary>
+    /// <param name="scheme">The <see cref="AuthenticationScheme"/>.</param>
+    /// <param name="user">The <see cref="ClaimsPrincipal"/>.</param>
+    /// <param name="cancellationToken">Optional <see cref="CancellationToken"/>.</param>
     Task<OAuthUserToken> GetTokenAsync(
         AuthenticationScheme scheme,
         ClaimsPrincipal user,
-        OAuthUserParameters? parameters = null,
         CancellationToken cancellationToken = default);
 
+    /// <summary>
+    /// Clears the token for the specified authentication scheme and user.
+    /// </summary>
+    /// <param name="scheme">The <see cref="AuthenticationScheme"/>.</param>
+    /// <param name="user">The <see cref="ClaimsPrincipal"/>.</param>
+    /// <param name="cancellationToken">Optional <see cref="CancellationToken"/>.</param>
     Task ClearTokenAsync(
         AuthenticationScheme scheme,
         ClaimsPrincipal user,
-        OAuthUserParameters? parameters = null,
         CancellationToken cancellationToken = default);
 }

Http/src/AppCore.Extensions.Http.Authentication.OAuth.AspNetCore.OpenIdConnect/OpenIdConnectUserTokenService.cs

@@ -1,4 +1,7 @@
-using System.Net.Http;
+// Licensed under the MIT License.
+// Copyright (c) 2018-2022 the AppCore .NET project.
+
+using System.Net.Http;
 using System.Net.Http.Headers;
 using System.Security.Authentication;
 using System.Security.Claims;
@@ -10,7 +13,7 @@
 namespace AppCore.Extensions.Http.Authentication.OAuth.AspNetCore;
 
 /// <summary>
-/// Provides a OAuth user authentication handler.
+/// Provides a base class for a OAuth user authentication handler.
 /// </summary>
 public abstract class OAuthUserHandler<TParameters> : IAuthenticationSchemeHandler<TParameters>
     where TParameters : OAuthUserParameters
@@ -32,13 +35,24 @@ protected OAuthUserHandler(IHttpContextAccessor httpContextAccessor, IOAuthUserT
         _authTokenService = authTokenService;
     }
 
+    /// <summary>
+    /// Ensures that the <paramref name="scheme"/> is compatible.
+    /// </summary>
+    /// <param name="scheme">The <see cref="AuthenticationScheme"/>.</param>
+    protected abstract void EnsureCompatibleScheme(AuthenticationScheme scheme);
+
     /// <inheritdoc />
     public async Task AuthenticateAsync(
         AuthenticationScheme scheme,
-        TParameters? parameters,
         HttpRequestMessage request,
+        TParameters? parameters = null,
         CancellationToken cancellationToken = default)
     {
+        Ensure.Arg.NotNull(scheme);
+        Ensure.Arg.NotNull(request);
+
+        EnsureCompatibleScheme(scheme);
+
         ClaimsPrincipal? user = _httpContextAccessor.HttpContext?.User;
         if (user == null)
             throw new AuthenticationException("User is not authenticated.");