Skip to content
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
24 commits
Select commit Hold shift + click to select a range
891f671
Add CaseSensitiveClaimsIdentity. Update JsonWebTokenHandler.
pmaytak Jul 11, 2024
63bfa21
Move switch to a separate class. Update claims identity creation code.
pmaytak Jul 11, 2024
b8b2fbc
Add test.
pmaytak Jul 11, 2024
98fc5f4
Update AppContextSwitches
pmaytak Jul 11, 2024
f15f4c4
Update test/Microsoft.IdentityModel.Tokens.Tests/CaseSensitiveClaimsI…
pmaytak Jul 12, 2024
a76cc11
Update comments.
pmaytak Jul 12, 2024
c0aa6bf
Merge remote-tracking branch 'origin/dev' into pmaytak/cs-claims
pmaytak Jul 12, 2024
b18236d
Update ClaimsIdentity code creation in src.
pmaytak Jul 12, 2024
dd1566e
Add tests.
pmaytak Jul 12, 2024
42eb9a0
Update tests to use correct types.
pmaytak Jul 12, 2024
c4bbcf6
Add SecurityToken property to CsClaimsIdentity.
pmaytak Jul 12, 2024
b19d572
Update tests to use CsClaimsIdentity.
pmaytak Jul 12, 2024
30b17fe
Refactor code into ClaimsIdentityFactory.
pmaytak Jul 12, 2024
2cfd756
Merge remote-tracking branch 'origin/dev' into pmaytak/cs-claims
pmaytak Jul 12, 2024
807790e
Update tests.
pmaytak Jul 13, 2024
73d4164
Update ClaimsIdentityFactory.
pmaytak Jul 13, 2024
25eed7f
Fix tests.
pmaytak Jul 13, 2024
c631785
Update tests for CaseSensitiveClaimsIdentity
Jul 13, 2024
bafae8b
ignore SecurityToken in IdentityComparer
Jul 13, 2024
36cdd6b
Set security token in ClaimsIdentityFactory. Add tests.
pmaytak Jul 15, 2024
0f93969
Apply suggestions from code review
pmaytak Jul 15, 2024
9532084
Update test.
pmaytak Jul 15, 2024
aef682c
Merge branch 'pmaytak/cs-claims' of https://github.com/AzureAD/azure-…
pmaytak Jul 15, 2024
11faf0b
Merge remote-tracking branch 'origin/dev' into pmaytak/cs-claims
pmaytak Jul 15, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,8 @@ public partial class JsonWebTokenHandler : TokenHandler
private static string _shortClaimType = _namespace + "/ShortTypeName";
private bool _mapInboundClaims = DefaultMapInboundClaims;

internal const string UseClaimsIdentityTypeSwitch = "Microsoft.IdentityModel.S2S.UseClaimsIdentityType";

