Custom typ header (#285)

* Checking if 'typ' header is presented in extra headers before adding default value * Update tests * Bumped version to 7.2.1
jwt-dotnet · May 21, 2020 · d9670e2 · d9670e2
1 parent 9e8a083
commit d9670e2
Show file tree

Hide file tree

Showing 4 changed files with 31 additions and 4 deletions.
diff --git a/src/JWT/JWT.csproj b/src/JWT/JWT.csproj
@@ -18,7 +18,7 @@
     <Authors>Alexander Batishchev, John Sheehan, Michael Lehenbauer</Authors>
     <PackageTags>jwt;json</PackageTags>
     <PackageLicense>CC0-1.0</PackageLicense>
-    <Version>7.2.0</Version>
+    <Version>7.2.1</Version>
     <FileVersion>7.0.0.0</FileVersion>
     <AssemblyVersion>7.0.0.0</AssemblyVersion>
     <RootNamespace>JWT</RootNamespace>

diff --git a/src/JWT/JwtEncoder.cs b/src/JWT/JwtEncoder.cs
@@ -39,8 +39,12 @@ public string Encode(IDictionary<string, object> extraHeaders, object payload, b
 
             var segments = new List<string>(3);
 
-            var header = extraHeaders is null ? new Dictionary<string, object>(StringComparer.OrdinalIgnoreCase) : new Dictionary<string, object>(extraHeaders, StringComparer.OrdinalIgnoreCase);
-            header.Add("typ", "JWT");
+            var header = extraHeaders is null ?
+                new Dictionary<string, object>(StringComparer.OrdinalIgnoreCase) :
+                new Dictionary<string, object>(extraHeaders, StringComparer.OrdinalIgnoreCase);
+
+            if (!header.ContainsKey("typ"))
+                header.Add("typ", "JWT");
             header.Add("alg", _algorithm.Name);
 
             var headerBytes = GetBytes(_jsonSerializer.Serialize(header));
@@ -58,4 +62,4 @@ public string Encode(IDictionary<string, object> extraHeaders, object payload, b
             return String.Join(".", segments.ToArray());
         }
     }
-}
+}
diff --git a/tests/JWT.Tests.Common/JwtEncoderTests.cs b/tests/JWT.Tests.Common/JwtEncoderTests.cs
@@ -49,5 +49,27 @@ public void Encode_Should_Encode_To_Token_With_Extra_Headers()
             actual.Should()
                   .Be(expected, "because the same data encoded with the same key must result in the same token");
         }
+
+        [TestMethod]
+        public void Encode_Should_Encode_To_Token_With_Custom_Type_Headers()
+        {
+            var extraHeaders = new Dictionary<string, object>
+            {
+                { "typ", "foo" }
+            };
+            const string key = TestData.Secret;
+            var toEncode = TestData.Customer;
+            const string expected = TestData.TokenWithCustomTypeHeader;
+
+            var algorithm = new HMACSHA256Algorithm();
+            var urlEncoder = new JwtBase64UrlEncoder();
+            var serializer = new JsonNetSerializer();
+            var encoder = new JwtEncoder(algorithm, serializer, urlEncoder);
+
+            var actual = encoder.Encode(extraHeaders, toEncode, key);
+
+            actual.Should()
+                  .Be(expected, "because the same data encoded with the same key must result in the same token");
+        }
     }
 }
diff --git a/tests/JWT.Tests.Common/Models/TestData.cs b/tests/JWT.Tests.Common/Models/TestData.cs
@@ -20,6 +20,7 @@ public static class TestData
 
         public const string Token = "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJGaXJzdE5hbWUiOiJKZXN1cyIsIkFnZSI6MzN9.jBdQNPhChZpZSMZX6Z5okc7YJ3dc5esWp4YCtasYXFU";
         public const string TokenWithExtraHeaders = "eyJmb28iOiJiYXIiLCJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJGaXJzdE5hbWUiOiJKZXN1cyIsIkFnZSI6MzN9.QQJaPxDE6E7l-zC-LKTbEgPfId5FDvowRKww1o6jdwU";
+        public const string TokenWithCustomTypeHeader = "eyJ0eXAiOiJmb28iLCJhbGciOiJIUzI1NiJ9.eyJGaXJzdE5hbWUiOiJKZXN1cyIsIkFnZSI6MzN9.vubwuLxx_7AWGvo-Y8XF_l7XP1WOv5obJulIk3RlVdk";
 
         public const string TokenWithIncorrectSignature = "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJGaXJzdE5hbWUiOiJCb2IiLCJBZ2UiOjM3fQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c";
         public const string TokenWithoutHeader = "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9eyJGaXJzdE5hbWUiOiJCb2IiLCJBZ2UiOjM3fQ.oj1ROhq6SyGDG3C0WIPe8wDuMJjA47uKwXCHkxl6Zy0";