Merge pull request #10 from dozer75/add-additional-headers-support

Add additional headers support
dozer75 · Jan 14, 2025 · 12b56a2 · 12b56a2
2 parents 5fb6709 + f23ea75
commit 12b56a2
Show file tree

Hide file tree

Showing 37 changed files with 414 additions and 227 deletions.
diff --git a/.github/workflows/master-pr.yml b/.github/workflows/master-pr.yml
@@ -22,10 +22,10 @@ jobs:
     steps:
     - name: Checkout source
       uses: actions/checkout@v4
-    - name: Setup .NET 8.0.x
+    - name: Setup .NET 9.0.x
       uses: actions/setup-dotnet@v4
       with:
-        dotnet-version: '8.0.x'
+        dotnet-version: '9.0.x'
     - name: Restore solution
       run: dotnet restore
     - name: Build solution

diff --git a/.github/workflows/master-publish.yml b/.github/workflows/master-publish.yml
@@ -16,10 +16,10 @@ jobs:
         echo "VERSION=${VERSION#v}" >> $GITHUB_ENV
     - name: Checkout source
       uses: actions/checkout@v4
-    - name: Setup .NET 8.0.x
+    - name: Setup .NET 9.0.x
       uses: actions/setup-dotnet@v4
       with:
-        dotnet-version: '8.0.x'
+        dotnet-version: '9.0.x'
     - name: Restore solution
       run: dotnet restore
     - name: Build solution (pre-release)

diff --git a/.github/workflows/master-push.yml b/.github/workflows/master-push.yml
@@ -19,10 +19,10 @@ jobs:
     steps:
     - name: Checkout source
       uses: actions/checkout@v4
-    - name: Setup .NET 8.0.x
+    - name: Setup .NET 9.0.x
       uses: actions/setup-dotnet@v4
       with:
-        dotnet-version: '8.0.x'
+        dotnet-version: '9.0.x'
     - name: Restore solution
       run: dotnet restore
     - name: Build solution

diff --git a/.gitignore b/.gitignore
@@ -344,5 +344,8 @@ healthchecksdb
 /test/coverage.opencover.xml
 /test/result.json
 
+# POC related
+/poc
+
 # Custom exclusions
 *.AssemblyAttributes
diff --git a/README.md b/README.md
@@ -11,11 +11,6 @@ The package currently supports the following authentication methods:
 - OAuth2
   - Client credentials
 
-> Please note: The .NET Standard 2.0 and .NET 6 targeted packages references the LTS version 6 of the dependent 
-NuGet packages. The reason for this is that while it is possible to run .NET 7 NuGet packages on .NET 6, it is known that some 
-of them may introduce unexpected behavior. It is recommended (especially from the ASP.NET Core team) limit usage of .NET 7 
-based NuGet packages on .NET 6 runtime.
-
 ## USAGE
 
 Add the NuGet package `KISS.HttpClientAuthentication` to your project and whenever a 
@@ -75,16 +70,25 @@ Authentication using OAuth2.
 
 ##### Client credentials
 