/// <summary>
/// Default claim type mapping for inbound claims.
/// </summary>
Expand Down Expand Up @@ -212,7 +214,7 @@ private ClaimsIdentity CreateClaimsIdentityWithMapping(JsonWebToken jwtToken, To
{
_ = validationParameters ?? throw LogHelper.LogArgumentNullException(nameof(validationParameters));

ClaimsIdentity identity = validationParameters.CreateClaimsIdentity(jwtToken, issuer);
ClaimsIdentity identity = CreateCaseSensitiveClaimsIdentityFromTokenValidationParameters(jwtToken, validationParameters, issuer);
foreach (Claim jwtClaim in jwtToken.Claims)
{
bool wasMapped = _inboundClaimTypeMap.TryGetValue(jwtClaim.Type, out string claimType);
Expand Down Expand Up @@ -281,7 +283,7 @@ private ClaimsIdentity CreateClaimsIdentityPrivate(JsonWebToken jwtToken, TokenV
{
_ = validationParameters ?? throw LogHelper.LogArgumentNullException(nameof(validationParameters));

ClaimsIdentity identity = validationParameters.CreateClaimsIdentity(jwtToken, issuer);
ClaimsIdentity identity = CreateCaseSensitiveClaimsIdentityFromTokenValidationParameters(jwtToken, validationParameters, issuer);
foreach (Claim jwtClaim in jwtToken.Claims)
{
string claimType = jwtClaim.Type;
Expand Down Expand Up @@ -315,6 +317,20 @@ private ClaimsIdentity CreateClaimsIdentityPrivate(JsonWebToken jwtToken, TokenV
return identity;
}

private static bool UseClaimsIdentityType() => (AppContext.TryGetSwitch(UseClaimsIdentityTypeSwitch, out bool useClaimsIdentityType) && useClaimsIdentityType);

internal static ClaimsIdentity CreateCaseSensitiveClaimsIdentityFromTokenValidationParameters(JsonWebToken securityToken, TokenValidationParameters validationParameters, string issuer)
{
ClaimsIdentity identity = validationParameters.CreateClaimsIdentity(securityToken, issuer);

if (!UseClaimsIdentityType() && identity is not CaseSensitiveClaimsIdentity)
{
identity = new CaseSensitiveClaimsIdentity(identity);
}

return identity;
}

/// <summary>
/// Decrypts a JWE and returns the clear text.
/// </summary>
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,98 @@
// Copyright (c) Microsoft Corporation. All rights reserved.
// Licensed under the MIT License.

using System;
using System.Collections.Generic;
using System.Security.Claims;

namespace Microsoft.IdentityModel.Tokens
{
/// <summary>
/// A derived <see cref="ClaimsIdentity"/> where claim retrieval is case-sensitive. The current <see cref="ClaimsIdentity"/> retrieves claims in a case-insensitive manner which is different than querying the underlying <see cref="SecurityToken"/>. The <see cref="CaseSensitiveClaimsIdentity"/> provides consistent retrieval logic between the <see cref="SecurityToken"/> and <see cref="ClaimsIdentity"/>.
/// </summary>
public class CaseSensitiveClaimsIdentity : ClaimsIdentity
{
/// <summary>
/// Initializes an instance of <see cref="CaseSensitiveClaimsIdentity"/>.
/// </summary>
public CaseSensitiveClaimsIdentity() : base()
{
}

/// <summary>
/// Initializes an instance of <see cref="CaseSensitiveClaimsIdentity"/>.
/// </summary>
/// <param name="claimsIdentity"><see cref="ClaimsIdentity"/> to copy.</param>
public CaseSensitiveClaimsIdentity(ClaimsIdentity claimsIdentity) : base(claimsIdentity)
{
}

/// <summary>
/// Initializes an instance of <see cref="CaseSensitiveClaimsIdentity"/>.
/// </summary>
/// <param name="claims"><see cref="IEnumerable{Claim}"/> associated with this instance.</param>
public CaseSensitiveClaimsIdentity(IEnumerable<Claim> claims) : base(claims)
{
}

/// <summary>
/// Initializes an instance of <see cref="CaseSensitiveClaimsIdentity"/>.
/// </summary>
/// <param name="claims"><see cref="IEnumerable{Claim}"/> associated with this instance.</param>
/// <param name="authenticationType">The authentication method used to establish this identity.</param>
public CaseSensitiveClaimsIdentity(IEnumerable<Claim> claims, string authenticationType) : base(claims, authenticationType)
{
}

/// <summary>
/// Initializes an instance of <see cref="CaseSensitiveClaimsIdentity"/>.
/// </summary>
/// <param name="claims"><see cref="IEnumerable{Claim}"/> associated with this instance.</param>
/// <param name="authenticationType">The authentication method used to establish this identity.</param>
/// <param name="nameType">The <see cref="Claim.Type"/> used when obtaining the value of <see cref="ClaimsIdentity.Name"/>.</param>
/// <param name="roleType">The <see cref="Claim.Type"/> used when performing logic for <see cref="ClaimsPrincipal.IsInRole"/>.</param>
public CaseSensitiveClaimsIdentity(IEnumerable<Claim> claims, string authenticationType, string nameType, string roleType) :
base(claims, authenticationType, nameType, roleType)
{
}

/// <summary>
/// Retrieves a <see cref="IEnumerable{Claim}"/> where each Claim.Type equals <paramref name="type"/>.
/// </summary>
/// <param name="type">The type of the claim to match.</param>
/// <returns>A <see cref="IEnumerable{Claim}"/> of matched claims.</returns>
/// <remarks>Comparison is: StringComparison.Ordinal.</remarks>
/// <exception cref="ArgumentNullException">if <paramref name="type"/> is null.</exception>
public override IEnumerable<Claim> FindAll(string type)
{
return base.FindAll(claim => claim?.Type.Equals(type, StringComparison.Ordinal) == true);
}

/// <summary>
/// Retrieves the first <see cref="Claim"/> where Claim.Type equals <paramref name="type"/>.
/// </summary>
/// <param name="type">The type of the claim to match.</param>
/// <returns>A <see cref="Claim"/>, <see langword="null"/> if nothing matches.</returns>
/// <remarks>Comparison is: StringComparison.Ordinal.</remarks>
/// <exception cref="ArgumentNullException">if <paramref name="type"/> is null.</exception>
public override Claim FindFirst(string type)
{
return base.FindFirst(claim => claim?.Type.Equals(type, StringComparison.Ordinal) == true);
}

/// <summary>
/// Determines if a claim with type AND value is contained within this claims identity.
/// </summary>
/// <param name="type">The type of the claim to match.</param>
/// <param name="value">The value of the claim to match.</param>
/// <returns><c>true</c> if a claim is matched, <c>false</c> otherwise.</returns>
/// <remarks>Comparison is: StringComparison.Ordinal for Claim.Type and Claim.Value.</remarks>
/// <exception cref="ArgumentNullException">if <paramref name="type"/> is null.</exception>
/// <exception cref="ArgumentNullException">if <paramref name="value"/> is null.</exception>
public override bool HasClaim(string type, string value)
{
return base.HasClaim(claim => claim?.Type.Equals(type, StringComparison.Ordinal) == true
&& claim?.Value.Equals(value, StringComparison.Ordinal) == true);
}
}
}