From ad1e0bd9d0c044c431135ab79da9057f5264a581 Mon Sep 17 00:00:00 2001
From: Ignacio Inglese <iinglese@microsoft.com>
Date: Wed, 20 Nov 2024 16:55:01 +0000
Subject: [PATCH] Added custom validation delegates and validation errors for
 issuer signing key extensibility testing

---
 ...stomIssuerSigningKeyValidationDelegates.cs | 144 ++++++++++++++++++
 .../CustomValidationErrors.cs                 |  47 ++++++
 2 files changed, 191 insertions(+)
 create mode 100644 test/Microsoft.IdentityModel.TestUtils/TokenValidationExtensibility/CustomIssuerSigningKeyValidationDelegates.cs

diff --git a/test/Microsoft.IdentityModel.TestUtils/TokenValidationExtensibility/CustomIssuerSigningKeyValidationDelegates.cs b/test/Microsoft.IdentityModel.TestUtils/TokenValidationExtensibility/CustomIssuerSigningKeyValidationDelegates.cs
new file mode 100644
index 0000000000..32b3a3ec85
--- /dev/null
+++ b/test/Microsoft.IdentityModel.TestUtils/TokenValidationExtensibility/CustomIssuerSigningKeyValidationDelegates.cs
@@ -0,0 +1,144 @@
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT License.
+
+using System;
+using Microsoft.IdentityModel.Tokens;
+
+#nullable enable
+namespace Microsoft.IdentityModel.TestUtils
+{
+    internal class CustomIssuerSigningKeyValidationDelegates
+    {
+        internal static ValidationResult<ValidatedSigningKeyLifetime> CustomIssuerSigningKeyValidatorDelegate(
+            SecurityKey signingKey,
+            SecurityToken securityToken,
+            ValidationParameters validationParameters,
+            BaseConfiguration? configuration,
+            CallContext callContext)
+        {
+            // Returns a CustomIssuerSigningKeyValidationError : IssuerSigningKeyValidationError
+            return new CustomIssuerSigningKeyValidationError(
+                new MessageDetail(nameof(CustomIssuerSigningKeyValidatorDelegate), null),
+                typeof(SecurityTokenInvalidSigningKeyException),
+                ValidationError.GetCurrentStackFrame(),
+                signingKey,
+                null);
+        }
+
+        internal static ValidationResult<ValidatedSigningKeyLifetime> CustomIssuerSigningKeyValidatorCustomExceptionDelegate(
+            SecurityKey signingKey,
+            SecurityToken securityToken,
+            ValidationParameters validationParameters,
+            BaseConfiguration? configuration,
+            CallContext callContext)
+        {
+            return new CustomIssuerSigningKeyValidationError(
+                new MessageDetail(nameof(CustomIssuerSigningKeyValidatorCustomExceptionDelegate), null),
+                typeof(CustomSecurityTokenInvalidSigningKeyException),
+                ValidationError.GetCurrentStackFrame(),
+                signingKey,
+                null);
+        }
+
+        internal static ValidationResult<ValidatedSigningKeyLifetime> CustomIssuerSigningKeyValidatorCustomExceptionCustomFailureTypeDelegate(
+            SecurityKey signingKey,
+            SecurityToken securityToken,
+            ValidationParameters validationParameters,
+            BaseConfiguration? configuration,
+            CallContext callContext)
+        {
+            return new CustomIssuerSigningKeyValidationError(
+                new MessageDetail(nameof(CustomIssuerSigningKeyValidatorCustomExceptionCustomFailureTypeDelegate), null),
+                typeof(CustomSecurityTokenInvalidSigningKeyException),
+                ValidationError.GetCurrentStackFrame(),
+                signingKey,
+                CustomIssuerSigningKeyValidationError.CustomIssuerSigningKeyValidationFailureType);
+        }
+
+        internal static ValidationResult<ValidatedSigningKeyLifetime> CustomIssuerSigningKeyValidatorUnknownExceptionDelegate(
+            SecurityKey signingKey,
+            SecurityToken securityToken,
+            ValidationParameters validationParameters,
+            BaseConfiguration? configuration,
+            CallContext callContext)
+        {
+            return new CustomIssuerSigningKeyValidationError(
+                new MessageDetail(nameof(CustomIssuerSigningKeyValidatorUnknownExceptionDelegate), null),
+                typeof(NotSupportedException),
+                ValidationError.GetCurrentStackFrame(),
+                signingKey,
+                null);
+        }
+
+        internal static ValidationResult<ValidatedSigningKeyLifetime> CustomIssuerSigningKeyValidatorWithoutGetExceptionOverrideDelegate(
+            SecurityKey signingKey,
+            SecurityToken securityToken,
+            ValidationParameters validationParameters,
+            BaseConfiguration? configuration,
+            CallContext callContext)
+        {
+            return new CustomIssuerSigningKeyWithoutGetExceptionValidationOverrideError(
+                new MessageDetail(nameof(CustomIssuerSigningKeyValidatorWithoutGetExceptionOverrideDelegate), null),
+                typeof(CustomSecurityTokenInvalidSigningKeyException),
+                ValidationError.GetCurrentStackFrame(),
+                signingKey,
+                null);
+        }
+
+        internal static ValidationResult<ValidatedSigningKeyLifetime> IssuerSigningKeyValidatorDelegate(
+            SecurityKey signingKey,
+            SecurityToken securityToken,
+            ValidationParameters validationParameters,
+            BaseConfiguration? configuration,
+            CallContext callContext)
+        {
+            return new IssuerSigningKeyValidationError(
+                new MessageDetail(nameof(IssuerSigningKeyValidatorDelegate), null),
+                typeof(SecurityTokenInvalidSigningKeyException),
+                ValidationError.GetCurrentStackFrame(),
+                signingKey,
+                null);
+        }
+
+        internal static ValidationResult<ValidatedSigningKeyLifetime> IssuerSigningKeyValidatorThrows(
+            SecurityKey signingKey,
+            SecurityToken securityToken,
+            ValidationParameters validationParameters,
+            BaseConfiguration? configuration,
+            CallContext callContext)
+        {
+            throw new CustomSecurityTokenInvalidSigningKeyException(nameof(IssuerSigningKeyValidatorThrows), null);
+        }
+
+        internal static ValidationResult<ValidatedSigningKeyLifetime> IssuerSigningKeyValidatorCustomIssuerSigningKeyExceptionTypeDelegate(
+            SecurityKey signingKey,
+            SecurityToken securityToken,
+            ValidationParameters validationParameters,
+            BaseConfiguration? configuration,
+            CallContext callContext)
+        {
+            return new IssuerSigningKeyValidationError(
+                new MessageDetail(nameof(IssuerSigningKeyValidatorCustomIssuerSigningKeyExceptionTypeDelegate), null),
+                typeof(CustomSecurityTokenInvalidSigningKeyException),
+                ValidationError.GetCurrentStackFrame(),
+                signingKey,
+                null);
+        }
+
+        internal static ValidationResult<ValidatedSigningKeyLifetime> IssuerSigningKeyValidatorCustomExceptionTypeDelegate(
+            SecurityKey signingKey,
+            SecurityToken securityToken,
+            ValidationParameters validationParameters,
+            BaseConfiguration? configuration,
+            CallContext callContext)
+        {
+            return new IssuerSigningKeyValidationError(
+                new MessageDetail(nameof(IssuerSigningKeyValidatorCustomExceptionTypeDelegate), null),
+                typeof(CustomSecurityTokenException),
+                ValidationError.GetCurrentStackFrame(),
+                signingKey,
+                null);
+        }
+    }
+}
+#nullable restore
diff --git a/test/Microsoft.IdentityModel.TestUtils/TokenValidationExtensibility/CustomValidationErrors.cs b/test/Microsoft.IdentityModel.TestUtils/TokenValidationExtensibility/CustomValidationErrors.cs
index e5274bd2f8..339eacb805 100644
--- a/test/Microsoft.IdentityModel.TestUtils/TokenValidationExtensibility/CustomValidationErrors.cs
+++ b/test/Microsoft.IdentityModel.TestUtils/TokenValidationExtensibility/CustomValidationErrors.cs
@@ -157,6 +157,53 @@ public CustomLifetimeWithoutGetExceptionValidationOverrideError(
     }
     #endregion
 
