Updated documentation for the new validation model and restructured internals #3056

iNinja · 2024-12-10T15:53:12Z

Updated documentation for the new validation model and restructured internals

Clean up work and documentation updates for the new validation model.

Removed static stack frames and replaced with the simplified approach of GetCurrentStackFrame() and AddCurrentStackFrame()
Updated IssuerValidationSource to be extensible.
Extracted validated fields onto their own files and made the structures read-only.
Updated documentation

Part of #2711

… of GetCurrentStackFrame() and AddCurrentStackFrame()

…fields onto their own files and made the structures read-only.

src/Microsoft.IdentityModel.Tokens/Validation/Validators.IssuerSigningKey.cs

…g IList values from two-part constructors.

… no ActorValidationParameters are provided.

…once the classes/structures are made public.

(cherry picked from commit 07a105f)

…il the ILogger compliance can be resolved. (cherry picked from commit af561ef)

Copilot reviewed 28 out of 43 changed files in this pull request and generated no comments.

Files not reviewed (15)

src/Microsoft.IdentityModel.Tokens/InternalAPI.Unshipped.txt: Language not supported
src/Microsoft.IdentityModel.JsonWebTokens/JsonWebTokenHandler.ValidateToken.StackFrames.cs: Evaluated as low risk
src/Microsoft.IdentityModel.Tokens.Saml/Saml2/Saml2SecurityTokenHandler.ValidateToken.StackFrames.cs: Evaluated as low risk
src/Microsoft.IdentityModel.Tokens.Saml/Saml/SamlSecurityTokenHandler.ValidateToken.StackFrames.cs: Evaluated as low risk
src/Microsoft.IdentityModel.Tokens/Validation/Results/Details/AlgorithmValidationError.cs: Evaluated as low risk
src/Microsoft.IdentityModel.Tokens.Saml/Saml2/Saml2SecurityTokenHandler.ValidateToken.Internal.cs: Evaluated as low risk
src/Microsoft.IdentityModel.Tokens/Validation/Results/Details/IssuerSigningKeyValidationError.cs: Evaluated as low risk
src/Microsoft.IdentityModel.Tokens/Validation/Results/Details/AudienceValidationError.cs: Evaluated as low risk
src/Microsoft.IdentityModel.Tokens.Saml/Saml/SamlSecurityTokenHandler.ValidateToken.Internal.cs: Evaluated as low risk
src/Microsoft.IdentityModel.Tokens.Saml/Saml2/Exceptions/Saml2ValidationError.cs: Evaluated as low risk
src/Microsoft.IdentityModel.JsonWebTokens/JwtTokenUtilities.cs: Evaluated as low risk
src/Microsoft.IdentityModel.Tokens/Validation/Results/Details/MessageDetail.cs: Evaluated as low risk
src/Microsoft.IdentityModel.JsonWebTokens/JwtTokenUtilities.DecryptTokenResult.cs: Evaluated as low risk
src/Microsoft.IdentityModel.JsonWebTokens/JsonWebTokenHandler.DecryptToken.cs: Evaluated as low risk
src/Microsoft.IdentityModel.JsonWebTokens/JsonWebTokenHandler.ReadToken.cs: Evaluated as low risk

jmprieur

LGTM
I've asked a few questions, which I'd like to be addressed, and proposed to improve the error messages to make them more actionable.

src/Microsoft.IdentityModel.Tokens.Saml/Saml/Exceptions/SamlValidationError.cs

src/Microsoft.IdentityModel.Tokens.Saml/Saml2/Exceptions/Saml2ValidationError.cs

src/Microsoft.IdentityModel.Tokens/Validation/Results/Details/AlgorithmValidationError.cs

src/Microsoft.IdentityModel.Tokens/Validation/Results/Details/AudienceValidationError.cs

...Microsoft.IdentityModel.Tokens/Validation/Results/Details/IssuerSigningKeyValidationError.cs

jmprieur · 2025-01-05T19:14:42Z

src/Microsoft.IdentityModel.Tokens/Validation/Results/ValidatedToken.cs

