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

MappedJwtClaimSetConverter#withDefaults doesn't remove claims from JWT as documented #10142

Closed
wants to merge 2 commits into from
Closed

MappedJwtClaimSetConverter#withDefaults doesn't remove claims from JWT as documented #10142

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
cc4e376
Previously, ClaimTypeConverter doesn't overwrite claim's value converted
Jul 27, 2021
672bef6
Preserve Null Claim Values
fguenci Jul 28, 2021
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
7 changes: 2 additions & 5 deletions .../src/main/java/org/springframework/security/oauth2/core/converter/ClaimTypeConverter.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/*
* Copyright 2002-2019 the original author or authors.
* Copyright 2002-2021 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
Expand Down Expand Up @@ -56,10 +56,7 @@ public Map<String, Object> convert(Map<String, Object> claims) {
this.claimTypeConverters.forEach((claimName, typeConverter) -> {
fguenci marked this conversation as resolved.
Show resolved Hide resolved
if (claims.containsKey(claimName)) {
Object claim = claims.get(claimName);
Object mappedClaim = typeConverter.convert(claim);
if (mappedClaim != null) {
result.put(claimName, mappedClaim);
}
result.put(claimName, typeConverter.convert(claim));
}
});
return result;
Expand Down
6 changes: 6 additions & 0 deletions ...test/java/org/springframework/security/oauth2/core/converter/ClaimTypeConverterTests.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,6 +62,8 @@ public class ClaimTypeConverterTests {

private static final String JSON_OBJECT_CLAIM = "json-object-claim";

private static final String NULL_OBJECT_CLAIM = "null-object-claim";

private ClaimTypeConverter claimTypeConverter;

@BeforeEach
Expand All @@ -77,6 +79,7 @@ public void setup() {
TypeDescriptor.collection(List.class, TypeDescriptor.valueOf(String.class)));
Converter<Object, ?> mapStringObjectConverter = getConverter(TypeDescriptor.map(Map.class,
TypeDescriptor.valueOf(String.class), TypeDescriptor.valueOf(Object.class)));
Converter<Object, ?> nullConverter = (value) -> null;
Map<String, Converter<Object, ?>> claimTypeConverters = new HashMap<>();
claimTypeConverters.put(STRING_CLAIM, stringConverter);
claimTypeConverters.put(BOOLEAN_CLAIM, booleanConverter);
Expand All @@ -85,6 +88,7 @@ public void setup() {
claimTypeConverters.put(COLLECTION_STRING_CLAIM, collectionStringConverter);
claimTypeConverters.put(LIST_STRING_CLAIM, listStringConverter);
claimTypeConverters.put(MAP_STRING_OBJECT_CLAIM, mapStringObjectConverter);
claimTypeConverters.put(NULL_OBJECT_CLAIM, nullConverter);
this.claimTypeConverter = new ClaimTypeConverter(claimTypeConverters);
}

Expand Down Expand Up @@ -138,6 +142,7 @@ public void convertWhenAllClaimsRequireConversionThenConvertAll() throws Excepti
claims.put(MAP_STRING_OBJECT_CLAIM, mapIntegerObject);
claims.put(JSON_ARRAY_CLAIM, jsonArray);
claims.put(JSON_OBJECT_CLAIM, jsonObject);
claims.put(NULL_OBJECT_CLAIM, instant.toString());
claims = this.claimTypeConverter.convert(claims);
assertThat(claims.get(STRING_CLAIM)).isEqualTo("true");
assertThat(claims.get(BOOLEAN_CLAIM)).isEqualTo(Boolean.TRUE);
Expand All @@ -148,6 +153,7 @@ public void convertWhenAllClaimsRequireConversionThenConvertAll() throws Excepti
assertThat(claims.get(MAP_STRING_OBJECT_CLAIM)).isEqualTo(mapStringObject);
assertThat(claims.get(JSON_ARRAY_CLAIM)).isEqualTo(jsonArrayListString);
assertThat(claims.get(JSON_OBJECT_CLAIM)).isEqualTo(jsonObjectMap);
assertThat(claims.get(NULL_OBJECT_CLAIM)).isNull();
}

@Test
Expand Down
10 changes: 10 additions & 0 deletions ...rc/test/java/org/springframework/security/oauth2/jwt/MappedJwtClaimSetConverterTests.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -123,8 +123,18 @@ public void convertWhenUsingCustomConverterThenAllOtherDefaultsAreStillUsed() {
assertThat(target.get(JwtClaimNames.SUB)).isEqualTo("1234");
}

// gh-10135
@Test
public void convertWhenConverterReturnsNullThenClaimIsRemoved() {
fguenci marked this conversation as resolved.
Show resolved Hide resolved
MappedJwtClaimSetConverter converter = MappedJwtClaimSetConverter
.withDefaults(Collections.singletonMap(JwtClaimNames.NBF, (nbfClaimValue) -> null));
Map<String, Object> source = Collections.singletonMap(JwtClaimNames.NBF, Instant.now());
Map<String, Object> target = converter.convert(source);
assertThat(target).doesNotContainKey(JwtClaimNames.NBF);
}

@Test
public void convertWhenClaimValueIsNullThenClaimIsRemoved() {
MappedJwtClaimSetConverter converter = MappedJwtClaimSetConverter.withDefaults(Collections.emptyMap());
Map<String, Object> source = Collections.singletonMap(JwtClaimNames.ISS, null);
Map<String, Object> target = converter.convert(source);
Expand Down