Skip to content

Commit

Permalink
Renamed delegates in ValidationParameters from "...ValidatorDelegate"…
Browse files Browse the repository at this point in the history
… to "...ValidationDelegate" (#2847)
  • Loading branch information
iNinja authored Sep 25, 2024
1 parent 1f2883c commit ad16a7f
Show file tree
Hide file tree
Showing 8 changed files with 27 additions and 27 deletions.
2 changes: 1 addition & 1 deletion src/Microsoft.IdentityModel.Tokens/Delegates.cs
Original file line number Diff line number Diff line change
Expand Up @@ -204,7 +204,7 @@ namespace Microsoft.IdentityModel.Tokens
/// <param name="callContext">The <see cref="CallContext"/> to be used for logging.</param>
/// <remarks>This method is not expected to throw.</remarks>
/// <returns>The validated <see cref="SecurityToken"/>.</returns>
internal delegate ValidationResult<SecurityKey> SignatureValidatorDelegate(SecurityToken token, ValidationParameters validationParameters, BaseConfiguration? configuration, CallContext? callContext);
internal delegate ValidationResult<SecurityKey> SignatureValidationDelegate(SecurityToken token, ValidationParameters validationParameters, BaseConfiguration? configuration, CallContext? callContext);

/// <summary>
/// Transforms the security token before signature validation.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,14 +25,14 @@ internal class ValidationParameters
private IList<string> _validTokenTypes;
private IList<string> _validAudiences;

private AlgorithmValidatorDelegate _algorithmValidator = Validators.ValidateAlgorithm;
private AudienceValidatorDelegate _audienceValidator = Validators.ValidateAudience;
private AlgorithmValidationDelegate _algorithmValidator = Validators.ValidateAlgorithm;
private AudienceValidationDelegate _audienceValidator = Validators.ValidateAudience;
private IssuerValidationDelegateAsync _issuerValidatorAsync = Validators.ValidateIssuerAsync;
private LifetimeValidatorDelegate _lifetimeValidator = Validators.ValidateLifetime;
private SignatureValidatorDelegate _signatureValidator;
private TokenReplayValidatorDelegate _tokenReplayValidator = Validators.ValidateTokenReplay;
private TypeValidatorDelegate _typeValidator = Validators.ValidateTokenType;
private IssuerSigningKeyValidatorDelegate _issuerSigningKeyValidator = Validators.ValidateIssuerSigningKey;
private LifetimeValidationDelegate _lifetimeValidator = Validators.ValidateLifetime;
private SignatureValidationDelegate _signatureValidator;
private TokenReplayValidationDelegate _tokenReplayValidator = Validators.ValidateTokenReplay;
private TokenTypeValidationDelegate _tokenTypeValidator = Validators.ValidateTokenType;
private IssuerSigningKeyValidationDelegate _issuerSigningKeyValidator = Validators.ValidateIssuerSigningKey;

/// <summary>
/// This is the default value of <see cref="ClaimsIdentity.AuthenticationType"/> when creating a <see cref="ClaimsIdentity"/>.
Expand Down Expand Up @@ -121,7 +121,7 @@ public ValidationParameters()
/// If no delegate is set, the default implementation will be used. The default checks the algorithm
/// against the <see cref="ValidAlgorithms"/> property, if present. If not, it will succeed.
/// </remarks>
public AlgorithmValidatorDelegate AlgorithmValidator
public AlgorithmValidationDelegate AlgorithmValidator
{
get { return _algorithmValidator; }
set { _algorithmValidator = value ?? throw new ArgumentNullException(nameof(value), "AlgorithmValidator cannot be null."); }
Expand All @@ -135,8 +135,8 @@ public AlgorithmValidatorDelegate AlgorithmValidator
/// This means that no default 'audience' validation will occur.
/// </remarks>
/// <exception cref="ArgumentNullException">Thrown when the value is set as null.</exception>
/// <returns>The <see cref="AudienceValidatorDelegate"/> used to validate the issuer of a token</returns>
public AudienceValidatorDelegate AudienceValidator
/// <returns>The <see cref="AudienceValidationDelegate"/> used to validate the issuer of a token</returns>
public AudienceValidationDelegate AudienceValidator
{
get { return _audienceValidator; }
set { _audienceValidator = value ?? throw new ArgumentNullException(nameof(value), "AudienceValidator cannot be set as null."); }
Expand Down Expand Up @@ -273,7 +273,7 @@ public virtual ClaimsIdentity CreateClaimsIdentity(SecurityToken securityToken,
/// If both <see cref="IssuerSigningKeyValidatorUsingConfiguration"/> and <see cref="IssuerSigningKeyValidator"/> are set, IssuerSigningKeyResolverUsingConfiguration takes
/// priority.
/// </remarks>
public IssuerSigningKeyValidatorDelegate IssuerSigningKeyValidator
public IssuerSigningKeyValidationDelegate IssuerSigningKeyValidator
{
get => _issuerSigningKeyValidator;
set => _issuerSigningKeyValidator = value ?? throw new ArgumentNullException(nameof(value), "IssuerSigningKeyValidator cannot be set as null.");
Expand Down Expand Up @@ -328,8 +328,8 @@ public IssuerValidationDelegateAsync IssuerValidatorAsync
/// Allows overriding the delegate that will be used to validate the lifetime of the token
/// </summary>
/// <exception cref="ArgumentNullException">Thrown when the value is set as null.</exception>
/// <returns>The <see cref="LifetimeValidatorDelegate"/> used to validate the lifetime of a token</returns>
public LifetimeValidatorDelegate LifetimeValidator
/// <returns>The <see cref="LifetimeValidationDelegate"/> used to validate the lifetime of a token</returns>
public LifetimeValidationDelegate LifetimeValidator
{
get { return _lifetimeValidator; }
set { _lifetimeValidator = value ?? throw new ArgumentNullException(nameof(value), "LifetimeValidator cannot be set as null."); }
Expand Down Expand Up @@ -441,7 +441,7 @@ public string RoleClaimType
/// <remarks>
/// If set, this delegate will be called to validate the signature of the token, instead of default processing.
/// </remarks>
public SignatureValidatorDelegate SignatureValidator
public SignatureValidationDelegate SignatureValidator
{
get { return _signatureValidator; }
set { _signatureValidator = value; }
Expand Down Expand Up @@ -479,8 +479,8 @@ public SignatureValidatorDelegate SignatureValidator
/// This means no default token replay validation will occur.
/// </remarks>
/// <exception cref="ArgumentNullException">Thrown when the value is set as null.</exception>
/// <returns>The <see cref="TokenReplayValidatorDelegate"/> used to validate the token replay of the token.</returns>
public TokenReplayValidatorDelegate TokenReplayValidator
/// <returns>The <see cref="TokenReplayValidationDelegate"/> used to validate the token replay of the token.</returns>
public TokenReplayValidationDelegate TokenReplayValidator
{
get { return _tokenReplayValidator; }
set { _tokenReplayValidator = value ?? throw new ArgumentNullException(nameof(value), "TokenReplayValidator cannot be set as null."); }
Expand All @@ -504,11 +504,11 @@ public TokenReplayValidatorDelegate TokenReplayValidator
/// against the <see cref="ValidTypes"/> property, if the type is present then, it will succeed.
/// </remarks>
/// <exception cref="ArgumentNullException">Thrown when the value is set as null.</exception>
/// <returns>The <see cref="TypeValidatorDelegate"/> used to validate the token type of a token</returns>
public TypeValidatorDelegate TypeValidator
/// <returns>The <see cref="TokenTypeValidationDelegate"/> used to validate the token type of a token</returns>
public TokenTypeValidationDelegate TypeValidator
{
get { return _typeValidator; }
set { _typeValidator = value ?? throw new ArgumentNullException(nameof(value), "TypeValidator cannot be set as null."); }
get { return _tokenTypeValidator; }
set { _tokenTypeValidator = value ?? throw new ArgumentNullException(nameof(value), "TypeValidator cannot be set as null."); }
}

/// <summary>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ namespace Microsoft.IdentityModel.Tokens
/// <param name="callContext"></param>
/// <returns>A <see cref="ValidationResult{TResult}"/>that contains the results of validating the algorithm.</returns>
/// <remarks>This delegate is not expected to throw.</remarks>
internal delegate ValidationResult<string> AlgorithmValidatorDelegate(
internal delegate ValidationResult<string> AlgorithmValidationDelegate(
string algorithm,
SecurityKey securityKey,
SecurityToken securityToken,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ namespace Microsoft.IdentityModel.Tokens
/// <param name="callContext"></param>
/// <returns>A <see cref="ValidationResult{TResult}"/>that contains the results of validating the issuer.</returns>
/// <remarks>This delegate is not expected to throw.</remarks>
internal delegate ValidationResult<string> AudienceValidatorDelegate(
internal delegate ValidationResult<string> AudienceValidationDelegate(
IList<string> audiences,
SecurityToken? securityToken,
ValidationParameters validationParameters,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ internal record struct ValidatedSigningKeyLifetime(DateTime? ValidFrom, DateTime
/// <param name="callContext">The <see cref="CallContext"/> to be used for logging.</param>
/// <returns>A <see cref="ValidationResult{TResult}"/>that contains the results of validating the issuer.</returns>
/// <remarks>This delegate is not expected to throw.</remarks>
internal delegate ValidationResult<ValidatedSigningKeyLifetime> IssuerSigningKeyValidatorDelegate(
internal delegate ValidationResult<ValidatedSigningKeyLifetime> IssuerSigningKeyValidationDelegate(
SecurityKey signingKey,
SecurityToken securityToken,
ValidationParameters validationParameters,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ internal record struct ValidatedLifetime(DateTime? NotBefore, DateTime? Expires)
/// <param name="callContext"></param>
/// <returns>A <see cref="ValidationResult{TResult}"/>that contains the results of validating the issuer.</returns>
/// <remarks>This delegate is not expected to throw.</remarks>
internal delegate ValidationResult<ValidatedLifetime> LifetimeValidatorDelegate(
internal delegate ValidationResult<ValidatedLifetime> LifetimeValidationDelegate(
DateTime? notBefore,
DateTime? expires,
SecurityToken? securityToken,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ namespace Microsoft.IdentityModel.Tokens
/// <param name="callContext"></param>
/// <returns>A <see cref="ValidationResult{TResult}"/>that contains the results of validating the token.</returns>
/// <remarks>This delegate is not expected to throw.</remarks>
internal delegate ValidationResult<DateTime?> TokenReplayValidatorDelegate(
internal delegate ValidationResult<DateTime?> TokenReplayValidationDelegate(
DateTime? expirationTime,
string securityToken,
ValidationParameters validationParameters,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ internal record struct ValidatedTokenType(string Type, int ValidTypeCount);
/// <param name="callContext"></param>
/// <returns> A <see cref="ValidationResult{TResult}"/>that contains the results of validating the token type.</returns>
/// <remarks>An EXACT match is required. <see cref="StringComparison.Ordinal"/> (case sensitive) is used for comparing <paramref name="type"/> against <see cref="ValidationParameters.ValidTypes"/>.</remarks>
internal delegate ValidationResult<ValidatedTokenType> TypeValidatorDelegate(
internal delegate ValidationResult<ValidatedTokenType> TokenTypeValidationDelegate(
string? type,
SecurityToken? securityToken,
ValidationParameters validationParameters,
Expand Down

0 comments on commit ad16a7f

Please sign in to comment.