Improved exception messages.

Updated README.md

Author: prochnowc

Http/README.md

@@ -3,6 +3,9 @@ AppCore .NET add-ons for Microsoft.Extensions.Http
 
 This project contains add-ons for the `Microsoft.Extensions.Http` library. It adds authentication support to the `IHttpCLientFactory`.
 
+## Features
+
+
 ## Packages
 
 Latest development packages can be found on [MyGet](https://www.myget.org/gallery/appcorenet).
@@ -12,3 +15,44 @@ Latest development packages can be found on [MyGet](https://www.myget.org/galler
 | `AppCore.Extensions.Http.Authentication`                                | Provides extensions which adds support for authenticating a HttpClient using different authentication standards.  |
 | `AppCore.Extensions.Http.Authentication.OAuth`                          | Adds support for authenticating a HttpClient using OAuth2 bearer tokens.                                          |
 | `AppCore.Extensions.Http.Authentication.OAuth.AspNetCore.OpenIdConnect` | Adds support for deriving token client configuration from ASP.NET Core OpenID connect authentication schemes.     |
+
+## Usage
+
+To add transparent authentication to a `HttpClient` which is built using the `IHttpClientFactory` you first have to register a client authentication scheme.
+Currently OAuth2 client credentials and password flow is supported out-of-the-box. Custom schemes can be easily added.
+
+After registering the scheme you have to configure the `IHttpClientFactory` to use the authentication handler. That's all.
+
+Add the package to your project:
+
+```shell
+> dotnet add package AppCore.Extensions.Http.Authentication.OAuth
+```
+
+Register a client authentication scheme, the following sample uses client credential authentication.
+
+```csharp
+services.AddHttpClientAuthentication()
+        .AddOAuthClient("catalog.client",
+                        o => {
+                          o.TokenEndpoint = "https://demo.duendesoftware.com/connect/token";
+                          o.ClientId = "6f59b670-990f-4ef7-856f-0dd584ed1fac";
+                          o.ClientSecret = "d0c17c6a-ba47-4654-a874-f6d576cdf799";
+                          o.Scope = "catalog inventory";
+                        });
+```
+
+Configure your HTTP client to use the authentication scheme:
+
+```csharp
+services.AddHttpClient("CatalogClient")
+        .AddOAuthClientAuthentication("catalog.client");
+```
+
+For frontend apps it is also possible to infer the OAuth client configuration from the ASP.Net Core
+OIDC authentication scheme.
+
+```csharp
+services.AddHttpClientAuthentication()
+        .AddOAuthClientForScheme(o => { o.OpenIdConnect() });
+```

Http/src/AppCore.Extensions.Http.Authentication.OAuth/OAuthAccessToken.cs

@@ -9,7 +9,7 @@ namespace AppCore.Extensions.Http.Authentication.OAuth;
 /// <summary>
 /// Represents a OAuth access token.
 /// </summary>
-public class OAuthAccessToken
+public sealed class OAuthAccessToken
 {
     /// <summary>
     /// Gets the access token.

Http/src/AppCore.Extensions.Http.Authentication.OAuth/OAuthOptionsProvider.cs

@@ -43,7 +43,7 @@ public virtual async Task<T> GetOptionsAsync<T>(AuthenticationScheme scheme)
         if (result == null)
         {
             throw new InvalidOperationException(
-                $"No options of type {typeof(T)} could be resolved for client authentication scheme {scheme.Name}.");
+                $"No options of type '{typeof(T)}' could be resolved for client authentication scheme {scheme.Name}.");
         }
 
         return result;

Http/src/AppCore.Extensions.Http.Authentication.OAuth/OAuthOptionsValidator.cs

@@ -13,17 +13,17 @@ protected List<string> Validate(string name, OAuthOptions options)
 
         if (options.TokenEndpoint == null)
         {
-            errors.Add($"Token endpoint for OAuth authentication scheme {name} must not be null.");
+            errors.Add($"Token endpoint for OAuth authentication scheme '{name}' must not be null.");
         }
 
         if (string.IsNullOrWhiteSpace(options.ClientId))
         {
-            errors.Add($"ClientId for OAuth authentication scheme {name} must not be null or empty.");
+            errors.Add($"ClientId for OAuth authentication scheme '{name}' must not be null or empty.");
         }
 
         if (string.IsNullOrWhiteSpace(options.ClientSecret))
         {
-            errors.Add($"ClientSecret for OAuth authentication scheme {name} must not be null or empty.");
+            errors.Add($"ClientSecret for OAuth authentication scheme '{name}' must not be null or empty.");
         }
 
         return errors;

Http/src/AppCore.Extensions.Http.Authentication.OAuth/OAuthTokenCache.cs

@@ -117,11 +117,11 @@ await _cache.GetAsync(cacheKey, cancellationToken)
 
         if (result != null)
         {
-            _logger.LogDebug("Cache hit for access token for scheme: {schemeName}", scheme.Name);
+            _logger.LogTrace("Cache hit for access token for scheme: {schemeName}", scheme.Name);
         }
         else
         {
-            _logger.LogDebug("Cache miss for access token for scheme: {schemeName}", scheme.Name);
+            _logger.LogTrace("Cache miss for access token for scheme: {schemeName}", scheme.Name);
         }
 
         return result;

Http/src/AppCore.Extensions.Http.Authentication.OAuth/OAuthTokenService.cs

@@ -95,7 +95,7 @@ await _client.RequestClientAccessToken(scheme, parameters, cancellationToken)
                             response.ErrorDescription);
 
                         throw new AuthenticationException(
-                            $"Error requesting access token for client scheme {scheme.Name}");
+                            $"Error requesting access token for client scheme '{scheme.Name}'");
                     }
 
                     OAuthAccessToken token = new(
@@ -158,7 +158,7 @@ await _client.RequestPasswordAccessToken(scheme, parameters, cancellationToken)
                             response.ErrorDescription);
 
                         throw new AuthenticationException(
-                            $"Error requesting access token for password scheme {scheme.Name}");
+                            $"Error requesting access token for password scheme '{scheme.Name}'");
                     }
 
                     OAuthAccessToken token = new(

Http/src/AppCore.Extensions.Http.Authentication/AuthenticationHandler.cs

@@ -62,13 +62,13 @@ await _schemes.FindSchemeAsync(_scheme)
 
         if (authenticationScheme == null)
         {
-            throw new InvalidOperationException($"There is no client authentication scheme registered with name {_scheme}.");
+            throw new InvalidOperationException($"There is no client authentication scheme registered with name '{_scheme}'.");
         }
 
         if (authenticationScheme.HandlerType != typeof(THandler))
         {
             throw new InvalidOperationException(
-                $"There is no client authentication scheme registered with name {_scheme} and handler {typeof(THandler).Name}.");
+                $"There is no client authentication scheme registered with name '{_scheme}' and handler '{typeof(THandler).Name}'.");
         }
 
         return authenticationScheme;
@@ -82,7 +82,7 @@ protected override async Task<HttpResponseMessage> SendAsync(
         AuthenticationScheme scheme = await GetSchemeAsync()
             .ConfigureAwait(false);
 
-        _logger.LogDebug("Authenticating HTTP request with scheme {schemeName}.", scheme.Name);
+        _logger.LogTrace("Authenticating HTTP request with scheme {schemeName}.", scheme.Name);
 
         await AuthenticateAsync(scheme, request, forceRenewal: false, cancellationToken)
             .ConfigureAwait(false);

Http/src/AppCore.Extensions.Http.Authentication/AuthenticationScheme.cs

@@ -9,7 +9,7 @@ namespace AppCore.Extensions.Http.Authentication;
 /// <summary>
 /// Represents a registered authentication scheme.
 /// </summary>
-public class AuthenticationScheme
+public sealed class AuthenticationScheme
 {
     /// <summary>
     /// The name of the authentication scheme.