+    #region IssuerSigningKeyValidationErrors
+    internal class CustomIssuerSigningKeyValidationError : IssuerSigningKeyValidationError
+    {
+        /// <summary>
+        /// A custom validation failure type.
+        /// </summary>
+        public static readonly ValidationFailureType CustomIssuerSigningKeyValidationFailureType = new IssuerSigningKeyValidationFailure("CustomIssuerSigningKeyValidationFailureType");
+        private class IssuerSigningKeyValidationFailure : ValidationFailureType { internal IssuerSigningKeyValidationFailure(string name) : base(name) { } }
+
+        public CustomIssuerSigningKeyValidationError(
+            MessageDetail messageDetail,
+            Type exceptionType,
+            StackFrame stackFrame,
+            SecurityKey? securityKey,
+            ValidationFailureType? validationFailureType = null,
+            Exception? innerException = null)
+            : base(messageDetail, exceptionType, stackFrame, securityKey, validationFailureType, innerException)
+        {
+        }
+
+        internal override Exception GetException()
+        {
+            if (ExceptionType == typeof(CustomSecurityTokenInvalidSigningKeyException))
+            {
+                var exception = new CustomSecurityTokenInvalidSigningKeyException(MessageDetail.Message, InnerException) { SigningKey = InvalidSigningKey };
+                exception.SetValidationError(this);
+                return exception;
+            }
+            return base.GetException();
+        }
+    }
+
+    internal class CustomIssuerSigningKeyWithoutGetExceptionValidationOverrideError : IssuerSigningKeyValidationError
+    {
+        public CustomIssuerSigningKeyWithoutGetExceptionValidationOverrideError(
+            MessageDetail messageDetail,
+            Type exceptionType,
+            StackFrame stackFrame,
+            SecurityKey? securityKey,
+            ValidationFailureType? failureType = null,
+            Exception? innerException = null)
+            : base(messageDetail, exceptionType, stackFrame, securityKey, failureType, innerException)
+        {
+        }
+    }
+    #endregion // IssuerSigningKeyValidationErrors
+
     // Other custom validation errors to be added here for signature validation, issuer signing key, etc.
 }
 #nullable restore