+    /// <param name="securityToken">The <see cref="SecurityToken"/> that is being validated.</param>
+    /// <param name="tokenHandler">The <see cref="TokenHandler"/> that is being used to validate the token.</param>
+    /// <param name="validationParameters">The <see cref="ValidationParameters"/> to be used for validating the token.</param>
+    internal class ValidatedToken(


is it ValidatedToken? Or ValidatedTokenResult?

This is what I consider a "success object", in the sense that it is only ever created and returned as part of a successful validation. The ValidationResult can be either positive or negative, but the ValidatedToken is just that, a token that was successfully validated.

src/Microsoft.IdentityModel.Tokens/Validation/Results/ValidatedToken.cs

jmprieur · 2025-01-05T19:40:52Z

src/Microsoft.IdentityModel.JsonWebTokens/JsonWebTokenHandler.ValidateToken.Internal.cs

@@ -233,8 +213,7 @@ await ValidateJWSAsync(decryptedToken!, validationParameters, configuration, cal

            if (!validationResult.IsValid)
            {
-                StackFrame validationFailureStackFrame = StackFrames.JWEValidationFailed ??= new StackFrame(true);
-                return validationResult.UnwrapError().AddStackFrame(validationFailureStackFrame);
+                return validationResult.UnwrapError().AddCurrentStackFrame();
            }

            JsonWebToken jsonWebToken = (validationResult.UnwrapResult().SecurityToken as JsonWebToken)!;


line 248, can we do better (more precise?) than catching the general Exception class?

In general, given this path is not meant to throw exceptions and we do not do it within the default validators, this is more of a safety net for the cases where a customer implements one of the delegates and decides to throw an exception.
Given that in that situation we have no way of knowing or limiting the types of exceptions that could occur, this seems like our safest approach.

In a basic scenario where no delegates are overwritten, this catch would never execute.

jmprieur · 2025-01-05T19:47:33Z

src/Microsoft.IdentityModel.JsonWebTokens/JsonWebTokenHandler.DecryptToken.cs

                return ValidationError.NullParameter(
                    nameof(jwtToken),
-                    tokenNullStackFrame);
+                    ValidationError.GetCurrentStackFrame());


Suggested change

ValidationError.GetCurrentStackFrame());

ValidationError.GetCurrentStackFrame(),

"The JWT token provided is null. Ensure that a valid token is passed.");

Addressed this in the other similar suggestion.

Suggest 'JsonWebToken' instead of "JWT'

jmprieur · 2025-01-05T19:49:32Z

src/Microsoft.IdentityModel.JsonWebTokens/JsonWebTokenHandler.DecryptToken.cs

                return ValidationError.NullParameter(
                    nameof(validationParameters),
-                    validationParametersNullStackFrame);
+                    ValidationError.GetCurrentStackFrame());


Suggested change

ValidationError.GetCurrentStackFrame());

ValidationError.GetCurrentStackFrame()

"Validation parameters are missing. Provide the necessary parameters for token validation.");

Currently, the NullParameter static method is a bit of a shortcut for a ValidationError with ValidationFailureType of NullArgument, and a message of IDX10000: The parameter '{0}' cannot be a 'null' or an empty object..

I see two options here if we really want to add this information:

We create a new IDX to allow the inclusion of further explanation

We allow to override the IDX10000 message with this

Suggest 'ValidationParameters' instead of 'Validation parameters'

Will not the current error message along with the stack trace will provide sufficient information to for the user?

We should not be assuming the stack traces will be normally seen, as we are aiming to not generate the exceptions unless there is a problem that is being diagnosed.

It may be worth allowing adding a little context along with the X parameter cannot be null or empty to make it easier to go without the stack trace and make that more of a last resort.

…idation model feature branch.

github-actions · 2025-01-13T15:06:40Z

Summary


Generated on:	1/13/2025 - 3:06:39 PM
Coverage date:	1/13/2025 - 2:57:01 PM - 1/13/2025 - 3:06:14 PM
Parser:	MultiReport (60x Cobertura)
Assemblies:	1
Classes:	7
Files:	2
Line coverage:	80.3% (620 of 772)
Covered lines:	620
Uncovered lines:	152
Coverable lines:	772
Total lines:	483
Branch coverage:	67.8% (228 of 336)
Covered branches:	228
Total branches:	336
Method coverage:	Feature is only available for sponsors

Coverage

Microsoft.IdentityModel.JsonWebTokens - 80.3%

Name	Line	Branch
Microsoft.IdentityModel.JsonWebTokens	80.3%	67.8%
Microsoft.IdentityModel.JsonWebTokens.JwtTokenUtilities	100%
System.Text.RegularExpressions.Generated	80.3%	67.8%
System.Text.RegularExpressions.Generated	80.3%	67.8%
System.Text.RegularExpressions.Generated.<RegexGenerator_g>F12A1AEDDDFE32BA DF4DBFF323AF1BCB48B9F9721B7CD3E05F5E034CF225E3DF8__CreateJweRegex_1	79.2%	68%
System.Text.RegularExpressions.Generated.<RegexGenerator_g>F12A1AEDDDFE32BA DF4DBFF323AF1BCB48B9F9721B7CD3E05F5E034CF225E3DF8__CreateJwsRegex_0	81.4%	67.6%
System.Text.RegularExpressions.Generated.<RegexGenerator_g>F334844C618E00D3 CEC5D3FE0D00CF0141BBEE98635313BB2CB8D3921464CE05A__CreateJweRegex_1	79.2%	68%
System.Text.RegularExpressions.Generated.<RegexGenerator_g>F334844C618E00D3 CEC5D3FE0D00CF0141BBEE98635313BB2CB8D3921464CE05A__CreateJwsRegex_0	81.4%	67.6%

github-actions · 2025-01-13T15:20:30Z

Summary