-Using OAuth2 client credentials, all settings except `DisableTokenCache` and `Scope` is required.
+Using OAuth2 client credentials, all settings except `DisableTokenCache`, `Scope` and
+`TokenEndpoint`'s `Additional*Parameters` is required.
 
 ```
 "<section name>": {
   "AuthenticationProvider": "OAuth2",
   "OAuth2": {
-    "AuthorizationEndpoint": "<OAuth2 token endpoint>",
     "DisableTokenCache": false,
     "GrantType": "ClientCredentials",
     "Scope": "<Optional scopes separated by space>",
+    "TokenEndpoint": {
+        "Url": "<OAuth2 token endpoint>",
+        "AdditionalHeaderParameters": {
+        },
+        "AdditionalBodyParameters": {
+        },
+        "AdditionalQueryParameters": {
+        }
+    },
     "ClientCredentials": {
         "ClientId": "<Unique client id>",
         "ClientSecret": "<Secret connected to the client id>"
@@ -93,6 +97,9 @@ Using OAuth2 client credentials, all settings except `DisableTokenCache` and `Sc
 }
 ```
 
+The `Additional*Parameters` configuration is dynamic, any configuration in these will 
+be added to their respective parts of the request accordingly. Please note that the 
+`AdditionalQueryParameters` will be url encoded.
 
 ### Examples
 

diff --git a/src/HttpClientAuthentication/AssemblyInfo.cs b/src/HttpClientAuthentication/AssemblyInfo.cs
@@ -1,4 +1,4 @@
-// Copyright © 2024 Rune Gulbrandsen.
+// Copyright © 2025 Rune Gulbrandsen.
 // All rights reserved. Licensed under the MIT License; see LICENSE.txt.
 
 using System.Runtime.CompilerServices;

diff --git a/src/HttpClientAuthentication/Configuration/ApiKeyConfiguration.cs b/src/HttpClientAuthentication/Configuration/ApiKeyConfiguration.cs
@@ -1,4 +1,4 @@
-// Copyright © 2024 Rune Gulbrandsen.
+// Copyright © 2025 Rune Gulbrandsen.
 // All rights reserved. Licensed under the MIT License; see LICENSE.txt.
 
 namespace KISS.HttpClientAuthentication.Configuration

diff --git a/src/HttpClientAuthentication/Configuration/BasicConfiguration.cs b/src/HttpClientAuthentication/Configuration/BasicConfiguration.cs
@@ -1,4 +1,4 @@
-// Copyright © 2024 Rune Gulbrandsen.
+// Copyright © 2025 Rune Gulbrandsen.
 // All rights reserved. Licensed under the MIT License; see LICENSE.txt.
 
 namespace KISS.HttpClientAuthentication.Configuration

diff --git a/src/HttpClientAuthentication/Configuration/ClientCredentialsConfiguration.cs b/src/HttpClientAuthentication/Configuration/ClientCredentialsConfiguration.cs
@@ -1,4 +1,4 @@
-// Copyright © 2024 Rune Gulbrandsen.
+// Copyright © 2025 Rune Gulbrandsen.
 // All rights reserved. Licensed under the MIT License; see LICENSE.txt.
 
 namespace KISS.HttpClientAuthentication.Configuration

diff --git a/src/HttpClientAuthentication/Configuration/HttpClientAuthenticationConfiguration.cs b/src/HttpClientAuthentication/Configuration/HttpClientAuthenticationConfiguration.cs
@@ -1,4 +1,4 @@
-// Copyright © 2024 Rune Gulbrandsen.
+// Copyright © 2025 Rune Gulbrandsen.
 // All rights reserved. Licensed under the MIT License; see LICENSE.txt.
 
 using KISS.HttpClientAuthentication.Constants;

diff --git a/src/HttpClientAuthentication/Configuration/OAuth2Configuration.cs b/src/HttpClientAuthentication/Configuration/OAuth2Configuration.cs
@@ -1,4 +1,4 @@
-// Copyright © 2024 Rune Gulbrandsen.
+// Copyright © 2025 Rune Gulbrandsen.
 // All rights reserved. Licensed under the MIT License; see LICENSE.txt.
 
 using KISS.HttpClientAuthentication.Constants;
@@ -10,12 +10,6 @@ namespace KISS.HttpClientAuthentication.Configuration
     /// </summary>
     public sealed class OAuth2Configuration
     {
-        /// <summary>
-        ///     Gets or sets the authorization endpoint used by some <see cref="AuthenticationProvider"/>
-        ///     configuration.
-        /// </summary>
-        public Uri AuthorizationEndpoint { get; set; } = default!;
-
         /// <summary>
         ///     Gets or sets the authorization scheme to use if <see cref="AuthenticationHeader"/> is 
         ///     Authorization or the selected <see cref="AuthenticationProvider"/> uses Authorization as default header.
@@ -47,5 +41,13 @@ public sealed class OAuth2Configuration
         ///     Scopes must be separated with a space.
         /// </remarks>
         public string? Scope { get; set; }
+
+        /// <summary>
+        ///     Gets or sets the token endpoint.
+        /// </summary>
+        /// <remarks>
+        ///     Replaces <see cref="AuthorizationEndpoint"/>.
+        /// </remarks>
+        public OAuth2Endpoint TokenEndpoint { get; set; } = default!;
     }
 }
diff --git a/src/HttpClientAuthentication/Configuration/OAuth2Endpoint.cs b/src/HttpClientAuthentication/Configuration/OAuth2Endpoint.cs
@@ -0,0 +1,40 @@
+// Copyright © 2025 Rune Gulbrandsen.
+// All rights reserved. Licensed under the MIT License; see LICENSE.txt.
+
+namespace KISS.HttpClientAuthentication.Configuration
+{
+    /// <summary>
+    ///     Endpoint configuration for OAuth2 endpoints
+    /// </summary>
+    public sealed partial class OAuth2Endpoint
+    {
+        /// <summary>
+        ///     Gets or sets the Url to the OAuth2 endpoint.
+        /// </summary>
+        public Uri Url { get; set; } = default!;
+
+        /// <summary>
+        ///     Gets a dictionary that can contain additional headers that will be
+        ///     supplied when requesting <see cref="Url"/>.
+        /// </summary>
+        public Dictionary<string, string> AdditionalHeaderParameters { get; } = [];
+
+
+        /// <summary>
+        ///     Gets a collection of additional form body parameters that will be
+        ///     supplied when requesting <see cref="Url"/>.
+        /// </summary>
+        public Dictionary<string, string> AdditionalBodyParameters { get; } = [];
+
+        /// <summary>
+        ///     Gets a collection of additional query string parameters that will
+        ///     be supplied when requesting <see cref="Url"/>.
+        /// </summary>
+        public Dictionary<string, string> AdditionalQueryParameters { get; } = [];
+
+        public override string ToString()
+        {
+            return Url.ToString();
+        }
+    }
+}
diff --git a/src/HttpClientAuthentication/Constants/AuthenticationProvider.cs b/src/HttpClientAuthentication/Constants/AuthenticationProvider.cs
@@ -1,4 +1,4 @@
-// Copyright © 2024 Rune Gulbrandsen.
+// Copyright © 2025 Rune Gulbrandsen.
 // All rights reserved. Licensed under the MIT License; see LICENSE.txt.
 
 namespace KISS.HttpClientAuthentication.Constants

diff --git a/src/HttpClientAuthentication/Constants/OAuth2GrantType.cs b/src/HttpClientAuthentication/Constants/OAuth2GrantType.cs
@@ -1,4 +1,4 @@
-// Copyright © 2024 Rune Gulbrandsen.
+// Copyright © 2025 Rune Gulbrandsen.
 // All rights reserved. Licensed under the MIT License; see LICENSE.txt.
 
 namespace KISS.HttpClientAuthentication.Constants

diff --git a/src/HttpClientAuthentication/Constants/OAuth2Keyword.cs b/src/HttpClientAuthentication/Constants/OAuth2Keyword.cs
@@ -1,4 +1,4 @@
-// Copyright © 2024 Rune Gulbrandsen.
+// Copyright © 2025 Rune Gulbrandsen.
 // All rights reserved. Licensed under the MIT License; see LICENSE.txt.
 
 namespace KISS.HttpClientAuthentication.Constants

diff --git a/src/HttpClientAuthentication/Handlers/ApiKeyAuthenticationHandler.cs b/src/HttpClientAuthentication/Handlers/ApiKeyAuthenticationHandler.cs
@@ -1,4 +1,4 @@
-// Copyright © 2024 Rune Gulbrandsen.
+// Copyright © 2025 Rune Gulbrandsen.
 // All rights reserved. Licensed under the MIT License; see LICENSE.txt.
 
 using KISS.HttpClientAuthentication.Configuration;

diff --git a/src/HttpClientAuthentication/Handlers/BaseAuthenticationHandler.cs b/src/HttpClientAuthentication/Handlers/BaseAuthenticationHandler.cs
@@ -1,4 +1,4 @@
-// Copyright © 2024 Rune Gulbrandsen.
+// Copyright © 2025 Rune Gulbrandsen.
 // All rights reserved. Licensed under the MIT License; see LICENSE.txt.
 
 namespace KISS.HttpClientAuthentication.Handlers

diff --git a/src/HttpClientAuthentication/Handlers/BasicAuthenticationHandler.cs b/src/HttpClientAuthentication/Handlers/BasicAuthenticationHandler.cs
@@ -1,4 +1,4 @@
-// Copyright © 2024 Rune Gulbrandsen.
+// Copyright © 2025 Rune Gulbrandsen.
 // All rights reserved. Licensed under the MIT License; see LICENSE.txt.
 
 using System.Net.Http.Headers;

diff --git a/src/HttpClientAuthentication/Handlers/NoAuthenticationHandler.cs b/src/HttpClientAuthentication/Handlers/NoAuthenticationHandler.cs
@@ -1,4 +1,4 @@
-// Copyright © 2024 Rune Gulbrandsen.
+// Copyright © 2025 Rune Gulbrandsen.
 // All rights reserved. Licensed under the MIT License; see LICENSE.txt.
 
 namespace KISS.HttpClientAuthentication.Handlers

diff --git a/src/HttpClientAuthentication/Handlers/OAuth2AuthenticationHandler.cs b/src/HttpClientAuthentication/Handlers/OAuth2AuthenticationHandler.cs
@@ -1,4 +1,4 @@
-// Copyright © 2024 Rune Gulbrandsen.
+// Copyright © 2025 Rune Gulbrandsen.
 // All rights reserved. Licensed under the MIT License; see LICENSE.txt.
 
 using System.Net.Http.Headers;

diff --git a/src/HttpClientAuthentication/Helpers/AccessTokenResponse.cs b/src/HttpClientAuthentication/Helpers/AccessTokenResponse.cs
@@ -1,4 +1,4 @@
-// Copyright © 2024 Rune Gulbrandsen.
+// Copyright © 2025 Rune Gulbrandsen.
 // All rights reserved. Licensed under the MIT License; see LICENSE.txt.
 
 using System.Text.Json.Serialization;

diff --git a/src/HttpClientAuthentication/Helpers/ErrorResponse.cs b/src/HttpClientAuthentication/Helpers/ErrorResponse.cs
@@ -1,4 +1,4 @@
-// Copyright © 2024 Rune Gulbrandsen.
+// Copyright © 2025 Rune Gulbrandsen.
 // All rights reserved. Licensed under the MIT License; see LICENSE.txt.
 
 using System.Text.Json.Serialization;

diff --git a/src/HttpClientAuthentication/Helpers/IOAuth2Provider.cs b/src/HttpClientAuthentication/Helpers/IOAuth2Provider.cs
@@ -1,4 +1,4 @@
-// Copyright © 2024 Rune Gulbrandsen.
+// Copyright © 2025 Rune Gulbrandsen.
 // All rights reserved. Licensed under the MIT License; see LICENSE.txt.
 
 using KISS.HttpClientAuthentication.Configuration;