Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: Remove early returns in claims transformation #99

Merged
merged 2 commits into from
May 10, 2024
Merged

fix: Remove early returns in claims transformation #99

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
88a5895
fix: Remove early returns in claims transformation will allow it chec…
Alexr03 May 9, 2024
a8d8085
Tests
Alexr03 May 10, 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
96 changes: 45 additions & 51 deletions src/Keycloak.AuthServices.Authorization/Claims/KeycloakRolesClaimsTransformation.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,73 +73,67 @@ public Task<ClaimsPrincipal> TransformAsync(ClaimsPrincipal principal)
if (this.roleSource.HasFlag(RolesClaimTransformationSource.ResourceAccess))
{
var resourceAccessValue = principal.FindFirst("resource_access")?.Value;
if (string.IsNullOrWhiteSpace(resourceAccessValue))
if (!string.IsNullOrWhiteSpace(resourceAccessValue))
{
return Task.FromResult(result);
}

using var resourceAccess = JsonDocument.Parse(resourceAccessValue);
var containsAudienceRoles = resourceAccess.RootElement.TryGetProperty(
this.audience,
out var rolesElement
);

if (!containsAudienceRoles)
{
return Task.FromResult(result);
}

var clientRoles = rolesElement.GetProperty("roles");

foreach (var role in clientRoles.EnumerateArray())
{
var value = role.GetString();

var matchingClaim = identity.Claims.FirstOrDefault(claim =>
claim.Type.Equals(
this.roleClaimType,
StringComparison.InvariantCultureIgnoreCase
) && claim.Value.Equals(value, StringComparison.InvariantCultureIgnoreCase)
using var resourceAccess = JsonDocument.Parse(resourceAccessValue);
var containsAudienceRoles = resourceAccess.RootElement.TryGetProperty(
this.audience,
out var rolesElement
);

if (matchingClaim is null && !string.IsNullOrWhiteSpace(value))
if (containsAudienceRoles)
{
identity.AddClaim(new Claim(this.roleClaimType, value));
var clientRoles = rolesElement.GetProperty("roles");

foreach (var role in clientRoles.EnumerateArray())
{
var value = role.GetString();

var matchingClaim = identity.Claims.FirstOrDefault(claim =>
claim.Type.Equals(
this.roleClaimType,
StringComparison.InvariantCultureIgnoreCase
) && claim.Value.Equals(value, StringComparison.InvariantCultureIgnoreCase)
);

if (matchingClaim is null && !string.IsNullOrWhiteSpace(value))
{
identity.AddClaim(new Claim(this.roleClaimType, value));
}
}
}
}
}

if (this.roleSource.HasFlag(RolesClaimTransformationSource.Realm))
{
var realmAccessValue = principal.FindFirst("realm_access")?.Value;
if (string.IsNullOrWhiteSpace(realmAccessValue))
if (!string.IsNullOrWhiteSpace(realmAccessValue))
{
return Task.FromResult(result);
}

using var realmAccess = JsonDocument.Parse(realmAccessValue);
using var realmAccess = JsonDocument.Parse(realmAccessValue);

var containsRoles = realmAccess.RootElement.TryGetProperty(
"roles",
out var rolesElement
);
var containsRoles = realmAccess.RootElement.TryGetProperty(
"roles",
out var rolesElement
);

if (containsRoles)
{
foreach (var role in rolesElement.EnumerateArray())
if (containsRoles)
{
var value = role.GetString();

var matchingClaim = identity.Claims.FirstOrDefault(claim =>
claim.Type.Equals(
this.roleClaimType,
StringComparison.InvariantCultureIgnoreCase
) && claim.Value.Equals(value, StringComparison.InvariantCultureIgnoreCase)
);

if (matchingClaim is null && !string.IsNullOrWhiteSpace(value))
foreach (var role in rolesElement.EnumerateArray())
{
identity.AddClaim(new Claim(this.roleClaimType, value));
var value = role.GetString();

var matchingClaim = identity.Claims.FirstOrDefault(claim =>
claim.Type.Equals(
this.roleClaimType,
StringComparison.InvariantCultureIgnoreCase
) && claim.Value.Equals(value, StringComparison.InvariantCultureIgnoreCase)
);

if (matchingClaim is null && !string.IsNullOrWhiteSpace(value))
{
identity.AddClaim(new Claim(this.roleClaimType, value));
}
}
}
}
Expand Down
65 changes: 54 additions & 11 deletions ...eycloak.AuthServices.Authorization.Tests/Claims/KeycloakRolesClaimsTransformationTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -82,6 +82,38 @@ public async Task ClaimsTransformationShouldHandleMissingResourceClaim()
claimsPrincipal.Claims.Count(item => ClaimTypes.Role == item.Type).Should().Be(0);
}

[Fact]
public async Task ClaimsTransformationShouldHandleMissingResourceClaimWithRealmRoles()
{
var target = new KeycloakRolesClaimsTransformation(
ClaimTypes.Role,
RolesClaimTransformationSource.All,
ClientId
);
var claimsPrincipal = GetClaimsPrincipal(MyRealmClaimValue, null);

claimsPrincipal = await target.TransformAsync(claimsPrincipal);
claimsPrincipal.HasClaim(ClaimTypes.Role, RealmRoleUserClaim).Should().BeTrue();
claimsPrincipal.HasClaim(ClaimTypes.Role, RealmRoleSuperUserClaim).Should().BeTrue();
claimsPrincipal.Claims.Count(item => ClaimTypes.Role == item.Type).Should().Be(2);
}

[Fact]
public async Task ClaimsTransformationShouldHandleMissingRealmClaimWithResourceRoles()
{
var target = new KeycloakRolesClaimsTransformation(
ClaimTypes.Role,
RolesClaimTransformationSource.All,
ClientId
);
var claimsPrincipal = GetClaimsPrincipal(null, MyResourceClaimValue);

claimsPrincipal = await target.TransformAsync(claimsPrincipal);
claimsPrincipal.HasClaim(ClaimTypes.Role, AppRoleUserClaim).Should().BeTrue();
claimsPrincipal.HasClaim(ClaimTypes.Role, AppRoleSuperUserClaim).Should().BeTrue();
claimsPrincipal.Claims.Count(item => ClaimTypes.Role == item.Type).Should().Be(2);
}

private const string MyResourceClaimValue = /*lang=json,strict*/
"""
{
Expand Down Expand Up @@ -138,17 +170,28 @@ public async Task ClaimsTransformationShouldHandleMissingResourceClaim()

// Get a claims principal that has all the appropriate claim details required for testing
private static ClaimsPrincipal GetClaimsPrincipal(
string realmClaimValue,
string resourceClaimValue
) =>
new(
new ClaimsIdentity(
[
new Claim(ResourceClaimType, resourceClaimValue, JsonValueType, MyUrl, MyUrl),
new Claim(RealmClaimType, realmClaimValue, JsonValueType, MyUrl, MyUrl),
]
)
);
string? realmClaimValue,
string? resourceClaimValue
)
{
var claimsIdentity = new ClaimsIdentity();

if (realmClaimValue != null)
{
claimsIdentity.AddClaim(
new Claim(RealmClaimType, realmClaimValue, JsonValueType, MyUrl, MyUrl)
);
}

if (resourceClaimValue != null)
{
claimsIdentity.AddClaim(
new Claim(ResourceClaimType, resourceClaimValue, JsonValueType, MyUrl, MyUrl)
);
}

return new ClaimsPrincipal(claimsIdentity);
}

// Get a claims principal that has all the appropriate claim details required for testing
private static ClaimsPrincipal GetClaimsPrincipalClaim(string claimValue) =>
Expand Down
Loading