Generated on:	1/13/2025 - 3:20:29 PM
Coverage date:	1/13/2025 - 3:10:04 PM - 1/13/2025 - 3:19:57 PM
Parser:	MultiReport (60x Cobertura)
Assemblies:	1
Classes:	7
Files:	2
Line coverage:	80.3% (620 of 772)
Covered lines:	620
Uncovered lines:	152
Coverable lines:	772
Total lines:	483
Branch coverage:	67.8% (228 of 336)
Covered branches:	228
Total branches:	336
Method coverage:	Feature is only available for sponsors

Coverage

Microsoft.IdentityModel.JsonWebTokens - 80.3%

Name	Line	Branch
Microsoft.IdentityModel.JsonWebTokens	80.3%	67.8%
Microsoft.IdentityModel.JsonWebTokens.JwtTokenUtilities	100%
System.Text.RegularExpressions.Generated	80.3%	67.8%
System.Text.RegularExpressions.Generated	80.3%	67.8%
System.Text.RegularExpressions.Generated.<RegexGenerator_g>F12A1AEDDDFE32BA DF4DBFF323AF1BCB48B9F9721B7CD3E05F5E034CF225E3DF8__CreateJweRegex_1	79.2%	68%
System.Text.RegularExpressions.Generated.<RegexGenerator_g>F12A1AEDDDFE32BA DF4DBFF323AF1BCB48B9F9721B7CD3E05F5E034CF225E3DF8__CreateJwsRegex_0	81.4%	67.6%
System.Text.RegularExpressions.Generated.<RegexGenerator_g>F334844C618E00D3 CEC5D3FE0D00CF0141BBEE98635313BB2CB8D3921464CE05A__CreateJweRegex_1	79.2%	68%
System.Text.RegularExpressions.Generated.<RegexGenerator_g>F334844C618E00D3 CEC5D3FE0D00CF0141BBEE98635313BB2CB8D3921464CE05A__CreateJwsRegex_0	81.4%	67.6%

…onError

github-actions · 2025-01-13T15:33:57Z

Summary


Generated on:	1/13/2025 - 3:33:56 PM
Coverage date:	1/13/2025 - 3:23:57 PM - 1/13/2025 - 3:33:30 PM
Parser:	MultiReport (60x Cobertura)
Assemblies:	1
Classes:	7
Files:	2
Line coverage:	80.3% (620 of 772)
Covered lines:	620
Uncovered lines:	152
Coverable lines:	772
Total lines:	483
Branch coverage:	67.8% (228 of 336)
Covered branches:	228
Total branches:	336
Method coverage:	Feature is only available for sponsors

Coverage

Microsoft.IdentityModel.JsonWebTokens - 80.3%

Name	Line	Branch
Microsoft.IdentityModel.JsonWebTokens	80.3%	67.8%
Microsoft.IdentityModel.JsonWebTokens.JwtTokenUtilities	100%
System.Text.RegularExpressions.Generated	80.3%	67.8%
System.Text.RegularExpressions.Generated	80.3%	67.8%
System.Text.RegularExpressions.Generated.<RegexGenerator_g>F12A1AEDDDFE32BA DF4DBFF323AF1BCB48B9F9721B7CD3E05F5E034CF225E3DF8__CreateJweRegex_1	79.2%	68%
System.Text.RegularExpressions.Generated.<RegexGenerator_g>F12A1AEDDDFE32BA DF4DBFF323AF1BCB48B9F9721B7CD3E05F5E034CF225E3DF8__CreateJwsRegex_0	81.4%	67.6%
System.Text.RegularExpressions.Generated.<RegexGenerator_g>F334844C618E00D3 CEC5D3FE0D00CF0141BBEE98635313BB2CB8D3921464CE05A__CreateJweRegex_1	79.2%	68%
System.Text.RegularExpressions.Generated.<RegexGenerator_g>F334844C618E00D3 CEC5D3FE0D00CF0141BBEE98635313BB2CB8D3921464CE05A__CreateJwsRegex_0	81.4%	67.6%

github-actions · 2025-01-13T16:12:22Z

Summary


Generated on:	1/13/2025 - 4:12:21 PM
Coverage date:	1/13/2025 - 4:02:50 PM - 1/13/2025 - 4:11:56 PM
Parser:	MultiReport (60x Cobertura)
Assemblies:	1
Classes:	7
Files:	2
Line coverage:	80.3% (620 of 772)
Covered lines:	620
Uncovered lines:	152
Coverable lines:	772
Total lines:	483
Branch coverage:	67.8% (228 of 336)
Covered branches:	228
Total branches:	336
Method coverage:	Feature is only available for sponsors

Coverage

Microsoft.IdentityModel.JsonWebTokens - 80.3%

