-
Notifications
You must be signed in to change notification settings - Fork 414
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Added signature extensibility tests for JWT, SAML, and SAML2
- Loading branch information
Showing
3 changed files
with
806 additions
and
0 deletions.
There are no files selected for viewing
266 changes: 266 additions & 0 deletions
266
...icrosoft.IdentityModel.JsonWebTokens.Tests/JsonWebTokenHandler.Extensibility.Signature.cs
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,266 @@ | ||
| // Copyright (c) Microsoft Corporation. All rights reserved. | ||
| // Licensed under the MIT License. | ||
|
|
||
| using System; | ||
| using System.Diagnostics; | ||
| using System.Threading; | ||
| using System.Threading.Tasks; | ||
| using Microsoft.IdentityModel.JsonWebTokens.Tests; | ||
| using Microsoft.IdentityModel.Logging; | ||
| using Microsoft.IdentityModel.TestUtils; | ||
| using Microsoft.IdentityModel.Tokens; | ||
| using Microsoft.IdentityModel.Tokens.Json.Tests; | ||
| using Xunit; | ||
|
|
||
| #nullable enable | ||
| namespace Microsoft.IdentityModel.JsonWebTokens.Extensibility.Tests | ||
| { | ||
| public partial class JsonWebTokenHandlerValidateTokenAsyncTests | ||
| { | ||
| [Theory, MemberData(nameof(Signature_ExtensibilityTestCases), DisableDiscoveryEnumeration = true)] | ||
| public async Task ValidateTokenAsync_SignatureValidator_Extensibility(SignatureExtensibilityTheoryData theoryData) | ||
| { | ||
| var context = TestUtilities.WriteHeader($"{this}.{nameof(ValidateTokenAsync_SignatureValidator_Extensibility)}", theoryData); | ||
| context.IgnoreType = false; | ||
| for (int i = 0; i < theoryData.ExtraStackFrames; i++) | ||
| theoryData.SignatureValidationError!.AddStackFrame(new StackFrame(false)); | ||
|
|
||
| try | ||
| { | ||
| ValidationResult<ValidatedToken> validationResult = await theoryData.JsonWebTokenHandler.ValidateTokenAsync( | ||
| theoryData.JsonWebToken!, | ||
| theoryData.ValidationParameters!, | ||
| theoryData.CallContext, | ||
| CancellationToken.None); | ||
|
|
||
| if (validationResult.IsValid) | ||
| { | ||
| // We expect the validation to fail, but it passed | ||
| context.AddDiff("ValidationResult is Valid."); | ||
| } | ||
| else | ||
| { | ||
| ValidationError validationError = validationResult.UnwrapError(); | ||
| IdentityComparer.AreValidationErrorsEqual(validationError, theoryData.SignatureValidationError, context); | ||
| theoryData.ExpectedException.ProcessException(validationError.GetException(), context); | ||
| } | ||
| } | ||
| catch (Exception ex) | ||
| { | ||
| theoryData.ExpectedException.ProcessException(ex, context); | ||
| } | ||
|
|
||
| TestUtilities.AssertFailIfErrors(context); | ||
| } | ||
|
|
||
| public static TheoryData<SignatureExtensibilityTheoryData> Signature_ExtensibilityTestCases | ||
| { | ||
| get | ||
| { | ||
| var theoryData = new TheoryData<SignatureExtensibilityTheoryData>(); | ||
| CallContext callContext = new CallContext(); | ||
| var utcNow = DateTime.UtcNow; | ||
| var utcPlusOneHour = utcNow + TimeSpan.FromHours(1); | ||
|
|
||
| #region return CustomSignatureValidationError | ||
| // Test cases where delegate is overridden and return a CustomSignatureValidationError | ||
| // CustomSignatureValidationError : SignatureValidationError, ExceptionType: SecurityTokenInvalidSignatureException | ||
| theoryData.Add(new SignatureExtensibilityTheoryData( | ||
| "CustomSignatureValidatorDelegate", | ||
| utcNow, | ||
| CustomSignatureValidationDelegates.CustomSignatureValidatorDelegate, | ||
| extraStackFrames: 3) | ||
| { | ||
| ExpectedException = new ExpectedException( | ||
| typeof(SecurityTokenInvalidSignatureException), | ||
| nameof(CustomSignatureValidationDelegates.CustomSignatureValidatorDelegate)), | ||
| SignatureValidationError = new CustomSignatureValidationError( | ||
| new MessageDetail( | ||
| nameof(CustomSignatureValidationDelegates.CustomSignatureValidatorDelegate), null), | ||
| typeof(SecurityTokenInvalidSignatureException), | ||
| new StackFrame("CustomSignatureValidationDelegates.cs", 160), | ||
| validationFailureType: ValidationFailureType.SignatureValidationFailed) | ||
| }); | ||
|
|
||
| // CustomSignatureValidationError : SignatureValidationError, ExceptionType: CustomSecurityTokenInvalidSignatureException : SecurityTokenInvalidSignatureException | ||
| theoryData.Add(new SignatureExtensibilityTheoryData( | ||
| "CustomSignatureValidatorCustomExceptionDelegate", | ||
| utcNow, | ||
| CustomSignatureValidationDelegates.CustomSignatureValidatorCustomExceptionDelegate, | ||
| extraStackFrames: 3) | ||
| { | ||
| ExpectedException = new ExpectedException( | ||
| typeof(CustomSecurityTokenInvalidSignatureException), | ||
| nameof(CustomSignatureValidationDelegates.CustomSignatureValidatorCustomExceptionDelegate)), | ||
| SignatureValidationError = new CustomSignatureValidationError( | ||
| new MessageDetail( | ||
| nameof(CustomSignatureValidationDelegates.CustomSignatureValidatorCustomExceptionDelegate), null), | ||
| typeof(CustomSecurityTokenInvalidSignatureException), | ||
| new StackFrame("CustomSignatureValidationDelegates.cs", 175), | ||
| validationFailureType: ValidationFailureType.SignatureValidationFailed), | ||
| }); | ||
|
|
||
| // CustomSignatureValidationError : SignatureValidationError, ExceptionType: NotSupportedException : SystemException | ||
| theoryData.Add(new SignatureExtensibilityTheoryData( | ||
| "CustomSignatureValidatorUnknownExceptionDelegate", | ||
| utcNow, | ||
| CustomSignatureValidationDelegates.CustomSignatureValidatorUnknownExceptionDelegate, | ||
| extraStackFrames: 3) | ||
| { | ||
| // CustomSignatureValidationError does not handle the exception type 'NotSupportedException' | ||
| ExpectedException = ExpectedException.SecurityTokenException( | ||
| LogHelper.FormatInvariant( | ||
| Tokens.LogMessages.IDX10002, // "IDX10002: Unknown exception type returned. Type: '{0}'. Message: '{1}'."; | ||
| typeof(NotSupportedException), | ||
| nameof(CustomSignatureValidationDelegates.CustomSignatureValidatorUnknownExceptionDelegate))), | ||
| SignatureValidationError = new CustomSignatureValidationError( | ||
| new MessageDetail( | ||
| nameof(CustomSignatureValidationDelegates.CustomSignatureValidatorUnknownExceptionDelegate), null), | ||
| typeof(NotSupportedException), | ||
| new StackFrame("CustomSignatureValidationDelegates.cs", 205), | ||
| validationFailureType: ValidationFailureType.SignatureValidationFailed), | ||
| }); | ||
|
|
||
| // CustomSignatureValidationError : SignatureValidationError, ExceptionType: NotSupportedException : SystemException, ValidationFailureType: CustomAudienceValidationFailureType | ||
| theoryData.Add(new SignatureExtensibilityTheoryData( | ||
| "CustomSignatureValidatorCustomExceptionCustomFailureTypeDelegate", | ||
| utcNow, | ||
| CustomSignatureValidationDelegates.CustomSignatureValidatorCustomExceptionCustomFailureTypeDelegate, | ||
| extraStackFrames: 3) | ||
| { | ||
| ExpectedException = new ExpectedException( | ||
| typeof(CustomSecurityTokenInvalidSignatureException), | ||
| nameof(CustomSignatureValidationDelegates.CustomSignatureValidatorCustomExceptionCustomFailureTypeDelegate)), | ||
| SignatureValidationError = new CustomSignatureValidationError( | ||
| new MessageDetail( | ||
| nameof(CustomSignatureValidationDelegates.CustomSignatureValidatorCustomExceptionCustomFailureTypeDelegate), null), | ||
| typeof(CustomSecurityTokenInvalidSignatureException), | ||
| new StackFrame("CustomSignatureValidationDelegates.cs", 190), | ||
| validationFailureType: CustomSignatureValidationError.CustomSignatureValidationFailureType), | ||
| }); | ||
| #endregion | ||
|
|
||
| #region return SignatureValidationError | ||
| // Test cases where delegate is overridden and return an SignatureValidationError | ||
| // SignatureValidationError : ValidationError, ExceptionType: SecurityTokenInvalidSignatureException | ||
| theoryData.Add(new SignatureExtensibilityTheoryData( | ||
| "SignatureValidatorDelegate", | ||
| utcNow, | ||
| CustomSignatureValidationDelegates.SignatureValidatorDelegate, | ||
| extraStackFrames: 3) | ||
| { | ||
| ExpectedException = new ExpectedException( | ||
| typeof(SecurityTokenInvalidSignatureException), | ||
| nameof(CustomSignatureValidationDelegates.SignatureValidatorDelegate)), | ||
| SignatureValidationError = new SignatureValidationError( | ||
| new MessageDetail( | ||
| nameof(CustomSignatureValidationDelegates.SignatureValidatorDelegate), null), | ||
| typeof(SecurityTokenInvalidSignatureException), | ||
| new StackFrame("CustomSignatureValidationDelegates.cs", 235), | ||
| validationFailureType: ValidationFailureType.SignatureValidationFailed) | ||
| }); | ||
|
|
||
| // SignatureValidationError : ValidationError, ExceptionType: CustomSecurityTokenInvalidSignatureException : SecurityTokenInvalidSignatureException | ||
| theoryData.Add(new SignatureExtensibilityTheoryData( | ||
| "SignatureValidatorCustomSignatureExceptionTypeDelegate", | ||
| utcNow, | ||
| CustomSignatureValidationDelegates.SignatureValidatorCustomSignatureExceptionTypeDelegate, | ||
| extraStackFrames: 3) | ||
| { | ||
| // SignatureValidationError does not handle the exception type 'CustomSecurityTokenInvalidSignatureException' | ||
| ExpectedException = ExpectedException.SecurityTokenException( | ||
| LogHelper.FormatInvariant( | ||
| Tokens.LogMessages.IDX10002, // "IDX10002: Unknown exception type returned. Type: '{0}'. Message: '{1}'."; | ||
| typeof(CustomSecurityTokenInvalidSignatureException), | ||
| nameof(CustomSignatureValidationDelegates.SignatureValidatorCustomSignatureExceptionTypeDelegate))), | ||
| SignatureValidationError = new SignatureValidationError( | ||
| new MessageDetail( | ||
| nameof(CustomSignatureValidationDelegates.SignatureValidatorCustomSignatureExceptionTypeDelegate), null), | ||
| typeof(CustomSecurityTokenInvalidSignatureException), | ||
| new StackFrame("CustomSignatureValidationDelegates.cs", 259), | ||
| validationFailureType: ValidationFailureType.SignatureValidationFailed) | ||
| }); | ||
|
|
||
| // SignatureValidationError : ValidationError, ExceptionType: CustomSecurityTokenException : SystemException | ||
| theoryData.Add(new SignatureExtensibilityTheoryData( | ||
| "SignatureValidatorCustomExceptionTypeDelegate", | ||
| utcNow, | ||
| CustomSignatureValidationDelegates.SignatureValidatorCustomExceptionTypeDelegate, | ||
| extraStackFrames: 3) | ||
| { | ||
| // SignatureValidationError does not handle the exception type 'CustomSecurityTokenException' | ||
| ExpectedException = ExpectedException.SecurityTokenException( | ||
| LogHelper.FormatInvariant( | ||
| Tokens.LogMessages.IDX10002, // "IDX10002: Unknown exception type returned. Type: '{0}'. Message: '{1}'."; | ||
| typeof(CustomSecurityTokenException), | ||
| nameof(CustomSignatureValidationDelegates.SignatureValidatorCustomExceptionTypeDelegate))), | ||
| SignatureValidationError = new SignatureValidationError( | ||
| new MessageDetail( | ||
| nameof(CustomSignatureValidationDelegates.SignatureValidatorCustomExceptionTypeDelegate), null), | ||
| typeof(CustomSecurityTokenException), | ||
| new StackFrame("CustomSignatureValidationDelegates.cs", 274), | ||
| validationFailureType: ValidationFailureType.SignatureValidationFailed) | ||
| }); | ||
|
|
||
| // SignatureValidationError : ValidationError, ExceptionType: SecurityTokenInvalidSignatureException, inner: CustomSecurityTokenInvalidSignatureException | ||
| theoryData.Add(new SignatureExtensibilityTheoryData( | ||
| "SignatureValidatorThrows", | ||
| utcNow, | ||
| CustomSignatureValidationDelegates.SignatureValidatorThrows, | ||
| extraStackFrames: 2) | ||
| { | ||
| ExpectedException = new ExpectedException( | ||
| typeof(SecurityTokenInvalidSignatureException), | ||
| string.Format(Tokens.LogMessages.IDX10272), | ||
| typeof(CustomSecurityTokenInvalidSignatureException)), | ||
| SignatureValidationError = new SignatureValidationError( | ||
| new MessageDetail( | ||
| string.Format(Tokens.LogMessages.IDX10272), null), | ||
| typeof(SecurityTokenInvalidSignatureException), | ||
| new StackFrame("JsonWebTokenHandler.ValidateSignature.cs", 250), | ||
| null, // no inner validation error | ||
| ValidationFailureType.SignatureValidatorThrew, | ||
| new SecurityTokenInvalidSignatureException(nameof(CustomSignatureValidationDelegates.SignatureValidatorThrows)) | ||
| ) | ||
| }); | ||
| #endregion | ||
|
|
||
| return theoryData; | ||
| } | ||
| } | ||
|
|
||
| public class SignatureExtensibilityTheoryData : ValidateTokenAsyncBaseTheoryData | ||
| { | ||
| internal SignatureExtensibilityTheoryData(string testId, DateTime utcNow, SignatureValidationDelegate signatureValidator, int extraStackFrames) : base(testId) | ||
| { | ||
| // The token is never read by the custom delegtes, so we create a dummy token | ||
| JsonWebToken = JsonUtilities.CreateUnsignedJsonWebToken("iss", "issuer"); | ||
|
|
||
| ValidationParameters = new ValidationParameters | ||
| { | ||
| AlgorithmValidator = SkipValidationDelegates.SkipAlgorithmValidation, | ||
| AudienceValidator = SkipValidationDelegates.SkipAudienceValidation, | ||
| IssuerValidatorAsync = SkipValidationDelegates.SkipIssuerValidation, | ||
| IssuerSigningKeyValidator = SkipValidationDelegates.SkipIssuerSigningKeyValidation, | ||
| LifetimeValidator = SkipValidationDelegates.SkipLifetimeValidation, | ||
| SignatureValidator = signatureValidator, | ||
| TokenReplayValidator = SkipValidationDelegates.SkipTokenReplayValidation, | ||
| TokenTypeValidator = SkipValidationDelegates.SkipTokenTypeValidation | ||
| }; | ||
|
|
||
| ExtraStackFrames = extraStackFrames; | ||
| } | ||
|
|
||
| public JsonWebToken JsonWebToken { get; } | ||
|
|
||
| public JsonWebTokenHandler JsonWebTokenHandler { get; } = new JsonWebTokenHandler(); | ||
|
|
||
| public bool IsValid { get; set; } | ||
|
|
||
| internal SignatureValidationError? SignatureValidationError { get; set; } | ||
|
|
||
| internal int ExtraStackFrames { get; } | ||
| } | ||
| } | ||
| } | ||
| #nullable restore |
Oops, something went wrong.