From a05b4f3e71c9a8fc7ef4f3011d020efbaafe9036 Mon Sep 17 00:00:00 2001 From: Peter Zaoral Date: Sat, 31 Oct 2026 09:09:54 +0000 Subject: [PATCH 1/3] [Quarkus 4] Adapt Keycloak JSON handling to Jackson 3 Closes: #54599 Signed-off-by: Peter Zaoral --- .github/actions/conditional/conditions | 1 + core-jackson3/README.md | 15 + core-jackson3/pom.xml | 72 +++++ .../KeycloakAnnotationIntrospector3.java | 4 +- .../MultivaluedHashMapValueDeserializer3.java | 4 +- .../MultivaluedHashMapValueSerializer3.java | 4 +- .../ResourceTypeMapDeserializer3.java | 4 +- .../jackson3/StringListMapDeserializer3.java | 4 +- .../jackson3/StringOrArrayDeserializer3.java | 8 +- .../jackson3/StringOrArraySerializer3.java | 4 +- .../jackson3/RepresentationAdaptersTest.java | 163 ++++++++++ .../idm/RealmRepresentation.java | 2 + .../idm/RealmRepresentationJsonTest.java | 28 ++ integration/admin-client-jackson3/pom.xml | 22 ++ .../client/jackson3/Jackson3MapperHolder.java | 2 + .../jackson3/RepresentationAdaptersTest.java | 25 ++ .../testsuite/unit/CRSerializationTest.java | 25 ++ pom.xml | 6 + quarkus/runtime/pom.xml | 19 ++ .../jaxrs/LegacyJsonNodeAdapter.java | 102 +++++++ .../LegacyNamingAnnotationIntrospector.java | 30 ++ .../jaxrs/QuarkusJacksonExceptionHandler.java | 52 ++++ .../jaxrs/QuarkusObjectMapperResolver.java | 54 +++- ...sUnrecognizedPropertyExceptionHandler.java | 27 ++ .../QuarkusObjectMapperResolverTest.java | 281 ++++++++++++++++++ .../jaxrs/RepresentationAdaptersTest.java | 61 ++++ .../services/error/KeycloakErrorHandler.java | 31 +- .../tests/error/JacksonErrorResponseTest.java | 145 +++++++++ .../tests/error/UncaughtErrorPageTest.java | 12 +- .../ErrorTestingRealmResourceProvider.java | 96 ++++++ .../src/main/resources/META-INF/beans.xml | 0 31 files changed, 1268 insertions(+), 35 deletions(-) create mode 100644 core-jackson3/README.md create mode 100644 core-jackson3/pom.xml rename {integration/admin-client-jackson3/src/main/java/org/keycloak/admin/client => core-jackson3/src/main/java/org/keycloak/json}/jackson3/KeycloakAnnotationIntrospector3.java (93%) rename {integration/admin-client-jackson3/src/main/java/org/keycloak/admin/client => core-jackson3/src/main/java/org/keycloak/json}/jackson3/MultivaluedHashMapValueDeserializer3.java (89%) rename {integration/admin-client-jackson3/src/main/java/org/keycloak/admin/client => core-jackson3/src/main/java/org/keycloak/json}/jackson3/MultivaluedHashMapValueSerializer3.java (93%) rename {integration/admin-client-jackson3/src/main/java/org/keycloak/admin/client => core-jackson3/src/main/java/org/keycloak/json}/jackson3/ResourceTypeMapDeserializer3.java (88%) rename {integration/admin-client-jackson3/src/main/java/org/keycloak/admin/client => core-jackson3/src/main/java/org/keycloak/json}/jackson3/StringListMapDeserializer3.java (89%) rename {integration/admin-client-jackson3/src/main/java/org/keycloak/admin/client => core-jackson3/src/main/java/org/keycloak/json}/jackson3/StringOrArrayDeserializer3.java (68%) rename {integration/admin-client-jackson3/src/main/java/org/keycloak/admin/client => core-jackson3/src/main/java/org/keycloak/json}/jackson3/StringOrArraySerializer3.java (84%) create mode 100644 core-jackson3/src/test/java/org/keycloak/json/jackson3/RepresentationAdaptersTest.java create mode 100644 core/src/test/java/org/keycloak/representations/idm/RealmRepresentationJsonTest.java create mode 100644 integration/admin-client-jackson3/src/test/java/org/keycloak/admin/client/jackson3/RepresentationAdaptersTest.java create mode 100644 quarkus/runtime/src/main/java/org/keycloak/quarkus/runtime/integration/jaxrs/LegacyJsonNodeAdapter.java create mode 100644 quarkus/runtime/src/main/java/org/keycloak/quarkus/runtime/integration/jaxrs/LegacyNamingAnnotationIntrospector.java create mode 100644 quarkus/runtime/src/main/java/org/keycloak/quarkus/runtime/integration/jaxrs/QuarkusJacksonExceptionHandler.java create mode 100644 quarkus/runtime/src/main/java/org/keycloak/quarkus/runtime/integration/jaxrs/QuarkusUnrecognizedPropertyExceptionHandler.java create mode 100644 quarkus/runtime/src/test/java/org/keycloak/quarkus/runtime/integration/jaxrs/QuarkusObjectMapperResolverTest.java create mode 100644 quarkus/runtime/src/test/java/org/keycloak/quarkus/runtime/integration/jaxrs/RepresentationAdaptersTest.java create mode 100644 tests/base/src/test/java/org/keycloak/tests/error/JacksonErrorResponseTest.java create mode 100644 tests/custom-providers/src/main/resources/META-INF/beans.xml diff --git a/.github/actions/conditional/conditions b/.github/actions/conditional/conditions index 85f79c331cb1..2711e20207ef 100644 --- a/.github/actions/conditional/conditions +++ b/.github/actions/conditional/conditions @@ -62,6 +62,7 @@ js/libs/ui-shared/ ci ci-webauthn *.tsx codeql-typescript rest/admin-v2/ admin-v2 ci-jackson3 +core-jackson3/ ci-jackson3 ci-quarkus integration/admin-client-jackson3/ ci-jackson3 integration/admin-client-core/ ci-jackson3 integration/admin-client/ ci-jackson3 diff --git a/core-jackson3/README.md b/core-jackson3/README.md new file mode 100644 index 000000000000..699018799355 --- /dev/null +++ b/core-jackson3/README.md @@ -0,0 +1,15 @@ +# Jackson 3 representation adapters + +This module provides Jackson 3 serializers and deserializers for Keycloak's shared representation annotations. +The adapters are used by the server and the Jackson 3 admin client. + +The module requires Java 17. Mapper configuration and provider registration are handled by the consuming modules. + +## Synchronizing public client sources + +The public Java clients are maintained in [keycloak/keycloak-client](https://github.com/keycloak/keycloak-client). +When synchronizing the Jackson 3 admin client, include `org/keycloak/json/jackson3/**/*.java` from the +`keycloak-core-jackson3` sources JAR alongside the admin-client sources. Source JARs are generated with the +`jboss-release` Maven profile. + +The adapters are compiled as part of the Java 17 client. The shared `core` and `common` sources retain their Java 8 baseline. diff --git a/core-jackson3/pom.xml b/core-jackson3/pom.xml new file mode 100644 index 000000000000..f2a53994bd0f --- /dev/null +++ b/core-jackson3/pom.xml @@ -0,0 +1,72 @@ + + + 4.0.0 + + org.keycloak + keycloak-parent + 999.0.0-SNAPSHOT + + + keycloak-core-jackson3 + Keycloak Core Jackson 3 Adapters + Jackson 3 adapters for shared Keycloak representation annotations, without mapper policy or provider registration. + + + 17 + + + + + org.keycloak + keycloak-core + + + * + * + + + + + org.keycloak + keycloak-common + + + * + * + + + + + com.fasterxml.jackson.core + jackson-databind + + test + + + tools.jackson.core + jackson-databind + + + junit + junit + test + + + + + + + maven-jar-plugin + + + + test-jar + + + + + + + diff --git a/integration/admin-client-jackson3/src/main/java/org/keycloak/admin/client/jackson3/KeycloakAnnotationIntrospector3.java b/core-jackson3/src/main/java/org/keycloak/json/jackson3/KeycloakAnnotationIntrospector3.java similarity index 93% rename from integration/admin-client-jackson3/src/main/java/org/keycloak/admin/client/jackson3/KeycloakAnnotationIntrospector3.java rename to core-jackson3/src/main/java/org/keycloak/json/jackson3/KeycloakAnnotationIntrospector3.java index d1e34c23643a..3609fcc0513a 100644 --- a/integration/admin-client-jackson3/src/main/java/org/keycloak/admin/client/jackson3/KeycloakAnnotationIntrospector3.java +++ b/core-jackson3/src/main/java/org/keycloak/json/jackson3/KeycloakAnnotationIntrospector3.java @@ -1,4 +1,4 @@ -package org.keycloak.admin.client.jackson3; +package org.keycloak.json.jackson3; import java.io.Serial; @@ -17,7 +17,7 @@ * Jackson 3 cannot expand the inner {@code @JsonDeserialize} (wrong package), * so this introspector maps them to the Jackson 3 equivalents directly. */ -class KeycloakAnnotationIntrospector3 extends JacksonAnnotationIntrospector { +public class KeycloakAnnotationIntrospector3 extends JacksonAnnotationIntrospector { @Serial private static final long serialVersionUID = 1L; diff --git a/integration/admin-client-jackson3/src/main/java/org/keycloak/admin/client/jackson3/MultivaluedHashMapValueDeserializer3.java b/core-jackson3/src/main/java/org/keycloak/json/jackson3/MultivaluedHashMapValueDeserializer3.java similarity index 89% rename from integration/admin-client-jackson3/src/main/java/org/keycloak/admin/client/jackson3/MultivaluedHashMapValueDeserializer3.java rename to core-jackson3/src/main/java/org/keycloak/json/jackson3/MultivaluedHashMapValueDeserializer3.java index 489920d1d351..057aee72d665 100644 --- a/integration/admin-client-jackson3/src/main/java/org/keycloak/admin/client/jackson3/MultivaluedHashMapValueDeserializer3.java +++ b/core-jackson3/src/main/java/org/keycloak/json/jackson3/MultivaluedHashMapValueDeserializer3.java @@ -1,4 +1,4 @@ -package org.keycloak.admin.client.jackson3; +package org.keycloak.json.jackson3; import java.util.Map.Entry; @@ -9,7 +9,7 @@ import tools.jackson.databind.JsonNode; import tools.jackson.databind.ValueDeserializer; -class MultivaluedHashMapValueDeserializer3 extends ValueDeserializer { +public class MultivaluedHashMapValueDeserializer3 extends ValueDeserializer { @Override public Object deserialize(JsonParser p, DeserializationContext ctxt) { diff --git a/integration/admin-client-jackson3/src/main/java/org/keycloak/admin/client/jackson3/MultivaluedHashMapValueSerializer3.java b/core-jackson3/src/main/java/org/keycloak/json/jackson3/MultivaluedHashMapValueSerializer3.java similarity index 93% rename from integration/admin-client-jackson3/src/main/java/org/keycloak/admin/client/jackson3/MultivaluedHashMapValueSerializer3.java rename to core-jackson3/src/main/java/org/keycloak/json/jackson3/MultivaluedHashMapValueSerializer3.java index fc0a13fc9967..d86ae2578147 100644 --- a/integration/admin-client-jackson3/src/main/java/org/keycloak/admin/client/jackson3/MultivaluedHashMapValueSerializer3.java +++ b/core-jackson3/src/main/java/org/keycloak/json/jackson3/MultivaluedHashMapValueSerializer3.java @@ -1,4 +1,4 @@ -package org.keycloak.admin.client.jackson3; +package org.keycloak.json.jackson3; import java.lang.reflect.Method; import java.util.Arrays; @@ -13,7 +13,7 @@ import tools.jackson.databind.SerializationContext; import tools.jackson.databind.ValueSerializer; -class MultivaluedHashMapValueSerializer3 extends ValueSerializer> { +public class MultivaluedHashMapValueSerializer3 extends ValueSerializer> { @Override public void serialize(MultivaluedHashMap map, JsonGenerator gen, SerializationContext ctxt) { diff --git a/integration/admin-client-jackson3/src/main/java/org/keycloak/admin/client/jackson3/ResourceTypeMapDeserializer3.java b/core-jackson3/src/main/java/org/keycloak/json/jackson3/ResourceTypeMapDeserializer3.java similarity index 88% rename from integration/admin-client-jackson3/src/main/java/org/keycloak/admin/client/jackson3/ResourceTypeMapDeserializer3.java rename to core-jackson3/src/main/java/org/keycloak/json/jackson3/ResourceTypeMapDeserializer3.java index 452f27761a1a..54eadffd7541 100644 --- a/integration/admin-client-jackson3/src/main/java/org/keycloak/admin/client/jackson3/ResourceTypeMapDeserializer3.java +++ b/core-jackson3/src/main/java/org/keycloak/json/jackson3/ResourceTypeMapDeserializer3.java @@ -1,4 +1,4 @@ -package org.keycloak.admin.client.jackson3; +package org.keycloak.json.jackson3; import java.util.List; import java.util.Map; @@ -12,7 +12,7 @@ import tools.jackson.databind.DeserializationContext; import tools.jackson.databind.ValueDeserializer; -class ResourceTypeMapDeserializer3 extends ValueDeserializer> { +public class ResourceTypeMapDeserializer3 extends ValueDeserializer> { @Override public Map deserialize(JsonParser p, DeserializationContext ctxt) { diff --git a/integration/admin-client-jackson3/src/main/java/org/keycloak/admin/client/jackson3/StringListMapDeserializer3.java b/core-jackson3/src/main/java/org/keycloak/json/jackson3/StringListMapDeserializer3.java similarity index 89% rename from integration/admin-client-jackson3/src/main/java/org/keycloak/admin/client/jackson3/StringListMapDeserializer3.java rename to core-jackson3/src/main/java/org/keycloak/json/jackson3/StringListMapDeserializer3.java index c3f854dfb0e1..d7bb35b91973 100644 --- a/integration/admin-client-jackson3/src/main/java/org/keycloak/admin/client/jackson3/StringListMapDeserializer3.java +++ b/core-jackson3/src/main/java/org/keycloak/json/jackson3/StringListMapDeserializer3.java @@ -1,4 +1,4 @@ -package org.keycloak.admin.client.jackson3; +package org.keycloak.json.jackson3; import java.util.HashMap; import java.util.LinkedList; @@ -10,7 +10,7 @@ import tools.jackson.databind.JsonNode; import tools.jackson.databind.ValueDeserializer; -class StringListMapDeserializer3 extends ValueDeserializer { +public class StringListMapDeserializer3 extends ValueDeserializer { @Override public Object deserialize(JsonParser p, DeserializationContext ctxt) { diff --git a/integration/admin-client-jackson3/src/main/java/org/keycloak/admin/client/jackson3/StringOrArrayDeserializer3.java b/core-jackson3/src/main/java/org/keycloak/json/jackson3/StringOrArrayDeserializer3.java similarity index 68% rename from integration/admin-client-jackson3/src/main/java/org/keycloak/admin/client/jackson3/StringOrArrayDeserializer3.java rename to core-jackson3/src/main/java/org/keycloak/json/jackson3/StringOrArrayDeserializer3.java index 224fecab803c..febe926430c3 100644 --- a/integration/admin-client-jackson3/src/main/java/org/keycloak/admin/client/jackson3/StringOrArrayDeserializer3.java +++ b/core-jackson3/src/main/java/org/keycloak/json/jackson3/StringOrArrayDeserializer3.java @@ -1,4 +1,4 @@ -package org.keycloak.admin.client.jackson3; +package org.keycloak.json.jackson3; import java.util.ArrayList; @@ -7,7 +7,7 @@ import tools.jackson.databind.JsonNode; import tools.jackson.databind.ValueDeserializer; -class StringOrArrayDeserializer3 extends ValueDeserializer { +public class StringOrArrayDeserializer3 extends ValueDeserializer { @Override public Object deserialize(JsonParser p, DeserializationContext ctxt) { @@ -15,11 +15,11 @@ public Object deserialize(JsonParser p, DeserializationContext ctxt) { if (jsonNode.isArray()) { ArrayList a = new ArrayList<>(1); for (JsonNode child : jsonNode) { - a.add(child.stringValue()); + a.add(child.isString() ? child.stringValue() : null); } return a.toArray(new String[0]); } else { - return new String[] { jsonNode.stringValue() }; + return new String[] { jsonNode.isString() ? jsonNode.stringValue() : null }; } } } diff --git a/integration/admin-client-jackson3/src/main/java/org/keycloak/admin/client/jackson3/StringOrArraySerializer3.java b/core-jackson3/src/main/java/org/keycloak/json/jackson3/StringOrArraySerializer3.java similarity index 84% rename from integration/admin-client-jackson3/src/main/java/org/keycloak/admin/client/jackson3/StringOrArraySerializer3.java rename to core-jackson3/src/main/java/org/keycloak/json/jackson3/StringOrArraySerializer3.java index 0e6dd6d329c4..7ff5b3cb69cf 100644 --- a/integration/admin-client-jackson3/src/main/java/org/keycloak/admin/client/jackson3/StringOrArraySerializer3.java +++ b/core-jackson3/src/main/java/org/keycloak/json/jackson3/StringOrArraySerializer3.java @@ -1,10 +1,10 @@ -package org.keycloak.admin.client.jackson3; +package org.keycloak.json.jackson3; import tools.jackson.core.JsonGenerator; import tools.jackson.databind.SerializationContext; import tools.jackson.databind.ValueSerializer; -class StringOrArraySerializer3 extends ValueSerializer { +public class StringOrArraySerializer3 extends ValueSerializer { @Override public void serialize(Object o, JsonGenerator gen, SerializationContext ctxt) { String[] array = (String[]) o; diff --git a/core-jackson3/src/test/java/org/keycloak/json/jackson3/RepresentationAdaptersTest.java b/core-jackson3/src/test/java/org/keycloak/json/jackson3/RepresentationAdaptersTest.java new file mode 100644 index 000000000000..7e4d7731fdaa --- /dev/null +++ b/core-jackson3/src/test/java/org/keycloak/json/jackson3/RepresentationAdaptersTest.java @@ -0,0 +1,163 @@ +package org.keycloak.json.jackson3; + +import java.util.Arrays; +import java.util.List; +import java.util.Map; +import java.util.Set; + +import org.keycloak.common.util.MultivaluedHashMap; +import org.keycloak.json.MultivaluedHashMapValue; +import org.keycloak.json.ResourceTypeMap; +import org.keycloak.representations.JsonWebToken; +import org.keycloak.representations.idm.UserRepresentation; +import org.keycloak.representations.idm.authorization.ResourceType; +import org.keycloak.representations.workflows.WorkflowRepresentation; +import org.keycloak.representations.workflows.WorkflowStepRepresentation; + +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.databind.ObjectMapper; +import org.junit.Test; +import tools.jackson.databind.json.JsonMapper; + +import static org.hamcrest.CoreMatchers.equalTo; +import static org.hamcrest.CoreMatchers.is; +import static org.hamcrest.MatcherAssert.assertThat; +import static org.junit.Assert.assertThrows; + +/** + * Client and server run the same representation contracts with their own mapper policies. + */ +public class RepresentationAdaptersTest { + + protected JsonMapper mapper() { + return JsonMapper.builder() + .configureForJackson2() + .annotationIntrospector(new KeycloakAnnotationIntrospector3()) + .changeDefaultPropertyInclusion(value -> JsonInclude.Value.construct( + JsonInclude.Include.NON_NULL, JsonInclude.Include.NON_NULL)) + .build(); + } + + private final ObjectMapper legacyMapper = new ObjectMapper() + .setSerializationInclusion(JsonInclude.Include.NON_NULL); + + @Test + public void stringListMapAcceptsScalarArrayAndNullAttributes() throws Exception { + String json = """ + {"username":"alice","attributes":{ + "scalar":"value","array":["first","second"],"empty":[], + "null":null,"mixed":[null,"text",true,42],"boolean":false,"number":12}} + """; + var expected = legacyMapper.readValue(json, UserRepresentation.class); + var actual = mapper().readValue(json, UserRepresentation.class); + + assertThat(actual.getAttributes(), equalTo(expected.getAttributes())); + assertThat(actual.getAttributes().get("scalar"), equalTo(List.of("value"))); + assertThat(actual.getAttributes().get("mixed"), equalTo(Arrays.asList(null, "text", "true", "42"))); + assertWireParity(actual); + } + + @Test + public void audienceRetainsScalarAndArrayWireForms() throws Exception { + for (String audience : List.of("\"one\"", "[\"one\"]", "[\"one\",\"two\"]", "[]", "null")) { + String json = "{\"aud\":" + audience + "}"; + var expected = legacyMapper.readValue(json, JsonWebToken.class); + var actual = mapper().readValue(json, JsonWebToken.class); + + assertThat(actual.getAudience(), equalTo(expected.getAudience())); + assertWireParity(actual); + } + var token = new JsonWebToken().audience("one"); + assertThat(mapper().readTree(mapper().writeValueAsString(token)).get("aud").stringValue(), equalTo("one")); + } + + @Test + public void audiencePreservesLegacyNonTextValues() throws Exception { + for (String audience : List.of("42", "true", "{}", "[null,42,true,{},[],\"one\"]")) { + String json = "{\"aud\":" + audience + "}"; + var expected = legacyMapper.readValue(json, JsonWebToken.class); + var actual = mapper().readValue(json, JsonWebToken.class); + + assertThat(actual.getAudience(), equalTo(expected.getAudience())); + assertWireParity(actual); + } + } + + @Test + public void resourceTypesAcceptArrayAndObjectForms() throws Exception { + String resource = "{\"type\":\"document\",\"scopes\":[\"read\",\"write\"]}"; + for (String types : List.of("[" + resource + "]", "{\"document\":" + resource + "}")) { + String json = "{\"resourceTypes\":" + types + "}"; + var expected = legacyMapper.readValue(json, ResourceTypesValue.class); + var actual = mapper().readValue(json, ResourceTypesValue.class); + + assertThat(actual.resourceTypes.keySet(), equalTo(Set.of("document"))); + assertThat(actual.resourceTypes.get("document").getScopes(), equalTo(expected.resourceTypes.get("document").getScopes())); + assertWireParity(actual); + } + } + + @Test + public void resourceTypesRejectScalarInput() { + assertThrows(tools.jackson.databind.exc.MismatchedInputException.class, + () -> mapper().readValue("{\"resourceTypes\":42}", ResourceTypesValue.class)); + } + + @Test + public void multivaluedWorkflowConfigurationSerializationPreservesWireShape() throws Exception { + var workflow = WorkflowRepresentation.withName("test") + .onEvent("user-created") + .withSteps(WorkflowStepRepresentation.create().of("set-user-attribute") + .withConfig("key", "value") + .withConfig("enabled", "true") + .withConfig("values", "first", "second").build()) + .build(); + assertWireParity(workflow); + } + + @Test + public void multivaluedConfigurationPreservesValuesAndFiltersReservedProperties() throws Exception { + String json = """ + {"config":{"reserved":"hidden","scalar":"value","flag":true,"values":["first","second"]}} + """; + var expected = legacyMapper.readValue(json, MultivaluedValue.class); + var actual = mapper().readValue(json, MultivaluedValue.class); + + assertThat(actual.config, equalTo(expected.config)); + assertThat(actual.config.get("flag"), equalTo(List.of("true"))); + assertThat(mapper().readTree(mapper().writeValueAsString(actual)).get("config").has("reserved"), is(false)); + assertWireParity(actual); + } + + @Test + public void nativeJacksonNamingWorksInBothDirections() { + var value = mapper().readValue("{\"some-value\":\"text\"}", NativeNamingValue.class); + + assertThat(value.someValue, equalTo("text")); + assertThat(mapper().writeValueAsString(value), equalTo("{\"some-value\":\"text\"}")); + } + + private void assertWireParity(Object value) throws Exception { + assertThat(legacyMapper.readTree(mapper().writeValueAsString(value)), + equalTo(legacyMapper.readTree(legacyMapper.writeValueAsString(value)))); + } + + @tools.jackson.databind.annotation.JsonNaming(tools.jackson.databind.PropertyNamingStrategies.KebabCaseStrategy.class) + public static class NativeNamingValue { + public String someValue; + } + + public static class ResourceTypesValue { + @ResourceTypeMap + public Map resourceTypes; + } + + public static class MultivaluedValue { + @MultivaluedHashMapValue + public MultivaluedHashMap config; + + public String getReserved() { + return "visible"; + } + } +} diff --git a/core/src/main/java/org/keycloak/representations/idm/RealmRepresentation.java b/core/src/main/java/org/keycloak/representations/idm/RealmRepresentation.java index df2b2367d807..3589a6fc8676 100755 --- a/core/src/main/java/org/keycloak/representations/idm/RealmRepresentation.java +++ b/core/src/main/java/org/keycloak/representations/idm/RealmRepresentation.java @@ -525,6 +525,7 @@ public void setOAuth2DeviceCodeLifespan(Integer oauth2DeviceCodeLifespan) { } @Schema(name = "oauth2DeviceCodeLifespan") + @JsonProperty("oauth2DeviceCodeLifespan") public Integer getOAuth2DeviceCodeLifespan() { return oauth2DeviceCodeLifespan; } @@ -534,6 +535,7 @@ public void setOAuth2DevicePollingInterval(Integer oauth2DevicePollingInterval) } @Schema(name = "oauth2DevicePollingInterval") + @JsonProperty("oauth2DevicePollingInterval") public Integer getOAuth2DevicePollingInterval() { return oauth2DevicePollingInterval; } diff --git a/core/src/test/java/org/keycloak/representations/idm/RealmRepresentationJsonTest.java b/core/src/test/java/org/keycloak/representations/idm/RealmRepresentationJsonTest.java new file mode 100644 index 000000000000..f1794ec55686 --- /dev/null +++ b/core/src/test/java/org/keycloak/representations/idm/RealmRepresentationJsonTest.java @@ -0,0 +1,28 @@ +package org.keycloak.representations.idm; + +import com.fasterxml.jackson.databind.JsonNode; +import com.fasterxml.jackson.databind.ObjectMapper; +import org.junit.Test; + +import static org.hamcrest.CoreMatchers.equalTo; +import static org.hamcrest.CoreMatchers.is; +import static org.hamcrest.MatcherAssert.assertThat; + +public class RealmRepresentationJsonTest { + + @Test + public void deviceSettingsRetainJackson2WireNames() throws Exception { + ObjectMapper mapper = new ObjectMapper(); + RealmRepresentation realm = mapper.readValue("{\"oauth2DeviceCodeLifespan\":600,\"oauth2DevicePollingInterval\":5}", + RealmRepresentation.class); + + assertThat(realm.getOAuth2DeviceCodeLifespan(), equalTo(Integer.valueOf(600))); + assertThat(realm.getOAuth2DevicePollingInterval(), equalTo(Integer.valueOf(5))); + + JsonNode json = mapper.readTree(mapper.writeValueAsString(realm)); + assertThat(json.path("oauth2DeviceCodeLifespan").asInt(), equalTo(600)); + assertThat(json.path("oauth2DevicePollingInterval").asInt(), equalTo(5)); + assertThat(json.has("OAuth2DeviceCodeLifespan"), is(false)); + assertThat(json.has("OAuth2DevicePollingInterval"), is(false)); + } +} diff --git a/integration/admin-client-jackson3/pom.xml b/integration/admin-client-jackson3/pom.xml index a6e17368c5df..24529bb86928 100644 --- a/integration/admin-client-jackson3/pom.xml +++ b/integration/admin-client-jackson3/pom.xml @@ -22,6 +22,10 @@ + + org.keycloak + keycloak-core-jackson3 + org.keycloak keycloak-admin-client-core @@ -42,6 +46,24 @@ resteasy-client ${resteasy.version} + + org.keycloak + keycloak-core-jackson3 + ${project.version} + test-jar + test + + + junit + junit + test + + + com.fasterxml.jackson.core + jackson-databind + + test + diff --git a/integration/admin-client-jackson3/src/main/java/org/keycloak/admin/client/jackson3/Jackson3MapperHolder.java b/integration/admin-client-jackson3/src/main/java/org/keycloak/admin/client/jackson3/Jackson3MapperHolder.java index 3aa47267c016..efce5f712849 100644 --- a/integration/admin-client-jackson3/src/main/java/org/keycloak/admin/client/jackson3/Jackson3MapperHolder.java +++ b/integration/admin-client-jackson3/src/main/java/org/keycloak/admin/client/jackson3/Jackson3MapperHolder.java @@ -1,5 +1,7 @@ package org.keycloak.admin.client.jackson3; +import org.keycloak.json.jackson3.KeycloakAnnotationIntrospector3; + import com.fasterxml.jackson.annotation.JsonInclude; import tools.jackson.databind.AnnotationIntrospector; import tools.jackson.databind.DeserializationFeature; diff --git a/integration/admin-client-jackson3/src/test/java/org/keycloak/admin/client/jackson3/RepresentationAdaptersTest.java b/integration/admin-client-jackson3/src/test/java/org/keycloak/admin/client/jackson3/RepresentationAdaptersTest.java new file mode 100644 index 000000000000..9f6cab9df141 --- /dev/null +++ b/integration/admin-client-jackson3/src/test/java/org/keycloak/admin/client/jackson3/RepresentationAdaptersTest.java @@ -0,0 +1,25 @@ +package org.keycloak.admin.client.jackson3; + +import org.keycloak.representations.idm.UserRepresentation; + +import org.junit.Test; +import tools.jackson.databind.json.JsonMapper; + +import static org.hamcrest.CoreMatchers.equalTo; +import static org.hamcrest.MatcherAssert.assertThat; + +public class RepresentationAdaptersTest extends org.keycloak.json.jackson3.RepresentationAdaptersTest { + + @Override + protected JsonMapper mapper() { + return Jackson3MapperHolder.MAPPER; + } + + @Test + public void publicClientMapperRetainsUnknownPropertyLeniency() { + var mapper = new Jackson3JsonMapper(); + var user = mapper.readValue("{\"username\":\"alice\",\"unknown\":true}", UserRepresentation.class); + + assertThat(user.getUsername(), equalTo("alice")); + } +} diff --git a/operator/src/test/java/org/keycloak/operator/testsuite/unit/CRSerializationTest.java b/operator/src/test/java/org/keycloak/operator/testsuite/unit/CRSerializationTest.java index d6865d668667..5ac41bb76f64 100644 --- a/operator/src/test/java/org/keycloak/operator/testsuite/unit/CRSerializationTest.java +++ b/operator/src/test/java/org/keycloak/operator/testsuite/unit/CRSerializationTest.java @@ -61,6 +61,31 @@ public class CRSerializationTest { + @Test + public void realmImportPreservesDeviceSettingNames() { + var resource = Serialization.unmarshal(""" + apiVersion: k8s.keycloak.org/v2beta1 + kind: KeycloakRealmImport + metadata: + name: device-settings + spec: + keycloakCRName: example + realm: + realm: example + oauth2DeviceCodeLifespan: 600 + oauth2DevicePollingInterval: 5 + """, KeycloakRealmImport.class); + var realm = resource.getSpec().getRealm(); + assertEquals(600, realm.getOAuth2DeviceCodeLifespan()); + assertEquals(5, realm.getOAuth2DevicePollingInterval()); + + var json = Serialization.jsonMapper().readTree(Serialization.asJson(resource)).path("spec").path("realm"); + assertEquals(600, json.path("oauth2DeviceCodeLifespan").asInt()); + assertEquals(5, json.path("oauth2DevicePollingInterval").asInt()); + assertFalse(json.has("OAuth2DeviceCodeLifespan")); + assertFalse(json.has("OAuth2DevicePollingInterval")); + } + private static final Map CUSTOM_INGRESS_ANNOTATION = Map.of( "myAnnotation", "myValue", "anotherAnnotation", "anotherValue" diff --git a/pom.xml b/pom.xml index 3ac750054736..7fb242edd632 100644 --- a/pom.xml +++ b/pom.xml @@ -312,6 +312,7 @@ boms common core + core-jackson3 crypto dependencies server-spi @@ -926,6 +927,11 @@ keycloak-common ${project.version} + + org.keycloak + keycloak-core-jackson3 + ${project.version} + org.keycloak keycloak-core diff --git a/quarkus/runtime/pom.xml b/quarkus/runtime/pom.xml index 37835f04873f..078938c03cba 100644 --- a/quarkus/runtime/pom.xml +++ b/quarkus/runtime/pom.xml @@ -14,6 +14,10 @@ keycloak-quarkus-server Keycloak Server + + org.keycloak + keycloak-core-jackson3 + io.quarkus @@ -45,6 +49,14 @@ io.quarkus quarkus-rest-jackson + + com.fasterxml.jackson.datatype + jackson-datatype-jdk8 + + + com.fasterxml.jackson.datatype + jackson-datatype-jsr310 + io.quarkus quarkus-hibernate-orm @@ -765,6 +777,13 @@ junit test + + org.keycloak + keycloak-core-jackson3 + ${project.version} + test-jar + test + org.hamcrest diff --git a/quarkus/runtime/src/main/java/org/keycloak/quarkus/runtime/integration/jaxrs/LegacyJsonNodeAdapter.java b/quarkus/runtime/src/main/java/org/keycloak/quarkus/runtime/integration/jaxrs/LegacyJsonNodeAdapter.java new file mode 100644 index 000000000000..6ec4d5ef374f --- /dev/null +++ b/quarkus/runtime/src/main/java/org/keycloak/quarkus/runtime/integration/jaxrs/LegacyJsonNodeAdapter.java @@ -0,0 +1,102 @@ +package org.keycloak.quarkus.runtime.integration.jaxrs; + +import com.fasterxml.jackson.databind.JsonNode; +import com.fasterxml.jackson.databind.node.JsonNodeFactory; +import com.fasterxml.jackson.databind.node.POJONode; +import tools.jackson.core.JsonGenerator; +import tools.jackson.core.JsonParser; +import tools.jackson.databind.DeserializationContext; +import tools.jackson.databind.SerializationContext; +import tools.jackson.databind.ValueDeserializer; +import tools.jackson.databind.ValueSerializer; +import tools.jackson.databind.module.SimpleModule; + +/** + * Keeps public Jackson 2 tree properties usable by the REST mapper, including token-buffer + * conversions. Raw JSON would bypass tokens and turn nested values into opaque raw values. + */ +final class LegacyJsonNodeAdapter extends SimpleModule { + + LegacyJsonNodeAdapter(JsonNodeFactory factory) { + addSerializer(JsonNode.class, new Serializer()); + addDeserializer(JsonNode.class, new ValueDeserializer<>() { + @Override + public JsonNode deserialize(JsonParser parser, DeserializationContext context) { + return toLegacy(context.readTree(parser), factory); + } + + @Override + public JsonNode getNullValue(DeserializationContext context) { + return factory.nullNode(); + } + }); + } + + static JsonNode toLegacy(tools.jackson.databind.JsonNode node, JsonNodeFactory factory) { + return switch (node.getNodeType()) { + case OBJECT -> { + var object = factory.objectNode(); + node.properties().forEach(property -> object.set(property.getKey(), toLegacy(property.getValue(), factory))); + yield object; + } + case ARRAY -> { + var array = factory.arrayNode(); + node.forEach(element -> array.add(toLegacy(element, factory))); + yield array; + } + case STRING -> factory.textNode(node.stringValue()); + case BOOLEAN -> factory.booleanNode(node.booleanValue()); + case NULL -> factory.nullNode(); + case MISSING -> factory.missingNode(); + case BINARY -> factory.binaryNode(node.binaryValue()); + case POJO -> factory.pojoNode(((tools.jackson.databind.node.POJONode) node).getPojo()); + case NUMBER -> switch (((tools.jackson.databind.node.NumericNode) node).numberType()) { + case INT -> factory.numberNode(node.intValue()); + case LONG -> factory.numberNode(node.longValue()); + case BIG_INTEGER -> factory.numberNode(node.bigIntegerValue()); + case FLOAT -> factory.numberNode(node.floatValue()); + case DOUBLE -> factory.numberNode(node.doubleValue()); + case BIG_DECIMAL -> factory.numberNode(node.decimalValue()); + }; + }; + } + + private static final class Serializer extends ValueSerializer { + + @Override + public void serialize(JsonNode node, JsonGenerator generator, SerializationContext context) { + switch (node.getNodeType()) { + case OBJECT -> { + generator.writeStartObject(node); + node.properties().forEach(property -> { + generator.writeName(property.getKey()); + serialize(property.getValue(), generator, context); + }); + generator.writeEndObject(); + } + case ARRAY -> { + generator.writeStartArray(node, node.size()); + node.forEach(element -> serialize(element, generator, context)); + generator.writeEndArray(); + } + case STRING -> generator.writeString(node.textValue()); + case BOOLEAN -> generator.writeBoolean(node.booleanValue()); + case NULL, MISSING -> generator.writeNull(); + case BINARY -> generator.writeBinary(((com.fasterxml.jackson.databind.node.BinaryNode) node).binaryValue()); + case POJO -> context.writeValue(generator, ((POJONode) node).getPojo()); + case NUMBER -> { + // Emit numbers as numbers, including non-finite floating-point values. The + // JSON generator retains the legacy quoting policy; token buffers retain types. + switch (node.numberType()) { + case INT -> generator.writeNumber(node.intValue()); + case LONG -> generator.writeNumber(node.longValue()); + case BIG_INTEGER -> generator.writeNumber(node.bigIntegerValue()); + case FLOAT -> generator.writeNumber(node.floatValue()); + case DOUBLE -> generator.writeNumber(node.doubleValue()); + case BIG_DECIMAL -> generator.writeNumber(node.decimalValue()); + } + } + } + } + } +} diff --git a/quarkus/runtime/src/main/java/org/keycloak/quarkus/runtime/integration/jaxrs/LegacyNamingAnnotationIntrospector.java b/quarkus/runtime/src/main/java/org/keycloak/quarkus/runtime/integration/jaxrs/LegacyNamingAnnotationIntrospector.java new file mode 100644 index 000000000000..39bfeffbe36d --- /dev/null +++ b/quarkus/runtime/src/main/java/org/keycloak/quarkus/runtime/integration/jaxrs/LegacyNamingAnnotationIntrospector.java @@ -0,0 +1,30 @@ +package org.keycloak.quarkus.runtime.integration.jaxrs; + +import java.io.Serial; + +import org.keycloak.json.jackson3.KeycloakAnnotationIntrospector3; + +import com.fasterxml.jackson.databind.annotation.JsonNaming; +import tools.jackson.databind.PropertyNamingStrategies; +import tools.jackson.databind.cfg.MapperConfig; +import tools.jackson.databind.introspect.AnnotatedClass; + +/** Server compatibility for providers still using Jackson 2 naming annotations. */ +final class LegacyNamingAnnotationIntrospector extends KeycloakAnnotationIntrospector3 { + + @Serial + private static final long serialVersionUID = 1L; + + @Override + public Object findNamingStrategy(MapperConfig config, AnnotatedClass annotated) { + Object strategy = super.findNamingStrategy(config, annotated); + if (strategy != null) { + return strategy; + } + JsonNaming naming = annotated.getAnnotation(JsonNaming.class); + if (naming != null && naming.value() == com.fasterxml.jackson.databind.PropertyNamingStrategies.SnakeCaseStrategy.class) { + return PropertyNamingStrategies.SNAKE_CASE; + } + return null; + } +} diff --git a/quarkus/runtime/src/main/java/org/keycloak/quarkus/runtime/integration/jaxrs/QuarkusJacksonExceptionHandler.java b/quarkus/runtime/src/main/java/org/keycloak/quarkus/runtime/integration/jaxrs/QuarkusJacksonExceptionHandler.java new file mode 100644 index 000000000000..270d6d0b99d2 --- /dev/null +++ b/quarkus/runtime/src/main/java/org/keycloak/quarkus/runtime/integration/jaxrs/QuarkusJacksonExceptionHandler.java @@ -0,0 +1,52 @@ +package org.keycloak.quarkus.runtime.integration.jaxrs; + +import jakarta.ws.rs.WebApplicationException; +import jakarta.ws.rs.core.Context; +import jakarta.ws.rs.core.Response; +import jakarta.ws.rs.ext.Provider; + +import org.keycloak.OAuthErrorException; +import org.keycloak.models.KeycloakSession; +import org.keycloak.representations.idm.OAuth2ErrorRepresentation; +import org.keycloak.services.error.KeycloakErrorHandler; + +import org.jboss.resteasy.reactive.server.ServerExceptionMapper; +import tools.jackson.core.JacksonException; +import tools.jackson.core.exc.StreamReadException; +import tools.jackson.databind.exc.MismatchedInputException; + +@Provider +public class QuarkusJacksonExceptionHandler { + + @Context + KeycloakSession session; + + @ServerExceptionMapper + public Response jacksonException(JacksonException exception) { + // The Jackson base type also covers response serialization failures. Quarkus's readers + // wrap input failures in an explicit HTTP 400, except for mismatched input (handled below) + // and invalid definitions (server errors). Do not infer bad input from the base type. + return KeycloakErrorHandler.getResponse(session, exception); + } + + @ServerExceptionMapper + public Response mismatchedInput(MismatchedInputException exception) { + return jsonError(exception, exception); + } + + @ServerExceptionMapper + public Response webApplication(WebApplicationException exception) { + if (exception.getResponse().getStatus() == Response.Status.BAD_REQUEST.getStatusCode() + && exception.getCause() instanceof JacksonException jacksonException) { + return jsonError(exception, jacksonException); + } + return KeycloakErrorHandler.getResponse(session, exception); + } + + private Response jsonError(Throwable exception, JacksonException jacksonException) { + OAuth2ErrorRepresentation error = new OAuth2ErrorRepresentation(); + error.setError(jacksonException instanceof StreamReadException ? OAuthErrorException.INVALID_REQUEST : "unknown_error"); + error.setErrorDescription("Cannot parse the JSON"); + return KeycloakErrorHandler.getResponse(session, exception, Response.Status.BAD_REQUEST, error); + } +} diff --git a/quarkus/runtime/src/main/java/org/keycloak/quarkus/runtime/integration/jaxrs/QuarkusObjectMapperResolver.java b/quarkus/runtime/src/main/java/org/keycloak/quarkus/runtime/integration/jaxrs/QuarkusObjectMapperResolver.java index 94e90d96720d..7d8894b9a100 100644 --- a/quarkus/runtime/src/main/java/org/keycloak/quarkus/runtime/integration/jaxrs/QuarkusObjectMapperResolver.java +++ b/quarkus/runtime/src/main/java/org/keycloak/quarkus/runtime/integration/jaxrs/QuarkusObjectMapperResolver.java @@ -17,20 +17,68 @@ package org.keycloak.quarkus.runtime.integration.jaxrs; +import java.io.IOException; + import jakarta.enterprise.context.ApplicationScoped; import jakarta.enterprise.inject.Produces; +import jakarta.ws.rs.ext.ContextResolver; import jakarta.ws.rs.ext.Provider; import org.keycloak.services.util.ObjectMapperResolver; +import org.keycloak.ssf.subject.SubjectId; +import org.keycloak.ssf.subject.SubjectIdJsonDeserializer; -import com.fasterxml.jackson.databind.ObjectMapper; +import com.fasterxml.jackson.annotation.JsonInclude; +import tools.jackson.core.JsonParser; +import tools.jackson.databind.DeserializationContext; +import tools.jackson.databind.ObjectMapper; +import tools.jackson.databind.SerializationFeature; +import tools.jackson.databind.ValueDeserializer; +import tools.jackson.databind.json.JsonMapper; +import tools.jackson.databind.module.SimpleModule; @Provider @ApplicationScoped -public class QuarkusObjectMapperResolver extends ObjectMapperResolver { +public class QuarkusObjectMapperResolver implements ContextResolver { + + private final com.fasterxml.jackson.databind.ObjectMapper legacyMapper = new ObjectMapperResolver().getContext(Object.class); + private final ObjectMapper mapper = createMapper(legacyMapper); @Produces - public ObjectMapper getObjectMapper() { + public com.fasterxml.jackson.databind.ObjectMapper getObjectMapper() { + return legacyMapper; + } + + @Override + public ObjectMapper getContext(Class type) { return mapper; } + + private static ObjectMapper createMapper(com.fasterxml.jackson.databind.ObjectMapper legacyMapper) { + var subjectMapper = legacyMapper.copy().registerModule(new com.fasterxml.jackson.databind.module.SimpleModule() + .addDeserializer(SubjectId.class, new SubjectIdJsonDeserializer())); + var builder = JsonMapper.builder() + .configureForJackson2() + .annotationIntrospector(new LegacyNamingAnnotationIntrospector()) + .addModule(new LegacyJsonNodeAdapter(legacyMapper.getNodeFactory())) + .addModule(new SimpleModule().addDeserializer(SubjectId.class, new ValueDeserializer() { + @Override + public SubjectId deserialize(JsonParser parser, DeserializationContext context) { + try { + var tree = LegacyJsonNodeAdapter.toLegacy(context.readTree(parser), subjectMapper.getNodeFactory()); + try (var subjectParser = tree.traverse(subjectMapper)) { + return subjectMapper.readValue(subjectParser, SubjectId.class); + } + } catch (IOException exception) { + return context.reportInputMismatch(SubjectId.class, "Unable to read the subject identifier"); + } + } + })) + .changeDefaultPropertyInclusion(inclusion -> JsonInclude.Value.construct(JsonInclude.Include.NON_NULL, JsonInclude.Include.NON_NULL)) + .configure(SerializationFeature.INDENT_OUTPUT, Boolean.getBoolean("keycloak.jsonPrettyPrint")); + if (Boolean.parseBoolean(System.getProperty("keycloak.jsonEnableJacksonModuleDiscovery", "true"))) { + builder.findAndAddModules(); + } + return builder.build(); + } } diff --git a/quarkus/runtime/src/main/java/org/keycloak/quarkus/runtime/integration/jaxrs/QuarkusUnrecognizedPropertyExceptionHandler.java b/quarkus/runtime/src/main/java/org/keycloak/quarkus/runtime/integration/jaxrs/QuarkusUnrecognizedPropertyExceptionHandler.java new file mode 100644 index 000000000000..9c09c326d37c --- /dev/null +++ b/quarkus/runtime/src/main/java/org/keycloak/quarkus/runtime/integration/jaxrs/QuarkusUnrecognizedPropertyExceptionHandler.java @@ -0,0 +1,27 @@ +package org.keycloak.quarkus.runtime.integration.jaxrs; + +import jakarta.ws.rs.BadRequestException; +import jakarta.ws.rs.core.Context; +import jakarta.ws.rs.core.Response; +import jakarta.ws.rs.ext.ExceptionMapper; +import jakarta.ws.rs.ext.Provider; + +import org.keycloak.models.KeycloakSession; +import org.keycloak.services.error.KeycloakErrorHandler; + +import tools.jackson.databind.exc.UnrecognizedPropertyException; + +@Provider +public class QuarkusUnrecognizedPropertyExceptionHandler implements ExceptionMapper { + + @Context + KeycloakSession session; + + @Override + public Response toResponse(UnrecognizedPropertyException exception) { + String message = String.format("Invalid json representation for %s. Unrecognized field \"%s\" at line %s column %s.", + exception.getReferringClass().getSimpleName(), exception.getPropertyName(), + exception.getLocation().getLineNr(), exception.getLocation().getColumnNr()); + return KeycloakErrorHandler.getResponse(session, new BadRequestException(message)); + } +} diff --git a/quarkus/runtime/src/test/java/org/keycloak/quarkus/runtime/integration/jaxrs/QuarkusObjectMapperResolverTest.java b/quarkus/runtime/src/test/java/org/keycloak/quarkus/runtime/integration/jaxrs/QuarkusObjectMapperResolverTest.java new file mode 100644 index 000000000000..482f89c9cb8e --- /dev/null +++ b/quarkus/runtime/src/test/java/org/keycloak/quarkus/runtime/integration/jaxrs/QuarkusObjectMapperResolverTest.java @@ -0,0 +1,281 @@ +package org.keycloak.quarkus.runtime.integration.jaxrs; + +import java.math.BigDecimal; +import java.math.BigInteger; +import java.util.LinkedHashMap; +import java.util.List; +import java.util.Map; +import java.util.stream.Stream; + +import org.keycloak.authorization.authzen.AuthZen; +import org.keycloak.representations.AccessTokenResponse; +import org.keycloak.representations.idm.authorization.AuthorizationSchema; +import org.keycloak.representations.workflows.WorkflowRepresentation; +import org.keycloak.representations.workflows.WorkflowStepRepresentation; +import org.keycloak.ssf.transmitter.resources.AddSubjectRequest; + +import org.junit.Test; + +import static org.hamcrest.CoreMatchers.containsString; +import static org.hamcrest.CoreMatchers.equalTo; +import static org.hamcrest.CoreMatchers.is; +import static org.hamcrest.CoreMatchers.nullValue; +import static org.hamcrest.MatcherAssert.assertThat; +import static org.junit.Assert.assertThrows; + +public class QuarkusObjectMapperResolverTest { + + @Test + public void omitNullTokenResponseFields() throws Exception { + var response = new AccessTokenResponse(); + response.setToken("access-token"); + var resolver = new QuarkusObjectMapperResolver(); + var mapper = resolver.getContext(AccessTokenResponse.class); + + var json = mapper.readTree(mapper.writeValueAsString(response)); + + assertThat(json.get("access_token").asString(), equalTo("access-token")); + assertThat(json.has("authorization_details"), is(false)); + assertThat(json.has("refresh_token"), is(false)); + + var legacyMapper = resolver.getObjectMapper(); + assertThat(legacyMapper.readTree(resolver.getContext(AccessTokenResponse.class).writeValueAsString(response)), + equalTo(legacyMapper.readTree(legacyMapper.writeValueAsString(response)))); + } + + @Test + public void serializeStreamsAsArrays() { + var mapper = new QuarkusObjectMapperResolver().getContext(Stream.class); + + assertThat(mapper.writeValueAsString(Stream.of("first", "second")), equalTo("[\"first\",\"second\"]")); + } + + @Test + public void omitNullMapValues() { + var values = new LinkedHashMap(); + values.put("visible", "value"); + values.put("hidden", null); + var mapper = new QuarkusObjectMapperResolver().getContext(values.getClass()); + + assertThat(mapper.writeValueAsString(values), equalTo("{\"visible\":\"value\"}")); + } + + @Test + public void honorPrettyPrinting() { + String previous = System.getProperty("keycloak.jsonPrettyPrint"); + try { + System.setProperty("keycloak.jsonPrettyPrint", "true"); + var mapper = new QuarkusObjectMapperResolver().getContext(Object.class); + var values = new LinkedHashMap(); + values.put("key", "value"); + + assertThat(mapper.writeValueAsString(values), containsString("\n")); + } finally { + if (previous == null) { + System.clearProperty("keycloak.jsonPrettyPrint"); + } else { + System.setProperty("keycloak.jsonPrettyPrint", previous); + } + } + } + + @Test + public void preserveLegacyJsonNodes() throws Exception { + var resolver = new QuarkusObjectMapperResolver(); + var legacyMapper = resolver.getObjectMapper(); + var mapper = resolver.getContext(Object.class); + + for (String json : List.of("\"signed-data\"", "{\"nested\":[1,true,null]}", "[\"value\",2]", "1.25", "true", "null")) { + var value = new LinkedHashMap(); + value.put("data", legacyMapper.readTree(json)); + assertThat(json, legacyMapper.readTree(mapper.writeValueAsString(value)), + equalTo(legacyMapper.readTree(legacyMapper.writeValueAsString(value)))); + } + } + + @Test + public void preserveWorkflowDeserialization() throws Exception { + String json = "{\"name\":\"test\",\"on\":\"user-created\",\"steps\":[{\"uses\":\"set-user-attribute\",\"custom\":\"value\"}]}"; + var resolver = new QuarkusObjectMapperResolver(); + var legacyMapper = resolver.getObjectMapper(); + var expected = legacyMapper.readValue(json, WorkflowRepresentation.class); + var actual = resolver.getContext(WorkflowRepresentation.class).readValue(json, WorkflowRepresentation.class); + + assertThat(legacyMapper.readTree(legacyMapper.writeValueAsString(actual)), + equalTo(legacyMapper.readTree(legacyMapper.writeValueAsString(expected)))); + } + + @Test + public void preserveAuthorizationSchemaForms() throws Exception { + var resolver = new QuarkusObjectMapperResolver(); + String resource = "{\"type\":\"document\",\"scopes\":[\"read\",\"write\"]}"; + for (String types : List.of("[" + resource + "]", "{\"document\":" + resource + "}")) { + String json = "{\"resourceTypes\":" + types + "}"; + var expected = resolver.getObjectMapper().readValue(json, AuthorizationSchema.class); + var actual = resolver.getContext(AuthorizationSchema.class).readValue(json, AuthorizationSchema.class); + assertThat(actual.getResourceTypes().keySet(), equalTo(expected.getResourceTypes().keySet())); + assertThat(actual.getResourceTypes().get("document").getScopes(), + equalTo(expected.getResourceTypes().get("document").getScopes())); + } + } + + @Test + public void preserveWorkflowConfiguration() throws Exception { + var resolver = new QuarkusObjectMapperResolver(); + var legacyMapper = resolver.getObjectMapper(); + var workflow = WorkflowRepresentation.withName("test") + .onEvent("user-created") + .withSteps(WorkflowStepRepresentation.create().of("set-user-attribute") + .withConfig("key", "value").withConfig("values", "first", "second").build()) + .build(); + String json = legacyMapper.writeValueAsString(workflow); + var actual = resolver.getContext(WorkflowRepresentation.class).readValue(json, WorkflowRepresentation.class); + + assertThat(legacyMapper.readTree(legacyMapper.writeValueAsString(actual)), equalTo(legacyMapper.readTree(json))); + assertThat(legacyMapper.readTree(resolver.getContext(WorkflowRepresentation.class).writeValueAsString(workflow)), + equalTo(legacyMapper.readTree(json))); + } + + @Test + public void preserveAuthZenOptions() throws Exception { + var resolver = new QuarkusObjectMapperResolver(); + var legacyMapper = resolver.getObjectMapper(); + for (var semantic : AuthZen.EvaluationsSemantic.values()) { + var options = new AuthZen.Options(semantic); + String json = legacyMapper.writeValueAsString(options); + assertThat(resolver.getContext(AuthZen.Options.class).readValue(json, AuthZen.Options.class), equalTo(options)); + assertThat(legacyMapper.readTree(resolver.getContext(AuthZen.Options.class).writeValueAsString(options)), + equalTo(legacyMapper.readTree(json))); + } + } + + @Test + public void preserveLegacyJsonNodeDeserialization() throws Exception { + var resolver = new QuarkusObjectMapperResolver(); + var legacyMapper = resolver.getObjectMapper(); + var mapper = resolver.getContext(LegacyTreeHolder.class); + + for (String value : List.of("\"value\"", "{\"nested\":[1,true,null]}", "[1,2]", "1.25", "true", "null")) { + String json = "{\"data\":" + value + "}"; + var expected = legacyMapper.readValue(json, LegacyTreeHolder.class); + var actual = mapper.readValue(json, LegacyTreeHolder.class); + assertThat(json, actual.data, equalTo(expected.data)); + } + } + + @Test + public void preserveLegacyTreeNumbers() throws Exception { + var resolver = new QuarkusObjectMapperResolver(); + var legacy = resolver.getObjectMapper(); + var mapper = resolver.getContext(LegacyTreeHolder.class); + for (String number : List.of("1", "2147483648", "123456789012345678901234567890", "1.2500", "-0.0", "1e400", "-1e400")) { + String json = "{\"data\":" + number + "}"; + var expected = legacy.readValue(json, LegacyTreeHolder.class).data; + var actual = mapper.readValue(json, LegacyTreeHolder.class).data; + assertThat(number, actual.isNumber(), is(true)); + assertThat(number, actual.numberType(), equalTo(expected.numberType())); + assertThat(number, actual.numberValue(), equalTo(expected.numberValue())); + assertThat(number, mapper.writeValueAsString(actual), equalTo(legacy.writeValueAsString(expected))); + } + } + + @Test + public void preserveStructuredTreeConversions() throws Exception { + var resolver = new QuarkusObjectMapperResolver(); + var legacy = resolver.getObjectMapper(); + var mapper = resolver.getContext(LegacyTreeHolder.class); + var holder = new LegacyTreeHolder(); + holder.data = legacy.readTree("{\"nested\":[1,true,null],\"explicitNull\":null}"); + + var tree = mapper.valueToTree(holder); + assertThat(tree.get("data").isObject(), is(true)); + assertThat(tree.get("data").get("nested").isArray(), is(true)); + assertThat(tree.get("data").get("explicitNull").isNull(), is(true)); + assertThat(tree.get("data").has("absent"), is(false)); + assertThat(mapper.convertValue(holder, Map.class), equalTo(legacy.convertValue(holder, Map.class))); + assertThat(mapper.treeToValue(tree, LegacyTreeHolder.class).data, equalTo(holder.data)); + assertThat(mapper.convertValue(Map.of("data", holder.data), LegacyTreeHolder.class).data, equalTo(holder.data)); + + assertThat(mapper.readValue("{}", LegacyTreeHolder.class).data, nullValue()); + assertThat(mapper.readValue("{\"data\":null}", LegacyTreeHolder.class).data.isNull(), is(true)); + } + + @Test + public void preserveInMemoryNumericTypesAndNonFinitePolicy() throws Exception { + var resolver = new QuarkusObjectMapperResolver(); + var legacy = resolver.getObjectMapper(); + var mapper = resolver.getContext(LegacyTreeHolder.class); + var factory = legacy.getNodeFactory(); + for (var number : List.of(factory.numberNode(1), factory.numberNode(1L), + factory.numberNode(new BigInteger("123456789012345678901234567890")), + factory.numberNode(1.25f), factory.numberNode(1.25d), + factory.numberNode(new BigDecimal("1.2345678901234567890123456789")), + factory.numberNode(Double.POSITIVE_INFINITY), factory.numberNode(Double.NEGATIVE_INFINITY), + factory.numberNode(Double.NaN), factory.numberNode(Float.NaN))) { + var holder = new LegacyTreeHolder(); + holder.data = number; + var tree = mapper.valueToTree(holder); + assertThat(tree.get("data").isNumber(), is(true)); + assertThat(tree.get("data").numberValue(), equalTo(number.numberValue())); + var converted = mapper.convertValue(Map.of("data", number), LegacyTreeHolder.class).data; + assertThat(converted.numberType(), equalTo(number.numberType())); + assertThat(converted.numberValue(), equalTo(number.numberValue())); + assertThat(mapper.writeValueAsString(holder), equalTo(legacy.writeValueAsString(holder))); + } + // Like the legacy mapper, bare non-finite literals are not valid JSON input. + assertThrows(com.fasterxml.jackson.core.JsonProcessingException.class, + () -> legacy.readValue("{\"data\":NaN}", LegacyTreeHolder.class)); + assertThrows(tools.jackson.core.JacksonException.class, + () -> mapper.readValue("{\"data\":NaN}", LegacyTreeHolder.class)); + } + + @Test + public void preserveEmbeddedTreeValues() throws Exception { + var resolver = new QuarkusObjectMapperResolver(); + var legacy = resolver.getObjectMapper(); + var mapper = resolver.getContext(LegacyTreeHolder.class); + var holder = new LegacyTreeHolder(); + holder.data = legacy.getNodeFactory().binaryNode(new byte[] { 1, 2, 3 }); + assertThat(mapper.writeValueAsString(holder), equalTo(legacy.writeValueAsString(holder))); + assertThat(mapper.valueToTree(holder).get("data").binaryValue(), equalTo(holder.data.binaryValue())); + holder.data = legacy.getNodeFactory().pojoNode(Map.of("nested", List.of(1, 2))); + assertThat(mapper.valueToTree(holder).get("data").isObject(), is(true)); + assertThat(mapper.convertValue(holder, Map.class), equalTo(legacy.convertValue(holder, Map.class))); + } + + @Test + public void preserveSubjectIdentifierFormatsAndExtensions() throws Exception { + var resolver = new QuarkusObjectMapperResolver(); + var legacy = resolver.getObjectMapper(); + var mapper = resolver.getContext(AddSubjectRequest.class); + for (String subject : List.of("null", + "{\"format\":\"iss_sub\",\"iss\":\"https://issuer.example\",\"sub\":\"user\"}", + "{\"subject_type\":\"iss-sub\",\"iss\":\"https://issuer.example\",\"sub\":\"user\"}", + "{\"format\":\"email\",\"email\":\"user@example.com\"}", + "{\"format\":\"complex\",\"user\":{\"format\":\"email\",\"email\":\"user@example.com\"}}", + "{\"format\":\"complex\",\"user\":{\"format\":\"iss_sub\",\"iss\":\"https://issuer.example\",\"sub\":\"user\"}}", + "{\"format\":\"custom-format\",\"extension\":{\"values\":[1,true,null]}}")) { + String json = "{\"subject\":" + subject + "}"; + var expected = legacy.readValue(json, AddSubjectRequest.class); + var actual = mapper.readValue(json, AddSubjectRequest.class); + assertThat(subject, legacy.valueToTree(actual), equalTo(legacy.valueToTree(expected))); + assertThat(subject, legacy.readTree(mapper.writeValueAsString(actual)), equalTo(legacy.valueToTree(expected))); + } + } + + @Test + public void rejectInvalidSubjectIdentifierFormats() { + var resolver = new QuarkusObjectMapperResolver(); + for (String subject : List.of("{}", "{\"format\":null}", "{\"format\":42}")) { + String json = "{\"subject\":" + subject + "}"; + assertThrows(com.fasterxml.jackson.core.JsonProcessingException.class, + () -> resolver.getObjectMapper().readValue(json, AddSubjectRequest.class)); + assertThrows(tools.jackson.databind.exc.MismatchedInputException.class, + () -> resolver.getContext(AddSubjectRequest.class).readValue(json, AddSubjectRequest.class)); + } + } + + public static class LegacyTreeHolder { + public com.fasterxml.jackson.databind.JsonNode data; + } +} diff --git a/quarkus/runtime/src/test/java/org/keycloak/quarkus/runtime/integration/jaxrs/RepresentationAdaptersTest.java b/quarkus/runtime/src/test/java/org/keycloak/quarkus/runtime/integration/jaxrs/RepresentationAdaptersTest.java new file mode 100644 index 000000000000..dc6bb2b810c7 --- /dev/null +++ b/quarkus/runtime/src/test/java/org/keycloak/quarkus/runtime/integration/jaxrs/RepresentationAdaptersTest.java @@ -0,0 +1,61 @@ +package org.keycloak.quarkus.runtime.integration.jaxrs; + +import org.keycloak.representations.idm.UserRepresentation; + +import com.fasterxml.jackson.databind.annotation.JsonNaming; +import org.junit.Test; +import tools.jackson.databind.exc.MismatchedInputException; +import tools.jackson.databind.exc.UnrecognizedPropertyException; +import tools.jackson.databind.json.JsonMapper; + +import static org.hamcrest.CoreMatchers.equalTo; +import static org.hamcrest.MatcherAssert.assertThat; +import static org.junit.Assert.assertThrows; + +public class RepresentationAdaptersTest extends org.keycloak.json.jackson3.RepresentationAdaptersTest { + + @Override + protected JsonMapper mapper() { + return (JsonMapper) new QuarkusObjectMapperResolver().getContext(Object.class); + } + + @Test + public void serverRejectsUnknownRepresentationProperties() { + assertThrows(UnrecognizedPropertyException.class, + () -> mapper().readValue("{\"username\":\"alice\",\"unknown\":true}", UserRepresentation.class)); + } + + @Test + public void serverRejectsScalarForArrayProperties() { + assertThrows(MismatchedInputException.class, + () -> mapper().readValue("{\"requiredActions\":\"UPDATE_PASSWORD\"}", UserRepresentation.class)); + } + + @Test + public void legacySnakeCaseNamingWorksInBothDirections() throws Exception { + var value = mapper().readValue("{\"some_value\":\"text\"}", SnakeCaseValue.class); + + assertThat(value.someValue, equalTo("text")); + assertThat(mapper().writeValueAsString(value), equalTo(new com.fasterxml.jackson.databind.ObjectMapper().writeValueAsString(value))); + assertThat(mapper().writeValueAsString(value), equalTo("{\"some_value\":\"text\"}")); + } + + @Test + public void nativeJacksonNamingTakesPrecedenceOverLegacyNaming() { + var value = mapper().readValue("{\"some-value\":\"text\"}", NativeNamingValue.class); + + assertThat(value.someValue, equalTo("text")); + assertThat(mapper().writeValueAsString(value), equalTo("{\"some-value\":\"text\"}")); + } + + @JsonNaming(com.fasterxml.jackson.databind.PropertyNamingStrategies.SnakeCaseStrategy.class) + public static class SnakeCaseValue { + public String someValue; + } + + @JsonNaming(com.fasterxml.jackson.databind.PropertyNamingStrategies.SnakeCaseStrategy.class) + @tools.jackson.databind.annotation.JsonNaming(tools.jackson.databind.PropertyNamingStrategies.KebabCaseStrategy.class) + public static class NativeNamingValue { + public String someValue; + } +} diff --git a/services/src/main/java/org/keycloak/services/error/KeycloakErrorHandler.java b/services/src/main/java/org/keycloak/services/error/KeycloakErrorHandler.java index 5f63eb62cb6c..8cc0bc9ed863 100644 --- a/services/src/main/java/org/keycloak/services/error/KeycloakErrorHandler.java +++ b/services/src/main/java/org/keycloak/services/error/KeycloakErrorHandler.java @@ -63,10 +63,26 @@ public Response toResponse(Throwable throwable) { } public static Response getResponse(KeycloakSession session, Throwable throwable) { + Response.Status responseStatus = getResponseStatus(throwable); + OAuth2ErrorRepresentation error = new OAuth2ErrorRepresentation(); + error.setError(getErrorCode(throwable)); + if (throwable instanceof ModelValidationException || throwable.getCause() instanceof ModelException) { + error.setErrorDescription(throwable.getMessage()); + } if (throwable instanceof ModelDuplicateException) { + error.setErrorDescription(throwable.getMessage()); + } else if (throwable instanceof JsonProcessingException || throwable.getCause() instanceof JsonProcessingException) { + error.setErrorDescription("Cannot parse the JSON"); + } else if (responseStatus.getFamily().equals(Response.Status.Family.SERVER_ERROR)) { + error.setErrorDescription("For more on this error consult the server log."); + } + return getResponse(session, throwable, responseStatus, error); + } + + public static Response getResponse(KeycloakSession session, Throwable throwable, Response.Status responseStatus, + OAuth2ErrorRepresentation error) { KeycloakTransaction tx = session.getTransactionManager(); tx.setRollbackOnly(); - Response.Status responseStatus = getResponseStatus(throwable); boolean isServerError = responseStatus.getFamily().equals(Response.Status.Family.SERVER_ERROR); if (isServerError) { @@ -78,19 +94,6 @@ public static Response getResponse(KeycloakSession session, Throwable throwable) HttpHeaders headers = session.getContext().getRequestHeaders(); if (!MediaTypeMatcher.isHtmlRequest(headers)) { - OAuth2ErrorRepresentation error = new OAuth2ErrorRepresentation(); - - error.setError(getErrorCode(throwable)); - if (throwable instanceof ModelValidationException || throwable.getCause() instanceof ModelException) { - error.setErrorDescription(throwable.getMessage()); - } if (throwable instanceof ModelDuplicateException) { - error.setErrorDescription(throwable.getMessage()); - } else if (throwable instanceof JsonProcessingException || throwable.getCause() instanceof JsonProcessingException) { - error.setErrorDescription("Cannot parse the JSON"); - } else if (isServerError) { - error.setErrorDescription("For more on this error consult the server log."); - } - return Response.status(responseStatus) .type(MediaType.APPLICATION_JSON_TYPE) .entity(error) diff --git a/tests/base/src/test/java/org/keycloak/tests/error/JacksonErrorResponseTest.java b/tests/base/src/test/java/org/keycloak/tests/error/JacksonErrorResponseTest.java new file mode 100644 index 000000000000..3000f94ff255 --- /dev/null +++ b/tests/base/src/test/java/org/keycloak/tests/error/JacksonErrorResponseTest.java @@ -0,0 +1,145 @@ +package org.keycloak.tests.error; + +import java.io.IOException; +import java.net.URI; +import java.util.UUID; + +import org.keycloak.common.util.KeycloakUriBuilder; +import org.keycloak.testframework.annotations.InjectHttpClient; +import org.keycloak.testframework.annotations.InjectKeycloakUrls; +import org.keycloak.testframework.annotations.KeycloakIntegrationTest; +import org.keycloak.testframework.server.KeycloakUrls; +import org.keycloak.tests.common.CustomProvidersServerConfig; +import org.keycloak.util.JsonSerialization; + +import org.apache.http.HttpResponse; +import org.apache.http.client.HttpClient; +import org.apache.http.client.methods.HttpGet; +import org.apache.http.client.methods.HttpPost; +import org.apache.http.entity.ContentType; +import org.apache.http.entity.StringEntity; +import org.apache.http.util.EntityUtils; +import org.junit.jupiter.api.Test; + +import static org.hamcrest.MatcherAssert.assertThat; +import static org.hamcrest.Matchers.containsString; +import static org.hamcrest.Matchers.is; +import static org.hamcrest.Matchers.not; + +@KeycloakIntegrationTest(config = CustomProvidersServerConfig.class) +class JacksonErrorResponseTest { + + @InjectKeycloakUrls + KeycloakUrls urls; + + @InjectHttpClient + HttpClient client; + + @Test + void validInputCommits() throws IOException { + String transaction = UUID.randomUUID().toString(); + HttpResponse response = post("", "{\"count\":7}", "application/json", transaction); + String body = EntityUtils.toString(response.getEntity()); + assertThat(body, response.getStatusLine().getStatusCode(), is(200)); + assertThat(JsonSerialization.mapper.readTree(body).get("count").asInt(), is(7)); + assertTransaction(transaction, "committed"); + } + + @Test + void typeMismatchIsStructuredBadRequest() throws IOException { + String transaction = UUID.randomUUID().toString(); + assertJsonError(post("", "{\"count\":{}}", "application/json", transaction), 400, + "unknown_error", "Cannot parse the JSON"); + assertTransaction(transaction, "rolled-back"); + } + + @Test + void streamConstraintIsStructuredBadRequest() throws IOException { + // Exceeds Jackson's default maximum number length, not merely the target int range. + assertJsonError(post("", "{\"count\":" + "1".repeat(1001) + "}", "application/json", null), 400, + "unknown_error", "Cannot parse the JSON"); + } + + @Test + void throwingResponseGetterIsServerError() throws IOException { + HttpGet get = new HttpGet(uri("/throwing-getter", null)); + get.setHeader("Accept", "application/json"); + assertJsonError(client.execute(get), 500, "unknown_error", "For more on this error consult the server log."); + } + + @Test + void invalidResponseDefinitionIsServerError() throws IOException { + HttpResponse response = client.execute(new HttpGet(uri("/invalid-definition", null))); + EntityUtils.consume(response.getEntity()); + assertThat(response.getStatusLine().getStatusCode(), is(500)); + } + + @Test + void invalidRequestDefinitionIsServerError() throws IOException { + HttpResponse response = post("/invalid-definition", "{}", "application/json", null); + EntityUtils.consume(response.getEntity()); + assertThat(response.getStatusLine().getStatusCode(), is(500)); + } + + @Test + void malformedInputNegotiatesHtml() throws IOException { + assertHtmlError(post("", "{\"count\":", "text/html, application/json;q=0.9", null), 400); + } + + @Test + void responseFailureNegotiatesHtml() throws IOException { + HttpGet get = new HttpGet(uri("/throwing-getter", null)); + get.setHeader("Accept", "text/html, application/json;q=0.9"); + assertHtmlError(client.execute(get), 500); + } + + @Test + void legacyMapperRemainsAvailableThroughCdi() throws IOException { + HttpResponse response = client.execute(new HttpGet(uri("/legacy-mapper", null))); + String json = EntityUtils.toString(response.getEntity()); + assertThat(json, response.getStatusLine().getStatusCode(), is(200)); + var body = JsonSerialization.mapper.readTree(json); + assertThat(body.get("optional").asText(), is("value")); + assertThat(body.get("date"), is(JsonSerialization.mapper.readTree("[2026,1,2]"))); + } + + private HttpResponse post(String path, String body, String accept, String transaction) throws IOException { + HttpPost post = new HttpPost(uri(path, transaction)); + post.setHeader("Accept", accept); + post.setEntity(new StringEntity(body, ContentType.APPLICATION_JSON)); + return client.execute(post); + } + + private void assertJsonError(HttpResponse response, int status, String code, String description) throws IOException { + String body = EntityUtils.toString(response.getEntity()); + assertThat(body, response.getStatusLine().getStatusCode(), is(status)); + assertThat(response.getFirstHeader("Content-Type").getValue(), containsString("application/json")); + var error = JsonSerialization.mapper.readTree(body); + assertThat(error.get("error").asText(), is(code)); + assertThat(error.get("error_description").asText(), is(description)); + assertThat(body, not(containsString("Private serialization failure detail"))); + } + + private void assertHtmlError(HttpResponse response, int status) throws IOException { + String body = EntityUtils.toString(response.getEntity()); + assertThat(body, response.getStatusLine().getStatusCode(), is(status)); + assertThat(response.getFirstHeader("Content-Type").getValue(), containsString("text/html")); + assertThat(body, containsString("An internal server error has occurred")); + assertThat(body, not(containsString("Private serialization failure detail"))); + } + + private void assertTransaction(String transaction, String outcome) throws IOException { + HttpResponse response = client.execute(new HttpGet(uri("/transaction", transaction))); + String body = EntityUtils.toString(response.getEntity()); + assertThat(body, response.getStatusLine().getStatusCode(), is(200)); + assertThat(body, is(outcome)); + } + + private URI uri(String path, String transaction) { + var builder = KeycloakUriBuilder.fromUri(urls.getMasterRealm()).path("error-testing/json" + path); + if (transaction != null) { + builder.queryParam("transaction", transaction); + } + return builder.build(); + } +} diff --git a/tests/base/src/test/java/org/keycloak/tests/error/UncaughtErrorPageTest.java b/tests/base/src/test/java/org/keycloak/tests/error/UncaughtErrorPageTest.java index 9ac5aec21816..58001e29282a 100644 --- a/tests/base/src/test/java/org/keycloak/tests/error/UncaughtErrorPageTest.java +++ b/tests/base/src/test/java/org/keycloak/tests/error/UncaughtErrorPageTest.java @@ -104,9 +104,11 @@ void uncaughtErrorClientRegistration() throws IOException { HttpResponse response = httpClient.execute(post); assertThat("status code", response.getStatusLine().getStatusCode(), is(400)); + assertContentTypeJson(response); + OAuth2ErrorRepresentation error = readError(response); assertThat("error code", error.getError(), is(OAuthErrorException.INVALID_REQUEST)); - assertThat("error description", error.getErrorDescription(), is(notNullValue())); + assertThat("error description", error.getErrorDescription(), is("Cannot parse the JSON")); } @Test @@ -117,9 +119,11 @@ void uncaughtErrorAdmin() throws IOException { HttpResponse response = httpClient.execute(post); assertThat("status code", response.getStatusLine().getStatusCode(), is(400)); + assertContentTypeJson(response); + OAuth2ErrorRepresentation error = readError(response); assertThat("error code", error.getError(), is(OAuthErrorException.INVALID_REQUEST)); - assertThat("error description", error.getErrorDescription(), is(notNullValue())); + assertThat("error description", error.getErrorDescription(), is("Cannot parse the JSON")); } @Test @@ -135,6 +139,10 @@ void uncaughtErrorAdminPropertyError() throws IOException { String body = EntityUtils.toString(response.getEntity()); assertThat("XSS payload should be escaped in response", body, containsString("Unrecognized field \\\"\\\"")); + var error = JsonSerialization.mapper.readTree(body); + assertThat("error message", error.get("error").asText(), + containsString("Unrecognized field \"\"")); + assertThat("representation type", error.get("error").asText(), containsString("ComponentRepresentation")); } @Test diff --git a/tests/custom-providers/src/main/java/org/keycloak/tests/providers/rest/ErrorTestingRealmResourceProvider.java b/tests/custom-providers/src/main/java/org/keycloak/tests/providers/rest/ErrorTestingRealmResourceProvider.java index 35d5757357da..4f9fcca6d927 100644 --- a/tests/custom-providers/src/main/java/org/keycloak/tests/providers/rest/ErrorTestingRealmResourceProvider.java +++ b/tests/custom-providers/src/main/java/org/keycloak/tests/providers/rest/ErrorTestingRealmResourceProvider.java @@ -1,16 +1,30 @@ package org.keycloak.tests.providers.rest; +import java.io.IOException; +import java.time.LocalDate; +import java.util.Map; +import java.util.Optional; +import java.util.concurrent.ConcurrentHashMap; + +import jakarta.enterprise.inject.spi.CDI; +import jakarta.ws.rs.Consumes; import jakarta.ws.rs.GET; +import jakarta.ws.rs.POST; import jakarta.ws.rs.Path; +import jakarta.ws.rs.Produces; import jakarta.ws.rs.QueryParam; +import jakarta.ws.rs.core.MediaType; import jakarta.ws.rs.core.Response; +import org.keycloak.models.AbstractKeycloakTransaction; import org.keycloak.models.KeycloakSession; import org.keycloak.services.ErrorPage; import org.keycloak.services.resource.RealmResourceProvider; public class ErrorTestingRealmResourceProvider implements RealmResourceProvider { + private static final Map TRANSACTION_OUTCOMES = new ConcurrentHashMap<>(); + private final KeycloakSession session; ErrorTestingRealmResourceProvider(KeycloakSession session) { @@ -19,6 +33,10 @@ public class ErrorTestingRealmResourceProvider implements RealmResourceProvider @Override public Object getResource() { + // The locator runs before request-body deserialization, so input errors must roll this back too. + if (!session.getContext().getUri().getPath().endsWith("/transaction")) { + trackTransaction(session.getContext().getUri().getQueryParameters().getFirst("transaction")); + } return this; } @@ -35,6 +53,84 @@ public Response uncaughtError() { throw new RuntimeException("Uncaught error"); } + @POST + @Path("json") + @Consumes(MediaType.APPLICATION_JSON) + @Produces(MediaType.APPLICATION_JSON) + public JsonInput json(JsonInput input) { + return input; + } + + @GET + @Path("json/throwing-getter") + @Produces(MediaType.APPLICATION_JSON) + public ThrowingGetter throwingGetter() { + return new ThrowingGetter(); + } + + @GET + @Path("json/invalid-definition") + @Produces(MediaType.APPLICATION_JSON) + public EmptyBean invalidDefinition() { + return new EmptyBean(); + } + + @POST + @Path("json/invalid-definition") + @Consumes(MediaType.APPLICATION_JSON) + public void invalidInputDefinition(UndefinedInput input) { + throw new AssertionError("An undefined input type must not reach the resource"); + } + + @GET + @Path("json/transaction") + @Produces(MediaType.TEXT_PLAIN) + public String transactionOutcome(@QueryParam("transaction") String transaction) { + return TRANSACTION_OUTCOMES.remove(transaction); + } + + @GET + @Path("json/legacy-mapper") + @Produces(MediaType.APPLICATION_JSON) + public String legacyMapper() throws IOException { + // Extension consumers must still be able to resolve the legacy CDI producer. + var mapper = CDI.current().select(com.fasterxml.jackson.databind.ObjectMapper.class).get(); + return mapper.writeValueAsString(Map.of("optional", Optional.of("value"), "date", LocalDate.of(2026, 1, 2))); + } + + private void trackTransaction(String transaction) { + if (transaction != null) { + session.getTransactionManager().enlistAfterCompletion(new AbstractKeycloakTransaction() { + @Override + protected void commitImpl() { + TRANSACTION_OUTCOMES.put(transaction, "committed"); + } + + @Override + protected void rollbackImpl() { + TRANSACTION_OUTCOMES.put(transaction, "rolled-back"); + } + }); + } + } + + public static class JsonInput { + public int count; + } + + public static class ThrowingGetter { + public String getValue() { + throw new IllegalStateException("Private serialization failure detail"); + } + } + + public static class EmptyBean { + } + + public interface UndefinedInput { + String getValue(); + } + @Override public void close() { } diff --git a/tests/custom-providers/src/main/resources/META-INF/beans.xml b/tests/custom-providers/src/main/resources/META-INF/beans.xml new file mode 100644 index 000000000000..e69de29bb2d1 From 78f401ea8d371baa82e0b370ad4f04e7a0a9b63f Mon Sep 17 00:00:00 2001 From: Peter Zaoral Date: Sat, 14 Nov 2026 15:30:09 +0100 Subject: [PATCH 2/3] [Quarkus 4] Adapt Keycloak JSON handling to Jackson 3 Closes: #54599 Signed-off-by: Peter Zaoral --- .../authorization/authzen/AuthZen.java | 5 +- .../topics/changes/changes-27_0_0.adoc | 14 + .../jaxrs/LegacyJsonNodeAdapter.java | 102 ------- .../LegacyNamingAnnotationIntrospector.java | 30 -- .../jaxrs/QuarkusObjectMapperResolver.java | 36 +-- .../jaxrs/SubjectIdDeserializer.java | 33 +++ .../QuarkusObjectMapperResolverTest.java | 265 ++++++++---------- .../jaxrs/RepresentationAdaptersTest.java | 22 +- .../OID4VCIssuerWellKnownProvider.java | 2 +- .../oid4vc/model/CredentialIssuer.java | 9 +- .../tests/error/JacksonErrorResponseTest.java | 9 +- tests/custom-providers/pom.xml | 5 + .../ErrorTestingRealmResourceProvider.java | 15 +- 13 files changed, 193 insertions(+), 354 deletions(-) delete mode 100644 quarkus/runtime/src/main/java/org/keycloak/quarkus/runtime/integration/jaxrs/LegacyJsonNodeAdapter.java delete mode 100644 quarkus/runtime/src/main/java/org/keycloak/quarkus/runtime/integration/jaxrs/LegacyNamingAnnotationIntrospector.java create mode 100644 quarkus/runtime/src/main/java/org/keycloak/quarkus/runtime/integration/jaxrs/SubjectIdDeserializer.java diff --git a/authzen/services/src/main/java/org/keycloak/authorization/authzen/AuthZen.java b/authzen/services/src/main/java/org/keycloak/authorization/authzen/AuthZen.java index 43f391262a73..c2dd3c9a7b41 100644 --- a/authzen/services/src/main/java/org/keycloak/authorization/authzen/AuthZen.java +++ b/authzen/services/src/main/java/org/keycloak/authorization/authzen/AuthZen.java @@ -23,8 +23,6 @@ import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonProperty; import com.fasterxml.jackson.annotation.JsonValue; -import com.fasterxml.jackson.databind.PropertyNamingStrategies; -import com.fasterxml.jackson.databind.annotation.JsonNaming; public final class AuthZen { @@ -108,8 +106,7 @@ public enum EvaluationsSemantic { } @JsonInclude(JsonInclude.Include.NON_NULL) - @JsonNaming(PropertyNamingStrategies.SnakeCaseStrategy.class) - public record Options(EvaluationsSemantic evaluationsSemantic) {} + public record Options(@JsonProperty("evaluations_semantic") EvaluationsSemantic evaluationsSemantic) {} @JsonInclude(JsonInclude.Include.NON_NULL) public record EvaluationsRequest( diff --git a/docs/documentation/upgrading/topics/changes/changes-27_0_0.adoc b/docs/documentation/upgrading/topics/changes/changes-27_0_0.adoc index b88c54358d40..6f050274fa58 100644 --- a/docs/documentation/upgrading/topics/changes/changes-27_0_0.adoc +++ b/docs/documentation/upgrading/topics/changes/changes-27_0_0.adoc @@ -4,6 +4,20 @@ Breaking changes are identified as those that might require changes for existing users to their configurations or applications. In minor or patch releases, {project_name} will only introduce breaking changes to fix bugs. +=== Jackson 3 for server extensions +// https://github.com/keycloak/keycloak/issues/54599 + +The upgrade to Quarkus 4 switches JSON handling for REST endpoints to Jackson 3. +Custom server extensions that use Jackson 2 APIs must migrate to Jackson 3. +This includes custom REST endpoints, JSON serializers and deserializers, and extensions that inject an object mapper. + +Update Jackson core and databind dependencies and imports from `com.fasterxml.jackson` to `tools.jackson` and adapt to the Jackson 3 APIs. +For example, a custom REST endpoint that returns `com.fasterxml.jackson.databind.JsonNode` must return `tools.jackson.databind.JsonNode` instead. +Databind annotations, such as `JsonNaming` and `JsonDeserialize`, move to `tools.jackson.databind.annotation`. +Annotations in `com.fasterxml.jackson.annotation`, such as `JsonProperty`, keep their existing package. + +For details, see the https://github.com/FasterXML/jackson/blob/main/jackson3/MIGRATING_TO_JACKSON_3.md[Jackson 3 migration guide]. + === Validation of client URI fields // https://github.com/keycloak/keycloak/issues/54046 diff --git a/quarkus/runtime/src/main/java/org/keycloak/quarkus/runtime/integration/jaxrs/LegacyJsonNodeAdapter.java b/quarkus/runtime/src/main/java/org/keycloak/quarkus/runtime/integration/jaxrs/LegacyJsonNodeAdapter.java deleted file mode 100644 index 6ec4d5ef374f..000000000000 --- a/quarkus/runtime/src/main/java/org/keycloak/quarkus/runtime/integration/jaxrs/LegacyJsonNodeAdapter.java +++ /dev/null @@ -1,102 +0,0 @@ -package org.keycloak.quarkus.runtime.integration.jaxrs; - -import com.fasterxml.jackson.databind.JsonNode; -import com.fasterxml.jackson.databind.node.JsonNodeFactory; -import com.fasterxml.jackson.databind.node.POJONode; -import tools.jackson.core.JsonGenerator; -import tools.jackson.core.JsonParser; -import tools.jackson.databind.DeserializationContext; -import tools.jackson.databind.SerializationContext; -import tools.jackson.databind.ValueDeserializer; -import tools.jackson.databind.ValueSerializer; -import tools.jackson.databind.module.SimpleModule; - -/** - * Keeps public Jackson 2 tree properties usable by the REST mapper, including token-buffer - * conversions. Raw JSON would bypass tokens and turn nested values into opaque raw values. - */ -final class LegacyJsonNodeAdapter extends SimpleModule { - - LegacyJsonNodeAdapter(JsonNodeFactory factory) { - addSerializer(JsonNode.class, new Serializer()); - addDeserializer(JsonNode.class, new ValueDeserializer<>() { - @Override - public JsonNode deserialize(JsonParser parser, DeserializationContext context) { - return toLegacy(context.readTree(parser), factory); - } - - @Override - public JsonNode getNullValue(DeserializationContext context) { - return factory.nullNode(); - } - }); - } - - static JsonNode toLegacy(tools.jackson.databind.JsonNode node, JsonNodeFactory factory) { - return switch (node.getNodeType()) { - case OBJECT -> { - var object = factory.objectNode(); - node.properties().forEach(property -> object.set(property.getKey(), toLegacy(property.getValue(), factory))); - yield object; - } - case ARRAY -> { - var array = factory.arrayNode(); - node.forEach(element -> array.add(toLegacy(element, factory))); - yield array; - } - case STRING -> factory.textNode(node.stringValue()); - case BOOLEAN -> factory.booleanNode(node.booleanValue()); - case NULL -> factory.nullNode(); - case MISSING -> factory.missingNode(); - case BINARY -> factory.binaryNode(node.binaryValue()); - case POJO -> factory.pojoNode(((tools.jackson.databind.node.POJONode) node).getPojo()); - case NUMBER -> switch (((tools.jackson.databind.node.NumericNode) node).numberType()) { - case INT -> factory.numberNode(node.intValue()); - case LONG -> factory.numberNode(node.longValue()); - case BIG_INTEGER -> factory.numberNode(node.bigIntegerValue()); - case FLOAT -> factory.numberNode(node.floatValue()); - case DOUBLE -> factory.numberNode(node.doubleValue()); - case BIG_DECIMAL -> factory.numberNode(node.decimalValue()); - }; - }; - } - - private static final class Serializer extends ValueSerializer { - - @Override - public void serialize(JsonNode node, JsonGenerator generator, SerializationContext context) { - switch (node.getNodeType()) { - case OBJECT -> { - generator.writeStartObject(node); - node.properties().forEach(property -> { - generator.writeName(property.getKey()); - serialize(property.getValue(), generator, context); - }); - generator.writeEndObject(); - } - case ARRAY -> { - generator.writeStartArray(node, node.size()); - node.forEach(element -> serialize(element, generator, context)); - generator.writeEndArray(); - } - case STRING -> generator.writeString(node.textValue()); - case BOOLEAN -> generator.writeBoolean(node.booleanValue()); - case NULL, MISSING -> generator.writeNull(); - case BINARY -> generator.writeBinary(((com.fasterxml.jackson.databind.node.BinaryNode) node).binaryValue()); - case POJO -> context.writeValue(generator, ((POJONode) node).getPojo()); - case NUMBER -> { - // Emit numbers as numbers, including non-finite floating-point values. The - // JSON generator retains the legacy quoting policy; token buffers retain types. - switch (node.numberType()) { - case INT -> generator.writeNumber(node.intValue()); - case LONG -> generator.writeNumber(node.longValue()); - case BIG_INTEGER -> generator.writeNumber(node.bigIntegerValue()); - case FLOAT -> generator.writeNumber(node.floatValue()); - case DOUBLE -> generator.writeNumber(node.doubleValue()); - case BIG_DECIMAL -> generator.writeNumber(node.decimalValue()); - } - } - } - } - } -} diff --git a/quarkus/runtime/src/main/java/org/keycloak/quarkus/runtime/integration/jaxrs/LegacyNamingAnnotationIntrospector.java b/quarkus/runtime/src/main/java/org/keycloak/quarkus/runtime/integration/jaxrs/LegacyNamingAnnotationIntrospector.java deleted file mode 100644 index 39bfeffbe36d..000000000000 --- a/quarkus/runtime/src/main/java/org/keycloak/quarkus/runtime/integration/jaxrs/LegacyNamingAnnotationIntrospector.java +++ /dev/null @@ -1,30 +0,0 @@ -package org.keycloak.quarkus.runtime.integration.jaxrs; - -import java.io.Serial; - -import org.keycloak.json.jackson3.KeycloakAnnotationIntrospector3; - -import com.fasterxml.jackson.databind.annotation.JsonNaming; -import tools.jackson.databind.PropertyNamingStrategies; -import tools.jackson.databind.cfg.MapperConfig; -import tools.jackson.databind.introspect.AnnotatedClass; - -/** Server compatibility for providers still using Jackson 2 naming annotations. */ -final class LegacyNamingAnnotationIntrospector extends KeycloakAnnotationIntrospector3 { - - @Serial - private static final long serialVersionUID = 1L; - - @Override - public Object findNamingStrategy(MapperConfig config, AnnotatedClass annotated) { - Object strategy = super.findNamingStrategy(config, annotated); - if (strategy != null) { - return strategy; - } - JsonNaming naming = annotated.getAnnotation(JsonNaming.class); - if (naming != null && naming.value() == com.fasterxml.jackson.databind.PropertyNamingStrategies.SnakeCaseStrategy.class) { - return PropertyNamingStrategies.SNAKE_CASE; - } - return null; - } -} diff --git a/quarkus/runtime/src/main/java/org/keycloak/quarkus/runtime/integration/jaxrs/QuarkusObjectMapperResolver.java b/quarkus/runtime/src/main/java/org/keycloak/quarkus/runtime/integration/jaxrs/QuarkusObjectMapperResolver.java index 7d8894b9a100..30d7ca4ac9da 100644 --- a/quarkus/runtime/src/main/java/org/keycloak/quarkus/runtime/integration/jaxrs/QuarkusObjectMapperResolver.java +++ b/quarkus/runtime/src/main/java/org/keycloak/quarkus/runtime/integration/jaxrs/QuarkusObjectMapperResolver.java @@ -17,23 +17,17 @@ package org.keycloak.quarkus.runtime.integration.jaxrs; -import java.io.IOException; - import jakarta.enterprise.context.ApplicationScoped; import jakarta.enterprise.inject.Produces; import jakarta.ws.rs.ext.ContextResolver; import jakarta.ws.rs.ext.Provider; -import org.keycloak.services.util.ObjectMapperResolver; +import org.keycloak.json.jackson3.KeycloakAnnotationIntrospector3; import org.keycloak.ssf.subject.SubjectId; -import org.keycloak.ssf.subject.SubjectIdJsonDeserializer; import com.fasterxml.jackson.annotation.JsonInclude; -import tools.jackson.core.JsonParser; -import tools.jackson.databind.DeserializationContext; import tools.jackson.databind.ObjectMapper; import tools.jackson.databind.SerializationFeature; -import tools.jackson.databind.ValueDeserializer; import tools.jackson.databind.json.JsonMapper; import tools.jackson.databind.module.SimpleModule; @@ -41,12 +35,11 @@ @ApplicationScoped public class QuarkusObjectMapperResolver implements ContextResolver { - private final com.fasterxml.jackson.databind.ObjectMapper legacyMapper = new ObjectMapperResolver().getContext(Object.class); - private final ObjectMapper mapper = createMapper(legacyMapper); + private final ObjectMapper mapper = createMapper(); @Produces - public com.fasterxml.jackson.databind.ObjectMapper getObjectMapper() { - return legacyMapper; + public ObjectMapper getObjectMapper() { + return mapper; } @Override @@ -54,26 +47,11 @@ public ObjectMapper getContext(Class type) { return mapper; } - private static ObjectMapper createMapper(com.fasterxml.jackson.databind.ObjectMapper legacyMapper) { - var subjectMapper = legacyMapper.copy().registerModule(new com.fasterxml.jackson.databind.module.SimpleModule() - .addDeserializer(SubjectId.class, new SubjectIdJsonDeserializer())); + private static ObjectMapper createMapper() { var builder = JsonMapper.builder() .configureForJackson2() - .annotationIntrospector(new LegacyNamingAnnotationIntrospector()) - .addModule(new LegacyJsonNodeAdapter(legacyMapper.getNodeFactory())) - .addModule(new SimpleModule().addDeserializer(SubjectId.class, new ValueDeserializer() { - @Override - public SubjectId deserialize(JsonParser parser, DeserializationContext context) { - try { - var tree = LegacyJsonNodeAdapter.toLegacy(context.readTree(parser), subjectMapper.getNodeFactory()); - try (var subjectParser = tree.traverse(subjectMapper)) { - return subjectMapper.readValue(subjectParser, SubjectId.class); - } - } catch (IOException exception) { - return context.reportInputMismatch(SubjectId.class, "Unable to read the subject identifier"); - } - } - })) + .annotationIntrospector(new KeycloakAnnotationIntrospector3()) + .addModule(new SimpleModule().addDeserializer(SubjectId.class, new SubjectIdDeserializer())) .changeDefaultPropertyInclusion(inclusion -> JsonInclude.Value.construct(JsonInclude.Include.NON_NULL, JsonInclude.Include.NON_NULL)) .configure(SerializationFeature.INDENT_OUTPUT, Boolean.getBoolean("keycloak.jsonPrettyPrint")); if (Boolean.parseBoolean(System.getProperty("keycloak.jsonEnableJacksonModuleDiscovery", "true"))) { diff --git a/quarkus/runtime/src/main/java/org/keycloak/quarkus/runtime/integration/jaxrs/SubjectIdDeserializer.java b/quarkus/runtime/src/main/java/org/keycloak/quarkus/runtime/integration/jaxrs/SubjectIdDeserializer.java new file mode 100644 index 000000000000..be901d48af79 --- /dev/null +++ b/quarkus/runtime/src/main/java/org/keycloak/quarkus/runtime/integration/jaxrs/SubjectIdDeserializer.java @@ -0,0 +1,33 @@ +package org.keycloak.quarkus.runtime.integration.jaxrs; + +import org.keycloak.ssf.subject.SubjectId; +import org.keycloak.ssf.subject.SubjectIds; + +import tools.jackson.core.JsonParser; +import tools.jackson.databind.DeserializationContext; +import tools.jackson.databind.ValueDeserializer; + +final class SubjectIdDeserializer extends ValueDeserializer { + + @Override + public SubjectId deserialize(JsonParser parser, DeserializationContext context) { + var node = context.readTree(parser); + var formatNode = node.get("format"); + boolean legacyRiscEventType = false; + if (formatNode == null) { + formatNode = node.get("subject_type"); + legacyRiscEventType = formatNode != null && formatNode.isString(); + } + if (formatNode == null || !formatNode.isString()) { + return context.reportInputMismatch(SubjectId.class, "Missing or invalid 'format' field in SubjectId"); + } + + String format = formatNode.asString(); + if (legacyRiscEventType) { + format = format.replace('-', '_'); + } + var subject = context.readTreeAsValue(node, SubjectIds.getSubjectIdType(format)); + subject.setFormat(format); + return subject; + } +} diff --git a/quarkus/runtime/src/test/java/org/keycloak/quarkus/runtime/integration/jaxrs/QuarkusObjectMapperResolverTest.java b/quarkus/runtime/src/test/java/org/keycloak/quarkus/runtime/integration/jaxrs/QuarkusObjectMapperResolverTest.java index 482f89c9cb8e..549295673664 100644 --- a/quarkus/runtime/src/test/java/org/keycloak/quarkus/runtime/integration/jaxrs/QuarkusObjectMapperResolverTest.java +++ b/quarkus/runtime/src/test/java/org/keycloak/quarkus/runtime/integration/jaxrs/QuarkusObjectMapperResolverTest.java @@ -1,30 +1,51 @@ package org.keycloak.quarkus.runtime.integration.jaxrs; -import java.math.BigDecimal; -import java.math.BigInteger; import java.util.LinkedHashMap; import java.util.List; import java.util.Map; +import java.util.Set; import java.util.stream.Stream; import org.keycloak.authorization.authzen.AuthZen; +import org.keycloak.protocol.oid4vc.model.CredentialIssuer; import org.keycloak.representations.AccessTokenResponse; import org.keycloak.representations.idm.authorization.AuthorizationSchema; import org.keycloak.representations.workflows.WorkflowRepresentation; import org.keycloak.representations.workflows.WorkflowStepRepresentation; +import org.keycloak.ssf.subject.ComplexSubjectId; +import org.keycloak.ssf.subject.EmailSubjectId; +import org.keycloak.ssf.subject.GenericSubjectId; +import org.keycloak.ssf.subject.IssuerSubjectId; import org.keycloak.ssf.transmitter.resources.AddSubjectRequest; +import org.keycloak.util.JsonSerialization; import org.junit.Test; import static org.hamcrest.CoreMatchers.containsString; import static org.hamcrest.CoreMatchers.equalTo; import static org.hamcrest.CoreMatchers.is; -import static org.hamcrest.CoreMatchers.nullValue; import static org.hamcrest.MatcherAssert.assertThat; +import static org.junit.Assert.assertNull; import static org.junit.Assert.assertThrows; public class QuarkusObjectMapperResolverTest { + @Test + public void preserveIssuerInfoAcrossInternalAndRestMappers() throws Exception { + var mapper = new QuarkusObjectMapperResolver().getContext(CredentialIssuer.class); + for (String data : List.of("\"signed-certificate\"", "{\"nested\":[1,true,null]}", + "[\"value\",2]", "1.25", "true", "null")) { + String json = "{\"issuer_info\":[{\"format\":\"registration_cert\",\"data\":" + data + "}]}"; + var issuer = JsonSerialization.readValue(json, CredentialIssuer.class); + + assertThat(JsonSerialization.mapper.readTree(mapper.writeValueAsString(issuer)), + equalTo(JsonSerialization.mapper.readTree(JsonSerialization.writeValueAsString(issuer)))); + var restored = mapper.readValue(json, CredentialIssuer.class); + assertThat(JsonSerialization.mapper.readTree(JsonSerialization.writeValueAsString(restored)), + equalTo(JsonSerialization.mapper.readTree(JsonSerialization.writeValueAsString(issuer)))); + } + } + @Test public void omitNullTokenResponseFields() throws Exception { var response = new AccessTokenResponse(); @@ -37,10 +58,6 @@ public void omitNullTokenResponseFields() throws Exception { assertThat(json.get("access_token").asString(), equalTo("access-token")); assertThat(json.has("authorization_details"), is(false)); assertThat(json.has("refresh_token"), is(false)); - - var legacyMapper = resolver.getObjectMapper(); - assertThat(legacyMapper.readTree(resolver.getContext(AccessTokenResponse.class).writeValueAsString(response)), - equalTo(legacyMapper.readTree(legacyMapper.writeValueAsString(response)))); } @Test @@ -79,188 +96,133 @@ public void honorPrettyPrinting() { } } - @Test - public void preserveLegacyJsonNodes() throws Exception { - var resolver = new QuarkusObjectMapperResolver(); - var legacyMapper = resolver.getObjectMapper(); - var mapper = resolver.getContext(Object.class); - - for (String json : List.of("\"signed-data\"", "{\"nested\":[1,true,null]}", "[\"value\",2]", "1.25", "true", "null")) { - var value = new LinkedHashMap(); - value.put("data", legacyMapper.readTree(json)); - assertThat(json, legacyMapper.readTree(mapper.writeValueAsString(value)), - equalTo(legacyMapper.readTree(legacyMapper.writeValueAsString(value)))); - } - } - @Test public void preserveWorkflowDeserialization() throws Exception { String json = "{\"name\":\"test\",\"on\":\"user-created\",\"steps\":[{\"uses\":\"set-user-attribute\",\"custom\":\"value\"}]}"; var resolver = new QuarkusObjectMapperResolver(); - var legacyMapper = resolver.getObjectMapper(); - var expected = legacyMapper.readValue(json, WorkflowRepresentation.class); var actual = resolver.getContext(WorkflowRepresentation.class).readValue(json, WorkflowRepresentation.class); - assertThat(legacyMapper.readTree(legacyMapper.writeValueAsString(actual)), - equalTo(legacyMapper.readTree(legacyMapper.writeValueAsString(expected)))); + assertThat(actual.getName(), equalTo("test")); + assertThat(actual.getOn(), equalTo("user-created")); + assertThat(actual.getSteps().size(), equalTo(1)); + var step = actual.getSteps().get(0); + assertThat(step.getUses(), equalTo("set-user-attribute")); + assertThat(step.getConfig().get("custom"), equalTo(List.of("value"))); } @Test - public void preserveAuthorizationSchemaForms() throws Exception { - var resolver = new QuarkusObjectMapperResolver(); + public void preserveAuthorizationSchemaForms() { + var mapper = new QuarkusObjectMapperResolver().getContext(AuthorizationSchema.class); String resource = "{\"type\":\"document\",\"scopes\":[\"read\",\"write\"]}"; for (String types : List.of("[" + resource + "]", "{\"document\":" + resource + "}")) { - String json = "{\"resourceTypes\":" + types + "}"; - var expected = resolver.getObjectMapper().readValue(json, AuthorizationSchema.class); - var actual = resolver.getContext(AuthorizationSchema.class).readValue(json, AuthorizationSchema.class); - assertThat(actual.getResourceTypes().keySet(), equalTo(expected.getResourceTypes().keySet())); - assertThat(actual.getResourceTypes().get("document").getScopes(), - equalTo(expected.getResourceTypes().get("document").getScopes())); + var actual = mapper.readValue("{\"resourceTypes\":" + types + "}", AuthorizationSchema.class); + + assertThat(actual.getResourceTypes().keySet(), equalTo(Set.of("document"))); + assertThat(actual.getResourceTypes().get("document").getScopes(), equalTo(Set.of("read", "write"))); } } @Test - public void preserveWorkflowConfiguration() throws Exception { - var resolver = new QuarkusObjectMapperResolver(); - var legacyMapper = resolver.getObjectMapper(); + public void preserveWorkflowConfiguration() { + var mapper = new QuarkusObjectMapperResolver().getContext(WorkflowRepresentation.class); var workflow = WorkflowRepresentation.withName("test") .onEvent("user-created") .withSteps(WorkflowStepRepresentation.create().of("set-user-attribute") .withConfig("key", "value").withConfig("values", "first", "second").build()) .build(); - String json = legacyMapper.writeValueAsString(workflow); - var actual = resolver.getContext(WorkflowRepresentation.class).readValue(json, WorkflowRepresentation.class); + String json = "{\"name\":\"test\",\"on\":\"user-created\",\"steps\":[{\"uses\":\"set-user-attribute\"," + + "\"with\":{\"key\":\"value\",\"values\":[\"first\",\"second\"]}}]}"; + var actual = mapper.readValue(json, WorkflowRepresentation.class); + + assertThat(actual.getName(), equalTo("test")); + assertThat(actual.getOn(), equalTo("user-created")); + assertThat(actual.getSteps().size(), equalTo(1)); + var step = actual.getSteps().get(0); + assertThat(step.getUses(), equalTo("set-user-attribute")); + assertThat(step.getConfig(), equalTo(Map.of("key", List.of("value"), "values", List.of("first", "second")))); + assertThat(mapper.readTree(mapper.writeValueAsString(workflow)), equalTo(mapper.readTree(json))); + } + + @Test + public void preserveAuthZenOptions() { + var mapper = new QuarkusObjectMapperResolver().getContext(AuthZen.Options.class); + var semantics = Map.of( + AuthZen.EvaluationsSemantic.EXECUTE_ALL, "execute_all", + AuthZen.EvaluationsSemantic.DENY_ON_FIRST_DENY, "deny_on_first_deny", + AuthZen.EvaluationsSemantic.PERMIT_ON_FIRST_PERMIT, "permit_on_first_permit"); + semantics.forEach((semantic, value) -> { + var options = new AuthZen.Options(semantic); + String json = "{\"evaluations_semantic\":\"" + value + "\"}"; - assertThat(legacyMapper.readTree(legacyMapper.writeValueAsString(actual)), equalTo(legacyMapper.readTree(json))); - assertThat(legacyMapper.readTree(resolver.getContext(WorkflowRepresentation.class).writeValueAsString(workflow)), - equalTo(legacyMapper.readTree(json))); + assertThat(mapper.readValue(json, AuthZen.Options.class), equalTo(options)); + assertThat(mapper.readTree(mapper.writeValueAsString(options)), equalTo(mapper.readTree(json))); + }); } @Test - public void preserveAuthZenOptions() throws Exception { - var resolver = new QuarkusObjectMapperResolver(); - var legacyMapper = resolver.getObjectMapper(); - for (var semantic : AuthZen.EvaluationsSemantic.values()) { - var options = new AuthZen.Options(semantic); - String json = legacyMapper.writeValueAsString(options); - assertThat(resolver.getContext(AuthZen.Options.class).readValue(json, AuthZen.Options.class), equalTo(options)); - assertThat(legacyMapper.readTree(resolver.getContext(AuthZen.Options.class).writeValueAsString(options)), - equalTo(legacyMapper.readTree(json))); - } - } + public void preserveIssuerSubjectIdentifier() { + var mapper = new QuarkusObjectMapperResolver().getContext(AddSubjectRequest.class); + String expected = "{\"subject\":{\"format\":\"iss_sub\",\"iss\":\"https://issuer.example\",\"sub\":\"user\"}}"; + for (String discriminator : List.of("\"format\":\"iss_sub\"", "\"subject_type\":\"iss-sub\"")) { + String json = "{\"subject\":{" + discriminator + ",\"iss\":\"https://issuer.example\",\"sub\":\"user\"}}"; + var actual = mapper.readValue(json, AddSubjectRequest.class); - @Test - public void preserveLegacyJsonNodeDeserialization() throws Exception { - var resolver = new QuarkusObjectMapperResolver(); - var legacyMapper = resolver.getObjectMapper(); - var mapper = resolver.getContext(LegacyTreeHolder.class); - - for (String value : List.of("\"value\"", "{\"nested\":[1,true,null]}", "[1,2]", "1.25", "true", "null")) { - String json = "{\"data\":" + value + "}"; - var expected = legacyMapper.readValue(json, LegacyTreeHolder.class); - var actual = mapper.readValue(json, LegacyTreeHolder.class); - assertThat(json, actual.data, equalTo(expected.data)); + assertThat(actual.getSubject().getClass(), equalTo(IssuerSubjectId.class)); + var subject = (IssuerSubjectId) actual.getSubject(); + assertThat(subject.getFormat(), equalTo("iss_sub")); + assertThat(subject.getIss(), equalTo("https://issuer.example")); + assertThat(subject.getSub(), equalTo("user")); + assertThat(mapper.readTree(mapper.writeValueAsString(actual)), equalTo(mapper.readTree(expected))); } } @Test - public void preserveLegacyTreeNumbers() throws Exception { - var resolver = new QuarkusObjectMapperResolver(); - var legacy = resolver.getObjectMapper(); - var mapper = resolver.getContext(LegacyTreeHolder.class); - for (String number : List.of("1", "2147483648", "123456789012345678901234567890", "1.2500", "-0.0", "1e400", "-1e400")) { - String json = "{\"data\":" + number + "}"; - var expected = legacy.readValue(json, LegacyTreeHolder.class).data; - var actual = mapper.readValue(json, LegacyTreeHolder.class).data; - assertThat(number, actual.isNumber(), is(true)); - assertThat(number, actual.numberType(), equalTo(expected.numberType())); - assertThat(number, actual.numberValue(), equalTo(expected.numberValue())); - assertThat(number, mapper.writeValueAsString(actual), equalTo(legacy.writeValueAsString(expected))); - } - } + public void preserveEmailSubjectIdentifier() { + var mapper = new QuarkusObjectMapperResolver().getContext(AddSubjectRequest.class); + String json = "{\"subject\":{\"format\":\"email\",\"email\":\"user@example.com\"}}"; + var actual = mapper.readValue(json, AddSubjectRequest.class); - @Test - public void preserveStructuredTreeConversions() throws Exception { - var resolver = new QuarkusObjectMapperResolver(); - var legacy = resolver.getObjectMapper(); - var mapper = resolver.getContext(LegacyTreeHolder.class); - var holder = new LegacyTreeHolder(); - holder.data = legacy.readTree("{\"nested\":[1,true,null],\"explicitNull\":null}"); - - var tree = mapper.valueToTree(holder); - assertThat(tree.get("data").isObject(), is(true)); - assertThat(tree.get("data").get("nested").isArray(), is(true)); - assertThat(tree.get("data").get("explicitNull").isNull(), is(true)); - assertThat(tree.get("data").has("absent"), is(false)); - assertThat(mapper.convertValue(holder, Map.class), equalTo(legacy.convertValue(holder, Map.class))); - assertThat(mapper.treeToValue(tree, LegacyTreeHolder.class).data, equalTo(holder.data)); - assertThat(mapper.convertValue(Map.of("data", holder.data), LegacyTreeHolder.class).data, equalTo(holder.data)); - - assertThat(mapper.readValue("{}", LegacyTreeHolder.class).data, nullValue()); - assertThat(mapper.readValue("{\"data\":null}", LegacyTreeHolder.class).data.isNull(), is(true)); + assertThat(actual.getSubject().getClass(), equalTo(EmailSubjectId.class)); + assertThat(((EmailSubjectId) actual.getSubject()).getEmail(), equalTo("user@example.com")); + assertThat(mapper.readTree(mapper.writeValueAsString(actual)), equalTo(mapper.readTree(json))); } @Test - public void preserveInMemoryNumericTypesAndNonFinitePolicy() throws Exception { - var resolver = new QuarkusObjectMapperResolver(); - var legacy = resolver.getObjectMapper(); - var mapper = resolver.getContext(LegacyTreeHolder.class); - var factory = legacy.getNodeFactory(); - for (var number : List.of(factory.numberNode(1), factory.numberNode(1L), - factory.numberNode(new BigInteger("123456789012345678901234567890")), - factory.numberNode(1.25f), factory.numberNode(1.25d), - factory.numberNode(new BigDecimal("1.2345678901234567890123456789")), - factory.numberNode(Double.POSITIVE_INFINITY), factory.numberNode(Double.NEGATIVE_INFINITY), - factory.numberNode(Double.NaN), factory.numberNode(Float.NaN))) { - var holder = new LegacyTreeHolder(); - holder.data = number; - var tree = mapper.valueToTree(holder); - assertThat(tree.get("data").isNumber(), is(true)); - assertThat(tree.get("data").numberValue(), equalTo(number.numberValue())); - var converted = mapper.convertValue(Map.of("data", number), LegacyTreeHolder.class).data; - assertThat(converted.numberType(), equalTo(number.numberType())); - assertThat(converted.numberValue(), equalTo(number.numberValue())); - assertThat(mapper.writeValueAsString(holder), equalTo(legacy.writeValueAsString(holder))); + public void preserveComplexSubjectIdentifier() { + var mapper = new QuarkusObjectMapperResolver().getContext(AddSubjectRequest.class); + for (String user : List.of("{\"format\":\"email\",\"email\":\"user@example.com\"}", + "{\"format\":\"iss_sub\",\"iss\":\"https://issuer.example\",\"sub\":\"user\"}")) { + String json = "{\"subject\":{\"format\":\"complex\",\"user\":" + user + "}}"; + var actual = mapper.readValue(json, AddSubjectRequest.class); + + assertThat(actual.getSubject().getClass(), equalTo(ComplexSubjectId.class)); + var subject = (ComplexSubjectId) actual.getSubject(); + assertThat(subject.getUser().getClass(), equalTo(user.contains("email") ? EmailSubjectId.class : IssuerSubjectId.class)); + assertThat(mapper.readTree(mapper.writeValueAsString(actual)), equalTo(mapper.readTree(json))); } - // Like the legacy mapper, bare non-finite literals are not valid JSON input. - assertThrows(com.fasterxml.jackson.core.JsonProcessingException.class, - () -> legacy.readValue("{\"data\":NaN}", LegacyTreeHolder.class)); - assertThrows(tools.jackson.core.JacksonException.class, - () -> mapper.readValue("{\"data\":NaN}", LegacyTreeHolder.class)); } @Test - public void preserveEmbeddedTreeValues() throws Exception { - var resolver = new QuarkusObjectMapperResolver(); - var legacy = resolver.getObjectMapper(); - var mapper = resolver.getContext(LegacyTreeHolder.class); - var holder = new LegacyTreeHolder(); - holder.data = legacy.getNodeFactory().binaryNode(new byte[] { 1, 2, 3 }); - assertThat(mapper.writeValueAsString(holder), equalTo(legacy.writeValueAsString(holder))); - assertThat(mapper.valueToTree(holder).get("data").binaryValue(), equalTo(holder.data.binaryValue())); - holder.data = legacy.getNodeFactory().pojoNode(Map.of("nested", List.of(1, 2))); - assertThat(mapper.valueToTree(holder).get("data").isObject(), is(true)); - assertThat(mapper.convertValue(holder, Map.class), equalTo(legacy.convertValue(holder, Map.class))); + public void preserveCustomSubjectIdentifierAttributes() { + var mapper = new QuarkusObjectMapperResolver().getContext(AddSubjectRequest.class); + String json = "{\"subject\":{\"format\":\"custom-format\",\"extension\":{\"values\":[1,true,null]}}}"; + var actual = mapper.readValue(json, AddSubjectRequest.class); + + assertThat(actual.getSubject().getClass(), equalTo(GenericSubjectId.class)); + assertThat(actual.getSubject().getFormat(), equalTo("custom-format")); + assertThat(mapper.valueToTree(actual.getSubject().getAttributes()), + equalTo(mapper.readTree("{\"extension\":{\"values\":[1,true,null]}}"))); + assertThat(mapper.readTree(mapper.writeValueAsString(actual)), + equalTo(mapper.readTree("{\"subject\":{\"format\":\"custom-format\"}}"))); } @Test - public void preserveSubjectIdentifierFormatsAndExtensions() throws Exception { - var resolver = new QuarkusObjectMapperResolver(); - var legacy = resolver.getObjectMapper(); - var mapper = resolver.getContext(AddSubjectRequest.class); - for (String subject : List.of("null", - "{\"format\":\"iss_sub\",\"iss\":\"https://issuer.example\",\"sub\":\"user\"}", - "{\"subject_type\":\"iss-sub\",\"iss\":\"https://issuer.example\",\"sub\":\"user\"}", - "{\"format\":\"email\",\"email\":\"user@example.com\"}", - "{\"format\":\"complex\",\"user\":{\"format\":\"email\",\"email\":\"user@example.com\"}}", - "{\"format\":\"complex\",\"user\":{\"format\":\"iss_sub\",\"iss\":\"https://issuer.example\",\"sub\":\"user\"}}", - "{\"format\":\"custom-format\",\"extension\":{\"values\":[1,true,null]}}")) { - String json = "{\"subject\":" + subject + "}"; - var expected = legacy.readValue(json, AddSubjectRequest.class); - var actual = mapper.readValue(json, AddSubjectRequest.class); - assertThat(subject, legacy.valueToTree(actual), equalTo(legacy.valueToTree(expected))); - assertThat(subject, legacy.readTree(mapper.writeValueAsString(actual)), equalTo(legacy.valueToTree(expected))); - } + public void omitNullSubjectIdentifier() { + var mapper = new QuarkusObjectMapperResolver().getContext(AddSubjectRequest.class); + var actual = mapper.readValue("{\"subject\":null}", AddSubjectRequest.class); + + assertNull(actual.getSubject()); + assertThat(mapper.writeValueAsString(actual), equalTo("{}")); } @Test @@ -268,14 +230,9 @@ public void rejectInvalidSubjectIdentifierFormats() { var resolver = new QuarkusObjectMapperResolver(); for (String subject : List.of("{}", "{\"format\":null}", "{\"format\":42}")) { String json = "{\"subject\":" + subject + "}"; - assertThrows(com.fasterxml.jackson.core.JsonProcessingException.class, - () -> resolver.getObjectMapper().readValue(json, AddSubjectRequest.class)); assertThrows(tools.jackson.databind.exc.MismatchedInputException.class, () -> resolver.getContext(AddSubjectRequest.class).readValue(json, AddSubjectRequest.class)); } } - public static class LegacyTreeHolder { - public com.fasterxml.jackson.databind.JsonNode data; - } } diff --git a/quarkus/runtime/src/test/java/org/keycloak/quarkus/runtime/integration/jaxrs/RepresentationAdaptersTest.java b/quarkus/runtime/src/test/java/org/keycloak/quarkus/runtime/integration/jaxrs/RepresentationAdaptersTest.java index dc6bb2b810c7..af33dd53c7f6 100644 --- a/quarkus/runtime/src/test/java/org/keycloak/quarkus/runtime/integration/jaxrs/RepresentationAdaptersTest.java +++ b/quarkus/runtime/src/test/java/org/keycloak/quarkus/runtime/integration/jaxrs/RepresentationAdaptersTest.java @@ -2,8 +2,9 @@ import org.keycloak.representations.idm.UserRepresentation; -import com.fasterxml.jackson.databind.annotation.JsonNaming; import org.junit.Test; +import tools.jackson.databind.PropertyNamingStrategies; +import tools.jackson.databind.annotation.JsonNaming; import tools.jackson.databind.exc.MismatchedInputException; import tools.jackson.databind.exc.UnrecognizedPropertyException; import tools.jackson.databind.json.JsonMapper; @@ -32,30 +33,15 @@ public void serverRejectsScalarForArrayProperties() { } @Test - public void legacySnakeCaseNamingWorksInBothDirections() throws Exception { + public void snakeCaseNamingWorksInBothDirections() { var value = mapper().readValue("{\"some_value\":\"text\"}", SnakeCaseValue.class); assertThat(value.someValue, equalTo("text")); - assertThat(mapper().writeValueAsString(value), equalTo(new com.fasterxml.jackson.databind.ObjectMapper().writeValueAsString(value))); assertThat(mapper().writeValueAsString(value), equalTo("{\"some_value\":\"text\"}")); } - @Test - public void nativeJacksonNamingTakesPrecedenceOverLegacyNaming() { - var value = mapper().readValue("{\"some-value\":\"text\"}", NativeNamingValue.class); - - assertThat(value.someValue, equalTo("text")); - assertThat(mapper().writeValueAsString(value), equalTo("{\"some-value\":\"text\"}")); - } - - @JsonNaming(com.fasterxml.jackson.databind.PropertyNamingStrategies.SnakeCaseStrategy.class) + @JsonNaming(PropertyNamingStrategies.SnakeCaseStrategy.class) public static class SnakeCaseValue { public String someValue; } - - @JsonNaming(com.fasterxml.jackson.databind.PropertyNamingStrategies.SnakeCaseStrategy.class) - @tools.jackson.databind.annotation.JsonNaming(tools.jackson.databind.PropertyNamingStrategies.KebabCaseStrategy.class) - public static class NativeNamingValue { - public String someValue; - } } diff --git a/services/src/main/java/org/keycloak/protocol/oid4vc/issuance/OID4VCIssuerWellKnownProvider.java b/services/src/main/java/org/keycloak/protocol/oid4vc/issuance/OID4VCIssuerWellKnownProvider.java index 606199353a61..6b8dd907e493 100644 --- a/services/src/main/java/org/keycloak/protocol/oid4vc/issuance/OID4VCIssuerWellKnownProvider.java +++ b/services/src/main/java/org/keycloak/protocol/oid4vc/issuance/OID4VCIssuerWellKnownProvider.java @@ -197,7 +197,7 @@ public static List getIssuerInfo(RealmModel realm) }); if (issuerInfo == null || issuerInfo.stream().anyMatch(info -> info == null || info.getFormat() == null || info.getFormat().isBlank() - || info.getData() == null || info.getData().isNull())) { + || info.getData() == null || info.getData().getValue() == null)) { LOGGER.warnf("Invalid %s realm attribute. Skipping issuer_info.", ISSUER_INFO_ATTR); return null; } diff --git a/services/src/main/java/org/keycloak/protocol/oid4vc/model/CredentialIssuer.java b/services/src/main/java/org/keycloak/protocol/oid4vc/model/CredentialIssuer.java index c6633fa34602..89be3617d639 100644 --- a/services/src/main/java/org/keycloak/protocol/oid4vc/model/CredentialIssuer.java +++ b/services/src/main/java/org/keycloak/protocol/oid4vc/model/CredentialIssuer.java @@ -20,10 +20,11 @@ import java.util.List; import java.util.Map; +import org.keycloak.json.RawJsonValue; + import com.fasterxml.jackson.annotation.JsonIgnoreProperties; import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonProperty; -import com.fasterxml.jackson.databind.JsonNode; /** * Represents a credentials issuer according to the OID4VCI Credentials Issuer Metadata @@ -181,7 +182,7 @@ public static class IssuerInfo { private String format; @JsonProperty("data") - private JsonNode data; + private RawJsonValue data; public String getFormat() { return format; @@ -192,11 +193,11 @@ public IssuerInfo setFormat(String format) { return this; } - public JsonNode getData() { + public RawJsonValue getData() { return data; } - public IssuerInfo setData(JsonNode data) { + public IssuerInfo setData(RawJsonValue data) { this.data = data; return this; } diff --git a/tests/base/src/test/java/org/keycloak/tests/error/JacksonErrorResponseTest.java b/tests/base/src/test/java/org/keycloak/tests/error/JacksonErrorResponseTest.java index 3000f94ff255..0f856be0852a 100644 --- a/tests/base/src/test/java/org/keycloak/tests/error/JacksonErrorResponseTest.java +++ b/tests/base/src/test/java/org/keycloak/tests/error/JacksonErrorResponseTest.java @@ -94,13 +94,14 @@ void responseFailureNegotiatesHtml() throws IOException { } @Test - void legacyMapperRemainsAvailableThroughCdi() throws IOException { - HttpResponse response = client.execute(new HttpGet(uri("/legacy-mapper", null))); + void jackson3MapperIsAvailableThroughCdi() throws IOException { + HttpResponse response = client.execute(new HttpGet(uri("/mapper", null))); String json = EntityUtils.toString(response.getEntity()); assertThat(json, response.getStatusLine().getStatusCode(), is(200)); var body = JsonSerialization.mapper.readTree(json); - assertThat(body.get("optional").asText(), is("value")); - assertThat(body.get("date"), is(JsonSerialization.mapper.readTree("[2026,1,2]"))); + assertThat(body.get("access_token").asText(), is("access-token")); + assertThat(body.has("refresh_token"), is(false)); + assertThat(body.has("authorization_details"), is(false)); } private HttpResponse post(String path, String body, String accept, String transaction) throws IOException { diff --git a/tests/custom-providers/pom.xml b/tests/custom-providers/pom.xml index a15b762aa8e6..fca6d68fe821 100755 --- a/tests/custom-providers/pom.xml +++ b/tests/custom-providers/pom.xml @@ -32,6 +32,11 @@ Keycloak Testsuite Custom Providers + + tools.jackson.core + jackson-databind + provided + org.keycloak keycloak-core diff --git a/tests/custom-providers/src/main/java/org/keycloak/tests/providers/rest/ErrorTestingRealmResourceProvider.java b/tests/custom-providers/src/main/java/org/keycloak/tests/providers/rest/ErrorTestingRealmResourceProvider.java index 4f9fcca6d927..ab011c0e3cb7 100644 --- a/tests/custom-providers/src/main/java/org/keycloak/tests/providers/rest/ErrorTestingRealmResourceProvider.java +++ b/tests/custom-providers/src/main/java/org/keycloak/tests/providers/rest/ErrorTestingRealmResourceProvider.java @@ -1,9 +1,6 @@ package org.keycloak.tests.providers.rest; -import java.io.IOException; -import java.time.LocalDate; import java.util.Map; -import java.util.Optional; import java.util.concurrent.ConcurrentHashMap; import jakarta.enterprise.inject.spi.CDI; @@ -18,6 +15,7 @@ import org.keycloak.models.AbstractKeycloakTransaction; import org.keycloak.models.KeycloakSession; +import org.keycloak.representations.AccessTokenResponse; import org.keycloak.services.ErrorPage; import org.keycloak.services.resource.RealmResourceProvider; @@ -90,12 +88,13 @@ public String transactionOutcome(@QueryParam("transaction") String transaction) } @GET - @Path("json/legacy-mapper") + @Path("json/mapper") @Produces(MediaType.APPLICATION_JSON) - public String legacyMapper() throws IOException { - // Extension consumers must still be able to resolve the legacy CDI producer. - var mapper = CDI.current().select(com.fasterxml.jackson.databind.ObjectMapper.class).get(); - return mapper.writeValueAsString(Map.of("optional", Optional.of("value"), "date", LocalDate.of(2026, 1, 2))); + public String mapper() { + var mapper = CDI.current().select(tools.jackson.databind.ObjectMapper.class).get(); + var response = new AccessTokenResponse(); + response.setToken("access-token"); + return mapper.writeValueAsString(response); } private void trackTransaction(String transaction) { From f2c5961d3d22c260317867135d80ee55da840219 Mon Sep 17 00:00:00 2001 From: Peter Zaoral Date: Sun, 15 Nov 2026 13:06:07 +0100 Subject: [PATCH 3/3] [Quarkus 4] Adapt Keycloak JSON handling to Jackson 3 Closes: #54599 Signed-off-by: Peter Zaoral --- ...KeycloakObjectMapperConfigurationTest.java | 41 ++++++++++ .../json/KeycloakObjectMapperTest.java} | 82 +++++++++---------- .../jaxrs/KeycloakObjectMapperCustomizer.java | 39 +++++++++ .../jaxrs/QuarkusObjectMapperResolver.java | 62 -------------- .../jaxrs/RepresentationAdaptersTest.java | 26 +++++- .../ErrorTestingRealmResourceProvider.java | 2 +- 6 files changed, 144 insertions(+), 108 deletions(-) create mode 100644 quarkus/deployment/src/test/java/test/org/keycloak/quarkus/json/KeycloakObjectMapperConfigurationTest.java rename quarkus/{runtime/src/test/java/org/keycloak/quarkus/runtime/integration/jaxrs/QuarkusObjectMapperResolverTest.java => deployment/src/test/java/test/org/keycloak/quarkus/json/KeycloakObjectMapperTest.java} (79%) create mode 100644 quarkus/runtime/src/main/java/org/keycloak/quarkus/runtime/integration/jaxrs/KeycloakObjectMapperCustomizer.java delete mode 100644 quarkus/runtime/src/main/java/org/keycloak/quarkus/runtime/integration/jaxrs/QuarkusObjectMapperResolver.java diff --git a/quarkus/deployment/src/test/java/test/org/keycloak/quarkus/json/KeycloakObjectMapperConfigurationTest.java b/quarkus/deployment/src/test/java/test/org/keycloak/quarkus/json/KeycloakObjectMapperConfigurationTest.java new file mode 100644 index 000000000000..04651d51ffb5 --- /dev/null +++ b/quarkus/deployment/src/test/java/test/org/keycloak/quarkus/json/KeycloakObjectMapperConfigurationTest.java @@ -0,0 +1,41 @@ +package test.org.keycloak.quarkus.json; + +import java.util.HashMap; +import java.util.Map; + +import jakarta.inject.Inject; + +import org.keycloak.representations.AccessTokenResponse; + +import io.quarkus.test.junit.QuarkusTest; +import io.quarkus.test.junit.TestProfile; +import org.junit.jupiter.api.Test; +import tools.jackson.databind.json.JsonMapper; + +import static org.hamcrest.CoreMatchers.equalTo; +import static org.hamcrest.MatcherAssert.assertThat; + +@QuarkusTest +@TestProfile(KeycloakObjectMapperConfigurationTest.LenientTrailingTokensProfile.class) +public class KeycloakObjectMapperConfigurationTest { + + @Inject + JsonMapper mapper; + + @Test + public void honorQuarkusTrailingTokensConfiguration() { + var response = mapper.readValue("{\"access_token\":\"access-token\"} {}", AccessTokenResponse.class); + + assertThat(response.getToken(), equalTo("access-token")); + } + + public static class LenientTrailingTokensProfile extends KeycloakObjectMapperTest.MapperProfile { + + @Override + public Map getConfigOverrides() { + var config = new HashMap<>(super.getConfigOverrides()); + config.put("quarkus.jackson.fail-on-trailing-tokens", "false"); + return config; + } + } +} diff --git a/quarkus/runtime/src/test/java/org/keycloak/quarkus/runtime/integration/jaxrs/QuarkusObjectMapperResolverTest.java b/quarkus/deployment/src/test/java/test/org/keycloak/quarkus/json/KeycloakObjectMapperTest.java similarity index 79% rename from quarkus/runtime/src/test/java/org/keycloak/quarkus/runtime/integration/jaxrs/QuarkusObjectMapperResolverTest.java rename to quarkus/deployment/src/test/java/test/org/keycloak/quarkus/json/KeycloakObjectMapperTest.java index 549295673664..df6076a9e2d1 100644 --- a/quarkus/runtime/src/test/java/org/keycloak/quarkus/runtime/integration/jaxrs/QuarkusObjectMapperResolverTest.java +++ b/quarkus/deployment/src/test/java/test/org/keycloak/quarkus/json/KeycloakObjectMapperTest.java @@ -1,4 +1,4 @@ -package org.keycloak.quarkus.runtime.integration.jaxrs; +package test.org.keycloak.quarkus.json; import java.util.LinkedHashMap; import java.util.List; @@ -6,6 +6,8 @@ import java.util.Set; import java.util.stream.Stream; +import jakarta.inject.Inject; + import org.keycloak.authorization.authzen.AuthZen; import org.keycloak.protocol.oid4vc.model.CredentialIssuer; import org.keycloak.representations.AccessTokenResponse; @@ -19,20 +21,40 @@ import org.keycloak.ssf.transmitter.resources.AddSubjectRequest; import org.keycloak.util.JsonSerialization; -import org.junit.Test; +import io.quarkus.test.junit.QuarkusTest; +import io.quarkus.test.junit.QuarkusTestProfile; +import io.quarkus.test.junit.TestProfile; +import org.junit.jupiter.api.Test; +import tools.jackson.databind.json.JsonMapper; -import static org.hamcrest.CoreMatchers.containsString; import static org.hamcrest.CoreMatchers.equalTo; import static org.hamcrest.CoreMatchers.is; import static org.hamcrest.MatcherAssert.assertThat; -import static org.junit.Assert.assertNull; -import static org.junit.Assert.assertThrows; - -public class QuarkusObjectMapperResolverTest { +import static org.junit.jupiter.api.Assertions.assertNull; +import static org.junit.jupiter.api.Assertions.assertThrows; + +@QuarkusTest +@TestProfile(KeycloakObjectMapperTest.MapperProfile.class) +public class KeycloakObjectMapperTest { + + @Inject + JsonMapper mapper; + + public static class MapperProfile implements QuarkusTestProfile { + + @Override + public Map getConfigOverrides() { + return Map.of("kc.http-enabled", "true", + "kc.hostname-strict", "false", + "kc.db", "dev-mem", + "kc.cache", "local", + "kc.server-async-bootstrap", "false", + "quarkus.class-loading.removed-artifacts", "io.quarkus:quarkus-jdbc-oracle,io.quarkus:quarkus-jdbc-oracle-deployment"); + } + } @Test public void preserveIssuerInfoAcrossInternalAndRestMappers() throws Exception { - var mapper = new QuarkusObjectMapperResolver().getContext(CredentialIssuer.class); for (String data : List.of("\"signed-certificate\"", "{\"nested\":[1,true,null]}", "[\"value\",2]", "1.25", "true", "null")) { String json = "{\"issuer_info\":[{\"format\":\"registration_cert\",\"data\":" + data + "}]}"; @@ -46,12 +68,16 @@ public void preserveIssuerInfoAcrossInternalAndRestMappers() throws Exception { } } + @Test + public void rejectTrailingTokensByDefault() { + assertThrows(tools.jackson.databind.exc.MismatchedInputException.class, + () -> mapper.readValue("{\"access_token\":\"access-token\"} {}", AccessTokenResponse.class)); + } + @Test public void omitNullTokenResponseFields() throws Exception { var response = new AccessTokenResponse(); response.setToken("access-token"); - var resolver = new QuarkusObjectMapperResolver(); - var mapper = resolver.getContext(AccessTokenResponse.class); var json = mapper.readTree(mapper.writeValueAsString(response)); @@ -62,8 +88,6 @@ public void omitNullTokenResponseFields() throws Exception { @Test public void serializeStreamsAsArrays() { - var mapper = new QuarkusObjectMapperResolver().getContext(Stream.class); - assertThat(mapper.writeValueAsString(Stream.of("first", "second")), equalTo("[\"first\",\"second\"]")); } @@ -72,35 +96,14 @@ public void omitNullMapValues() { var values = new LinkedHashMap(); values.put("visible", "value"); values.put("hidden", null); - var mapper = new QuarkusObjectMapperResolver().getContext(values.getClass()); assertThat(mapper.writeValueAsString(values), equalTo("{\"visible\":\"value\"}")); } - @Test - public void honorPrettyPrinting() { - String previous = System.getProperty("keycloak.jsonPrettyPrint"); - try { - System.setProperty("keycloak.jsonPrettyPrint", "true"); - var mapper = new QuarkusObjectMapperResolver().getContext(Object.class); - var values = new LinkedHashMap(); - values.put("key", "value"); - - assertThat(mapper.writeValueAsString(values), containsString("\n")); - } finally { - if (previous == null) { - System.clearProperty("keycloak.jsonPrettyPrint"); - } else { - System.setProperty("keycloak.jsonPrettyPrint", previous); - } - } - } - @Test public void preserveWorkflowDeserialization() throws Exception { String json = "{\"name\":\"test\",\"on\":\"user-created\",\"steps\":[{\"uses\":\"set-user-attribute\",\"custom\":\"value\"}]}"; - var resolver = new QuarkusObjectMapperResolver(); - var actual = resolver.getContext(WorkflowRepresentation.class).readValue(json, WorkflowRepresentation.class); + var actual = mapper.readValue(json, WorkflowRepresentation.class); assertThat(actual.getName(), equalTo("test")); assertThat(actual.getOn(), equalTo("user-created")); @@ -112,7 +115,6 @@ public void preserveWorkflowDeserialization() throws Exception { @Test public void preserveAuthorizationSchemaForms() { - var mapper = new QuarkusObjectMapperResolver().getContext(AuthorizationSchema.class); String resource = "{\"type\":\"document\",\"scopes\":[\"read\",\"write\"]}"; for (String types : List.of("[" + resource + "]", "{\"document\":" + resource + "}")) { var actual = mapper.readValue("{\"resourceTypes\":" + types + "}", AuthorizationSchema.class); @@ -124,7 +126,6 @@ public void preserveAuthorizationSchemaForms() { @Test public void preserveWorkflowConfiguration() { - var mapper = new QuarkusObjectMapperResolver().getContext(WorkflowRepresentation.class); var workflow = WorkflowRepresentation.withName("test") .onEvent("user-created") .withSteps(WorkflowStepRepresentation.create().of("set-user-attribute") @@ -145,7 +146,6 @@ public void preserveWorkflowConfiguration() { @Test public void preserveAuthZenOptions() { - var mapper = new QuarkusObjectMapperResolver().getContext(AuthZen.Options.class); var semantics = Map.of( AuthZen.EvaluationsSemantic.EXECUTE_ALL, "execute_all", AuthZen.EvaluationsSemantic.DENY_ON_FIRST_DENY, "deny_on_first_deny", @@ -161,7 +161,6 @@ public void preserveAuthZenOptions() { @Test public void preserveIssuerSubjectIdentifier() { - var mapper = new QuarkusObjectMapperResolver().getContext(AddSubjectRequest.class); String expected = "{\"subject\":{\"format\":\"iss_sub\",\"iss\":\"https://issuer.example\",\"sub\":\"user\"}}"; for (String discriminator : List.of("\"format\":\"iss_sub\"", "\"subject_type\":\"iss-sub\"")) { String json = "{\"subject\":{" + discriminator + ",\"iss\":\"https://issuer.example\",\"sub\":\"user\"}}"; @@ -178,7 +177,6 @@ public void preserveIssuerSubjectIdentifier() { @Test public void preserveEmailSubjectIdentifier() { - var mapper = new QuarkusObjectMapperResolver().getContext(AddSubjectRequest.class); String json = "{\"subject\":{\"format\":\"email\",\"email\":\"user@example.com\"}}"; var actual = mapper.readValue(json, AddSubjectRequest.class); @@ -189,7 +187,6 @@ public void preserveEmailSubjectIdentifier() { @Test public void preserveComplexSubjectIdentifier() { - var mapper = new QuarkusObjectMapperResolver().getContext(AddSubjectRequest.class); for (String user : List.of("{\"format\":\"email\",\"email\":\"user@example.com\"}", "{\"format\":\"iss_sub\",\"iss\":\"https://issuer.example\",\"sub\":\"user\"}")) { String json = "{\"subject\":{\"format\":\"complex\",\"user\":" + user + "}}"; @@ -204,7 +201,6 @@ public void preserveComplexSubjectIdentifier() { @Test public void preserveCustomSubjectIdentifierAttributes() { - var mapper = new QuarkusObjectMapperResolver().getContext(AddSubjectRequest.class); String json = "{\"subject\":{\"format\":\"custom-format\",\"extension\":{\"values\":[1,true,null]}}}"; var actual = mapper.readValue(json, AddSubjectRequest.class); @@ -218,7 +214,6 @@ public void preserveCustomSubjectIdentifierAttributes() { @Test public void omitNullSubjectIdentifier() { - var mapper = new QuarkusObjectMapperResolver().getContext(AddSubjectRequest.class); var actual = mapper.readValue("{\"subject\":null}", AddSubjectRequest.class); assertNull(actual.getSubject()); @@ -227,11 +222,10 @@ public void omitNullSubjectIdentifier() { @Test public void rejectInvalidSubjectIdentifierFormats() { - var resolver = new QuarkusObjectMapperResolver(); for (String subject : List.of("{}", "{\"format\":null}", "{\"format\":42}")) { String json = "{\"subject\":" + subject + "}"; assertThrows(tools.jackson.databind.exc.MismatchedInputException.class, - () -> resolver.getContext(AddSubjectRequest.class).readValue(json, AddSubjectRequest.class)); + () -> mapper.readValue(json, AddSubjectRequest.class)); } } diff --git a/quarkus/runtime/src/main/java/org/keycloak/quarkus/runtime/integration/jaxrs/KeycloakObjectMapperCustomizer.java b/quarkus/runtime/src/main/java/org/keycloak/quarkus/runtime/integration/jaxrs/KeycloakObjectMapperCustomizer.java new file mode 100644 index 000000000000..5584d61a4484 --- /dev/null +++ b/quarkus/runtime/src/main/java/org/keycloak/quarkus/runtime/integration/jaxrs/KeycloakObjectMapperCustomizer.java @@ -0,0 +1,39 @@ +package org.keycloak.quarkus.runtime.integration.jaxrs; + +import jakarta.inject.Singleton; + +import org.keycloak.json.jackson3.KeycloakAnnotationIntrospector3; +import org.keycloak.ssf.subject.SubjectId; + +import com.fasterxml.jackson.annotation.JsonInclude; +import io.quarkus.jackson.JsonMapperBuilderCustomizer; +import tools.jackson.databind.DeserializationFeature; +import tools.jackson.databind.MapperFeature; +import tools.jackson.databind.SerializationFeature; +import tools.jackson.databind.cfg.DateTimeFeature; +import tools.jackson.databind.json.JsonMapper; +import tools.jackson.databind.module.SimpleModule; + +/** + * Applies Keycloak's REST representation configuration to the mapper managed by Quarkus. + */ +@Singleton +public class KeycloakObjectMapperCustomizer implements JsonMapperBuilderCustomizer { + + @Override + public void customize(JsonMapper.Builder builder) { + builder.enable(DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES) + .enable(DateTimeFeature.WRITE_DATES_AS_TIMESTAMPS) + // Workflow steps expose immutable properties through their getters. + .enable(MapperFeature.ALLOW_FINAL_FIELDS_AS_MUTATORS) + .annotationIntrospector(new KeycloakAnnotationIntrospector3()) + .addModule(new SimpleModule().addDeserializer(SubjectId.class, new SubjectIdDeserializer())) + .changeDefaultPropertyInclusion(inclusion -> JsonInclude.Value.construct(JsonInclude.Include.NON_NULL, JsonInclude.Include.NON_NULL)); + if (Boolean.getBoolean("keycloak.jsonPrettyPrint")) { + builder.enable(SerializationFeature.INDENT_OUTPUT); + } + if (Boolean.parseBoolean(System.getProperty("keycloak.jsonEnableJacksonModuleDiscovery", "true"))) { + builder.findAndAddModules(); + } + } +} diff --git a/quarkus/runtime/src/main/java/org/keycloak/quarkus/runtime/integration/jaxrs/QuarkusObjectMapperResolver.java b/quarkus/runtime/src/main/java/org/keycloak/quarkus/runtime/integration/jaxrs/QuarkusObjectMapperResolver.java deleted file mode 100644 index 30d7ca4ac9da..000000000000 --- a/quarkus/runtime/src/main/java/org/keycloak/quarkus/runtime/integration/jaxrs/QuarkusObjectMapperResolver.java +++ /dev/null @@ -1,62 +0,0 @@ -/* - * Copyright 2022 Red Hat, Inc. and/or its affiliates - * and other contributors as indicated by the @author tags. - * - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - */ - -package org.keycloak.quarkus.runtime.integration.jaxrs; - -import jakarta.enterprise.context.ApplicationScoped; -import jakarta.enterprise.inject.Produces; -import jakarta.ws.rs.ext.ContextResolver; -import jakarta.ws.rs.ext.Provider; - -import org.keycloak.json.jackson3.KeycloakAnnotationIntrospector3; -import org.keycloak.ssf.subject.SubjectId; - -import com.fasterxml.jackson.annotation.JsonInclude; -import tools.jackson.databind.ObjectMapper; -import tools.jackson.databind.SerializationFeature; -import tools.jackson.databind.json.JsonMapper; -import tools.jackson.databind.module.SimpleModule; - -@Provider -@ApplicationScoped -public class QuarkusObjectMapperResolver implements ContextResolver { - - private final ObjectMapper mapper = createMapper(); - - @Produces - public ObjectMapper getObjectMapper() { - return mapper; - } - - @Override - public ObjectMapper getContext(Class type) { - return mapper; - } - - private static ObjectMapper createMapper() { - var builder = JsonMapper.builder() - .configureForJackson2() - .annotationIntrospector(new KeycloakAnnotationIntrospector3()) - .addModule(new SimpleModule().addDeserializer(SubjectId.class, new SubjectIdDeserializer())) - .changeDefaultPropertyInclusion(inclusion -> JsonInclude.Value.construct(JsonInclude.Include.NON_NULL, JsonInclude.Include.NON_NULL)) - .configure(SerializationFeature.INDENT_OUTPUT, Boolean.getBoolean("keycloak.jsonPrettyPrint")); - if (Boolean.parseBoolean(System.getProperty("keycloak.jsonEnableJacksonModuleDiscovery", "true"))) { - builder.findAndAddModules(); - } - return builder.build(); - } -} diff --git a/quarkus/runtime/src/test/java/org/keycloak/quarkus/runtime/integration/jaxrs/RepresentationAdaptersTest.java b/quarkus/runtime/src/test/java/org/keycloak/quarkus/runtime/integration/jaxrs/RepresentationAdaptersTest.java index af33dd53c7f6..59bc922203d6 100644 --- a/quarkus/runtime/src/test/java/org/keycloak/quarkus/runtime/integration/jaxrs/RepresentationAdaptersTest.java +++ b/quarkus/runtime/src/test/java/org/keycloak/quarkus/runtime/integration/jaxrs/RepresentationAdaptersTest.java @@ -1,5 +1,7 @@ package org.keycloak.quarkus.runtime.integration.jaxrs; +import java.util.LinkedHashMap; + import org.keycloak.representations.idm.UserRepresentation; import org.junit.Test; @@ -9,6 +11,7 @@ import tools.jackson.databind.exc.UnrecognizedPropertyException; import tools.jackson.databind.json.JsonMapper; +import static org.hamcrest.CoreMatchers.containsString; import static org.hamcrest.CoreMatchers.equalTo; import static org.hamcrest.MatcherAssert.assertThat; import static org.junit.Assert.assertThrows; @@ -17,7 +20,28 @@ public class RepresentationAdaptersTest extends org.keycloak.json.jackson3.Repre @Override protected JsonMapper mapper() { - return (JsonMapper) new QuarkusObjectMapperResolver().getContext(Object.class); + var builder = JsonMapper.builder(); + new KeycloakObjectMapperCustomizer().customize(builder); + return builder.build(); + } + + @Test + public void honorPrettyPrinting() { + String previous = System.getProperty("keycloak.jsonPrettyPrint"); + try { + System.setProperty("keycloak.jsonPrettyPrint", "true"); + var mapper = mapper(); + var values = new LinkedHashMap(); + values.put("key", "value"); + + assertThat(mapper.writeValueAsString(values), containsString("\n")); + } finally { + if (previous == null) { + System.clearProperty("keycloak.jsonPrettyPrint"); + } else { + System.setProperty("keycloak.jsonPrettyPrint", previous); + } + } } @Test diff --git a/tests/custom-providers/src/main/java/org/keycloak/tests/providers/rest/ErrorTestingRealmResourceProvider.java b/tests/custom-providers/src/main/java/org/keycloak/tests/providers/rest/ErrorTestingRealmResourceProvider.java index ab011c0e3cb7..d5e843f9179e 100644 --- a/tests/custom-providers/src/main/java/org/keycloak/tests/providers/rest/ErrorTestingRealmResourceProvider.java +++ b/tests/custom-providers/src/main/java/org/keycloak/tests/providers/rest/ErrorTestingRealmResourceProvider.java @@ -91,7 +91,7 @@ public String transactionOutcome(@QueryParam("transaction") String transaction) @Path("json/mapper") @Produces(MediaType.APPLICATION_JSON) public String mapper() { - var mapper = CDI.current().select(tools.jackson.databind.ObjectMapper.class).get(); + var mapper = CDI.current().select(tools.jackson.databind.json.JsonMapper.class).get(); var response = new AccessTokenResponse(); response.setToken("access-token"); return mapper.writeValueAsString(response);