Name	Line	Branch
Microsoft.IdentityModel.JsonWebTokens	80.3%	67.8%
Microsoft.IdentityModel.JsonWebTokens.JwtTokenUtilities	100%
System.Text.RegularExpressions.Generated	80.3%	67.8%
System.Text.RegularExpressions.Generated	80.3%	67.8%
System.Text.RegularExpressions.Generated.<RegexGenerator_g>F12A1AEDDDFE32BA DF4DBFF323AF1BCB48B9F9721B7CD3E05F5E034CF225E3DF8__CreateJweRegex_1	79.2%	68%
System.Text.RegularExpressions.Generated.<RegexGenerator_g>F12A1AEDDDFE32BA DF4DBFF323AF1BCB48B9F9721B7CD3E05F5E034CF225E3DF8__CreateJwsRegex_0	81.4%	67.6%
System.Text.RegularExpressions.Generated.<RegexGenerator_g>F334844C618E00D3 CEC5D3FE0D00CF0141BBEE98635313BB2CB8D3921464CE05A__CreateJweRegex_1	79.2%	68%
System.Text.RegularExpressions.Generated.<RegexGenerator_g>F334844C618E00D3 CEC5D3FE0D00CF0141BBEE98635313BB2CB8D3921464CE05A__CreateJwsRegex_0	81.4%	67.6%

src/Microsoft.IdentityModel.JsonWebTokens/JsonWebTokenHandler.ValidateToken.Internal.cs

brentschmaltz · 2025-01-13T17:31:06Z

src/Microsoft.IdentityModel.JsonWebTokens/JsonWebTokenHandler.ValidateToken.Internal.cs

@@ -200,8 +183,7 @@ await ValidateJWEAsync(jsonWebToken, validationParameters, lkgConfiguration, cal
            }

            // If we reach this point, the token validation failed and we should return the error.
-            StackFrame stackFrame = StackFrames.TokenValidationFailed ??= new StackFrame(true);
-            return result.UnwrapError().AddStackFrame(stackFrame);
+            return result.UnwrapError().AddCurrentStackFrame();


If there no Error, UnWrapError() will throw an InvalidOperationException.
This may not be valuable to the user.

It is not possible to reach this line without an error.

ValidationError can only be constructed with a successful result or an error, but always one of the two is present.
The code above this line returns the success value if the result is valid, only reaching this point if it is not, and therefore holding the error.

brentschmaltz · 2025-01-13T17:38:44Z

src/Microsoft.IdentityModel.Tokens.Saml/Saml/Exceptions/SamlValidationError.cs

