Made ctor of ValidationParameters public (#480)

* Made ctor of ValidationParameters public * Set default values for boolean properties to true * Update tests * Bumped version to 10.1.1 * Update CHANGELOG.md --------- Co-authored-by: Alexander Batishchev <[email protected]>
jwt-dotnet · Sep 27, 2023 · bc9d9d2 · bc9d9d2
1 parent 2c76ee0
commit bc9d9d2
Show file tree

Hide file tree

Showing 4 changed files with 78 additions and 13 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,9 @@
 # Unreleased
 
+# 10.1.1
+
+- Made ctor of ValidationParameters public, set default values for boolean properties to true
+
 # 10.1.0
 
 - Unmarked HMAC SHA based algorithms as insecure and obsolete (was done in 9.0.0-beta4)

diff --git a/src/JWT/JWT.csproj b/src/JWT/JWT.csproj
@@ -25,7 +25,7 @@
   </PropertyGroup>
 
   <PropertyGroup>
-    <Version>10.1.0</Version>
+    <Version>10.1.1</Version>
     <FileVersion>10.0.0.0</FileVersion>
     <AssemblyVersion>10.0.0.0</AssemblyVersion>
   </PropertyGroup>

diff --git a/src/JWT/ValidationParameters.cs b/src/JWT/ValidationParameters.cs
@@ -8,27 +8,28 @@ namespace JWT
     public class ValidationParameters
     {
         /// <remarks>
+        /// By default, all peroperties are set to <c>true</c> to ensure validation is enabled.
         /// Use <see cref="Default"/> if you'd like to set all properties set to <see langword="true" />
         /// or use <see cref="None"/> if you'd like to set all properties set to <see langword="false" />.
         /// </remarks>>
-        private ValidationParameters()
+        public ValidationParameters()
         {
         }
 
         /// <summary>
         /// Gets or sets whether to validate the validity of the token's signature.
         /// </summary>
-        public bool ValidateSignature { get; set; }
+        public bool ValidateSignature { get; set; } = true;
 
         /// <summary>
         /// Gets or sets whether to validate the validity of the token's expiration time.
         /// </summary>
-        public bool ValidateExpirationTime { get; set; }
+        public bool ValidateExpirationTime { get; set; } = true;
 
         /// <summary>
         /// Gets or sets whether to validate the validity of the token's issued time.
         /// </summary>
-        public bool ValidateIssuedTime { get; set; }
+        public bool ValidateIssuedTime { get; set; } = true;
 
         /// <summary>
         /// Gets or sets the time margin in seconds for exp and nbf during token validation.
@@ -38,13 +39,7 @@ private ValidationParameters()
         /// <summary>
         /// Returns a <see cref="ValidationParameters" /> with all properties set to <see langword="true" />.
         /// </summary>
-        public static ValidationParameters Default => new ValidationParameters
-        {
-            ValidateSignature = true,
-            ValidateExpirationTime = true,
-            ValidateIssuedTime = true,
-            TimeMargin = 0
-        };
+        public static ValidationParameters Default => new ValidationParameters();
 
         /// <summary>
         /// Returns a <see cref="ValidationParameters" /> with all properties set to <see langword="false" />.

diff --git a/tests/JWT.Tests.Common/JwtValidatorTests.cs b/tests/JWT.Tests.Common/JwtValidatorTests.cs
@@ -378,7 +378,73 @@ public void TryValidate_Should_Return_True_And_Exception_Null_When_Token_Is_Not_
                    .BeTrue("because token should be valid");
 
         }
-
+
+        [TestMethod]
+        public void ValidationParameters_Ctor_Should_Set_All_Validation_To_True()
+        {
+            var valParams = new ValidationParameters();
+
+            valParams.ValidateSignature.Should()
+                     .BeTrue("because ValidationParameters constructor should set ValidateSignature to true");
+            valParams.ValidateExpirationTime.Should()
+                     .BeTrue("because ValidationParameters constructor should set ValidateExpirationTime to true");
+            valParams.ValidateIssuedTime.Should()
+                     .BeTrue("because ValidationParameters constructor should set ValidateIssuedTime to true");
+            valParams.TimeMargin.Should()
+                     .Be(0, "because ValidationParameters constructor should set TimeMargin to 0");
+        }
+
+        [TestMethod]
+        public void ValidationParameters_Ctor_Should_Allow_Default_Values_To_Be_Overriden()
+        {
+            var valParams = new ValidationParameters
+            {
+                ValidateSignature = false,
+                ValidateExpirationTime = false,
+                ValidateIssuedTime = false,
+                TimeMargin = 300
+            };
+
+            valParams.ValidateSignature.Should()
+                     .BeFalse("because ValidationParameters constructor should allow ValidateSignature to be overridden");
+            valParams.ValidateExpirationTime.Should()
+                     .BeFalse("because ValidationParameters constructor should allow ValidateExpirationTime to be overridden");
+            valParams.ValidateIssuedTime.Should()
+                     .BeFalse("because ValidationParameters constructor should allow ValidateIssuedTime to be overridden");
+            valParams.TimeMargin.Should()
+                     .Be(300, "because ValidationParameters constructor should allow TimeMargin to be overridden");
+        }
+
+        [TestMethod]
+        public void ValidationParameters_Default_Should_Set_All_Validation_To_True()
+        {
+            var valParams = ValidationParameters.Default;
+
+            valParams.ValidateSignature.Should()
+                     .BeTrue("because ValidationParameters.Default should set ValidateSignature to true");
+            valParams.ValidateExpirationTime.Should()
+                     .BeTrue("because ValidationParameters.Default should set ValidateExpirationTime to true");
+            valParams.ValidateIssuedTime.Should()
+                     .BeTrue("because ValidationParameters.Default should set ValidateIssuedTime to true");
+            valParams.TimeMargin.Should()
+                     .Be(0, "because ValidationParameters.Default should set TimeMargin to 0");
+        }
+
+        [TestMethod]
+        public void ValidationParameters_None_Should_Set_All_Validation_To_False()
+        {
+            var valParams = ValidationParameters.None;
+
+            valParams.ValidateSignature.Should()
+                     .BeFalse("because ValidationParameters.None should set ValidateSignature to false");
+            valParams.ValidateExpirationTime.Should()
+                     .BeFalse("because ValidationParameters.DefaNoneult should set ValidateExpirationTime to false");
+            valParams.ValidateIssuedTime.Should()
+                     .BeFalse("because ValidationParameters.None should set ValidateIssuedTime to false");
+            valParams.TimeMargin.Should()
+                     .Be(0, "because ValidationParameters.Default should set TimeMargin to 0");
+        }
+
         private static IJsonSerializer CreateSerializer() =>
             new DefaultJsonSerializerFactory().Create();
     }