@@ -7,9 +7,20 @@
 #nullable enable
 namespace Microsoft.IdentityModel.Tokens.Saml
 {
+    /// <summary>


I am curious why we need this class.

It was introduced as part of the intention to specialise the returned errors from the delegates, though there is a chance that the SAML and SAML2 validation errors could be left as ValidationError and keep the others for the common validations. I'll have a look.

Took me a moment to remember the exact reasoning, but here it is and it is simple:

We have 2 exceptions thrown by the SAMLSecurityTokenHandler and SAML2SecurityHandler that need to be created, each of them deriving from a SamlSecurityTokenException or Saml2SecurityTokenException.

If we try to create those exceptions within ValidationError using the current approach, we would need to have M.IM.Tokens depend on the SAML and SAML2 packages.

We implement these two validation errors in order to have each create their custom exception.

brentschmaltz · 2025-01-13T17:41:45Z

src/Microsoft.IdentityModel.Tokens.Saml/Saml2/Exceptions/Saml2ValidationError.cs

+        /// <param name="exceptionType"/> is the type of exception that occurred.
+        /// <param name="stackFrame"/> is the stack frame where the exception occurred.
+        /// <param name="innerException"/> is the inner exception that occurred.
+        public Saml2ValidationError(


Curious why we need this class.
As I don't see a JwtValidationError.

Addressed on the SAML validation error comment.

brentschmaltz · 2025-01-13T17:47:50Z

src/Microsoft.IdentityModel.Tokens/Validation/Results/Details/AlgorithmValidationError.cs

@@ -7,8 +7,20 @@
 #nullable enable
 namespace Microsoft.IdentityModel.Tokens
 {
+    /// <summary>
+    /// Represents an algorithm validation error.


Suggest: When validating a SecurityToken the user can specify which algorithms are acceptable. AlgorithmValidationError contains details of why the validation of the SecurityToken failed associated with the algorithm found in the SecurityToken.

This kind of explanation sounds too verbose to me and more suited for a KB article / wiki.
I'll try to expand the current description to something more clear.

src/Microsoft.IdentityModel.Tokens/Validation/Results/Details/AlgorithmValidationError.cs

brentschmaltz · 2025-01-13T17:58:00Z

src/Microsoft.IdentityModel.Tokens/Validation/Results/Details/TokenTypeValidationError.cs

+        /// <param name="stackFrame"/> is the stack frame where the exception occurred.
+        /// <param name="invalidTokenType"/> is the token type that could not be validated.
+        /// <param name="innerException"/> is the inner exception that occurred.
+        public TokenTypeValidationError(


In general we are not consistent with our default parameters.
invalidTokenType can be null, but we don't have default = null, for innerException we do have a default.

default parameters limit how class methods can be modified in the future.

These are two different cases and the default value intends to reflect that.

We want the invalidTokenType to be present, but because the value on the token itself may be missing, we have to allow null to be passed here.
The inner exception, on the other hand, is an optional parameter that can be added if present but is not required.

but one important to have is the cancellationToken = default) as the last parameter of Async methods

I am adding the default on the main method.

src/Microsoft.IdentityModel.Tokens/Validation/Results/ValidatedIssuer.cs

src/Microsoft.IdentityModel.Tokens/Validation/Results/ValidatedToken.cs

brentschmaltz · 2025-01-13T19:11:30Z

src/Microsoft.IdentityModel.Tokens/Validation/Results/ValidatedToken.cs

        public string? ValidatedAudience { get; internal set; }

+        /// <summary>
+        /// The issuer that was validated. If present, it contains the source of the validation as well.
+        /// </summary>
        public ValidatedIssuer? ValidatedIssuer { get; internal set; }


Is the idea that the 'internal set' will become public so the user can set the value?

The ideal would be to make these properties be { get; init; } to make them only settable from the two-part constructor when calling:

var validatedToken = new ValidatedToken(token, handler, parameters) { ValidatedIssuer = someValidatedIssuer, ValidatedLifetime = someValidatedLifetime, }

and outside of that, keep the property as read-only.

There is a small incompatibility between the init keyword and .NET Framework / .NET Standard that requires a workaround that is not included here as it requires its own conversation.

…with a regular constructor with validations

github-actions · 2025-01-14T15:11:52Z

Summary


Generated on:	1/14/2025 - 3:11:51 PM
Coverage date:	1/14/2025 - 3:01:42 PM - 1/14/2025 - 3:11:27 PM
Parser:	MultiReport (60x Cobertura)
Assemblies:	1
Classes:	7
Files:	2
Line coverage:	80.3% (620 of 772)
Covered lines:	620
Uncovered lines:	152
Coverable lines:	772
Total lines:	483
Branch coverage:	67.8% (228 of 336)
Covered branches:	228
Total branches:	336
Method coverage:	Feature is only available for sponsors

Coverage

Microsoft.IdentityModel.JsonWebTokens - 80.3%

Name	Line	Branch
Microsoft.IdentityModel.JsonWebTokens	80.3%	67.8%
Microsoft.IdentityModel.JsonWebTokens.JwtTokenUtilities	100%
System.Text.RegularExpressions.Generated	80.3%	67.8%
System.Text.RegularExpressions.Generated	80.3%	67.8%
System.Text.RegularExpressions.Generated.<RegexGenerator_g>F12A1AEDDDFE32BA DF4DBFF323AF1BCB48B9F9721B7CD3E05F5E034CF225E3DF8__CreateJweRegex_1	79.2%	68%
System.Text.RegularExpressions.Generated.<RegexGenerator_g>F12A1AEDDDFE32BA DF4DBFF323AF1BCB48B9F9721B7CD3E05F5E034CF225E3DF8__CreateJwsRegex_0	81.4%	67.6%
System.Text.RegularExpressions.Generated.<RegexGenerator_g>F334844C618E00D3 CEC5D3FE0D00CF0141BBEE98635313BB2CB8D3921464CE05A__CreateJweRegex_1	79.2%	68%
System.Text.RegularExpressions.Generated.<RegexGenerator_g>F334844C618E00D3 CEC5D3FE0D00CF0141BBEE98635313BB2CB8D3921464CE05A__CreateJwsRegex_0	81.4%	67.6%

github-actions · 2025-01-14T15:15:07Z

Summary


Generated on:	1/14/2025 - 3:15:06 PM
Coverage date:	1/14/2025 - 3:05:32 PM - 1/14/2025 - 3:14:40 PM
Parser:	MultiReport (60x Cobertura)
Assemblies:	1
Classes:	7
Files:	2
Line coverage:	80.3% (620 of 772)
Covered lines:	620
Uncovered lines:	152
Coverable lines:	772
Total lines:	483
Branch coverage:	67.8% (228 of 336)
Covered branches:	228
Total branches:	336
Method coverage:	Feature is only available for sponsors

Coverage

Microsoft.IdentityModel.JsonWebTokens - 80.3%

Name	Line	Branch
Microsoft.IdentityModel.JsonWebTokens	80.3%	67.8%
Microsoft.IdentityModel.JsonWebTokens.JwtTokenUtilities	100%
System.Text.RegularExpressions.Generated	80.3%	67.8%
System.Text.RegularExpressions.Generated	80.3%	67.8%
System.Text.RegularExpressions.Generated.<RegexGenerator_g>F12A1AEDDDFE32BA DF4DBFF323AF1BCB48B9F9721B7CD3E05F5E034CF225E3DF8__CreateJweRegex_1	79.2%	68%
System.Text.RegularExpressions.Generated.<RegexGenerator_g>F12A1AEDDDFE32BA DF4DBFF323AF1BCB48B9F9721B7CD3E05F5E034CF225E3DF8__CreateJwsRegex_0	81.4%	67.6%
System.Text.RegularExpressions.Generated.<RegexGenerator_g>F334844C618E00D3 CEC5D3FE0D00CF0141BBEE98635313BB2CB8D3921464CE05A__CreateJweRegex_1	79.2%	68%
System.Text.RegularExpressions.Generated.<RegexGenerator_g>F334844C618E00D3 CEC5D3FE0D00CF0141BBEE98635313BB2CB8D3921464CE05A__CreateJwsRegex_0	81.4%	67.6%

src/Microsoft.IdentityModel.Tokens/Validation/Results/IssuerValidationSource.cs

src/Microsoft.IdentityModel.Tokens/Validation/Results/ValidatedIssuer.cs

src/Microsoft.IdentityModel.Tokens/Validation/Results/ValidatedLifetime.cs

src/Microsoft.IdentityModel.Tokens/Validation/Results/ValidatedSigningKeyLifetime.cs

jmprieur

LTGM
Thanks @iNinja

# Conflicts: # src/Microsoft.IdentityModel.Tokens/InternalAPI.Unshipped.txt

github-actions · 2025-01-15T17:23:46Z

Summary


Generated on:	1/15/2025 - 5:23:45 PM
Coverage date:	1/15/2025 - 5:13:20 PM - 1/15/2025 - 5:23:20 PM
Parser:	MultiReport (60x Cobertura)
Assemblies:	1
Classes:	7
Files:	2
Line coverage:	80.3% (620 of 772)
Covered lines:	620
Uncovered lines:	152
Coverable lines:	772
Total lines:	483
Branch coverage:	67.8% (228 of 336)
Covered branches:	228
Total branches:	336
Method coverage:	Feature is only available for sponsors

Coverage

Microsoft.IdentityModel.JsonWebTokens - 80.3%

Name	Line	Branch
Microsoft.IdentityModel.JsonWebTokens	80.3%	67.8%
Microsoft.IdentityModel.JsonWebTokens.JwtTokenUtilities	100%
System.Text.RegularExpressions.Generated	80.3%	67.8%
System.Text.RegularExpressions.Generated	80.3%	67.8%
System.Text.RegularExpressions.Generated.<RegexGenerator_g>F12A1AEDDDFE32BA DF4DBFF323AF1BCB48B9F9721B7CD3E05F5E034CF225E3DF8__CreateJweRegex_1	79.2%	68%
System.Text.RegularExpressions.Generated.<RegexGenerator_g>F12A1AEDDDFE32BA DF4DBFF323AF1BCB48B9F9721B7CD3E05F5E034CF225E3DF8__CreateJwsRegex_0	81.4%	67.6%
System.Text.RegularExpressions.Generated.<RegexGenerator_g>F334844C618E00D3 CEC5D3FE0D00CF0141BBEE98635313BB2CB8D3921464CE05A__CreateJweRegex_1	79.2%	68%
System.Text.RegularExpressions.Generated.<RegexGenerator_g>F334844C618E00D3 CEC5D3FE0D00CF0141BBEE98635313BB2CB8D3921464CE05A__CreateJwsRegex_0	81.4%	67.6%

…r the new validation model

github-actions · 2025-01-16T16:23:58Z

Summary


Generated on:	1/16/2025 - 4:23:57 PM
Coverage date:	1/16/2025 - 4:13:12 PM - 1/16/2025 - 4:23:31 PM
Parser:	MultiReport (60x Cobertura)
Assemblies:	1
Classes:	7
Files:	2
Line coverage:	80.3% (620 of 772)
Covered lines:	620
Uncovered lines:	152
Coverable lines:	772
Total lines:	483
Branch coverage:	67.8% (228 of 336)
Covered branches:	228
Total branches:	336
Method coverage:	Feature is only available for sponsors

Coverage

Microsoft.IdentityModel.JsonWebTokens - 80.3%

Name	Line	Branch
Microsoft.IdentityModel.JsonWebTokens	80.3%	67.8%
Microsoft.IdentityModel.JsonWebTokens.JwtTokenUtilities	100%
System.Text.RegularExpressions.Generated	80.3%	67.8%
System.Text.RegularExpressions.Generated	80.3%	67.8%
System.Text.RegularExpressions.Generated.<RegexGenerator_g>F12A1AEDDDFE32BA DF4DBFF323AF1BCB48B9F9721B7CD3E05F5E034CF225E3DF8__CreateJweRegex_1	79.2%	68%
System.Text.RegularExpressions.Generated.<RegexGenerator_g>F12A1AEDDDFE32BA DF4DBFF323AF1BCB48B9F9721B7CD3E05F5E034CF225E3DF8__CreateJwsRegex_0	81.4%	67.6%
System.Text.RegularExpressions.Generated.<RegexGenerator_g>F334844C618E00D3 CEC5D3FE0D00CF0141BBEE98635313BB2CB8D3921464CE05A__CreateJweRegex_1	79.2%	68%
System.Text.RegularExpressions.Generated.<RegexGenerator_g>F334844C618E00D3 CEC5D3FE0D00CF0141BBEE98635313BB2CB8D3921464CE05A__CreateJwsRegex_0	81.4%	67.6%

github-actions · 2025-01-17T18:44:21Z

Summary


Generated on:	1/17/2025 - 6:44:20 PM
Coverage date:	1/17/2025 - 6:34:28 PM - 1/17/2025 - 6:43:55 PM
Parser:	MultiReport (60x Cobertura)
Assemblies:	1
Classes:	7
Files:	2
Line coverage:	80.3% (620 of 772)
Covered lines:	620
Uncovered lines:	152
Coverable lines:	772
Total lines:	483
Branch coverage:	67.8% (228 of 336)
Covered branches:	228
Total branches:	336
Method coverage:	Feature is only available for sponsors

Coverage

Microsoft.IdentityModel.JsonWebTokens - 80.3%

Name	Line	Branch
Microsoft.IdentityModel.JsonWebTokens	80.3%	67.8%
Microsoft.IdentityModel.JsonWebTokens.JwtTokenUtilities	100%
System.Text.RegularExpressions.Generated	80.3%	67.8%
System.Text.RegularExpressions.Generated	80.3%	67.8%
System.Text.RegularExpressions.Generated.<RegexGenerator_g>F12A1AEDDDFE32BA DF4DBFF323AF1BCB48B9F9721B7CD3E05F5E034CF225E3DF8__CreateJweRegex_1	79.2%	68%
System.Text.RegularExpressions.Generated.<RegexGenerator_g>F12A1AEDDDFE32BA DF4DBFF323AF1BCB48B9F9721B7CD3E05F5E034CF225E3DF8__CreateJwsRegex_0	81.4%	67.6%
System.Text.RegularExpressions.Generated.<RegexGenerator_g>F334844C618E00D3 CEC5D3FE0D00CF0141BBEE98635313BB2CB8D3921464CE05A__CreateJweRegex_1	79.2%	68%
System.Text.RegularExpressions.Generated.<RegexGenerator_g>F334844C618E00D3 CEC5D3FE0D00CF0141BBEE98635313BB2CB8D3921464CE05A__CreateJwsRegex_0	81.4%	67.6%

keegan-caruso · 2025-01-17T18:53:21Z

src/Microsoft.IdentityModel.Tokens/Validation/Results/ValidatedIssuer.cs

+        /// The validated issuer's string representation.
+        /// </summary>
+        /// <returns>A string representing the issuer and where it was validated from.</returns>
+        public override string ToString() => $"{Issuer} (from {ValidationSource})";


Could we cache this so we don't create a new string each time? (similar comment for other files in this commit)

keegan-caruso

Just one question, otherwise LGTM

iNinja added 3 commits December 10, 2024 15:40

Removed static stack frames and replaced with the simplified approach…

a664f72

… of GetCurrentStackFrame() and AddCurrentStackFrame()

Updated IssuerValidationSource to be extensible. Extracted validated …

9b66954

…fields onto their own files and made the structures read-only.

Updated documentation

073aae5

iNinja requested a review from a team as a code owner December 10, 2024 15:53

Merge branch 'dev' into iinglese/tidy-up-new-validation-model

143daa7

kllysng reviewed Dec 10, 2024

View reviewed changes

src/Microsoft.IdentityModel.Tokens/Validation/Validators.IssuerSigningKey.cs Show resolved Hide resolved

iNinja added 3 commits December 16, 2024 14:49

Added nullability annotations to ValidationParameters. Enabled settin…

206c0be

…g IList values from two-part constructors.

Handle case where ValidateActor is true, there is an actor token, but…

aa94abc

… no ActorValidationParameters are provided.

Updated documentation, added missing interfaces and methods required …

9e2746c

…once the classes/structures are made public.

iNinja mentioned this pull request Dec 16, 2024

New validation model - Public API review #3060

Closed

iNinja added 4 commits December 16, 2024 17:00

Merge branch 'dev' into iinglese/tidy-up-new-validation-model

0ba56b4

Merge branch 'dev' into iinglese/tidy-up-new-validation-model

42a41bc

Added missing documentation around validation errors

54063b3

(cherry picked from commit 07a105f)

Added CLSCompliant flag to Log methods to address the build issue unt…

5ac80f6

…il the ILogger compliance can be resolved. (cherry picked from commit af561ef)

pmaytak requested a review from Copilot December 20, 2024 21:50

Copilot AI reviewed Dec 20, 2024

View reviewed changes

jmprieur approved these changes Jan 5, 2025

View reviewed changes

iNinja added 3 commits January 13, 2025 13:55

Moved signature error back to internal after merging from the new val…

fa12679

…idation model feature branch.

Cache exceptions from ValidationErrors

b402f51

Merge branch 'dev' into iinglese/tidy-up-new-validation-model

9a3e03a

Added log level checks for log methods in ValidatedToken and Validati…

3403ac5

…onError

Updated comment for issuer validation source for clarity

08acf78

brentschmaltz reviewed Jan 13, 2025

View reviewed changes

src/Microsoft.IdentityModel.JsonWebTokens/JsonWebTokenHandler.ValidateToken.Internal.cs Outdated Show resolved Hide resolved

brentschmaltz reviewed Jan 13, 2025

View reviewed changes

src/Microsoft.IdentityModel.Tokens/Validation/Results/Details/AlgorithmValidationError.cs Outdated Show resolved Hide resolved

brentschmaltz reviewed Jan 13, 2025

View reviewed changes

src/Microsoft.IdentityModel.Tokens/Validation/Results/ValidatedIssuer.cs Outdated Show resolved Hide resolved

brentschmaltz reviewed Jan 13, 2025

View reviewed changes

src/Microsoft.IdentityModel.Tokens/Validation/Results/ValidatedToken.cs Outdated Show resolved Hide resolved

brentschmaltz reviewed Jan 13, 2025

View reviewed changes

src/Microsoft.IdentityModel.Tokens/Validation/Results/ValidatedToken.cs Outdated Show resolved Hide resolved

brentschmaltz reviewed Jan 13, 2025

View reviewed changes

iNinja added 4 commits January 14, 2025 14:55

Removed use of "this" in constructors.

1ccb3b6

Updated documentation based on PR feedback

00090eb

Removed primary constructor from ValidatedToken in favour of clarity …

0cb18a9

…with a regular constructor with validations

Merge branch 'dev' into iinglese/tidy-up-new-validation-model

9dd20d5

jmprieur reviewed Jan 14, 2025

View reviewed changes

src/Microsoft.IdentityModel.Tokens/Validation/Results/IssuerValidationSource.cs Show resolved Hide resolved

jmprieur reviewed Jan 14, 2025

View reviewed changes

src/Microsoft.IdentityModel.Tokens/Validation/Results/ValidatedIssuer.cs Show resolved Hide resolved

jmprieur reviewed Jan 14, 2025

View reviewed changes

src/Microsoft.IdentityModel.Tokens/Validation/Results/ValidatedLifetime.cs Show resolved Hide resolved

jmprieur reviewed Jan 14, 2025

View reviewed changes

src/Microsoft.IdentityModel.Tokens/Validation/Results/ValidatedSigningKeyLifetime.cs Show resolved Hide resolved

Overridden ToString method for validation objects.

3c83d26

jmprieur approved these changes Jan 15, 2025

View reviewed changes

Merge branch 'dev' into iinglese/tidy-up-new-validation-model

197e401

# Conflicts: # src/Microsoft.IdentityModel.Tokens/InternalAPI.Unshipped.txt

Added default value for the cancellation token on the entry points fo…

db68a7c

…r the new validation model

jmprieur approved these changes Jan 17, 2025

View reviewed changes

Merge branch 'dev' into iinglese/tidy-up-new-validation-model

8fff0a6

keegan-caruso reviewed Jan 17, 2025

View reviewed changes

keegan-caruso approved these changes Jan 17, 2025

View reviewed changes

	ValidationError.GetCurrentStackFrame());
	ValidationError.GetCurrentStackFrame(),
	"The JWT token provided is null. Ensure that a valid token is passed.");

	ValidationError.GetCurrentStackFrame());
	ValidationError.GetCurrentStackFrame()
	"Validation parameters are missing. Provide the necessary parameters for token validation.");

Updated documentation for the new validation model and restructured internals #3056

Are you sure you want to change the base?

Updated documentation for the new validation model and restructured internals #3056

Conversation

iNinja commented Dec 10, 2024

Updated documentation for the new validation model and restructured internals

Choose a reason for hiding this comment

jmprieur left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

github-actions bot commented Jan 13, 2025

Summary

Coverage

github-actions bot commented Jan 13, 2025

Summary

Coverage

github-actions bot commented Jan 13, 2025

Summary

Coverage

github-actions bot commented Jan 13, 2025

Summary

Coverage

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

brentschmaltz Jan 13, 2025 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

iNinja Jan 14, 2025 • edited Loading

Choose a reason for hiding this comment

github-actions bot commented Jan 14, 2025

Summary

Coverage

github-actions bot commented Jan 14, 2025

Summary

Coverage

jmprieur left a comment

Choose a reason for hiding this comment

github-actions bot commented Jan 15, 2025

Summary

Coverage

github-actions bot commented Jan 16, 2025

Summary

Coverage

github-actions bot commented Jan 17, 2025

Summary

Coverage

Choose a reason for hiding this comment

keegan-caruso left a comment

Choose a reason for hiding this comment

brentschmaltz Jan 13, 2025 •

edited

Loading

iNinja Jan 14, 2025 •

edited

Loading