author
int64 658
755k
| date
stringlengths 19
19
| timezone
int64 -46,800
43.2k
| hash
stringlengths 40
40
| message
stringlengths 5
490
| mods
list | language
stringclasses 20
values | license
stringclasses 3
values | repo
stringlengths 5
68
| original_message
stringlengths 12
491
|
|---|---|---|---|---|---|---|---|---|---|
339,687 | 25.11.2022 10:46:31 | -3,600 | 88bc5e2307fe8b14d42d6e2a56584e0490959afa | Use different Postgres image in Testcontainers. Upgraded Testcontainers dependency to 1.17.5. | [
{
"change_type": "MODIFY",
"old_path": "pom.xml",
"new_path": "pom.xml",
"diff": "https://issues.redhat.com/browse/KEYCLOAK-17585?focusedCommentId=16002705&page=com.atlassian.jira.plugin.system.issuetabpanels%3Acomment-tabpanel#comment-16002705\n-->\n<microprofile-metrics-api.version>2.3</microprofile-metrics-api.version>\n- <testcontainers.version>1.16.3</testcontainers.version>\n+ <testcontainers.version>1.17.5</testcontainers.version>\n<!-- Maven Plugins -->\n<replacer.plugin.version>1.3.5</replacer.plugin.version>\n"
},
{
"change_type": "MODIFY",
"old_path": "testsuite/integration-arquillian/tests/base/src/main/java/org/keycloak/testsuite/arquillian/PostgresContainerTestEnricher.java",
"new_path": "testsuite/integration-arquillian/tests/base/src/main/java/org/keycloak/testsuite/arquillian/PostgresContainerTestEnricher.java",
"diff": "@@ -20,12 +20,13 @@ import org.jboss.arquillian.container.spi.event.StartSuiteContainers;\nimport org.jboss.arquillian.core.api.annotation.Observes;\nimport org.jboss.arquillian.test.spi.event.suite.AfterSuite;\nimport org.testcontainers.containers.PostgreSQLContainer;\n+import org.testcontainers.utility.DockerImageName;\npublic class PostgresContainerTestEnricher {\nprivate static final Boolean START_CONTAINER = Boolean.valueOf(System.getProperty(\"postgres.start-container\", \"false\"));\nprivate static final String POSTGRES_DOCKER_IMAGE_NAME = System.getProperty(\"keycloak.map.storage.postgres.docker.image\", \"postgres:alpine\");\n- private static final PostgreSQLContainer POSTGRES_CONTAINER = new PostgreSQLContainer(POSTGRES_DOCKER_IMAGE_NAME);\n+ private static final PostgreSQLContainer POSTGRES_CONTAINER = new PostgreSQLContainer(DockerImageName.parse(POSTGRES_DOCKER_IMAGE_NAME).asCompatibleSubstituteFor(\"postgres\"));\nprivate static final String POSTGRES_DB_USER = System.getProperty(\"keycloak.map.storage.connectionsJpa.user\", \"keycloak\");\nprivate static final String POSTGRES_DB_PASSWORD = System.getProperty(\"keycloak.map.storage.connectionsJpa.password\", \"pass\");\n"
},
{
"change_type": "MODIFY",
"old_path": "testsuite/model/src/test/java/org/keycloak/testsuite/model/parameters/JpaMapStorage.java",
"new_path": "testsuite/model/src/test/java/org/keycloak/testsuite/model/parameters/JpaMapStorage.java",
"diff": "@@ -52,6 +52,7 @@ import org.keycloak.sessions.AuthenticationSessionSpi;\nimport org.keycloak.testsuite.model.Config;\nimport org.keycloak.testsuite.model.KeycloakModelParameters;\nimport org.testcontainers.containers.PostgreSQLContainer;\n+import org.testcontainers.utility.DockerImageName;\npublic class JpaMapStorage extends KeycloakModelParameters {\n@@ -59,7 +60,7 @@ public class JpaMapStorage extends KeycloakModelParameters {\nprivate static final Boolean START_CONTAINER = Boolean.valueOf(System.getProperty(\"postgres.start-container\", \"true\"));\nprivate static final String POSTGRES_DOCKER_IMAGE_NAME = System.getProperty(\"keycloak.map.storage.postgres.docker.image\", \"postgres:alpine\");\n- private static final PostgreSQLContainer POSTGRES_CONTAINER = new PostgreSQLContainer(POSTGRES_DOCKER_IMAGE_NAME);\n+ private static final PostgreSQLContainer POSTGRES_CONTAINER = new PostgreSQLContainer(DockerImageName.parse(POSTGRES_DOCKER_IMAGE_NAME).asCompatibleSubstituteFor(\"postgres\"));\nprivate static final String POSTGRES_DB_DEFAULT_NAME = System.getProperty(\"keycloak.map.storage.connectionsJpa.databaseName\", \"keycloak\");\nprivate static final String POSTGRES_DB_USER = System.getProperty(\"keycloak.map.storage.connectionsJpa.user\", \"keycloak\");\nprivate static final String POSTGRES_DB_PASSWORD = System.getProperty(\"keycloak.map.storage.connectionsJpa.password\", \"pass\");\n"
}
] | Java | Apache License 2.0 | keycloak/keycloak | Use different Postgres image in Testcontainers. Upgraded Testcontainers dependency to 1.17.5. |
339,487 | 28.11.2022 22:32:05 | 10,800 | 55b21624218121acdf67249d9089bce496adf9f7 | Create map-file module with empty implementations
Closes | [
{
"change_type": "MODIFY",
"old_path": "dependencies/server-all/pom.xml",
"new_path": "dependencies/server-all/pom.xml",
"diff": "<groupId>org.keycloak</groupId>\n<artifactId>keycloak-model-map-hot-rod</artifactId>\n</dependency>\n+ <dependency>\n+ <groupId>org.keycloak</groupId>\n+ <artifactId>keycloak-model-map-file</artifactId>\n+ </dependency>\n<!-- identity providers -->\n<dependency>\n<groupId>org.twitter4j</groupId>\n"
},
{
"change_type": "ADD",
"old_path": null,
"new_path": "model/map-file/pom.xml",
"diff": "+<?xml version=\"1.0\"?>\n+<!--\n+ ~ Copyright 2022 Red Hat, Inc. and/or its affiliates\n+ ~ and other contributors as indicated by the @author tags.\n+ ~\n+ ~ Licensed under the Apache License, Version 2.0 (the \"License\");\n+ ~ you may not use this file except in compliance with the License.\n+ ~ You may obtain a copy of the License at\n+ ~\n+ ~ http://www.apache.org/licenses/LICENSE-2.0\n+ ~\n+ ~ Unless required by applicable law or agreed to in writing, software\n+ ~ distributed under the License is distributed on an \"AS IS\" BASIS,\n+ ~ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n+ ~ See the License for the specific language governing permissions and\n+ ~ limitations under the License.\n+ -->\n+\n+<project xmlns=\"http://maven.apache.org/POM/4.0.0\"\n+ xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\"\n+ xsi:schemaLocation=\"http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd\">\n+ <parent>\n+ <artifactId>keycloak-model-pom</artifactId>\n+ <groupId>org.keycloak</groupId>\n+ <version>999-SNAPSHOT</version>\n+ </parent>\n+ <modelVersion>4.0.0</modelVersion>\n+\n+ <artifactId>keycloak-model-map-file</artifactId>\n+ <name>Keycloak Model Map File</name>\n+ <dependencies>\n+ <dependency>\n+ <groupId>org.keycloak</groupId>\n+ <artifactId>keycloak-model-map</artifactId>\n+ </dependency>\n+ <dependency>\n+ <groupId>junit</groupId>\n+ <artifactId>junit</artifactId>\n+ <scope>test</scope>\n+ </dependency>\n+ </dependencies>\n+</project>\n\\ No newline at end of file\n"
},
{
"change_type": "ADD",
"old_path": null,
"new_path": "model/map-file/src/main/java/org/keycloak/models/map/storage/file/FileKeycloakTransaction.java",
"diff": "+/*\n+ * Copyright 2022 Red Hat, Inc. and/or its affiliates\n+ * and other contributors as indicated by the @author tags.\n+ *\n+ * Licensed under the Apache License, Version 2.0 (the \"License\");\n+ * you may not use this file except in compliance with the License.\n+ * You may obtain a copy of the License at\n+ *\n+ * http://www.apache.org/licenses/LICENSE-2.0\n+ *\n+ * Unless required by applicable law or agreed to in writing, software\n+ * distributed under the License is distributed on an \"AS IS\" BASIS,\n+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n+ * See the License for the specific language governing permissions and\n+ * limitations under the License.\n+ */\n+package org.keycloak.models.map.storage.file;\n+\n+import java.util.stream.Stream;\n+\n+import org.keycloak.models.map.common.AbstractEntity;\n+import org.keycloak.models.map.storage.MapKeycloakTransaction;\n+import org.keycloak.models.map.storage.QueryParameters;\n+\n+/**\n+ * {@link MapKeycloakTransaction} implementation used with the file map storage.\n+ *\n+ * @author <a href=\"mailto:sguilhen@redhat.com\">Stefan Guilhen</a>\n+ */\n+public class FileKeycloakTransaction<V extends AbstractEntity, M> implements MapKeycloakTransaction<V, M> {\n+\n+ private boolean active;\n+ private boolean rollback;\n+\n+ @Override\n+ public V create(V value) {\n+ return null;\n+ }\n+\n+ @Override\n+ public V read(String key) {\n+ return null;\n+ }\n+\n+ @Override\n+ public Stream<V> read(QueryParameters<M> queryParameters) {\n+ return null;\n+ }\n+\n+ @Override\n+ public long getCount(QueryParameters<M> queryParameters) {\n+ return 0;\n+ }\n+\n+ @Override\n+ public boolean delete(String key) {\n+ return false;\n+ }\n+\n+ @Override\n+ public long delete(QueryParameters<M> queryParameters) {\n+ return 0;\n+ }\n+\n+ @Override\n+ public void begin() {\n+ active = true;\n+ }\n+\n+ @Override\n+ public void commit() {\n+ if (rollback) {\n+ throw new RuntimeException(\"Rollback only!\");\n+ }\n+ }\n+\n+ @Override\n+ public void rollback() {\n+ }\n+\n+ @Override\n+ public void setRollbackOnly() {\n+ rollback = true;\n+ }\n+\n+ @Override\n+ public boolean getRollbackOnly() {\n+ return rollback;\n+ }\n+\n+ @Override\n+ public boolean isActive() {\n+ return active;\n+ }\n+}\n"
},
{
"change_type": "ADD",
"old_path": null,
"new_path": "model/map-file/src/main/java/org/keycloak/models/map/storage/file/FileMapStorage.java",
"diff": "+/*\n+ * Copyright 2022 Red Hat, Inc. and/or its affiliates\n+ * and other contributors as indicated by the @author tags.\n+ *\n+ * Licensed under the Apache License, Version 2.0 (the \"License\");\n+ * you may not use this file except in compliance with the License.\n+ * You may obtain a copy of the License at\n+ *\n+ * http://www.apache.org/licenses/LICENSE-2.0\n+ *\n+ * Unless required by applicable law or agreed to in writing, software\n+ * distributed under the License is distributed on an \"AS IS\" BASIS,\n+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n+ * See the License for the specific language governing permissions and\n+ * limitations under the License.\n+ */\n+package org.keycloak.models.map.storage.file;\n+\n+import org.keycloak.models.KeycloakSession;\n+import org.keycloak.models.map.common.AbstractEntity;\n+import org.keycloak.models.map.storage.MapKeycloakTransaction;\n+import org.keycloak.models.map.storage.MapStorage;\n+\n+/**\n+ * A file-based {@link MapStorage}.\n+ *\n+ * @author <a href=\"mailto:sguilhen@redhat.com\">Stefan Guilhen</a>\n+ */\n+public class FileMapStorage<V extends AbstractEntity, M> implements MapStorage<V, M> {\n+\n+ @Override\n+ public MapKeycloakTransaction<V, M> createTransaction(KeycloakSession session) {\n+ return new FileKeycloakTransaction();\n+ }\n+}\n"
},
{
"change_type": "ADD",
"old_path": null,
"new_path": "model/map-file/src/main/java/org/keycloak/models/map/storage/file/FileMapStorageProvider.java",
"diff": "+/*\n+ * Copyright 2022 Red Hat, Inc. and/or its affiliates\n+ * and other contributors as indicated by the @author tags.\n+ *\n+ * Licensed under the Apache License, Version 2.0 (the \"License\");\n+ * you may not use this file except in compliance with the License.\n+ * You may obtain a copy of the License at\n+ *\n+ * http://www.apache.org/licenses/LICENSE-2.0\n+ *\n+ * Unless required by applicable law or agreed to in writing, software\n+ * distributed under the License is distributed on an \"AS IS\" BASIS,\n+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n+ * See the License for the specific language governing permissions and\n+ * limitations under the License.\n+ */\n+package org.keycloak.models.map.storage.file;\n+\n+import org.keycloak.models.map.common.AbstractEntity;\n+import org.keycloak.models.map.storage.MapStorage;\n+import org.keycloak.models.map.storage.MapStorageProvider;\n+import org.keycloak.models.map.storage.MapStorageProviderFactory;\n+\n+/**\n+ * File-based {@link MapStorageProvider} implementation.\n+ *\n+ * @author <a href=\"mailto:sguilhen@redhat.com\">Stefan Guilhen</a>\n+ */\n+public class FileMapStorageProvider implements MapStorageProvider {\n+\n+ public FileMapStorageProvider() {\n+ }\n+\n+ @Override\n+ public <V extends AbstractEntity, M> MapStorage<V, M> getStorage(Class<M> modelType, MapStorageProviderFactory.Flag... flags) {\n+ return null;\n+ }\n+\n+ @Override\n+ public void close() {\n+ }\n+}\n"
},
{
"change_type": "ADD",
"old_path": null,
"new_path": "model/map-file/src/main/java/org/keycloak/models/map/storage/file/FileMapStorageProviderFactory.java",
"diff": "+/*\n+ * Copyright 2022 Red Hat, Inc. and/or its affiliates\n+ * and other contributors as indicated by the @author tags.\n+ *\n+ * Licensed under the Apache License, Version 2.0 (the \"License\");\n+ * you may not use this file except in compliance with the License.\n+ * You may obtain a copy of the License at\n+ *\n+ * http://www.apache.org/licenses/LICENSE-2.0\n+ *\n+ * Unless required by applicable law or agreed to in writing, software\n+ * distributed under the License is distributed on an \"AS IS\" BASIS,\n+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n+ * See the License for the specific language governing permissions and\n+ * limitations under the License.\n+ */\n+package org.keycloak.models.map.storage.file;\n+\n+import org.keycloak.Config;\n+import org.keycloak.common.Profile;\n+import org.keycloak.component.AmphibianProviderFactory;\n+import org.keycloak.models.KeycloakSession;\n+import org.keycloak.models.KeycloakSessionFactory;\n+import org.keycloak.models.map.storage.MapStorageProvider;\n+import org.keycloak.models.map.storage.MapStorageProviderFactory;\n+import org.keycloak.provider.EnvironmentDependentProviderFactory;\n+\n+/**\n+ * A {@link MapStorageProviderFactory} that creates file-based {@link MapStorageProvider}s.\n+ *\n+ * @author <a href=\"mailto:sguilhen@redhat.com\">Stefan Guilhen</a>\n+ */\n+public class FileMapStorageProviderFactory implements AmphibianProviderFactory<MapStorageProvider>,\n+ MapStorageProviderFactory,\n+ EnvironmentDependentProviderFactory {\n+\n+ public static final String PROVIDER_ID = \"file\";\n+ private Config.Scope config;\n+\n+ @Override\n+ public MapStorageProvider create(KeycloakSession session) {\n+ return new FileMapStorageProvider();\n+ }\n+\n+ @Override\n+ public String getHelpText() {\n+ return \"File Map Storage\";\n+ }\n+\n+ @Override\n+ public boolean isSupported() {\n+ return Profile.isFeatureEnabled(Profile.Feature.MAP_STORAGE);\n+ }\n+\n+ @Override\n+ public void init(Config.Scope config) {\n+ this.config = config;\n+ }\n+\n+ @Override\n+ public void postInit(KeycloakSessionFactory factory) {\n+ }\n+\n+ @Override\n+ public String getId() {\n+ return PROVIDER_ID;\n+ }\n+}\n"
},
{
"change_type": "ADD",
"old_path": null,
"new_path": "model/map-file/src/main/resources/META-INF/services/org.keycloak.models.map.storage.MapStorageProviderFactory",
"diff": "+#\n+# Copyright 2022 Red Hat, Inc. and/or its affiliates\n+# and other contributors as indicated by the @author tags.\n+#\n+# Licensed under the Apache License, Version 2.0 (the \"License\");\n+# you may not use this file except in compliance with the License.\n+# You may obtain a copy of the License at\n+#\n+# http://www.apache.org/licenses/LICENSE-2.0\n+#\n+# Unless required by applicable law or agreed to in writing, software\n+# distributed under the License is distributed on an \"AS IS\" BASIS,\n+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n+# See the License for the specific language governing permissions and\n+# limitations under the License.\n+#\n+\n+org.keycloak.models.map.storage.file.FileMapStorageProviderFactory\n"
},
{
"change_type": "MODIFY",
"old_path": "model/pom.xml",
"new_path": "model/pom.xml",
"diff": "<module>build-processor</module>\n<module>map-hot-rod</module>\n<module>map-ldap</module>\n+ <module>map-file</module>\n</modules>\n</project>\n"
},
{
"change_type": "MODIFY",
"old_path": "pom.xml",
"new_path": "pom.xml",
"diff": "<artifactId>keycloak-model-map-hot-rod</artifactId>\n<version>${project.version}</version>\n</dependency>\n+ <dependency>\n+ <groupId>org.keycloak</groupId>\n+ <artifactId>keycloak-model-map-file</artifactId>\n+ <version>${project.version}</version>\n+ </dependency>\n<dependency>\n<groupId>org.keycloak</groupId>\n<artifactId>launcher</artifactId>\n"
},
{
"change_type": "MODIFY",
"old_path": "quarkus/runtime/pom.xml",
"new_path": "quarkus/runtime/pom.xml",
"diff": "</exclusion>\n</exclusions>\n</dependency>\n+ <dependency>\n+ <groupId>org.keycloak</groupId>\n+ <artifactId>keycloak-model-map-file</artifactId>\n+ <exclusions>\n+ <exclusion>\n+ <groupId>*</groupId>\n+ <artifactId>*</artifactId>\n+ </exclusion>\n+ </exclusions>\n+ </dependency>\n<!-- Keycloak Dependencies-->\n<dependency>\n"
}
] | Java | Apache License 2.0 | keycloak/keycloak | Create map-file module with empty implementations
Closes #15706 |
339,185 | 30.11.2022 12:40:26 | -3,600 | 60ce949304edee9762d2f01a8a48c99b2fad6d50 | Ignore unknown clients in LDAP role mapper
Fixes: | [
{
"change_type": "MODIFY",
"old_path": "federation/ldap/src/main/java/org/keycloak/storage/ldap/mappers/membership/role/RoleLDAPStorageMapper.java",
"new_path": "federation/ldap/src/main/java/org/keycloak/storage/ldap/mappers/membership/role/RoleLDAPStorageMapper.java",
"diff": "@@ -92,10 +92,15 @@ public class RoleLDAPStorageMapper extends AbstractLDAPStorageMapper implements\n// Import role mappings from LDAP into Keycloak DB\nString roleNameAttr = config.getRoleNameLdapAttribute();\n- for (LDAPObject ldapRole : ldapRoles) {\n- String roleName = ldapRole.getAttributeAsString(roleNameAttr);\nRoleContainerModel roleContainer = getTargetRoleContainer(realm);\n+ if (roleContainer == null) {\n+ logger.warnf(\"Ignored client role grant for federation mapper '%s' as client not found: '%s'\", mapperModel.getName(), config.getClientId());\n+ return;\n+ }\n+\n+ for (LDAPObject ldapRole : ldapRoles) {\n+ String roleName = ldapRole.getAttributeAsString(roleNameAttr);\nRoleModel role = roleContainer.getRole(roleName);\nif (role == null) {\n@@ -127,11 +132,16 @@ public class RoleLDAPStorageMapper extends AbstractLDAPStorageMapper implements\nlogger.debugf(\"Syncing roles from LDAP into Keycloak DB. Mapper is [%s], LDAP provider is [%s]\", mapperModel.getName(), ldapProvider.getModel().getName());\n+ RoleContainerModel roleContainer = getTargetRoleContainer(realm);\n+ if (roleContainer == null) {\n+ logger.warnf(\"Ignored sync for federation mapper '%s' as client not found: '%s'\", mapperModel.getName(), config.getClientId());\n+ return syncResult;\n+ }\n+\n// Send LDAP query to load all roles\ntry (LDAPQuery ldapRoleQuery = createRoleQuery(false)) {\nList<LDAPObject> ldapRoles = LDAPUtils.loadAllLDAPObjects(ldapRoleQuery, ldapProvider);\n- RoleContainerModel roleContainer = getTargetRoleContainer(realm);\nString rolesRdnAttr = config.getRoleNameLdapAttribute();\nfor (LDAPObject ldapRole : ldapRoles) {\nString roleName = ldapRole.getAttributeAsString(rolesRdnAttr);\n@@ -169,6 +179,12 @@ public class RoleLDAPStorageMapper extends AbstractLDAPStorageMapper implements\nlogger.debugf(\"Syncing roles from Keycloak into LDAP. Mapper is [%s], LDAP provider is [%s]\", mapperModel.getName(), ldapProvider.getModel().getName());\n+ RoleContainerModel roleContainer = getTargetRoleContainer(realm);\n+ if (roleContainer == null) {\n+ logger.warnf(\"Ignored sync for federation mapper '%s' as client not found: '%s'\", mapperModel.getName(), config.getClientId());\n+ return syncResult;\n+ }\n+\n// Send LDAP query to see which roles exists there\ntry (LDAPQuery ldapQuery = createRoleQuery(false)) {\nList<LDAPObject> ldapRoles = LDAPUtils.loadAllLDAPObjects(ldapQuery, ldapProvider);\n@@ -181,7 +197,6 @@ public class RoleLDAPStorageMapper extends AbstractLDAPStorageMapper implements\n}\n- RoleContainerModel roleContainer = getTargetRoleContainer(realm);\nStream<RoleModel> keycloakRoles = roleContainer.getRolesStream();\nConsumer<String> syncRoleFromKCToLDAP = roleName -> {\n@@ -242,7 +257,7 @@ public class RoleLDAPStorageMapper extends AbstractLDAPStorageMapper implements\n}\nClientModel client = realm.getClientByClientId(clientId);\nif (client == null) {\n- throw new ModelException(\"Can't found requested client with clientId: \" + clientId);\n+ logger.warnf(\"Cannot find requested client with clientId '%s' in federation mapper '%s'\", clientId, mapperModel.getName());\n}\nreturn client;\n}\n@@ -296,8 +311,12 @@ public class RoleLDAPStorageMapper extends AbstractLDAPStorageMapper implements\n// For IMPORT mode, all operations are performed against local DB\nif (mode == LDAPGroupMapperMode.IMPORT) {\nreturn delegate;\n+ }\n+ final RoleContainerModel targetRoleContainer = getTargetRoleContainer(realm);\n+ if (targetRoleContainer == null) {\n+ return delegate;\n} else {\n- return new LDAPRoleMappingsUserDelegate(realm, delegate, ldapUser);\n+ return new LDAPRoleMappingsUserDelegate(realm, delegate, ldapUser, targetRoleContainer);\n}\n}\n@@ -324,11 +343,11 @@ public class RoleLDAPStorageMapper extends AbstractLDAPStorageMapper implements\n// Avoid loading role mappings from LDAP more times per-request\nprivate Set<RoleModel> cachedLDAPRoleMappings;\n- public LDAPRoleMappingsUserDelegate(RealmModel realm, UserModel user, LDAPObject ldapUser) {\n+ public LDAPRoleMappingsUserDelegate(RealmModel realm, UserModel user, LDAPObject ldapUser, RoleContainerModel targetRoleContainer) {\nsuper(user);\nthis.realm = realm;\nthis.ldapUser = ldapUser;\n- this.roleContainer = getTargetRoleContainer(realm);\n+ this.roleContainer = targetRoleContainer;\n}\n@Override\n"
},
{
"change_type": "MODIFY",
"old_path": "testsuite/integration-arquillian/tests/base/src/test/java/org/keycloak/testsuite/federation/ldap/LDAPRoleMapperTest.java",
"new_path": "testsuite/integration-arquillian/tests/base/src/test/java/org/keycloak/testsuite/federation/ldap/LDAPRoleMapperTest.java",
"diff": "@@ -33,6 +33,9 @@ import org.keycloak.storage.ldap.mappers.membership.role.RoleMapperConfig;\nimport org.keycloak.testsuite.util.LDAPRule;\nimport org.keycloak.testsuite.util.LDAPTestUtils;\n+import static org.hamcrest.MatcherAssert.assertThat;\n+import static org.hamcrest.Matchers.nullValue;\n+\n/**\n*\n* @author rmartinc\n@@ -62,29 +65,29 @@ public class LDAPRoleMapperTest extends AbstractLDAPTest {\n// check users\nUserModel john = session.users().getUserByUsername(appRealm, \"johnkeycloak\");\nAssert.assertNotNull(john);\n- Assert.assertThat(john.getRealmRoleMappingsStream().map(RoleModel::getName).collect(Collectors.toSet()), Matchers.containsInAnyOrder(\"group1\", \"group2\"));\n+ assertThat(john.getRealmRoleMappingsStream().map(RoleModel::getName).collect(Collectors.toSet()), Matchers.containsInAnyOrder(\"group1\", \"group2\"));\nUserModel mary = session.users().getUserByUsername(appRealm, \"marykeycloak\");\nAssert.assertNotNull(mary);\n- Assert.assertThat(mary.getRealmRoleMappingsStream().map(RoleModel::getName).collect(Collectors.toSet()), Matchers.containsInAnyOrder(\"group1\", \"group2\"));\n+ assertThat(mary.getRealmRoleMappingsStream().map(RoleModel::getName).collect(Collectors.toSet()), Matchers.containsInAnyOrder(\"group1\", \"group2\"));\nUserModel rob = session.users().getUserByUsername(appRealm, \"robkeycloak\");\nAssert.assertNotNull(rob);\n- Assert.assertThat(rob.getRealmRoleMappingsStream().map(RoleModel::getName).collect(Collectors.toSet()), Matchers.containsInAnyOrder(\"group1\"));\n+ assertThat(rob.getRealmRoleMappingsStream().map(RoleModel::getName).collect(Collectors.toSet()), Matchers.containsInAnyOrder(\"group1\"));\nUserModel james = session.users().getUserByUsername(appRealm, \"jameskeycloak\");\nAssert.assertNotNull(james);\n- Assert.assertThat(james.getRealmRoleMappingsStream().collect(Collectors.toSet()), Matchers.empty());\n+ assertThat(james.getRealmRoleMappingsStream().collect(Collectors.toSet()), Matchers.empty());\n// check groups\nRoleModel group1 = appRealm.getRole(\"group1\");\nAssert.assertNotNull(group1);\n- Assert.assertThat(session.users().getRoleMembersStream(appRealm, group1).map(UserModel::getUsername).collect(Collectors.toSet()),\n+ assertThat(session.users().getRoleMembersStream(appRealm, group1).map(UserModel::getUsername).collect(Collectors.toSet()),\nMatchers.containsInAnyOrder(\"johnkeycloak\", \"marykeycloak\", \"robkeycloak\"));\nRoleModel group2 = appRealm.getRole(\"group2\");\nAssert.assertNotNull(group2);\n- Assert.assertThat(session.users().getRoleMembersStream(appRealm, group2).map(UserModel::getUsername).collect(Collectors.toSet()),\n+ assertThat(session.users().getRoleMembersStream(appRealm, group2).map(UserModel::getUsername).collect(Collectors.toSet()),\nMatchers.containsInAnyOrder(\"johnkeycloak\", \"marykeycloak\"));\nRoleModel group3 = appRealm.getRole(\"group3\");\nAssert.assertNotNull(group3);\n- Assert.assertThat(session.users().getRoleMembersStream(appRealm, group3).collect(Collectors.toSet()), Matchers.empty());\n+ assertThat(session.users().getRoleMembersStream(appRealm, group3).collect(Collectors.toSet()), Matchers.empty());\n});\n}\n@@ -110,29 +113,77 @@ public class LDAPRoleMapperTest extends AbstractLDAPTest {\n// check users\nUserModel john = session.users().getUserByUsername(appRealm, \"johnkeycloak\");\nAssert.assertNotNull(john);\n- Assert.assertThat(john.getClientRoleMappingsStream(rolesClient).map(RoleModel::getName).collect(Collectors.toSet()), Matchers.containsInAnyOrder(\"group1\", \"group2\"));\n+ assertThat(john.getClientRoleMappingsStream(rolesClient).map(RoleModel::getName).collect(Collectors.toSet()), Matchers.containsInAnyOrder(\"group1\", \"group2\"));\nUserModel mary = session.users().getUserByUsername(appRealm, \"marykeycloak\");\nAssert.assertNotNull(mary);\n- Assert.assertThat(mary.getClientRoleMappingsStream(rolesClient).map(RoleModel::getName).collect(Collectors.toSet()), Matchers.containsInAnyOrder(\"group1\", \"group2\"));\n+ assertThat(mary.getClientRoleMappingsStream(rolesClient).map(RoleModel::getName).collect(Collectors.toSet()), Matchers.containsInAnyOrder(\"group1\", \"group2\"));\nUserModel rob = session.users().getUserByUsername(appRealm, \"robkeycloak\");\nAssert.assertNotNull(rob);\n- Assert.assertThat(rob.getClientRoleMappingsStream(rolesClient).map(RoleModel::getName).collect(Collectors.toSet()), Matchers.containsInAnyOrder(\"group1\"));\n+ assertThat(rob.getClientRoleMappingsStream(rolesClient).map(RoleModel::getName).collect(Collectors.toSet()), Matchers.containsInAnyOrder(\"group1\"));\nUserModel james = session.users().getUserByUsername(appRealm, \"jameskeycloak\");\nAssert.assertNotNull(james);\n- Assert.assertThat(james.getClientRoleMappingsStream(rolesClient).map(RoleModel::getName).collect(Collectors.toSet()), Matchers.empty());\n+ assertThat(james.getClientRoleMappingsStream(rolesClient).map(RoleModel::getName).collect(Collectors.toSet()), Matchers.empty());\n// check groups\nRoleModel group1 = rolesClient.getRole(\"group1\");\nAssert.assertNotNull(group1);\n- Assert.assertThat(session.users().getRoleMembersStream(appRealm, group1).map(UserModel::getUsername).collect(Collectors.toSet()),\n+ assertThat(session.users().getRoleMembersStream(appRealm, group1).map(UserModel::getUsername).collect(Collectors.toSet()),\nMatchers.containsInAnyOrder(\"johnkeycloak\", \"marykeycloak\", \"robkeycloak\"));\nRoleModel group2 = rolesClient.getRole(\"group2\");\nAssert.assertNotNull(group2);\n- Assert.assertThat(session.users().getRoleMembersStream(appRealm, group2).map(UserModel::getUsername).collect(Collectors.toSet()),\n+ assertThat(session.users().getRoleMembersStream(appRealm, group2).map(UserModel::getUsername).collect(Collectors.toSet()),\nMatchers.containsInAnyOrder(\"johnkeycloak\", \"marykeycloak\"));\nRoleModel group3 = rolesClient.getRole(\"group3\");\nAssert.assertNotNull(group3);\n- Assert.assertThat(session.users().getRoleMembersStream(appRealm, group3).collect(Collectors.toSet()), Matchers.empty());\n+ assertThat(session.users().getRoleMembersStream(appRealm, group3).collect(Collectors.toSet()), Matchers.empty());\n+\n+ } finally {\n+ appRealm.removeClient(rolesClient.getId());\n+ }\n+ });\n+ }\n+\n+ @Test\n+ public void test03RoleMapperClientRoles() {\n+ testingClient.server().run(session -> {\n+ LDAPTestContext ctx = LDAPTestContext.init(session);\n+ RealmModel appRealm = ctx.getRealm();\n+\n+ // create a client to set the roles in it\n+ ClientModel rolesClient = session.clients().addClient(appRealm, \"role-mapper-client\");\n+ final String clientId = rolesClient.getClientId();\n+\n+ try {\n+ ComponentModel mapperModel = LDAPTestUtils.getSubcomponentByName(appRealm, ctx.getLdapModel(), \"rolesMapper\");\n+ LDAPTestUtils.updateGroupMapperConfigOptions(mapperModel,\n+ RoleMapperConfig.USE_REALM_ROLES_MAPPING, \"false\",\n+ RoleMapperConfig.CLIENT_ID, clientId);\n+ appRealm.updateComponent(mapperModel);\n+\n+ rolesClient.setClientId(clientId + \"-suffix\");\n+ rolesClient.updateClient();\n+\n+ // synch to the client to create the roles at the client\n+ new RoleLDAPStorageMapperFactory().create(session, mapperModel).syncDataFromFederationProviderToKeycloak(appRealm);\n+\n+ // check users\n+ UserModel john = session.users().getUserByUsername(appRealm, \"johnkeycloak\");\n+ Assert.assertNotNull(john);\n+ assertThat(john.getClientRoleMappingsStream(rolesClient).map(RoleModel::getName).collect(Collectors.toSet()), Matchers.empty());\n+ UserModel mary = session.users().getUserByUsername(appRealm, \"marykeycloak\");\n+ Assert.assertNotNull(mary);\n+ assertThat(mary.getClientRoleMappingsStream(rolesClient).map(RoleModel::getName).collect(Collectors.toSet()), Matchers.empty());\n+ UserModel rob = session.users().getUserByUsername(appRealm, \"robkeycloak\");\n+ Assert.assertNotNull(rob);\n+ assertThat(rob.getClientRoleMappingsStream(rolesClient).map(RoleModel::getName).collect(Collectors.toSet()), Matchers.empty());\n+ UserModel james = session.users().getUserByUsername(appRealm, \"jameskeycloak\");\n+ Assert.assertNotNull(james);\n+ assertThat(james.getClientRoleMappingsStream(rolesClient).map(RoleModel::getName).collect(Collectors.toSet()), Matchers.empty());\n+\n+ // check groups\n+ assertThat(rolesClient.getRole(\"group1\"), nullValue());\n+ assertThat(rolesClient.getRole(\"group2\"), nullValue());\n+ assertThat(rolesClient.getRole(\"group3\"), nullValue());\n} finally {\nappRealm.removeClient(rolesClient.getId());\n"
}
] | Java | Apache License 2.0 | keycloak/keycloak | Ignore unknown clients in LDAP role mapper
Fixes: #10958 |
339,487 | 30.11.2022 10:15:04 | 10,800 | 3a9e0513012aaaa574280ed141525fa946ce73a0 | Add debug log messages to KeycloakModelUtils.runJobInRetriableTransaction
Closes | [
{
"change_type": "MODIFY",
"old_path": "server-spi-private/src/main/java/org/keycloak/models/utils/KeycloakModelUtils.java",
"new_path": "server-spi-private/src/main/java/org/keycloak/models/utils/KeycloakModelUtils.java",
"diff": "package org.keycloak.models.utils;\n+import org.jboss.logging.Logger;\nimport org.keycloak.Config;\nimport org.keycloak.Config.Scope;\nimport org.keycloak.broker.social.SocialIdentityProvider;\n@@ -90,6 +91,8 @@ import static org.keycloak.models.Constants.REALM_ATTR_USERNAME_CASE_SENSITIVE_D\n*/\npublic final class KeycloakModelUtils {\n+ private static final Logger logger = Logger.getLogger(KeycloakModelUtils.class);\n+\npublic static final String AUTH_TYPE_CLIENT_SECRET = \"client-secret\";\npublic static final String AUTH_TYPE_CLIENT_SECRET_JWT = \"client-secret-jwt\";\n@@ -325,6 +328,7 @@ public final class KeycloakModelUtils {\nif (isExceptionRetriable(re) && ++retryCount < attemptsCount) {\nint delay = Math.min(retryIntervalMillis * attemptsCount, (1 << retryCount) * retryIntervalMillis)\n+ rand.nextInt(retryIntervalMillis);\n+ logger.debugf(\"Caught retriable exception, retrying request. Retry count = %s, retry delay = %s\", retryCount, delay);\ntry {\nThread.sleep(delay);\n} catch (InterruptedException ie) {\n@@ -332,6 +336,9 @@ public final class KeycloakModelUtils {\nthrow new RuntimeException(ie);\n}\n} else {\n+ if (retryCount == attemptsCount) {\n+ logger.debug(\"Exhausted all retry attempts for request.\");\n+ }\nthrow re;\n}\n} finally {\n"
}
] | Java | Apache License 2.0 | keycloak/keycloak | Add debug log messages to KeycloakModelUtils.runJobInRetriableTransaction
Closes #15749 |
339,364 | 02.12.2022 10:46:36 | -3,600 | 7a0ad6ff21c508524fb562b97405480547259c7d | Handle `null` in HttpRequestImpl | [
{
"change_type": "MODIFY",
"old_path": "services/src/main/java/org/keycloak/services/HttpRequestImpl.java",
"new_path": "services/src/main/java/org/keycloak/services/HttpRequestImpl.java",
"diff": "package org.keycloak.services;\n-import java.security.cert.X509Certificate;\n+import org.keycloak.http.HttpRequest;\n+\nimport javax.ws.rs.core.HttpHeaders;\nimport javax.ws.rs.core.MultivaluedMap;\nimport javax.ws.rs.core.UriInfo;\n-import org.keycloak.http.HttpRequest;\n+import java.security.cert.X509Certificate;\npublic class HttpRequestImpl implements HttpRequest {\nprivate org.jboss.resteasy.spi.HttpRequest delegate;\n- public <R> HttpRequestImpl(org.jboss.resteasy.spi.HttpRequest delegate) {\n+ public HttpRequestImpl(org.jboss.resteasy.spi.HttpRequest delegate) {\nthis.delegate = delegate;\n}\n@Override\npublic String getHttpMethod() {\n+ if (delegate == null) {\n+ return null;\n+ }\nreturn delegate.getHttpMethod();\n}\n@Override\npublic MultivaluedMap<String, String> getDecodedFormParameters() {\n+ if (delegate == null) {\n+ return null;\n+ }\nreturn delegate.getDecodedFormParameters();\n}\n@Override\npublic HttpHeaders getHttpHeaders() {\n+ if (delegate == null) {\n+ return null;\n+ }\nreturn delegate.getHttpHeaders();\n}\n@Override\npublic X509Certificate[] getClientCertificateChain() {\n+ if (delegate == null) {\n+ return null;\n+ }\nreturn (X509Certificate[]) delegate.getAttribute(\"javax.servlet.request.X509Certificate\");\n}\n@Override\npublic UriInfo getUri() {\n+ if (delegate == null) {\n+ return null;\n+ }\nreturn delegate.getUri();\n}\n}\n"
}
] | Java | Apache License 2.0 | keycloak/keycloak | Handle `null` in HttpRequestImpl |
339,448 | 30.11.2022 13:35:24 | -3,600 | b7d72687442be3c5ba0f6fcc04b1c2c9e2b13e36 | Initialize CryptoIntegration before loading adapter config
Initialize CryptoIntegration before building KeycloakDeploymentBuilder, same way as in public static KeycloakDeployment build(InputStream is) method
Closes | [
{
"change_type": "MODIFY",
"old_path": "adapters/oidc/adapter-core/src/main/java/org/keycloak/adapters/KeycloakDeploymentBuilder.java",
"new_path": "adapters/oidc/adapter-core/src/main/java/org/keycloak/adapters/KeycloakDeploymentBuilder.java",
"diff": "@@ -201,6 +201,7 @@ public class KeycloakDeploymentBuilder {\npublic static KeycloakDeployment build(AdapterConfig adapterConfig) {\n+ CryptoIntegration.init(KeycloakDeploymentBuilder.class.getClassLoader());\nreturn new KeycloakDeploymentBuilder().internalBuild(adapterConfig);\n}\n"
}
] | Java | Apache License 2.0 | keycloak/keycloak | Initialize CryptoIntegration before loading adapter config
Initialize CryptoIntegration before building KeycloakDeploymentBuilder, same way as in public static KeycloakDeployment build(InputStream is) method
Closes #15767 |
339,269 | 31.10.2022 17:09:06 | -3,600 | 3c6e2c3c1e291370c3df672c4651ec0ec2df4a1e | 15234 switch to micrometer metrics | [
{
"change_type": "MODIFY",
"old_path": "quarkus/deployment/pom.xml",
"new_path": "quarkus/deployment/pom.xml",
"diff": "</dependency>\n<dependency>\n<groupId>io.quarkus</groupId>\n- <artifactId>quarkus-smallrye-metrics-deployment</artifactId>\n+ <artifactId>quarkus-micrometer-deployment</artifactId>\n+ </dependency>\n+ <dependency>\n+ <groupId>io.quarkus</groupId>\n+ <artifactId>quarkus-micrometer-registry-prometheus-deployment</artifactId>\n</dependency>\n<dependency>\n<groupId>io.quarkus</groupId>\n"
},
{
"change_type": "MODIFY",
"old_path": "quarkus/runtime/pom.xml",
"new_path": "quarkus/runtime/pom.xml",
"diff": "</dependency>\n<dependency>\n<groupId>io.quarkus</groupId>\n- <artifactId>quarkus-smallrye-metrics</artifactId>\n+ <artifactId>quarkus-micrometer</artifactId>\n+ </dependency>\n+ <dependency>\n+ <groupId>io.quarkus</groupId>\n+ <artifactId>quarkus-micrometer-registry-prometheus</artifactId>\n</dependency>\n<dependency>\n<groupId>io.quarkus</groupId>\n"
},
{
"change_type": "MODIFY",
"old_path": "quarkus/runtime/src/main/java/org/keycloak/quarkus/runtime/KeycloakRecorder.java",
"new_path": "quarkus/runtime/src/main/java/org/keycloak/quarkus/runtime/KeycloakRecorder.java",
"diff": "@@ -33,8 +33,6 @@ import liquibase.Scope;\nimport org.hibernate.cfg.AvailableSettings;\nimport org.infinispan.manager.DefaultCacheManager;\n-import io.quarkus.smallrye.metrics.runtime.SmallRyeMetricsHandler;\n-import io.vertx.core.Handler;\nimport io.vertx.ext.web.RoutingContext;\nimport org.keycloak.Config;\n@@ -116,12 +114,6 @@ public class KeycloakRecorder {\n});\n}\n- public Handler<RoutingContext> createMetricsHandler(String path) {\n- SmallRyeMetricsHandler metricsHandler = new SmallRyeMetricsHandler();\n- metricsHandler.setMetricsPath(path);\n- return metricsHandler;\n- }\n-\npublic HibernateOrmIntegrationRuntimeInitListener createUserDefinedUnitListener(String name) {\nreturn new HibernateOrmIntegrationRuntimeInitListener() {\n@Override\n"
},
{
"change_type": "MODIFY",
"old_path": "quarkus/runtime/src/main/java/org/keycloak/quarkus/runtime/configuration/mappers/MetricsPropertyMappers.java",
"new_path": "quarkus/runtime/src/main/java/org/keycloak/quarkus/runtime/configuration/mappers/MetricsPropertyMappers.java",
"diff": "@@ -12,7 +12,7 @@ final class MetricsPropertyMappers {\npublic static PropertyMapper[] getMetricsPropertyMappers() {\nreturn new PropertyMapper[] {\nfromOption(MetricsOptions.METRICS_ENABLED)\n- .to(\"quarkus.smallrye-metrics.extensions.enabled\")\n+ .to(\"quarkus.micrometer.enabled\")\n.paramLabel(Boolean.TRUE + \"|\" + Boolean.FALSE)\n.build()\n};\n"
},
{
"change_type": "MODIFY",
"old_path": "quarkus/runtime/src/main/resources/application.properties",
"new_path": "quarkus/runtime/src/main/resources/application.properties",
"diff": "@@ -10,7 +10,7 @@ quarkus.health.extensions.enabled=false\nquarkus.datasource.health.enabled=false\n# Enables metrics from other extensions if metrics is enabled\n-quarkus.datasource.metrics.enabled=${quarkus.smallrye-metrics.extensions.enabled}\n+quarkus.datasource.metrics.enabled=${quarkus.micrometer.enabled}\n# Default transaction timeout\nquarkus.transaction-manager.default-transaction-timeout=300\n"
},
{
"change_type": "MODIFY",
"old_path": "quarkus/tests/integration/src/test/java/org/keycloak/it/cli/dist/MetricsDistTest.java",
"new_path": "quarkus/tests/integration/src/test/java/org/keycloak/it/cli/dist/MetricsDistTest.java",
"diff": "@@ -46,7 +46,7 @@ public class MetricsDistTest {\nvoid testMetricsEndpoint() {\nwhen().get(\"/metrics\").then()\n.statusCode(200)\n- .body(containsString(\"base_gc_total\"));\n+ .body(containsString(\"jvm_gc_\"));\n}\n@Test\n@@ -54,7 +54,7 @@ public class MetricsDistTest {\nvoid testMetricsEndpointUsingRelativePath() {\nwhen().get(\"/auth/metrics\").then()\n.statusCode(200)\n- .body(containsString(\"base_gc_total\"));\n+ .body(containsString(\"jvm_gc_\"));\n}\n@Test\n"
},
{
"change_type": "MODIFY",
"old_path": "quarkus/tests/integration/src/test/java/org/keycloak/it/cli/dist/QuarkusPropertiesAutoBuildDistTest.java",
"new_path": "quarkus/tests/integration/src/test/java/org/keycloak/it/cli/dist/QuarkusPropertiesAutoBuildDistTest.java",
"diff": "@@ -167,7 +167,7 @@ public class QuarkusPropertiesAutoBuildDistTest {\n@Override\npublic void accept(KeycloakDistribution distribution) {\ndistribution.setManualStop(true);\n- distribution.setQuarkusProperty(\"quarkus.smallrye-metrics.extensions.enabled\",\"true\");\n+ distribution.setQuarkusProperty(\"quarkus.micrometer.enabled\",\"true\");\n}\n}\n}\n\\ No newline at end of file\n"
},
{
"change_type": "MODIFY",
"old_path": "quarkus/tests/integration/src/test/java/org/keycloak/it/cli/dist/QuarkusPropertiesDistTest.java",
"new_path": "quarkus/tests/integration/src/test/java/org/keycloak/it/cli/dist/QuarkusPropertiesDistTest.java",
"diff": "@@ -126,7 +126,7 @@ public class QuarkusPropertiesDistTest {\nCLIResult cliResult = (CLIResult) result;\ncliResult.assertNoBuild();\nwhen().get(\"/metrics\").then().statusCode(200)\n- .body(containsString(\"vendor_hibernate_cache_query_plan_total\"));\n+ .body(containsString(\"jvm_gc_\"));\n}\npublic static class UpdateConsoleLogLevelToWarnFromQuarkusProps implements Consumer<KeycloakDistribution> {\n"
}
] | Java | Apache License 2.0 | keycloak/keycloak | 15234 switch to micrometer metrics |
339,179 | 05.12.2022 13:16:04 | -3,600 | 59ccae76cbff6ffef6cc8286b557d6fea93a2aa4 | Fix flaky JS test
Closes | [
{
"change_type": "MODIFY",
"old_path": "testsuite/integration-arquillian/tests/base/src/main/java/org/keycloak/testsuite/updaters/RealmAttributeUpdater.java",
"new_path": "testsuite/integration-arquillian/tests/base/src/main/java/org/keycloak/testsuite/updaters/RealmAttributeUpdater.java",
"diff": "@@ -69,6 +69,11 @@ public class RealmAttributeUpdater extends ServerResourceUpdater<RealmAttributeU\nreturn this;\n}\n+ public RealmAttributeUpdater setAccessTokenLifespanForImplicitFlow(Integer lifespan) {\n+ rep.setAccessTokenLifespanForImplicitFlow(lifespan);\n+ return this;\n+ }\n+\npublic RealmAttributeUpdater setRememberMe(Boolean rememberMe) {\nrep.setRememberMe(rememberMe);\nreturn this;\n"
},
{
"change_type": "MODIFY",
"old_path": "testsuite/integration-arquillian/tests/base/src/test/java/org/keycloak/testsuite/javascript/JavascriptAdapterTest.java",
"new_path": "testsuite/integration-arquillian/tests/base/src/test/java/org/keycloak/testsuite/javascript/JavascriptAdapterTest.java",
"diff": "@@ -27,6 +27,7 @@ import org.keycloak.testsuite.arquillian.annotation.DisableFeature;\nimport org.keycloak.testsuite.auth.page.account.Applications;\nimport org.keycloak.testsuite.auth.page.login.OAuthGrant;\nimport org.keycloak.testsuite.auth.page.login.UpdatePassword;\n+import org.keycloak.testsuite.updaters.RealmAttributeUpdater;\nimport org.keycloak.testsuite.util.JavascriptBrowser;\nimport org.keycloak.testsuite.util.OAuthClient;\nimport org.keycloak.testsuite.util.RealmBuilder;\n@@ -50,16 +51,18 @@ import static java.lang.Math.toIntExact;\nimport static org.hamcrest.CoreMatchers.anyOf;\nimport static org.hamcrest.CoreMatchers.both;\nimport static org.hamcrest.CoreMatchers.containsString;\n+import static org.hamcrest.CoreMatchers.not;\n+import static org.hamcrest.MatcherAssert.assertThat;\nimport static org.hamcrest.Matchers.greaterThan;\nimport static org.hamcrest.Matchers.is;\nimport static org.hamcrest.Matchers.lessThan;\nimport static org.hamcrest.collection.IsMapContaining.hasEntry;\nimport static org.junit.Assert.assertEquals;\n-import static org.junit.Assert.assertThat;\nimport static org.junit.Assert.assertTrue;\nimport static org.keycloak.testsuite.util.ServerURLs.AUTH_SERVER_HOST;\nimport static org.keycloak.testsuite.util.URLAssert.assertCurrentUrlDoesntStartWith;\nimport static org.keycloak.testsuite.util.URLAssert.assertCurrentUrlStartsWith;\n+import static org.keycloak.testsuite.util.WaitUtils.pause;\nimport static org.keycloak.testsuite.util.WaitUtils.waitForPageToLoad;\nimport static org.keycloak.testsuite.util.WaitUtils.waitUntilElement;\n@@ -386,21 +389,23 @@ public class JavascriptAdapterTest extends AbstractJavascriptTest {\n@Test\npublic void implicitFlowOnTokenExpireTest() {\n- RealmRepresentation realm = adminClient.realms().realm(REALM_NAME).toRepresentation();\n- Integer storeAccesTokenLifespan = realm.getAccessTokenLifespanForImplicitFlow();\n- try {\n- realm.setAccessTokenLifespanForImplicitFlow(5);\n- adminClient.realms().realm(REALM_NAME).update(realm);\n-\n+ try (RealmAttributeUpdater rau = new RealmAttributeUpdater(adminClient.realms().realm(REALM_NAME))\n+ .setAccessTokenLifespanForImplicitFlow(3)\n+ .update()\n+ ) {\nsetImplicitFlowForClient();\n- testExecutor.logInAndInit(defaultArguments().implicitFlow(), testUser, this::assertInitAuth)\n- .addTimeSkew(-5); // Move in time instead of wait\n+ testExecutor.init(defaultArguments().implicitFlow());\n+\n+ testExecutor.logInAndInit(defaultArguments().implicitFlow(), testUser, this::assertInitAuth);\n+ assertThat(driver.getPageSource(), not(containsString(\"Access token expired\")));\n+\n+ // Here we can't move in time because we are waiting for onTokenExpired execution which is already\n+ // scheduled by setTimeout method, so we can't make it execute sooner\n+ pause(1000);\nwaitUntilElement(eventsArea).text().contains(\"Access token expired\");\n- } finally {\n- // Get to origin state\n- realm.setAccessTokenLifespanForImplicitFlow(storeAccesTokenLifespan);\n- adminClient.realms().realm(REALM_NAME).update(realm);\n+ } catch (IOException e) {\n+ throw new RuntimeException(e);\n}\n}\n"
}
] | Java | Apache License 2.0 | keycloak/keycloak | Fix flaky JS test (#15804)
Closes #15761
Co-authored-by: Stian Thorgersen <stianst@gmail.com> |
339,465 | 06.12.2022 14:50:07 | -3,600 | f4e91a5312a9952890f20cd6a9ecb7049815420a | The redirect URI cannot be verified during logout in the case when client was removed
closes | [
{
"change_type": "MODIFY",
"old_path": "services/src/main/java/org/keycloak/protocol/oidc/endpoints/LogoutEndpoint.java",
"new_path": "services/src/main/java/org/keycloak/protocol/oidc/endpoints/LogoutEndpoint.java",
"diff": "@@ -238,10 +238,9 @@ public class LogoutEndpoint {\nOIDCAdvancedConfigWrapper wrapper = OIDCAdvancedConfigWrapper.fromClientModel(client);\nSet<String> postLogoutRedirectUris = wrapper.getPostLogoutRedirectUris() != null ? new HashSet(wrapper.getPostLogoutRedirectUris()) : new HashSet<>();\nvalidatedRedirectUri = RedirectUtils.verifyRedirectUri(session, client.getRootUrl(), redirectUri, postLogoutRedirectUris, true);\n- } else if (clientId == null) {\n+ } else if (clientId == null && providerConfig.isLegacyLogoutRedirectUri()) {\n/*\n- * Only call verifyRealmRedirectUri, in case both clientId and client are null - otherwise\n- * the logout uri contains a non-existing client, and we should show an INVALID_REDIRECT_URI error\n+ * Only call verifyRealmRedirectUri against all in the realm, in case when \"Legacy\" switch is enabled and when we don't have a client - usually due both clientId and client are null\n*/\nvalidatedRedirectUri = RedirectUtils.verifyRealmRedirectUri(session, redirectUri);\n}\n"
},
{
"change_type": "MODIFY",
"old_path": "testsuite/integration-arquillian/tests/base/src/test/java/org/keycloak/testsuite/oauth/RPInitiatedLogoutTest.java",
"new_path": "testsuite/integration-arquillian/tests/base/src/test/java/org/keycloak/testsuite/oauth/RPInitiatedLogoutTest.java",
"diff": "@@ -83,6 +83,7 @@ import org.keycloak.testsuite.pages.PageUtils;\nimport org.keycloak.testsuite.updaters.ClientAttributeUpdater;\nimport org.keycloak.testsuite.updaters.RealmAttributeUpdater;\nimport org.keycloak.testsuite.updaters.UserAttributeUpdater;\n+import org.keycloak.testsuite.util.ClientBuilder;\nimport org.keycloak.testsuite.util.ClientManager;\nimport org.keycloak.testsuite.util.InfinispanTestTimeServiceRule;\nimport org.keycloak.testsuite.util.Matchers;\n@@ -1068,6 +1069,33 @@ public class RPInitiatedLogoutTest extends AbstractTestRealmKeycloakTest {\n}\n}\n+ @Test\n+ public void logoutWithIdTokenAndRemovedClient() throws Exception {\n+ ClientRepresentation clientRep = ClientBuilder.create()\n+ .clientId(\"my-foo-client\")\n+ .enabled(true)\n+ .baseUrl(\"https://foo/bar\")\n+ .addRedirectUri(APP_REDIRECT_URI)\n+ .secret(\"password\")\n+ .build();\n+ try (Response response = testRealm().clients().create(clientRep)) {\n+ String uuid = ApiUtil.getCreatedId(response);\n+ oauth.clientId(\"my-foo-client\");\n+\n+ OAuthClient.AccessTokenResponse tokenResponse = loginUser();\n+\n+ // Remove client after login of user\n+ testRealm().clients().get(uuid).remove();\n+\n+ String logoutUrl = oauth.getLogoutUrl().postLogoutRedirectUri(APP_REDIRECT_URI).idTokenHint(tokenResponse.getIdToken()).build();\n+ driver.navigate().to(logoutUrl);\n+\n+ // Invalid redirect URI page is shown. It was not possible to verify post_logout_redirect_uri due the client was removed\n+ errorPage.assertCurrent();\n+ events.expectLogoutError(OAuthErrorException.INVALID_REDIRECT_URI).detail(Details.REDIRECT_URI, APP_REDIRECT_URI).assertEvent();\n+ }\n+ }\n+\n// SUPPORT METHODS\nprivate OAuthClient.AccessTokenResponse loginUser() {\nreturn loginUser(false);\n"
}
] | Java | Apache License 2.0 | keycloak/keycloak | The redirect URI cannot be verified during logout in the case when client was removed
closes #15866 |
339,179 | 29.11.2022 12:55:12 | -3,600 | de7dd77aebe5f81cf108d4e642400feddcbae150 | Change id of TermsAndConditions required actions to uppercase
Closes | [
{
"change_type": "MODIFY",
"old_path": "model/legacy-private/src/main/java/org/keycloak/storage/datastore/LegacyExportImportManager.java",
"new_path": "model/legacy-private/src/main/java/org/keycloak/storage/datastore/LegacyExportImportManager.java",
"diff": "@@ -114,6 +114,7 @@ import java.util.Set;\nimport java.util.function.Function;\nimport java.util.stream.Collectors;\n+import static org.keycloak.models.utils.DefaultRequiredActions.getDefaultRequiredActionCaseInsensitively;\nimport static org.keycloak.models.utils.RepresentationToModel.createCredentials;\nimport static org.keycloak.models.utils.RepresentationToModel.createFederatedIdentities;\nimport static org.keycloak.models.utils.RepresentationToModel.createGroups;\n@@ -869,11 +870,7 @@ public class LegacyExportImportManager implements ExportImportManager {\n}\nif (userRep.getRequiredActions() != null) {\nfor (String requiredAction : userRep.getRequiredActions()) {\n- try {\n- user.addRequiredAction(UserModel.RequiredAction.valueOf(requiredAction.toUpperCase()));\n- } catch (IllegalArgumentException iae) {\n- user.addRequiredAction(requiredAction);\n- }\n+ user.addRequiredAction(getDefaultRequiredActionCaseInsensitively(requiredAction));\n}\n}\ncreateCredentials(userRep, session, newRealm, user, false);\n"
},
{
"change_type": "MODIFY",
"old_path": "model/map/src/main/java/org/keycloak/models/map/datastore/MapExportImportManager.java",
"new_path": "model/map/src/main/java/org/keycloak/models/map/datastore/MapExportImportManager.java",
"diff": "@@ -123,6 +123,7 @@ import java.util.stream.Collectors;\nimport static org.keycloak.models.map.storage.QueryParameters.withCriteria;\nimport static org.keycloak.models.map.storage.criteria.DefaultModelCriteria.criteria;\n+import static org.keycloak.models.utils.DefaultRequiredActions.getDefaultRequiredActionCaseInsensitively;\nimport static org.keycloak.models.utils.RepresentationToModel.createCredentials;\nimport static org.keycloak.models.utils.RepresentationToModel.createFederatedIdentities;\nimport static org.keycloak.models.utils.RepresentationToModel.createGroups;\n@@ -1138,11 +1139,7 @@ public class MapExportImportManager implements ExportImportManager {\n}\nif (userRep.getRequiredActions() != null) {\nfor (String requiredAction : userRep.getRequiredActions()) {\n- try {\n- user.addRequiredAction(UserModel.RequiredAction.valueOf(requiredAction.toUpperCase()));\n- } catch (IllegalArgumentException iae) {\n- user.addRequiredAction(requiredAction);\n- }\n+ user.addRequiredAction(getDefaultRequiredActionCaseInsensitively(requiredAction));\n}\n}\ncreateCredentials(userRep, session, newRealm, user, false);\n"
},
{
"change_type": "MODIFY",
"old_path": "server-spi-private/src/main/java/org/keycloak/models/utils/DefaultRequiredActions.java",
"new_path": "server-spi-private/src/main/java/org/keycloak/models/utils/DefaultRequiredActions.java",
"diff": "@@ -74,7 +74,7 @@ public class DefaultRequiredActions {\nUPDATE_PROFILE(UserModel.RequiredAction.UPDATE_PROFILE.name(), DefaultRequiredActions::addUpdateProfileAction),\nCONFIGURE_TOTP(UserModel.RequiredAction.CONFIGURE_TOTP.name(), DefaultRequiredActions::addConfigureTotpAction),\nUPDATE_PASSWORD(UserModel.RequiredAction.UPDATE_PASSWORD.name(), DefaultRequiredActions::addUpdatePasswordAction),\n- TERMS_AND_CONDITIONS(\"terms_and_conditions\", DefaultRequiredActions::addTermsAndConditionsAction),\n+ TERMS_AND_CONDITIONS(UserModel.RequiredAction.TERMS_AND_CONDITIONS.name(), DefaultRequiredActions::addTermsAndConditionsAction),\nDELETE_ACCOUNT(\"delete_account\", DefaultRequiredActions::addDeleteAccountAction),\nUPDATE_USER_LOCALE(\"update_user_locale\", DefaultRequiredActions::addUpdateLocaleAction),\nUPDATE_EMAIL(UserModel.RequiredAction.UPDATE_EMAIL.name(), DefaultRequiredActions::addUpdateEmailAction, () -> isFeatureEnabled(Profile.Feature.UPDATE_EMAIL)),\n@@ -169,12 +169,12 @@ public class DefaultRequiredActions {\n}\npublic static void addTermsAndConditionsAction(RealmModel realm) {\n- if (realm.getRequiredActionProviderByAlias(\"terms_and_conditions\") == null) {\n+ if (realm.getRequiredActionProviderByAlias(UserModel.RequiredAction.TERMS_AND_CONDITIONS.name()) == null) {\nRequiredActionProviderModel termsAndConditions = new RequiredActionProviderModel();\ntermsAndConditions.setEnabled(false);\n- termsAndConditions.setAlias(\"terms_and_conditions\");\n+ termsAndConditions.setAlias(UserModel.RequiredAction.TERMS_AND_CONDITIONS.name());\ntermsAndConditions.setName(\"Terms and Conditions\");\n- termsAndConditions.setProviderId(\"terms_and_conditions\");\n+ termsAndConditions.setProviderId(UserModel.RequiredAction.TERMS_AND_CONDITIONS.name());\ntermsAndConditions.setDefaultAction(false);\ntermsAndConditions.setPriority(20);\nrealm.addRequiredActionProvider(termsAndConditions);\n@@ -290,4 +290,23 @@ public class DefaultRequiredActions {\nrealm.addRequiredActionProvider(webauthnRegister);\n}\n}\n+\n+ /**\n+ * Checks whether given {@code providerId} case insensitively matches any of {@link UserModel.RequiredAction} enum\n+ * and if yes, it returns the value in correct form.\n+ * <p/>\n+ * This is necessary to stay backward compatible with older deployments where not all provider factories had ids\n+ * in uppercase. This means that storage can contain some values in incorrect letter-case.\n+ *\n+ * @param providerId the required actions providerId\n+ * @return providerId with correct letter-case, or the original value if it doesn't match any\n+ * of {@link UserModel.RequiredAction}\n+ */\n+ public static String getDefaultRequiredActionCaseInsensitively(String providerId) {\n+ try {\n+ return UserModel.RequiredAction.valueOf(providerId.toUpperCase()).name();\n+ } catch (IllegalArgumentException iae) {\n+ return providerId;\n+ }\n+ }\n}\n"
},
{
"change_type": "MODIFY",
"old_path": "server-spi/src/main/java/org/keycloak/models/UserModel.java",
"new_path": "server-spi/src/main/java/org/keycloak/models/UserModel.java",
"diff": "@@ -21,11 +21,8 @@ import org.keycloak.provider.ProviderEvent;\nimport org.keycloak.storage.SearchableModelField;\nimport java.util.Comparator;\n-import java.util.LinkedHashSet;\nimport java.util.List;\nimport java.util.Map;\n-import java.util.Set;\n-import java.util.stream.Collectors;\nimport java.util.stream.Stream;\n/**\n"
},
{
"change_type": "MODIFY",
"old_path": "services/src/main/java/org/keycloak/authentication/actiontoken/execactions/ExecuteActionsActionTokenHandler.java",
"new_path": "services/src/main/java/org/keycloak/authentication/actiontoken/execactions/ExecuteActionsActionTokenHandler.java",
"diff": "@@ -36,6 +36,8 @@ import javax.ws.rs.core.Response;\nimport javax.ws.rs.core.UriBuilder;\nimport javax.ws.rs.core.UriInfo;\n+import static org.keycloak.models.utils.DefaultRequiredActions.getDefaultRequiredActionCaseInsensitively;\n+\n/**\n*\n* @author hmlnarik\n@@ -115,13 +117,13 @@ public class ExecuteActionsActionTokenHandler extends AbstractActionTokenHandler\nKeycloakSessionFactory sessionFactory = tokenContext.getSession().getKeycloakSessionFactory();\nreturn token.getRequiredActions().stream()\n- .map(actionName -> realm.getRequiredActionProviderByAlias(actionName)) // get realm-specific model from action name and filter out irrelevant\n+ .map(realm::getRequiredActionProviderByAlias) // get realm-specific model from action name and filter out irrelevant\n.filter(Objects::nonNull)\n.filter(RequiredActionProviderModel::isEnabled)\n.map(RequiredActionProviderModel::getProviderId) // get provider ID from model\n- .map(providerId -> (RequiredActionFactory) sessionFactory.getProviderFactory(RequiredActionProvider.class, providerId))\n+ .map(providerId -> (RequiredActionFactory) sessionFactory.getProviderFactory(RequiredActionProvider.class, getDefaultRequiredActionCaseInsensitively(providerId)))\n.filter(Objects::nonNull)\n.noneMatch(RequiredActionFactory::isOneTimeAction);\n"
},
{
"change_type": "MODIFY",
"old_path": "services/src/main/java/org/keycloak/authentication/requiredactions/TermsAndConditions.java",
"new_path": "services/src/main/java/org/keycloak/authentication/requiredactions/TermsAndConditions.java",
"diff": "@@ -22,6 +22,7 @@ import org.keycloak.authentication.*;\nimport org.keycloak.common.util.Time;\nimport org.keycloak.models.KeycloakSession;\nimport org.keycloak.models.KeycloakSessionFactory;\n+import org.keycloak.models.UserModel;\nimport javax.ws.rs.core.Response;\nimport java.util.Arrays;\n@@ -31,7 +32,7 @@ import java.util.Arrays;\n* @version $Revision: 1 $\n*/\npublic class TermsAndConditions implements RequiredActionProvider, RequiredActionFactory {\n- public static final String PROVIDER_ID = \"terms_and_conditions\";\n+ public static final String PROVIDER_ID = UserModel.RequiredAction.TERMS_AND_CONDITIONS.name();\npublic static final String USER_ATTRIBUTE = PROVIDER_ID;\n@Override\n"
},
{
"change_type": "MODIFY",
"old_path": "services/src/main/java/org/keycloak/services/managers/AuthenticationManager.java",
"new_path": "services/src/main/java/org/keycloak/services/managers/AuthenticationManager.java",
"diff": "@@ -112,6 +112,7 @@ import java.util.stream.Stream;\nimport static org.keycloak.common.util.ServerCookie.SameSiteAttributeValue;\nimport static org.keycloak.models.UserSessionModel.CORRESPONDING_SESSION_ID;\n+import static org.keycloak.models.utils.DefaultRequiredActions.getDefaultRequiredActionCaseInsensitively;\nimport static org.keycloak.protocol.oidc.grants.device.DeviceGrantType.isOAuth2DeviceVerificationFlow;\nimport static org.keycloak.services.util.CookieHelper.getCookie;\nimport static org.keycloak.utils.LockObjectsForModification.lockUserSessionsForModification;\n@@ -1291,7 +1292,8 @@ public class AuthenticationManager {\nprivate static Response executeAction(KeycloakSession session, AuthenticationSessionModel authSession, RequiredActionProviderModel model,\nHttpRequest request, EventBuilder event, RealmModel realm, UserModel user, boolean kcActionExecution) {\n- RequiredActionFactory factory = (RequiredActionFactory) session.getKeycloakSessionFactory().getProviderFactory(RequiredActionProvider.class, model.getProviderId());\n+ RequiredActionFactory factory = (RequiredActionFactory) session.getKeycloakSessionFactory()\n+ .getProviderFactory(RequiredActionProvider.class, getDefaultRequiredActionCaseInsensitively(model.getProviderId()));\nif (factory == null) {\nthrow new RuntimeException(\"Unable to find factory for Required Action: \" + model.getProviderId() + \" did you forget to declare it in a META-INF/services file?\");\n}\n@@ -1402,7 +1404,7 @@ public class AuthenticationManager {\nprivate static RequiredActionFactory toRequiredActionFactory(KeycloakSession session, RequiredActionProviderModel model, RealmModel realm) {\nRequiredActionFactory factory = (RequiredActionFactory) session.getKeycloakSessionFactory()\n- .getProviderFactory(RequiredActionProvider.class, model.getProviderId());\n+ .getProviderFactory(RequiredActionProvider.class, getDefaultRequiredActionCaseInsensitively(model.getProviderId()));\nif (factory == null) {\nif (!DefaultRequiredActions.isActionAvailable(model)) {\nlogger.warnf(\"Required action provider factory '%s' configured in the realm '%s' is not available. \" +\n"
},
{
"change_type": "MODIFY",
"old_path": "services/src/main/java/org/keycloak/services/resources/LoginActionsService.java",
"new_path": "services/src/main/java/org/keycloak/services/resources/LoginActionsService.java",
"diff": "@@ -102,6 +102,7 @@ import java.net.URI;\nimport java.util.Map;\nimport static org.keycloak.authentication.actiontoken.DefaultActionToken.ACTION_TOKEN_BASIC_CHECKS;\n+import static org.keycloak.models.utils.DefaultRequiredActions.getDefaultRequiredActionCaseInsensitively;\n/**\n* @author <a href=\"mailto:sthorger@redhat.com\">Stian Thorgersen</a>\n@@ -992,7 +993,7 @@ public class LoginActionsService {\nevent.event(EventType.CUSTOM_REQUIRED_ACTION);\nevent.detail(Details.CUSTOM_REQUIRED_ACTION, action);\n- RequiredActionFactory factory = (RequiredActionFactory)session.getKeycloakSessionFactory().getProviderFactory(RequiredActionProvider.class, action);\n+ RequiredActionFactory factory = (RequiredActionFactory)session.getKeycloakSessionFactory().getProviderFactory(RequiredActionProvider.class, getDefaultRequiredActionCaseInsensitively(action));\nif (factory == null) {\nServicesLogger.LOGGER.actionProviderNull();\nevent.error(Errors.INVALID_CODE);\n"
},
{
"change_type": "MODIFY",
"old_path": "testsuite/integration-arquillian/tests/base/src/main/java/org/keycloak/testsuite/auth/page/login/TermsAndConditions.java",
"new_path": "testsuite/integration-arquillian/tests/base/src/main/java/org/keycloak/testsuite/auth/page/login/TermsAndConditions.java",
"diff": "*/\npackage org.keycloak.testsuite.auth.page.login;\n+import org.keycloak.models.UserModel;\nimport org.openqa.selenium.WebElement;\nimport org.openqa.selenium.support.FindBy;\n@@ -38,7 +39,7 @@ public class TermsAndConditions extends RequiredActions {\n@Override\npublic String getActionId() {\n- return \"terms_and_conditions\";\n+ return UserModel.RequiredAction.TERMS_AND_CONDITIONS.name();\n}\npublic void acceptTerms() {\n"
},
{
"change_type": "MODIFY",
"old_path": "testsuite/integration-arquillian/tests/base/src/test/java/org/keycloak/testsuite/actions/RequiredActionPriorityTest.java",
"new_path": "testsuite/integration-arquillian/tests/base/src/test/java/org/keycloak/testsuite/actions/RequiredActionPriorityTest.java",
"diff": "@@ -134,7 +134,7 @@ public class RequiredActionPriorityTest extends AbstractTestRealmKeycloakTest {\n// After Changing the priority, the order will be:\n// UpdatePassword -> UpdateProfile -> TermsAndConditions\ntestRealm().flows().raiseRequiredActionPriority(UserModel.RequiredAction.UPDATE_PASSWORD.name());\n- testRealm().flows().lowerRequiredActionPriority(\"terms_and_conditions\");\n+ testRealm().flows().lowerRequiredActionPriority(UserModel.RequiredAction.TERMS_AND_CONDITIONS.name());\n// Login\nloginPage.open();\n"
},
{
"change_type": "MODIFY",
"old_path": "testsuite/integration-arquillian/tests/base/src/test/java/org/keycloak/testsuite/actions/TermsAndConditionsTest.java",
"new_path": "testsuite/integration-arquillian/tests/base/src/test/java/org/keycloak/testsuite/actions/TermsAndConditionsTest.java",
"diff": "@@ -26,6 +26,7 @@ import org.keycloak.authentication.requiredactions.TermsAndConditions;\nimport org.keycloak.events.Details;\nimport org.keycloak.events.Errors;\nimport org.keycloak.events.EventType;\n+import org.keycloak.models.UserModel;\nimport org.keycloak.representations.idm.RealmRepresentation;\nimport org.keycloak.representations.idm.RequiredActionProviderRepresentation;\nimport org.keycloak.representations.idm.UserRepresentation;\n@@ -72,9 +73,9 @@ public class TermsAndConditionsTest extends AbstractTestRealmKeycloakTest {\nUserBuilder.edit(user).requiredAction(TermsAndConditions.PROVIDER_ID);\nadminClient.realm(\"test\").users().get(user.getId()).update(user);\n- RequiredActionProviderRepresentation rep = adminClient.realm(\"test\").flows().getRequiredAction(\"terms_and_conditions\");\n+ RequiredActionProviderRepresentation rep = adminClient.realm(\"test\").flows().getRequiredAction(UserModel.RequiredAction.TERMS_AND_CONDITIONS.name());\nrep.setEnabled(true);\n- adminClient.realm(\"test\").flows().updateRequiredAction(\"terms_and_conditions\", rep);\n+ adminClient.realm(\"test\").flows().updateRequiredAction(UserModel.RequiredAction.TERMS_AND_CONDITIONS.name(), rep);\n}\n@Test\n@@ -141,9 +142,9 @@ public class TermsAndConditionsTest extends AbstractTestRealmKeycloakTest {\n@Test\n// KEYCLOAK-3192\npublic void termsDisabled() {\n- RequiredActionProviderRepresentation rep = adminClient.realm(\"test\").flows().getRequiredAction(\"terms_and_conditions\");\n+ RequiredActionProviderRepresentation rep = adminClient.realm(\"test\").flows().getRequiredAction(UserModel.RequiredAction.TERMS_AND_CONDITIONS.name());\nrep.setEnabled(false);\n- adminClient.realm(\"test\").flows().updateRequiredAction(\"terms_and_conditions\", rep);\n+ adminClient.realm(\"test\").flows().updateRequiredAction(UserModel.RequiredAction.TERMS_AND_CONDITIONS.name(), rep);\nloginPage.open();\n"
},
{
"change_type": "MODIFY",
"old_path": "testsuite/integration-arquillian/tests/base/src/test/java/org/keycloak/testsuite/admin/authentication/RequiredActionsTest.java",
"new_path": "testsuite/integration-arquillian/tests/base/src/test/java/org/keycloak/testsuite/admin/authentication/RequiredActionsTest.java",
"diff": "@@ -46,11 +46,11 @@ public class RequiredActionsTest extends AbstractAuthenticationTest {\nList<RequiredActionProviderRepresentation> expected = new ArrayList<>();\naddRequiredAction(expected, \"CONFIGURE_TOTP\", \"Configure OTP\", true, false, null);\n+ addRequiredAction(expected, \"TERMS_AND_CONDITIONS\", \"Terms and Conditions\", false, false, null);\naddRequiredAction(expected, \"UPDATE_PASSWORD\", \"Update Password\", true, false, null);\naddRequiredAction(expected, \"UPDATE_PROFILE\", \"Update Profile\", true, false, null);\naddRequiredAction(expected, \"VERIFY_EMAIL\", \"Verify Email\", true, false, null);\naddRequiredAction(expected, \"delete_account\", \"Delete Account\", false, false, null);\n- addRequiredAction(expected, \"terms_and_conditions\", \"Terms and Conditions\", false, false, null);\naddRequiredAction(expected, \"update_user_locale\", \"Update User Locale\", true, false, null);\naddRequiredAction(expected, \"webauthn-register\", \"Webauthn Register\", true, false, null);\naddRequiredAction(expected, \"webauthn-register-passwordless\", \"Webauthn Register Passwordless\", true, false, null);\n"
},
{
"change_type": "MODIFY",
"old_path": "testsuite/integration-arquillian/tests/base/src/test/java/org/keycloak/testsuite/admin/partialimport/PartialImportTest.java",
"new_path": "testsuite/integration-arquillian/tests/base/src/test/java/org/keycloak/testsuite/admin/partialimport/PartialImportTest.java",
"diff": "@@ -25,7 +25,9 @@ import org.keycloak.admin.client.resource.ClientResource;\nimport org.keycloak.admin.client.resource.IdentityProviderResource;\nimport org.keycloak.admin.client.resource.RoleResource;\nimport org.keycloak.admin.client.resource.UserResource;\n+import org.keycloak.authentication.requiredactions.TermsAndConditions;\nimport org.keycloak.events.admin.OperationType;\n+import org.keycloak.models.UserModel;\nimport org.keycloak.partialimport.PartialImportResult;\nimport org.keycloak.partialimport.PartialImportResults;\nimport org.keycloak.representations.idm.AdminEventRepresentation;\n@@ -58,6 +60,8 @@ import java.util.Set;\nimport static org.hamcrest.CoreMatchers.hasItem;\nimport static org.hamcrest.CoreMatchers.startsWith;\n+import static org.hamcrest.MatcherAssert.assertThat;\n+import static org.hamcrest.Matchers.contains;\nimport static org.junit.Assert.assertEquals;\nimport static org.junit.Assert.assertNotNull;\nimport static org.junit.Assert.assertNull;\n@@ -245,7 +249,7 @@ public class PartialImportTest extends AbstractAuthTest {\nprivate void addUsersWithTermsAndConditions() {\nList<UserRepresentation> users = new ArrayList<>();\nList<String> requiredActions = new ArrayList<>();\n- requiredActions.add(\"terms_and_conditions\");\n+ requiredActions.add(UserModel.RequiredAction.TERMS_AND_CONDITIONS.name());\nfor (int i = 0; i < NUM_ENTITIES; i++) {\nUserRepresentation user = createUserRepresentation(USER_PREFIX + i, USER_PREFIX + i + \"@foo.com\", \"foo\", \"bar\", true);\n@@ -476,6 +480,7 @@ public class PartialImportTest extends AbstractAuthTest {\nUserRepresentation user = userRsc.toRepresentation();\nassertTrue(user.getUsername().startsWith(USER_PREFIX));\nAssert.assertTrue(userIds.contains(id));\n+ assertThat(user.getRequiredActions(), contains(TermsAndConditions.PROVIDER_ID));\n}\n}\n"
},
{
"change_type": "MODIFY",
"old_path": "testsuite/integration-arquillian/tests/other/old-admin-console/src/main/java/org/keycloak/testsuite/console/page/authentication/RequiredActions.java",
"new_path": "testsuite/integration-arquillian/tests/other/old-admin-console/src/main/java/org/keycloak/testsuite/console/page/authentication/RequiredActions.java",
"diff": "@@ -18,7 +18,7 @@ public class RequiredActions extends Authentication {\npublic final static String DEFAULT = \".defaultAction\";\npublic final static String CONFIGURE_TOTP = \"CONFIGURE_TOTP\";\npublic final static String UPDATE_PROFILE = \"UPDATE_PROFILE\";\n- public final static String TERMS_AND_CONDITIONS = \"terms_and_conditions\";\n+ public final static String TERMS_AND_CONDITIONS = \"TERMS_AND_CONDITIONS\";\npublic final static String UPDATE_PASSWORD = \"UPDATE_PASSWORD\";\npublic final static String VERIFY_EMAIL = \"VERIFY_EMAIL\";\n"
}
] | Java | Apache License 2.0 | keycloak/keycloak | Change id of TermsAndConditions required actions to uppercase
Closes #9991 |
339,274 | 20.12.2021 21:45:45 | -3,600 | 993d9105208e3f027168f003e5235cbe9bed9a7e | avoid NPE in LegacyAttributes when using federated storage
Closes #https://github.com/keycloak/keycloak/issues/15482 | [
{
"change_type": "MODIFY",
"old_path": "services/src/main/java/org/keycloak/userprofile/LegacyAttributes.java",
"new_path": "services/src/main/java/org/keycloak/userprofile/LegacyAttributes.java",
"diff": "@@ -40,16 +40,10 @@ public class LegacyAttributes extends DefaultAttributes {\n@Override\npublic Map<String, List<String>> getReadable() {\n- if(user == null)\n- return null;\n+ if(user == null || user.getAttributes() == null)\n+ return new HashMap<>();\n- Map<String, List<String>> attributes = new HashMap<>(user.getAttributes());\n-\n- if (attributes.isEmpty()) {\n- return null;\n- }\n-\n- return attributes;\n+ return new HashMap<>(user.getAttributes());\n}\n@Override\n"
}
] | Java | Apache License 2.0 | keycloak/keycloak | avoid NPE in LegacyAttributes when using federated storage
Closes #https://github.com/keycloak/keycloak/issues/15482 |
339,452 | 29.11.2022 09:50:57 | -3,600 | 4acd1afa3b744aadcf1f66d53a902ebf39892a39 | Use org.keycloak.common.util.Base64Url to encode/decode clientID
fix
related | [
{
"change_type": "MODIFY",
"old_path": "server-spi-private/src/main/java/org/keycloak/broker/provider/util/IdentityBrokerState.java",
"new_path": "server-spi-private/src/main/java/org/keycloak/broker/provider/util/IdentityBrokerState.java",
"diff": "@@ -20,10 +20,10 @@ package org.keycloak.broker.provider.util;\nimport org.keycloak.authorization.policy.evaluation.Realm;\nimport org.keycloak.models.ClientModel;\nimport org.keycloak.models.RealmModel;\n+import org.keycloak.common.util.Base64Url;\nimport java.nio.BufferUnderflowException;\nimport java.nio.ByteBuffer;\n-import java.util.Base64;\nimport java.util.UUID;\nimport java.util.regex.Pattern;\n@@ -51,8 +51,8 @@ public class IdentityBrokerState {\nbb.putLong(clientDbUuid.getMostSignificantBits());\nbb.putLong(clientDbUuid.getLeastSignificantBits());\nbyte[] clientUuidBytes = bb.array();\n- clientIdEncoded = Base64.getEncoder().encodeToString(clientUuidBytes).replace(\"=\", \"\");\n- } catch (IllegalArgumentException e) {\n+ clientIdEncoded = Base64Url.encode(clientUuidBytes);\n+ } catch (RuntimeException e) {\n// Ignore...the clientid in the database was not in UUID format. Just use as is.\n}\n}\n@@ -73,7 +73,7 @@ public class IdentityBrokerState {\ntry {\n// If this decoding succeeds it was the result of the encoding of a UUID client.id - if it fails we interpret it as client.clientId\n// in accordance to the method decoded above\n- byte[] decodedClientId = Base64.getDecoder().decode(clientId);\n+ byte[] decodedClientId = Base64Url.decode(clientId);\nByteBuffer bb = ByteBuffer.wrap(decodedClientId);\nlong first = bb.getLong();\nlong second = bb.getLong();\n@@ -83,7 +83,7 @@ public class IdentityBrokerState {\nif (clientModel != null) {\nclientId = clientModel.getClientId();\n}\n- } catch (IllegalArgumentException | BufferUnderflowException e) {\n+ } catch (RuntimeException e) {\n// Ignore...the clientid was not in encoded uuid format. Just use as it is.\n}\n}\n"
},
{
"change_type": "MODIFY",
"old_path": "server-spi-private/src/test/java/org/keycloak/broker/provider/util/IdentityBrokerStateTest.java",
"new_path": "server-spi-private/src/test/java/org/keycloak/broker/provider/util/IdentityBrokerStateTest.java",
"diff": "@@ -45,6 +45,25 @@ public class IdentityBrokerStateTest {\nAssert.assertEquals(\"gNrGamIDGKpKSI9yOrcFzYTKoFGH779_WNCacAelkhk.vpISZLVDAc0.7UlEjBTPRx6oOgY9DcO8jA\", encodedState.getEncoded());\n}\n+ @Test\n+ public void testDecodedWithClientIdAnActualUuidBASE64UriFriendly() {\n+\n+ // Given\n+ String state = \"gNrGamIDGKpKSI9yOrcFzYTKoFGH779_WNCacAelkhk\";\n+ String clientId = \"c5ac1ea7-6c28-4be1-b7cd-d63a1ba57f78\";\n+ String clientClientId = \"http://i.am.an.url\";\n+ String tabId = \"vpISZLVDAc0\";\n+\n+ // When\n+ IdentityBrokerState encodedState = IdentityBrokerState.decoded(state, clientId, clientClientId, tabId);\n+\n+ // Then\n+ Assert.assertNotNull(encodedState);\n+ Assert.assertEquals(clientClientId, encodedState.getClientId());\n+ Assert.assertEquals(tabId, encodedState.getTabId());\n+ Assert.assertEquals(\"gNrGamIDGKpKSI9yOrcFzYTKoFGH779_WNCacAelkhk.vpISZLVDAc0.xawep2woS-G3zdY6G6V_eA\", encodedState.getEncoded());\n+ }\n+\n@Test\npublic void testEncodedWithClientIdUUid() {\n// Given\n"
}
] | Java | Apache License 2.0 | keycloak/keycloak | Use org.keycloak.common.util.Base64Url to encode/decode clientID
fix #15734
related #10227 #10231 |
339,185 | 15.03.2022 15:22:20 | -3,600 | 901c85f6c09aff6b9c25eda36e9a5a422058ccee | Camel case field names
Fixes: | [
{
"change_type": "MODIFY",
"old_path": "model/build-processor/src/main/java/org/keycloak/models/map/processor/GenerateEntityImplementationsProcessor.java",
"new_path": "model/build-processor/src/main/java/org/keycloak/models/map/processor/GenerateEntityImplementationsProcessor.java",
"diff": "@@ -156,6 +156,7 @@ public class GenerateEntityImplementationsProcessor extends AbstractGenerateEnti\nTypeMirror fieldType = determineFieldType(fieldName, methods);\npw.println(\" public static final String FIELD_NAME = \\\"\" + fieldName + \"\\\";\");\npw.println(\" public static final String FIELD_NAME_DASHED = \\\"\" + fieldName.replaceAll(\"([^_A-Z])([A-Z])\", \"$1-$2\").toLowerCase() + \"\\\";\");\n+ pw.println(\" public static final String FIELD_NAME_CAMEL_CASE = \\\"\" + fieldName.substring(0, 1).toLowerCase() + fieldName.substring(1) + \"\\\";\");\npw.println(\" @SuppressWarnings(\\\"unchecked\\\") @Override public Class<?> getFieldClass() {\");\npw.println(\" return \" + types.erasure(fieldType) + \".class;\");\npw.println(\" }\");\n@@ -165,6 +166,9 @@ public class GenerateEntityImplementationsProcessor extends AbstractGenerateEnti\npw.println(\" @Override public String getNameDashed() {\");\npw.println(\" return FIELD_NAME_DASHED;\");\npw.println(\" }\");\n+ pw.println(\" @Override public String getNameCamelCase() {\");\n+ pw.println(\" return FIELD_NAME_CAMEL_CASE;\");\n+ pw.println(\" }\");\nFieldAccessorType.getMethod(FieldAccessorType.COLLECTION_ADD, methods, fieldName, types, fieldType).ifPresent(method -> {\nTypeMirror firstParameterType = method.getParameters().get(0).asType();\n"
},
{
"change_type": "MODIFY",
"old_path": "model/map/src/main/java/org/keycloak/models/map/common/EntityField.java",
"new_path": "model/map/src/main/java/org/keycloak/models/map/common/EntityField.java",
"diff": "@@ -16,6 +16,12 @@ public interface EntityField<E> {\n* @return\n*/\nString getName();\n+ /*\n+ * Returns name of this field in camel case with first word starting with lower case letter and\n+ * further words starting with a capital letter.\n+ * @return\n+ */\n+ String getNameCamelCase();\n/**\n* Returns name of this field in lowercase with words separated by a dash ({@code -}).\n* @return\n"
}
] | Java | Apache License 2.0 | keycloak/keycloak | Camel case field names
Fixes: #15846 |
339,459 | 30.11.2022 00:04:56 | -3,600 | 1073a342cf55852618ea538190207ff4aa1a23e9 | Cleanup dependencies and align with Quarkus
* aligned parent POM dependency versions with the Quarkus BOM
Closes | [
{
"change_type": "MODIFY",
"old_path": "model/map-jpa/pom.xml",
"new_path": "model/map-jpa/pom.xml",
"diff": "<plugin>\n<groupId>org.hibernate.orm.tooling</groupId>\n<artifactId>hibernate-enhance-maven-plugin</artifactId>\n- <version>${hibernate.core.version}</version>\n+ <version>${hibernate-orm.version}</version>\n<executions>\n<execution>\n<configuration>\n"
},
{
"change_type": "MODIFY",
"old_path": "pom.xml",
"new_path": "pom.xml",
"diff": "<dom4j.version>2.1.3</dom4j.version>\n<h2.version>2.1.214</h2.version>\n<jakarta.persistence.version>2.2.3</jakarta.persistence.version>\n- <hibernate.core.version>5.6.10.Final</hibernate.core.version>\n- <hibernate.c3p0.version>5.6.10.Final</hibernate.c3p0.version>\n+ <hibernate-orm.version>5.6.14.Final</hibernate-orm.version>\n+ <hibernate.c3p0.version>${hibernate-orm.version}</hibernate.c3p0.version>\n<infinispan.version>14.0.2.Final</infinispan.version>\n<infinispan.protostream.processor.version>4.5.0.Final</infinispan.protostream.processor.version>\n<jackson.version>2.13.4</jackson.version>\n<sun.activation.version>1.2.2</sun.activation.version>\n<org.glassfish.jaxb.xsom.version>2.3.3-b02</org.glassfish.jaxb.xsom.version>\n<undertow.version>2.2.19.Final</undertow.version>\n- <elytron.version>1.18.3.Final</elytron.version>\n+ <wildfly-elytron.version>1.20.1.Final</wildfly-elytron.version>\n<elytron.undertow-server.version>1.9.0.Final</elytron.undertow-server.version>\n<jetty94.version>9.4.40.v20210413</jetty94.version>\n<woodstox.version>6.0.3</woodstox.version>\n<!-- Databases -->\n<mysql.version>8.0.23</mysql.version>\n- <mysql.driver.version>8.0.28</mysql.driver.version>\n+ <mysql-jdbc.version>8.0.30</mysql-jdbc.version>\n<postgresql.version>13.2</postgresql.version>\n- <postgresql.driver.version>42.3.3</postgresql.driver.version>\n+ <postgresql-jdbc.version>42.5.0</postgresql-jdbc.version>\n<mariadb.version>10.3.27</mariadb.version>\n- <mariadb.driver.version>2.7.2</mariadb.driver.version>\n+ <mariadb-jdbc.version>2.7.2</mariadb-jdbc.version>\n<mssql.version>2019-CU10-ubuntu-20.04</mssql.version>\n- <mssql.driver.version>9.2.0.jre8</mssql.driver.version>\n+ <mssql-jdbc.version>9.2.0.jre8</mssql-jdbc.version>\n<!-- this is the oracle driver version also used in the Quarkus BOM -->\n- <oracle.driver.version>21.5.0.0</oracle.driver.version>\n+ <oracle-jdbc.version>21.5.0.0</oracle-jdbc.version>\n<!-- Test -->\n<greenmail.version>1.3.1b</greenmail.version>\n<junit.version>4.13.2</junit.version>\n<picketlink.version>2.7.0.Final</picketlink.version>\n<selenium.version>2.35.0</selenium.version>\n+ <!-- Needs to be aligned with Quarkus, see e.g. https://github.com/quarkusio/quarkus-quickstarts/blob/2.13.5.Final/getting-started-async/pom.xml#L14 -->\n+ <surefire-plugin.version>3.0.0-M7</surefire-plugin.version>\n<xml-apis.version>1.4.01</xml-apis.version>\n<subethasmtp.version>3.1.7</subethasmtp.version>\n<awaitility.version>4.1.1</awaitility.version>\n<!-- KEYCLOAK-17585 Prevent microprofile-metrics-api upgrades from version \"2.3\" due to:\nhttps://issues.redhat.com/browse/KEYCLOAK-17585?focusedCommentId=16002705&page=com.atlassian.jira.plugin.system.issuetabpanels%3Acomment-tabpanel#comment-16002705\n-->\n- <microprofile-metrics-api.version>2.3</microprofile-metrics-api.version>\n+ <microprofile-metrics-api.version>3.0.1</microprofile-metrics-api.version>\n<testcontainers.version>1.17.5</testcontainers.version>\n<!-- Maven Plugins -->\n<dependency>\n<groupId>org.hibernate</groupId>\n<artifactId>hibernate-core</artifactId>\n- <version>${hibernate.core.version}</version>\n+ <version>${hibernate-orm.version}</version>\n</dependency>\n<dependency>\n<groupId>org.hibernate</groupId>\n<dependency>\n<groupId>mysql</groupId>\n<artifactId>mysql-connector-java</artifactId>\n- <version>${mysql.driver.version}</version>\n+ <version>${mysql-jdbc.version}</version>\n<scope>test</scope>\n</dependency>\n<dependency>\n<dependency>\n<groupId>org.wildfly.security</groupId>\n<artifactId>wildfly-elytron</artifactId>\n- <version>${elytron.version}</version>\n+ <version>${wildfly-elytron.version}</version>\n</dependency>\n<dependency>\n<groupId>org.wildfly.common</groupId>\n<plugin>\n<groupId>org.apache.maven.plugins</groupId>\n<artifactId>maven-surefire-plugin</artifactId>\n- <version>3.0.0-M7</version>\n+ <version>${surefire-plugin.version}</version>\n<configuration>\n<forkMode>once</forkMode>\n<argLine>-Djava.awt.headless=true ${surefire.memory.settings} ${surefire.system.args} -Duser.language=en -Duser.region=US</argLine>\n<groupId>org.apache.maven.plugins</groupId>\n<artifactId>maven-javadoc-plugin</artifactId>\n<configuration>\n- <additionalparam>-Xdoclint:none</additionalparam>\n+ <doclint>none</doclint>\n<failOnError>false</failOnError>\n<excludePackageNames>cx.*:org.freedesktop*:org.jvnet*</excludePackageNames>\n</configuration>\n"
},
{
"change_type": "MODIFY",
"old_path": "quarkus/pom.xml",
"new_path": "quarkus/pom.xml",
"diff": "<packaging>pom</packaging>\n<properties>\n- <!--\n- Do not change the properties bellow.\n- Their names should match the name used by Quarkus BOM and the versions are automatically set when running the 'set-quarkus-version.sh' script.\n- -->\n- <resteasy.version>4.7.7.Final</resteasy.version>\n- <hibernate-orm.version>5.6.14.Final</hibernate-orm.version>\n- <mysql-jdbc.version>8.0.30</mysql-jdbc.version>\n- <postgresql-jdbc.version>42.5.0</postgresql-jdbc.version>\n<wildfly-common.version>1.5.4.Final-format-001</wildfly-common.version>\n- <wildfly-elytron.version>1.20.1.Final</wildfly-elytron.version>\n- <microprofile-metrics-api.version>3.0.1</microprofile-metrics-api.version>\n<!--\nWe need to override certain dependencies from the parent POM.\nTODO: remove these properties after changing the parent POM to use the same property names used by Quarkus BOM.\n-->\n- <hibernate.core.version>${hibernate-orm.version}</hibernate.core.version>\n- <mysql.driver.version>${mysql-jdbc.version}</mysql.driver.version>\n- <postgresql.version>${postgresql-jdbc.version}</postgresql.version>\n<wildfly.common.version>${wildfly-common.version}</wildfly.common.version>\n<!--\n<maven.compiler.release>11</maven.compiler.release>\n<maven.compiler.source>11</maven.compiler.source>\n<maven.compiler.target>11</maven.compiler.target>\n-\n- <!-- Needs to be aligned with Quarkus, see e.g. https://github.com/quarkusio/quarkus-quickstarts/blob/2.7.6.Final/getting-started-async/pom.xml#L14 -->\n- <surefire-plugin.version>3.0.0-M5</surefire-plugin.version>\n</properties>\n<dependencyManagement>\n<version>${infinispan.version}</version>\n</dependency>\n+\n<!-- Dependencies removed from JDK 11 and in compliance with those used by Wildfly. -->\n<dependency>\n<groupId>org.jboss.spec.javax.xml.bind</groupId>\n"
},
{
"change_type": "MODIFY",
"old_path": "quarkus/runtime/pom.xml",
"new_path": "quarkus/runtime/pom.xml",
"diff": "<dependency>\n<groupId>org.wildfly.security</groupId>\n<artifactId>wildfly-elytron</artifactId>\n- <version>${wildfly-elytron.version}</version>\n</dependency>\n<dependency>\n<groupId>io.quarkiverse.vault</groupId>\n<dependency>\n<groupId>org.jboss.resteasy</groupId>\n<artifactId>resteasy-multipart-provider</artifactId>\n- <version>${resteasy.version}</version>\n</dependency>\n<dependency>\n<groupId>org.jboss.logging</groupId>\n<plugin>\n<groupId>org.apache.maven.plugins</groupId>\n<artifactId>maven-failsafe-plugin</artifactId>\n- <version>${surefire-plugin.version}</version>\n<executions>\n<execution>\n<goals>\n"
},
{
"change_type": "MODIFY",
"old_path": "testsuite/integration-arquillian/pom.xml",
"new_path": "testsuite/integration-arquillian/pom.xml",
"diff": "<!-- for the particular EAP version -->\n<jdbc.mvn.groupId>mysql</jdbc.mvn.groupId>\n<jdbc.mvn.artifactId>mysql-connector-java</jdbc.mvn.artifactId>\n- <jdbc.mvn.version>${mysql.driver.version}</jdbc.mvn.version>\n+ <jdbc.mvn.version>${mysql-jdbc.version}</jdbc.mvn.version>\n<docker.database.image>mysql:${mysql.version}</docker.database.image>\n<docker.database.port>3306</docker.database.port>\n<docker.database.skip>false</docker.database.skip>\n<!-- for the particular EAP version -->\n<jdbc.mvn.groupId>org.postgresql</jdbc.mvn.groupId>\n<jdbc.mvn.artifactId>postgresql</jdbc.mvn.artifactId>\n- <jdbc.mvn.version>${postgresql.driver.version}</jdbc.mvn.version>\n+ <jdbc.mvn.version>${postgresql-jdbc.version}</jdbc.mvn.version>\n<docker.database.image>postgres:${postgresql.version}</docker.database.image>\n<docker.database.port>5432</docker.database.port>\n<docker.database.skip>false</docker.database.skip>\n<!-- for the particular EAP version -->\n<jdbc.mvn.groupId>org.mariadb.jdbc</jdbc.mvn.groupId>\n<jdbc.mvn.artifactId>mariadb-java-client</jdbc.mvn.artifactId>\n- <jdbc.mvn.version>${mariadb.driver.version}</jdbc.mvn.version>\n+ <jdbc.mvn.version>${mariadb-jdbc.version}</jdbc.mvn.version>\n<docker.database.image>mariadb:${mariadb.version}</docker.database.image>\n<docker.database.port>3306</docker.database.port>\n<docker.database.skip>false</docker.database.skip>\n<!-- for the particular EAP version -->\n<jdbc.mvn.groupId>com.microsoft.sqlserver</jdbc.mvn.groupId>\n<jdbc.mvn.artifactId>mssql-jdbc</jdbc.mvn.artifactId>\n- <jdbc.mvn.version>${mssql.driver.version}</jdbc.mvn.version>\n+ <jdbc.mvn.version>${mssql-jdbc.version}</jdbc.mvn.version>\n</properties>\n</profile>\n<profile>\n<!-- for the particular EAP version -->\n<jdbc.mvn.groupId>com.oracle.database.jdbc</jdbc.mvn.groupId>\n<jdbc.mvn.artifactId>ojdbc11</jdbc.mvn.artifactId>\n- <jdbc.mvn.version>${oracle.driver.version}</jdbc.mvn.version>\n+ <jdbc.mvn.version>${oracle-jdbc.version}</jdbc.mvn.version>\n</properties>\n</profile>\n<profile>\n"
},
{
"change_type": "MODIFY",
"old_path": "testsuite/model/pom.xml",
"new_path": "testsuite/model/pom.xml",
"diff": "<dependency>\n<groupId>org.postgresql</groupId>\n<artifactId>postgresql</artifactId>\n- <version>${postgresql.driver.version}</version>\n+ <version>${postgresql-jdbc.version}</version>\n</dependency>\n<dependency>\n<groupId>org.testcontainers</groupId>\n"
},
{
"change_type": "MODIFY",
"old_path": "testsuite/utils/pom.xml",
"new_path": "testsuite/utils/pom.xml",
"diff": "<dependency>\n<groupId>org.postgresql</groupId>\n<artifactId>postgresql</artifactId>\n- <version>${postgresql.driver.version}</version>\n+ <version>${postgresql-jdbc.version}</version>\n</dependency>\n<dependency>\n<groupId>com.oracle.database.jdbc</groupId>\n<artifactId>ojdbc11</artifactId>\n- <version>${oracle.driver.version}</version>\n+ <version>${oracle-jdbc.version}</version>\n<scope>compile</scope>\n</dependency>\n<dependency>\n<groupId>org.mariadb.jdbc</groupId>\n<artifactId>mariadb-java-client</artifactId>\n- <version>${mariadb.driver.version}</version>\n+ <version>${mariadb-jdbc.version}</version>\n</dependency>\n<dependency>\n<groupId>com.microsoft.sqlserver</groupId>\n<artifactId>mssql-jdbc</artifactId>\n- <version>${mssql.driver.version}</version>\n+ <version>${mssql-jdbc.version}</version>\n</dependency>\n</dependencies>\n"
}
] | Java | Apache License 2.0 | keycloak/keycloak | Cleanup dependencies and align with Quarkus
* aligned parent POM dependency versions with the Quarkus BOM
Closes #15325
Signed-off-by: Peter Zaoral <pzaoral@redhat.com> |
339,487 | 09.12.2022 12:00:04 | 10,800 | d6a4acceda59fc9a2b0f97dd23193d51d3496130 | Exclude commons-text from liquibase-core dependency
Closes | [
{
"change_type": "MODIFY",
"old_path": "dependencies/server-all/pom.xml",
"new_path": "dependencies/server-all/pom.xml",
"diff": "<dependency>\n<groupId>org.liquibase</groupId>\n<artifactId>liquibase-core</artifactId>\n- <exclusions>\n- <exclusion>\n- <groupId>org.yaml</groupId>\n- <artifactId>snakeyaml</artifactId>\n- </exclusion>\n- </exclusions>\n</dependency>\n<!-- Dependencies for RHEL IdM -->\n"
},
{
"change_type": "MODIFY",
"old_path": "model/jpa/pom.xml",
"new_path": "model/jpa/pom.xml",
"diff": "<dependency>\n<groupId>org.liquibase</groupId>\n<artifactId>liquibase-core</artifactId>\n- <exclusions>\n- <exclusion>\n- <groupId>org.yaml</groupId>\n- <artifactId>snakeyaml</artifactId>\n- </exclusion>\n- </exclusions>\n</dependency>\n<dependency>\n<groupId>jakarta.persistence</groupId>\n"
},
{
"change_type": "MODIFY",
"old_path": "model/map-jpa/pom.xml",
"new_path": "model/map-jpa/pom.xml",
"diff": "<dependency>\n<groupId>org.liquibase</groupId>\n<artifactId>liquibase-core</artifactId>\n- <exclusions>\n- <exclusion>\n- <groupId>org.yaml</groupId>\n- <artifactId>snakeyaml</artifactId>\n- </exclusion>\n- </exclusions>\n</dependency>\n</dependencies>\n<build>\n"
},
{
"change_type": "MODIFY",
"old_path": "pom.xml",
"new_path": "pom.xml",
"diff": "<groupId>org.liquibase</groupId>\n<artifactId>liquibase-core</artifactId>\n<version>${liquibase.version}</version>\n+ <exclusions>\n+ <exclusion>\n+ <groupId>org.yaml</groupId>\n+ <artifactId>snakeyaml</artifactId>\n+ </exclusion>\n+ <exclusion>\n+ <groupId>org.apache.commons</groupId>\n+ <artifactId>commons-text</artifactId>\n+ </exclusion>\n+ </exclusions>\n</dependency>\n<dependency>\n<groupId>org.osgi</groupId>\n"
}
] | Java | Apache License 2.0 | keycloak/keycloak | Exclude commons-text from liquibase-core dependency
Closes #15915 |
339,144 | 16.12.2022 11:56:14 | -3,600 | 220590d241f415c75604eab5279f69ca0024172e | improve german email translation
Closes | [
{
"change_type": "MODIFY",
"old_path": "themes/src/main/resources-community/theme/base/email/messages/messages_de.properties",
"new_path": "themes/src/main/resources-community/theme/base/email/messages/messages_de.properties",
"diff": "emailVerificationSubject=E-Mail verifizieren\n-emailVerificationBody=Jemand hat ein {2} Konto mit dieser E-Mail-Adresse erstellt. Falls Sie das waren, dann klicken Sie auf den Link, um die E-Mail-Adresse zu verifizieren.\\n\\n{0}\\n\\nDieser Link wird in {1} Minuten ablaufen.\\n\\nFalls Sie dieses Konto nicht erstellt haben, dann k\\u00F6nnen sie diese Nachricht ignorieren.\n-emailVerificationBodyHtml=<p>Jemand hat ein {2} Konto mit dieser E-Mail-Adresse erstellt. Falls das Sie waren, klicken Sie auf den Link, um die E-Mail-Adresse zu verifizieren.</p><p><a href=\"{0}\">Link zur Best\\u00E4tigung der E-Mail-Adresse</a></p><p>Dieser Link wird in {1} Minuten ablaufen.</p><p>Falls Sie dieses Konto nicht erstellt haben, dann k\\u00F6nnen sie diese Nachricht ignorieren.</p>\n+emailVerificationBody=Jemand hat ein {2} Konto mit dieser E-Mail-Adresse erstellt. Falls Sie das waren, dann klicken Sie auf den Link, um die E-Mail-Adresse zu verifizieren.\\n\\n{0}\\n\\nDer Link ist {3} g\\u00FCltig.\\n\\nFalls Sie dieses Konto nicht erstellt haben, dann k\\u00F6nnen sie diese Nachricht ignorieren.\n+emailVerificationBodyHtml=<p>Jemand hat ein {2} Konto mit dieser E-Mail-Adresse erstellt. Falls das Sie waren, klicken Sie auf den Link, um die E-Mail-Adresse zu verifizieren.</p><p><a href=\"{0}\">Link zur Best\\u00E4tigung der E-Mail-Adresse</a></p><p>Der Link ist {3} g\\u00FCltig.</p><p>Falls Sie dieses Konto nicht erstellt haben, dann k\\u00F6nnen sie diese Nachricht ignorieren.</p>\n+emailUpdateConfirmationSubject=Neue E-Mail verifizieren\n+emailUpdateConfirmationBody=Um Ihren {2} Account mit der E-Mail-Adresse {1} zu verifizieren, klicken Sie den folgenden Link\\n\\n{0}\\n\\nDer Link ist {3} g\\u00FCltig.\\n\\nSollten Sie die neue E-Mail-Adresse nicht verwenden wollen, ignorieren Sie diese Nachricht.\n+emailUpdateConfirmationBodyHtml=<p>Um Ihren {2} Account mit der E-Mail-Adresse {1} zu verifizieren, klicken Sie den folgenden Link</p><p><a href=\"{0}\">{0}</a></p><p>Der Link ist {3} g\\u00FCltig.</p><p>Sollten Sie die neue E-Mail-Adresse nicht verwenden wollen, ignorieren Sie diese Nachricht.</p>\nidentityProviderLinkSubject=Link {0}\n-identityProviderLinkBody=Es wurde beantragt Ihren Account {1} mit dem Account {0} von Benutzer {2} zu verlinken. Sollten Sie dies beantragt haben, klicken Sie auf den unten stehenden Link.\\n\\n{3}\\n\\n Die G\\u00FCltigkeit des Links wird in {4} Minuten verfallen.\\n\\nSollten Sie Ihren Account nicht verlinken wollen, ignorieren Sie diese Nachricht. Wenn Sie die Accounts verlinken wird ein Login auf {1} \\u00FCber {0} erm\\u00F6glicht.\n-identityProviderLinkBodyHtml=<p>Es wurde beantragt Ihren Account {1} mit dem Account {0} von Benutzer {2} zu verlinken. Sollten Sie dies beantragt haben, klicken Sie auf den unten stehenden Link.</p><p><a href=\"{3}\">Link zur Best\\u00E4tigung der Kontoverkn\\u00FCpfung</a></p><p>Die G\\u00FCltigkeit des Links wird in {4} Minuten verfallen.</p><p>Sollten Sie Ihren Account nicht verlinken wollen, ignorieren Sie diese Nachricht. Wenn Sie die Accounts verlinken wird ein Login auf {1} \\u00FCber {0} erm\\u00F6glicht.</p>\n+identityProviderLinkBody=Es wurde beantragt Ihren Account \"{1}\" mit dem Account \"{0}\" von Benutzer {2} zu verlinken. Sollten Sie dies beantragt haben, klicken Sie auf den unten stehenden Link.\\n\\n{3}\\n\\nDer Link ist {5} g\\u00FCltig.\\n\\nSollten Sie Ihren Account nicht verlinken wollen, ignorieren Sie diese Nachricht. Wenn Sie die Accounts verlinken wird ein Login auf {1} \\u00FCber {0} erm\\u00F6glicht.\n+identityProviderLinkBodyHtml=<p>Es wurde beantragt Ihren Account <b>{1}</b> mit dem Account <b>{0}</b> von Benutzer {2} zu verlinken. Sollten Sie dies beantragt haben, klicken Sie auf den unten stehenden Link.</p><p><a href=\"{3}\">Link zur Best\\u00E4tigung der Kontoverkn\\u00FCpfung</a></p><p>Der Link ist {5} g\\u00FCltig.</p><p>Sollten Sie Ihren Account nicht verlinken wollen, ignorieren Sie diese Nachricht. Wenn Sie die Accounts verlinken wird ein Login auf {1} \\u00FCber {0} erm\\u00F6glicht.</p>\npasswordResetSubject=Passwort zur\\u00FCcksetzen\n-passwordResetBody=Es wurde eine \\u00C4nderung der Anmeldeinformationen f\\u00FCr Ihren Account {2} angefordert. Wenn Sie diese \\u00C4nderung beantragt haben, klicken Sie auf den unten stehenden Link.\\n\\n{0}\\n\\nDie G\\u00FCltigkeit des Links wird in {1} Minuten verfallen.\\n\\nSollten Sie keine \\u00C4nderung vollziehen wollen k\\u00F6nnen Sie diese Nachricht ignorieren und an Ihrem Account wird nichts ge\\u00E4ndert.\n-passwordResetBodyHtml=<p>Es wurde eine \\u00C4nderung der Anmeldeinformationen f\\u00FCr Ihren Account {2} angefordert. Wenn Sie diese \\u00C4nderung beantragt haben, klicken Sie auf den unten stehenden Link.</p><p><a href=\"{0}\">Link zum Zur\\u00FCcksetzen von Anmeldeinformationen</a></p><p>Die G\\u00FCltigkeit des Links wird in {1} Minuten verfallen.</p><p>Sollten Sie keine \\u00C4nderung vollziehen wollen k\\u00F6nnen Sie diese Nachricht ignorieren und an Ihrem Account wird nichts ge\\u00E4ndert.</p>\n+passwordResetBody=Es wurde eine \\u00C4nderung der Anmeldeinformationen f\\u00FCr Ihren Account {2} angefordert. Wenn Sie diese \\u00C4nderung beantragt haben, klicken Sie auf den unten stehenden Link.\\n\\n{0}\\n\\nDer Link ist {3} g\\u00FCltig.\\n\\nSollten Sie keine \\u00C4nderung vollziehen wollen k\\u00F6nnen Sie diese Nachricht ignorieren und an Ihrem Account wird nichts ge\\u00E4ndert.\n+passwordResetBodyHtml=<p>Es wurde eine \\u00C4nderung der Anmeldeinformationen f\\u00FCr Ihren Account {2} angefordert. Wenn Sie diese \\u00C4nderung beantragt haben, klicken Sie auf den unten stehenden Link.</p><p><a href=\"{0}\">Link zum Zur\\u00FCcksetzen von Anmeldeinformationen</a></p><p>Der Link ist {3} g\\u00FCltig.</p><p>Sollten Sie keine \\u00C4nderung vollziehen wollen k\\u00F6nnen Sie diese Nachricht ignorieren und an Ihrem Account wird nichts ge\\u00E4ndert.</p>\nexecuteActionsSubject=Aktualisieren Sie Ihr Konto\n-executeActionsBody=Ihr Administrator hat Sie aufgefordert Ihren Account {2} zu aktualisieren. Klicken Sie auf den unten stehenden Link um den Prozess zu starten.\\n\\n{0}\\n\\nDie G\\u00FCltigkeit des Links wird in {1} Minuten verfallen.\\n\\nSollten Sie sich dieser Aufforderung nicht bewusst sein, ignorieren Sie diese Nachricht und Ihr Account bleibt unver\\u00E4ndert.\n-executeActionsBodyHtml=<p>Ihr Administrator hat Sie aufgefordert Ihren Account {2} zu aktualisieren. Klicken Sie auf den unten stehenden Link um den Prozess zu starten.</p><p><a href=\"{0}\">Link zum Account-Update</a></p><p>Die G\\u00FCltigkeit des Links wird in {1} Minuten verfallen.</p><p>Sollten Sie sich dieser Aufforderung nicht bewusst sein, ignorieren Sie diese Nachricht und Ihr Account bleibt unver\\u00E4ndert.</p>\n+executeActionsBody=Ihr Administrator hat Sie aufgefordert Ihren Account {2} zu aktualisieren. Klicken Sie auf den unten stehenden Link um den Prozess zu starten.\\n\\n{0}\\n\\nDer Link ist {4} g\\u00FCltig.\\n\\nSollten Sie sich dieser Aufforderung nicht bewusst sein, ignorieren Sie diese Nachricht und Ihr Account bleibt unver\\u00E4ndert.\n+executeActionsBodyHtml=<p>Ihr Administrator hat Sie aufgefordert Ihren Account {2} zu aktualisieren. Klicken Sie auf den unten stehenden Link um den Prozess zu starten.</p><p><a href=\"{0}\">Link zum Account-Update</a></p><p>Der Link ist {4} g\\u00FCltig.</p><p>Sollten Sie sich dieser Aufforderung nicht bewusst sein, ignorieren Sie diese Nachricht und Ihr Account bleibt unver\\u00E4ndert.</p>\neventLoginErrorSubject=Fehlgeschlagene Anmeldung\neventLoginErrorBody=Jemand hat um {0} von {1} versucht, sich mit Ihrem Konto anzumelden. Falls das nicht Sie waren, dann kontaktieren Sie bitte Ihren Admin.\neventLoginErrorBodyHtml=<p>Jemand hat um {0} von {1} versucht, sich mit Ihrem Konto anzumelden. Falls das nicht Sie waren, dann kontaktieren Sie bitte Ihren Admin.</p>\n"
}
] | Java | Apache License 2.0 | keycloak/keycloak | improve german email translation (#15949)
Closes #15948 |
339,410 | 17.12.2022 08:50:21 | -3,600 | 1d758fac2bd7be94b3885dd195da0fcb8e27467a | Adding CRDB into GHA for the new store
The CockroachDB database is slower than PostgreSQL, therefore it will only run branches and nightly builds.
Closes | [
{
"change_type": "MODIFY",
"old_path": ".github/workflows/ci.yml",
"new_path": ".github/workflows/ci.yml",
"diff": "@@ -165,7 +165,7 @@ jobs:\nrun: |\nTESTS=`testsuite/integration-arquillian/tests/base/testsuites/suite.sh jdk`\necho \"Tests: $TESTS\"\n- ./mvnw test -nsu -B -Pauth-server-quarkus -Pdb-${{ matrix.db }} -Dtest=$TESTS -pl testsuite/integration-arquillian/tests/base | misc/log/trimmer.sh\n+ ./mvnw test -nsu -B -Pauth-server-quarkus -Dtest=$TESTS -pl testsuite/integration-arquillian/tests/base | misc/log/trimmer.sh\n- id: upload-surefire-reports\nname: Upload Surefire reports\n@@ -175,14 +175,31 @@ jobs:\napi-key: ${{ secrets.FORESIGHT_API_KEY }}\nsurefire-reports-path: 'testsuite/integration-arquillian/tests/base/target/surefire-reports/*.xml'\n+ databases-new-store:\n+ name: Databases New Store\n+ runs-on: ubuntu-latest\n+ steps:\n+ - id: matrix-db\n+ # language=bash\n+ run: |\n+ # For PRs, run only PostgreSQL, on branches and nightly runs run all databases\n+ if [ \"${{ github.event_name }}\" == \"pull_request\" ]; then\n+ echo 'db=[\"chm\", \"hot-rod\", \"jpa-postgres\"]' >> $GITHUB_OUTPUT\n+ else\n+ echo 'db=[\"chm\", \"hot-rod\", \"jpa-postgres\", \"jpa-cockroach\"]' >> $GITHUB_OUTPUT\n+ fi\n+ outputs:\n+ db: ${{ steps.matrix-db.outputs.db }}\n+\nnew-store-integration-tests:\nname: New Store IT\n- needs: build\n+ needs: [build, databases-new-store]\nruns-on: ubuntu-latest\n- timeout-minutes: 45\n+ # Currently, the run of CockroachDB (only branches and nightly runs) is the longest with ~45 minutes\n+ timeout-minutes: 70\nstrategy:\nmatrix:\n- db: [chm, hot-rod, jpa]\n+ db: ${{ fromJson(needs.databases-new-store.outputs.db) }}\nfail-fast: false\nsteps:\n- uses: actions/checkout@v3\n@@ -196,7 +213,8 @@ jobs:\ndeclare -A PARAMS\nPARAMS[\"chm\"]=\"-Pmap-storage -Dpageload.timeout=90000\"\nPARAMS[\"hot-rod\"]=\"-Pmap-storage,map-storage-hot-rod -Dpageload.timeout=90000\"\n- PARAMS[\"jpa\"]=\"-Pmap-storage,map-storage-jpa -Dpageload.timeout=90000\"\n+ PARAMS[\"jpa-postgres\"]=\"-Pmap-storage,map-storage-jpa-postgres -Dpageload.timeout=90000\"\n+ PARAMS[\"jpa-cockroach\"]=\"-Pmap-storage,map-storage-jpa-cockroach -Dpageload.timeout=90000\"\nTESTS=`testsuite/integration-arquillian/tests/base/testsuites/suite.sh database`\necho \"Tests: $TESTS\"\n"
},
{
"change_type": "MODIFY",
"old_path": "quarkus/tests/integration/pom.xml",
"new_path": "quarkus/tests/integration/pom.xml",
"diff": "<groupId>org.testcontainers</groupId>\n<artifactId>postgresql</artifactId>\n</dependency>\n+ <dependency>\n+ <groupId>org.testcontainers</groupId>\n+ <artifactId>cockroachdb</artifactId>\n+ </dependency>\n<dependency>\n<groupId>org.testcontainers</groupId>\n<artifactId>mariadb</artifactId>\n"
},
{
"change_type": "MODIFY",
"old_path": "testsuite/integration-arquillian/HOW-TO-RUN.md",
"new_path": "testsuite/integration-arquillian/HOW-TO-RUN.md",
"diff": "@@ -837,14 +837,19 @@ mvn clean install -f testsuite/integration-arquillian/tests/base \\\n### Running tests with JPA Map storage\n-By default tests with `map-storage-jpa` profile spawns a new Postgres container\n-with each test execution. Default image used is \"postgres:alpine\". To spawn different\n-version, it can be used \"keycloak.map.storage.postgres.docker.image\" system property.\n+By default, testing with the profile `map-storage-jpa-postgres` spawns a new Postgres container\n+with each test execution. The default image used is `postgres:alpine`. To spawn a different\n+version, use the system property `keycloak.map.storage.postgres.docker.image`.\n+\n+In a similar way the profile `map-storage-jpa-cockroach` spawns a new CockroachDB container\n+with each test execution. It uses the official CockroachDB image in the version stated in the\n+class `CockroachdbContainerTestEnricher`. To spawn a different\n+version, use the system property `keycloak.map.storage.cockroachdb.docker.image`.\nExecute tests:\n```shell\nmvn clean install -f testsuite/integration-arquillian/tests/base \\\n- -Pmap-storage,map-storage-jpa\n+ -Pmap-storage,map-storage-jpa-postgres\n```\nIt's also possible to configure tests to connect to an external database, it might be useful\n@@ -859,7 +864,7 @@ podman run --name postgres -p 5432:5432 -e POSTGRES_PASSWORD=pass -e POSTGRES_US\nTo run the tests without spawning the container for you, execute tests with the following command:\n```shell\nmvn clean install -f testsuite/integration-arquillian/tests/base \\\n- -Pmap-storage,map-storage-jpa \\\n+ -Pmap-storage,map-storage-jpa-postgres \\\n-Dpostgres.start-container=false \\\n-Dkeycloak.map.storage.connectionsJpa.url=<jdbc_url> \\\n-Dkeycloak.map.storage.connectionsJpa.user=<user> \\\n"
},
{
"change_type": "MODIFY",
"old_path": "testsuite/integration-arquillian/tests/base/pom.xml",
"new_path": "testsuite/integration-arquillian/tests/base/pom.xml",
"diff": "<artifactId>postgresql</artifactId>\n<version>${testcontainers.version}</version>\n</dependency>\n+ <dependency>\n+ <groupId>org.testcontainers</groupId>\n+ <artifactId>cockroachdb</artifactId>\n+ <version>${testcontainers.version}</version>\n+ </dependency>\n<dependency>\n<groupId>com.google.guava</groupId>\n<artifactId>guava</artifactId>\n</profile>\n<profile>\n- <id>map-storage-jpa</id>\n+ <id>map-storage-jpa-postgres</id>\n<properties>\n<postgres.start-container>true</postgres.start-container>\n</properties>\n</build>\n</profile>\n+ <profile>\n+ <id>map-storage-jpa-cockroach</id>\n+ <properties>\n+ <cockroachdb.start-container>true</cockroachdb.start-container>\n+ <keycloak.map.storage.connectionsJpa.url>jdbc:postgresql://localhost:26257/keycloak</keycloak.map.storage.connectionsJpa.url>\n+ </properties>\n+ <build>\n+ <plugins>\n+ <plugin>\n+ <artifactId>maven-enforcer-plugin</artifactId>\n+ <goals>\n+ <goal>enforce</goal>\n+ </goals>\n+ <configuration>\n+ <rules>\n+ <requireActiveProfile>\n+ <profiles>map-storage</profiles>\n+ <message>map-storage profile not active</message>\n+ </requireActiveProfile>\n+ </rules>\n+ </configuration>\n+ </plugin>\n+ <plugin>\n+ <groupId>org.apache.maven.plugins</groupId>\n+ <artifactId>maven-surefire-plugin</artifactId>\n+ <configuration>\n+ <systemPropertyVariables>\n+ <cockroachdb.start-container>${cockroachdb.start-container}</cockroachdb.start-container>\n+\n+ <keycloak.map.storage.connectionsJpa.url>${keycloak.map.storage.connectionsJpa.url}</keycloak.map.storage.connectionsJpa.url>\n+ <keycloak.map.storage.connectionsJpa.user>${keycloak.map.storage.connectionsJpa.user}</keycloak.map.storage.connectionsJpa.user>\n+ <keycloak.map.storage.connectionsJpa.password>${keycloak.map.storage.connectionsJpa.password}</keycloak.map.storage.connectionsJpa.password>\n+\n+ <keycloak.authorization.map.storage.provider>jpa</keycloak.authorization.map.storage.provider>\n+ <keycloak.authSession.map.storage.provider>jpa</keycloak.authSession.map.storage.provider>\n+ <keycloak.client.map.storage.provider>jpa</keycloak.client.map.storage.provider>\n+ <keycloak.clientScope.map.storage.provider>jpa</keycloak.clientScope.map.storage.provider>\n+ <keycloak.adminEventsStore.map.storage.provider>jpa</keycloak.adminEventsStore.map.storage.provider>\n+ <keycloak.authEventsStore.map.storage.provider>jpa</keycloak.authEventsStore.map.storage.provider>\n+ <keycloak.group.map.storage.provider>jpa</keycloak.group.map.storage.provider>\n+ <keycloak.loginFailure.map.storage.provider>jpa</keycloak.loginFailure.map.storage.provider>\n+ <keycloak.realm.map.storage.provider>jpa</keycloak.realm.map.storage.provider>\n+ <keycloak.role.map.storage.provider>jpa</keycloak.role.map.storage.provider>\n+ <keycloak.singleUseObject.map.storage.provider>jpa</keycloak.singleUseObject.map.storage.provider>\n+ <keycloak.user.map.storage.provider>jpa</keycloak.user.map.storage.provider>\n+ <keycloak.userSession.map.storage.provider>jpa</keycloak.userSession.map.storage.provider>\n+ <auth.server.quarkus.mapStorage.profile.config>jpa</auth.server.quarkus.mapStorage.profile.config>\n+ </systemPropertyVariables>\n+ </configuration>\n+ </plugin>\n+ </plugins>\n+ </build>\n+ </profile>\n+\n+\n<profile>\n<id>auth-server-fips140-2</id>\n"
},
{
"change_type": "ADD",
"old_path": null,
"new_path": "testsuite/integration-arquillian/tests/base/src/main/java/org/keycloak/testsuite/arquillian/CockroachdbContainerTestEnricher.java",
"diff": "+/*\n+ * Copyright 2022 Red Hat, Inc. and/or its affiliates\n+ * and other contributors as indicated by the @author tags.\n+ *\n+ * Licensed under the Apache License, Version 2.0 (the \"License\");\n+ * you may not use this file except in compliance with the License.\n+ * You may obtain a copy of the License at\n+ *\n+ * http://www.apache.org/licenses/LICENSE-2.0\n+ *\n+ * Unless required by applicable law or agreed to in writing, software\n+ * distributed under the License is distributed on an \"AS IS\" BASIS,\n+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n+ * See the License for the specific language governing permissions and\n+ * limitations under the License.\n+ */\n+package org.keycloak.testsuite.arquillian;\n+\n+import org.jboss.arquillian.container.spi.event.StartSuiteContainers;\n+import org.jboss.arquillian.core.api.annotation.Observes;\n+import org.jboss.arquillian.test.spi.event.suite.AfterSuite;\n+import org.testcontainers.containers.CockroachContainer;\n+import org.testcontainers.utility.DockerImageName;\n+\n+public class CockroachdbContainerTestEnricher {\n+\n+ private static final Boolean START_CONTAINER = Boolean.valueOf(System.getProperty(\"cockroachdb.start-container\", \"false\"));\n+ private static final String COCKROACHDB_DOCKER_IMAGE_NAME = System.getProperty(\"keycloak.map.storage.cockroachdb.docker.image\", \"cockroachdb/cockroach:v22.1.0\");\n+ private static final CockroachContainer COCKROACHDB_CONTAINER = new CockroachContainer(DockerImageName.parse(COCKROACHDB_DOCKER_IMAGE_NAME).asCompatibleSubstituteFor(\"cockroachdb\"));\n+ private static final String COCKROACHDB_DB_USER = System.getProperty(\"keycloak.map.storage.connectionsJpa.user\", \"keycloak\");\n+\n+ public void beforeContainerStarted(@Observes(precedence = 1) StartSuiteContainers event) {\n+ if (START_CONTAINER) {\n+ COCKROACHDB_CONTAINER\n+ // Using the environment variables for now where using the withXXX() method is not supported, yet.\n+ // https://github.com/testcontainers/testcontainers-java/issues/6299\n+ .withEnv(\"COCKROACH_DATABASE\", \"keycloak\")\n+ .withEnv(\"COCKROACH_USER\", COCKROACHDB_DB_USER)\n+ // password is not used/supported in insecure mode\n+ .withCommand(\"start-single-node\", \"--insecure\")\n+ .start();\n+\n+ System.setProperty(\"keycloak.map.storage.connectionsJpa.url\", COCKROACHDB_CONTAINER.getJdbcUrl());\n+ }\n+ }\n+\n+ public void afterSuite(@Observes(precedence = 4) AfterSuite event) {\n+ if (START_CONTAINER) {\n+ COCKROACHDB_CONTAINER.stop();\n+ }\n+ }\n+}\n"
},
{
"change_type": "MODIFY",
"old_path": "testsuite/integration-arquillian/tests/base/src/main/java/org/keycloak/testsuite/arquillian/KeycloakArquillianExtension.java",
"new_path": "testsuite/integration-arquillian/tests/base/src/main/java/org/keycloak/testsuite/arquillian/KeycloakArquillianExtension.java",
"diff": "@@ -68,6 +68,7 @@ public class KeycloakArquillianExtension implements LoadableExtension {\n.observer(CrossDCTestEnricher.class)\n.observer(HotRodStoreTestEnricher.class)\n.observer(PostgresContainerTestEnricher.class)\n+ .observer(CockroachdbContainerTestEnricher.class)\n.observer(H2TestEnricher.class);\nbuilder\n.service(TestExecutionDecider.class, MigrationTestExecutionDecider.class)\n"
},
{
"change_type": "MODIFY",
"old_path": "testsuite/model/pom.xml",
"new_path": "testsuite/model/pom.xml",
"diff": "</properties>\n</profile>\n+ <profile>\n+ <id>map-jpa-cockroachdb</id>\n+ <properties>\n+ <keycloak.profile.feature.map_storage>enabled</keycloak.profile.feature.map_storage>\n+ <keycloak.model.parameters>Map,JpaMapStorageCockroachdb</keycloak.model.parameters>\n+ </properties>\n+ </profile>\n+\n<profile>\n<id>.asyncProfiler</id>\n<activation>\n"
},
{
"change_type": "ADD",
"old_path": null,
"new_path": "testsuite/model/src/test/java/org/keycloak/testsuite/model/parameters/JpaMapStorageCockroachdb.java",
"diff": "+/*\n+ * Copyright 2022 Red Hat, Inc. and/or its affiliates\n+ * and other contributors as indicated by the @author tags.\n+ *\n+ * Licensed under the Apache License, Version 2.0 (the \"License\");\n+ * you may not use this file except in compliance with the License.\n+ * You may obtain a copy of the License at\n+ *\n+ * http://www.apache.org/licenses/LICENSE-2.0\n+ *\n+ * Unless required by applicable law or agreed to in writing, software\n+ * distributed under the License is distributed on an \"AS IS\" BASIS,\n+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n+ * See the License for the specific language governing permissions and\n+ * limitations under the License.\n+ */\n+package org.keycloak.testsuite.model.parameters;\n+\n+import com.google.common.collect.ImmutableSet;\n+import org.jboss.logging.Logger;\n+import org.keycloak.authorization.store.StoreFactorySpi;\n+import org.keycloak.events.EventStoreSpi;\n+import org.keycloak.models.DeploymentStateSpi;\n+import org.keycloak.models.SingleUseObjectSpi;\n+import org.keycloak.models.UserLoginFailureSpi;\n+import org.keycloak.models.UserSessionSpi;\n+import org.keycloak.models.map.authSession.MapRootAuthenticationSessionProviderFactory;\n+import org.keycloak.models.map.authorization.MapAuthorizationStoreFactory;\n+import org.keycloak.models.map.client.MapClientProviderFactory;\n+import org.keycloak.models.map.clientscope.MapClientScopeProviderFactory;\n+import org.keycloak.models.map.deploymentState.MapDeploymentStateProviderFactory;\n+import org.keycloak.models.map.events.MapEventStoreProviderFactory;\n+import org.keycloak.models.map.group.MapGroupProviderFactory;\n+import org.keycloak.models.map.keys.MapPublicKeyStorageProviderFactory;\n+import org.keycloak.models.map.loginFailure.MapUserLoginFailureProviderFactory;\n+import org.keycloak.models.map.realm.MapRealmProviderFactory;\n+import org.keycloak.models.map.role.MapRoleProviderFactory;\n+import org.keycloak.models.map.singleUseObject.MapSingleUseObjectProviderFactory;\n+import org.keycloak.models.map.storage.MapStorageSpi;\n+import org.keycloak.models.map.storage.chm.ConcurrentHashMapStorageProviderFactory;\n+import org.keycloak.models.map.storage.jpa.JpaMapStorageProviderFactory;\n+import org.keycloak.models.map.storage.jpa.liquibase.connection.MapLiquibaseConnectionProviderFactory;\n+import org.keycloak.models.map.storage.jpa.liquibase.connection.MapLiquibaseConnectionSpi;\n+import org.keycloak.models.map.storage.jpa.updater.MapJpaUpdaterProviderFactory;\n+import org.keycloak.models.map.storage.jpa.updater.MapJpaUpdaterSpi;\n+import org.keycloak.models.map.user.MapUserProviderFactory;\n+import org.keycloak.models.map.userSession.MapUserSessionProviderFactory;\n+import org.keycloak.provider.ProviderFactory;\n+import org.keycloak.provider.Spi;\n+import org.keycloak.sessions.AuthenticationSessionSpi;\n+import org.keycloak.testsuite.model.Config;\n+import org.keycloak.testsuite.model.KeycloakModelParameters;\n+import org.testcontainers.containers.CockroachContainer;\n+import org.testcontainers.utility.DockerImageName;\n+\n+import java.util.Set;\n+\n+public class JpaMapStorageCockroachdb extends KeycloakModelParameters {\n+\n+ private static final Logger LOG = Logger.getLogger(JpaMapStorageCockroachdb.class.getName());\n+\n+ private static final Boolean START_CONTAINER = Boolean.valueOf(System.getProperty(\"cockroachdb.start-container\", \"true\"));\n+ private static final String COCKROACHDB_DOCKER_IMAGE_NAME = System.getProperty(\"keycloak.map.storage.cockroachdb.docker.image\", \"cockroachdb/cockroach:v22.1.0\");\n+ private static final CockroachContainer COCKROACHDB_CONTAINER = new CockroachContainer(DockerImageName.parse(COCKROACHDB_DOCKER_IMAGE_NAME).asCompatibleSubstituteFor(\"cockroachdb\"));\n+ private static final String COCKROACHDB_DB_USER = System.getProperty(\"keycloak.map.storage.connectionsJpa.user\", \"keycloak\");\n+ private static final String COCKROACHDB_DB_PASSWORD = System.getProperty(\"keycloak.map.storage.connectionsJpa.password\", \"pass\");\n+\n+ private static String COCKROACHDB_DB_JDBC_URL = System.getProperty(\"keycloak.map.storage.connectionsJpa.url\");\n+\n+ static final Set<Class<? extends Spi>> ALLOWED_SPIS = ImmutableSet.<Class<? extends Spi>>builder()\n+ .add(MapJpaUpdaterSpi.class)\n+ .add(MapLiquibaseConnectionSpi.class)\n+ .build();\n+\n+ static final Set<Class<? extends ProviderFactory>> ALLOWED_FACTORIES = ImmutableSet.<Class<? extends ProviderFactory>>builder()\n+ .add(ConcurrentHashMapStorageProviderFactory.class)\n+ .add(JpaMapStorageProviderFactory.class)\n+ .add(MapJpaUpdaterProviderFactory.class)\n+ .add(MapLiquibaseConnectionProviderFactory.class)\n+ .build();\n+\n+ public JpaMapStorageCockroachdb() {\n+ super(ALLOWED_SPIS, ALLOWED_FACTORIES);\n+ }\n+\n+ @Override\n+ public void updateConfig(Config cf) {\n+ cf.spi(MapStorageSpi.NAME)\n+ .provider(ConcurrentHashMapStorageProviderFactory.PROVIDER_ID)\n+ .config(\"dir\", \"${project.build.directory:target}\");\n+\n+ cf.spi(MapStorageSpi.NAME)\n+ .provider(JpaMapStorageProviderFactory.PROVIDER_ID)\n+ .config(\"url\", COCKROACHDB_DB_JDBC_URL)\n+ .config(\"user\", COCKROACHDB_DB_USER)\n+ .config(\"password\", COCKROACHDB_DB_PASSWORD)\n+ .config(\"driver\", \"org.postgresql.Driver\")\n+ .config(\"driverDialect\", \"org.keycloak.models.map.storage.jpa.hibernate.dialect.JsonbPostgreSQL95Dialect\");\n+\n+ cf.spi(AuthenticationSessionSpi.PROVIDER_ID).provider(MapRootAuthenticationSessionProviderFactory.PROVIDER_ID) .config(STORAGE_CONFIG, JpaMapStorageProviderFactory.PROVIDER_ID)\n+ .spi(\"client\").provider(MapClientProviderFactory.PROVIDER_ID) .config(STORAGE_CONFIG, JpaMapStorageProviderFactory.PROVIDER_ID)\n+ .spi(\"clientScope\").provider(MapClientScopeProviderFactory.PROVIDER_ID) .config(STORAGE_CONFIG, JpaMapStorageProviderFactory.PROVIDER_ID)\n+ .spi(\"group\").provider(MapGroupProviderFactory.PROVIDER_ID) .config(STORAGE_CONFIG, JpaMapStorageProviderFactory.PROVIDER_ID)\n+ .spi(\"realm\").provider(MapRealmProviderFactory.PROVIDER_ID) .config(STORAGE_CONFIG, JpaMapStorageProviderFactory.PROVIDER_ID)\n+ .spi(\"role\").provider(MapRoleProviderFactory.PROVIDER_ID) .config(STORAGE_CONFIG, JpaMapStorageProviderFactory.PROVIDER_ID)\n+ .spi(DeploymentStateSpi.NAME).provider(MapDeploymentStateProviderFactory.PROVIDER_ID) .config(STORAGE_CONFIG, ConcurrentHashMapStorageProviderFactory.PROVIDER_ID)\n+ .spi(StoreFactorySpi.NAME).provider(MapAuthorizationStoreFactory.PROVIDER_ID) .config(STORAGE_CONFIG, JpaMapStorageProviderFactory.PROVIDER_ID)\n+ .spi(\"user\").provider(MapUserProviderFactory.PROVIDER_ID) .config(STORAGE_CONFIG, JpaMapStorageProviderFactory.PROVIDER_ID)\n+ .spi(UserLoginFailureSpi.NAME).provider(MapUserLoginFailureProviderFactory.PROVIDER_ID) .config(STORAGE_CONFIG, JpaMapStorageProviderFactory.PROVIDER_ID)\n+ .spi(SingleUseObjectSpi.NAME).provider(MapSingleUseObjectProviderFactory.PROVIDER_ID) .config(STORAGE_CONFIG, JpaMapStorageProviderFactory.PROVIDER_ID)\n+ .spi(\"publicKeyStorage\").provider(MapPublicKeyStorageProviderFactory.PROVIDER_ID) .config(STORAGE_CONFIG, ConcurrentHashMapStorageProviderFactory.PROVIDER_ID)\n+ .spi(UserSessionSpi.NAME).provider(MapUserSessionProviderFactory.PROVIDER_ID) .config(STORAGE_CONFIG, JpaMapStorageProviderFactory.PROVIDER_ID)\n+ .spi(EventStoreSpi.NAME).provider(MapEventStoreProviderFactory.PROVIDER_ID) .config(\"storage-admin-events.provider\", JpaMapStorageProviderFactory.PROVIDER_ID)\n+ .config(\"storage-auth-events.provider\", JpaMapStorageProviderFactory.PROVIDER_ID);\n+ }\n+\n+ @Override\n+ public void beforeSuite(Config cf) {\n+ if (START_CONTAINER) {\n+ COCKROACHDB_CONTAINER\n+ // Using the environment variables for now where using the withXXX() method is not supported, yet.\n+ // https://github.com/testcontainers/testcontainers-java/issues/6299\n+ .withEnv(\"COCKROACH_DATABASE\", \"keycloak\")\n+ .withEnv(\"COCKROACH_USER\", COCKROACHDB_DB_USER)\n+ // password is not used/supported in insecure mode\n+ .withCommand(\"start-single-node\", \"--insecure\")\n+ .start();\n+\n+ COCKROACHDB_DB_JDBC_URL = COCKROACHDB_CONTAINER.getJdbcUrl();\n+ }\n+ }\n+\n+ @Override\n+ public void afterSuite() {\n+ if (START_CONTAINER) {\n+ COCKROACHDB_CONTAINER.stop();\n+ }\n+ }\n+}\n"
}
] | Java | Apache License 2.0 | keycloak/keycloak | Adding CRDB into GHA for the new store (#16021)
The CockroachDB database is slower than PostgreSQL, therefore it will only run branches and nightly builds.
Closes #16020 |
339,410 | 15.12.2022 10:14:30 | -3,600 | 6d0e112bf1d5363825ec6072d6f151f8e8ac7234 | Ensure lock table has its primary key created, and re-enable the DBLockTest
Closes | [
{
"change_type": "MODIFY",
"old_path": "model/jpa/src/main/java/org/keycloak/connections/jpa/updater/liquibase/lock/CustomLockService.java",
"new_path": "model/jpa/src/main/java/org/keycloak/connections/jpa/updater/liquibase/lock/CustomLockService.java",
"diff": "@@ -24,11 +24,18 @@ import liquibase.exception.UnexpectedLiquibaseException;\nimport liquibase.executor.Executor;\nimport liquibase.executor.ExecutorService;\nimport liquibase.lockservice.StandardLockService;\n+import liquibase.snapshot.DatabaseSnapshot;\n+import liquibase.snapshot.InvalidExampleException;\n+import liquibase.snapshot.SnapshotControl;\n+import liquibase.snapshot.SnapshotGeneratorFactory;\nimport liquibase.statement.core.CreateDatabaseChangeLogLockTableStatement;\nimport liquibase.statement.core.DropTableStatement;\nimport liquibase.statement.core.InitializeDatabaseChangeLogLockTableStatement;\nimport liquibase.statement.core.LockDatabaseChangeLogStatement;\nimport liquibase.statement.core.RawSqlStatement;\n+import liquibase.structure.core.PrimaryKey;\n+import liquibase.structure.core.Schema;\n+import liquibase.structure.core.Table;\nimport org.jboss.logging.Logger;\nimport org.keycloak.common.util.Time;\nimport org.keycloak.common.util.reflections.Reflections;\n@@ -52,6 +59,41 @@ public class CustomLockService extends StandardLockService {\nprivate static final Logger log = Logger.getLogger(CustomLockService.class);\n+ @Override\n+ protected boolean hasDatabaseChangeLogLockTable() throws DatabaseException {\n+ boolean originalReturnValue = super.hasDatabaseChangeLogLockTable();\n+ if (originalReturnValue && database.getConnection().getDatabaseProductName().equals(\"H2\")) {\n+ /* Liquibase only checks that the table exists. On the H2 database, creation of a table with a primary key is not atomic,\n+ and the primary key might not be visible yet. The primary key would be needed to prevent inserting the data into the table\n+ a second time. Inserting it a second time might lead to a failure when creating the primary key, which would then roll back\n+ the creation of the table. Therefore, at least on the H2 database, checking for the primary key is essential.\n+\n+ An existing DATABASECHANGELOG might indicate that the insertion of data was completed previously.\n+ Still, this isn't working with the DBLockTest which deletes only the DATABASECHANGELOGLOCK table.\n+\n+ See https://github.com/keycloak/keycloak/issues/15487 for more information.\n+ */\n+ Table lockTable = (Table) new Table().setName(database.getDatabaseChangeLogLockTableName()).setSchema(\n+ new Schema(database.getLiquibaseCatalogName(), database.getLiquibaseSchemaName()));\n+ SnapshotGeneratorFactory instance = SnapshotGeneratorFactory.getInstance();\n+\n+ try {\n+ DatabaseSnapshot snapshot = instance.createSnapshot(lockTable.getSchema().toCatalogAndSchema(), database,\n+ new SnapshotControl(database, false, Table.class, PrimaryKey.class).setWarnIfObjectNotFound(false));\n+ Table lockTableFromSnapshot = snapshot.get(lockTable);\n+ if (lockTableFromSnapshot == null) {\n+ throw new RuntimeException(\"DATABASECHANGELOGLOCK not found, although Liquibase claims it exists.\");\n+ } else if (lockTableFromSnapshot.getPrimaryKey() == null) {\n+ log.warn(\"Primary key not found - table creation not complete yet.\");\n+ return false;\n+ }\n+ } catch (InvalidExampleException e) {\n+ throw new RuntimeException(e);\n+ }\n+ }\n+ return originalReturnValue;\n+ }\n+\n@Override\npublic void init() throws DatabaseException {\nExecutor executor = Scope.getCurrentScope().getSingleton(ExecutorService.class).getExecutor(LiquibaseConstants.JDBC_EXECUTOR, database);\n@@ -65,7 +107,7 @@ public class CustomLockService extends StandardLockService {\nexecutor.execute(new CreateDatabaseChangeLogLockTableStatement());\ndatabase.commit();\n} catch (DatabaseException de) {\n- log.warn(\"Failed to create lock table. Maybe other transaction created in the meantime. Retrying...\");\n+ log.warn(\"Failed to create lock table. Maybe other transaction created in the meantime. Retrying...\", de);\nif (log.isTraceEnabled()) {\nlog.trace(de.getMessage(), de); //Log details at trace level\n}\n@@ -97,7 +139,7 @@ public class CustomLockService extends StandardLockService {\n}\n} catch (DatabaseException de) {\n- log.warn(\"Failed to insert first record to the lock table. Maybe other transaction inserted in the meantime. Retrying...\");\n+ log.warn(\"Failed to insert first record to the lock table. Maybe other transaction inserted in the meantime. Retrying...\", de);\nif (log.isTraceEnabled()) {\nlog.trace(de.getMessage(), de); // Log details at trace level\n}\n@@ -212,7 +254,7 @@ public class CustomLockService extends StandardLockService {\nreturn true;\n} catch (DatabaseException de) {\n- log.warn(\"Lock didn't yet acquired. Will possibly retry to acquire lock. Details: \" + de.getMessage());\n+ log.warn(\"Lock didn't yet acquired. Will possibly retry to acquire lock. Details: \" + de.getMessage(), de);\nif (log.isTraceEnabled()) {\nlog.debug(de.getMessage(), de);\n}\n"
},
{
"change_type": "MODIFY",
"old_path": "testsuite/model/src/test/java/org/keycloak/testsuite/model/DBLockTest.java",
"new_path": "testsuite/model/src/test/java/org/keycloak/testsuite/model/DBLockTest.java",
"diff": "@@ -23,7 +23,6 @@ import java.util.concurrent.atomic.AtomicInteger;\nimport org.jboss.logging.Logger;\nimport org.junit.Assert;\nimport org.junit.Before;\n-import org.junit.Ignore;\nimport org.junit.Test;\nimport org.keycloak.models.KeycloakSession;\nimport org.keycloak.models.KeycloakSessionFactory;\n@@ -108,7 +107,6 @@ public class DBLockTest extends KeycloakModelTest {\n}\n@Test\n- @Ignore(\"Ignored as it is unstable. Analysis pending in https://github.com/keycloak/keycloak/issues/15487\")\npublic void testLockConcurrentlyGeneral() throws Exception {\ninComittedTransaction(1, (session , i) -> {\ntestLockConcurrentlyInternal(session, DBLockProvider.Namespace.DATABASE);\n@@ -117,7 +115,6 @@ public class DBLockTest extends KeycloakModelTest {\n}\n@Test\n- @Ignore(\"Ignored as it is unstable. Analysis pending in https://github.com/keycloak/keycloak/issues/15487\")\npublic void testLockConcurrentlyOffline() throws Exception {\ninComittedTransaction(1, (session , i) -> {\ntestLockConcurrentlyInternal(session, DBLockProvider.Namespace.OFFLINE_SESSIONS);\n"
}
] | Java | Apache License 2.0 | keycloak/keycloak | Ensure lock table has its primary key created, and re-enable the DBLockTest
Closes #15487 |
339,410 | 15.12.2022 10:14:30 | -3,600 | 0fee33bb95150d6e14b228da716c14ca06e820da | Normalize JVM heap usage in tests and handle OOM situations
Closes | [
{
"change_type": "ADD",
"old_path": null,
"new_path": ".github/actions/upload-heapdumps/action.yml",
"diff": "+name: Upload JVM Heapdumps\n+description: Upload JVM Heapdumps\n+\n+runs:\n+ using: composite\n+ steps:\n+ - id: upload-jvm-heapdumps\n+ name: Upload JVM Heapdumps\n+ uses: actions/upload-artifact@v3\n+ with:\n+ name: jvm-heap-dumps\n+ path: '**/java_pid*.hprof'\n"
},
{
"change_type": "MODIFY",
"old_path": ".github/workflows/ci.yml",
"new_path": ".github/workflows/ci.yml",
"diff": "@@ -58,6 +58,10 @@ jobs:\n./mvnw test -nsu -B -pl \"$PROJECTS\" -am\n+ - name: Upload JVM Heapdumps\n+ if: always()\n+ uses: ./.github/actions/upload-heapdumps\n+\n- id: upload-surefire-reports\nname: Upload Surefire reports\nuses: ./.github/actions/upload-surefire-reports\n@@ -88,6 +92,10 @@ jobs:\necho \"Tests: $TESTS\"\n./mvnw test -Dsurefire.rerunFailingTestsCount=${{ env.SUREFIRE_RERUN_FAILING_COUNT }} -nsu -B -Pauth-server-quarkus -Dtest=$TESTS -pl testsuite/integration-arquillian/tests/base | misc/log/trimmer.sh\n+ - name: Upload JVM Heapdumps\n+ if: always()\n+ uses: ./.github/actions/upload-heapdumps\n+\n- id: upload-surefire-reports\nname: Upload Surefire reports\nuses: ./.github/actions/upload-surefire-reports\n@@ -128,6 +136,10 @@ jobs:\n./mvnw install -nsu -B -pl quarkus/tests/integration -am -DskipTests\n./mvnw test -nsu -B -pl quarkus/tests/integration ${PARAMS[\"${{ matrix.server }}\"]} | misc/log/trimmer.sh\n+ - name: Upload JVM Heapdumps\n+ if: always()\n+ uses: ./.github/actions/upload-heapdumps\n+\n- id: upload-surefire-reports\nname: Upload Surefire reports\nuses: ./.github/actions/upload-surefire-reports\n@@ -165,6 +177,10 @@ jobs:\necho \"Tests: $TESTS\"\n./mvnw test -nsu -B -Pauth-server-quarkus -Dtest=$TESTS -pl testsuite/integration-arquillian/tests/base | misc/log/trimmer.sh\n+ - name: Upload JVM Heapdumps\n+ if: always()\n+ uses: ./.github/actions/upload-heapdumps\n+\n- id: upload-surefire-reports\nname: Upload Surefire reports\nuses: ./.github/actions/upload-surefire-reports\n@@ -218,6 +234,10 @@ jobs:\necho \"Tests: $TESTS\"\n./mvnw test -nsu -B -Pauth-server-quarkus ${PARAMS[\"${{ matrix.db }}\"]} -Dtest=$TESTS -pl testsuite/integration-arquillian/tests/base | misc/log/trimmer.sh\n+ - name: Upload JVM Heapdumps\n+ if: always()\n+ uses: ./.github/actions/upload-heapdumps\n+\n- id: upload-surefire-reports\nname: Upload Surefire reports\nuses: ./.github/actions/upload-surefire-reports\n@@ -248,6 +268,10 @@ jobs:\necho \"Tests: $TESTS\"\n./mvnw test -nsu -B -Pauth-server-quarkus -Pdb-${{ matrix.db }} -Dtest=$TESTS -pl testsuite/integration-arquillian/tests/base | misc/log/trimmer.sh\n+ - name: Upload JVM Heapdumps\n+ if: always()\n+ uses: ./.github/actions/upload-heapdumps\n+\n- id: upload-surefire-reports\nname: Upload Surefire reports\nuses: ./.github/actions/upload-surefire-reports\n@@ -271,6 +295,10 @@ jobs:\n- name: Run model tests\nrun: testsuite/model/test-all-profiles.sh\n+ - name: Upload JVM Heapdumps\n+ if: always()\n+ uses: ./.github/actions/upload-heapdumps\n+\nclustering-integration-tests:\nname: Legacy Clustering IT\nneeds: build\n@@ -289,6 +317,10 @@ jobs:\nrun: |\n./mvnw test -nsu -B -Pauth-server-cluster-quarkus -Dsession.cache.owners=2 -Dtest=**.cluster.** -pl testsuite/integration-arquillian/tests/base | misc/log/trimmer.sh\n+ - name: Upload JVM Heapdumps\n+ if: always()\n+ uses: ./.github/actions/upload-heapdumps\n+\n- id: upload-surefire-reports\nname: Upload Surefire reports\nuses: ./.github/actions/upload-surefire-reports\n@@ -315,6 +347,10 @@ jobs:\n- name: Run crypto tests (BCFIPS approved mode)\nrun: ./mvnw test -nsu -B -am -pl crypto/default,crypto/fips1402,crypto/elytron -Dcom.redhat.fips=true -Dorg.bouncycastle.fips.approved_only=true\n+ - name: Upload JVM Heapdumps\n+ if: always()\n+ uses: ./.github/actions/upload-heapdumps\n+\n- id: upload-surefire-reports\nname: Upload Surefire reports\nuses: ./.github/actions/upload-surefire-reports\n@@ -344,6 +380,10 @@ jobs:\necho \"Tests: $TESTS\"\n./mvnw test -nsu -B -Pauth-server-quarkus,auth-server-fips140-2 -Dtest=$TESTS -pl testsuite/integration-arquillian/tests/base | misc/log/trimmer.sh\n+ - name: Upload JVM Heapdumps\n+ if: always()\n+ uses: ./.github/actions/upload-heapdumps\n+\n- id: upload-surefire-reports\nname: Upload Surefire reports\nuses: ./.github/actions/upload-surefire-reports\n"
},
{
"change_type": "MODIFY",
"old_path": "pom.xml",
"new_path": "pom.xml",
"diff": "<version>${surefire-plugin.version}</version>\n<configuration>\n<forkMode>once</forkMode>\n- <argLine>-Djava.awt.headless=true ${surefire.memory.settings} ${surefire.system.args} -Duser.language=en -Duser.region=US</argLine>\n+ <argLine>-Djava.awt.headless=true ${surefire.memory.settings} ${surefire.system.args} -Duser.language=en -Duser.region=US -XX:+ExitOnOutOfMemoryError -XX:+HeapDumpOnOutOfMemoryError</argLine>\n<runOrder>alphabetical</runOrder>\n<failIfNoSpecifiedTests>false</failIfNoSpecifiedTests>\n</configuration>\n"
},
{
"change_type": "MODIFY",
"old_path": "quarkus/tests/integration/pom.xml",
"new_path": "quarkus/tests/integration/pom.xml",
"diff": "<groupId>org.apache.maven.plugins</groupId>\n<artifactId>maven-surefire-plugin</artifactId>\n<configuration>\n- <argLine>-Djdk.net.hosts.file=${project.build.testOutputDirectory}/hosts_file</argLine>\n+ <argLine>-Djdk.net.hosts.file=${project.build.testOutputDirectory}/hosts_file -XX:+ExitOnOutOfMemoryError -XX:+HeapDumpOnOutOfMemoryError</argLine>\n<systemPropertyVariables>\n<kc.quarkus.tests.dist>${kc.quarkus.tests.dist}</kc.quarkus.tests.dist>\n</systemPropertyVariables>\n<groupId>org.apache.maven.plugins</groupId>\n<artifactId>maven-surefire-plugin</artifactId>\n<configuration>\n- <argLine>-Xmx1024m -XX:MaxMetaspaceSize=512m</argLine>\n+ <argLine>-Xmx1024m -XX:MaxMetaspaceSize=512m -XX:+ExitOnOutOfMemoryError -XX:+HeapDumpOnOutOfMemoryError</argLine>\n<systemPropertyVariables>\n<kc.test.storage.database>true</kc.test.storage.database>\n<!--DB Container -->\n"
},
{
"change_type": "MODIFY",
"old_path": "saml-core/pom.xml",
"new_path": "saml-core/pom.xml",
"diff": "<id>with-security-manager-all-permissions</id>\n<goals><goal>test</goal></goals>\n<configuration>\n- <argLine>-Dmaven.basedir=${basedir} -Djava.security.manager -Djava.security.policy=${basedir}/src/test/resources/all-permissions.policy</argLine>\n+ <argLine>-Dmaven.basedir=${basedir} -Djava.security.manager -Djava.security.policy=${basedir}/src/test/resources/all-permissions.policy -XX:+ExitOnOutOfMemoryError -XX:+HeapDumpOnOutOfMemoryError</argLine>\n<test>SecurityActionsTest</test>\n<skip>${skip.security-manager.tests}</skip>\n</configuration>\n<id>with-security-manager-named-permissions</id>\n<goals><goal>test</goal></goals>\n<configuration>\n- <argLine>-Djava.security.debug=access -Dmaven.basedir=${basedir} -Djava.security.manager -Djava.security.policy=${basedir}/src/test/resources/named-permissions.policy</argLine>\n+ <argLine>-Djava.security.debug=access -Dmaven.basedir=${basedir} -Djava.security.manager -Djava.security.policy=${basedir}/src/test/resources/named-permissions.policy -XX:+ExitOnOutOfMemoryError -XX:+HeapDumpOnOutOfMemoryError</argLine>\n<test>SecurityActionsTest</test>\n<skip>${skip.security-manager.tests}</skip>\n</configuration>\n"
},
{
"change_type": "MODIFY",
"old_path": "server-spi-private/pom.xml",
"new_path": "server-spi-private/pom.xml",
"diff": "<exclude/>\n</excludes>\n<!-- Surefire misses to pass on correct encoding to forked JVM, even though encoding is set correct. -->\n- <argLine>-Dfile.encoding=UTF-8</argLine>\n+ <!-- https://issues.apache.org/jira/browse/SUREFIRE-951 -->\n+ <argLine>-Dfile.encoding=UTF-8 -XX:+ExitOnOutOfMemoryError -XX:+HeapDumpOnOutOfMemoryError</argLine>\n</configuration>\n</plugin>\n</plugins>\n"
},
{
"change_type": "MODIFY",
"old_path": "testsuite/model/pom.xml",
"new_path": "testsuite/model/pom.xml",
"diff": "<groupId>org.apache.maven.plugins</groupId>\n<artifactId>maven-surefire-plugin</artifactId>\n<configuration>\n- <argLine>@{argLine}</argLine>\n+ <argLine>@{argLine} -Xmx1024m -XX:+ExitOnOutOfMemoryError -XX:+HeapDumpOnOutOfMemoryError</argLine>\n<systemPropertyVariables>\n<!-- keycloak.model.parameters lists parameter classes from\norg.keycloak.model.parameters package and determine enabled providers -->\n"
}
] | Java | Apache License 2.0 | keycloak/keycloak | Normalize JVM heap usage in tests and handle OOM situations
Closes #16089 |
339,179 | 16.12.2022 18:55:31 | -3,600 | c79d29e68c0d2fa88e0733b7f75b37e8f95f0788 | Move HotRod profile to the same pom as other map profiles and introduce map-storage-chm profile
Closes | [
{
"change_type": "MODIFY",
"old_path": ".github/workflows/ci.yml",
"new_path": ".github/workflows/ci.yml",
"diff": "@@ -225,10 +225,10 @@ jobs:\n- name: Run base tests\nrun: |\ndeclare -A PARAMS\n- PARAMS[\"chm\"]=\"-Pmap-storage -Dpageload.timeout=90000\"\n- PARAMS[\"hot-rod\"]=\"-Pmap-storage,map-storage-hot-rod -Dpageload.timeout=90000\"\n- PARAMS[\"jpa-postgres\"]=\"-Pmap-storage,map-storage-jpa-postgres -Dpageload.timeout=90000\"\n- PARAMS[\"jpa-cockroach\"]=\"-Pmap-storage,map-storage-jpa-cockroach -Dpageload.timeout=90000\"\n+ PARAMS[\"chm\"]=\"-Pmap-storage-chm -Dpageload.timeout=90000\"\n+ PARAMS[\"hot-rod\"]=\"-Pmap-storage-hot-rod -Dpageload.timeout=90000\"\n+ PARAMS[\"jpa-postgres\"]=\"-Pmap-storage-jpa-postgres -Dpageload.timeout=90000\"\n+ PARAMS[\"jpa-cockroach\"]=\"-Pmap-storage-jpa-cockroach -Dpageload.timeout=90000\"\nTESTS=`testsuite/integration-arquillian/tests/base/testsuites/suite.sh database`\necho \"Tests: $TESTS\"\n"
},
{
"change_type": "MODIFY",
"old_path": "model/map-hot-rod/src/main/java/org/keycloak/models/map/storage/hotRod/HotRodMapStorage.java",
"new_path": "model/map-hot-rod/src/main/java/org/keycloak/models/map/storage/hotRod/HotRodMapStorage.java",
"diff": "@@ -195,8 +195,10 @@ public class HotRodMapStorage<K, E extends AbstractHotRodEntity, V extends Abstr\nQueryFactory queryFactory = Search.getQueryFactory(remoteCache);\n- Query<Object[]> query = paginateQuery(queryFactory.create(queryString), queryParameters.getOffset(),\n- queryParameters.getLimit());\n+ if (queryParameters.getLimit() != null || queryParameters.getOffset() != null) {\n+ throw new IllegalArgumentException(\"HotRod storage does not support pagination for delete query\");\n+ }\n+ Query<Object[]> query = queryFactory.create(queryString);\nquery.setParameters(iqmcb.getParameters());\n"
},
{
"change_type": "MODIFY",
"old_path": "model/map-hot-rod/src/main/java/org/keycloak/models/map/storage/hotRod/common/HotRodUtils.java",
"new_path": "model/map-hot-rod/src/main/java/org/keycloak/models/map/storage/hotRod/common/HotRodUtils.java",
"diff": "@@ -22,7 +22,7 @@ import org.infinispan.query.dsl.Query;\n* @author <a href=\"mailto:mkanis@redhat.com\">Martin Kanis</a>\n*/\npublic class HotRodUtils {\n-\n+ public static final int DEFAULT_MAX_RESULTS = Integer.MAX_VALUE >> 1;\npublic static <T> Query<T> paginateQuery(Query<T> query, Integer first, Integer max) {\nif (first != null && first > 0) {\nquery = query.startOffset(first);\n@@ -30,6 +30,10 @@ public class HotRodUtils {\nif (max != null && max >= 0) {\nquery = query.maxResults(max);\n+ } else {\n+ // Infinispan uses default max value equal to 100\n+ // We need to change this to support more returned values\n+ query = query.maxResults(DEFAULT_MAX_RESULTS);\n}\nreturn query;\n"
},
{
"change_type": "MODIFY",
"old_path": "testsuite/integration-arquillian/HOW-TO-RUN.md",
"new_path": "testsuite/integration-arquillian/HOW-TO-RUN.md",
"diff": "@@ -832,7 +832,7 @@ we rely on [nip.io](https://nip.io) for DNS switching, so tests will work everyw\nTo run base testsuite with new storage run the following command (this will execute testsuite with ConcurrentHashMap storage):\n```shell\nmvn clean install -f testsuite/integration-arquillian/tests/base \\\n- -Pauth-server-quarkus -Pmap-storage\n+ -Pauth-server-quarkus -Pmap-storage-chm\n```\n### Running tests with JPA Map storage\n@@ -849,7 +849,7 @@ version, use the system property `keycloak.map.storage.cockroachdb.docker.image`\nExecute tests:\n```shell\nmvn clean install -f testsuite/integration-arquillian/tests/base \\\n- -Pmap-storage,map-storage-jpa-postgres\n+ -Pmap-storage-jpa-postgres\n```\nIt's also possible to configure tests to connect to an external database, it might be useful\n@@ -864,7 +864,7 @@ podman run --name postgres -p 5432:5432 -e POSTGRES_PASSWORD=pass -e POSTGRES_US\nTo run the tests without spawning the container for you, execute tests with the following command:\n```shell\nmvn clean install -f testsuite/integration-arquillian/tests/base \\\n- -Pmap-storage,map-storage-jpa-postgres \\\n+ -Pmap-storage-jpa-postgres \\\n-Dpostgres.start-container=false \\\n-Dkeycloak.map.storage.connectionsJpa.url=<jdbc_url> \\\n-Dkeycloak.map.storage.connectionsJpa.user=<user> \\\n@@ -877,7 +877,7 @@ By default, Base testsuite with `map-storage-hotrod` profile spawn a new Infinis\nwith each test execution. To run the tests execute:\n```shell\nmvn clean install -f testsuite/integration-arquillian/tests/base \\\n- -Pmap-storage,map-storage-hotrod\n+ -Pmap-storage-hotrod\n```\nNote: For running Infinispan server we are using Testcontainer, see section\n_Usage of Testcontainers_ for details on how to set up your container engine.\n@@ -887,7 +887,7 @@ connect to an external instance of Infinispan. To do so, execute tests with\nthe following command:\n```shell\nmvn clean install -f testsuite/integration-arquillian/tests/base \\\n- -Pmap-storage,map-storage-hotrod\n+ -Pmap-storage-hotrod\n-Dkeycloak.testsuite.start-hotrod-container=false \\\n-Dkeycloak.connectionsHotRod.host=<host> \\\n-Dkeycloak.connectionsHotRod.port=<port> \\\n"
},
{
"change_type": "MODIFY",
"old_path": "testsuite/integration-arquillian/tests/base/pom.xml",
"new_path": "testsuite/integration-arquillian/tests/base/pom.xml",
"diff": "</build>\n</profile>\n<profile>\n- <id>map-storage</id>\n+ <id>map-storage-chm</id>\n<build>\n<plugins>\n<plugin>\n<artifactId>maven-surefire-plugin</artifactId>\n<configuration>\n<systemPropertyVariables>\n+ <!--\n+ The following properties needs to be synchronized across all map-storage profiles\n+ -->\n<keycloak.profile.feature.map_storage>enabled</keycloak.profile.feature.map_storage>\n- <keycloak.mapStorage.provider>concurrenthashmap</keycloak.mapStorage.provider>\n<keycloak.globalLock.provider>none</keycloak.globalLock.provider>\n<keycloak.realm.provider>map</keycloak.realm.provider>\n<keycloak.client.provider>map</keycloak.client.provider>\n<keycloak.publicKeyCache.enabled>false</keycloak.publicKeyCache.enabled>\n<keycloak.userSessionPersister.provider></keycloak.userSessionPersister.provider>\n<keycloak.userFederatedStorage.provider></keycloak.userFederatedStorage.provider>\n+ <!--\n+ The end of the block synchronized across all map-storage profiles\n+ -->\n+ <keycloak.mapStorage.provider>concurrenthashmap</keycloak.mapStorage.provider>\n<auth.server.quarkus.mapStorage.profile.config>chm</auth.server.quarkus.mapStorage.profile.config>\n</systemPropertyVariables>\n</configuration>\n</plugins>\n</build>\n</profile>\n-\n<profile>\n<id>map-storage-jpa-postgres</id>\n<properties>\n</properties>\n<build>\n<plugins>\n- <plugin>\n- <artifactId>maven-enforcer-plugin</artifactId>\n- <goals>\n- <goal>enforce</goal>\n- </goals>\n- <configuration>\n- <rules>\n- <requireActiveProfile>\n- <profiles>map-storage</profiles>\n- <message>map-storage profile not active</message>\n- </requireActiveProfile>\n- </rules>\n- </configuration>\n- </plugin>\n<plugin>\n<groupId>org.apache.maven.plugins</groupId>\n<artifactId>maven-surefire-plugin</artifactId>\n<configuration>\n<systemPropertyVariables>\n+ <!--\n+ The following properties needs to be synchronized across all map-storage profiles\n+ -->\n+ <keycloak.profile.feature.map_storage>enabled</keycloak.profile.feature.map_storage>\n+ <keycloak.globalLock.provider>none</keycloak.globalLock.provider>\n+ <keycloak.realm.provider>map</keycloak.realm.provider>\n+ <keycloak.client.provider>map</keycloak.client.provider>\n+ <keycloak.clientScope.provider>map</keycloak.clientScope.provider>\n+ <keycloak.group.provider>map</keycloak.group.provider>\n+ <keycloak.role.provider>map</keycloak.role.provider>\n+ <keycloak.user.provider>map</keycloak.user.provider>\n+ <keycloak.deploymentState.provider>map</keycloak.deploymentState.provider>\n+ <keycloak.authSession.provider>map</keycloak.authSession.provider>\n+ <keycloak.userSession.provider>map</keycloak.userSession.provider>\n+ <keycloak.loginFailure.provider>map</keycloak.loginFailure.provider>\n+ <keycloak.authorization.provider>map</keycloak.authorization.provider>\n+ <keycloak.eventsStore.provider>map</keycloak.eventsStore.provider>\n+ <keycloak.singleUseObject.provider>map</keycloak.singleUseObject.provider>\n+ <keycloak.publicKeyStorage.provider>map</keycloak.publicKeyStorage.provider>\n+ <keycloak.authorizationCache.enabled>false</keycloak.authorizationCache.enabled>\n+ <keycloak.realmCache.enabled>false</keycloak.realmCache.enabled>\n+ <keycloak.userCache.enabled>false</keycloak.userCache.enabled>\n+ <keycloak.publicKeyCache.enabled>false</keycloak.publicKeyCache.enabled>\n+ <keycloak.userSessionPersister.provider></keycloak.userSessionPersister.provider>\n+ <keycloak.userFederatedStorage.provider></keycloak.userFederatedStorage.provider>\n+ <!--\n+ The end of the block synchronized across all map-storage profiles\n+ -->\n<postgres.start-container>${postgres.start-container}</postgres.start-container>\n<keycloak.map.storage.connectionsJpa.url>${keycloak.map.storage.connectionsJpa.url}</keycloak.map.storage.connectionsJpa.url>\n</profile>\n<profile>\n- <id>map-storage-jpa-cockroach</id>\n+ <id>map-storage-hot-rod</id>\n<properties>\n- <cockroachdb.start-container>true</cockroachdb.start-container>\n- <keycloak.map.storage.connectionsJpa.url>jdbc:postgresql://localhost:26257/keycloak</keycloak.map.storage.connectionsJpa.url>\n+ <keycloak.testsuite.start-hotrod-container>true</keycloak.testsuite.start-hotrod-container>\n</properties>\n<build>\n<plugins>\n<plugin>\n- <artifactId>maven-enforcer-plugin</artifactId>\n- <goals>\n- <goal>enforce</goal>\n- </goals>\n+ <groupId>org.apache.maven.plugins</groupId>\n+ <artifactId>maven-surefire-plugin</artifactId>\n<configuration>\n- <rules>\n- <requireActiveProfile>\n- <profiles>map-storage</profiles>\n- <message>map-storage profile not active</message>\n- </requireActiveProfile>\n- </rules>\n+ <systemPropertyVariables>\n+ <!--\n+ The following properties needs to be synchronized across all map-storage profiles\n+ -->\n+ <keycloak.profile.feature.map_storage>enabled</keycloak.profile.feature.map_storage>\n+ <keycloak.globalLock.provider>none</keycloak.globalLock.provider>\n+ <keycloak.realm.provider>map</keycloak.realm.provider>\n+ <keycloak.client.provider>map</keycloak.client.provider>\n+ <keycloak.clientScope.provider>map</keycloak.clientScope.provider>\n+ <keycloak.group.provider>map</keycloak.group.provider>\n+ <keycloak.role.provider>map</keycloak.role.provider>\n+ <keycloak.user.provider>map</keycloak.user.provider>\n+ <keycloak.deploymentState.provider>map</keycloak.deploymentState.provider>\n+ <keycloak.authSession.provider>map</keycloak.authSession.provider>\n+ <keycloak.userSession.provider>map</keycloak.userSession.provider>\n+ <keycloak.loginFailure.provider>map</keycloak.loginFailure.provider>\n+ <keycloak.authorization.provider>map</keycloak.authorization.provider>\n+ <keycloak.eventsStore.provider>map</keycloak.eventsStore.provider>\n+ <keycloak.singleUseObject.provider>map</keycloak.singleUseObject.provider>\n+ <keycloak.publicKeyStorage.provider>map</keycloak.publicKeyStorage.provider>\n+ <keycloak.authorizationCache.enabled>false</keycloak.authorizationCache.enabled>\n+ <keycloak.realmCache.enabled>false</keycloak.realmCache.enabled>\n+ <keycloak.userCache.enabled>false</keycloak.userCache.enabled>\n+ <keycloak.publicKeyCache.enabled>false</keycloak.publicKeyCache.enabled>\n+ <keycloak.userSessionPersister.provider></keycloak.userSessionPersister.provider>\n+ <keycloak.userFederatedStorage.provider></keycloak.userFederatedStorage.provider>\n+ <!--\n+ The end of the block synchronized across all map-storage profiles\n+ -->\n+ <keycloak.authSession.map.storage.provider>hotrod</keycloak.authSession.map.storage.provider>\n+ <keycloak.client.map.storage.provider>hotrod</keycloak.client.map.storage.provider>\n+ <keycloak.clientScope.map.storage.provider>hotrod</keycloak.clientScope.map.storage.provider>\n+ <keycloak.group.map.storage.provider>hotrod</keycloak.group.map.storage.provider>\n+ <keycloak.role.map.storage.provider>hotrod</keycloak.role.map.storage.provider>\n+ <keycloak.user.map.storage.provider>hotrod</keycloak.user.map.storage.provider>\n+ <keycloak.loginFailure.map.storage.provider>hotrod</keycloak.loginFailure.map.storage.provider>\n+ <keycloak.realm.map.storage.provider>hotrod</keycloak.realm.map.storage.provider>\n+ <keycloak.userSession.map.storage.provider>hotrod</keycloak.userSession.map.storage.provider>\n+ <keycloak.authorization.map.storage.provider>hotrod</keycloak.authorization.map.storage.provider>\n+ <keycloak.eventStore.map.storage.provider>hotrod</keycloak.eventStore.map.storage.provider>\n+ <keycloak.singleUseObject.map.storage.provider>hotrod</keycloak.singleUseObject.map.storage.provider>\n+ <infinispan.version>${infinispan.version}</infinispan.version>\n+ <keycloak.testsuite.start-hotrod-container>${keycloak.testsuite.start-hotrod-container}</keycloak.testsuite.start-hotrod-container>\n+ <auth.server.quarkus.mapStorage.profile.config>hotrod</auth.server.quarkus.mapStorage.profile.config>\n+ </systemPropertyVariables>\n</configuration>\n</plugin>\n+ </plugins>\n+ </build>\n+ </profile>\n+\n+ <profile>\n+ <id>map-storage-jpa-cockroach</id>\n+ <properties>\n+ <cockroachdb.start-container>true</cockroachdb.start-container>\n+ <keycloak.map.storage.connectionsJpa.url>jdbc:postgresql://localhost:26257/keycloak</keycloak.map.storage.connectionsJpa.url>\n+ </properties>\n+ <build>\n+ <plugins>\n<plugin>\n<groupId>org.apache.maven.plugins</groupId>\n<artifactId>maven-surefire-plugin</artifactId>\n<configuration>\n<systemPropertyVariables>\n+ <!--\n+ The following properties needs to be synchronized across all map-storage profiles\n+ -->\n+ <keycloak.profile.feature.map_storage>enabled</keycloak.profile.feature.map_storage>\n+ <keycloak.globalLock.provider>none</keycloak.globalLock.provider>\n+ <keycloak.realm.provider>map</keycloak.realm.provider>\n+ <keycloak.client.provider>map</keycloak.client.provider>\n+ <keycloak.clientScope.provider>map</keycloak.clientScope.provider>\n+ <keycloak.group.provider>map</keycloak.group.provider>\n+ <keycloak.role.provider>map</keycloak.role.provider>\n+ <keycloak.user.provider>map</keycloak.user.provider>\n+ <keycloak.deploymentState.provider>map</keycloak.deploymentState.provider>\n+ <keycloak.authSession.provider>map</keycloak.authSession.provider>\n+ <keycloak.userSession.provider>map</keycloak.userSession.provider>\n+ <keycloak.loginFailure.provider>map</keycloak.loginFailure.provider>\n+ <keycloak.authorization.provider>map</keycloak.authorization.provider>\n+ <keycloak.eventsStore.provider>map</keycloak.eventsStore.provider>\n+ <keycloak.singleUseObject.provider>map</keycloak.singleUseObject.provider>\n+ <keycloak.publicKeyStorage.provider>map</keycloak.publicKeyStorage.provider>\n+ <keycloak.authorizationCache.enabled>false</keycloak.authorizationCache.enabled>\n+ <keycloak.realmCache.enabled>false</keycloak.realmCache.enabled>\n+ <keycloak.userCache.enabled>false</keycloak.userCache.enabled>\n+ <keycloak.publicKeyCache.enabled>false</keycloak.publicKeyCache.enabled>\n+ <keycloak.userSessionPersister.provider></keycloak.userSessionPersister.provider>\n+ <keycloak.userFederatedStorage.provider></keycloak.userFederatedStorage.provider>\n+ <!--\n+ The end of the block synchronized across all map-storage profiles\n+ -->\n<cockroachdb.start-container>${cockroachdb.start-container}</cockroachdb.start-container>\n<keycloak.map.storage.connectionsJpa.url>${keycloak.map.storage.connectionsJpa.url}</keycloak.map.storage.connectionsJpa.url>\n"
},
{
"change_type": "MODIFY",
"old_path": "testsuite/integration-arquillian/tests/base/src/main/java/org/keycloak/testsuite/model/StoreProvider.java",
"new_path": "testsuite/integration-arquillian/tests/base/src/main/java/org/keycloak/testsuite/model/StoreProvider.java",
"diff": "@@ -48,8 +48,8 @@ public enum StoreProvider {\npublic void addStoreOptions(List<String> commands) {\ncommands.add(\"--storage=\" + getAlias());\ncommands.add(\"--storage-hotrod-host='\" + System.getProperty(\"keycloak.connectionsHotRod.host\") + \"'\");\n- commands.add(\"--storage-hotrod-username\" + System.getProperty(\"keycloak.connectionsHotRod.username\"));\n- commands.add(\"--storage-hotrod-password\" + System.getProperty(\"keycloak.connectionsHotRod.password\"));\n+ commands.add(\"--storage-hotrod-username=\" + System.getProperty(\"keycloak.connectionsHotRod.username\", \"admin\"));\n+ commands.add(\"--storage-hotrod-password=\" + System.getProperty(\"keycloak.connectionsHotRod.password\", \"admin\"));\n}\n},\nLEGACY(\"legacy\") {\n"
},
{
"change_type": "MODIFY",
"old_path": "testsuite/integration-arquillian/tests/pom.xml",
"new_path": "testsuite/integration-arquillian/tests/pom.xml",
"diff": "</build>\n</profile>\n- <profile>\n- <id>map-storage-hot-rod</id>\n- <properties>\n- <keycloak.testsuite.start-hotrod-container>true</keycloak.testsuite.start-hotrod-container>\n- <auth.server.quarkus.mapStorage.profile.config>hotrod</auth.server.quarkus.mapStorage.profile.config>\n- </properties>\n- <build>\n- <plugins>\n- </plugins>\n- <pluginManagement>\n- <plugins>\n- <plugin>\n- <groupId>org.apache.maven.plugins</groupId>\n- <artifactId>maven-surefire-plugin</artifactId>\n- <configuration>\n- <systemPropertyVariables>\n- <keycloak.authSession.map.storage.provider>hotrod</keycloak.authSession.map.storage.provider>\n- <keycloak.client.map.storage.provider>hotrod</keycloak.client.map.storage.provider>\n- <keycloak.clientScope.map.storage.provider>hotrod</keycloak.clientScope.map.storage.provider>\n- <keycloak.group.map.storage.provider>hotrod</keycloak.group.map.storage.provider>\n- <keycloak.role.map.storage.provider>hotrod</keycloak.role.map.storage.provider>\n- <keycloak.user.map.storage.provider>hotrod</keycloak.user.map.storage.provider>\n- <keycloak.loginFailure.map.storage.provider>hotrod</keycloak.loginFailure.map.storage.provider>\n- <keycloak.realm.map.storage.provider>hotrod</keycloak.realm.map.storage.provider>\n- <keycloak.userSession.map.storage.provider>hotrod</keycloak.userSession.map.storage.provider>\n- <keycloak.authorization.map.storage.provider>hotrod</keycloak.authorization.map.storage.provider>\n- <keycloak.eventStore.map.storage.provider>hotrod</keycloak.eventStore.map.storage.provider>\n- <keycloak.singleUseObject.map.storage.provider>hotrod</keycloak.singleUseObject.map.storage.provider>\n- <infinispan.version>${infinispan.version}</infinispan.version>\n- <keycloak.testsuite.start-hotrod-container>${keycloak.testsuite.start-hotrod-container}</keycloak.testsuite.start-hotrod-container>\n- </systemPropertyVariables>\n- </configuration>\n- </plugin>\n- </plugins>\n- </pluginManagement>\n- </build>\n- </profile>\n-\n-\n<profile>\n<id>auth-server-profile</id>\n<activation>\n"
}
] | Java | Apache License 2.0 | keycloak/keycloak | Move HotRod profile to the same pom as other map profiles and introduce map-storage-chm profile
Closes #16046 |
339,281 | 19.12.2022 13:38:30 | -3,600 | 44715fe3978bec2e63056936b0372c3a0cd799a7 | Generate getMapKeyClass and getMapValueClass methods for map fields
Closes | [
{
"change_type": "MODIFY",
"old_path": "model/build-processor/src/main/java/org/keycloak/models/map/processor/GenerateEntityImplementationsProcessor.java",
"new_path": "model/build-processor/src/main/java/org/keycloak/models/map/processor/GenerateEntityImplementationsProcessor.java",
"diff": "@@ -184,15 +184,18 @@ public class GenerateEntityImplementationsProcessor extends AbstractGenerateEnti\npw.println(\" }\");\n});\n- FieldAccessorType.getMethod(FieldAccessorType.MAP_ADD, methods, fieldName, types, fieldType).ifPresent(method -> {\n- TypeMirror firstParameterType = method.getParameters().get(0).asType();\n- TypeMirror secondParameterType = method.getParameters().get(1).asType();\n+ FieldAccessorType.getMethod(FieldAccessorType.GETTER, methods, fieldName, types, fieldType).ifPresent(method -> {\n+ if (Util.isMapType((TypeElement) types.asElement(types.erasure(fieldType)))) {\n+ TypeMirror firstParameterType = Util.getGenericsDeclaration(method.getReturnType()).get(0);\n+ TypeMirror secondParameterType = Util.getGenericsDeclaration(method.getReturnType()).get(1);\n+\npw.println(\" @SuppressWarnings(\\\"unchecked\\\") @Override public Class<?> getMapKeyClass() {\");\npw.println(\" return \" + types.erasure(firstParameterType) + \".class;\");\npw.println(\" }\");\npw.println(\" @SuppressWarnings(\\\"unchecked\\\") @Override public Class<?> getMapValueClass() {\");\npw.println(\" return \" + types.erasure(secondParameterType) + \".class;\");\npw.println(\" }\");\n+ }\n});\nfor (ExecutableElement ee : methods) {\n"
}
] | Java | Apache License 2.0 | keycloak/keycloak | Generate getMapKeyClass and getMapValueClass methods for map fields
Closes #16053 |
339,465 | 08.12.2022 18:54:14 | -3,600 | 36bd76957de8f85d45b5232bf3e81952d5e10279 | Make Keycloak FIPS working with OpenJDK 17 on FIPS enabled RHEL
Closes | [
{
"change_type": "MODIFY",
"old_path": "crypto/fips1402/pom.xml",
"new_path": "crypto/fips1402/pom.xml",
"diff": "</dependency>\n</dependencies>\n- <build>\n- <pluginManagement>\n- <plugins>\n- <plugin>\n- <artifactId>maven-surefire-plugin</artifactId>\n- <configuration>\n- <systemPropertyVariables>\n- <java.security.properties>${basedir}/target/test-classes/kc.java.security</java.security.properties>\n- </systemPropertyVariables>\n- </configuration>\n- </plugin>\n- </plugins>\n- </pluginManagement>\n- </build>\n-\n</project>\n\\ No newline at end of file\n"
},
{
"change_type": "MODIFY",
"old_path": "crypto/fips1402/src/main/java/org/keycloak/crypto/fips/FIPS1402Provider.java",
"new_path": "crypto/fips1402/src/main/java/org/keycloak/crypto/fips/FIPS1402Provider.java",
"diff": "@@ -9,6 +9,7 @@ import java.security.KeyStoreException;\nimport java.security.NoSuchAlgorithmException;\nimport java.security.NoSuchProviderException;\nimport java.security.Provider;\n+import java.security.SecureRandom;\nimport java.security.spec.ECField;\nimport java.security.spec.ECFieldF2m;\nimport java.security.spec.ECFieldFp;\n@@ -83,7 +84,7 @@ public class FIPS1402Provider implements CryptoProvider {\nSecurity.insertProviderAt(new KeycloakFipsSecurityProvider(bcFipsProvider), 1);\nif (existingBcFipsProvider == null) {\n- Security.insertProviderAt(this.bcFipsProvider, 2);\n+ checkSecureRandom(() -> Security.insertProviderAt(this.bcFipsProvider, 2));\nProvider bcJsseProvider = new BouncyCastleJsseProvider(\"fips:BCFIPS\");\nSecurity.insertProviderAt(bcJsseProvider, 3);\nlog.debugf(\"Inserted security providers: %s\", Arrays.asList(this.bcFipsProvider.getName(),bcJsseProvider.getName()));\n@@ -191,12 +192,8 @@ public class FIPS1402Provider implements CryptoProvider {\n@Override\npublic KeyStore getKeyStore(KeystoreFormat format) throws KeyStoreException, NoSuchProviderException {\n- if (format == KeystoreFormat.JKS) {\n- return KeyStore.getInstance(format.toString());\n- } else {\nreturn KeyStore.getInstance(format.toString(), BouncyIntegration.PROVIDER);\n}\n- }\n@Override\npublic CertificateFactory getX509CertFactory() throws CertificateException, NoSuchProviderException {\n@@ -262,4 +259,34 @@ public class FIPS1402Provider implements CryptoProvider {\n};\n}\n+\n+ // BCFIPS require \"SecureRandom.getInstanceStrong\" to be available. But it may not be available on RHEL 8 on OpenJDK 17 due the https://bugzilla.redhat.com/show_bug.cgi?id=2155060\n+ private void checkSecureRandom(Runnable insertBcFipsProvider) {\n+ try {\n+ SecureRandom sr = SecureRandom.getInstanceStrong();\n+ log.debugf(\"Strong secure random available. Algorithm: %s, Provider: %s\", sr.getAlgorithm(), sr.getProvider());\n+ insertBcFipsProvider.run();\n+ } catch (NoSuchAlgorithmException nsae) {\n+\n+ // Fallback to regular SecureRandom\n+ SecureRandom secRandom = new SecureRandom();\n+ String origStrongAlgs = Security.getProperty(\"securerandom.strongAlgorithms\");\n+ String usedAlg = secRandom.getAlgorithm() + \":\" + secRandom.getProvider().getName();\n+ log.debugf(\"Strong secure random not available. Tried algorithms: %s. Using algorithm as a fallback for strong secure random: %s\", origStrongAlgs, usedAlg);\n+\n+ String strongAlgs = origStrongAlgs == null ? usedAlg : usedAlg + \",\" + origStrongAlgs;\n+ Security.setProperty(\"securerandom.strongAlgorithms\", strongAlgs);\n+\n+ try {\n+ // Need to insert BCFIPS provider to security providers with \"strong algorithm\" available\n+ insertBcFipsProvider.run();\n+ SecureRandom.getInstance(\"DEFAULT\", \"BCFIPS\");\n+ log.debugf(\"Initialized BCFIPS secured random\");\n+ } catch (NoSuchAlgorithmException | NoSuchProviderException nsaee) {\n+ throw new IllegalStateException(\"Not possible to initiate BCFIPS secure random\", nsaee);\n+ } finally {\n+ Security.setProperty(\"securerandom.strongAlgorithms\", origStrongAlgs != null ? origStrongAlgs : \"\");\n+ }\n+ }\n+ }\n}\n"
},
{
"change_type": "DELETE",
"old_path": "crypto/fips1402/src/test/resources/kc.java.security",
"new_path": null,
"diff": "-# Configuration file just with the security properties, which are supposed to be overriden. The properties, which are not mentioned in this file,\n-# are inherited from the default java.security file bundled within the Java distribution.\n-#\n-# NOTE: Each property is specified 2 times. This is so the same file can be used on both FIPS based RHEL host (which uses \"fips\" prefixed properties by default)\n-# and the non-fips based (EG. when running the tests on GH actions)\n-\n-#\n-# List of providers and their preference orders (see above). Used on the host without FIPS (EG. when running the tests on GH actions)\n-# Uses only BouncyCastle FIPS providers to make sure to use only FIPS compliant cryptography.\n-#\n-security.provider.1=org.bouncycastle.jcajce.provider.BouncyCastleFipsProvider\n-security.provider.2=org.bouncycastle.jsse.provider.BouncyCastleJsseProvider fips:BCFIPS\n-security.provider.3=\n-\n-#\n-# Security providers used when global crypto-policies are set to FIPS (Usually it is used when FIPS enabled on system/JVM level)\n-#\n-fips.provider.1=org.bouncycastle.jcajce.provider.BouncyCastleFipsProvider\n-fips.provider.2=org.bouncycastle.jsse.provider.BouncyCastleJsseProvider fips:BCFIPS\n-fips.provider.3=\n-\n-# Commented this provider for now (and also other providers) as it uses lots of non-FIPS services.\n-# See https://access.redhat.com/documentation/en-us/openjdk/11/html-single/configuring_openjdk_11_on_rhel_with_fips/index#ref_openjdk-default-fips-configuration_openjdk\n-# fips.provider.2=SUN\n-\n-#\n-# Default keystore type.\n-#\n-keystore.type=PKCS12\n-fips.keystore.type=PKCS12\n-\n-# This is needed especially if we cannot add security provider \"com.sun.net.ssl.internal.ssl.Provider BCFIPS\" as a security provider.\n-# OpenJDK has \"SunX509\" as default algorithm, but that one is not supported by BCJSSE. So adding the Sun provider delegating to BCFIPS is needed (as above)\n-# or changing default algorithm as described here\n-ssl.KeyManagerFactory.algorithm=PKIX\n-fips.ssl.KeyManagerFactory.algorithm=PKIX\n-\n-ssl.TrustManagerFactory.algorithm=PKIX\n-fips.ssl.TrustManagerFactory.algorithm=PKIX\n-\n-#\n-# Controls compatibility mode for JKS and PKCS12 keystore types.\n-#\n-# When set to 'true', both JKS and PKCS12 keystore types support loading\n-# keystore files in either JKS or PKCS12 format. When set to 'false' the\n-# JKS keystore type supports loading only JKS keystore files and the PKCS12\n-# keystore type supports loading only PKCS12 keystore files.\n-#\n-# This is set to false as BCFIPS providers don't support JKS\n-keystore.type.compat=false\n-fips.keystore.type.compat=false\n"
},
{
"change_type": "MODIFY",
"old_path": "docs/fips.md",
"new_path": "docs/fips.md",
"diff": "@@ -66,8 +66,7 @@ For the `fips-mode`, he alternative is to use `--fips-mode=strict` in which case\nwhich means even stricter security algorithms. As mentioned above, strict mode won't work with `pkcs12` keystore:\n```\n-./kc.sh build --fips-mode=enabled\n-./kc.sh start --optimized --hostname=localhost \\\n+./kc.sh start --fips-mode=enabled --hostname=localhost \\\n--https-key-store-file=$PWD/$KEYSTORE_FILE \\\n--https-key-store-type=$KEYSTORE_FORMAT \\\n--https-key-store-password=passwordpassword \\\n"
},
{
"change_type": "MODIFY",
"old_path": "integration/client-cli/admin-cli/src/main/java/org/keycloak/client/admin/cli/util/AuthUtil.java",
"new_path": "integration/client-cli/admin-cli/src/main/java/org/keycloak/client/admin/cli/util/AuthUtil.java",
"diff": "@@ -191,7 +191,8 @@ public class AuthUtil {\npublic static String getSignedRequestToken(String keystore, String storePass, String keyPass, String alias, int sigLifetime, String clientId, String realmInfoUrl) {\n- KeyPair keypair = KeystoreUtil.loadKeyPairFromKeystore(keystore, storePass, keyPass, alias, KeystoreUtil.KeystoreFormat.JKS);\n+ KeystoreUtil.KeystoreFormat keystoreType = Enum.valueOf(KeystoreUtil.KeystoreFormat.class, KeystoreUtil.getKeystoreType(null, keystore, KeystoreUtil.KeystoreFormat.JKS.toString()));\n+ KeyPair keypair = KeystoreUtil.loadKeyPairFromKeystore(keystore, storePass, keyPass, alias, keystoreType);\nJsonWebToken reqToken = new JsonWebToken();\nreqToken.id(UUID.randomUUID().toString());\n"
},
{
"change_type": "MODIFY",
"old_path": "integration/client-cli/client-registration-cli/src/main/java/org/keycloak/client/registration/cli/util/AuthUtil.java",
"new_path": "integration/client-cli/client-registration-cli/src/main/java/org/keycloak/client/registration/cli/util/AuthUtil.java",
"diff": "@@ -31,7 +31,6 @@ import java.io.IOException;\nimport java.io.InputStream;\nimport java.io.UnsupportedEncodingException;\nimport java.security.KeyPair;\n-import java.security.PrivateKey;\nimport java.util.UUID;\nimport static java.lang.System.currentTimeMillis;\n@@ -193,7 +192,8 @@ public class AuthUtil {\npublic static String getSignedRequestToken(String keystore, String storePass, String keyPass, String alias, int sigLifetime, String clientId, String realmInfoUrl) {\n- KeyPair keypair = KeystoreUtil.loadKeyPairFromKeystore(keystore, storePass, keyPass, alias, KeystoreUtil.KeystoreFormat.JKS);\n+ KeystoreUtil.KeystoreFormat keystoreType = Enum.valueOf(KeystoreUtil.KeystoreFormat.class, KeystoreUtil.getKeystoreType(null, keystore, KeystoreUtil.KeystoreFormat.JKS.toString()));\n+ KeyPair keypair = KeystoreUtil.loadKeyPairFromKeystore(keystore, storePass, keyPass, alias, keystoreType);\nJsonWebToken reqToken = new JsonWebToken();\nreqToken.id(UUID.randomUUID().toString());\n"
},
{
"change_type": "MODIFY",
"old_path": "quarkus/runtime/src/main/java/org/keycloak/quarkus/runtime/configuration/mappers/ClassLoaderPropertyMappers.java",
"new_path": "quarkus/runtime/src/main/java/org/keycloak/quarkus/runtime/configuration/mappers/ClassLoaderPropertyMappers.java",
"diff": "@@ -34,7 +34,7 @@ final class ClassLoaderPropertyMappers {\nif (fipsEnabled != null && FipsMode.valueOf(fipsEnabled.getValue()).isFipsEnabled()) {\nreturn Optional.of(\n- \"org.bouncycastle:bcprov-jdk15on,org.bouncycastle:bcpkix-jdk15on,org.keycloak:keycloak-crypto-default\");\n+ \"org.bouncycastle:bcprov-jdk15on,org.bouncycastle:bcpkix-jdk15on,org.bouncycastle:bcutil-jdk15on,org.keycloak:keycloak-crypto-default\");\n}\nreturn Optional.of(\n"
},
{
"change_type": "MODIFY",
"old_path": "testsuite/integration-arquillian/servers/auth-server/common/fips/kc.java.security",
"new_path": "testsuite/integration-arquillian/servers/auth-server/common/fips/kc.java.security",
"diff": "# List of providers and their preference orders (see above). Used on the host without FIPS (EG. when running the tests on GH actions)\n# Uses only BouncyCastle FIPS providers to make sure to use only FIPS compliant cryptography.\n#\n-security.provider.1=org.bouncycastle.jcajce.provider.BouncyCastleFipsProvider\n-security.provider.2=org.bouncycastle.jsse.provider.BouncyCastleJsseProvider fips:BCFIPS\n-security.provider.3=\n+#security.provider.1=org.bouncycastle.jcajce.provider.BouncyCastleFipsProvider\n+#security.provider.2=org.bouncycastle.jsse.provider.BouncyCastleJsseProvider fips:BCFIPS\n+#security.provider.3=\n#\n# Security providers used when global crypto-policies are set to FIPS (Usually it is used when FIPS enabled on system/JVM level)\n#\n-fips.provider.1=org.bouncycastle.jcajce.provider.BouncyCastleFipsProvider\n-fips.provider.2=org.bouncycastle.jsse.provider.BouncyCastleJsseProvider fips:BCFIPS\n-fips.provider.3=\n-#fips.provider.3=SunJGSS\n-#fips.provider.4=XMLDSig\n+#fips.provider.1=SunPKCS11 ${java.home}/conf/security/nss.fips.cfg\n+#fips.provider.2=SUN\n+#fips.provider.3=SunEC\n+#fips.provider.4=com.sun.net.ssl.internal.ssl.Provider SunPKCS11-NSS-FIPS\n+#fips.provider.5=SunJGSS\n+#fips.provider.6=XMLDSig\n#fips.provider.5=\n# Commented this provider for now (and also other providers) as it uses lots of non-FIPS services.\n"
},
{
"change_type": "MODIFY",
"old_path": "testsuite/integration-arquillian/servers/auth-server/quarkus/pom.xml",
"new_path": "testsuite/integration-arquillian/servers/auth-server/quarkus/pom.xml",
"diff": "<goal>copy-dependencies</goal>\n</goals>\n<configuration>\n- <outputDirectory>${auth.server.home}/lib/bootstrap</outputDirectory>\n+ <outputDirectory>${auth.server.home}/providers</outputDirectory>\n<includeArtifactIds>bc-fips,bctls-fips,bcpkix-fips</includeArtifactIds>\n</configuration>\n</execution>\n"
},
{
"change_type": "MODIFY",
"old_path": "testsuite/integration-arquillian/tests/base/src/test/java/org/keycloak/testsuite/cli/admin/KcAdmTest.java",
"new_path": "testsuite/integration-arquillian/tests/base/src/test/java/org/keycloak/testsuite/cli/admin/KcAdmTest.java",
"diff": "@@ -5,8 +5,10 @@ import org.junit.Test;\nimport org.keycloak.client.admin.cli.config.ConfigData;\nimport org.keycloak.client.admin.cli.config.FileConfigHandler;\nimport org.keycloak.client.admin.cli.config.RealmConfigData;\n+import org.keycloak.common.util.KeystoreUtil;\nimport org.keycloak.representations.idm.ClientRepresentation;\nimport org.keycloak.testsuite.cli.KcAdmExec;\n+import org.keycloak.testsuite.util.KeystoreUtils;\nimport org.keycloak.testsuite.util.TempFileResource;\nimport org.keycloak.util.JsonSerialization;\n@@ -501,13 +503,24 @@ public class KcAdmTest extends AbstractAdmCliTest {\n}\n@Test\n- public void testCRUDWithOnTheFlyUserAuthWithSignedJwtClient() throws IOException {\n+ public void testCRUDWithOnTheFlyUserAuthWithSignedJwtClient_JKSKeystore() throws IOException {\n+ KeystoreUtils.assumeKeystoreTypeSupported(KeystoreUtil.KeystoreFormat.JKS);\n+ testCRUDWithOnTheFlyUserAuthWithSignedJwtClient(KeystoreUtil.KeystoreFormat.JKS.getFileExtension());\n+ }\n+\n+ @Test\n+ public void testCRUDWithOnTheFlyUserAuthWithSignedJwtClient_PKCS12Keystore() throws IOException {\n+ KeystoreUtils.assumeKeystoreTypeSupported(KeystoreUtil.KeystoreFormat.PKCS12);\n+ testCRUDWithOnTheFlyUserAuthWithSignedJwtClient(KeystoreUtil.KeystoreFormat.PKCS12.getFileExtension());\n+ }\n+\n+ private void testCRUDWithOnTheFlyUserAuthWithSignedJwtClient(String keystoreFileExtension) throws IOException {\n/*\n* Test create, get, update, and delete using on-the-fly authentication - without using any config file.\n* Login is performed by each operation again, and again using username, password, and client JWT signature.\n*/\n- File keystore = new File(System.getProperty(\"user.dir\") + \"/src/test/resources/cli/kcadm/admin-cli-keystore.jks\");\n- Assert.assertTrue(\"admin-cli-keystore.jks exists\", keystore.isFile());\n+ File keystore = new File(System.getProperty(\"user.dir\") + \"/src/test/resources/cli/kcadm/admin-cli-keystore.\" + keystoreFileExtension);\n+ Assert.assertTrue(\"admin-cli-keystore.\" + keystoreFileExtension + \" must exist, but it does not exists\", keystore.isFile());\n// try client without direct grants enabled\nKcAdmExec exe = KcAdmExec.execute(\"get clients --no-config --server \" + serverUrl + \" --realm test\" +\n@@ -536,7 +549,7 @@ public class KcAdmTest extends AbstractAdmCliTest {\nassertExitCodeAndStreamSizes(exe, 1, 0, 2);\nAssert.assertEquals(\"login message\", \"Logging into \" + serverUrl + \" as user user1 of realm test\", exe.stderrLines().get(0));\n- Assert.assertEquals(\"error message\", \"Failed to load private key: Keystore was tampered with, or password was incorrect\", exe.stderrLines().get(exe.stderrLines().size() - 1));\n+ Assert.assertTrue(\"error message\", exe.stderrLines().get(exe.stderrLines().size() - 1).startsWith(\"Failed to load private key:\"));\n// try whole CRUD\n@@ -563,8 +576,8 @@ public class KcAdmTest extends AbstractAdmCliTest {\n* Test create, get, update, and delete using on-the-fly authentication - without using any config file.\n* Login is performed by each operation again, and again using only client JWT signature - service account is used.\n*/\n- File keystore = new File(System.getProperty(\"user.dir\") + \"/src/test/resources/cli/kcadm/admin-cli-keystore.jks\");\n- Assert.assertTrue(\"admin-cli-keystore.jks exists\", keystore.isFile());\n+ File keystore = new File(System.getProperty(\"user.dir\") + \"/src/test/resources/cli/kcadm/admin-cli-keystore.p12\");\n+ Assert.assertTrue(\"admin-cli-keystore.p12 exists\", keystore.isFile());\ntestCRUDWithOnTheFlyAuth(serverUrl,\n\"--client admin-cli-jwt --keystore '\" + keystore.getAbsolutePath() + \"' --storepass storepass --keypass keypass --alias admin-cli\", \"\",\n"
},
{
"change_type": "MODIFY",
"old_path": "testsuite/integration-arquillian/tests/base/src/test/java/org/keycloak/testsuite/cli/registration/KcRegTest.java",
"new_path": "testsuite/integration-arquillian/tests/base/src/test/java/org/keycloak/testsuite/cli/registration/KcRegTest.java",
"diff": "@@ -6,8 +6,10 @@ import org.junit.Test;\nimport org.keycloak.client.registration.cli.config.ConfigData;\nimport org.keycloak.client.registration.cli.config.FileConfigHandler;\nimport org.keycloak.client.registration.cli.config.RealmConfigData;\n+import org.keycloak.common.util.KeystoreUtil;\nimport org.keycloak.representations.idm.ClientRepresentation;\nimport org.keycloak.testsuite.cli.KcRegExec;\n+import org.keycloak.testsuite.util.KeystoreUtils;\nimport org.keycloak.testsuite.util.TempFileResource;\nimport org.keycloak.util.JsonSerialization;\n@@ -502,13 +504,24 @@ public class KcRegTest extends AbstractRegCliTest {\n}\n@Test\n- public void testCRUDWithOnTheFlyUserAuthWithSignedJwtClient() throws IOException {\n+ public void testCRUDWithOnTheFlyUserAuthWithSignedJwtClient_JKSKeystore() throws IOException {\n+ KeystoreUtils.assumeKeystoreTypeSupported(KeystoreUtil.KeystoreFormat.JKS);\n+ testCRUDWithOnTheFlyUserAuthWithSignedJwtClient(KeystoreUtil.KeystoreFormat.JKS.getFileExtension());\n+ }\n+\n+ @Test\n+ public void testCRUDWithOnTheFlyUserAuthWithSignedJwtClient_PKCS12Keystore() throws IOException {\n+ KeystoreUtils.assumeKeystoreTypeSupported(KeystoreUtil.KeystoreFormat.PKCS12);\n+ testCRUDWithOnTheFlyUserAuthWithSignedJwtClient(KeystoreUtil.KeystoreFormat.PKCS12.getFileExtension());\n+ }\n+\n+ private void testCRUDWithOnTheFlyUserAuthWithSignedJwtClient(String keystoreFileExtension) throws IOException {\n/*\n* Test create, get, update, and delete using on-the-fly authentication - without using any config file.\n* Login is performed by each operation again, and again using username, password, and client JWT signature.\n*/\n- File keystore = new File(System.getProperty(\"user.dir\") + \"/src/test/resources/cli/kcreg/reg-cli-keystore.jks\");\n- Assert.assertTrue(\"reg-cli-keystore.jks exists\", keystore.isFile());\n+ File keystore = new File(System.getProperty(\"user.dir\") + \"/src/test/resources/cli/kcreg/reg-cli-keystore.\" + keystoreFileExtension);\n+ Assert.assertTrue(\"reg-cli-keystore.\" + keystoreFileExtension + \" exists\", keystore.isFile());\n// try client without direct grants enabled\nKcRegExec exe = execute(\"get test-client --no-config --server \" + serverUrl + \" --realm test\" +\n@@ -537,7 +550,7 @@ public class KcRegTest extends AbstractRegCliTest {\nassertExitCodeAndStreamSizes(exe, 1, 0, 2);\nAssert.assertEquals(\"login message\", \"Logging into \" + serverUrl + \" as user user1 of realm test\", exe.stderrLines().get(0));\n- Assert.assertEquals(\"error message\", \"Failed to load private key: Keystore was tampered with, or password was incorrect\", exe.stderrLines().get(exe.stderrLines().size() - 1));\n+ Assert.assertTrue(\"error message\", exe.stderrLines().get(exe.stderrLines().size() - 1).startsWith(\"Failed to load private key: \"));\n// try whole CRUD\n@@ -564,8 +577,8 @@ public class KcRegTest extends AbstractRegCliTest {\n* Test create, get, update, and delete using on-the-fly authentication - without using any config file.\n* Login is performed by each operation again, and again using only client JWT signature - service account is used.\n*/\n- File keystore = new File(System.getProperty(\"user.dir\") + \"/src/test/resources/cli/kcreg/reg-cli-keystore.jks\");\n- Assert.assertTrue(\"reg-cli-keystore.jks exists\", keystore.isFile());\n+ File keystore = new File(System.getProperty(\"user.dir\") + \"/src/test/resources/cli/kcreg/reg-cli-keystore.p12\");\n+ Assert.assertTrue(\"reg-cli-keystore.p12 exists\", keystore.isFile());\ntestCRUDWithOnTheFlyAuth(serverUrl,\n\"--client reg-cli-jwt --keystore '\" + keystore.getAbsolutePath() + \"' --storepass storepass --keypass keypass --alias reg-cli\", \"\",\n"
},
{
"change_type": "ADD",
"old_path": "testsuite/integration-arquillian/tests/base/src/test/resources/cli/kcadm/admin-cli-keystore.p12",
"new_path": "testsuite/integration-arquillian/tests/base/src/test/resources/cli/kcadm/admin-cli-keystore.p12",
"diff": "Binary files /dev/null and b/testsuite/integration-arquillian/tests/base/src/test/resources/cli/kcadm/admin-cli-keystore.p12 differ\n"
},
{
"change_type": "ADD",
"old_path": "testsuite/integration-arquillian/tests/base/src/test/resources/cli/kcreg/reg-cli-keystore.p12",
"new_path": "testsuite/integration-arquillian/tests/base/src/test/resources/cli/kcreg/reg-cli-keystore.p12",
"diff": "Binary files /dev/null and b/testsuite/integration-arquillian/tests/base/src/test/resources/cli/kcreg/reg-cli-keystore.p12 differ\n"
}
] | Java | Apache License 2.0 | keycloak/keycloak | Make Keycloak FIPS working with OpenJDK 17 on FIPS enabled RHEL
Closes #15721 |
339,687 | 21.12.2022 08:15:38 | -3,600 | 9bb5b08015361ad02b9d748111cd5905bbc3691e | Added Oracle to Legacy Store IT. | [
{
"change_type": "MODIFY",
"old_path": ".github/workflows/ci.yml",
"new_path": ".github/workflows/ci.yml",
"diff": "@@ -253,7 +253,7 @@ jobs:\ntimeout-minutes: 45\nstrategy:\nmatrix:\n- db: [postgres, mysql] # 'mariadb' is not always shutting down, 'mssql', 'oracle11g' containers not available\n+ db: [postgres, mysql, oracle] # 'mariadb' is not always shutting down, 'mssql' container not available yet\nfail-fast: false\nsteps:\n- uses: actions/checkout@v3\n"
},
{
"change_type": "MODIFY",
"old_path": "testsuite/integration-arquillian/pom.xml",
"new_path": "testsuite/integration-arquillian/pom.xml",
"diff": "</properties>\n</profile>\n<profile>\n- <id>db-oracle11g</id>\n+ <id>db-oracle</id>\n<properties>\n- <docker.database.image>oracle/database:11.2.0.2-xe</docker.database.image>\n+ <docker.database.image>docker.io/gvenzl/oracle-xe:21-slim-faststart</docker.database.image>\n<docker.database.port>1521</docker.database.port>\n<docker.database.shmsize>1073741824</docker.database.shmsize>\n<docker.database.skip>false</docker.database.skip>\n<keycloak.map.storage.connectionsJpa.user>${keycloak.connectionsJpa.user}</keycloak.map.storage.connectionsJpa.user>\n<keycloak.map.storage.connectionsJpa.password>${keycloak.connectionsJpa.password}</keycloak.map.storage.connectionsJpa.password>\n- <docker.database.postStart>bash -c while\\ !\\ sqlplus\\ -L\\ SYS/sa@localhost/XE\\ AS\\ SYSDBA\\ <<<\\ $'CREATE\\ USER\\ ${keycloak.connectionsJpa.user}\\ IDENTIFIED\\ BY\\ ${keycloak.connectionsJpa.password};\\n\\ GRANT\\ CONNECT,\\ RESOURCE,\\ DBA,\\ GRANT\\ ANY\\ PRIVILEGE,\\ UNLIMITED\\ TABLESPACE\\ TO\\ ${keycloak.connectionsJpa.user};\\n';\\ do\\ sleep\\ 5;\\ done</docker.database.postStart>\n+ <docker.database.postStart>bash -c while\\ !\\ sqlplus\\ -L\\ SYS/sa@localhost/XE\\ AS\\ SYSDBA\\ <<<\\ $'alter\\ session\\ set\\ \\\"_ORACLE_SCRIPT\\\"=true;\\n\\ CREATE\\ USER\\ ${keycloak.connectionsJpa.user}\\ IDENTIFIED\\ BY\\ ${keycloak.connectionsJpa.password};\\n\\ GRANT\\ CONNECT,\\ RESOURCE,\\ DBA,\\ GRANT\\ ANY\\ PRIVILEGE,\\ UNLIMITED\\ TABLESPACE\\ TO\\ ${keycloak.connectionsJpa.user};\\n';\\ do\\ sleep\\ 5;\\ done</docker.database.postStart>\n<!-- JDBC properties point to \"default\" JDBC driver for the particular DB -->\n<!-- For EAP testing, it is recommended to override those with system properties pointing to GAV of more appropriate JDBC driver -->\n<!-- for the particular EAP version -->\n"
},
{
"change_type": "MODIFY",
"old_path": "testsuite/integration-arquillian/tests/base/pom.xml",
"new_path": "testsuite/integration-arquillian/tests/base/pom.xml",
"diff": "<!-- Oracle -->\n<ORACLE_SID>${keycloak.connectionsJpa.database}</ORACLE_SID>\n- <ORACLE_PWD>sa</ORACLE_PWD>\n+ <ORACLE_PASSWORD>sa</ORACLE_PASSWORD>\n</env>\n<cmd>${docker.database.cmd}</cmd>\n<wait>\n"
}
] | Java | Apache License 2.0 | keycloak/keycloak | Added Oracle to Legacy Store IT. (#16097) |
339,500 | 19.12.2022 09:53:46 | -3,600 | 5aae3842c40c8f5b8c6c80fa47e09c11f4a6d7e6 | Upgrade to Infinispan 14.0.4.Final | [
{
"change_type": "MODIFY",
"old_path": "model/infinispan/src/main/java/org/keycloak/cluster/infinispan/InfinispanNotificationsManager.java",
"new_path": "model/infinispan/src/main/java/org/keycloak/cluster/infinispan/InfinispanNotificationsManager.java",
"diff": "@@ -258,11 +258,17 @@ public class InfinispanNotificationsManager {\n});\n} catch (RejectedExecutionException ree) {\n+ // server is shutting down or pool was terminated - don't throw errors\n+ if (ree.getMessage() != null && (ree.getMessage().contains(\"Terminated\") || ree.getMessage().contains(\"Shutting down\"))) {\n+ logger.warnf(\"Rejected submitting of the event for key: %s because server is shutting down or pool was terminated.\", key);\n+ logger.debug(ree);\n+ } else {\n// avoid touching the cache when creating a log message to avoid a deadlock in Infinispan 12.1.7.Final\nlogger.errorf(\"Rejected submitting of the event for key: %s. Server going to shutdown or pool exhausted. Pool: %s\", key, listenersExecutor.toString());\nthrow ree;\n}\n}\n+ }\n}\n"
},
{
"change_type": "MODIFY",
"old_path": "model/infinispan/src/main/java/org/keycloak/connections/infinispan/DefaultInfinispanConnectionProviderFactory.java",
"new_path": "model/infinispan/src/main/java/org/keycloak/connections/infinispan/DefaultInfinispanConnectionProviderFactory.java",
"diff": "@@ -393,7 +393,7 @@ public class DefaultInfinispanConnectionProviderFactory implements InfinispanCon\n// Used for cross-data centers scenario. Usually integration with external JDG server, which itself handles communication between DCs.\nprivate void configureRemoteCacheStore(ConfigurationBuilder builder, boolean async, String cacheName) {\n- String jdgServer = config.get(\"remoteStoreHost\", \"localhost\");\n+ String jdgServer = config.get(\"remoteStoreHost\", \"127.0.0.1\");\nInteger jdgPort = config.getInt(\"remoteStorePort\", 11222);\n// After upgrade to Infinispan 12.1.7.Final it's required that both remote store and embedded cache use\n@@ -422,7 +422,7 @@ public class DefaultInfinispanConnectionProviderFactory implements InfinispanCon\n}\nprivate void configureRemoteActionTokenCacheStore(ConfigurationBuilder builder, boolean async) {\n- String jdgServer = config.get(\"remoteStoreHost\", \"localhost\");\n+ String jdgServer = config.get(\"remoteStoreHost\", \"127.0.0.1\");\nInteger jdgPort = config.getInt(\"remoteStorePort\", 11222);\n// After upgrade to Infinispan 12.1.7.Final it's required that both remote store and embedded cache use\n"
},
{
"change_type": "MODIFY",
"old_path": "model/infinispan/src/main/java/org/keycloak/models/sessions/infinispan/remotestore/ClientListenerExecutorDecorator.java",
"new_path": "model/infinispan/src/main/java/org/keycloak/models/sessions/infinispan/remotestore/ClientListenerExecutorDecorator.java",
"diff": "@@ -127,10 +127,17 @@ public class ClientListenerExecutorDecorator<K> {\n} catch (RejectedExecutionException ree) {\neventsInProgress.remove(key);\n+ // server is shutting down or pool was terminated - don't throw errors\n+ if (ree.getMessage() != null && (ree.getMessage().contains(\"Terminated\") || ree.getMessage().contains(\"Shutting down\"))) {\n+ logger.warnf(\"Rejected execution of task for the event '%s' because server is shutting down or pool was terminated.\", event.toString());\n+ logger.debug(ree);\n+ } else {\n+ // avoid touching the cache when creating a log message to avoid a deadlock in Infinispan 12.1.7.Final\nlogger.errorf(\"Rejected execution of task for the event '%s' . Try to increase the pool size. Pool is '%s'\", event.toString(), decorated.toString());\nthrow ree;\n}\n}\n+ }\n// Assume it's called from the synchronized block\n"
},
{
"change_type": "MODIFY",
"old_path": "pom.xml",
"new_path": "pom.xml",
"diff": "<jakarta.persistence.version>2.2.3</jakarta.persistence.version>\n<hibernate-orm.version>5.6.14.Final</hibernate-orm.version>\n<hibernate.c3p0.version>${hibernate-orm.version}</hibernate.c3p0.version>\n- <infinispan.version>14.0.2.Final</infinispan.version>\n- <infinispan.protostream.processor.version>4.5.0.Final</infinispan.protostream.processor.version>\n+ <infinispan.version>14.0.4.Final</infinispan.version>\n+ <infinispan.protostream.processor.version>4.6.0.Final</infinispan.protostream.processor.version>\n<jackson.version>2.13.4</jackson.version>\n<jackson.databind.version>2.13.4.2</jackson.databind.version>\n<jackson.annotations.version>${jackson.version}</jackson.annotations.version>\n"
}
] | Java | Apache License 2.0 | keycloak/keycloak | Upgrade to Infinispan 14.0.4.Final |
339,323 | 16.12.2022 11:43:14 | -32,400 | ce6b737e334294ddc114e5d69ce939fab0bfc7bf | NPE in userinfo endpoint
Closes | [
{
"change_type": "MODIFY",
"old_path": "services/src/main/java/org/keycloak/protocol/oidc/endpoints/UserInfoEndpoint.java",
"new_path": "services/src/main/java/org/keycloak/protocol/oidc/endpoints/UserInfoEndpoint.java",
"diff": "@@ -141,10 +141,12 @@ public class UserInfoEndpoint {\nauthorization(accessToken);\ntry {\n+ if (MediaType.APPLICATION_FORM_URLENCODED.equalsIgnoreCase(headers.getHeaderString(HttpHeaders.CONTENT_TYPE))) {\nMultivaluedMap<String, String> formParams = request.getDecodedFormParameters();\ncheckAccessTokenDuplicated(formParams);\naccessToken = formParams.getFirst(OAuth2Constants.ACCESS_TOKEN);\nauthorization(accessToken);\n+ }\n} catch (IllegalArgumentException e) {\n// not application/x-www-form-urlencoded, ignore\n}\n"
},
{
"change_type": "MODIFY",
"old_path": "testsuite/integration-arquillian/tests/base/src/test/java/org/keycloak/testsuite/oidc/UserInfoTest.java",
"new_path": "testsuite/integration-arquillian/tests/base/src/test/java/org/keycloak/testsuite/oidc/UserInfoTest.java",
"diff": "@@ -1036,4 +1036,25 @@ public class UserInfoTest extends AbstractKeycloakTest {\nassertNull(userInfo.getOtherClaims().get(\"realm_access\"));\nassertNull(userInfo.getOtherClaims().get(\"resource_access\"));\n}\n+\n+ @Test\n+ public void test_noContentType() throws Exception {\n+ Client client = AdminClientUtil.createResteasyClient();\n+\n+ try {\n+ AccessTokenResponse accessTokenResponse = executeGrantAccessTokenRequest(client);\n+\n+ WebTarget userInfoTarget = UserInfoClientUtil.getUserInfoWebTarget(client);\n+ Response response = userInfoTarget.request()\n+ .header(HttpHeaders.AUTHORIZATION, \"bearer \" + accessTokenResponse.getToken())\n+ .build(\"POST\")\n+ .invoke();\n+\n+ Assert.assertEquals(200, response.getStatus());\n+ Assert.assertEquals(\"OK\", response.getStatusInfo().toString());\n+\n+ } finally {\n+ client.close();\n+ }\n+ }\n}\n"
}
] | Java | Apache License 2.0 | keycloak/keycloak | NPE in userinfo endpoint
Closes #15429 |
339,465 | 03.01.2023 07:26:11 | -3,600 | 496c6d598ebc04c3d3c07aef27017ffb6c13879c | Some authorization adapter test failing on Java 17
Closes | [
{
"change_type": "ADD",
"old_path": null,
"new_path": "testsuite/integration-arquillian/test-apps/hello-world-authz-service/src/main/java/org/keycloak/testsuite/example/WebAppHelper.java",
"diff": "+/*\n+ * Copyright 2023 Red Hat, Inc. and/or its affiliates\n+ * and other contributors as indicated by the @author tags.\n+ *\n+ * Licensed under the Apache License, Version 2.0 (the \"License\");\n+ * you may not use this file except in compliance with the License.\n+ * You may obtain a copy of the License at\n+ *\n+ * http://www.apache.org/licenses/LICENSE-2.0\n+ *\n+ * Unless required by applicable law or agreed to in writing, software\n+ * distributed under the License is distributed on an \"AS IS\" BASIS,\n+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n+ *\n+ * See the License for the specific language governing permissions and\n+ * limitations under the License.\n+ *\n+ */\n+\n+package org.keycloak.testsuite.example;\n+\n+/**\n+ * @author <a href=\"mailto:mposolda@redhat.com\">Marek Posolda</a>\n+ */\n+public class WebAppHelper {\n+\n+ public static String getAuthUri() {\n+ boolean isTLSEnabled = Boolean.parseBoolean(System.getProperty(\"auth.server.ssl.required\", \"true\"));\n+ String authPort = isTLSEnabled ? System.getProperty(\"auth.server.https.port\", \"8543\") : System.getProperty(\"auth.server.http.port\", \"8180\");\n+ String authScheme = isTLSEnabled ? \"https\" : \"http\";\n+ return authScheme + \"://localhost:\" + authPort + \"/auth\";\n+ }\n+\n+}\n"
},
{
"change_type": "MODIFY",
"old_path": "testsuite/integration-arquillian/test-apps/hello-world-authz-service/src/main/webapp/error.jsp",
"new_path": "testsuite/integration-arquillian/test-apps/hello-world-authz-service/src/main/webapp/error.jsp",
"diff": "<%@ page import=\"org.keycloak.common.util.KeycloakUriBuilder\" %>\n<%@ page import=\"org.keycloak.constants.ServiceUrlConstants\" %>\n-\n-<%\n- boolean isTLSEnabled = Boolean.parseBoolean(System.getProperty(\"auth.server.ssl.required\", \"true\"));\n- String authPort = isTLSEnabled ? System.getProperty(\"auth.server.https.port\", \"8543\") : System.getProperty(\"auth.server.http.port\", \"8180\");\n- String authScheme = isTLSEnabled ? \"https\" : \"http\";\n- String authUri = authScheme + \"://localhost:\" + authPort + \"/auth\";\n-%>\n+<%@ page import=\"org.keycloak.testsuite.example.WebAppHelper\" %>\n<html>\n<body>\n-<h2><a href=\"<%= KeycloakUriBuilder.fromUri(authUri).path(ServiceUrlConstants.TOKEN_SERVICE_LOGOUT_PATH)\n+<h2><a href=\"<%= KeycloakUriBuilder.fromUri(WebAppHelper.getAuthUri()).path(ServiceUrlConstants.TOKEN_SERVICE_LOGOUT_PATH)\n.queryParam(\"redirect_uri\", \"http://localhost:8080/hello-world-authz-service\").build(\"hello-world-authz\").toString()%>\">Logout</a></h2>\n<h3>Access Denied !</h3>\n"
},
{
"change_type": "MODIFY",
"old_path": "testsuite/integration-arquillian/test-apps/hello-world-authz-service/src/main/webapp/index.jsp",
"new_path": "testsuite/integration-arquillian/test-apps/hello-world-authz-service/src/main/webapp/index.jsp",
"diff": "<%@ page import=\"org.keycloak.common.util.KeycloakUriBuilder\" %>\n<%@ page import=\"org.keycloak.constants.ServiceUrlConstants\" %>\n<%@ page import=\"org.keycloak.representations.idm.authorization.Permission\" %>\n+<%@ page import=\"org.keycloak.testsuite.example.WebAppHelper\" %>\n<%\nKeycloakSecurityContext keycloakSecurityContext = (KeycloakSecurityContext) request.getAttribute(KeycloakSecurityContext.class.getName());\nAuthorizationContext authzContext = keycloakSecurityContext.getAuthorizationContext();\n-\n- boolean isTLSEnabled = Boolean.parseBoolean(System.getProperty(\"auth.server.ssl.required\", \"true\"));\n- String authPort = isTLSEnabled ? System.getProperty(\"auth.server.https.port\", \"8543\") : System.getProperty(\"auth.server.http.port\", \"8180\");\n- String authScheme = isTLSEnabled ? \"https\" : \"http\";\n- String authUri = authScheme + \"://localhost:\" + authPort + \"/auth\";\n%>\n<html>\n<body>\n<h2>Welcome !</h2>\n-<h2><a href=\"<%= KeycloakUriBuilder.fromUri(authUri).path(ServiceUrlConstants.TOKEN_SERVICE_LOGOUT_PATH)\n+<h2><a href=\"<%= KeycloakUriBuilder.fromUri(WebAppHelper.getAuthUri()).path(ServiceUrlConstants.TOKEN_SERVICE_LOGOUT_PATH)\n.queryParam(\"redirect_uri\", \"http://localhost:8080/hello-world-authz-service\").build(\"hello-world-authz\").toString()%>\">Logout</a></h2>\n<h3>Your permissions are:</h3>\n"
},
{
"change_type": "ADD",
"old_path": null,
"new_path": "testsuite/integration-arquillian/test-apps/servlet-authz/src/main/java/org/keycloak/testsuite/servletauthz/WebAppHelper.java",
"diff": "+/*\n+ * Copyright 2023 Red Hat, Inc. and/or its affiliates\n+ * and other contributors as indicated by the @author tags.\n+ *\n+ * Licensed under the Apache License, Version 2.0 (the \"License\");\n+ * you may not use this file except in compliance with the License.\n+ * You may obtain a copy of the License at\n+ *\n+ * http://www.apache.org/licenses/LICENSE-2.0\n+ *\n+ * Unless required by applicable law or agreed to in writing, software\n+ * distributed under the License is distributed on an \"AS IS\" BASIS,\n+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n+ *\n+ * See the License for the specific language governing permissions and\n+ * limitations under the License.\n+ *\n+ */\n+\n+package org.keycloak.testsuite.servletauthz;\n+\n+/**\n+ * @author <a href=\"mailto:mposolda@redhat.com\">Marek Posolda</a>\n+ */\n+public class WebAppHelper {\n+\n+ public static String getAuthUri() {\n+ boolean isTLSEnabled = Boolean.parseBoolean(System.getProperty(\"auth.server.ssl.required\", \"true\"));\n+ String authPort = isTLSEnabled ? System.getProperty(\"auth.server.https.port\", \"8543\") : System.getProperty(\"auth.server.http.port\", \"8180\");\n+ String authScheme = isTLSEnabled ? \"https\" : \"http\";\n+ return authScheme + \"://localhost:\" + authPort + \"/auth\";\n+ }\n+}\n"
},
{
"change_type": "MODIFY",
"old_path": "testsuite/integration-arquillian/test-apps/servlet-authz/src/main/webapp/logout-include.jsp",
"new_path": "testsuite/integration-arquillian/test-apps/servlet-authz/src/main/webapp/logout-include.jsp",
"diff": "<%@ page import=\"org.keycloak.common.util.KeycloakUriBuilder\" %>\n<%@ page import=\"org.keycloak.constants.ServiceUrlConstants\" %>\n+<%@ page import=\"org.keycloak.testsuite.servletauthz.WebAppHelper\" %>\n<%\nString scheme = request.getScheme();\nString host = request.getServerName();\nint port = request.getServerPort();\nString contextPath = request.getContextPath();\nString redirectUri = scheme + \"://\" + host + \":\" + port + contextPath;\n-\n-\n- boolean isTLSEnabled = Boolean.parseBoolean(System.getProperty(\"auth.server.ssl.required\", \"true\"));\n- String authPort = isTLSEnabled ? System.getProperty(\"auth.server.https.port\", \"8543\") : System.getProperty(\"auth.server.http.port\", \"8180\");\n- String authScheme = isTLSEnabled ? \"https\" : \"http\";\n- String authHost = System.getProperty(\"auth.server.host\", \"localhost\");\n- String authUri = authScheme + \"://\" + authHost + \":\" + authPort + \"/auth\";\n%>\n-<h2>Click here <a href=\"<%= KeycloakUriBuilder.fromUri(authUri).path(ServiceUrlConstants.TOKEN_SERVICE_LOGOUT_PATH)\n+<h2>Click here <a href=\"<%= KeycloakUriBuilder.fromUri(WebAppHelper.getAuthUri()).path(ServiceUrlConstants.TOKEN_SERVICE_LOGOUT_PATH)\n.build(\"servlet-authz\").toString()%>\">Sign Out</a></h2>\n\\ No newline at end of file\n"
},
{
"change_type": "ADD",
"old_path": null,
"new_path": "testsuite/integration-arquillian/test-apps/servlet-policy-enforcer/src/main/java/org/keycloak/testsuite/example/WebAppHelper.java",
"diff": "+/*\n+ * Copyright 2023 Red Hat, Inc. and/or its affiliates\n+ * and other contributors as indicated by the @author tags.\n+ *\n+ * Licensed under the Apache License, Version 2.0 (the \"License\");\n+ * you may not use this file except in compliance with the License.\n+ * You may obtain a copy of the License at\n+ *\n+ * http://www.apache.org/licenses/LICENSE-2.0\n+ *\n+ * Unless required by applicable law or agreed to in writing, software\n+ * distributed under the License is distributed on an \"AS IS\" BASIS,\n+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n+ *\n+ * See the License for the specific language governing permissions and\n+ * limitations under the License.\n+ *\n+ */\n+\n+package org.keycloak.testsuite.example;\n+\n+/**\n+ * @author <a href=\"mailto:mposolda@redhat.com\">Marek Posolda</a>\n+ */\n+public class WebAppHelper {\n+\n+ public static String getAuthUri() {\n+ boolean isTLSEnabled = Boolean.parseBoolean(System.getProperty(\"auth.server.ssl.required\", \"true\"));\n+ String authPort = isTLSEnabled ? System.getProperty(\"auth.server.https.port\", \"8543\") : System.getProperty(\"auth.server.http.port\", \"8180\");\n+ String authScheme = isTLSEnabled ? \"https\" : \"http\";\n+ return authScheme + \"://localhost:\" + authPort + \"/auth\";\n+ }\n+}\n"
},
{
"change_type": "MODIFY",
"old_path": "testsuite/integration-arquillian/test-apps/servlet-policy-enforcer/src/main/webapp/logout-include.jsp",
"new_path": "testsuite/integration-arquillian/test-apps/servlet-policy-enforcer/src/main/webapp/logout-include.jsp",
"diff": "<%@ page import=\"org.keycloak.common.util.KeycloakUriBuilder\" %>\n<%@ page import=\"org.keycloak.constants.ServiceUrlConstants\" %>\n+<%@ page import=\"org.keycloak.testsuite.example.WebAppHelper\" %>\n<%\nString scheme = request.getScheme();\nString host = request.getServerName();\nint port = request.getServerPort();\nString contextPath = request.getContextPath();\nString redirectUri = scheme + \"://\" + host + \":\" + port + contextPath;\n-\n-\n- boolean isTLSEnabled = Boolean.parseBoolean(System.getProperty(\"auth.server.ssl.required\", \"true\"));\n- String authPort = isTLSEnabled ? System.getProperty(\"auth.server.https.port\", \"8543\") : System.getProperty(\"auth.server.http.port\", \"8180\");\n- String authScheme = isTLSEnabled ? \"https\" : \"http\";\n- String authHost = System.getProperty(\"auth.server.host\", \"localhost\");\n- String authUri = authScheme + \"://\" + authHost + \":\" + authPort + \"/auth\";\n%>\n-<h2>Click here <a href=\"<%= KeycloakUriBuilder.fromUri(authUri).path(ServiceUrlConstants.TOKEN_SERVICE_LOGOUT_PATH)\n+<h2>Click here <a href=\"<%= KeycloakUriBuilder.fromUri(WebAppHelper.getAuthUri()).path(ServiceUrlConstants.TOKEN_SERVICE_LOGOUT_PATH)\n.build(\"servlet-policy-enforcer-authz\").toString()%>\">Sign Out</a></h2>\n\\ No newline at end of file\n"
}
] | Java | Apache License 2.0 | keycloak/keycloak | Some authorization adapter test failing on Java 17
Closes #16216 |
339,400 | 20.12.2022 13:37:58 | 10,800 | ae74cadcfcefec85d8fa7942cfd3594c0f4fd341 | Add missing < to Javadoc | [
{
"change_type": "MODIFY",
"old_path": "services/src/main/java/org/keycloak/authentication/authenticators/browser/ScriptBasedAuthenticator.java",
"new_path": "services/src/main/java/org/keycloak/authentication/authenticators/browser/ScriptBasedAuthenticator.java",
"diff": "@@ -50,7 +50,7 @@ import java.util.Map;\n* <li>{@code session} the active {@link KeycloakSession}</li>\n* <li>{@code authenticationSession} the current {@link org.keycloak.sessions.AuthenticationSessionModel}</li>\n* <li>{@code httpRequest} the current {@link org.keycloak.http.HttpRequest}</li>\n- * <li>{@code LOG} a {@link org.jboss.logging.Logger} scoped to {@link ScriptBasedAuthenticator}/li>\n+ * <li>{@code LOG} a {@link org.jboss.logging.Logger} scoped to {@link ScriptBasedAuthenticator}</li>\n* </ol>\n* </p>\n* <p>\n"
}
] | Java | Apache License 2.0 | keycloak/keycloak | Add missing < to Javadoc |
339,281 | 04.01.2023 12:12:26 | -3,600 | 380df3bedfc8860b6d3a393417e03af67c4b3446 | Field generator: getCollectionElementClass method not generated when no addElement method is present in interface
Closes | [
{
"change_type": "MODIFY",
"old_path": "model/build-processor/src/main/java/org/keycloak/models/map/processor/GenerateEntityImplementationsProcessor.java",
"new_path": "model/build-processor/src/main/java/org/keycloak/models/map/processor/GenerateEntityImplementationsProcessor.java",
"diff": "@@ -177,15 +177,14 @@ public class GenerateEntityImplementationsProcessor extends AbstractGenerateEnti\npw.println(\" return FIELD_NAME_CAMEL_CASE;\");\npw.println(\" }\");\n- FieldAccessorType.getMethod(FieldAccessorType.COLLECTION_ADD, methods, fieldName, types, fieldType).ifPresent(method -> {\n- TypeMirror firstParameterType = method.getParameters().get(0).asType();\n+ FieldAccessorType.getMethod(FieldAccessorType.GETTER, methods, fieldName, types, fieldType).ifPresent(method -> {\n+ if (Util.isCollectionType((TypeElement) types.asElement(types.erasure(fieldType)))) {\n+ TypeMirror firstParameterType = Util.getGenericsDeclaration(method.getReturnType()).get(0);\npw.println(\" @SuppressWarnings(\\\"unchecked\\\") @Override public Class<?> getCollectionElementClass() {\");\npw.println(\" return \" + types.erasure(firstParameterType) + \".class;\");\npw.println(\" }\");\n- });\n- FieldAccessorType.getMethod(FieldAccessorType.GETTER, methods, fieldName, types, fieldType).ifPresent(method -> {\n- if (Util.isMapType((TypeElement) types.asElement(types.erasure(fieldType)))) {\n+ } else if (Util.isMapType((TypeElement) types.asElement(types.erasure(fieldType)))) {\nTypeMirror firstParameterType = Util.getGenericsDeclaration(method.getReturnType()).get(0);\nTypeMirror secondParameterType = Util.getGenericsDeclaration(method.getReturnType()).get(1);\n"
},
{
"change_type": "MODIFY",
"old_path": "model/build-processor/src/main/java/org/keycloak/models/map/processor/Util.java",
"new_path": "model/build-processor/src/main/java/org/keycloak/models/map/processor/Util.java",
"diff": "package org.keycloak.models.map.processor;\nimport org.keycloak.models.map.annotations.IgnoreForEntityImplementationGenerator;\n-import java.util.Arrays;\n+import java.util.ArrayList;\nimport java.util.HashMap;\nimport java.util.HashSet;\nimport java.util.LinkedHashSet;\n@@ -45,8 +45,9 @@ import javax.lang.model.util.SimpleTypeVisitor8;\n*/\npublic class Util {\n- private static final HashSet<String> SET_TYPES = new HashSet<>(Arrays.asList(Set.class.getCanonicalName(), TreeSet.class.getCanonicalName(), HashSet.class.getCanonicalName(), LinkedHashSet.class.getCanonicalName()));\n- private static final HashSet<String> MAP_TYPES = new HashSet<>(Arrays.asList(Map.class.getCanonicalName(), HashMap.class.getCanonicalName()));\n+ private static final Set<String> LIST_TYPES = Set.of(List.class.getCanonicalName(), ArrayList.class.getCanonicalName(), LinkedList.class.getCanonicalName());\n+ private static final Set<String> SET_TYPES = Set.of(Set.class.getCanonicalName(), TreeSet.class.getCanonicalName(), HashSet.class.getCanonicalName(), LinkedHashSet.class.getCanonicalName());\n+ private static final Set<String> MAP_TYPES = Set.of(Map.class.getCanonicalName(), HashMap.class.getCanonicalName());\npublic static List<TypeMirror> getGenericsDeclaration(TypeMirror fieldType) {\nList<TypeMirror> res = new LinkedList<>();\n@@ -69,6 +70,15 @@ public class Util {\n.collect(Collectors.joining(\", \"));\n}\n+ public static boolean isCollectionType(TypeElement typeElement) {\n+ return isListType(typeElement) || isSetType(typeElement);\n+ }\n+\n+ public static boolean isListType(TypeElement typeElement) {\n+ Name name = typeElement.getQualifiedName();\n+ return LIST_TYPES.contains(name.toString());\n+ }\n+\npublic static boolean isSetType(TypeElement typeElement) {\nName name = typeElement.getQualifiedName();\nreturn SET_TYPES.contains(name.toString());\n"
}
] | Java | Apache License 2.0 | keycloak/keycloak | Field generator: getCollectionElementClass method not generated when no addElement method is present in interface
Closes #16255 |
339,465 | 05.01.2023 11:51:00 | -3,600 | e374e309c65c4f229db077b127c98d990e00aeb8 | Deprecate SHA1 based algorithms for sign SAML documents and assertions
Closes | [
{
"change_type": "MODIFY",
"old_path": "testsuite/integration-arquillian/tests/base/src/test/resources/adapter-test/keycloak-saml/testsaml.json",
"new_path": "testsuite/integration-arquillian/tests/base/src/test/resources/adapter-test/keycloak-saml/testsaml.json",
"diff": "\"attributes\": {\n\"saml.server.signature\": \"true\",\n\"saml.client.signature\": \"true\",\n- \"saml.signature.algorithm\": \"RSA_SHA1\",\n+ \"saml.signature.algorithm\": \"RSA_SHA256\",\n\"saml.authnstatement\": \"true\",\n\"saml.signing.certificate\": \"MIIB0DCCATkCBgFJH5u0EDANBgkqhkiG9w0BAQsFADAuMSwwKgYDVQQDEyNodHRwOi8vbG9jYWxob3N0OjgwODAvZW1wbG95ZWUtc2lnLzAeFw0xNDEwMTcxOTMzNThaFw0yNDEwMTcxOTM1MzhaMC4xLDAqBgNVBAMTI2h0dHA6Ly9sb2NhbGhvc3Q6ODA4MC9lbXBsb3llZS1zaWcvMIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQC+9kVgPFpshjS2aT2g52lqTv2lqb1jgvXZVk7iFF4LAO6SdCXKXRZI4SuzIRkVNpE1a42V1kQRlaozoFklgvX5sje8tkpa9ylq+bxGXM9RRycqRu2B+oWUV7Aqq7Bs0Xud0WeHQYRcEoCjqsFKGy65qkLRDdT70FTJgpSHts+gDwIDAQABMA0GCSqGSIb3DQEBCwUAA4GBACKyPLGqMX8GsIrCfJU8eVnpaqzTXMglLVo/nTcfAnWe9UAdVe8N3a2PXpDBvuqNA/DEAhVcQgxdlOTWnB6s8/yLTRuH0bZgb3qGdySif+lU+E7zZ/SiDzavAvn+ABqemnzHcHyhYO+hNRGHvUbW5OAii9Vdjhm8BI32YF1NwhKp\"\n}\n"
},
{
"change_type": "MODIFY",
"old_path": "themes/src/main/resources/theme/base/admin/messages/admin-messages_en.properties",
"new_path": "themes/src/main/resources/theme/base/admin/messages/admin-messages_en.properties",
"diff": "@@ -353,7 +353,7 @@ sign-documents-redirect-enable-key-info-ext.tooltip=When signing SAML documents\nsign-assertions=Sign Assertions\nsign-assertions.tooltip=Should assertions inside SAML documents be signed? This setting is not needed if document is already being signed.\nsignature-algorithm=Signature Algorithm\n-signature-algorithm.tooltip=The signature algorithm to use to sign documents.\n+signature-algorithm.tooltip=The signature algorithm to use to sign documents. Note that 'SHA1' based algorithms are deprecated and can be removed in the future. It is recommended to stick to some more secure algorithm instead of '*_SHA1'\ncanonicalization-method=Canonicalization Method\ncanonicalization-method.tooltip=Canonicalization Method for XML signatures.\nencrypt-assertions=Encrypt Assertions\n"
}
] | Java | Apache License 2.0 | keycloak/keycloak | Deprecate SHA1 based algorithms for sign SAML documents and assertions
Closes #16240 |
339,177 | 20.11.2022 20:07:17 | -3,600 | dbe0c27bcf04ec267e768d45a7e95800c19e52a0 | Allowing client registration access token rotation deactivation | [
{
"change_type": "ADD",
"old_path": null,
"new_path": "server-spi-private/src/main/java/org/keycloak/models/ClientRegistrationAccessTokenConstants.java",
"diff": "+/*\n+ * Copyright 2022 Red Hat, Inc. and/or its affiliates\n+ * and other contributors as indicated by the @author tags.\n+ *\n+ * Licensed under the Apache License, Version 2.0 (the \"License\");\n+ * you may not use this file except in compliance with the License.\n+ * You may obtain a copy of the License at\n+ *\n+ * http://www.apache.org/licenses/LICENSE-2.0\n+ *\n+ * Unless required by applicable law or agreed to in writing, software\n+ * distributed under the License is distributed on an \"AS IS\" BASIS,\n+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n+ * See the License for the specific language governing permissions and\n+ * limitations under the License.\n+ */\n+\n+package org.keycloak.models;\n+\n+public class ClientRegistrationAccessTokenConstants {\n+\n+ public static final String ROTATION_ENABLED = \"client.registration.access.token.enabled\";\n+\n+ private ClientRegistrationAccessTokenConstants(){}\n+\n+}\n"
},
{
"change_type": "ADD",
"old_path": null,
"new_path": "services/src/main/java/org/keycloak/services/clientpolicy/executor/RegistrationAccessTokenRotationDisabledExecutor.java",
"diff": "+/*\n+ * Copyright 2022 Red Hat, Inc. and/or its affiliates\n+ * and other contributors as indicated by the @author tags.\n+ *\n+ * Licensed under the Apache License, Version 2.0 (the \"License\");\n+ * you may not use this file except in compliance with the License.\n+ * You may obtain a copy of the License at\n+ *\n+ * http://www.apache.org/licenses/LICENSE-2.0\n+ *\n+ * Unless required by applicable law or agreed to in writing, software\n+ * distributed under the License is distributed on an \"AS IS\" BASIS,\n+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n+ * See the License for the specific language governing permissions and\n+ * limitations under the License.\n+ */\n+\n+package org.keycloak.services.clientpolicy.executor;\n+\n+import org.keycloak.models.ClientRegistrationAccessTokenConstants;\n+import org.keycloak.models.KeycloakSession;\n+import org.keycloak.representations.idm.ClientPolicyExecutorConfigurationRepresentation;\n+import org.keycloak.services.clientpolicy.ClientPolicyContext;\n+import org.keycloak.services.clientpolicy.ClientPolicyException;\n+\n+public class RegistrationAccessTokenRotationDisabledExecutor implements ClientPolicyExecutorProvider<ClientPolicyExecutorConfigurationRepresentation> {\n+\n+ private final String providerId;\n+ private final KeycloakSession session;\n+\n+ public RegistrationAccessTokenRotationDisabledExecutor(String providerId, KeycloakSession session) {\n+ this.providerId = providerId;\n+ this.session = session;\n+ }\n+\n+ @Override\n+ public String getProviderId() {\n+ return providerId;\n+ }\n+\n+ @Override\n+ public void executeOnEvent(ClientPolicyContext context) throws ClientPolicyException {\n+ if (session.getAttribute(ClientRegistrationAccessTokenConstants.ROTATION_ENABLED) == null){\n+ return;\n+ }\n+ session.setAttribute(ClientRegistrationAccessTokenConstants.ROTATION_ENABLED, false);\n+ }\n+\n+}\n"
},
{
"change_type": "ADD",
"old_path": null,
"new_path": "services/src/main/java/org/keycloak/services/clientpolicy/executor/RegistrationAccessTokenRotationDisabledExecutorFactory.java",
"diff": "+/*\n+ * Copyright 2022 Red Hat, Inc. and/or its affiliates\n+ * and other contributors as indicated by the @author tags.\n+ *\n+ * Licensed under the Apache License, Version 2.0 (the \"License\");\n+ * you may not use this file except in compliance with the License.\n+ * You may obtain a copy of the License at\n+ *\n+ * http://www.apache.org/licenses/LICENSE-2.0\n+ *\n+ * Unless required by applicable law or agreed to in writing, software\n+ * distributed under the License is distributed on an \"AS IS\" BASIS,\n+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n+ * See the License for the specific language governing permissions and\n+ * limitations under the License.\n+ */\n+\n+package org.keycloak.services.clientpolicy.executor;\n+\n+import java.util.Collections;\n+import java.util.List;\n+import org.keycloak.Config;\n+import org.keycloak.models.KeycloakSession;\n+import org.keycloak.models.KeycloakSessionFactory;\n+import org.keycloak.provider.ProviderConfigProperty;\n+\n+public class RegistrationAccessTokenRotationDisabledExecutorFactory implements ClientPolicyExecutorProviderFactory {\n+\n+ public static final String PROVIDER_ID = \"registration-access-token-rotation-disabled\";\n+\n+ @Override\n+ public String getHelpText() {\n+ return \"Disables registration access rotation for the client.\";\n+ }\n+\n+ @Override\n+ public List<ProviderConfigProperty> getConfigProperties() {\n+ return Collections.emptyList();\n+ }\n+\n+ @Override\n+ public ClientPolicyExecutorProvider create(KeycloakSession session) {\n+ return new RegistrationAccessTokenRotationDisabledExecutor(getId(), session);\n+ }\n+\n+ @Override\n+ public void init(Config.Scope config) {\n+\n+ }\n+\n+ @Override\n+ public void postInit(KeycloakSessionFactory factory) {\n+\n+ }\n+\n+ @Override\n+ public void close() {\n+\n+ }\n+\n+ @Override\n+ public String getId() {\n+ return PROVIDER_ID;\n+ }\n+\n+ @Override\n+ public boolean isSupported() {\n+ return true;\n+ }\n+}\n"
},
{
"change_type": "MODIFY",
"old_path": "services/src/main/java/org/keycloak/services/clientregistration/AbstractClientRegistrationProvider.java",
"new_path": "services/src/main/java/org/keycloak/services/clientregistration/AbstractClientRegistrationProvider.java",
"diff": "@@ -22,6 +22,7 @@ import org.keycloak.events.EventBuilder;\nimport org.keycloak.events.EventType;\nimport org.keycloak.models.ClientInitialAccessModel;\nimport org.keycloak.models.ClientModel;\n+import org.keycloak.models.ClientRegistrationAccessTokenConstants;\nimport org.keycloak.models.KeycloakSession;\nimport org.keycloak.models.ModelDuplicateException;\nimport org.keycloak.models.RealmModel;\n@@ -142,6 +143,7 @@ public abstract class AbstractClientRegistrationProvider implements ClientRegist\nevent.event(EventType.CLIENT_UPDATE).client(clientId);\nClientModel client = session.getContext().getRealm().getClientByClientId(clientId);\n+ session.setAttribute(ClientRegistrationAccessTokenConstants.ROTATION_ENABLED, true);\nRegistrationAuth registrationAuth = auth.requireUpdate(context, client);\nif (!client.getClientId().equals(rep.getClientId())) {\n@@ -165,9 +167,15 @@ public abstract class AbstractClientRegistrationProvider implements ClientRegist\n}\nif (auth.isRegistrationAccessToken()) {\n- String registrationAccessToken = ClientRegistrationTokenUtils.updateRegistrationAccessToken(session, client, auth.getRegistrationAuth());\n+ String registrationAccessToken;\n+ if ((boolean) session.getAttribute(ClientRegistrationAccessTokenConstants.ROTATION_ENABLED)) {\n+ registrationAccessToken = ClientRegistrationTokenUtils.updateRegistrationAccessToken(session, client, auth.getRegistrationAuth());\n+ } else {\n+ registrationAccessToken = ClientRegistrationTokenUtils.updateTokenSignature(session, auth);\n+ }\nrep.setRegistrationAccessToken(registrationAccessToken);\n}\n+ session.removeAttribute(ClientRegistrationAccessTokenConstants.ROTATION_ENABLED);\ntry {\nsession.getContext().setClient(client);\n"
},
{
"change_type": "MODIFY",
"old_path": "services/src/main/resources/META-INF/services/org.keycloak.services.clientpolicy.executor.ClientPolicyExecutorProviderFactory",
"new_path": "services/src/main/resources/META-INF/services/org.keycloak.services.clientpolicy.executor.ClientPolicyExecutorProviderFactory",
"diff": "@@ -19,3 +19,4 @@ org.keycloak.services.clientpolicy.executor.ClientSecretRotationExecutorFactory\norg.keycloak.services.clientpolicy.executor.RejectRequestExecutorFactory\norg.keycloak.services.clientpolicy.executor.IntentClientBindCheckExecutorFactory\norg.keycloak.services.clientpolicy.executor.SuppressRefreshTokenRotationExecutorFactory\n+org.keycloak.services.clientpolicy.executor.RegistrationAccessTokenRotationDisabledExecutorFactory\n"
},
{
"change_type": "MODIFY",
"old_path": "testsuite/integration-arquillian/tests/base/src/test/java/org/keycloak/testsuite/client/ClientPoliciesTest.java",
"new_path": "testsuite/integration-arquillian/tests/base/src/test/java/org/keycloak/testsuite/client/ClientPoliciesTest.java",
"diff": "@@ -111,6 +111,7 @@ import org.keycloak.services.clientpolicy.executor.FullScopeDisabledExecutorFact\nimport org.keycloak.services.clientpolicy.executor.HolderOfKeyEnforcerExecutorFactory;\nimport org.keycloak.services.clientpolicy.executor.IntentClientBindCheckExecutorFactory;\nimport org.keycloak.services.clientpolicy.executor.PKCEEnforcerExecutorFactory;\n+import org.keycloak.services.clientpolicy.executor.RegistrationAccessTokenRotationDisabledExecutorFactory;\nimport org.keycloak.services.clientpolicy.executor.RejectRequestExecutorFactory;\nimport org.keycloak.services.clientpolicy.executor.RejectResourceOwnerPasswordCredentialsGrantExecutorFactory;\nimport org.keycloak.services.clientpolicy.executor.SecureClientAuthenticatorExecutorFactory;\n@@ -3391,6 +3392,38 @@ public class ClientPoliciesTest extends AbstractClientPoliciesTest {\nassertEquals(\"no claim for an intent value for ID token\" , oauth.getCurrentFragment().get(OAuth2Constants.ERROR_DESCRIPTION));\n}\n+ @Test\n+ public void testRegistrationAccessTokenRotationDisabledExecutor() throws Exception {\n+ // register profiles - client autoConfigured to disable registration access token rotation\n+ String json = new ClientProfilesBuilder().addProfile(\n+ new ClientProfileBuilder().createProfile(PROFILE_NAME, \"Test Profile\")\n+ .addExecutor(\n+ RegistrationAccessTokenRotationDisabledExecutorFactory.PROVIDER_ID,\n+ new ClientPolicyExecutorConfigurationRepresentation()\n+ )\n+ .toRepresentation()\n+ ).toString();\n+ updateProfiles(json);\n+\n+ // register policies\n+ json = new ClientPoliciesBuilder().addPolicy(\n+ new ClientPolicyBuilder().createPolicy(POLICY_NAME, \"Test Policy\", Boolean.TRUE)\n+ .addCondition(AnyClientConditionFactory.PROVIDER_ID,\n+ createAnyClientConditionConfig())\n+ .addProfile(PROFILE_NAME)\n+ .toRepresentation()\n+ ).toString();\n+ updatePolicies(json);\n+\n+ String clientId = createClientDynamically(generateSuffixedName(CLIENT_NAME), r -> {});\n+ OIDCClientRepresentation createdClient = getClientDynamically(clientId);\n+\n+ updateClientDynamically(clientId, clientRep ->\n+ clientRep.setTokenEndpointAuthMethod(OIDCLoginProtocol.CLIENT_SECRET_BASIC));\n+\n+ assertEquals(createdClient.getRegistrationAccessToken(), getClientDynamically(clientId).getRegistrationAccessToken());\n+ }\n+\nprivate void openVerificationPage(String verificationUri) {\ndriver.navigate().to(verificationUri);\n}\n"
}
] | Java | Apache License 2.0 | keycloak/keycloak | Allowing client registration access token rotation deactivation |
339,185 | 05.01.2023 17:35:32 | -3,600 | 7708e2cc5c4cc3ae30ec0b858a7d12f9c4fb510b | Fix putAll issues
Closes: | [
{
"change_type": "MODIFY",
"old_path": "model/infinispan/src/main/java/org/keycloak/models/sessions/infinispan/InfinispanUserSessionProvider.java",
"new_path": "model/infinispan/src/main/java/org/keycloak/models/sessions/infinispan/InfinispanUserSessionProvider.java",
"diff": "@@ -865,7 +865,9 @@ public class InfinispanUserSessionProvider implements UserSessionProvider {\noffline ? SessionTimeouts::getOfflineSessionLifespanMs : SessionTimeouts::getUserSessionLifespanMs,\noffline ? SessionTimeouts::getOfflineSessionMaxIdleMs : SessionTimeouts::getUserSessionMaxIdleMs);\n} else {\n+ Retry.executeWithBackoff((int iteration) -> {\ncache.putAll(sessionsById);\n+ }, 10, 10);\n}\n// put all entities to the remoteCache (if exists)\n@@ -899,15 +901,17 @@ public class InfinispanUserSessionProvider implements UserSessionProvider {\n}\n// Import client sessions\n- Cache<UUID, SessionEntityWrapper<AuthenticatedClientSessionEntity>> clientSessCache = offline ? offlineClientSessionCache : clientSessionCache;\n- clientSessCache = CacheDecorators.skipCacheLoaders(clientSessCache);\n+ Cache<UUID, SessionEntityWrapper<AuthenticatedClientSessionEntity>> clientSessCache =\n+ CacheDecorators.skipCacheLoaders(offline ? offlineClientSessionCache : clientSessionCache);\nif (importWithExpiration) {\nimportSessionsWithExpiration(clientSessionsById, clientSessCache,\noffline ? SessionTimeouts::getOfflineClientSessionLifespanMs : SessionTimeouts::getClientSessionLifespanMs,\noffline ? SessionTimeouts::getOfflineClientSessionMaxIdleMs : SessionTimeouts::getClientSessionMaxIdleMs);\n} else {\n+ Retry.executeWithBackoff((int iteration) -> {\nclientSessCache.putAll(clientSessionsById);\n+ }, 10, 10);\n}\n// put all entities to the remoteCache (if exists)\n"
}
] | Java | Apache License 2.0 | keycloak/keycloak | Fix putAll issues
Closes: #16287 |
339,177 | 06.01.2023 14:04:48 | -3,600 | 141c9dd80380526c4cfcdc4f2853db920be674f7 | update-email: email change does not affect the username when "Email as username" option is checked
Closes | [
{
"change_type": "MODIFY",
"old_path": "services/src/main/java/org/keycloak/userprofile/AbstractUserProfileProvider.java",
"new_path": "services/src/main/java/org/keycloak/userprofile/AbstractUserProfileProvider.java",
"diff": "@@ -80,6 +80,8 @@ public abstract class AbstractUserProfileProvider<U extends UserProfileProvider>\ncase ACCOUNT:\ncase UPDATE_PROFILE:\nreturn realm.isEditUsernameAllowed();\n+ case UPDATE_EMAIL:\n+ return realm.isRegistrationEmailAsUsername();\ncase USER_API:\nreturn true;\ndefault:\n"
},
{
"change_type": "MODIFY",
"old_path": "testsuite/integration-arquillian/tests/base/src/test/java/org/keycloak/testsuite/actions/AbstractAppInitiatedActionUpdateEmailTest.java",
"new_path": "testsuite/integration-arquillian/tests/base/src/test/java/org/keycloak/testsuite/actions/AbstractAppInitiatedActionUpdateEmailTest.java",
"diff": "@@ -20,6 +20,7 @@ import org.jboss.arquillian.graphene.page.Page;\nimport org.junit.Assert;\nimport org.junit.Before;\nimport org.junit.Test;\n+import org.keycloak.admin.client.resource.RealmResource;\nimport org.keycloak.common.Profile;\nimport org.keycloak.models.UserModel;\nimport org.keycloak.representations.idm.RealmRepresentation;\n@@ -59,6 +60,12 @@ public abstract class AbstractAppInitiatedActionUpdateEmailTest extends Abstract\nApiUtil.createUserAndResetPasswordWithAdminClient(testRealm(), user, \"password\");\n}\n+ private void setRegistrationEmailAsUsername(RealmResource realmResource, boolean enabled) {\n+ RealmRepresentation realmRepresentation = realmResource.toRepresentation();\n+ realmRepresentation.setRegistrationEmailAsUsername(enabled);\n+ realmResource.update(realmRepresentation);\n+ }\n+\nprotected void prepareUser(UserRepresentation user){\n}\n@@ -127,4 +134,22 @@ public abstract class AbstractAppInitiatedActionUpdateEmailTest extends Abstract\nAssert.assertEquals(\"test-user@localhost\", user.getEmail());\n}\n+ @Test\n+ public void updateWithEmailAsUsernameEnabled() throws Exception {\n+ Boolean genuineRegistrationEmailAsUsername = testRealm()\n+ .toRepresentation()\n+ .isRegistrationEmailAsUsername();\n+\n+ setRegistrationEmailAsUsername(testRealm(), true);\n+ try {\n+ changeEmailUsingAIA(\"new@email.com\");\n+\n+ UserRepresentation user = ActionUtil.findUserWithAdminClient(adminClient, \"new@email.com\");\n+ Assert.assertNotNull(user);\n+ } finally {\n+ setRegistrationEmailAsUsername(testRealm(), genuineRegistrationEmailAsUsername);\n+ }\n+ }\n+\n+ protected abstract void changeEmailUsingAIA(String newEmail) throws Exception;\n}\n"
},
{
"change_type": "MODIFY",
"old_path": "testsuite/integration-arquillian/tests/base/src/test/java/org/keycloak/testsuite/actions/AbstractRequiredActionUpdateEmailTest.java",
"new_path": "testsuite/integration-arquillian/tests/base/src/test/java/org/keycloak/testsuite/actions/AbstractRequiredActionUpdateEmailTest.java",
"diff": "@@ -23,6 +23,7 @@ import org.junit.Assert;\nimport org.junit.Before;\nimport org.junit.Rule;\nimport org.junit.Test;\n+import org.keycloak.admin.client.resource.RealmResource;\nimport org.keycloak.common.Profile;\nimport org.keycloak.models.UserModel;\nimport org.keycloak.representations.idm.RealmRepresentation;\n@@ -74,6 +75,12 @@ public abstract class AbstractRequiredActionUpdateEmailTest extends AbstractTest\nApiUtil.createUserAndResetPasswordWithAdminClient(testRealm(), user, \"password\");\n}\n+ private void setRegistrationEmailAsUsername(RealmResource realmResource, boolean enabled) {\n+ RealmRepresentation realmRepresentation = realmResource.toRepresentation();\n+ realmRepresentation.setRegistrationEmailAsUsername(enabled);\n+ realmResource.update(realmRepresentation);\n+ }\n+\nprotected void prepareUser(UserRepresentation user) {\n}\n@@ -152,4 +159,23 @@ public abstract class AbstractRequiredActionUpdateEmailTest extends AbstractTest\nevents.assertEmpty();\n}\n+\n+ @Test\n+ public void updateEmailWithEmailAsUsernameEnabled() throws Exception {\n+ Boolean genuineRegistrationEmailAsUsername = testRealm()\n+ .toRepresentation()\n+ .isRegistrationEmailAsUsername();\n+\n+ setRegistrationEmailAsUsername(testRealm(), true);\n+ try {\n+ changeEmailUsingRequiredAction(\"new@localhost\");\n+\n+ UserRepresentation user = ActionUtil.findUserWithAdminClient(adminClient, \"new@localhost\");\n+ Assert.assertNotNull(user);\n+ } finally {\n+ setRegistrationEmailAsUsername(testRealm(), genuineRegistrationEmailAsUsername);\n+ }\n+ }\n+\n+ protected abstract void changeEmailUsingRequiredAction(String newEmail) throws Exception;\n}\n"
},
{
"change_type": "MODIFY",
"old_path": "testsuite/integration-arquillian/tests/base/src/test/java/org/keycloak/testsuite/actions/AppInitiatedActionUpdateEmailTest.java",
"new_path": "testsuite/integration-arquillian/tests/base/src/test/java/org/keycloak/testsuite/actions/AppInitiatedActionUpdateEmailTest.java",
"diff": "@@ -22,21 +22,13 @@ import org.junit.Assert;\nimport org.junit.Test;\nimport org.keycloak.events.Details;\nimport org.keycloak.events.EventType;\n-import org.keycloak.representations.idm.RealmRepresentation;\nimport org.keycloak.representations.idm.UserRepresentation;\npublic class AppInitiatedActionUpdateEmailTest extends AbstractAppInitiatedActionUpdateEmailTest {\n@Test\n- public void updateEmail() {\n- doAIA();\n-\n- loginPage.login(\"test-user@localhost\", \"password\");\n-\n- emailUpdatePage.assertCurrent();\n- assertTrue(emailUpdatePage.isCancelDisplayed());\n-\n- emailUpdatePage.changeEmail(\"new@email.com\");\n+ public void updateEmail() throws Exception {\n+ changeEmailUsingAIA(\"new@email.com\");\nevents.expect(EventType.UPDATE_EMAIL).detail(Details.PREVIOUS_EMAIL, \"test-user@localhost\")\n.detail(Details.UPDATED_EMAIL, \"new@email.com\").assertEvent();\n@@ -48,4 +40,16 @@ public class AppInitiatedActionUpdateEmailTest extends AbstractAppInitiatedActio\nAssert.assertEquals(\"Tom\", user.getFirstName());\nAssert.assertEquals(\"Brady\", user.getLastName());\n}\n+\n+ @Override\n+ protected void changeEmailUsingAIA(String newEmail) throws Exception {\n+ doAIA();\n+\n+ loginPage.login(\"test-user@localhost\", \"password\");\n+\n+ emailUpdatePage.assertCurrent();\n+ assertTrue(emailUpdatePage.isCancelDisplayed());\n+\n+ emailUpdatePage.changeEmail(newEmail);\n+ }\n}\n"
},
{
"change_type": "MODIFY",
"old_path": "testsuite/integration-arquillian/tests/base/src/test/java/org/keycloak/testsuite/actions/AppInitiatedActionUpdateEmailWithVerificationTest.java",
"new_path": "testsuite/integration-arquillian/tests/base/src/test/java/org/keycloak/testsuite/actions/AppInitiatedActionUpdateEmailWithVerificationTest.java",
"diff": "@@ -58,22 +58,27 @@ public class AppInitiatedActionUpdateEmailWithVerificationTest extends AbstractA\nuser.setEmailVerified(true);\n}\n- @Test\n- public void updateEmail() throws IOException, MessagingException {\n+ @Override\n+ protected void changeEmailUsingAIA(String newEmail) throws Exception {\ndoAIA();\nloginPage.login(\"test-user@localhost\", \"password\");\nemailUpdatePage.assertCurrent();\nassertTrue(emailUpdatePage.isCancelDisplayed());\n- emailUpdatePage.changeEmail(\"new@localhost\");\n+ emailUpdatePage.changeEmail(newEmail);\n- events.expect(EventType.SEND_VERIFY_EMAIL).detail(Details.EMAIL, \"new@localhost\").assertEvent();\n+ events.expect(EventType.SEND_VERIFY_EMAIL).detail(Details.EMAIL, newEmail).assertEvent();\nAssert.assertEquals(\"test-user@localhost\", ActionUtil.findUserWithAdminClient(adminClient, \"test-user@localhost\").getEmail());\n- driver.navigate().to(fetchEmailConfirmationLink(\"new@localhost\"));\n+ driver.navigate().to(fetchEmailConfirmationLink(newEmail));\ninfoPage.assertCurrent();\n- assertEquals(\"The account email has been successfully updated to new@localhost.\", infoPage.getInfo());\n+ assertEquals(String.format(\"The account email has been successfully updated to %s.\", newEmail), infoPage.getInfo());\n+ }\n+\n+ @Test\n+ public void updateEmail() throws Exception {\n+ changeEmailUsingAIA(\"new@localhost\");\nevents.expect(EventType.UPDATE_EMAIL)\n.detail(Details.PREVIOUS_EMAIL, \"test-user@localhost\")\n"
},
{
"change_type": "MODIFY",
"old_path": "testsuite/integration-arquillian/tests/base/src/test/java/org/keycloak/testsuite/actions/RequiredActionUpdateEmailTest.java",
"new_path": "testsuite/integration-arquillian/tests/base/src/test/java/org/keycloak/testsuite/actions/RequiredActionUpdateEmailTest.java",
"diff": "@@ -19,7 +19,6 @@ package org.keycloak.testsuite.actions;\nimport static org.junit.Assert.assertEquals;\nimport static org.junit.Assert.assertFalse;\n-import org.junit.Assert;\nimport org.junit.Test;\nimport org.keycloak.events.Details;\nimport org.keycloak.events.EventType;\n@@ -29,25 +28,30 @@ import org.keycloak.testsuite.pages.AppPage;\npublic class RequiredActionUpdateEmailTest extends AbstractRequiredActionUpdateEmailTest {\n- @Test\n- public void updateEmail() {\n+ @Override\n+ protected void changeEmailUsingRequiredAction(String newEmail) {\nloginPage.open();\nloginPage.login(\"test-user@localhost\", \"password\");\nupdateEmailPage.assertCurrent();\n- updateEmailPage.changeEmail(\"new-email@localhost\");\n+ updateEmailPage.changeEmail(newEmail);\n+ }\n+\n+ @Test\n+ public void updateEmail() {\n+ changeEmailUsingRequiredAction(\"new@localhost\");\nevents.expectRequiredAction(EventType.UPDATE_EMAIL).detail(Details.PREVIOUS_EMAIL, \"test-user@localhost\")\n- .detail(Details.UPDATED_EMAIL, \"new-email@localhost\").assertEvent();\n+ .detail(Details.UPDATED_EMAIL, \"new@localhost\").assertEvent();\nassertEquals(AppPage.RequestType.AUTH_RESPONSE, appPage.getRequestType());\nevents.expectLogin().assertEvent();\n// assert user is really updated in persistent store\nUserRepresentation user = ActionUtil.findUserWithAdminClient(adminClient, \"test-user@localhost\");\n- assertEquals(\"new-email@localhost\", user.getEmail());\n+ assertEquals(\"new@localhost\", user.getEmail());\nassertEquals(\"Tom\", user.getFirstName());\nassertEquals(\"Brady\", user.getLastName());\nassertFalse(user.getRequiredActions().contains(UserModel.RequiredAction.UPDATE_EMAIL.name()));\n"
},
{
"change_type": "MODIFY",
"old_path": "testsuite/integration-arquillian/tests/base/src/test/java/org/keycloak/testsuite/actions/RequiredActionUpdateEmailTestWithVerificationTest.java",
"new_path": "testsuite/integration-arquillian/tests/base/src/test/java/org/keycloak/testsuite/actions/RequiredActionUpdateEmailTestWithVerificationTest.java",
"diff": "@@ -26,7 +26,6 @@ import javax.mail.Message;\nimport javax.mail.MessagingException;\nimport javax.mail.internet.MimeMessage;\nimport org.jboss.arquillian.graphene.page.Page;\n-import org.junit.Assert;\nimport org.junit.Rule;\nimport org.junit.Test;\nimport org.keycloak.events.Details;\n@@ -59,30 +58,35 @@ public class RequiredActionUpdateEmailTestWithVerificationTest extends AbstractR\ntestRealm.setVerifyEmail(true);\n}\n- @Test\n- public void updateEmail() throws IOException, MessagingException {\n+ @Override\n+ protected void changeEmailUsingRequiredAction(String newEmail) throws Exception {\nloginPage.open();\nloginPage.login(\"test-user@localhost\", \"password\");\nupdateEmailPage.assertCurrent();\n- updateEmailPage.changeEmail(\"new@localhost\");\n+ updateEmailPage.changeEmail(newEmail);\n- events.expect(EventType.SEND_VERIFY_EMAIL).detail(Details.EMAIL, \"new@localhost\").assertEvent();\n+ events.expect(EventType.SEND_VERIFY_EMAIL).detail(Details.EMAIL, newEmail).assertEvent();\nUserRepresentation user = ActionUtil.findUserWithAdminClient(adminClient, \"test-user@localhost\");\nassertEquals(\"test-user@localhost\", user.getEmail());\nassertTrue(user.getRequiredActions().contains(UserModel.RequiredAction.UPDATE_EMAIL.name()));\n- driver.navigate().to(fetchEmailConfirmationLink(\"new@localhost\"));\n+ driver.navigate().to(fetchEmailConfirmationLink(newEmail));\ninfoPage.assertCurrent();\nassertEquals(\"The account email has been successfully updated to new@localhost.\", infoPage.getInfo());\n+ }\n+\n+ @Test\n+ public void updateEmail() throws Exception {\n+ changeEmailUsingRequiredAction(\"new@localhost\");\nevents.expect(EventType.UPDATE_EMAIL)\n.detail(Details.PREVIOUS_EMAIL, \"test-user@localhost\")\n.detail(Details.UPDATED_EMAIL, \"new@localhost\");\n- user = ActionUtil.findUserWithAdminClient(adminClient, \"test-user@localhost\");\n+ UserRepresentation user = ActionUtil.findUserWithAdminClient(adminClient, \"test-user@localhost\");\nassertEquals(\"new@localhost\", user.getEmail());\nassertFalse(user.getRequiredActions().contains(UserModel.RequiredAction.UPDATE_EMAIL.name()));\n}\n"
}
] | Java | Apache License 2.0 | keycloak/keycloak | update-email: email change does not affect the username when "Email as username" option is checked (#15583)
Closes #13988 |
339,410 | 09.01.2023 13:12:58 | -3,600 | 665dec19c0cb4bb5f8632a79e62a89a03f3cf1f8 | Extend build time for CockroachDB
Closes | [
{
"change_type": "MODIFY",
"old_path": ".github/workflows/ci.yml",
"new_path": ".github/workflows/ci.yml",
"diff": "@@ -220,8 +220,8 @@ jobs:\nname: New Store IT\nneeds: [build, databases-new-store]\nruns-on: ubuntu-latest\n- # Currently, the run of CockroachDB (only branches and nightly runs) is the longest with ~45 minutes\n- timeout-minutes: 70\n+ # Currently, the run of CockroachDB (only branches and nightly runs) is the longest with 50-60 minutes\n+ timeout-minutes: 90\nstrategy:\nmatrix:\ndb: ${{ fromJson(needs.databases-new-store.outputs.db) }}\n"
}
] | Java | Apache License 2.0 | keycloak/keycloak | Extend build time for CockroachDB (#16315)
Closes #16313 |
339,458 | 04.01.2023 09:29:19 | 0 | d900540034d381816162bf9c2cf14ef1fb8a2208 | Fix NPE if user not exists
Check "userSession.getId().equals(clientUser.getId())" fails if getUserFromToken return non existed user. It is happens when AccessToken.subject relates to non existed user.
Closes | [
{
"change_type": "MODIFY",
"old_path": "services/src/main/java/org/keycloak/authorization/common/KeycloakIdentity.java",
"new_path": "services/src/main/java/org/keycloak/authorization/common/KeycloakIdentity.java",
"diff": "@@ -234,6 +234,9 @@ public class KeycloakIdentity implements Identity {\n}\nUserModel userSession = getUserFromToken();\n+ if (userSession == null) {\n+ throw new IllegalArgumentException(\"User from token not found\");\n+ }\nthis.resourceServer = clientUser != null && userSession.getId().equals(clientUser.getId());\n"
},
{
"change_type": "MODIFY",
"old_path": "services/src/main/java/org/keycloak/protocol/oidc/TokenManager.java",
"new_path": "services/src/main/java/org/keycloak/protocol/oidc/TokenManager.java",
"diff": "@@ -356,13 +356,10 @@ public class TokenManager {\n// Fallback to lookup user based on username (preferred_username claim)\nif (token.getPreferredUsername() != null) {\n- user = session.users().getUserByUsername(realm, token.getPreferredUsername());\n- if (user != null) {\n- return user;\n- }\n+ return session.users().getUserByUsername(realm, token.getPreferredUsername());\n}\n- return user;\n+ return null;\n}\n"
}
] | Java | Apache License 2.0 | keycloak/keycloak | Fix NPE if user not exists
Check "userSession.getId().equals(clientUser.getId())" fails if getUserFromToken return non existed user. It is happens when AccessToken.subject relates to non existed user.
Closes #16297 |
339,281 | 09.01.2023 12:43:09 | -3,600 | f11bef3e7f697935adf4c4a29e9225d62e5580d5 | EntityField `mapPut` and `collectionAdd` default methods doesn't insert an element when `get(e)` returns `null`
Closes | [
{
"change_type": "MODIFY",
"old_path": "model/map/src/main/java/org/keycloak/models/map/common/EntityField.java",
"new_path": "model/map/src/main/java/org/keycloak/models/map/common/EntityField.java",
"diff": "package org.keycloak.models.map.common;\nimport java.util.Collection;\n+import java.util.Collections;\n+import java.util.List;\nimport java.util.Map;\n+import java.util.Set;\n/**\n* Represents a field in an entity with appropriate accessors.\n@@ -48,12 +51,22 @@ public interface EntityField<E> {\n* @param e Entity\n* @param value Value to be added to the collection\n* @throws ClassCastException If this field is not a collection.\n+ * @throws UnsupportedOperationException If this collection type is not yet known.\n*/\ndefault <T> void collectionAdd(E e, T value) {\n@SuppressWarnings(\"unchecked\")\nCollection<T> c = (Collection<T>) get(e);\nif (c != null) {\nc.add(value);\n+ } else {\n+ if (getFieldClass().equals(List.class)) {\n+ c = Collections.singletonList(value);\n+ } else if (getFieldClass().equals(Set.class)) {\n+ c = Collections.singleton(value);\n+ } else {\n+ throw new UnsupportedOperationException(\"Unsupported collection type.\"); // in case we add e.g. java.util.Queue in future\n+ }\n+ set(e, c);\n}\n}\n/**\n@@ -93,6 +106,8 @@ public interface EntityField<E> {\nMap<K, T> m = (Map<K, T>) get(e);\nif (m != null) {\nm.put(key, value);\n+ } else {\n+ set(e, Collections.singletonMap(key, value));\n}\n}\n/**\n"
}
] | Java | Apache License 2.0 | keycloak/keycloak | EntityField `mapPut` and `collectionAdd` default methods doesn't insert an element when `get(e)` returns `null`
Closes #16317 |
339,465 | 09.01.2023 14:40:04 | -3,600 | 4d55c6a647111dcffd9ff142177a580c511866bc | Adding SAML tests for FIPS - with addition of XMLDSig security provider
Closes | [
{
"change_type": "MODIFY",
"old_path": "testsuite/integration-arquillian/servers/auth-server/common/fips/kc.java.security",
"new_path": "testsuite/integration-arquillian/servers/auth-server/common/fips/kc.java.security",
"diff": "#\n# Security providers used when global crypto-policies are set to FIPS (Usually it is used when FIPS enabled on system/JVM level)\n#\n-#fips.provider.1=SunPKCS11 ${java.home}/conf/security/nss.fips.cfg\n-#fips.provider.2=SUN\n-#fips.provider.3=SunEC\n-#fips.provider.4=com.sun.net.ssl.internal.ssl.Provider SunPKCS11-NSS-FIPS\n-#fips.provider.5=SunJGSS\n-#fips.provider.6=XMLDSig\n-#fips.provider.5=\n+# NOTE: This list of providers is needed to be override just because XMLDSig provider is not yet present on the OpenJDK 17 by default on the RHEL FIPS host on OpenJDK 17.0.3.\n+# However once it is present, there won't be a need to override this and this part can be fully commented/removed.\n+# TODO: Comment/remove this once https://bugzilla.redhat.com/show_bug.cgi?id=1940064 is fixed and OpenJDK 17 updated to corresponding version where XMLDSig is available by default\n+#\n+fips.provider.1=SunPKCS11 ${java.home}/conf/security/nss.fips.cfg\n+fips.provider.2=SUN\n+fips.provider.3=SunEC\n+fips.provider.4=SunJSSE\n+fips.provider.5=SunJCE\n+fips.provider.6=SunRsaSign\n+fips.provider.7=XMLDSig\n# Commented this provider for now (and also other providers) as it uses lots of non-FIPS services.\n# See https://access.redhat.com/documentation/en-us/openjdk/11/html-single/configuring_openjdk_11_on_rhel_with_fips/index#ref_openjdk-default-fips-configuration_openjdk\n"
},
{
"change_type": "MODIFY",
"old_path": "testsuite/integration-arquillian/tests/base/testsuites/fips-suite",
"new_path": "testsuite/integration-arquillian/tests/base/testsuites/fips-suite",
"diff": "@@ -13,3 +13,8 @@ KcRegTest\nKcRegCreateTest\nKcAdmTest\nKcAdmCreateTest\n+SAMLServletAdapterTest\n+SamlSignatureTest\n+KcSamlBrokerTest\n+KcSamlFirstBrokerLoginTest\n+KcSamlEncryptedIdTest\n"
}
] | Java | Apache License 2.0 | keycloak/keycloak | Adding SAML tests for FIPS - with addition of XMLDSig security provider
Closes #14969 |
339,542 | 10.01.2023 11:56:40 | -3,600 | bcc23b633046af7075fd2219e55051bb579bf795 | Fix (keycloak#15493): make nginx certificate-lookup thread safe
Closes | [
{
"change_type": "MODIFY",
"old_path": "services/src/main/java/org/keycloak/services/x509/NginxProxySslClientCertificateLookup.java",
"new_path": "services/src/main/java/org/keycloak/services/x509/NginxProxySslClientCertificateLookup.java",
"diff": "@@ -3,7 +3,6 @@ package org.keycloak.services.x509;\nimport java.io.UnsupportedEncodingException;\nimport java.security.GeneralSecurityException;\nimport java.security.InvalidAlgorithmParameterException;\n-import java.security.KeyStore;\nimport java.security.NoSuchAlgorithmException;\nimport java.security.NoSuchProviderException;\nimport java.security.cert.CertPath;\n@@ -19,6 +18,7 @@ import java.security.cert.X509Certificate;\nimport java.util.ArrayList;\nimport java.util.HashSet;\nimport java.util.List;\n+import java.util.Objects;\nimport java.util.Set;\nimport org.jboss.logging.Logger;\n@@ -27,10 +27,6 @@ import org.keycloak.http.HttpRequest;\nimport org.keycloak.common.crypto.CryptoIntegration;\nimport org.keycloak.common.util.PemException;\nimport org.keycloak.common.util.PemUtils;\n-import org.keycloak.models.KeycloakSession;\n-import org.keycloak.models.KeycloakSessionFactory;\n-import org.keycloak.truststore.TruststoreProvider;\n-import org.keycloak.truststore.TruststoreProviderFactory;\n/**\n* The NGINX Provider extract end user X.509 certificate send during TLS mutual authentication,\n@@ -62,20 +58,27 @@ public class NginxProxySslClientCertificateLookup extends AbstractClientCertific\nprivate static final Logger log = Logger.getLogger(NginxProxySslClientCertificateLookup.class);\n- private static boolean isTruststoreLoaded = false;\n+ private final boolean isTruststoreLoaded;\n+ private final Set<X509Certificate> trustedRootCerts;\n+ private final Set<X509Certificate> intermediateCerts;\n- private static KeyStore truststore = null;\n- private static Set<X509Certificate> trustedRootCerts = null;\n- private static Set<X509Certificate> intermediateCerts = null;\n-\n- public NginxProxySslClientCertificateLookup(String sslCientCertHttpHeader,\n+ public NginxProxySslClientCertificateLookup(String sslClientCertHttpHeader,\nString sslCertChainHttpHeaderPrefix,\nint certificateChainLength,\n- KeycloakSession kcsession) {\n- super(sslCientCertHttpHeader, sslCertChainHttpHeaderPrefix, certificateChainLength);\n-\n- if (!loadKeycloakTrustStore(kcsession)) {\n+ Set<X509Certificate> intermediateCerts,\n+ Set<X509Certificate> trustedRootCerts,\n+ boolean isTruststoreLoaded\n+ ) {\n+ super(sslClientCertHttpHeader, sslCertChainHttpHeaderPrefix, certificateChainLength);\n+\n+ Objects.requireNonNull(intermediateCerts,\"requireNonNull intermediateCerts\");\n+ Objects.requireNonNull(trustedRootCerts,\"requireNonNull trustedRootCerts\");\n+ this.intermediateCerts = intermediateCerts;\n+ this.trustedRootCerts = trustedRootCerts;\n+ this.isTruststoreLoaded = isTruststoreLoaded;\n+\n+ if (!this.isTruststoreLoaded) {\nlog.warn(\"Keycloak Truststore is null or empty, but it's required for NGINX x509cert-lookup provider\");\nlog.warn(\" see Keycloak documentation here : https://www.keycloak.org/docs/latest/server_installation/index.html#_truststore\");\n}\n@@ -126,7 +129,7 @@ public class NginxProxySslClientCertificateLookup extends AbstractClientCertific\nX509Certificate clientCert = getCertificateFromHttpHeader(httpRequest, sslClientCertHttpHeader);\nif (clientCert != null) {\n- log.debugf(\"End user certificate found : Subject DN=[%s] SerialNumber=[%s]\", clientCert.getSubjectDN(), clientCert.getSerialNumber());\n+ log.debugf(\"End user certificate found : Subject DN=[%s] SerialNumber=[%s]\", clientCert.getSubjectX500Principal(), clientCert.getSerialNumber());\n// Rebuilding the end user certificate chain using Keycloak Truststore\nX509Certificate[] certChain = buildChain(clientCert);\n@@ -134,9 +137,9 @@ public class NginxProxySslClientCertificateLookup extends AbstractClientCertific\nlog.info(\"Impossible to rebuild end user cert chain : client certificate authentication will fail.\" );\nchain.add(clientCert);\n} else {\n- for (X509Certificate cacert : certChain) {\n- chain.add(cacert);\n- log.debugf(\"Rebuilded user cert chain DN : %s\", cacert.getSubjectDN().toString() );\n+ for (X509Certificate caCert : certChain) {\n+ chain.add(caCert);\n+ log.debugf(\"Rebuilded user cert chain DN : %s\", caCert.getSubjectX500Principal());\n}\n}\n}\n@@ -148,25 +151,25 @@ public class NginxProxySslClientCertificateLookup extends AbstractClientCertific\n* we are rebuilding here the end user certificate chain with Keycloak truststore.\n* <br>\n* Please note that Keycloak truststore must contain root and intermediate CA's certificates.\n- * @param end_user_auth_cert\n+ * @param endUserAuthCert\n* @return\n*/\n- public X509Certificate[] buildChain(X509Certificate end_user_auth_cert) {\n+ private X509Certificate[] buildChain(X509Certificate endUserAuthCert) {\n- X509Certificate[] user_cert_chain = null;\n+ X509Certificate[] userCertChain = new X509Certificate[0];\ntry {\n// No truststore : no way!\n- if (isTruststoreLoaded == false) {\n+ if (!isTruststoreLoaded) {\nlog.warn(\"Keycloak Truststore is null, but it is required !\");\nlog.warn(\" see https://www.keycloak.org/docs/latest/server_installation/index.html#_truststore\");\n- return null;\n+ return userCertChain;\n}\n// Create the selector that specifies the starting certificate\nX509CertSelector selector = new X509CertSelector();\n- selector.setCertificate(end_user_auth_cert);\n+ selector.setCertificate(endUserAuthCert);\n// Create the trust anchors (set of root CA certificates)\nSet<TrustAnchor> trustAnchors = new HashSet<TrustAnchor>();\n@@ -184,9 +187,9 @@ public class NginxProxySslClientCertificateLookup extends AbstractClientCertific\npkixParams.setMaxPathLength(certificateChainLength);\n// Adding the list of intermediate certificates + end user certificate\n- intermediateCerts.add(end_user_auth_cert);\n- CollectionCertStoreParameters intermediateCA_userCert = new CollectionCertStoreParameters(intermediateCerts);\n- CertStore intermediateCertStore = CryptoIntegration.getProvider().getCertStore(intermediateCA_userCert);\n+ intermediateCerts.add(endUserAuthCert);\n+ CollectionCertStoreParameters intermediateCAUserCert = new CollectionCertStoreParameters(intermediateCerts);\n+ CertStore intermediateCertStore = CryptoIntegration.getProvider().getCertStore(intermediateCAUserCert);\npkixParams.addCertStore(intermediateCertStore);\n// Build and verify the certification chain (revocation status excluded)\n@@ -194,9 +197,9 @@ public class NginxProxySslClientCertificateLookup extends AbstractClientCertific\nCertPath certPath = certPathBuilder.build(pkixParams).getCertPath();\nlog.debug(\"Certification path building OK, and contains \" + certPath.getCertificates().size() + \" X509 Certificates\");\n- user_cert_chain = convertCertPathtoX509CertArray( certPath );\n+ userCertChain = convertCertPathToX509CertArray(certPath);\n- } catch (NoSuchAlgorithmException e) {\n+ } catch (NoSuchAlgorithmException | InvalidAlgorithmParameterException | NoSuchProviderException e) {\nlog.error(e.getLocalizedMessage(),e);\n} catch (CertPathBuilderException e) {\nif (log.isEnabled(Level.TRACE)) {\n@@ -204,64 +207,32 @@ public class NginxProxySslClientCertificateLookup extends AbstractClientCertific\n} else {\nlog.warn(e.getLocalizedMessage());\n}\n- } catch (InvalidAlgorithmParameterException e) {\n- log.error(e.getLocalizedMessage(),e);\n- } catch (NoSuchProviderException e) {\n- log.error(e.getLocalizedMessage(),e);\n} finally {\nif (isTruststoreLoaded) {\n//Remove end user certificate\n- intermediateCerts.remove(end_user_auth_cert);\n+ intermediateCerts.remove(endUserAuthCert);\n}\n}\n- return user_cert_chain;\n+ return userCertChain;\n}\n- public X509Certificate[] convertCertPathtoX509CertArray( CertPath certPath ) {\n+ private X509Certificate[] convertCertPathToX509CertArray(CertPath certPath ) {\n- X509Certificate[] x509certchain = null;\n+ X509Certificate[] x509certChain = new X509Certificate[0];\n+ if (certPath == null){\n+ return x509certChain;\n+ }\n- if (certPath != null) {\nList<X509Certificate> trustedX509Chain = new ArrayList<X509Certificate>();\nfor (Certificate certificate : certPath.getCertificates()) {\nif (certificate instanceof X509Certificate) {\ntrustedX509Chain.add((X509Certificate) certificate);\n}\n}\n- x509certchain = trustedX509Chain.toArray(new X509Certificate[0]);\n- }\n-\n- return x509certchain;\n-\n- }\n- /** Loading truststore @ first login\n- *\n- * @param kcsession\n- * @return\n- */\n- public boolean loadKeycloakTrustStore(KeycloakSession kcsession) {\n-\n- if (!isTruststoreLoaded) {\n- log.debug(\" Loading Keycloak truststore ...\");\n- KeycloakSessionFactory factory = kcsession.getKeycloakSessionFactory();\n- TruststoreProviderFactory truststoreFactory = (TruststoreProviderFactory) factory.getProviderFactory(TruststoreProvider.class, \"file\");\n-\n- TruststoreProvider provider = truststoreFactory.create(kcsession);\n+ return trustedX509Chain.toArray(x509certChain);\n- if (provider != null && provider.getTruststore() != null) {\n- truststore = provider.getTruststore();\n- trustedRootCerts = new HashSet<>(provider.getRootCertificates().values());\n- intermediateCerts = new HashSet<>(provider.getIntermediateCertificates().values());\n- log.debug(\"Keycloak truststore loaded for NGINX x509cert-lookup provider.\");\n-\n- isTruststoreLoaded = true;\n- }\n}\n-\n- return isTruststoreLoaded;\n- }\n-\n}\n"
},
{
"change_type": "MODIFY",
"old_path": "services/src/main/java/org/keycloak/services/x509/NginxProxySslClientCertificateLookupFactory.java",
"new_path": "services/src/main/java/org/keycloak/services/x509/NginxProxySslClientCertificateLookupFactory.java",
"diff": "@@ -3,6 +3,13 @@ package org.keycloak.services.x509;\nimport org.jboss.logging.Logger;\nimport org.keycloak.Config;\nimport org.keycloak.models.KeycloakSession;\n+import org.keycloak.models.KeycloakSessionFactory;\n+import org.keycloak.truststore.TruststoreProvider;\n+import org.keycloak.truststore.TruststoreProviderFactory;\n+\n+import java.security.cert.X509Certificate;\n+import java.util.Set;\n+import java.util.concurrent.ConcurrentHashMap;\n/**\n* The factory and the corresponding providers extract a client certificate\n@@ -15,29 +22,40 @@ import org.keycloak.models.KeycloakSession;\npublic class NginxProxySslClientCertificateLookupFactory extends AbstractClientCertificateFromHttpHeadersLookupFactory {\n- private final static Logger logger = Logger.getLogger(NginxProxySslClientCertificateLookupFactory.class);\n+ private static final Logger logger = Logger.getLogger(NginxProxySslClientCertificateLookupFactory.class);\n+\n+ private static final String PROVIDER = \"nginx\";\n+\n+ protected static final String TRUST_PROXY_VERIFICATION = \"trust-proxy-verification\";\n- private final static String PROVIDER = \"nginx\";\n+ protected boolean trustProxyVerification;\n- protected final static String TRUST_PROXY_VERIFICATION = \"trust-proxy-verification\";\n+ private volatile boolean isTruststoreLoaded;\n- protected boolean trustProxyVerification = false;\n+ private Set<X509Certificate> trustedRootCerts;\n+\n+ private Set<X509Certificate> intermediateCerts;\n@Override\npublic void init(Config.Scope config) {\nsuper.init(config);\n- trustProxyVerification = config.getBoolean(TRUST_PROXY_VERIFICATION, false);\n+ this.trustProxyVerification = config.getBoolean(TRUST_PROXY_VERIFICATION, false);\nlogger.tracev(\"{0}: ''{1}''\", TRUST_PROXY_VERIFICATION, trustProxyVerification);\n+ this.isTruststoreLoaded = false;\n+ this.trustedRootCerts = ConcurrentHashMap.newKeySet();\n+ this.intermediateCerts = ConcurrentHashMap.newKeySet();\n+\n}\n@Override\npublic X509ClientCertificateLookup create(KeycloakSession session) {\n+ loadKeycloakTrustStore(session);\nif (trustProxyVerification) {\nreturn new NginxProxyTrustedClientCertificateLookup(sslClientCertHttpHeader,\nsslChainHttpHeaderPrefix, certificateChainLength);\n} else {\nreturn new NginxProxySslClientCertificateLookup(sslClientCertHttpHeader,\n- sslChainHttpHeaderPrefix, certificateChainLength, session);\n+ sslChainHttpHeaderPrefix, certificateChainLength, intermediateCerts, trustedRootCerts, isTruststoreLoaded);\n}\n}\n@@ -45,4 +63,33 @@ public class NginxProxySslClientCertificateLookupFactory extends AbstractClientC\npublic String getId() {\nreturn PROVIDER;\n}\n+\n+ /** Loading truststore @ first login\n+ *\n+ * @param kcSession keycloak session\n+ */\n+ private void loadKeycloakTrustStore(KeycloakSession kcSession) {\n+\n+ if (isTruststoreLoaded){\n+ return;\n+ }\n+\n+ synchronized (this) {\n+ if (isTruststoreLoaded) {\n+ return;\n+ }\n+ logger.debug(\" Loading Keycloak truststore ...\");\n+ KeycloakSessionFactory factory = kcSession.getKeycloakSessionFactory();\n+ TruststoreProviderFactory truststoreFactory = (TruststoreProviderFactory) factory.getProviderFactory(TruststoreProvider.class, \"file\");\n+ TruststoreProvider provider = truststoreFactory.create(kcSession);\n+\n+ if (provider != null && provider.getTruststore() != null) {\n+ trustedRootCerts.addAll(provider.getRootCertificates().values());\n+ intermediateCerts.addAll(provider.getIntermediateCertificates().values());\n+ logger.debug(\"Keycloak truststore loaded for NGINX x509cert-lookup provider.\");\n+\n+ isTruststoreLoaded = true;\n+ }\n+ }\n+ }\n}\n"
}
] | Java | Apache License 2.0 | keycloak/keycloak | Fix (keycloak#15493): make nginx certificate-lookup thread safe (#15480)
Closes #15493 |
339,687 | 10.01.2023 17:37:27 | -3,600 | 7bd78f604a81ff52b7282f968e692654a0a19d88 | Added MariaDB to Legacy Store IT. | [
{
"change_type": "MODIFY",
"old_path": ".github/workflows/ci.yml",
"new_path": ".github/workflows/ci.yml",
"diff": "@@ -271,7 +271,7 @@ jobs:\ntimeout-minutes: 45\nstrategy:\nmatrix:\n- db: [postgres, mysql, oracle, mssql] # 'mariadb' is not always shutting down\n+ db: [postgres, mysql, oracle, mssql, mariadb]\nfail-fast: false\nsteps:\n- uses: actions/checkout@v3\n"
},
{
"change_type": "MODIFY",
"old_path": "pom.xml",
"new_path": "pom.xml",
"diff": "<mysql-jdbc.version>8.0.30</mysql-jdbc.version>\n<postgresql.version>13.2</postgresql.version>\n<postgresql-jdbc.version>42.5.1</postgresql-jdbc.version>\n- <mariadb.version>10.3.27</mariadb.version>\n+ <mariadb.version>10.6</mariadb.version>\n<mariadb-jdbc.version>2.7.2</mariadb-jdbc.version>\n<mssql.version>2019-latest</mssql.version>\n<mssql-jdbc.version>9.2.0.jre8</mssql-jdbc.version>\n"
},
{
"change_type": "MODIFY",
"old_path": "testsuite/integration-arquillian/pom.xml",
"new_path": "testsuite/integration-arquillian/pom.xml",
"diff": "<jdbc.mvn.groupId>org.mariadb.jdbc</jdbc.mvn.groupId>\n<jdbc.mvn.artifactId>mariadb-java-client</jdbc.mvn.artifactId>\n<jdbc.mvn.version>${mariadb-jdbc.version}</jdbc.mvn.version>\n- <docker.database.image>mariadb:${mariadb.version}</docker.database.image>\n+ <docker.database.image>docker.io/mariadb:${mariadb.version}</docker.database.image>\n<docker.database.port>3306</docker.database.port>\n<docker.database.skip>false</docker.database.skip>\n<!-- Need to explicitly enable utf8 as it is not the default settings in the mariadb docker image -->\n"
},
{
"change_type": "MODIFY",
"old_path": "testsuite/integration-arquillian/tests/base/pom.xml",
"new_path": "testsuite/integration-arquillian/tests/base/pom.xml",
"diff": "<!-- Do not use waiting for port since that is unreliable, sometimes port is listening before DB is ready to serve -->\n<log>${docker.database.wait-for-log-regex}</log>\n<time>300000</time>\n+ <kill>10000</kill>\n<exec>\n<postStart>${docker.database.postStart}</postStart>\n<breakOnError>true</breakOnError>\n"
}
] | Java | Apache License 2.0 | keycloak/keycloak | Added MariaDB to Legacy Store IT. (#16157) |
339,465 | 09.01.2023 14:44:34 | -3,600 | ac490a666cb3a585c53011e89f9b2a2898779acf | Fix KcSamlSignedBrokerTest in FIPS. Support for choosing realm encryption key for decrypt SAML assertions instead of realm signature key
Closes | [
{
"change_type": "MODIFY",
"old_path": "server-spi-private/src/main/java/org/keycloak/models/utils/DefaultKeyProviders.java",
"new_path": "server-spi-private/src/main/java/org/keycloak/models/utils/DefaultKeyProviders.java",
"diff": "@@ -32,6 +32,8 @@ import java.util.Objects;\n*/\npublic class DefaultKeyProviders {\n+ public static final String DEFAULT_PRIORITY = \"100\";\n+\npublic static void createProviders(RealmModel realm) {\nif (!hasProvider(realm, \"rsa-generated\")) {\ncreateRsaKeyProvider(\"rsa-generated\", realm);\n@@ -53,7 +55,7 @@ public class DefaultKeyProviders {\ngenerated.setProviderType(KeyProvider.class.getName());\nMultivaluedHashMap<String, String> config = new MultivaluedHashMap<>();\n- config.putSingle(\"priority\", \"100\");\n+ config.putSingle(\"priority\", DEFAULT_PRIORITY);\nconfig.putSingle(\"keyUse\", KeyUse.SIG.name());\ngenerated.setConfig(config);\n@@ -68,7 +70,7 @@ public class DefaultKeyProviders {\ngenerated.setProviderType(KeyProvider.class.getName());\nMultivaluedHashMap<String, String> config = new MultivaluedHashMap<>();\n- config.putSingle(\"priority\", \"100\");\n+ config.putSingle(\"priority\", DEFAULT_PRIORITY);\nconfig.putSingle(\"keyUse\", KeyUse.ENC.name());\nconfig.putSingle(\"algorithm\", JWEConstants.RSA_OAEP);\ngenerated.setConfig(config);\n@@ -85,7 +87,7 @@ public class DefaultKeyProviders {\ngenerated.setProviderType(KeyProvider.class.getName());\nMultivaluedHashMap<String, String> config = new MultivaluedHashMap<>();\n- config.putSingle(\"priority\", \"100\");\n+ config.putSingle(\"priority\", DEFAULT_PRIORITY);\nconfig.putSingle(\"algorithm\", Algorithm.HS256);\ngenerated.setConfig(config);\n@@ -101,7 +103,7 @@ public class DefaultKeyProviders {\ngenerated.setProviderType(KeyProvider.class.getName());\nMultivaluedHashMap<String, String> config = new MultivaluedHashMap<>();\n- config.putSingle(\"priority\", \"100\");\n+ config.putSingle(\"priority\", DEFAULT_PRIORITY);\ngenerated.setConfig(config);\nrealm.addComponentModel(generated);\n@@ -121,7 +123,7 @@ public class DefaultKeyProviders {\nrsa.setProviderType(KeyProvider.class.getName());\nMultivaluedHashMap<String, String> config = new MultivaluedHashMap<>();\n- config.putSingle(\"priority\", \"100\");\n+ config.putSingle(\"priority\", DEFAULT_PRIORITY);\nconfig.putSingle(\"privateKey\", privateKeyPem);\nif (certificatePem != null) {\nconfig.putSingle(\"certificate\", certificatePem);\n"
},
{
"change_type": "MODIFY",
"old_path": "server-spi/src/main/java/org/keycloak/models/KeyManager.java",
"new_path": "server-spi/src/main/java/org/keycloak/models/KeyManager.java",
"diff": "@@ -99,6 +99,10 @@ public interface KeyManager {\nthis.certificate = certificate;\n}\n+ public ActiveRsaKey(KeyWrapper keyWrapper) {\n+ this(keyWrapper.getKid(), (PrivateKey) keyWrapper.getPrivateKey(), (PublicKey) keyWrapper.getPublicKey(), keyWrapper.getCertificate());\n+ }\n+\npublic String getKid() {\nreturn kid;\n}\n"
},
{
"change_type": "MODIFY",
"old_path": "services/src/main/java/org/keycloak/broker/saml/SAMLEndpoint.java",
"new_path": "services/src/main/java/org/keycloak/broker/saml/SAMLEndpoint.java",
"diff": "@@ -415,7 +415,7 @@ public class SAMLEndpoint {\n}\nsession.getContext().setAuthenticationSession(authSession);\n- KeyManager.ActiveRsaKey keys = session.keys().getActiveRsaKey(realm);\n+ KeyManager.ActiveRsaKey keys = SamlProtocolUtils.getDecryptionKey(session, realm, config);\nif (! isSuccessfulSamlResponse(responseType)) {\nString statusMessage = responseType.getStatus() == null || responseType.getStatus().getStatusMessage() == null ? Messages.IDENTITY_PROVIDER_UNEXPECTED_ERROR : responseType.getStatus().getStatusMessage();\nreturn callback.error(statusMessage);\n"
},
{
"change_type": "MODIFY",
"old_path": "services/src/main/java/org/keycloak/broker/saml/SAMLIdentityProvider.java",
"new_path": "services/src/main/java/org/keycloak/broker/saml/SAMLIdentityProvider.java",
"diff": "@@ -28,6 +28,7 @@ import org.keycloak.common.util.PemUtils;\nimport org.keycloak.crypto.Algorithm;\nimport org.keycloak.crypto.KeyStatus;\nimport org.keycloak.crypto.KeyUse;\n+import org.keycloak.crypto.KeyWrapper;\nimport org.keycloak.dom.saml.v2.assertion.AssertionType;\nimport org.keycloak.dom.saml.v2.assertion.AuthnStatementType;\nimport org.keycloak.dom.saml.v2.assertion.NameIDType;\n@@ -94,6 +95,8 @@ import java.util.LinkedList;\nimport java.util.List;\nimport java.util.Map.Entry;\nimport java.util.Objects;\n+import java.util.stream.Collectors;\n+import java.util.stream.Stream;\n/**\n* @author Pedro Igor\n@@ -360,27 +363,16 @@ public class SAMLIdentityProvider extends AbstractIdentityProvider<SAMLIdentityP\nString nameIDPolicyFormat = getConfig().getNameIDPolicyFormat();\n- List<Element> signingKeys = new LinkedList<>();\n- List<Element> encryptionKeys = new LinkedList<>();\n+ List<Element> signingKeys = streamForExport(session.keys().getKeysStream(realm, KeyUse.SIG, Algorithm.RS256), false)\n+ .collect(Collectors.toList());\n- session.keys().getKeysStream(realm, KeyUse.SIG, Algorithm.RS256)\n- .filter(Objects::nonNull)\n- .filter(key -> key.getCertificate() != null)\n- .sorted(SamlService::compareKeys)\n- .forEach(key -> {\n- try {\n- Element element = SPMetadataDescriptor\n- .buildKeyInfoElement(key.getKid(), PemUtils.encodeCertificate(key.getCertificate()));\n- signingKeys.add(element);\n-\n- if (key.getStatus() == KeyStatus.ACTIVE) {\n- encryptionKeys.add(element);\n- }\n- } catch (ParserConfigurationException e) {\n- logger.warn(\"Failed to export SAML SP Metadata!\", e);\n- throw new RuntimeException(e);\n- }\n- });\n+ // See also SamlProtocolUtils.getDecryptionKey\n+ String encAlg = getConfig().getEncryptionAlgorithm();\n+ Stream<KeyWrapper> encryptionKeyWrappers = (encAlg != null && !encAlg.trim().isEmpty())\n+ ? session.keys().getKeysStream(realm, KeyUse.ENC, encAlg)\n+ : session.keys().getKeysStream(realm, KeyUse.SIG, Algorithm.RS256);\n+ List<Element> encryptionKeys = streamForExport(encryptionKeyWrappers, true)\n+ .collect(Collectors.toList());\n// Prepare the metadata descriptor model\nStringWriter sw = new StringWriter();\n@@ -462,6 +454,23 @@ public class SAMLIdentityProvider extends AbstractIdentityProvider<SAMLIdentityP\n}\n}\n+ private Stream<Element> streamForExport(Stream<KeyWrapper> keys, boolean checkActive) {\n+ return keys.filter(Objects::nonNull)\n+ .filter(key -> key.getCertificate() != null)\n+ .filter(key -> !checkActive || key.getStatus() == KeyStatus.ACTIVE)\n+ .sorted(SamlService::compareKeys)\n+ .map(key -> {\n+ try {\n+ Element element = SPMetadataDescriptor\n+ .buildKeyInfoElement(key.getKid(), PemUtils.encodeCertificate(key.getCertificate()));\n+ return element;\n+ } catch (ParserConfigurationException e) {\n+ logger.warn(\"Failed to export SAML SP Metadata!\", e);\n+ throw new RuntimeException(e);\n+ }\n+ });\n+ }\n+\npublic SignatureAlgorithm getSignatureAlgorithm() {\nString alg = getConfig().getSignatureAlgorithm();\nif (alg != null) {\n"
},
{
"change_type": "MODIFY",
"old_path": "services/src/main/java/org/keycloak/broker/saml/SAMLIdentityProviderConfig.java",
"new_path": "services/src/main/java/org/keycloak/broker/saml/SAMLIdentityProviderConfig.java",
"diff": "@@ -45,6 +45,7 @@ public class SAMLIdentityProviderConfig extends IdentityProviderModel {\npublic static final String POST_BINDING_LOGOUT = \"postBindingLogout\";\npublic static final String POST_BINDING_RESPONSE = \"postBindingResponse\";\npublic static final String SIGNATURE_ALGORITHM = \"signatureAlgorithm\";\n+ public static final String ENCRYPTION_ALGORITHM = \"encryptionAlgorithm\";\npublic static final String SIGNING_CERTIFICATE_KEY = \"signingCertificate\";\npublic static final String SINGLE_LOGOUT_SERVICE_URL = \"singleLogoutServiceUrl\";\npublic static final String SINGLE_SIGN_ON_SERVICE_URL = \"singleSignOnServiceUrl\";\n@@ -204,6 +205,14 @@ public class SAMLIdentityProviderConfig extends IdentityProviderModel {\ngetConfig().put(SIGNATURE_ALGORITHM, signatureAlgorithm);\n}\n+ public String getEncryptionAlgorithm() {\n+ return getConfig().get(ENCRYPTION_ALGORITHM);\n+ }\n+\n+ public void setEncryptionAlgorithm(String encryptionAlgorithm) {\n+ getConfig().put(ENCRYPTION_ALGORITHM, encryptionAlgorithm);\n+ }\n+\npublic String getEncryptionPublicKey() {\nreturn getConfig().get(ENCRYPTION_PUBLIC_KEY);\n}\n"
},
{
"change_type": "MODIFY",
"old_path": "services/src/main/java/org/keycloak/keys/AbstractImportedRsaKeyProviderFactory.java",
"new_path": "services/src/main/java/org/keycloak/keys/AbstractImportedRsaKeyProviderFactory.java",
"diff": "@@ -86,7 +86,7 @@ public abstract class AbstractImportedRsaKeyProviderFactory extends AbstractRsaK\nCertificate certificate = CertificateUtils.generateV1SelfSignedCertificate(keyPair, realm.getName());\nmodel.put(Attributes.CERTIFICATE_KEY, PemUtils.encodeCertificate(certificate));\n} catch (Throwable t) {\n- throw new ComponentValidationException(\"Failed to generate self-signed certificate\");\n+ throw new ComponentValidationException(\"Failed to generate self-signed certificate\", t);\n}\n}\n}\n"
},
{
"change_type": "MODIFY",
"old_path": "services/src/main/java/org/keycloak/keys/DefaultKeyManager.java",
"new_path": "services/src/main/java/org/keycloak/keys/DefaultKeyManager.java",
"diff": "@@ -153,7 +153,7 @@ public class DefaultKeyManager implements KeyManager {\n@Deprecated\npublic ActiveRsaKey getActiveRsaKey(RealmModel realm) {\nKeyWrapper key = getActiveKey(realm, KeyUse.SIG, Algorithm.RS256);\n- return new ActiveRsaKey(key.getKid(), (PrivateKey) key.getPrivateKey(), (PublicKey) key.getPublicKey(), key.getCertificate());\n+ return new ActiveRsaKey(key);\n}\n@Override\n"
},
{
"change_type": "MODIFY",
"old_path": "services/src/main/java/org/keycloak/protocol/saml/SamlProtocolUtils.java",
"new_path": "services/src/main/java/org/keycloak/protocol/saml/SamlProtocolUtils.java",
"diff": "@@ -22,13 +22,20 @@ import java.io.ByteArrayOutputStream;\nimport java.net.URI;\nimport java.security.Key;\n+import org.jboss.logging.Logger;\n+import org.keycloak.broker.saml.SAMLIdentityProviderConfig;\nimport org.keycloak.common.VerificationException;\nimport org.keycloak.common.util.PemUtils;\n+import org.keycloak.crypto.KeyUse;\n+import org.keycloak.crypto.KeyWrapper;\nimport org.keycloak.dom.saml.v2.assertion.NameIDType;\nimport org.keycloak.dom.saml.v2.protocol.ArtifactResponseType;\nimport org.keycloak.dom.saml.v2.protocol.StatusCodeType;\nimport org.keycloak.dom.saml.v2.protocol.StatusType;\nimport org.keycloak.models.ClientModel;\n+import org.keycloak.models.KeyManager;\n+import org.keycloak.models.KeycloakSession;\n+import org.keycloak.models.RealmModel;\nimport org.keycloak.saml.SignatureAlgorithm;\nimport org.keycloak.saml.common.constants.GeneralConstants;\nimport org.keycloak.saml.common.constants.JBossSAMLURIConstants;\n@@ -70,6 +77,8 @@ import org.w3c.dom.Element;\n*/\npublic class SamlProtocolUtils {\n+ private static final Logger logger = Logger.getLogger(SamlProtocolUtils.class);\n+\n/**\n* Verifies a signature of the given SAML document using settings for the given client.\n* Throws an exception if the client signature is expected to be present as per the client\n@@ -123,6 +132,22 @@ public class SamlProtocolUtils {\nreturn getPublicKey(client, SamlConfigAttributes.SAML_ENCRYPTION_CERTIFICATE_ATTRIBUTE);\n}\n+ /**\n+ * Returns private key used to decrypt SAML assertions encrypted by 3rd party SAML IDP\n+ */\n+ public static KeyManager.ActiveRsaKey getDecryptionKey(KeycloakSession session, RealmModel realm, SAMLIdentityProviderConfig idpConfig) {\n+ String encryptionAlgorithm = idpConfig.getEncryptionAlgorithm();\n+ if (encryptionAlgorithm != null && !encryptionAlgorithm.trim().isEmpty()) {\n+ KeyWrapper kw = session.keys().getActiveKey(realm, KeyUse.ENC, encryptionAlgorithm);\n+ return new KeyManager.ActiveRsaKey(kw);\n+ } else {\n+ // Backwards compatibility. Fallback to return default realm key (which is signature key, even if we're not signing anything, but decrypting stuff)\n+ logger.debugf(\"Fallback to use default realm RSA key as a key for decrypt SAML documents. It is recommended to configure 'Encryption algorithm' on SAML IDP '%s' and configure encryption key of this algorithm in realm '%s'\",\n+ idpConfig.getAlias(), realm.getName());\n+ return session.keys().getActiveRsaKey(realm);\n+ }\n+ }\n+\npublic static PublicKey getPublicKey(ClientModel client, String attribute) throws VerificationException {\nString certPem = client.getAttribute(attribute);\nreturn getPublicKey(certPem);\n"
},
{
"change_type": "MODIFY",
"old_path": "testsuite/integration-arquillian/tests/base/src/test/java/org/keycloak/testsuite/broker/KcSamlSignedBrokerTest.java",
"new_path": "testsuite/integration-arquillian/tests/base/src/test/java/org/keycloak/testsuite/broker/KcSamlSignedBrokerTest.java",
"diff": "package org.keycloak.testsuite.broker;\nimport org.keycloak.broker.saml.SAMLIdentityProviderConfig;\n+import org.keycloak.common.util.MultivaluedHashMap;\nimport org.keycloak.crypto.Algorithm;\n+import org.keycloak.crypto.KeyUse;\nimport org.keycloak.dom.saml.v2.protocol.AuthnRequestType;\n+import org.keycloak.jose.jwe.JWEConstants;\n+import org.keycloak.keys.Attributes;\n+import org.keycloak.keys.GeneratedRsaEncKeyProviderFactory;\n+import org.keycloak.keys.KeyProvider;\nimport org.keycloak.models.IdentityProviderSyncMode;\n+import org.keycloak.models.utils.DefaultKeyProviders;\nimport org.keycloak.protocol.saml.SamlConfigAttributes;\nimport org.keycloak.representations.idm.ClientRepresentation;\n+import org.keycloak.representations.idm.ComponentExportRepresentation;\nimport org.keycloak.representations.idm.IdentityProviderRepresentation;\nimport org.keycloak.representations.idm.RealmRepresentation;\nimport org.keycloak.saml.common.constants.JBossSAMLURIConstants;\n@@ -60,14 +68,11 @@ import static org.keycloak.testsuite.broker.BrokerTestTools.getProviderRoot;\npublic class KcSamlSignedBrokerTest extends AbstractBrokerTest {\n- private static final String PRIVATE_KEY = \"MIIBVQIBADANBgkqhkiG9w0BAQEFAASCAT8wggE7AgEAAkEAs46ICYPRIkmr8diECmyT59cChTWIEiXYBY3T6OLlZrF8ofVCzbEeoUOmhrtHijxxuKSoqLWP4nNOt3rINtQNBQIDAQABAkBL2nyxuFQTLhhLdPJjDPd2y6gu6ixvrjkSL5ZEHgZXWRHzhTzBT0eRxg/5rJA2NDRMBzTTegaEGkWUt7lF5wDJAiEA5pC+h9NEgqDJSw42I52BOml3II35Z6NlNwl6OMfnD1sCIQDHXUiOIJy4ZcSgv5WGue1KbdNVOT2gop1XzfuyWgtjHwIhAOCjLb9QC3PqC7Tgx8azcnDiyHojWVesTrTsuvQPcAP5AiAkX5OeQrr1NbQTNAEe7IsrmjAFi4T/6stUOsOiPaV4NwIhAJIeyh4foIXIVQ+M4To2koaDFRssxKI9/O72vnZSJ+uA\";\n- private static final String PUBLIC_KEY = \"MFwwDQYJKoZIhvcNAQEBBQADSwAwSAJBALOOiAmD0SJJq/HYhApsk+fXAoU1iBIl2AWN0+ji5WaxfKH1Qs2xHqFDpoa7R4o8cbikqKi1j+JzTrd6yDbUDQUCAwEAAQ==\";\n-\npublic void withSignedEncryptedAssertions(Runnable testBody, boolean signedDocument, boolean signedAssertion, boolean encryptedAssertion) throws Exception {\nString providerCert = KeyUtils.getActiveSigningKey(adminClient.realm(bc.providerRealmName()).keys().getKeyMetadata(), Algorithm.RS256).getCertificate();\nAssert.assertThat(providerCert, Matchers.notNullValue());\n- String consumerCert = KeyUtils.getActiveSigningKey(adminClient.realm(bc.consumerRealmName()).keys().getKeyMetadata(), Algorithm.RS256).getCertificate();\n+ String consumerCert = KeyUtils.getActiveEncKey(adminClient.realm(bc.consumerRealmName()).keys().getKeyMetadata(), JWEConstants.RSA_OAEP).getCertificate();\nAssert.assertThat(consumerCert, Matchers.notNullValue());\ntry (Closeable idpUpdater = new IdentityProviderAttributeUpdater(identityProviderResource)\n@@ -75,7 +80,7 @@ public class KcSamlSignedBrokerTest extends AbstractBrokerTest {\n.setAttribute(SAMLIdentityProviderConfig.WANT_ASSERTIONS_SIGNED, Boolean.toString(signedAssertion))\n.setAttribute(SAMLIdentityProviderConfig.WANT_ASSERTIONS_ENCRYPTED, Boolean.toString(encryptedAssertion))\n.setAttribute(SAMLIdentityProviderConfig.WANT_AUTHN_REQUESTS_SIGNED, \"false\")\n- .setAttribute(SAMLIdentityProviderConfig.ENCRYPTION_PUBLIC_KEY, PUBLIC_KEY)\n+ .setAttribute(SAMLIdentityProviderConfig.ENCRYPTION_ALGORITHM, JWEConstants.RSA_OAEP)\n.setAttribute(SAMLIdentityProviderConfig.SIGNING_CERTIFICATE_KEY, providerCert)\n.update();\nCloseable clientUpdater = ClientAttributeUpdater.forClient(adminClient, bc.providerRealmName(), bc.getIDPClientIdInProviderRealm())\n@@ -83,7 +88,6 @@ public class KcSamlSignedBrokerTest extends AbstractBrokerTest {\n.setAttribute(SamlConfigAttributes.SAML_ENCRYPTION_CERTIFICATE_ATTRIBUTE, consumerCert)\n.setAttribute(SamlConfigAttributes.SAML_SERVER_SIGNATURE, Boolean.toString(signedDocument))\n.setAttribute(SamlConfigAttributes.SAML_ASSERTION_SIGNATURE, Boolean.toString(signedAssertion))\n- .setAttribute(SamlConfigAttributes.SAML_ENCRYPTION_PRIVATE_KEY_ATTRIBUTE, PRIVATE_KEY)\n.setAttribute(SamlConfigAttributes.SAML_CLIENT_SIGNATURE_ATTRIBUTE, \"false\") // Do not require client signature\n.update())\n{\n@@ -260,9 +264,14 @@ public class KcSamlSignedBrokerTest extends AbstractBrokerTest {\n@Override\npublic RealmRepresentation createConsumerRealm() {\nRealmRepresentation realm = super.createConsumerRealm();\n+ realm.setId(realm.getRealm());\n- realm.setPublicKey(REALM_PUBLIC_KEY);\n- realm.setPrivateKey(REALM_PRIVATE_KEY);\n+ ComponentExportRepresentation signingKey = createKeyRepToRealm(realm,\"rsa\");\n+ signingKey.getConfig().putSingle(Attributes.PRIVATE_KEY_KEY, REALM_PRIVATE_KEY);\n+\n+ ComponentExportRepresentation decryptionKey = createKeyRepToRealm(realm, GeneratedRsaEncKeyProviderFactory.ID);\n+ decryptionKey.getConfig().putSingle(Attributes.KEY_USE, KeyUse.ENC.name());\n+ decryptionKey.getConfig().putSingle(Attributes.ALGORITHM_KEY, JWEConstants.RSA_OAEP);\nreturn realm;\n}\n@@ -506,4 +515,17 @@ public class KcSamlSignedBrokerTest extends AbstractBrokerTest {\n.execute();\n}\n}\n+\n+ protected ComponentExportRepresentation createKeyRepToRealm(RealmRepresentation realmRep, String providerId) {\n+ ComponentExportRepresentation rep = new ComponentExportRepresentation();\n+ rep.setName(providerId);\n+ rep.setProviderId(providerId);\n+ rep.setConfig(new MultivaluedHashMap<>());\n+ rep.getConfig().putSingle(Attributes.PRIORITY_KEY, DefaultKeyProviders.DEFAULT_PRIORITY);\n+ if (realmRep.getComponents() == null) {\n+ realmRep.setComponents(new MultivaluedHashMap<>());\n+ }\n+ realmRep.getComponents().add(KeyProvider.class.getName(), rep);\n+ return rep;\n+ }\n}\n"
},
{
"change_type": "MODIFY",
"old_path": "testsuite/integration-arquillian/tests/base/src/test/java/org/keycloak/testsuite/broker/KcSamlSpDescriptorTest.java",
"new_path": "testsuite/integration-arquillian/tests/base/src/test/java/org/keycloak/testsuite/broker/KcSamlSpDescriptorTest.java",
"diff": "@@ -10,6 +10,7 @@ import org.keycloak.broker.saml.mappers.AttributeToRoleMapper;\nimport org.keycloak.broker.saml.mappers.UserAttributeMapper;\nimport org.keycloak.dom.saml.v2.metadata.EntityDescriptorType;\nimport org.keycloak.dom.saml.v2.metadata.SPSSODescriptorType;\n+import org.keycloak.jose.jwe.JWEConstants;\nimport org.keycloak.models.IdentityProviderMapperModel;\nimport org.keycloak.models.IdentityProviderMapperSyncMode;\nimport org.keycloak.representations.idm.IdentityProviderMapperRepresentation;\n@@ -22,6 +23,10 @@ import org.keycloak.testsuite.updaters.IdentityProviderAttributeUpdater;\nimport java.io.Closeable;\nimport java.io.IOException;\nimport java.net.URISyntaxException;\n+import java.util.Map;\n+import java.util.stream.Collectors;\n+\n+import javax.xml.crypto.dsig.XMLSignature;\nimport static org.hamcrest.MatcherAssert.assertThat;\nimport static org.hamcrest.Matchers.is;\n@@ -43,10 +48,7 @@ public class KcSamlSpDescriptorTest extends AbstractBrokerTest {\n.update())\n{\n- String spDescriptorString = identityProviderResource.export(null).readEntity(String.class);\n- SAMLParser parser = SAMLParser.getInstance();\n- EntityDescriptorType o = (EntityDescriptorType) parser.parse(new StringInputStream(spDescriptorString));\n- SPSSODescriptorType spDescriptor = o.getChoiceType().get(0).getDescriptors().get(0).getSpDescriptor();\n+ SPSSODescriptorType spDescriptor = getExportedSamlProvider();\n//attribute mappers do not exist- no AttributeConsumingService\nassertThat(spDescriptor.getAttributeConsumingService(), empty());\n@@ -72,10 +74,7 @@ public class KcSamlSpDescriptorTest extends AbstractBrokerTest {\nidentityProviderResource.addMapper(attrMapperEmail);\n- String spDescriptorString = identityProviderResource.export(null).readEntity(String.class);\n- SAMLParser parser = SAMLParser.getInstance();\n- EntityDescriptorType o = (EntityDescriptorType) parser.parse(new StringInputStream(spDescriptorString));\n- SPSSODescriptorType spDescriptor = o.getChoiceType().get(0).getDescriptors().get(0).getSpDescriptor();\n+ SPSSODescriptorType spDescriptor = getExportedSamlProvider();\nassertThat(spDescriptor.getAttributeConsumingService(), not(empty()));\nassertThat(spDescriptor.getAttributeConsumingService().get(0).getIndex(), is(12));\n@@ -108,10 +107,7 @@ public class KcSamlSpDescriptorTest extends AbstractBrokerTest {\nidentityProviderResource.addMapper(attrMapperEmail);\n- String spDescriptorString = identityProviderResource.export(null).readEntity(String.class);\n- SAMLParser parser = SAMLParser.getInstance();\n- EntityDescriptorType o = (EntityDescriptorType) parser.parse(new StringInputStream(spDescriptorString));\n- SPSSODescriptorType spDescriptor = o.getChoiceType().get(0).getDescriptors().get(0).getSpDescriptor();\n+ SPSSODescriptorType spDescriptor = getExportedSamlProvider();\nassertThat(spDescriptor.getAttributeConsumingService(), not(empty()));\nassertThat(spDescriptor.getAttributeConsumingService().get(0).getIndex(), is(12));\n@@ -145,10 +141,7 @@ public class KcSamlSpDescriptorTest extends AbstractBrokerTest {\nidentityProviderResource.addMapper(attrMapperEmail);\n- String spDescriptorString = identityProviderResource.export(null).readEntity(String.class);\n- SAMLParser parser = SAMLParser.getInstance();\n- EntityDescriptorType o = (EntityDescriptorType) parser.parse(new StringInputStream(spDescriptorString));\n- SPSSODescriptorType spDescriptor = o.getChoiceType().get(0).getDescriptors().get(0).getSpDescriptor();\n+ SPSSODescriptorType spDescriptor = getExportedSamlProvider();\nassertThat(spDescriptor.getAttributeConsumingService(), not(empty()));\nassertThat(spDescriptor.getAttributeConsumingService().get(0).getIndex(), is(12));\n@@ -181,10 +174,7 @@ public class KcSamlSpDescriptorTest extends AbstractBrokerTest {\nidentityProviderResource.addMapper(attrMapperRole);\n- String spDescriptorString = identityProviderResource.export(null).readEntity(String.class);\n- SAMLParser parser = SAMLParser.getInstance();\n- EntityDescriptorType o = (EntityDescriptorType) parser.parse(new StringInputStream(spDescriptorString));\n- SPSSODescriptorType spDescriptor = o.getChoiceType().get(0).getDescriptors().get(0).getSpDescriptor();\n+ SPSSODescriptorType spDescriptor = getExportedSamlProvider();\nassertThat(spDescriptor.getAttributeConsumingService(), not(empty()));\nassertThat(spDescriptor.getAttributeConsumingService().get(0).getIndex(), is(9));\n@@ -196,4 +186,75 @@ public class KcSamlSpDescriptorTest extends AbstractBrokerTest {\nassertThat(spDescriptor.getAttributeConsumingService().get(0).getServiceName().get(0).getValue(), is(\"My Attribute Set\"));\n}\n}\n+\n+ @Test\n+ public void testKeysDescriptors() throws IOException, ParsingException, URISyntaxException {\n+ // No keys by default\n+ SPSSODescriptorType spDescriptor = getExportedSamlProvider();\n+ Assert.assertNotNull(\"KeyDescriptor is null\", spDescriptor.getKeyDescriptor());\n+ Assert.assertEquals(\"KeyDescriptor.size\", 0, spDescriptor.getKeyDescriptor().size());\n+\n+ // Enable signing for IDP. Only signing key is present\n+ try (Closeable idpUpdater = new IdentityProviderAttributeUpdater(identityProviderResource)\n+ .setAttribute(SAMLIdentityProviderConfig.WANT_AUTHN_REQUESTS_SIGNED, \"true\")\n+ .update())\n+ {\n+ spDescriptor = getExportedSamlProvider();\n+ Assert.assertEquals(\"KeyDescriptor.size\", 1, spDescriptor.getKeyDescriptor().size());\n+ Map<String, String> certs = convertCerts(spDescriptor);\n+ Assert.assertEquals(1, certs.size());\n+ Assert.assertNotNull(certs.get(\"signing\"));\n+ }\n+\n+ // Enable signing and encryption. Both keys are present and mapped to same realm key\n+ try (Closeable idpUpdater = new IdentityProviderAttributeUpdater(identityProviderResource)\n+ .setAttribute(SAMLIdentityProviderConfig.WANT_AUTHN_REQUESTS_SIGNED, \"true\")\n+ .setAttribute(SAMLIdentityProviderConfig.WANT_ASSERTIONS_ENCRYPTED, \"true\")\n+ .update())\n+ {\n+ spDescriptor = getExportedSamlProvider();\n+ Assert.assertEquals(\"KeyDescriptor.size\", 2, spDescriptor.getKeyDescriptor().size());\n+ Map<String, String> certs = convertCerts(spDescriptor);\n+ Assert.assertEquals(2, certs.size());\n+ String signingCert = certs.get(\"signing\");\n+ String encCert = certs.get(\"encryption\");\n+ Assert.assertNotNull(signingCert);\n+ Assert.assertNotNull(encCert);\n+ Assert.assertEquals(signingCert, encCert);\n+ }\n+\n+ // Enable signing and encryption and set encryption algorithm. Both keys are present and mapped to different realm key (signing to \"rsa-generated\"m encryption to \"rsa-enc-generated\")\n+ try (Closeable idpUpdater = new IdentityProviderAttributeUpdater(identityProviderResource)\n+ .setAttribute(SAMLIdentityProviderConfig.WANT_AUTHN_REQUESTS_SIGNED, \"true\")\n+ .setAttribute(SAMLIdentityProviderConfig.WANT_ASSERTIONS_ENCRYPTED, \"true\")\n+ .setAttribute(SAMLIdentityProviderConfig.ENCRYPTION_ALGORITHM, JWEConstants.RSA_OAEP)\n+ .update())\n+ {\n+ spDescriptor = getExportedSamlProvider();\n+ Assert.assertEquals(\"KeyDescriptor.size\", 2, spDescriptor.getKeyDescriptor().size());\n+ Map<String, String> certs = convertCerts(spDescriptor);\n+ Assert.assertEquals(2, certs.size());\n+ String signingCert = certs.get(\"signing\");\n+ String encCert = certs.get(\"encryption\");\n+ Assert.assertNotNull(signingCert);\n+ Assert.assertNotNull(encCert);\n+ Assert.assertNotEquals(signingCert, encCert);\n+ }\n+ }\n+\n+ private SPSSODescriptorType getExportedSamlProvider() throws ParsingException {\n+ String spDescriptorString = identityProviderResource.export(null).readEntity(String.class);\n+ SAMLParser parser = SAMLParser.getInstance();\n+ EntityDescriptorType o = (EntityDescriptorType) parser.parse(new StringInputStream(spDescriptorString));\n+ return o.getChoiceType().get(0).getDescriptors().get(0).getSpDescriptor();\n+ }\n+\n+ // Key is usage (\"signing\" or \"encryption\"), Value is string with X509 certificate\n+ private Map<String, String> convertCerts(SPSSODescriptorType spDescriptor) {\n+ return spDescriptor.getKeyDescriptor().stream()\n+ .collect(Collectors.toMap(\n+ keyDescriptor -> keyDescriptor.getUse().value(),\n+ keyDescriptor -> keyDescriptor.getKeyInfo().getElementsByTagNameNS(XMLSignature.XMLNS, \"X509Certificate\").item(0).getTextContent()));\n+ }\n+\n}\n"
},
{
"change_type": "MODIFY",
"old_path": "testsuite/integration-arquillian/tests/base/testsuites/fips-suite",
"new_path": "testsuite/integration-arquillian/tests/base/testsuites/fips-suite",
"diff": "@@ -18,3 +18,5 @@ SamlSignatureTest\nKcSamlBrokerTest\nKcSamlFirstBrokerLoginTest\nKcSamlEncryptedIdTest\n+KcSamlSignedBrokerTest\n+KcSamlSpDescriptorTest\n"
},
{
"change_type": "MODIFY",
"old_path": "themes/src/main/resources/theme/base/admin/messages/admin-messages_en.properties",
"new_path": "themes/src/main/resources/theme/base/admin/messages/admin-messages_en.properties",
"diff": "@@ -354,6 +354,8 @@ sign-assertions=Sign Assertions\nsign-assertions.tooltip=Should assertions inside SAML documents be signed? This setting is not needed if document is already being signed.\nsignature-algorithm=Signature Algorithm\nsignature-algorithm.tooltip=The signature algorithm to use to sign documents. Note that 'SHA1' based algorithms are deprecated and can be removed in the future. It is recommended to stick to some more secure algorithm instead of '*_SHA1'\n+saml-encryption-algorithm=Encryption Algorithm\n+saml-encryption-algorithm.tooltip=Encryption algorithm, which is used by SAML IDP for encryption of SAML documents, assertions or IDs. The corresponding decryption key for decrypt SAML document parts will be chosen based on this configured algorithm and should be available in realm keys for the encryption (ENC) usage.\ncanonicalization-method=Canonicalization Method\ncanonicalization-method.tooltip=Canonicalization Method for XML signatures.\nencrypt-assertions=Encrypt Assertions\n"
},
{
"change_type": "MODIFY",
"old_path": "themes/src/main/resources/theme/base/admin/resources/partials/realm-identity-provider-saml.html",
"new_path": "themes/src/main/resources/theme/base/admin/resources/partials/realm-identity-provider-saml.html",
"diff": "</div>\n<kc-tooltip>{{:: 'signature-algorithm.tooltip' | translate}}</kc-tooltip>\n</div>\n+ <div class=\"form-group\">\n+ <label class=\"col-md-2 control-label\" for=\"encryptionAlgorithm\">{{:: 'saml-encryption-algorithm' | translate}}</label>\n+ <div class=\"col-md-6\">\n+ <div>\n+ <select id=\"encryptionAlgorithm\"\n+ ng-model=\"identityProvider.config.encryptionAlgorithm\"\n+ ng-options=\"alg for alg in serverInfo.listProviderIds('cekmanagement')\">\n+ </select>\n+ </div>\n+ </div>\n+ <kc-tooltip>{{:: 'saml-encryption-algorithm.tooltip' | translate}}</kc-tooltip>\n+ </div>\n<div class=\"form-group clearfix block\" data-ng-show=\"identityProvider.config.wantAuthnRequestsSigned == 'true'\">\n<label class=\"col-md-2 control-label\" for=\"samlSigKeyNameTranformer\">{{:: 'saml-signature-keyName-transformer' | translate}}</label>\n<div class=\"col-md-6\">\n"
}
] | Java | Apache License 2.0 | keycloak/keycloak | Fix KcSamlSignedBrokerTest in FIPS. Support for choosing realm encryption key for decrypt SAML assertions instead of realm signature key
Closes #16324 |
339,235 | 11.01.2023 08:48:00 | -3,600 | 09ff572ef62157c43ff66728d8f41a73c31193d1 | Update to XStream 1.4.20
Closes | [
{
"change_type": "MODIFY",
"old_path": "pom.xml",
"new_path": "pom.xml",
"diff": "<ua-parser.version>1.5.2</ua-parser.version>\n<picketbox.version>5.0.3.Final</picketbox.version>\n<google.guava.version>30.1-jre</google.guava.version>\n+ <xstream.version>1.4.20</xstream.version>\n<!-- Openshift -->\n<version.com.openshift.openshift-restclient-java>9.0.5.Final</version.com.openshift.openshift-restclient-java>\n<dependencyManagement>\n<dependencies>\n+ <dependency>\n+ <groupId>com.thoughtworks.xstream</groupId>\n+ <artifactId>xstream</artifactId>\n+ <version>${xstream.version}</version>\n+ </dependency>\n<dependency>\n<groupId>org.yaml</groupId>\n<artifactId>snakeyaml</artifactId>\n"
}
] | Java | Apache License 2.0 | keycloak/keycloak | Update to XStream 1.4.20
Closes #16276 |
339,618 | 20.10.2022 11:27:09 | -7,200 | 7398d7e1edd971db191607faf90fca8292f56efc | initial impl of running export/import without serving | [
{
"change_type": "MODIFY",
"old_path": "quarkus/config-api/src/main/java/org/keycloak/config/HttpOptions.java",
"new_path": "quarkus/config-api/src/main/java/org/keycloak/config/HttpOptions.java",
"diff": "@@ -100,4 +100,11 @@ public class HttpOptions {\n.description(\"The type of the trust store file. \" +\n\"If not given, the type is automatically detected based on the file name.\")\n.build();\n+\n+ public static final Option<Boolean> HTTP_SERVER_ENABLED = new OptionBuilder<>(\"http-server-enabled\", Boolean.class)\n+ .category(OptionCategory.HTTP)\n+ .hidden()\n+ .description(\"Enables or disables the HTTP/s and Socket serving.\")\n+ .defaultValue(Boolean.TRUE)\n+ .build();\n}\n"
},
{
"change_type": "MODIFY",
"old_path": "quarkus/runtime/src/main/java/org/keycloak/quarkus/runtime/configuration/mappers/HttpPropertyMappers.java",
"new_path": "quarkus/runtime/src/main/java/org/keycloak/quarkus/runtime/configuration/mappers/HttpPropertyMappers.java",
"diff": "@@ -27,6 +27,10 @@ final class HttpPropertyMappers {\n.transformer(HttpPropertyMappers::getHttpEnabledTransformer)\n.paramLabel(Boolean.TRUE + \"|\" + Boolean.FALSE)\n.build(),\n+ fromOption(HttpOptions.HTTP_SERVER_ENABLED)\n+ .to(\"quarkus.http.host-enabled\")\n+ .paramLabel(Boolean.TRUE + \"|\" + Boolean.FALSE)\n+ .build(),\nfromOption(HttpOptions.HTTP_HOST)\n.to(\"quarkus.http.host\")\n.paramLabel(\"host\")\n"
},
{
"change_type": "MODIFY",
"old_path": "quarkus/runtime/src/main/resources/META-INF/keycloak.conf",
"new_path": "quarkus/runtime/src/main/resources/META-INF/keycloak.conf",
"diff": "@@ -19,6 +19,7 @@ metrics-enabled=false\n# The default configuration when running in import or export mode\n%import_export.http-enabled=true\n+%import_export.http-server-enabled=false\n%import_export.hostname-strict=false\n%import_export.hostname-strict-https=false\n"
}
] | Java | Apache License 2.0 | keycloak/keycloak | initial impl of running export/import without serving |
339,465 | 12.01.2023 18:24:23 | -3,600 | 79fa6bb3c96bdecb18c602ad8ceeb4cbe4fc7876 | Initial support for running testsuite in BCFIPS approved mode
Closes | [
{
"change_type": "MODIFY",
"old_path": "docs/fips.md",
"new_path": "docs/fips.md",
"diff": "FIPS 140-2 Integration\n======================\n+Environment\n+-----------\n+All the steps below were tested on RHEL 8.6 with FIPS mode enabled (See [this page](https://access.redhat.com/documentation/en-us/red_hat_enterprise_linux/8/html/security_hardening/assembly_installing-a-rhel-8-system-with-fips-mode-enabled_security-hardening#doc-wrapper)\n+for the details) and with OpenJDK 17.0.5 on that host.\n+\nRun the server with FIPS\n------------------------\n@@ -21,8 +26,8 @@ running the unit tests below):\ncd $KEYCLOAK_HOME/bin\nexport MAVEN_REPO_HOME=$HOME/.m2/repository\nexport BCFIPS_VERSION=1.0.2.3\n-export BCTLSFIPS_VERSION=1.0.12.2\n-export BCPKIXFIPS_VERSION=1.0.5\n+export BCTLSFIPS_VERSION=1.0.14\n+export BCPKIXFIPS_VERSION=1.0.7\ncp $MAVEN_REPO_HOME/org/bouncycastle/bc-fips/$BCFIPS_VERSION/bc-fips-$BCFIPS_VERSION.jar ../providers/\ncp $MAVEN_REPO_HOME/org/bouncycastle/bctls-fips/$BCTLSFIPS_VERSION/bctls-fips-$BCTLSFIPS_VERSION.jar ../providers/\ncp $MAVEN_REPO_HOME/org/bouncycastle/bcpkix-fips/$BCPKIXFIPS_VERSION/bcpkix-fips-$BCPKIXFIPS_VERSION.jar ../providers/\n@@ -38,14 +43,17 @@ Note that for keystore generation, it is needed to use the BouncyCastle FIPS lib\nwill remove default SUN and SunPKCS11 providers as it doesn't work to create keystore with them on FIPS enabled OpenJDK11 due\nthe limitation described here https://access.redhat.com/solutions/6954451 and in the related bugzilla https://bugzilla.redhat.com/show_bug.cgi?id=2048582.\n```\n-export KEYSTORE_FILE=keycloak-server.pkcs12\n+export KEYSTORE_FILE=keycloak-server.p12\n#export KEYSTORE_FILE=keycloak-server.bcfks\nexport KEYCLOAK_SOURCES=$HOME/IdeaProjects/keycloak\nexport KEYSTORE_FORMAT=$(echo $KEYSTORE_FILE | cut -d. -f2)\n+if [ \"$KEYSTORE_FORMAT\" == \"p12\" ]; then\n+ export KEYSTORE_FORMAT=pkcs12;\n+fi;\n# Removing old keystore file to start from fresh\n-rm keycloak-server.pkcs12\n+rm keycloak-server.p12\nrm keycloak-server.bcfks\nkeytool -keystore $KEYSTORE_FILE \\\n@@ -57,13 +65,10 @@ keytool -keystore $KEYSTORE_FILE \\\n-alias localhost \\\n-genkeypair -sigalg SHA512withRSA -keyalg RSA -storepass passwordpassword \\\n-dname CN=localhost -keypass passwordpassword \\\n- -J-Djava.security.properties=$KEYCLOAK_SOURCES/crypto/fips1402/src/test/resources/kc.java.security\n+ -J-Djava.security.properties=$KEYCLOAK_SOURCES/testsuite/integration-arquillian/servers/auth-server/common/fips/kc.keystore-create.java.security\n```\n-3) Run \"build\" to re-augment with `enabled` fips mode and start the server.\n-\n-For the `fips-mode`, he alternative is to use `--fips-mode=strict` in which case BouncyCastle FIPS will use \"approved mode\",\n-which means even stricter security algorithms. As mentioned above, strict mode won't work with `pkcs12` keystore:\n+3) Run \"build\" to re-augment with `enabled` fips mode and start the server. This will run the server with BCFIPS in non-approved mode\n```\n./kc.sh start --fips-mode=enabled --hostname=localhost \\\n@@ -73,48 +78,24 @@ which means even stricter security algorithms. As mentioned above, strict mode w\n--log-level=INFO,org.keycloak.common.crypto:TRACE,org.keycloak.crypto:TRACE\n```\n-4) The approach above will run the Keycloak JVM with all the default java security providers and will add also\n-BouncyCastle FIPS security providers on top of that in runtime. This works fine, however it may not be guaranteed that\n-all the crypto algorithms are used in the FIPS compliant way as the default providers like \"Sun\" potentially allow non-FIPS\n-usage in the Java. Some more details here: https://access.redhat.com/documentation/en-us/openjdk/11/html-single/configuring_openjdk_11_on_rhel_with_fips/index#ref_openjdk-default-fips-configuration_openjdk\n-\n-To ensure that Java strictly allows to use only FIPS-compliant crypto, it can be good to rely solely just on the BCFIPS.\n-This is possible by using custom java security file, which adds just the BouncyCastle FIPS security providers. This requires\n-BouncyCastle FIPS dependencies to be available in the bootstrap classpath instead of adding them in runtime.\n-\n-So for this approach, it is needed to move the BCFIPS jars from the `providers` directory to bootstrap classpath.\n-```\n-mkdir ../lib/bootstrap\n-mv ../providers/bc*.jar ../lib/bootstrap/\n-```\n-Then run `build` and `start` commands as above, but with additional property for the alternative security file like\n+4) For the `fips-mode` option, the more secure alternative is to use `--fips-mode=strict` in which case BouncyCastle FIPS will use \"approved mode\",\n+which means even stricter security requirements on cryptography and security algorithms. Few more points:\n+- As mentioned above, strict mode won't work with `pkcs12` keystore. So it is needed to use other keystore (probably `bcfks`).\n+- User passwords must be 14 characters or longer. Keycloak uses PBKDF2 based password encoding by default. BCFIPS approved mode requires passwords to be at least 112 bits\n+- (effectively 14 characters). If you want to allow shorter password, you need to set property `max-padding-length` of\n+ provider `pbkdf2-sha256` of SPI `password-hashing` to value 14, so there will be some additional padding used when verifying hash created by this algorithm.\n+ This is also backwards compatible with previously stored passwords (if you had your user's DB in non-FIPS environment and you have shorter passwords and you\n+ want to verify them now with Keycloak using BCFIPS in approved mode, it should work fine). So effectively, you can use option like this when starting the server:\n```\n--Djava.security.properties=$KEYCLOAK_SOURCES/crypto/fips1402/src/test/resources/kc.java.security\n-```\n-At the server startup, you should see the message like this in the log and you can check if correct providers are present and not any others:\n-```\n-2022-10-10 08:23:07,097 TRACE [org.keycloak.common.crypto.CryptoIntegration] (main) Java security providers: [\n- KC(BCFIPS version 1.000203) version 1.0 - class org.keycloak.crypto.fips.KeycloakFipsSecurityProvider,\n- BCFIPS version 1.000203 - class org.bouncycastle.jcajce.provider.BouncyCastleFipsProvider,\n- BCJSSE version 1.001202 - class org.bouncycastle.jsse.provider.BouncyCastleJsseProvider,\n-]\n+--spi-password-hashing-pbkdf2-sha256-max-padding-length=14\n```\n+- RSA keys of 1024 bits don't work (2048 is the minimum)\n+- Also `jks` and `pkcs12` keystores/trustores are not supported.\n-NOTE: If you want to use BouncyCastle approved mode, then it is recommended to change/add these properties into the `kc.java.security`\n-file:\n-```\n-keystore.type=BCFKS\n-fips.keystore.type=BCFKS\n-org.bouncycastle.fips.approved_only=true\n-```\n-and then check that startup log contains `KC` provider contains KC provider with the note about `Approved Mode` like this:\n+When starting server at startup, you can check that startup log contains `KC` provider contains KC provider with the note about `Approved Mode` like this:\n```\nKC(BCFIPS version 1.000203 Approved Mode) version 1.0 - class org.keycloak.crypto.fips.KeycloakFipsSecurityProvider,\n```\n-Note that in approved mode, there are few limitations at the moment like for example:\n-- User passwords must be at least 14 characters long\n-- Keystore/truststore must be of type bcfks due the both of `jks` and `pkcs12` don't work\n-- Some warnings in the server.log at startup\nRun the CLI on the FIPS host\n----------------------------\n@@ -150,5 +131,4 @@ mvn clean install -f crypto/fips1402 -Dorg.bouncycastle.fips.approved_only=true\nRun the integration tests in the FIPS environment\n-------------------------------------------------\n-See the FIPS section in the [MySQL docker image](../testsuite/integration-arquillian/HOW-TO-RUN.md)\n-\n+See the FIPS section in the [HOW-TO-RUN.md](../testsuite/integration-arquillian/HOW-TO-RUN.md)\n"
},
{
"change_type": "MODIFY",
"old_path": "services/src/main/java/org/keycloak/credential/PasswordCredentialProvider.java",
"new_path": "services/src/main/java/org/keycloak/credential/PasswordCredentialProvider.java",
"diff": "@@ -64,9 +64,13 @@ public class PasswordCredentialProvider implements CredentialProvider<PasswordCr\nif (hash == null) {\nreturn false;\n}\n+ try {\nPasswordCredentialModel credentialModel = hash.encodedCredential(password, policy.getHashIterations());\ncredentialModel.setCreatedDate(Time.currentTimeMillis());\ncreateCredential(realm, user, credentialModel);\n+ } catch (Throwable t) {\n+ throw new ModelException(t.getMessage(), t);\n+ }\nreturn true;\n}\n@@ -174,6 +178,7 @@ public class PasswordCredentialProvider implements CredentialProvider<PasswordCr\nlogger.debugv(\"PasswordHashProvider {0} not found for user {1} \", password.getPasswordCredentialData().getAlgorithm(), user.getUsername());\nreturn false;\n}\n+ try {\nif (!hash.verify(input.getChallengeResponse(), password)) {\nlogger.debugv(\"Failed password validation for user {0} \", user.getUsername());\nreturn false;\n@@ -195,6 +200,10 @@ public class PasswordCredentialProvider implements CredentialProvider<PasswordCr\nnewPassword.setCreatedDate(password.getCreatedDate());\nnewPassword.setUserLabel(password.getUserLabel());\nuser.credentialManager().updateStoredCredential(newPassword);\n+ } catch (Throwable t) {\n+ logger.warn(\"Error when validating user password\", t);\n+ return false;\n+ }\nreturn true;\n}\n"
},
{
"change_type": "MODIFY",
"old_path": "testsuite/integration-arquillian/HOW-TO-RUN.md",
"new_path": "testsuite/integration-arquillian/HOW-TO-RUN.md",
"diff": "@@ -968,3 +968,16 @@ there should be messages similar to those:\nBCJSSE version 1.001202 - class org.bouncycastle.jsse.provider.BouncyCastleJsseProvider,\n]\n```\n+\n+### BCFIPS approved mode\n+\n+For running testsuite with server using BCFIPS approved mode, those additional properties should be added when running tests:\n+```\n+-Dauth.server.fips.mode=strict \\\n+-Dauth.server.supported.keystore.types=BCFKS \\\n+-Dauth.server.keystore.type=bcfks\n+```\n+The log should contain `KeycloakFipsSecurityProvider` mentioning \"Approved mode\". Something like:\n+```\n+KC(BCFIPS version 1.000203 Approved Mode) version 1.0 - class org.keycloak.crypto.fips.KeycloakFipsSecurityProvider,\n+```\n"
},
{
"change_type": "ADD",
"old_path": null,
"new_path": "testsuite/integration-arquillian/servers/auth-server/common/fips/README-keystores-format-conversion.md",
"diff": "+How to convert keystores and truststores\n+----------------------------------------\n+Magic command to import PKCS12 keystore to BCFKS\n+\n+```\n+keytool -importkeystore -srckeystore keycloak-fips.keystore.pkcs12 -destkeystore keycloak-fips.keystore.bcfks \\\n+ -srcstoretype PKCS12 -deststoretype BCFKS -deststorepass passwordpassword \\\n+ -providername BCFIPS \\\n+ -providerclass org.bouncycastle.jcajce.provider.BouncyCastleFipsProvider \\\n+ -provider org.bouncycastle.jcajce.provider.BouncyCastleFipsProvider \\\n+ -providerpath $MAVEN_REPO_HOME/org/bouncycastle/bc-fips/1.0.2.3/bc-fips-1.0.2.3.jar \\\n+ -J-Djava.security.properties=$KEYCLOAK_SOURCES/testsuite/integration-arquillian/servers/auth-server/common/fips/kc.keystore-create.java.security\n+```\n+Default password is `passwordpassword`.\n+\n+When converting from `JKS` to `PKCS12` on non-FIPS host, only first 2 lines from this command are needed (no need to use BCFIPS provider).\n+Original JKS keystore, which was used to create `PKCS12` (and transitively also `BCFKS`) keystore is [keycloak.jks](../keystore/keycloak.jks).\n+Original JKS truststore is [keycloak.truststore](../keystore/keycloak.truststore).\n\\ No newline at end of file\n"
},
{
"change_type": "ADD",
"old_path": null,
"new_path": "testsuite/integration-arquillian/servers/auth-server/common/fips/kc.keystore-create.java.security",
"diff": "+# This property is needed when creating keystore with BCFIPS provider on FIPS enabled RHEL 8.6 due the issue https://bugzilla.redhat.com/show_bug.cgi?id=2155060\n+# once that is fixed in the OpenJDK, we should be good.\n+securerandom.strongAlgorithms=PKCS11:SunPKCS11-NSS-FIPS\n"
},
{
"change_type": "ADD",
"old_path": "testsuite/integration-arquillian/servers/auth-server/common/fips/keycloak-fips.keystore.bcfks",
"new_path": "testsuite/integration-arquillian/servers/auth-server/common/fips/keycloak-fips.keystore.bcfks",
"diff": "Binary files /dev/null and b/testsuite/integration-arquillian/servers/auth-server/common/fips/keycloak-fips.keystore.bcfks differ\n"
},
{
"change_type": "ADD",
"old_path": "testsuite/integration-arquillian/servers/auth-server/common/fips/keycloak-fips.truststore.bcfks",
"new_path": "testsuite/integration-arquillian/servers/auth-server/common/fips/keycloak-fips.truststore.bcfks",
"diff": "Binary files /dev/null and b/testsuite/integration-arquillian/servers/auth-server/common/fips/keycloak-fips.truststore.bcfks differ\n"
},
{
"change_type": "MODIFY",
"old_path": "testsuite/integration-arquillian/tests/base/src/main/java/org/keycloak/testsuite/arquillian/containers/KeycloakQuarkusServerDeployableContainer.java",
"new_path": "testsuite/integration-arquillian/tests/base/src/main/java/org/keycloak/testsuite/arquillian/containers/KeycloakQuarkusServerDeployableContainer.java",
"diff": "@@ -294,6 +294,15 @@ public class KeycloakQuarkusServerDeployableContainer implements DeployableConta\ncommands.add(\"--spi-truststore-file-file=\" + configuration.getTruststoreFile());\ncommands.add(\"--spi-truststore-file-password=\" + configuration.getTruststorePassword());\ncommands.add(\"--spi-truststore-file-type=\" + configuration.getTruststoreType());\n+\n+ // BCFIPS approved mode requires passwords of at least 112 bits (14 characters) to be used. To bypass this, we use this by default\n+ // as testsuite uses shorter passwords everywhere\n+ if (FipsMode.strict == configuration.getFipsMode()) {\n+ commands.add(\"--spi-password-hashing-pbkdf2-max-padding-length=14\");\n+ commands.add(\"--spi-password-hashing-pbkdf2-sha256-max-padding-length=14\");\n+ commands.add(\"--spi-password-hashing-pbkdf2-sha512-max-padding-length=14\");\n+ }\n+\ncommands.add(\"--log-level=INFO,org.keycloak.common.crypto:TRACE,org.keycloak.crypto:TRACE,org.keycloak.truststore:TRACE\");\nconfiguration.appendJavaOpts(\"-Djava.security.properties=\" + System.getProperty(\"auth.server.java.security.file\"));\n"
}
] | Java | Apache License 2.0 | keycloak/keycloak | Initial support for running testsuite in BCFIPS approved mode
Closes #16429 |
339,185 | 12.01.2023 11:19:00 | -3,600 | 31195664075b065eead88047dee56783c42a3a24 | Prevent endless loop in case of split-brain
Fixes: | [
{
"change_type": "MODIFY",
"old_path": "model/infinispan/src/main/java/org/keycloak/connections/infinispan/DefaultInfinispanConnectionProviderFactory.java",
"new_path": "model/infinispan/src/main/java/org/keycloak/connections/infinispan/DefaultInfinispanConnectionProviderFactory.java",
"diff": "@@ -259,6 +259,7 @@ public class DefaultInfinispanConnectionProviderFactory implements InfinispanCon\n.l1()\n.enabled(l1Enabled)\n.lifespan(l1Lifespan)\n+ .stateTransfer().timeout(30, TimeUnit.SECONDS)\n.build();\n}\n"
},
{
"change_type": "MODIFY",
"old_path": "model/infinispan/src/main/java/org/keycloak/models/sessions/infinispan/InfinispanUserLoginFailureProviderFactory.java",
"new_path": "model/infinispan/src/main/java/org/keycloak/models/sessions/infinispan/InfinispanUserLoginFailureProviderFactory.java",
"diff": "@@ -181,6 +181,10 @@ public class InfinispanUserLoginFailureProviderFactory implements UserLoginFailu\n}\n}\n+ private int getStalledTimeoutInSeconds(int defaultTimeout) {\n+ return config.getInt(\"stalledTimeoutInSeconds\", defaultTimeout);\n+ }\n+\nprivate void loadLoginFailuresFromRemoteCaches(final KeycloakSessionFactory sessionFactory, String cacheName, final int sessionsPerSegment, final int maxErrors) {\nlog.debugf(\"Check pre-loading sessions from remote cache '%s'\", cacheName);\n@@ -190,9 +194,12 @@ public class InfinispanUserLoginFailureProviderFactory implements UserLoginFailu\npublic void run(KeycloakSession session) {\nInfinispanConnectionProvider connections = session.getProvider(InfinispanConnectionProvider.class);\nCache<String, Serializable> workCache = connections.getCache(InfinispanConnectionProvider.WORK_CACHE_NAME);\n+ int defaultStateTransferTimeout = (int) (connections.getCache(InfinispanConnectionProvider.LOGIN_FAILURE_CACHE_NAME)\n+ .getCacheConfiguration().clustering().stateTransfer().timeout() / 1000);\nInfinispanCacheInitializer initializer = new InfinispanCacheInitializer(sessionFactory, workCache,\n- new RemoteCacheSessionsLoader(cacheName, sessionsPerSegment), \"remoteCacheLoad::\" + cacheName, sessionsPerSegment, maxErrors);\n+ new RemoteCacheSessionsLoader(cacheName, sessionsPerSegment), \"remoteCacheLoad::\" + cacheName, sessionsPerSegment, maxErrors,\n+ getStalledTimeoutInSeconds(defaultStateTransferTimeout));\ninitializer.initCache();\ninitializer.loadSessions();\n"
},
{
"change_type": "MODIFY",
"old_path": "model/infinispan/src/main/java/org/keycloak/models/sessions/infinispan/InfinispanUserSessionProviderFactory.java",
"new_path": "model/infinispan/src/main/java/org/keycloak/models/sessions/infinispan/InfinispanUserSessionProviderFactory.java",
"diff": "@@ -165,6 +165,9 @@ public class InfinispanUserSessionProviderFactory implements UserSessionProvider\nreturn timeout != null ? timeout : Environment.getServerStartupTimeout();\n}\n+ private int getStalledTimeoutInSeconds(int defaultTimeout) {\n+ return config.getInt(\"sessionPreloadStalledTimeoutInSeconds\", defaultTimeout);\n+ }\n@Override\npublic void loadPersistentSessions(final KeycloakSessionFactory sessionFactory, final int maxErrors, final int sessionsPerSegment) {\n@@ -180,9 +183,12 @@ public class InfinispanUserSessionProviderFactory implements UserSessionProvider\nInfinispanConnectionProvider connections = session.getProvider(InfinispanConnectionProvider.class);\nCache<String, Serializable> workCache = connections.getCache(InfinispanConnectionProvider.WORK_CACHE_NAME);\n+ int defaultStateTransferTimeout = (int) (connections.getCache(InfinispanConnectionProvider.OFFLINE_USER_SESSION_CACHE_NAME)\n+ .getCacheConfiguration().clustering().stateTransfer().timeout() / 1000);\nInfinispanCacheInitializer ispnInitializer = new InfinispanCacheInitializer(sessionFactory, workCache,\n- new OfflinePersistentUserSessionLoader(sessionsPerSegment), \"offlineUserSessions\", sessionsPerSegment, maxErrors);\n+ new OfflinePersistentUserSessionLoader(sessionsPerSegment), \"offlineUserSessions\", sessionsPerSegment, maxErrors,\n+ getStalledTimeoutInSeconds(defaultStateTransferTimeout));\n// DB-lock to ensure that persistent sessions are loaded from DB just on one DC. The other DCs will load them from remote cache.\nCacheInitializer initializer = new DBLockBasedCacheInitializer(session, ispnInitializer);\n@@ -326,9 +332,12 @@ public class InfinispanUserSessionProviderFactory implements UserSessionProvider\npublic void run(KeycloakSession session) {\nInfinispanConnectionProvider connections = session.getProvider(InfinispanConnectionProvider.class);\nCache<String, Serializable> workCache = connections.getCache(InfinispanConnectionProvider.WORK_CACHE_NAME);\n+ int defaultStateTransferTimeout = (int) (connections.getCache(InfinispanConnectionProvider.USER_SESSION_CACHE_NAME)\n+ .getCacheConfiguration().clustering().stateTransfer().timeout() / 1000);\nInfinispanCacheInitializer initializer = new InfinispanCacheInitializer(sessionFactory, workCache,\n- new RemoteCacheSessionsLoader(cacheName, sessionsPerSegment), \"remoteCacheLoad::\" + cacheName, sessionsPerSegment, maxErrors);\n+ new RemoteCacheSessionsLoader(cacheName, sessionsPerSegment), \"remoteCacheLoad::\" + cacheName, sessionsPerSegment, maxErrors,\n+ getStalledTimeoutInSeconds(defaultStateTransferTimeout));\ninitializer.initCache();\ninitializer.loadSessions();\n"
},
{
"change_type": "MODIFY",
"old_path": "model/infinispan/src/main/java/org/keycloak/models/sessions/infinispan/initializer/BaseCacheInitializer.java",
"new_path": "model/infinispan/src/main/java/org/keycloak/models/sessions/infinispan/initializer/BaseCacheInitializer.java",
"diff": "@@ -72,6 +72,11 @@ public abstract class BaseCacheInitializer extends CacheInitializer {\nreturn transport == null || transport.isCoordinator();\n}\n+ @Override\n+ protected int getProgressIndicator() {\n+ InitializerState state = getStateFromCache();\n+ return state == null ? 0 : state.getProgressIndicator();\n+ }\nprotected InitializerState getStateFromCache() {\n// We ignore cacheStore for now, so that in Cross-DC scenario (with RemoteStore enabled) is the remoteStore ignored.\n"
},
{
"change_type": "MODIFY",
"old_path": "model/infinispan/src/main/java/org/keycloak/models/sessions/infinispan/initializer/CacheInitializer.java",
"new_path": "model/infinispan/src/main/java/org/keycloak/models/sessions/infinispan/initializer/CacheInitializer.java",
"diff": "package org.keycloak.models.sessions.infinispan.initializer;\n+import java.time.Instant;\n+import java.util.concurrent.TimeUnit;\nimport org.jboss.logging.Logger;\n/**\n@@ -30,10 +32,32 @@ public abstract class CacheInitializer {\n}\npublic void loadSessions() {\n+ Instant loadingMustContinueBy = Instant.now().plusSeconds(getStalledTimeoutInSeconds());\n+ boolean loadingStalledInPreviousStep = false;\n+ int lastProgressIndicator = 0;\nwhile (!isFinished()) {\nif (!isCoordinator()) {\ntry {\n- Thread.sleep(1000);\n+ TimeUnit.SECONDS.sleep(1);\n+\n+ final int progressIndicator = getProgressIndicator();\n+ final boolean loadingStalled = lastProgressIndicator == progressIndicator;\n+ if (loadingStalled) {\n+ if (loadingStalledInPreviousStep) {\n+ if (Instant.now().isAfter(loadingMustContinueBy)) {\n+ throw new RuntimeException(\"Loading sessions has stalled for \" + getStalledTimeoutInSeconds() + \" seconds, possibly caused by split-brain\");\n+ }\n+\n+ log.tracef(\"Loading sessions stalled. Waiting until %s\", loadingMustContinueBy);\n+ } else {\n+ loadingMustContinueBy = Instant.now().plusSeconds(getStalledTimeoutInSeconds());\n+ loadingStalledInPreviousStep = true;\n+ }\n+ } else {\n+ loadingStalledInPreviousStep = false;\n+ }\n+\n+ lastProgressIndicator = progressIndicator;\n} catch (InterruptedException ie) {\nlog.error(\"Interrupted\", ie);\nthrow new RuntimeException(\"Loading sessions failed\", ie);\n@@ -49,8 +73,19 @@ public abstract class CacheInitializer {\nprotected abstract boolean isCoordinator();\n+ /**\n+ * Returns an integer which captures current progress. If there is a progress in loading,\n+ * this indicator must be different most of the time so that it does not hit 30-seconds\n+ * limit.\n+ * @see #stalledTimeoutInSeconds\n+ * @return\n+ */\n+ protected abstract int getProgressIndicator();\n+\n/**\n* Just coordinator will run this\n*/\nprotected abstract void startLoading();\n+\n+ protected abstract int getStalledTimeoutInSeconds();\n}\n"
},
{
"change_type": "MODIFY",
"old_path": "model/infinispan/src/main/java/org/keycloak/models/sessions/infinispan/initializer/DBLockBasedCacheInitializer.java",
"new_path": "model/infinispan/src/main/java/org/keycloak/models/sessions/infinispan/initializer/DBLockBasedCacheInitializer.java",
"diff": "@@ -57,6 +57,15 @@ public class DBLockBasedCacheInitializer extends CacheInitializer {\nreturn delegate.isCoordinator();\n}\n+ @Override\n+ protected int getProgressIndicator() {\n+ return delegate.getProgressIndicator();\n+ }\n+\n+ @Override\n+ protected int getStalledTimeoutInSeconds() {\n+ return delegate.getStalledTimeoutInSeconds();\n+ }\n/**\n* Just coordinator will run this. And there is DB-lock, so the delegate.startLoading() will be permitted just by the single DC\n"
},
{
"change_type": "MODIFY",
"old_path": "model/infinispan/src/main/java/org/keycloak/models/sessions/infinispan/initializer/InfinispanCacheInitializer.java",
"new_path": "model/infinispan/src/main/java/org/keycloak/models/sessions/infinispan/initializer/InfinispanCacheInitializer.java",
"diff": "@@ -51,10 +51,13 @@ public class InfinispanCacheInitializer extends BaseCacheInitializer {\nprivate final int maxErrors;\n+ // Effectively no timeout\n+ private final int stalledTimeoutInSeconds;\n- public InfinispanCacheInitializer(KeycloakSessionFactory sessionFactory, Cache<String, Serializable> workCache, SessionLoader sessionLoader, String stateKeySuffix, int sessionsPerSegment, int maxErrors) {\n+ public InfinispanCacheInitializer(KeycloakSessionFactory sessionFactory, Cache<String, Serializable> workCache, SessionLoader sessionLoader, String stateKeySuffix, int sessionsPerSegment, int maxErrors, int stalledTimeoutInSeconds) {\nsuper(sessionFactory, workCache, sessionLoader, stateKeySuffix, sessionsPerSegment);\nthis.maxErrors = maxErrors;\n+ this.stalledTimeoutInSeconds = stalledTimeoutInSeconds;\n}\n@@ -111,6 +114,10 @@ public class InfinispanCacheInitializer extends BaseCacheInitializer {\nstartLoadingImpl(state, ctx[0]);\n}\n+ @Override\n+ protected int getStalledTimeoutInSeconds() {\n+ return this.stalledTimeoutInSeconds;\n+ }\nprotected void startLoadingImpl(InitializerState state, SessionLoader.LoaderContext loaderCtx) {\n// Assume each worker has same processor's count\n"
},
{
"change_type": "MODIFY",
"old_path": "model/infinispan/src/main/java/org/keycloak/models/sessions/infinispan/initializer/InitializerState.java",
"new_path": "model/infinispan/src/main/java/org/keycloak/models/sessions/infinispan/initializer/InitializerState.java",
"diff": "@@ -73,6 +73,11 @@ public class InitializerState extends SessionEntity {\nreturn segments.cardinality() == segmentsCount;\n}\n+ /** Return indication of progress - changes upon progress */\n+ public int getProgressIndicator() {\n+ return segments.hashCode();\n+ }\n+\n/** Return next un-finished segments in the next row of segments.\n* @param segmentToLoad The segment we are loading\n* @param maxSegmentCount The max segment to load\n"
},
{
"change_type": "MODIFY",
"old_path": "testsuite/model/src/test/java/org/keycloak/testsuite/model/parameters/Infinispan.java",
"new_path": "testsuite/model/src/test/java/org/keycloak/testsuite/model/parameters/Infinispan.java",
"diff": "@@ -23,6 +23,8 @@ import org.keycloak.keys.PublicKeyStorageSpi;\nimport org.keycloak.keys.infinispan.InfinispanCachePublicKeyProviderFactory;\nimport org.keycloak.keys.infinispan.InfinispanPublicKeyStorageProviderFactory;\nimport org.keycloak.models.SingleUseObjectSpi;\n+import org.keycloak.models.UserLoginFailureSpi;\n+import org.keycloak.models.UserSessionSpi;\nimport org.keycloak.models.cache.authorization.CachedStoreFactorySpi;\nimport org.keycloak.models.cache.infinispan.authorization.InfinispanCacheStoreFactoryProviderFactory;\nimport org.keycloak.models.cache.CachePublicKeyProviderSpi;\n@@ -98,7 +100,14 @@ public class Infinispan extends KeycloakModelParameters {\n.config(\"embedded\", \"true\")\n.config(\"clustered\", \"true\")\n.config(\"useKeycloakTimeService\", \"true\")\n- .config(\"nodeName\", \"node-\" + NODE_COUNTER.incrementAndGet());\n+ .config(\"nodeName\", \"node-\" + NODE_COUNTER.incrementAndGet())\n+ .spi(UserLoginFailureSpi.NAME)\n+ .provider(InfinispanUserLoginFailureProviderFactory.PROVIDER_ID)\n+ .config(\"stalledTimeoutInSeconds\", \"10\")\n+ .spi(UserSessionSpi.NAME)\n+ .provider(InfinispanUserSessionProviderFactory.PROVIDER_ID)\n+ .config(\"sessionPreloadStalledTimeoutInSeconds\", \"10\")\n+ ;\n}\npublic Infinispan() {\n"
}
] | Java | Apache License 2.0 | keycloak/keycloak | Prevent endless loop in case of split-brain
Fixes: #16427 |
339,235 | 16.01.2023 12:21:59 | -3,600 | dceb2f96b274b83c764c2ba8fd98dab16980f757 | Fix REST API header showing product.name.full
Closes | [
{
"change_type": "MODIFY",
"old_path": "services/src/docs/asciidoc/overview.adoc",
"new_path": "services/src/docs/asciidoc/overview.adoc",
"diff": "-= ${product.name.full} Admin REST API\n+= Keycloak Admin REST API\n== Overview\n-This is a REST API reference for the ${product.name.full} Admin REST API.\n+This is a REST API reference for the Keycloak Admin REST API.\n=== Version information\nVersion: 1\n"
}
] | Java | Apache License 2.0 | keycloak/keycloak | Fix REST API header showing product.name.full
Closes #16067 |
339,156 | 01.12.2022 10:40:47 | -7,200 | c73859794edd71e924e826c0a815f924f801bf22 | Short verification_uri for Device Authorization Request
Closes | [
{
"change_type": "MODIFY",
"old_path": "services/src/main/java/org/keycloak/protocol/oidc/grants/device/endpoints/DeviceEndpoint.java",
"new_path": "services/src/main/java/org/keycloak/protocol/oidc/grants/device/endpoints/DeviceEndpoint.java",
"diff": "@@ -80,6 +80,8 @@ public class DeviceEndpoint extends AuthorizationEndpointBase implements RealmRe\nprotected static final Logger logger = Logger.getLogger(DeviceEndpoint.class);\n+ public static final String SHORT_VERIFICATION_URI = \"shortVerificationUri\";\n+\nprivate final HttpRequest request;\nprivate Cors cors;\n@@ -168,7 +170,7 @@ public class DeviceEndpoint extends AuthorizationEndpointBase implements RealmRe\nsingleUseStore.put(userCode.serializeKey(), lifespanSeconds, userCode.serializeValue());\ntry {\n- String deviceUrl = DeviceGrantType.oauth2DeviceVerificationUrl(session.getContext().getUri()).build(realm.getName())\n+ String deviceUrl = realm.getAttribute(SHORT_VERIFICATION_URI) != null ? realm.getAttribute(SHORT_VERIFICATION_URI) : DeviceGrantType.oauth2DeviceVerificationUrl(session.getContext().getUri()).build(realm.getName())\n.toString();\nOAuth2DeviceAuthorizationResponse response = new OAuth2DeviceAuthorizationResponse();\n"
},
{
"change_type": "MODIFY",
"old_path": "testsuite/integration-arquillian/tests/base/src/test/java/org/keycloak/testsuite/oauth/OAuth2DeviceAuthorizationGrantTest.java",
"new_path": "testsuite/integration-arquillian/tests/base/src/test/java/org/keycloak/testsuite/oauth/OAuth2DeviceAuthorizationGrantTest.java",
"diff": "@@ -33,6 +33,7 @@ import org.keycloak.models.ClientScopeModel;\nimport org.keycloak.models.OAuth2DeviceConfig;\nimport org.keycloak.models.utils.KeycloakModelUtils;\nimport org.keycloak.protocol.oidc.OIDCConfigAttributes;\n+import org.keycloak.protocol.oidc.grants.device.endpoints.DeviceEndpoint;\nimport org.keycloak.representations.AccessToken;\nimport org.keycloak.representations.UserInfo;\nimport org.keycloak.representations.idm.ClientRepresentation;\n@@ -71,10 +72,11 @@ public class OAuth2DeviceAuthorizationGrantTest extends AbstractKeycloakTest {\nprivate static String userId;\n- public static final String REALM_NAME = \"test\";\n- public static final String DEVICE_APP = \"test-device\";\n- public static final String DEVICE_APP_PUBLIC = \"test-device-public\";\n- public static final String DEVICE_APP_PUBLIC_CUSTOM_CONSENT = \"test-device-public-custom-consent\";\n+ private static final String REALM_NAME = \"test\";\n+ private static final String DEVICE_APP = \"test-device\";\n+ private static final String DEVICE_APP_PUBLIC = \"test-device-public\";\n+ private static final String DEVICE_APP_PUBLIC_CUSTOM_CONSENT = \"test-device-public-custom-consent\";\n+ private static final String SHORT_DEVICE_FLOW_URL = \"https://keycloak.org/device\";\n@Rule\npublic AssertEvents events = new AssertEvents(this);\n@@ -217,6 +219,32 @@ public class OAuth2DeviceAuthorizationGrantTest extends AbstractKeycloakTest {\nassertNotNull(token);\n}\n+\n+ @Test\n+ public void testCustomVerificationUri() throws Exception {\n+ // Device Authorization Request from device\n+ try {\n+ RealmResource testRealm = adminClient.realm(REALM_NAME);\n+ RealmRepresentation realmRep = testRealm.toRepresentation();\n+ realmRep.getAttributes().put(DeviceEndpoint.SHORT_VERIFICATION_URI, SHORT_DEVICE_FLOW_URL);\n+ testRealm.update(realmRep);\n+ oauth.realm(REALM_NAME);\n+ oauth.clientId(DEVICE_APP_PUBLIC);\n+ OAuthClient.DeviceAuthorizationResponse response = oauth.doDeviceAuthorizationRequest(DEVICE_APP_PUBLIC, null);\n+\n+ Assert.assertEquals(200, response.getStatusCode());\n+ assertNotNull(response.getDeviceCode());\n+ assertNotNull(response.getUserCode());\n+ Assert.assertEquals(SHORT_DEVICE_FLOW_URL,response.getVerificationUri());\n+ Assert.assertEquals(SHORT_DEVICE_FLOW_URL + \"?user_code=\" + response.getUserCode(),response.getVerificationUriComplete());\n+ } finally {\n+ RealmResource testRealm = adminClient.realm(REALM_NAME);\n+ RealmRepresentation realmRep = testRealm.toRepresentation();\n+ realmRep.getAttributes().remove(\"shortVerificationUri\");\n+ testRealm.update(realmRep);\n+ }\n+ }\n+\n@Test\npublic void testPublicClientOptionalScope() throws Exception {\n// Device Authorization Request from device - check giving optional scope phone\n"
},
{
"change_type": "MODIFY",
"old_path": "themes/src/main/resources/theme/base/admin/messages/admin-messages_en.properties",
"new_path": "themes/src/main/resources/theme/base/admin/messages/admin-messages_en.properties",
"diff": "@@ -474,6 +474,8 @@ policy-uri=Policy URL\npolicy-uri.tooltip=URL that the Relying Party Client provides to the End-User to read about the how the profile data will be used\ntos-uri=Terms of service URL\ntos-uri.tooltip=URL that the Relying Party Client provides to the End-User to read about the Relying Party's terms of service\n+short-verification-uri= Short verification_uri in Device Authorization flow\n+short-verification-uri.tooltip= If set, this value will be return as verification_uri in Device Authorization flow. This uri need to redirect to {server-root}/realms/{realm}/device\n# client import\n"
},
{
"change_type": "MODIFY",
"old_path": "themes/src/main/resources/theme/base/admin/resources/partials/realm-tokens.html",
"new_path": "themes/src/main/resources/theme/base/admin/resources/partials/realm-tokens.html",
"diff": "<kc-tooltip>{{:: 'oauth2-device-polling-interval.tooltip' | translate}}</kc-tooltip>\n</div>\n+ <div class=\"form-group\">\n+ <label class=\"col-md-2 control-label\" for=\"shortVerificationUri\">{{:: 'short-verification-uri' | translate}}</label>\n+ <div class=\"col-md-6\">\n+ <input class=\"form-control\" id=\"shortVerificationUri\" type=\"text\" ng-model=\"realm.attributes.shortVerificationUri\" name=\"shortVerificationUri\">\n+ </div>\n+ <kc-tooltip>{{:: 'short-verification-uri.tooltip' | translate}}</kc-tooltip>\n+ </div>\n+\n<div class=\"form-group\">\n<div class=\"col-md-10 col-md-offset-2\" data-ng-show=\"access.manageRealm\">\n<button kc-save data-ng-disabled=\"!changed\">{{:: 'save' | translate}}</button>\n"
}
] | Java | Apache License 2.0 | keycloak/keycloak | Short verification_uri for Device Authorization Request
Closes #16107 |
339,269 | 18.01.2023 13:03:03 | -3,600 | e5ef0a417a32f8ac507392b2ca432f169ecc2a66 | Updated list of Keycloak repositories in GOVERNANCE.md | [
{
"change_type": "MODIFY",
"old_path": "GOVERNANCE.md",
"new_path": "GOVERNANCE.md",
"diff": "@@ -21,11 +21,12 @@ enabling the less common use cases through custom extensions.\nKeycloak consists of several projects:\n* [Keycloak](https://github.com/keycloak/keycloak) - Keycloak Server and Java adapters\n+* [Keycloak UI](https://github.com/keycloak/keycloak-ui) - Keycloak Admin and Account user interface\n* [Keycloak Documentation](https://github.com/keycloak/keycloak-documentation) - Documentation for Keycloak\n* [Keycloak QuickStarts](https://github.com/keycloak/keycloak-quickstarts) - QuickStarts for getting started with Keycloak\n-* [Keycloak Containers](https://github.com/keycloak/keycloak-containers) - Container images for Keycloak\n-* [Keycloak Node.js Connect](https://github.com/keycloak/keycloak-nodejs-connect) - Node.js adapter for Keycloak\n-* [Keycloak Node.js Admin Client](https://github.com/keycloak/keycloak-nodejs-admin-client) - Node.js library for Keycloak Admin REST API\n+* [Keycloak Benchmark](https://github.com/keycloak/keycloak-benchmark) - Load tests for benchmarking Keycloak\n+* [Keycloak Community](https://github.com/keycloak/keycloak-community) - Keycloak design documents\n+* [Keycloak Web](https://github.com/keycloak/keycloak-web) - Website keycloak.org\nThe same governance model applies to all projects. However, the list of maintainers may vary per project.\n"
}
] | Java | Apache License 2.0 | keycloak/keycloak | Updated list of Keycloak repositories in GOVERNANCE.md (#16447) |
339,272 | 18.01.2023 13:06:36 | -3,600 | 5ddb79cbe6ae4bd591df81428139aa468d23ad24 | fix(account): do not leak into messages
Closes | [
{
"change_type": "MODIFY",
"old_path": "services/src/main/java/org/keycloak/services/resources/account/AccountConsole.java",
"new_path": "services/src/main/java/org/keycloak/services/resources/account/AccountConsole.java",
"diff": "@@ -111,7 +111,8 @@ public class AccountConsole {\nif (auth != null) user = auth.getUser();\nLocale locale = session.getContext().resolveLocale(user);\nmap.put(\"locale\", locale.toLanguageTag());\n- Properties messages = theme.getMessages(locale);\n+ Properties messages = new Properties();\n+ messages.putAll(theme.getMessages(locale));\nif(StringUtil.isNotBlank(realm.getDefaultLocale())) {\nmessages.putAll(realm.getRealmLocalizationTextsByLocale(realm.getDefaultLocale()));\n}\n"
}
] | Java | Apache License 2.0 | keycloak/keycloak | fix(account): do not leak into messages (#16212)
Closes #16211 |
339,410 | 11.01.2023 10:46:46 | -3,600 | e9e6b73bd27b71be91731e1e311543118f29d05f | Avoid using Hibernate APIs to cache query results as the API changes in Hibernate 6
Closes | [
{
"change_type": "MODIFY",
"old_path": "model/map-jpa/src/main/java/org/keycloak/models/map/storage/jpa/JpaMapKeycloakTransaction.java",
"new_path": "model/map-jpa/src/main/java/org/keycloak/models/map/storage/jpa/JpaMapKeycloakTransaction.java",
"diff": "*/\npackage org.keycloak.models.map.storage.jpa;\n+import java.util.ArrayList;\nimport java.util.HashMap;\nimport java.util.LinkedList;\nimport java.util.List;\n@@ -25,7 +26,6 @@ import java.util.UUID;\nimport java.util.stream.Stream;\nimport javax.persistence.EntityManager;\nimport javax.persistence.LockModeType;\n-import javax.persistence.Parameter;\nimport javax.persistence.PersistenceException;\nimport javax.persistence.TypedQuery;\nimport javax.persistence.criteria.CriteriaBuilder;\n@@ -38,11 +38,9 @@ import javax.persistence.criteria.Selection;\nimport org.hibernate.Session;\nimport org.hibernate.internal.SessionImpl;\n-import org.hibernate.query.spi.QueryImplementor;\nimport org.jboss.logging.Logger;\nimport org.keycloak.common.util.Time;\nimport org.keycloak.models.KeycloakSession;\n-import org.keycloak.models.ModelException;\nimport org.keycloak.models.map.common.AbstractEntity;\nimport org.keycloak.models.map.common.ExpirableEntity;\nimport org.keycloak.models.map.common.StringKeyConverter;\n@@ -134,6 +132,26 @@ public abstract class JpaMapKeycloakTransaction<RE extends JpaRootEntity, E exte\n@Override\n@SuppressWarnings(\"unchecked\")\npublic Stream<E> read(QueryParameters<M> queryParameters) {\n+ Map<QueryCacheKey, List<RE>> cache = getQueryCache();\n+ QueryCacheKey queryCacheKey = new QueryCacheKey(queryParameters, modelType);\n+ if (!LockObjectsForModification.isEnabled(this.session, modelType)) {\n+ List<RE> previousResult = cache.get(queryCacheKey);\n+ SessionImpl session = (SessionImpl) em.unwrap(Session.class);\n+ // only do dirty checking if there is a previously cached result that would match the query\n+ if (previousResult != null) {\n+ // if the session is dirty, data has been modified, and the cache must not be used\n+ // check if there are queued actions already, as this allows us to skip the expensive dirty check\n+ if (!session.getActionQueue().areInsertionsOrDeletionsQueued() && session.getActionQueue().numberOfUpdates() == 0 && session.getActionQueue().numberOfCollectionUpdates() == 0 &&\n+ !session.isDirty()) {\n+ logger.tracef(\"tx %d: cache hit for %s/%s%s\", hashCode(), queryParameters, queryCacheKey, getShortStackTrace());\n+ return closing(previousResult.stream()).map(this::mapToEntityDelegateUnique);\n+ } else {\n+ logger.tracef(\"tx %d: cache ignored due to dirty session\", hashCode());\n+ }\n+ }\n+ }\n+ logger.tracef(\"tx %d: cache miss for %s/%s%s\", hashCode(), queryParameters, queryCacheKey, getShortStackTrace());\n+\nJpaModelCriteriaBuilder mcb = queryParameters.getModelCriteriaBuilder()\n.flashToModelCriteriaBuilder(createJpaModelCriteriaBuilder());\n@@ -170,27 +188,6 @@ public abstract class JpaMapKeycloakTransaction<RE extends JpaRootEntity, E exte\nTypedQuery<RE> emQuery = paginateQuery(em.createQuery(query), queryParameters.getOffset(), queryParameters.getLimit());\n- Map<QueryCacheKey, List<RE>> cache = getQueryCache();\n- QueryCacheKey queryCacheKey = new QueryCacheKey(emQuery, modelType);\n- if (!LockObjectsForModification.isEnabled(this.session, modelType)) {\n- List<RE> previousResult = cache.get(queryCacheKey);\n- //noinspection resource\n- SessionImpl session = (SessionImpl) em.unwrap(Session.class);\n- // only do dirty checking if there is a previously cached result that would match the query\n- if (previousResult != null) {\n- // if the session is dirty, data has been modified, and the cache must not be used\n- // check if there are queued actions already, as this allows us to skip the expensive dirty check\n- if (!session.getActionQueue().areInsertionsOrDeletionsQueued() && session.getActionQueue().numberOfUpdates() == 0 && session.getActionQueue().numberOfCollectionUpdates() == 0 &&\n- !session.isDirty()) {\n- logger.tracef(\"tx %d: cache hit for %s/%s%s\", hashCode(), queryParameters, queryCacheKey, getShortStackTrace());\n- return closing(previousResult.stream()).map(this::mapToEntityDelegateUnique);\n- } else {\n- logger.tracef(\"tx %d: cache ignored due to dirty session\", hashCode());\n- }\n- }\n- }\n- logger.tracef(\"tx %d: cache miss for %s/%s%s\", hashCode(), queryParameters, queryCacheKey, getShortStackTrace());\n-\nif (LockObjectsForModification.isEnabled(session, modelType)) {\nemQuery = emQuery.setLockMode(LockModeType.PESSIMISTIC_WRITE);\n}\n@@ -209,11 +206,10 @@ public abstract class JpaMapKeycloakTransaction<RE extends JpaRootEntity, E exte\n}\nprivate Map<QueryCacheKey, List<RE>> getQueryCache() {\n- //noinspection resource,unchecked\n+ //noinspection unchecked\nMap<QueryCacheKey, List<RE>> cache = (Map<QueryCacheKey, List<RE>>) em.unwrap(Session.class).getProperties().get(JPA_MAP_CACHE);\nif (cache == null) {\ncache = new HashMap<>();\n- //noinspection resource\nem.unwrap(Session.class).setProperty(JPA_MAP_CACHE, cache);\n}\nreturn cache;\n@@ -345,24 +341,17 @@ public abstract class JpaMapKeycloakTransaction<RE extends JpaRootEntity, E exte\nprivate static class QueryCacheKey {\nprivate final String queryString;\n- private final Integer queryMaxResults;\n- private final Integer queryFirstResult;\n- private final HashMap<String, Object> queryParameters;\n+ private final Integer queryLimit;\n+ private final Integer queryOffset;\nprivate final Class<?> modelType;\n+ private final List<? extends QueryParameters.OrderBy<?>> queryOrderBy;\n- public QueryCacheKey(TypedQuery<?> emQuery, Class<?> modelType) {\n+ public QueryCacheKey(QueryParameters<?> query, Class<?> modelType) {\n// copy over all fields from the query that relevant for caching\n- QueryImplementor<?> query = emQuery.unwrap(QueryImplementor.class);\n- this.queryString = query.getQueryString();\n- this.queryParameters = new HashMap<>();\n- for (Parameter<?> parameter : query.getParameters()) {\n- if (parameter.getName() == null) {\n- throw new ModelException(\"Can't prepare query for caching as parameter doesn't have a name\");\n- }\n- this.queryParameters.put(parameter.getName(), query.getParameterValue(parameter.getName()));\n- }\n- this.queryMaxResults = emQuery.getMaxResults();\n- this.queryFirstResult = emQuery.getFirstResult();\n+ this.queryString = query.getModelCriteriaBuilder().toString();\n+ this.queryLimit = query.getLimit();\n+ this.queryOffset = query.getOffset();\n+ this.queryOrderBy = new ArrayList<>(query.getOrderBy());\nthis.modelType = modelType;\n}\n@@ -372,24 +361,24 @@ public abstract class JpaMapKeycloakTransaction<RE extends JpaRootEntity, E exte\nif (o == null || getClass() != o.getClass()) return false;\nQueryCacheKey that = (QueryCacheKey) o;\nreturn Objects.equals(queryString, that.queryString)\n- && Objects.equals(queryMaxResults, that.queryMaxResults)\n- && Objects.equals(queryFirstResult, that.queryFirstResult)\n- && Objects.equals(queryParameters, that.queryParameters)\n+ && Objects.equals(queryLimit, that.queryLimit)\n+ && Objects.equals(queryOffset, that.queryOffset)\n+ && Objects.equals(queryOrderBy, that.queryOrderBy)\n&& Objects.equals(modelType, that.modelType);\n}\n@Override\npublic int hashCode() {\n- return Objects.hash(queryString, queryMaxResults, queryFirstResult, queryParameters, modelType);\n+ return Objects.hash(queryString, queryLimit, queryOffset, queryOrderBy, modelType);\n}\n@Override\npublic String toString() {\nreturn \"QueryCacheKey{\" +\n\"queryString='\" + queryString + '\\'' +\n- \", queryMaxResults=\" + queryMaxResults +\n- \", queryFirstResult=\" + queryFirstResult +\n- \", queryParameters=\" + queryParameters +\n+ \", queryMaxResults=\" + queryLimit +\n+ \", queryFirstResult=\" + queryOffset +\n+ \", queryOrderBy=\" + queryOrderBy +\n\", modelType=\" + modelType.getName() +\n'}';\n}\n"
},
{
"change_type": "MODIFY",
"old_path": "model/map/src/main/java/org/keycloak/models/map/storage/QueryParameters.java",
"new_path": "model/map/src/main/java/org/keycloak/models/map/storage/QueryParameters.java",
"diff": "@@ -5,6 +5,7 @@ import org.keycloak.storage.SearchableModelField;\nimport java.util.LinkedList;\nimport java.util.List;\n+import java.util.Objects;\nimport static org.keycloak.models.map.storage.QueryParameters.Order.ASCENDING;\n@@ -146,5 +147,18 @@ public class QueryParameters<M> {\npublic Order getOrder() {\nreturn order;\n}\n+\n+ @Override\n+ public boolean equals(Object o) {\n+ if (this == o) return true;\n+ if (o == null || getClass() != o.getClass()) return false;\n+ OrderBy<?> orderBy = (OrderBy<?>) o;\n+ return Objects.equals(modelField, orderBy.modelField) && order == orderBy.order;\n+ }\n+\n+ @Override\n+ public int hashCode() {\n+ return Objects.hash(modelField, order);\n+ }\n}\n}\n"
}
] | Java | Apache License 2.0 | keycloak/keycloak | Avoid using Hibernate APIs to cache query results as the API changes in Hibernate 6
Closes #16332 |
339,282 | 20.01.2023 02:08:31 | 18,000 | d388ae7ce7bdea977591324eb3958d9d8d097c67 | Fix markdown link to database tests | [
{
"change_type": "MODIFY",
"old_path": "docs/tests.md",
"new_path": "docs/tests.md",
"diff": "@@ -16,7 +16,7 @@ To run the tests with Firefox add `-Dbrowser=firefox` or for Chrome add `-Dbrows\nDatabase\n--------\n-By default the testsuite uses an embedded H2 database to test with other databases see (Database Testing)[tests-db.md].\n+By default the testsuite uses an embedded H2 database to test with other databases see [Database Testing](tests-db.md).\nTest utils\n==========\n"
}
] | Java | Apache License 2.0 | keycloak/keycloak | Fix markdown link to database tests (#15457) |
339,307 | 20.01.2023 09:10:31 | -3,600 | ac6b9ed42151d00086ad33220a491c9afc74a101 | docs: add missing backslash to realm startup command | [
{
"change_type": "MODIFY",
"old_path": "docs/guides/src/main/server/containers.adoc",
"new_path": "docs/guides/src/main/server/containers.adoc",
"diff": "@@ -163,7 +163,7 @@ The https://quay.io/keycloak/keycloak[published Keycloak containers] have a dire\n----\npodman|docker run --name keycloak_unoptimized -p 8080:8080 \\\n-e KEYCLOAK_ADMIN=admin -e KEYCLOAK_ADMIN_PASSWORD=change_me \\\n- -v /path/to/realm/data:/opt/keycloak/data/import\n+ -v /path/to/realm/data:/opt/keycloak/data/import \\\nquay.io/keycloak/keycloak:latest \\\nstart-dev --import-realm\n----\n"
}
] | Java | Apache License 2.0 | keycloak/keycloak | docs: add missing backslash to realm startup command (#16381) |
339,510 | 20.01.2023 09:11:04 | -3,600 | 234267556d57f59e38d5c034983283c488224307 | Update logging.adoc
Incorrect reference to "log-format" configuration instead of "log-console-format" | [
{
"change_type": "MODIFY",
"old_path": "docs/guides/src/main/server/logging.adoc",
"new_path": "docs/guides/src/main/server/logging.adoc",
"diff": "@@ -108,7 +108,7 @@ To set the logging format for a logged line, perform these steps:\n. Build your desired format template using the preceding table.\n. Enter the following command:\n+\n-<@kc.start parameters=\"--log-format=\\\"\\'<format>\\'\\\"\"/>\n+<@kc.start parameters=\"--log-console-format=\\\"\\'<format>\\'\\\"\"/>\nNote that you need to escape characters when invoking commands containing special shell characters such as `;` using the CLI. Therefore, consider setting it in the configuration file instead.\n"
}
] | Java | Apache License 2.0 | keycloak/keycloak | Update logging.adoc (#16179)
Incorrect reference to "log-format" configuration instead of "log-console-format" |
339,410 | 20.01.2023 09:11:38 | -3,600 | bd30023d629d92dacf805a6318b4380c42f1e26d | Cache the maven wrapper JAR for Maven builds
Closes | [
{
"change_type": "MODIFY",
"old_path": ".github/actions/maven-cache/action.yml",
"new_path": ".github/actions/maven-cache/action.yml",
"diff": "@@ -26,3 +26,12 @@ runs:\nls ~/.m2/repository/org/keycloak\nexit 1\nfi\n+\n+ - name: Cache Maven Wrapper\n+ uses: actions/cache@v3\n+ with:\n+ path: .mvn/wrapper/maven-wrapper.jar\n+ key: ${{ runner.os }}-maven-wrapper-${{ hashFiles('**/maven-wrapper.properties') }}\n+ # use a previously cached JAR file as something else besides the version could have changed in the file\n+ restore-keys: |\n+ ${{ runner.os }}-maven-wrapper-\n\\ No newline at end of file\n"
}
] | Java | Apache License 2.0 | keycloak/keycloak | Cache the maven wrapper JAR for Maven builds (#16092)
Closes #16091 |
339,677 | 20.01.2023 09:14:32 | -3,600 | 447364076adb84b62d0d5db38502a02774b0254d | Update containers.adoc
You have to set also variable KC_DB after building image, otherwise Keycloak will default to H2 database | [
{
"change_type": "MODIFY",
"old_path": "docs/guides/src/main/server/containers.adoc",
"new_path": "docs/guides/src/main/server/containers.adoc",
"diff": "@@ -40,6 +40,7 @@ FROM quay.io/keycloak/keycloak:latest\nCOPY --from=builder /opt/keycloak/ /opt/keycloak/\n# change these values to point to a running postgres instance\n+ENV KC_DB=postgres\nENV KC_DB_URL=<DBURL>\nENV KC_DB_USERNAME=<DBUSERNAME>\nENV KC_DB_PASSWORD=<DBPASSWORD>\n"
}
] | Java | Apache License 2.0 | keycloak/keycloak | Update containers.adoc (#15729)
You have to set also variable KC_DB after building image, otherwise Keycloak will default to H2 database |
339,185 | 23.01.2023 14:43:20 | -3,600 | 977cc473bb3a52d2d3e2d76bf2d94cffcf2bfaae | Fix linebreaks in XML / SAML signatures
See
See
Fixes: | [
{
"change_type": "MODIFY",
"old_path": "saml-core/src/main/java/org/keycloak/saml/common/util/SystemPropertiesUtil.java",
"new_path": "saml-core/src/main/java/org/keycloak/saml/common/util/SystemPropertiesUtil.java",
"diff": "@@ -32,6 +32,11 @@ public class SystemPropertiesUtil {\nSecurityActions.setSystemProperty(xmlSec, \"true\");\n}\n+ String xmlSecOpenJdk = \"com.sun.org.apache.xml.internal.security.ignoreLineBreaks\";\n+ if (StringUtil.isNullOrEmpty(SecurityActions.getSystemProperty(xmlSecOpenJdk, \"\"))) {\n+ SecurityActions.setSystemProperty(xmlSecOpenJdk, \"true\");\n+ }\n+\n// For JAXP Validation\nString schemaFactoryProperty = \"javax.xml.validation.SchemaFactory:\" + XMLConstants.W3C_XML_SCHEMA_NS_URI;\nif (StringUtil.isNullOrEmpty(SecurityActions.getSystemProperty(schemaFactoryProperty, \"\"))) {\n"
},
{
"change_type": "MODIFY",
"old_path": "testsuite/integration-arquillian/tests/base/src/test/java/org/keycloak/testsuite/saml/BasicSamlTest.java",
"new_path": "testsuite/integration-arquillian/tests/base/src/test/java/org/keycloak/testsuite/saml/BasicSamlTest.java",
"diff": "@@ -2,6 +2,7 @@ package org.keycloak.testsuite.saml;\nimport org.junit.Test;\nimport org.keycloak.dom.saml.v2.protocol.AuthnRequestType;\n+import org.keycloak.protocol.saml.SamlConfigAttributes;\nimport org.keycloak.protocol.saml.SamlProtocol;\nimport org.keycloak.saml.SignatureAlgorithm;\nimport org.keycloak.saml.common.constants.GeneralConstants;\n@@ -14,6 +15,7 @@ import org.keycloak.saml.processing.api.saml.v2.request.SAML2Request;\nimport org.keycloak.saml.processing.core.saml.v2.common.SAMLDocumentHolder;\nimport org.keycloak.saml.processing.web.util.RedirectBindingUtil;\nimport org.keycloak.services.resources.RealmsResource;\n+import org.keycloak.testsuite.updaters.ClientAttributeUpdater;\nimport org.keycloak.testsuite.util.KeyUtils;\nimport org.keycloak.testsuite.util.Matchers;\nimport org.keycloak.testsuite.util.SamlClient;\n@@ -48,6 +50,7 @@ import static org.hamcrest.Matchers.is;\nimport static org.hamcrest.Matchers.nullValue;\nimport static org.hamcrest.Matchers.notNullValue;\nimport static org.hamcrest.MatcherAssert.assertThat;\n+import static org.hamcrest.Matchers.matchesRegex;\nimport static org.keycloak.saml.common.constants.JBossSAMLURIConstants.NAMEID_FORMAT_TRANSIENT;\nimport static org.keycloak.saml.common.constants.JBossSAMLURIConstants.PROTOCOL_NSURI;\nimport static org.keycloak.testsuite.util.ServerURLs.AUTH_SERVER_PORT;\n@@ -304,4 +307,24 @@ public class BasicSamlTest extends AbstractSamlTest {\nassertThat(\"AuthnRequest/NameIdPolicy Format should be Transient, but it is not\", formatAttribute.getNodeValue(), is(NAMEID_FORMAT_TRANSIENT.get()));\nassertThat(\"AuthnRequest/NameIdPolicy element shouldn't contain the AllowCreate attribute when Format is set to Transient, but it does\", allowCreateAttribute, nullValue());\n}\n+\n+ @Test\n+ public void testSignatureContainsAllowedCharactersOnly() throws IOException {\n+ try (var c = ClientAttributeUpdater.forClient(adminClient, REALM_NAME, SAML_CLIENT_ID_SALES_POST)\n+ .setAttribute(SamlConfigAttributes.SAML_SERVER_SIGNATURE, \"true\")\n+ .update()\n+ ) {\n+ SAMLDocumentHolder documentHolder = new SamlClientBuilder()\n+ .authnRequest(getAuthServerSamlEndpoint(REALM_NAME), SAML_CLIENT_ID_SALES_POST, SAML_ASSERTION_CONSUMER_URL_SALES_POST, Binding.POST).build()\n+ .login().user(bburkeUser).build()\n+ .getSamlResponse(Binding.POST);\n+\n+ final String signature = documentHolder.getSamlDocument()\n+ .getElementsByTagName(\"dsig:SignatureValue\")\n+ .item(0).getTextContent();\n+\n+ // Corresponds to https://www.w3.org/TR/xmlschema-2/#base64Binary\n+ assertThat(signature, matchesRegex(\"^[A-Za-z0-9+/ ]+[= ]*$\"));\n+ }\n+ }\n}\n"
}
] | Java | Apache License 2.0 | keycloak/keycloak | Fix linebreaks in XML / SAML signatures
See https://bugs.openjdk.org/browse/JDK-8264194
See https://issues.apache.org/jira/browse/SANTUARIO-482
Fixes: #14529 |
339,687 | 24.01.2023 16:01:03 | -3,600 | 83147a67a0077668a51ef50fdc6b73b3bcb8d46d | Added New Account Console Tests to CI workflow. | [
{
"change_type": "MODIFY",
"old_path": ".github/workflows/ci.yml",
"new_path": ".github/workflows/ci.yml",
"diff": "@@ -438,6 +438,42 @@ jobs:\nwith:\njob-name: FIPS IT\n+ account-console-integration-tests:\n+ name: Account Console IT\n+ runs-on: ubuntu-latest\n+ needs: build\n+ timeout-minutes: 75\n+ strategy:\n+ matrix:\n+ browser: [firefox] # Chrome not working for now\n+ fail-fast: false\n+ steps:\n+ - uses: actions/checkout@v3\n+\n+ - name: Setup firefox\n+ uses: browser-actions/setup-firefox@latest\n+ with:\n+ firefox-version: latest\n+ - run: firefox --version\n+\n+ - id: integration-test-setup\n+ name: Integration test setup\n+ uses: ./.github/actions/integration-test-setup\n+\n+ - name: Run Account Console IT\n+ run: ./mvnw test -Dsurefire.rerunFailingTestsCount=${{ env.SUREFIRE_RERUN_FAILING_COUNT }} -nsu -B -Pauth-server-quarkus -Dtest=**.account2.**,!SigningInTest#passwordlessWebAuthnTest,!SigningInTest#twoFactorWebAuthnTest -Dbrowser=${{ matrix.browser }} -f testsuite/integration-arquillian/tests/other/base-ui/pom.xml | misc/log/trimmer.sh\n+\n+ - name: Upload JVM Heapdumps\n+ if: always()\n+ uses: ./.github/actions/upload-heapdumps\n+\n+ - uses: ./.github/actions/upload-flaky-tests\n+ name: Upload flaky tests\n+ env:\n+ GH_TOKEN: ${{ github.token }}\n+ with:\n+ job-name: Account Console IT\n+\ncheck-set-status:\nname: Set check conclusion\nneeds:\n@@ -451,6 +487,7 @@ jobs:\n- clustering-integration-tests\n- fips-unit-tests\n- fips-integration-tests\n+ - account-console-integration-tests\nruns-on: ubuntu-latest\noutputs:\nconclusion: ${{ steps.check.outputs.conclusion }}\n"
},
{
"change_type": "MODIFY",
"old_path": "testsuite/integration-arquillian/tests/other/base-ui/src/test/java/org/keycloak/testsuite/ui/account2/InternationalizationTest.java",
"new_path": "testsuite/integration-arquillian/tests/other/base-ui/src/test/java/org/keycloak/testsuite/ui/account2/InternationalizationTest.java",
"diff": "@@ -19,6 +19,7 @@ package org.keycloak.testsuite.ui.account2;\nimport org.jboss.arquillian.graphene.page.Page;\nimport org.junit.Before;\n+import org.junit.Ignore;\nimport org.junit.Test;\nimport org.keycloak.models.UserModel;\nimport org.keycloak.models.credential.PasswordCredentialModel;\n@@ -85,6 +86,7 @@ public class InternationalizationTest extends AbstractAccountTest {\n}\n@Test\n+ @Ignore\npublic void loginFormTest() {\npersonalInfoPage.navigateTo();\nloginPage.localeDropdown().selectAndAssert(CUSTOM_LOCALE_NAME);\n@@ -106,6 +108,7 @@ public class InternationalizationTest extends AbstractAccountTest {\n}\n@Test\n+ @Ignore\npublic void shouldDisplayTimeUsingSelectedLocale() {\nsigningInPage.navigateTo();\nloginToAccount();\n"
},
{
"change_type": "MODIFY",
"old_path": "testsuite/integration-arquillian/tests/pom.xml",
"new_path": "testsuite/integration-arquillian/tests/pom.xml",
"diff": "<firefoxLegacyDriver>false</firefoxLegacyDriver>\n<firefoxDriverVersion/>\n<firefoxUserPreferences/>\n- <firefoxHeadless>false</firefoxHeadless>\n+ <firefoxHeadless>true</firefoxHeadless>\n<chromeBinary/>\n- <chromeArguments/>\n+ <chromeArguments>--headless</chromeArguments>\n<chromeDriverVersion/>\n<appium.platformName/>\n"
}
] | Java | Apache License 2.0 | keycloak/keycloak | Added New Account Console Tests to CI workflow. (#16547) |
339,468 | 10.01.2023 14:09:33 | -3,600 | 69c114288df382c850c56de28944142d126cf862 | Return 404 when trying to retrieve non-existing external IDP token | [
{
"change_type": "MODIFY",
"old_path": "services/src/main/java/org/keycloak/services/resources/IdentityBrokerService.java",
"new_path": "services/src/main/java/org/keycloak/services/resources/IdentityBrokerService.java",
"diff": "@@ -474,6 +474,10 @@ public class IdentityBrokerService implements IdentityProvider.AuthenticationCal\nreturn corsResponse(badRequest(\"User [\" + authResult.getUser().getId() + \"] is not associated with identity provider [\" + providerId + \"].\"), clientModel);\n}\n+ if (identity.getToken() == null) {\n+ return corsResponse(notFound(\"No token stored for user [\" + authResult.getUser().getId() + \"] with associated identity provider [\" + providerId + \"].\"), clientModel);\n+ }\n+\nthis.event.success();\nreturn corsResponse(identityProvider.retrieveToken(session, identity), clientModel);\n@@ -1224,6 +1228,11 @@ public class IdentityBrokerService implements IdentityProvider.AuthenticationCal\nreturn ErrorResponse.error(message, Response.Status.FORBIDDEN);\n}\n+ private Response notFound(String message) {\n+ fireErrorEvent(message);\n+ return ErrorResponse.error(message, Response.Status.NOT_FOUND);\n+ }\n+\npublic static IdentityProvider getIdentityProvider(KeycloakSession session, RealmModel realm, String alias) {\nIdentityProviderModel identityProviderModel = realm.getIdentityProviderByAlias(alias);\n"
}
] | Java | Apache License 2.0 | keycloak/keycloak | Return 404 when trying to retrieve non-existing external IDP token |
339,465 | 23.01.2023 14:42:43 | -3,600 | 16888eaeabe9f81eb6347a25f8161cd7b84c5623 | Only available RSA key sizes should be shown in admin console
Closes | [
{
"change_type": "MODIFY",
"old_path": "common/src/main/java/org/keycloak/common/crypto/CryptoProvider.java",
"new_path": "common/src/main/java/org/keycloak/common/crypto/CryptoProvider.java",
"diff": "@@ -15,7 +15,6 @@ import java.security.cert.CertificateException;\nimport java.security.cert.CertificateFactory;\nimport java.security.cert.CollectionCertStoreParameters;\nimport java.security.spec.ECParameterSpec;\n-import java.util.function.Supplier;\nimport java.util.stream.Stream;\nimport javax.crypto.Cipher;\n@@ -124,4 +123,11 @@ public interface CryptoProvider {\n* @return decorated factory\n*/\nSSLSocketFactory wrapFactoryForTruststore(SSLSocketFactory delegate);\n+\n+ /**\n+ * @return Allowed key sizes of RSA key modulus, which this cryptoProvider supports\n+ */\n+ default String[] getSupportedRsaKeySizes() {\n+ return new String[] {\"1024\", \"2048\", \"4096\"};\n+ }\n}\n"
},
{
"change_type": "MODIFY",
"old_path": "crypto/fips1402/src/main/java/org/keycloak/crypto/fips/Fips1402StrictCryptoProvider.java",
"new_path": "crypto/fips1402/src/main/java/org/keycloak/crypto/fips/Fips1402StrictCryptoProvider.java",
"diff": "@@ -14,4 +14,10 @@ public class Fips1402StrictCryptoProvider extends FIPS1402Provider {\nstatic {\nSystem.setProperty(\"org.bouncycastle.fips.approved_only\", Boolean.TRUE.toString());\n}\n+\n+ @Override\n+ public String[] getSupportedRsaKeySizes() {\n+ // RSA key of 1024 bits not supported in BCFIPS approved mode\n+ return new String[] {\"2048\", \"4096\"};\n+ }\n}\n"
},
{
"change_type": "MODIFY",
"old_path": "services/src/main/java/org/keycloak/keys/AbstractGeneratedRsaKeyProviderFactory.java",
"new_path": "services/src/main/java/org/keycloak/keys/AbstractGeneratedRsaKeyProviderFactory.java",
"diff": "@@ -78,7 +78,7 @@ public abstract class AbstractGeneratedRsaKeyProviderFactory extends AbstractRsa\npublic void validateConfiguration(KeycloakSession session, RealmModel realm, ComponentModel model) throws ComponentValidationException {\nsuper.validateConfiguration(session, realm, model);\n- ConfigurationValidationHelper.check(model).checkList(Attributes.KEY_SIZE_PROPERTY, false);\n+ ConfigurationValidationHelper.check(model).checkList(Attributes.KEY_SIZE_PROPERTY.get(), false);\nint size = model.get(Attributes.KEY_SIZE_KEY, 2048);\n@@ -103,6 +103,10 @@ public abstract class AbstractGeneratedRsaKeyProviderFactory extends AbstractRsa\nkeyPair = KeyUtils.generateRsaKeyPair(size);\nmodel.put(Attributes.PRIVATE_KEY_KEY, PemUtils.encodeKey(keyPair.getPrivate()));\n} catch (Throwable t) {\n+ getLogger().warnf(\"Failed to generate keys for key provider '%s' in realm '%s'. Details: %s\", model.getName(), realm.getName(), t.getMessage());\n+ if (getLogger().isDebugEnabled()) {\n+ getLogger().debug(t.getMessage(), t);\n+ }\nthrow new ComponentValidationException(\"Failed to generate keys\", t);\n}\n@@ -114,6 +118,10 @@ public abstract class AbstractGeneratedRsaKeyProviderFactory extends AbstractRsa\nCertificate certificate = CertificateUtils.generateV1SelfSignedCertificate(keyPair, realm.getName());\nmodel.put(Attributes.CERTIFICATE_KEY, PemUtils.encodeCertificate(certificate));\n} catch (Throwable t) {\n+ getLogger().warnf(\"Failed to generate certificate for key provider '%s' in realm '%s'. Details: %s\", model.getName(), realm.getName(), t.getMessage());\n+ if (getLogger().isDebugEnabled()) {\n+ getLogger().debug(t.getMessage(), t);\n+ }\nthrow new ComponentValidationException(\"Failed to generate certificate\", t);\n}\n}\n"
},
{
"change_type": "MODIFY",
"old_path": "services/src/main/java/org/keycloak/keys/Attributes.java",
"new_path": "services/src/main/java/org/keycloak/keys/Attributes.java",
"diff": "package org.keycloak.keys;\n+import java.util.function.Supplier;\n+\n+import org.keycloak.common.crypto.CryptoIntegration;\nimport org.keycloak.crypto.Algorithm;\nimport org.keycloak.crypto.KeyUse;\nimport org.keycloak.jose.jwe.JWEConstants;\n@@ -45,7 +48,8 @@ public interface Attributes {\nProviderConfigProperty CERTIFICATE_PROPERTY = new ProviderConfigProperty(CERTIFICATE_KEY, \"X509 Certificate\", \"X509 Certificate encoded in PEM format\", FILE_TYPE, null);\nString KEY_SIZE_KEY = \"keySize\";\n- ProviderConfigProperty KEY_SIZE_PROPERTY = new ProviderConfigProperty(KEY_SIZE_KEY, \"Key size\", \"Size for the generated keys\", LIST_TYPE, \"2048\", \"1024\", \"2048\", \"4096\");\n+ Supplier<ProviderConfigProperty> KEY_SIZE_PROPERTY = () -> new ProviderConfigProperty(KEY_SIZE_KEY, \"Key size\", \"Size for the generated keys\", LIST_TYPE, \"2048\",\n+ CryptoIntegration.getProvider().getSupportedRsaKeySizes());\nString KEY_USE = \"keyUse\";\nProviderConfigProperty KEY_USE_PROPERTY = new ProviderConfigProperty(KEY_USE, \"Key use\", \"Whether the key should be used for signing or encryption.\", LIST_TYPE,\n"
},
{
"change_type": "MODIFY",
"old_path": "services/src/main/java/org/keycloak/keys/GeneratedRsaEncKeyProviderFactory.java",
"new_path": "services/src/main/java/org/keycloak/keys/GeneratedRsaEncKeyProviderFactory.java",
"diff": "@@ -37,11 +37,6 @@ public class GeneratedRsaEncKeyProviderFactory extends AbstractGeneratedRsaKeyPr\nprivate static final String HELP_TEXT = \"Generates RSA keys for key encryption and creates a self-signed certificate\";\n- private static final List<ProviderConfigProperty> CONFIG_PROPERTIES = AbstractGeneratedRsaKeyProviderFactory.rsaKeyConfigurationBuilder()\n- .property(Attributes.KEY_SIZE_PROPERTY)\n- .property(Attributes.RS_ENC_ALGORITHM_PROPERTY)\n- .build();\n-\n@Override\npublic KeyProvider create(KeycloakSession session, ComponentModel model) {\nmodel.put(Attributes.KEY_USE, KeyUse.ENC.name());\n@@ -55,7 +50,10 @@ public class GeneratedRsaEncKeyProviderFactory extends AbstractGeneratedRsaKeyPr\n@Override\npublic List<ProviderConfigProperty> getConfigProperties() {\n- return CONFIG_PROPERTIES;\n+ return AbstractGeneratedRsaKeyProviderFactory.rsaKeyConfigurationBuilder()\n+ .property(Attributes.KEY_SIZE_PROPERTY.get())\n+ .property(Attributes.RS_ENC_ALGORITHM_PROPERTY)\n+ .build();\n}\n@Override\n"
},
{
"change_type": "MODIFY",
"old_path": "services/src/main/java/org/keycloak/keys/GeneratedRsaKeyProviderFactory.java",
"new_path": "services/src/main/java/org/keycloak/keys/GeneratedRsaKeyProviderFactory.java",
"diff": "@@ -37,11 +37,6 @@ public class GeneratedRsaKeyProviderFactory extends AbstractGeneratedRsaKeyProvi\nprivate static final String HELP_TEXT = \"Generates RSA signature keys and creates a self-signed certificate\";\n- private static final List<ProviderConfigProperty> CONFIG_PROPERTIES = AbstractGeneratedRsaKeyProviderFactory.rsaKeyConfigurationBuilder()\n- .property(Attributes.KEY_SIZE_PROPERTY)\n- .property(Attributes.RS_ALGORITHM_PROPERTY)\n- .build();\n-\n@Override\npublic KeyProvider create(KeycloakSession session, ComponentModel model) {\nif (model.getConfig().get(Attributes.KEY_USE) == null) {\n@@ -58,7 +53,10 @@ public class GeneratedRsaKeyProviderFactory extends AbstractGeneratedRsaKeyProvi\n@Override\npublic List<ProviderConfigProperty> getConfigProperties() {\n- return CONFIG_PROPERTIES;\n+ return AbstractGeneratedRsaKeyProviderFactory.rsaKeyConfigurationBuilder()\n+ .property(Attributes.KEY_SIZE_PROPERTY.get())\n+ .property(Attributes.RS_ALGORITHM_PROPERTY)\n+ .build();\n}\n@Override\n"
},
{
"change_type": "MODIFY",
"old_path": "testsuite/integration-arquillian/HOW-TO-RUN.md",
"new_path": "testsuite/integration-arquillian/HOW-TO-RUN.md",
"diff": "@@ -992,6 +992,7 @@ For running testsuite with server using BCFIPS approved mode, those additional p\n-Dauth.server.fips.mode=strict \\\n-Dauth.server.supported.keystore.types=BCFKS \\\n-Dauth.server.keystore.type=bcfks\n+-Dauth.server.supported.rsa.key.sizes=2048,4096\n```\nThe log should contain `KeycloakFipsSecurityProvider` mentioning \"Approved mode\". Something like:\n```\n"
},
{
"change_type": "MODIFY",
"old_path": "testsuite/integration-arquillian/tests/base/src/test/java/org/keycloak/testsuite/admin/ServerInfoTest.java",
"new_path": "testsuite/integration-arquillian/tests/base/src/test/java/org/keycloak/testsuite/admin/ServerInfoTest.java",
"diff": "@@ -19,11 +19,17 @@ package org.keycloak.testsuite.admin;\nimport org.junit.Test;\nimport org.keycloak.common.Version;\n+import org.keycloak.keys.Attributes;\n+import org.keycloak.keys.GeneratedRsaKeyProviderFactory;\n+import org.keycloak.keys.KeyProvider;\n+import org.keycloak.representations.idm.ComponentTypeRepresentation;\n+import org.keycloak.representations.idm.ConfigPropertyRepresentation;\nimport org.keycloak.representations.idm.RealmRepresentation;\nimport org.keycloak.representations.info.ProviderRepresentation;\nimport org.keycloak.representations.info.ServerInfoRepresentation;\nimport org.keycloak.testsuite.AbstractKeycloakTest;\nimport org.keycloak.testsuite.Assert;\n+import org.keycloak.testsuite.util.KeystoreUtils;\nimport java.util.List;\nimport java.util.Map;\n@@ -59,11 +65,21 @@ public class ServerInfoTest extends AbstractKeycloakTest {\nassertNotNull(info.getMemoryInfo());\nassertNotNull(info.getSystemInfo());\nassertNotNull(info.getCryptoInfo());\n- String expectedSupportedKeystoreTypes = System.getProperty(\"auth.server.supported.keystore.types\");\n- if (expectedSupportedKeystoreTypes == null) {\n- fail(\"Property 'auth.server.supported.keystore.types' not set\");\n+ Assert.assertNames(info.getCryptoInfo().getSupportedKeystoreTypes(), KeystoreUtils.getSupportedKeystoreTypes());\n+\n+ String expectedSupportedRsaKeySizes = System.getProperty(\"auth.server.supported.rsa.key.sizes\");\n+ if (expectedSupportedRsaKeySizes == null || expectedSupportedRsaKeySizes.trim().isEmpty()) {\n+ fail(\"Property 'auth.server.supported.rsa.key.sizes' not set\");\n}\n- Assert.assertNames(info.getCryptoInfo().getSupportedKeystoreTypes(), expectedSupportedKeystoreTypes.split(\",\"));\n+ ComponentTypeRepresentation rsaGeneratedProviderInfo = info.getComponentTypes().get(KeyProvider.class.getName())\n+ .stream()\n+ .filter(componentType -> GeneratedRsaKeyProviderFactory.ID.equals(componentType.getId()))\n+ .findFirst().orElseThrow(() -> new RuntimeException(\"Not found provider with ID 'rsa-generated'\"));\n+ ConfigPropertyRepresentation keySizeRep = rsaGeneratedProviderInfo.getProperties()\n+ .stream()\n+ .filter(configProp -> Attributes.KEY_SIZE_KEY.equals(configProp.getName()))\n+ .findFirst().orElseThrow(() -> new RuntimeException(\"Not found provider with ID 'rsa-generated'\"));\n+ Assert.assertNames(keySizeRep.getOptions(), expectedSupportedRsaKeySizes.split(\",\"));\nassertEquals(Version.VERSION, info.getSystemInfo().getVersion());\nassertNotNull(info.getSystemInfo().getServerTime());\n"
},
{
"change_type": "MODIFY",
"old_path": "testsuite/integration-arquillian/tests/pom.xml",
"new_path": "testsuite/integration-arquillian/tests/pom.xml",
"diff": "<auth.server.quarkus.cluster.config>local</auth.server.quarkus.cluster.config>\n<auth.server.fips.mode>disabled</auth.server.fips.mode>\n<auth.server.supported.keystore.types>JKS,PKCS12,BCFKS</auth.server.supported.keystore.types>\n+ <auth.server.supported.rsa.key.sizes>1024,2048,4096</auth.server.supported.rsa.key.sizes>\n</properties>\n<build>\n<auth.server.fips.mode>${auth.server.fips.mode}</auth.server.fips.mode>\n<auth.server.fips.keystore.type>${auth.server.fips.keystore.type}</auth.server.fips.keystore.type>\n<auth.server.supported.keystore.types>${auth.server.supported.keystore.types}</auth.server.supported.keystore.types>\n+ <auth.server.supported.rsa.key.sizes>${auth.server.supported.rsa.key.sizes}</auth.server.supported.rsa.key.sizes>\n<!--\n~ Used for Wildfly Elytron 1.13.0.CR3+ RESTEasy client SSL truststore configuration.\n"
}
] | Java | Apache License 2.0 | keycloak/keycloak | Only available RSA key sizes should be shown in admin console
Closes #16437 |
339,269 | 07.12.2022 17:13:05 | -3,600 | 54c34dc75b4bdf9f5dd8de08f7e39e8e475c9aae | 15901 enabled Infinispan metrics | [
{
"change_type": "MODIFY",
"old_path": "quarkus/deployment/src/main/java/org/keycloak/quarkus/deployment/CacheBuildSteps.java",
"new_path": "quarkus/deployment/src/main/java/org/keycloak/quarkus/deployment/CacheBuildSteps.java",
"diff": "@@ -27,7 +27,10 @@ import java.nio.file.Paths;\nimport java.util.stream.Collectors;\nimport javax.enterprise.context.ApplicationScoped;\nimport org.infinispan.commons.util.FileLookupFactory;\n+import org.keycloak.config.MetricsOptions;\nimport org.keycloak.quarkus.runtime.KeycloakRecorder;\n+import org.keycloak.quarkus.runtime.configuration.Configuration;\n+import org.keycloak.quarkus.runtime.configuration.MicroProfileConfigProvider;\nimport org.keycloak.quarkus.runtime.storage.legacy.infinispan.CacheManagerFactory;\nimport io.quarkus.arc.deployment.SyntheticBeanBuildItem;\n@@ -69,7 +72,7 @@ public class CacheBuildSteps {\n.scope(ApplicationScoped.class)\n.unremovable()\n.setRuntimeInit()\n- .runtimeValue(recorder.createCacheInitializer(config, shutdownContext)).done());\n+ .runtimeValue(recorder.createCacheInitializer(config, isMetricsEnabled(), shutdownContext)).done());\n} catch (Exception cause) {\nthrow new RuntimeException(\"Failed to read clustering configuration from [\" + url + \"]\", cause);\n}\n@@ -78,4 +81,7 @@ public class CacheBuildSteps {\n}\n}\n+ private boolean isMetricsEnabled() {\n+ return Configuration.getOptionalBooleanValue(MicroProfileConfigProvider.NS_KEYCLOAK_PREFIX.concat(MetricsOptions.METRICS_ENABLED.getKey())).orElse(false);\n+ }\n}\n"
},
{
"change_type": "MODIFY",
"old_path": "quarkus/runtime/src/main/java/org/keycloak/quarkus/runtime/KeycloakRecorder.java",
"new_path": "quarkus/runtime/src/main/java/org/keycloak/quarkus/runtime/KeycloakRecorder.java",
"diff": "@@ -84,9 +84,9 @@ public class KeycloakRecorder {\nQuarkusKeycloakSessionFactory.setInstance(new QuarkusKeycloakSessionFactory(factories, defaultProviders, preConfiguredProviders, themes, reaugmented));\n}\n- public RuntimeValue<CacheManagerFactory> createCacheInitializer(String config, ShutdownContext shutdownContext) {\n+ public RuntimeValue<CacheManagerFactory> createCacheInitializer(String config, boolean metricsEnabled, ShutdownContext shutdownContext) {\ntry {\n- CacheManagerFactory cacheManagerFactory = new CacheManagerFactory(config);\n+ CacheManagerFactory cacheManagerFactory = new CacheManagerFactory(config, metricsEnabled);\nshutdownContext.addShutdownTask(new Runnable() {\n@Override\n"
},
{
"change_type": "MODIFY",
"old_path": "quarkus/runtime/src/main/java/org/keycloak/quarkus/runtime/storage/legacy/infinispan/CacheManagerFactory.java",
"new_path": "quarkus/runtime/src/main/java/org/keycloak/quarkus/runtime/storage/legacy/infinispan/CacheManagerFactory.java",
"diff": "@@ -22,23 +22,28 @@ import java.util.concurrent.Executors;\nimport java.util.concurrent.Future;\nimport java.util.concurrent.ThreadFactory;\nimport java.util.concurrent.TimeUnit;\n+\n+import io.micrometer.core.instrument.Metrics;\nimport org.infinispan.configuration.parsing.ConfigurationBuilderHolder;\nimport org.infinispan.configuration.parsing.ParserRegistry;\nimport org.infinispan.jboss.marshalling.core.JBossUserMarshaller;\nimport org.infinispan.manager.DefaultCacheManager;\n+import org.infinispan.metrics.config.MicrometerMeterRegisterConfigurationBuilder;\nimport org.jboss.logging.Logger;\nimport org.keycloak.quarkus.runtime.configuration.Configuration;\npublic class CacheManagerFactory {\nprivate String config;\n+ private boolean metricsEnabled;\nprivate DefaultCacheManager cacheManager;\nprivate Future<DefaultCacheManager> cacheManagerFuture;\nprivate ExecutorService executor;\nprivate boolean initialized;\n- public CacheManagerFactory(String config) {\n+ public CacheManagerFactory(String config, boolean metricsEnabled) {\nthis.config = config;\n+ this.metricsEnabled = metricsEnabled;\nthis.executor = createThreadPool();\nthis.cacheManagerFuture = executor.submit(this::startCacheManager);\n}\n@@ -78,6 +83,12 @@ public class CacheManagerFactory {\nconfigureTransportStack(builder);\n}\n+ if (metricsEnabled) {\n+ builder.getNamedConfigurationBuilders().values().stream().forEach(b -> b.statistics().enable());\n+ builder.getGlobalConfigurationBuilder().addModule(MicrometerMeterRegisterConfigurationBuilder.class);\n+ builder.getGlobalConfigurationBuilder().module(MicrometerMeterRegisterConfigurationBuilder.class).meterRegistry(Metrics.globalRegistry);\n+ }\n+\n// For Infinispan 10, we go with the JBoss marshalling.\n// TODO: This should be replaced later with the marshalling recommended by infinispan. Probably protostream.\n// See https://infinispan.org/docs/stable/titles/developing/developing.html#marshalling for the details\n"
},
{
"change_type": "MODIFY",
"old_path": "quarkus/tests/integration/src/test/java/org/keycloak/it/cli/dist/MetricsDistTest.java",
"new_path": "quarkus/tests/integration/src/test/java/org/keycloak/it/cli/dist/MetricsDistTest.java",
"diff": "@@ -25,11 +25,13 @@ import java.util.concurrent.CompletableFuture;\nimport java.util.concurrent.TimeUnit;\nimport org.junit.jupiter.api.Test;\nimport org.keycloak.it.junit5.extension.DistributionTest;\n+import org.keycloak.it.junit5.extension.LegacyStore;\nimport org.keycloak.it.utils.KeycloakDistribution;\nimport io.quarkus.test.junit.main.Launch;\n@DistributionTest(keepAlive =true)\n+@LegacyStore\npublic class MetricsDistTest {\n@Test\n@@ -46,7 +48,8 @@ public class MetricsDistTest {\nvoid testMetricsEndpoint() {\nwhen().get(\"/metrics\").then()\n.statusCode(200)\n- .body(containsString(\"jvm_gc_\"));\n+ .body(containsString(\"jvm_gc_\"))\n+ .body(containsString(\"vendor_cache_manager_keycloak_cache_realms_\"));\n}\n@Test\n"
}
] | Java | Apache License 2.0 | keycloak/keycloak | 15901 enabled Infinispan metrics |
339,468 | 02.12.2022 14:16:10 | -3,600 | 9176308d7919c28c8ec64588e1012af97f6b76f5 | 15812 Make DeclarativeUserProfileProvider MetaData Map thread safe | [
{
"change_type": "MODIFY",
"old_path": "services/src/main/java/org/keycloak/userprofile/DeclarativeUserProfileProvider.java",
"new_path": "services/src/main/java/org/keycloak/userprofile/DeclarativeUserProfileProvider.java",
"diff": "@@ -27,10 +27,10 @@ import java.io.ByteArrayInputStream;\nimport java.io.IOException;\nimport java.util.ArrayList;\nimport java.util.Collections;\n-import java.util.HashMap;\nimport java.util.List;\nimport java.util.Map;\nimport java.util.Set;\n+import java.util.concurrent.ConcurrentHashMap;\nimport java.util.function.Predicate;\nimport java.util.stream.Collectors;\n@@ -156,7 +156,7 @@ public class DeclarativeUserProfileProvider extends AbstractUserProfileProvider<\n// not cached, create a note with cache\nif (metadataMap == null) {\n- metadataMap = new HashMap<>();\n+ metadataMap = new ConcurrentHashMap<>();\nmodel.setNote(PARSED_CONFIG_COMPONENT_KEY, metadataMap);\n}\n"
}
] | Java | Apache License 2.0 | keycloak/keycloak | 15812 Make DeclarativeUserProfileProvider MetaData Map thread safe |
339,179 | 18.01.2023 17:57:52 | -3,600 | eb59fdb772d294d934f7486da9ae59a8a9ca3f34 | Add transaction tests to model tests
Closes: | [
{
"change_type": "MODIFY",
"old_path": "model/map-jpa/src/main/java/org/keycloak/models/map/storage/jpa/JpaMapStorageProviderFactory.java",
"new_path": "model/map-jpa/src/main/java/org/keycloak/models/map/storage/jpa/JpaMapStorageProviderFactory.java",
"diff": "@@ -21,6 +21,7 @@ import static org.keycloak.models.map.storage.jpa.updater.MapJpaUpdaterProvider.\nimport java.sql.Connection;\nimport java.sql.DatabaseMetaData;\nimport java.sql.DriverManager;\n+import java.sql.PreparedStatement;\nimport java.sql.SQLException;\nimport java.util.HashMap;\nimport java.util.LinkedHashMap;\n@@ -165,6 +166,7 @@ public class JpaMapStorageProviderFactory implements\nprivate Config.Scope config;\nprivate final String sessionProviderKey;\nprivate final String sessionTxKey;\n+ private String databaseShortName;\n// Object instances for each single JpaMapStorageProviderFactory instance per model type.\n// Used to synchronize on when validating the model type area.\n@@ -278,7 +280,23 @@ public class JpaMapStorageProviderFactory implements\n}\nprotected EntityManager getEntityManager() {\n- return emf.createEntityManager();\n+ EntityManager em = emf.createEntityManager();\n+\n+ // This is a workaround for Hibernate not supporting javax.persistence.lock.timeout\n+ // config option for Postgresql/CockroachDB - https://hibernate.atlassian.net/browse/HHH-16071\n+ if (\"postgresql\".equals(databaseShortName) || \"cockroachdb\".equals(databaseShortName)) {\n+ Long lockTimeout = config.getLong(\"lockTimeout\");\n+ if (lockTimeout != null) {\n+ em.unwrap(SessionImpl.class)\n+ .doWork(connection -> {\n+ PreparedStatement preparedStatement = connection.prepareStatement(\"SET LOCAL lock_timeout = '\" + lockTimeout + \"';\");\n+ preparedStatement.execute();\n+ });\n+ } else {\n+ logger.warnf(\"Database %s used without lockTimeout option configured. This can result in deadlock where one connection waits for a pessimistic write lock forever.\", databaseShortName);\n+ }\n+ }\n+ return em;\n}\n@Override\n@@ -370,6 +388,11 @@ public class JpaMapStorageProviderFactory implements\nproperties.put(\"hibernate.show_sql\", config.getBoolean(\"showSql\", false));\nproperties.put(\"hibernate.format_sql\", config.getBoolean(\"formatSql\", true));\nproperties.put(\"hibernate.dialect\", config.get(\"driverDialect\"));\n+ Integer lockTimeout = config.getInt(\"lockTimeout\");\n+ if (lockTimeout != null) {\n+ // This property does not work for PostgreSQL/CockroachDB - https://hibernate.atlassian.net/browse/HHH-16071\n+ properties.put(\"javax.persistence.lock.timeout\", lockTimeout);\n+ }\nlogger.trace(\"Creating EntityManagerFactory\");\nParsedPersistenceXmlDescriptor descriptor = PersistenceXmlParser.locateIndividualPersistenceUnit(\n@@ -416,6 +439,7 @@ public class JpaMapStorageProviderFactory implements\nMapJpaUpdaterProvider updater = session.getProvider(MapJpaUpdaterProvider.class);\nMapJpaUpdaterProvider.Status status = updater.validate(modelType, connection, config.get(\"schema\"));\n+ databaseShortName = updater.getDatabaseShortName();\nif (!status.equals(VALID)) {\nupdate(modelType, connection, session);\n"
},
{
"change_type": "MODIFY",
"old_path": "model/map-jpa/src/main/java/org/keycloak/models/map/storage/jpa/liquibase/updater/MapJpaLiquibaseUpdaterProvider.java",
"new_path": "model/map-jpa/src/main/java/org/keycloak/models/map/storage/jpa/liquibase/updater/MapJpaLiquibaseUpdaterProvider.java",
"diff": "@@ -45,6 +45,7 @@ public class MapJpaLiquibaseUpdaterProvider implements MapJpaUpdaterProvider {\nprivate static final Logger logger = Logger.getLogger(MapJpaLiquibaseUpdaterProvider.class);\nprivate final KeycloakSession session;\n+ private String databaseShortName;\npublic MapJpaLiquibaseUpdaterProvider(KeycloakSession session) {\nthis.session = session;\n@@ -187,6 +188,7 @@ public class MapJpaLiquibaseUpdaterProvider implements MapJpaUpdaterProvider {\ntry (Database database = DatabaseFactory.getInstance().findCorrectDatabaseImplementation(new JdbcConnectionFromPool(connection.unwrap(Connection.class)))) {\n// if the database is cockroachdb, use the aggregate changelog (see GHI #11230).\nString changelog = database instanceof CockroachDatabase ? \"META-INF/jpa-aggregate-changelog.xml\" : \"META-INF/jpa-\" + modelName + \"-changelog.xml\";\n+ databaseShortName = database.getShortName();\nreturn liquibaseProvider.getLiquibaseForCustomUpdate(connection, defaultSchema, changelog, this.getClass().getClassLoader(), \"databasechangelog\");\n} catch (SQLException e) {\nthrow new LiquibaseException(e);\n@@ -197,4 +199,8 @@ public class MapJpaLiquibaseUpdaterProvider implements MapJpaUpdaterProvider {\npublic void close() {\n}\n+ @Override\n+ public String getDatabaseShortName() {\n+ return databaseShortName;\n+ }\n}\n"
},
{
"change_type": "MODIFY",
"old_path": "model/map-jpa/src/main/java/org/keycloak/models/map/storage/jpa/updater/MapJpaUpdaterProvider.java",
"new_path": "model/map-jpa/src/main/java/org/keycloak/models/map/storage/jpa/updater/MapJpaUpdaterProvider.java",
"diff": "@@ -68,4 +68,8 @@ public interface MapJpaUpdaterProvider extends Provider {\n*/\nvoid export(Class<?> modelType, Connection connection, String defaultSchema, File file);\n+ /**\n+ * Returns an all-lower-case short name of the used database.\n+ */\n+ String getDatabaseShortName();\n}\n"
},
{
"change_type": "MODIFY",
"old_path": "testsuite/model/src/test/java/org/keycloak/testsuite/model/parameters/JpaMapStorage.java",
"new_path": "testsuite/model/src/test/java/org/keycloak/testsuite/model/parameters/JpaMapStorage.java",
"diff": "@@ -95,7 +95,8 @@ public class JpaMapStorage extends KeycloakModelParameters {\n.config(\"user\", POSTGRES_DB_USER)\n.config(\"password\", POSTGRES_DB_PASSWORD)\n.config(\"driver\", \"org.postgresql.Driver\")\n- .config(\"driverDialect\", \"org.keycloak.models.map.storage.jpa.hibernate.dialect.JsonbPostgreSQL95Dialect\");\n+ .config(\"driverDialect\", \"org.keycloak.models.map.storage.jpa.hibernate.dialect.JsonbPostgreSQL95Dialect\")\n+ .config(\"lockTimeout\", \"1000\");\ncf.spi(AuthenticationSessionSpi.PROVIDER_ID).provider(MapRootAuthenticationSessionProviderFactory.PROVIDER_ID) .config(STORAGE_CONFIG, JpaMapStorageProviderFactory.PROVIDER_ID)\n.spi(\"client\").provider(MapClientProviderFactory.PROVIDER_ID) .config(STORAGE_CONFIG, JpaMapStorageProviderFactory.PROVIDER_ID)\n"
},
{
"change_type": "MODIFY",
"old_path": "testsuite/model/src/test/java/org/keycloak/testsuite/model/parameters/JpaMapStorageCockroachdb.java",
"new_path": "testsuite/model/src/test/java/org/keycloak/testsuite/model/parameters/JpaMapStorageCockroachdb.java",
"diff": "@@ -96,7 +96,8 @@ public class JpaMapStorageCockroachdb extends KeycloakModelParameters {\n.config(\"user\", COCKROACHDB_DB_USER)\n.config(\"password\", COCKROACHDB_DB_PASSWORD)\n.config(\"driver\", \"org.postgresql.Driver\")\n- .config(\"driverDialect\", \"org.keycloak.models.map.storage.jpa.hibernate.dialect.JsonbPostgreSQL95Dialect\");\n+ .config(\"driverDialect\", \"org.keycloak.models.map.storage.jpa.hibernate.dialect.JsonbPostgreSQL95Dialect\")\n+ .config(\"lockTimeout\", \"1000\");\ncf.spi(AuthenticationSessionSpi.PROVIDER_ID).provider(MapRootAuthenticationSessionProviderFactory.PROVIDER_ID) .config(STORAGE_CONFIG, JpaMapStorageProviderFactory.PROVIDER_ID)\n.spi(\"client\").provider(MapClientProviderFactory.PROVIDER_ID) .config(STORAGE_CONFIG, JpaMapStorageProviderFactory.PROVIDER_ID)\n"
},
{
"change_type": "ADD",
"old_path": null,
"new_path": "testsuite/model/src/test/java/org/keycloak/testsuite/model/transaction/StorageTransactionTest.java",
"diff": "+/*\n+ * Copyright 2023 Red Hat, Inc. and/or its affiliates\n+ * and other contributors as indicated by the @author tags.\n+ *\n+ * Licensed under the Apache License, Version 2.0 (the \"License\");\n+ * you may not use this file except in compliance with the License.\n+ * You may obtain a copy of the License at\n+ *\n+ * http://www.apache.org/licenses/LICENSE-2.0\n+ *\n+ * Unless required by applicable law or agreed to in writing, software\n+ * distributed under the License is distributed on an \"AS IS\" BASIS,\n+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n+ * See the License for the specific language governing permissions and\n+ * limitations under the License.\n+ */\n+\n+package org.keycloak.testsuite.model.transaction;\n+\n+import org.junit.Test;\n+import org.keycloak.models.Constants;\n+import org.keycloak.models.KeycloakSession;\n+import org.keycloak.models.ModelException;\n+import org.keycloak.models.RealmModel;\n+import org.keycloak.models.RealmProvider;\n+import org.keycloak.models.map.storage.MapStorageProvider;\n+import org.keycloak.models.map.storage.jpa.JpaMapStorageProviderFactory;\n+import org.keycloak.testsuite.model.KeycloakModelTest;\n+import org.keycloak.testsuite.model.RequireProvider;\n+import org.keycloak.testsuite.model.util.TransactionController;\n+import org.keycloak.utils.LockObjectsForModification;\n+\n+import javax.persistence.OptimisticLockException;\n+import javax.persistence.PessimisticLockException;\n+\n+import static org.hamcrest.CoreMatchers.allOf;\n+import static org.hamcrest.CoreMatchers.equalTo;\n+import static org.hamcrest.CoreMatchers.instanceOf;\n+import static org.hamcrest.MatcherAssert.assertThat;\n+import static org.junit.internal.matchers.ThrowableCauseMatcher.hasCause;\n+import static org.keycloak.testsuite.model.util.KeycloakAssertions.assertException;\n+\n+@RequireProvider(RealmProvider.class)\n+public class StorageTransactionTest extends KeycloakModelTest {\n+\n+ private String realmId;\n+\n+ @Override\n+ protected void createEnvironment(KeycloakSession s) {\n+ RealmModel r = s.realms().createRealm(\"1\");\n+ r.setDefaultRole(s.roles().addRealmRole(r, Constants.DEFAULT_ROLES_ROLE_PREFIX + \"-\" + r.getName()));\n+ r.setAttribute(\"k1\", \"v1\");\n+ realmId = r.getId();\n+ }\n+\n+ @Override\n+ protected void cleanEnvironment(KeycloakSession s) {\n+ s.realms().removeRealm(realmId);\n+ }\n+\n+ @Override\n+ protected boolean isUseSameKeycloakSessionFactoryForAllThreads() {\n+ return true;\n+ }\n+\n+ @Test\n+ public void testTwoTransactionsSequentially() throws Exception {\n+ TransactionController tx1 = new TransactionController(getFactory());\n+ TransactionController tx2 = new TransactionController(getFactory());\n+\n+ tx1.begin();\n+ assertThat(\n+ tx1.runStep(session -> {\n+ session.realms().getRealm(realmId).setAttribute(\"k2\", \"v1\");\n+ return session.realms().getRealm(realmId).getAttribute(\"k2\");\n+ }), equalTo(\"v1\"));\n+ tx1.commit();\n+\n+ tx2.begin();\n+ assertThat(\n+ tx2.runStep(session -> session.realms().getRealm(realmId).getAttribute(\"k2\")),\n+ equalTo(\"v1\"));\n+ tx2.commit();\n+\n+ }\n+\n+ @Test\n+ public void testRepeatableRead() {\n+ TransactionController tx1 = new TransactionController(getFactory());\n+ TransactionController tx2 = new TransactionController(getFactory());\n+ TransactionController tx3 = new TransactionController(getFactory());\n+\n+ tx1.begin();\n+ tx2.begin();\n+ tx3.begin();\n+\n+ // Read original value in tx1\n+ assertThat(\n+ tx1.runStep(session -> session.realms().getRealm(realmId).getAttribute(\"k1\")),\n+ equalTo(\"v1\"));\n+\n+ // change value to new in tx2\n+ tx2.runStep(session -> {\n+ session.realms().getRealm(realmId).setAttribute(\"k1\", \"v2\");\n+ return null;\n+ });\n+ tx2.commit();\n+\n+ // tx1 should still return the value that already read\n+ assertThat(\n+ tx1.runStep(session -> session.realms().getRealm(realmId).getAttribute(\"k1\")),\n+ equalTo(\"v1\"));\n+\n+ // tx3 should return the new value\n+ assertThat(\n+ tx3.runStep(session -> session.realms().getRealm(realmId).getAttribute(\"k1\")),\n+ equalTo(\"v2\"));\n+ tx1.commit();\n+ tx3.commit();\n+ }\n+\n+ @Test\n+ // LockObjectForModification is currently used only in map-jpa\n+ @RequireProvider(value = MapStorageProvider.class, only = JpaMapStorageProviderFactory.PROVIDER_ID)\n+ public void testLockObjectForModification() {\n+ TransactionController tx1 = new TransactionController(getFactory());\n+ TransactionController tx2 = new TransactionController(getFactory());\n+ TransactionController tx3 = new TransactionController(getFactory());\n+\n+ tx1.begin();\n+ tx2.begin();\n+\n+ // tx1 acquires lock\n+ tx1.runStep(session -> LockObjectsForModification.lockRealmsForModification(session, () -> session.realms().getRealm(realmId)));\n+\n+ // tx2 should fail as tx1 locked the realm\n+ assertException(() -> tx2.runStep(session -> LockObjectsForModification.lockRealmsForModification(session, () -> session.realms().getRealm(realmId))),\n+ allOf(instanceOf(ModelException.class),\n+ hasCause(instanceOf(PessimisticLockException.class))));\n+\n+ // end both transactions\n+ tx2.rollback();\n+ tx1.commit();\n+\n+ // start new transaction and read again, it should be successful\n+ tx3.begin();\n+ tx3.runStep(session -> LockObjectsForModification.lockRealmsForModification(session, () -> session.realms().getRealm(realmId)));\n+ tx3.commit();\n+ }\n+\n+ @Test\n+ // Optimistic locking works only with map-jpa\n+ @RequireProvider(value = MapStorageProvider.class, only = JpaMapStorageProviderFactory.PROVIDER_ID)\n+ public void testOptimisticLockingException() {\n+ withRealm(realmId, (session, realm) -> {\n+ realm.setDisplayName(\"displayName1\");\n+ return null;\n+ });\n+\n+ TransactionController tx1 = new TransactionController(getFactory());\n+ TransactionController tx2 = new TransactionController(getFactory());\n+\n+ // tx1 acquires lock\n+ tx1.begin();\n+ tx2.begin();\n+\n+ // both transactions touch the same entity\n+ tx1.runStep(session -> {\n+ session.realms().getRealm(realmId).setDisplayName(\"displayName2\");\n+ return null;\n+ });\n+ tx2.runStep(session -> {\n+ session.realms().getRealm(realmId).setDisplayName(\"displayName3\");\n+ return null;\n+ });\n+\n+ // tx1 transaction should be successful\n+ tx1.commit();\n+\n+ // tx2 should fail as tx1 already changed the value\n+ assertException(tx2::commit,\n+ allOf(instanceOf(ModelException.class),\n+ hasCause(instanceOf(OptimisticLockException.class))));\n+ }\n+}\n"
},
{
"change_type": "ADD",
"old_path": null,
"new_path": "testsuite/model/src/test/java/org/keycloak/testsuite/model/util/KeycloakAssertions.java",
"diff": "+/*\n+ * Copyright 2023 Red Hat, Inc. and/or its affiliates\n+ * and other contributors as indicated by the @author tags.\n+ *\n+ * Licensed under the Apache License, Version 2.0 (the \"License\");\n+ * you may not use this file except in compliance with the License.\n+ * You may obtain a copy of the License at\n+ *\n+ * http://www.apache.org/licenses/LICENSE-2.0\n+ *\n+ * Unless required by applicable law or agreed to in writing, software\n+ * distributed under the License is distributed on an \"AS IS\" BASIS,\n+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n+ * See the License for the specific language governing permissions and\n+ * limitations under the License.\n+ */\n+\n+package org.keycloak.testsuite.model.util;\n+\n+import org.hamcrest.Matcher;\n+\n+import static org.hamcrest.CoreMatchers.allOf;\n+import static org.hamcrest.CoreMatchers.notNullValue;\n+import static org.hamcrest.MatcherAssert.assertThat;\n+\n+public class KeycloakAssertions {\n+\n+ /**\n+ * Runs {@code task} and checks whether the execution resulted in\n+ * an exception that matches {@code matcher}. The method fails also\n+ * when no exception is thrown.\n+ *\n+ * @param task task\n+ * @param matcher matcher that the exception should match\n+ */\n+ public static void assertException(Runnable task, Matcher<? super Throwable> matcher) {\n+ Throwable ex = catchException(task);\n+ assertThat(ex, allOf(notNullValue(), matcher));\n+ }\n+\n+ /**\n+ * Runs the {@code task} and returns any throwable that is thrown.\n+ * If not exception is thrown, the method returns {@code null}\n+ *\n+ * @param task task\n+ */\n+ public static Throwable catchException(Runnable task) {\n+ try {\n+ task.run();\n+ return null;\n+ } catch (Throwable ex) {\n+ return ex;\n+ }\n+ }\n+}\n"
},
{
"change_type": "ADD",
"old_path": null,
"new_path": "testsuite/model/src/test/java/org/keycloak/testsuite/model/util/TransactionController.java",
"diff": "+/*\n+ * Copyright 2023 Red Hat, Inc. and/or its affiliates\n+ * and other contributors as indicated by the @author tags.\n+ *\n+ * Licensed under the Apache License, Version 2.0 (the \"License\");\n+ * you may not use this file except in compliance with the License.\n+ * You may obtain a copy of the License at\n+ *\n+ * http://www.apache.org/licenses/LICENSE-2.0\n+ *\n+ * Unless required by applicable law or agreed to in writing, software\n+ * distributed under the License is distributed on an \"AS IS\" BASIS,\n+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n+ * See the License for the specific language governing permissions and\n+ * limitations under the License.\n+ */\n+\n+package org.keycloak.testsuite.model.util;\n+\n+import org.keycloak.models.KeycloakSession;\n+import org.keycloak.models.KeycloakSessionFactory;\n+import org.keycloak.models.KeycloakTransactionManager;\n+\n+import java.util.function.Function;\n+\n+public class TransactionController {\n+ private final KeycloakSession session;\n+\n+ public TransactionController(KeycloakSessionFactory sessionFactory) {\n+ session = sessionFactory.create();\n+ }\n+\n+ public void begin() {\n+ getTransactionManager().begin();\n+ }\n+\n+ public void commit() {\n+ getTransactionManager().commit();\n+ }\n+\n+ public void rollback() {\n+ getTransactionManager().rollback();\n+ }\n+\n+ public <R> R runStep(Function<KeycloakSession, R> task) {\n+ return task.apply(session);\n+ }\n+\n+ private KeycloakTransactionManager getTransactionManager() {\n+ return session.getTransactionManager();\n+ }\n+}\n"
}
] | Java | Apache License 2.0 | keycloak/keycloak | Add transaction tests to model tests
Closes: #15890 |
339,274 | 27.01.2023 10:58:59 | -3,600 | f067c9aa26a649c85232748455c8f8aa7517199b | Fix label for IdpReviewProfileAuthenticatorFactory
Closes | [
{
"change_type": "MODIFY",
"old_path": "services/src/main/java/org/keycloak/authentication/authenticators/broker/IdpReviewProfileAuthenticatorFactory.java",
"new_path": "services/src/main/java/org/keycloak/authentication/authenticators/broker/IdpReviewProfileAuthenticatorFactory.java",
"diff": "@@ -101,16 +101,12 @@ public class IdpReviewProfileAuthenticatorFactory implements AuthenticatorFactor\nProviderConfigProperty property;\nproperty = new ProviderConfigProperty();\nproperty.setName(UPDATE_PROFILE_ON_FIRST_LOGIN);\n- property.setLabel(\"{{:: 'update-profile-on-first-login' | translate}}\");\n+ property.setLabel(\"updateProfileOnFirstLogin\");\nproperty.setType(ProviderConfigProperty.LIST_TYPE);\nList<String> updateProfileValues = Arrays.asList(IdentityProviderRepresentation.UPFLM_ON, IdentityProviderRepresentation.UPFLM_MISSING, IdentityProviderRepresentation.UPFLM_OFF);\nproperty.setOptions(updateProfileValues);\nproperty.setDefaultValue(IdentityProviderRepresentation.UPFLM_MISSING);\n- property.setHelpText(\"Define conditions under which a user has to review and update his profile after first-time login. Value 'On' means that\"\n- + \" page for reviewing profile will be displayed and user can review and update his profile. Value 'off' means that page won't be displayed.\"\n- + \" Value 'missing' means that page is displayed just when some required attribute is missing (wasn't downloaded from identity provider). Value 'missing' is the default one.\"\n- + \" WARN: In case that user clicks 'Review profile info' on link duplications page, the update page will be always displayed. You would need to disable this authenticator to never display the page.\");\n-\n+ property.setHelpText(\"updateProfileOnFirstLoginTooltip\");\nconfigProperties.add(property);\n}\n"
},
{
"change_type": "MODIFY",
"old_path": "themes/src/main/resources-community/theme/base/admin/messages/admin-messages_ca.properties",
"new_path": "themes/src/main/resources-community/theme/base/admin/messages/admin-messages_ca.properties",
"diff": "@@ -395,11 +395,11 @@ store-tokens=Emmagatzemar tokens\nidentity-provider.store-tokens.tooltip=Habilitar/deshabilitar si els tokens han de ser emmagatzemats despr\\u00E9s d''autenticar als usuaris.\nstored-tokens-readable=Tokens emmagatzemats llegibles\nidentity-provider.stored-tokens-readable.tooltip=Habilitar/deshabilitar si els nous usuaris poden llegir els tokens emmagatzemats. Aix\\u00F2 assigna el rol ''broker.read-token''.\n-update-profile-on-first-login=Actualitzar perfil al primer inici de sessi\\u00F3\n+updateProfileOnFirstLogin=Actualitzar perfil al primer inici de sessi\\u00F3\non=Activat\non-missing-info=Si falta informaci\\u00F3\noff=Desactivat\n-update-profile-on-first-login.tooltip=Defineix condicions sota les quals un usuari ha de actualitzar el seu perfil durant el primer inici de sessi\\u00F3.\n+updateProfileOnFirstLoginTooltip=Defineix condicions sota les quals un usuari ha de actualitzar el seu perfil durant el primer inici de sessi\\u00F3.\ntrust-email=Confiar en l''email\ntrust-email.tooltip=Si est\\u00E0 habilitat, l''email rebut d''aquest prove\\u00EFdor no es verificar\\u00E0 encara que la verificaci\\u00F3 estigui habilitada per al domini.\ngui-order.tooltip=N\\u00FAmero que defineix l''ordre del prove\\u00EFdor en la interf\\u00EDcie gr\\u00E0fica (GUI) (ex. a la p\\u00E0gina d''inici de sessi\\u00F3)\n"
},
{
"change_type": "MODIFY",
"old_path": "themes/src/main/resources-community/theme/base/admin/messages/admin-messages_es.properties",
"new_path": "themes/src/main/resources-community/theme/base/admin/messages/admin-messages_es.properties",
"diff": "@@ -396,11 +396,11 @@ store-tokens=Almacenar tokens\nidentity-provider.store-tokens.tooltip=Habilitar/deshabilitar si los tokens deben ser almacenados despu\\u00E9s de autenticar a los usuarios.\nstored-tokens-readable=Tokens almacenados legibles\nidentity-provider.stored-tokens-readable.tooltip=Habilitar/deshabilitar si los nuevos usuarios pueden leer los tokens almacenados. Esto asigna el rol ''broker.read-token''.\n-update-profile-on-first-login=Actualizar perfil en el primer inicio de sesi\\u00F3n\n+updateProfileOnFirstLogin=Actualizar perfil en el primer inicio de sesi\\u00F3n\non=Activado\non-missing-info=Si falta informaci\\u00F3n\noff=Desactivado\n-update-profile-on-first-login.tooltip=Define condiciones bajo las cuales un usuario tiene que actualizar su perfil durante el primer inicio de sesi\\u00F3n.\n+updateProfileOnFirstLoginTooltip=Define condiciones bajo las cuales un usuario tiene que actualizar su perfil durante el primer inicio de sesi\\u00F3n.\ntrust-email=Confiar en el email\ntrust-email.tooltip=Si est\\u00E1 habilitado, el email recibido de este proveedor no se verificar\\u00E1 aunque la verificaci\\u00F3n est\\u00E9 habilitada para el dominio.\ngui-order.tooltip=N\\u00FAmero que define el orden del proveedor en la interfaz gr\\u00E1fica (GUI) (ej. en la p\\u00E1gina de inicio de sesi\\u00F3n)\n"
},
{
"change_type": "MODIFY",
"old_path": "themes/src/main/resources-community/theme/base/admin/messages/admin-messages_no.properties",
"new_path": "themes/src/main/resources-community/theme/base/admin/messages/admin-messages_no.properties",
"diff": "@@ -428,11 +428,11 @@ store-tokens=Lagre Tokens\nidentity-provider.store-tokens.tooltip=Aktiver/deaktiver hvis tokens m\\u00E5 bli lagret etter at brukere har blitt autentisert.\nstored-tokens-readable=Lagrede lesbare tokens\nidentity-provider.stored-tokens-readable.tooltip=Aktiver/deaktiver hvis nye brukere kan lese lagrede tokens. Dette tildeles broker.read-token rollen.\n-update-profile-on-first-login=Oppdater profil ved f\\u00F8rste innlogging\n+updateProfileOnFirstLogin=Oppdater profil ved f\\u00F8rste innlogging\non=P\\u00E5\non-missing-info=Ved manglende informasjon\noff=Av\n-update-profile-on-first-login.tooltip=Definer vilk\\u00E5rene en bruker m\\u00E5 oppfylle for \\u00E5 oppdatere sin profil ved f\\u00F8rste innlogging.\n+updateProfileOnFirstLoginTooltip=Definer vilk\\u00E5rene en bruker m\\u00E5 oppfylle for \\u00E5 oppdatere sin profil ved f\\u00F8rste innlogging.\ntrust-email=Stol p\\u00E5 e-post\ntrust-email.tooltip=Hvis aktivert vil ikke e-post levert av denne leverand\\u00F8ren bli verifisert selv om verifisering er aktivert for sikkerhetsdomenet.\ngui-order.tooltip=Antall som angir rekkef\\u00F8lgen av leverand\\u00F8rer i brukergrensesnittet (For eksempel p\\u00E5 innloggingssiden).\n"
}
] | Java | Apache License 2.0 | keycloak/keycloak | Fix label for IdpReviewProfileAuthenticatorFactory (#15293)
Closes #16658 |
339,551 | 27.01.2023 13:29:42 | -10,800 | a4c78a05d2ba12ff9b21625502bac9f75a6de1c4 | Descriptor file release
Closes | [
{
"change_type": "MODIFY",
"old_path": "common/src/test/java/org/keycloak/common/ProfileTest.java",
"new_path": "common/src/test/java/org/keycloak/common/ProfileTest.java",
"diff": "@@ -13,6 +13,7 @@ import org.keycloak.common.profile.PropertiesProfileConfigResolver;\nimport java.io.FileOutputStream;\nimport java.io.IOException;\n+import java.io.OutputStream;\nimport java.nio.file.Files;\nimport java.nio.file.Path;\nimport java.util.Arrays;\n@@ -112,7 +113,9 @@ public class ProfileTest {\nPath profileProperties = tempDirectory.resolve(\"profile.properties\");\n- properties.store(new FileOutputStream(profileProperties.toFile()), \"\");\n+ try(OutputStream out = Files.newOutputStream(profileProperties.toFile().toPath())) {\n+ properties.store(out, \"\");\n+ }\nProfile.configure(new PropertiesFileProfileConfigResolver());\n@@ -169,7 +172,9 @@ public class ProfileTest {\nPath profileProperties = tempDirectory.resolve(\"profile.properties\");\n- properties.store(new FileOutputStream(profileProperties.toFile()), \"\");\n+ try(OutputStream out = Files.newOutputStream(profileProperties.toFile().toPath())) {\n+ properties.store(out, \"\");\n+ }\nProfile.configure(new PropertiesFileProfileConfigResolver());\n"
}
] | Java | Apache License 2.0 | keycloak/keycloak | Descriptor file release (#16659)
Closes #16657
Co-authored-by: Khvatov-Alexey <Khvatov-Alexey> |
339,465 | 27.01.2023 15:30:39 | -3,600 | 7f017f540ed33b1690aff0a1dd17f0d927b68eb4 | BCFIPS approved mode: Some tests failing due the short secret for client-secret-jwt client authentication
Closes | [
{
"change_type": "MODIFY",
"old_path": "core/src/test/java/org/keycloak/jose/HmacTest.java",
"new_path": "core/src/test/java/org/keycloak/jose/HmacTest.java",
"diff": "package org.keycloak.jose;\n+import org.jboss.logging.Logger;\nimport org.junit.Assert;\nimport org.junit.ClassRule;\nimport org.junit.Test;\n+import org.keycloak.common.util.BouncyIntegration;\nimport org.keycloak.jose.jws.JWSBuilder;\nimport org.keycloak.jose.jws.JWSInput;\nimport org.keycloak.jose.jws.crypto.HMACProvider;\nimport org.keycloak.rule.CryptoInitRule;\nimport javax.crypto.SecretKey;\n+import javax.crypto.SecretKeyFactory;\nimport javax.crypto.spec.SecretKeySpec;\n+\nimport java.util.UUID;\n/**\n@@ -35,17 +39,29 @@ import java.util.UUID;\n*/\npublic abstract class HmacTest {\n+ private final Logger logger = Logger.getLogger(getClass().getName());\n+\n@ClassRule\npublic static CryptoInitRule cryptoInitRule = new CryptoInitRule();\n@Test\n- public void testHmacSignatures() throws Exception {\n- SecretKey secret = new SecretKeySpec(UUID.randomUUID().toString().getBytes(), \"HmacSHA256\");\n+ public void testHmacSignaturesWithRandomSecretKey() throws Exception {\n+ SecretKey secretKey = new SecretKeySpec(UUID.randomUUID().toString().getBytes(), \"HmacSHA256\");\n+ testHMACSignAndVerify(secretKey, \"testHmacSignaturesWithRandomSecretKey\");\n+ }\n+\n+ @Test\n+ public void testHmacSignaturesWithShortSecretKey() throws Exception {\n+ SecretKey secretKey = new SecretKeySpec(\"secret\".getBytes(), \"HmacSHA256\");\n+ testHMACSignAndVerify(secretKey, \"testHmacSignaturesWithShortSecretKey\");\n+ }\n+\n+ protected void testHMACSignAndVerify(SecretKey secretKey, String test) throws Exception {\nString encoded = new JWSBuilder().content(\"12345678901234567890\".getBytes())\n- .hmac256(secret);\n- System.out.println(\"length: \" + encoded.length());\n+ .hmac256(secretKey);\n+ logger.infof(\"%s: Length of encoded content: %d, Length of secret key: %d\", test, encoded.length(), secretKey.getEncoded().length);\nJWSInput input = new JWSInput(encoded);\n- Assert.assertTrue(HMACProvider.verify(input, secret));\n+ Assert.assertTrue(HMACProvider.verify(input, secretKey));\n}\n}\n"
},
{
"change_type": "MODIFY",
"old_path": "crypto/elytron/src/test/java/org/keycloak/crypto/elytron/test/ElytronHmacTest.java",
"new_path": "crypto/elytron/src/test/java/org/keycloak/crypto/elytron/test/ElytronHmacTest.java",
"diff": "@@ -42,13 +42,9 @@ public class ElytronHmacTest extends HmacTest {\nSecureRandom random = isWindows() ? SecureRandom.getInstance(\"Windows-PRNG\") : SecureRandom.getInstance(\"NativePRNG\");\nrandom.setSeed(UUID.randomUUID().toString().getBytes());\nkeygen.init(random);\n- SecretKey secret = keygen.generateKey();\n+ SecretKey secretKey = keygen.generateKey();\n- String encoded = new JWSBuilder().content(\"12345678901234567890\".getBytes())\n- .hmac256(secret);\n- System.out.println(\"length: \" + encoded.length());\n- JWSInput input = new JWSInput(encoded);\n- Assert.assertTrue(HMACProvider.verify(input, secret));\n+ testHMACSignAndVerify(secretKey, \"testHmacSignaturesUsingKeyGen\");\n}\nprivate boolean isWindows(){\nreturn System.getProperty(\"os.name\").startsWith(\"Windows\");\n"
},
{
"change_type": "MODIFY",
"old_path": "crypto/fips1402/src/test/java/org/keycloak/crypto/fips/test/FIPS1402HmacTest.java",
"new_path": "crypto/fips1402/src/test/java/org/keycloak/crypto/fips/test/FIPS1402HmacTest.java",
"diff": "package org.keycloak.crypto.fips.test;\n+\nimport java.util.UUID;\nimport javax.crypto.SecretKey;\nimport javax.crypto.SecretKeyFactory;\nimport javax.crypto.spec.SecretKeySpec;\n-import org.junit.Assert;\n+import org.bouncycastle.crypto.CryptoServicesRegistrar;\nimport org.junit.Assume;\nimport org.junit.Before;\nimport org.junit.Test;\nimport org.keycloak.common.util.BouncyIntegration;\nimport org.keycloak.common.util.Environment;\nimport org.keycloak.jose.HmacTest;\n-import org.keycloak.jose.jws.JWSBuilder;\n-import org.keycloak.jose.jws.JWSInput;\n-import org.keycloak.jose.jws.crypto.HMACProvider;\n/**\n@@ -31,15 +29,16 @@ public class FIPS1402HmacTest extends HmacTest {\n}\n@Test\n- public void testHmacSignaturesFIPS() throws Exception {\n- //\n-\n+ public void testHmacSignaturesWithRandomSecretKeyCreatedByFactory() throws Exception {\nSecretKeyFactory skFact = SecretKeyFactory.getInstance(\"HmacSHA256\", BouncyIntegration.PROVIDER );\n- SecretKey secret = skFact.generateSecret(new SecretKeySpec(UUID.randomUUID().toString().getBytes(), \"HmacSHA256\"));\n- String encoded = new JWSBuilder().content(\"12345678901234567890\".getBytes())\n- .hmac256(secret);\n- System.out.println(\"length: \" + encoded.length());\n- JWSInput input = new JWSInput(encoded);\n- Assert.assertTrue(HMACProvider.verify(input, secret));\n+ SecretKey secretKey = skFact.generateSecret(new SecretKeySpec(UUID.randomUUID().toString().getBytes(), \"HmacSHA256\"));\n+ testHMACSignAndVerify(secretKey, \"testHmacSignaturesWithRandomSecretKeyCreatedByFactory\");\n+ }\n+\n+ @Override\n+ public void testHmacSignaturesWithShortSecretKey() throws Exception {\n+ // With BCFIPS approved mode, secret key used for HmacSHA256 must be at least 112 bits long (14 characters). Short key won't work\n+ Assume.assumeFalse(CryptoServicesRegistrar.isInApprovedOnlyMode());\n+ super.testHmacSignaturesWithShortSecretKey();\n}\n}\n"
},
{
"change_type": "MODIFY",
"old_path": "docs/fips.md",
"new_path": "docs/fips.md",
"diff": "@@ -89,7 +89,10 @@ which means even stricter security requirements on cryptography and security alg\n```\n--spi-password-hashing-pbkdf2-sha256-max-padding-length=14\n```\n-- RSA keys of 1024 bits don't work (2048 is the minimum)\n+- RSA keys of 1024 bits don't work (2048 is the minimum). This applies for keys used by Keycloak realm itself (Realm keys from the `Keys` tab), but also client keys and IDP keys\n+- HMAC SHA-XXX keys must be at least 112 bits (or 14 characters long). For example if you use OIDC clients with the client\n+ authentication `Signed Jwt with Client Secret` (aka `client-secret-jwt`), then your client secrets should be at least 14 characters long.\n+ But anyway, it is recommended to use client secrets generated by Keycloak server, which always matches this requirement.\n- Also `jks` and `pkcs12` keystores/trustores are not supported.\nWhen starting server at startup, you can check that startup log contains `KC` provider contains KC provider with the note about `Approved Mode` like this:\n"
},
{
"change_type": "MODIFY",
"old_path": "testsuite/integration-arquillian/tests/base/src/test/java/org/keycloak/testsuite/broker/KcOidcBrokerClientSecretJwtTest.java",
"new_path": "testsuite/integration-arquillian/tests/base/src/test/java/org/keycloak/testsuite/broker/KcOidcBrokerClientSecretJwtTest.java",
"diff": "package org.keycloak.testsuite.broker;\n-import static org.keycloak.testsuite.broker.BrokerTestConstants.CLIENT_SECRET;\nimport static org.keycloak.testsuite.broker.BrokerTestConstants.IDP_OIDC_ALIAS;\nimport static org.keycloak.testsuite.broker.BrokerTestConstants.IDP_OIDC_PROVIDER_ID;\nimport static org.keycloak.testsuite.broker.BrokerTestTools.createIdentityProvider;\n@@ -16,6 +15,9 @@ import org.keycloak.representations.idm.IdentityProviderRepresentation;\npublic class KcOidcBrokerClientSecretJwtTest extends AbstractBrokerTest {\n+ // BCFIPS approved mode requires at least 112 bits (14 characters) long SecretKey for \"client-secret-jwt\" authentication\n+ private static final String CLIENT_SECRET = \"atleast-14chars-password\";\n+\n@Override\nprotected BrokerConfiguration getBrokerConfiguration() {\nreturn new KcOidcBrokerConfigurationWithJWTAuthentication();\n@@ -39,6 +41,7 @@ public class KcOidcBrokerClientSecretJwtTest extends AbstractBrokerTest {\nIdentityProviderRepresentation idp = createIdentityProvider(IDP_OIDC_ALIAS, IDP_OIDC_PROVIDER_ID);\nMap<String, String> config = idp.getConfig();\napplyDefaultConfiguration(config, syncMode);\n+ config.put(\"clientSecret\", CLIENT_SECRET);\nconfig.put(\"clientAuthMethod\", OIDCLoginProtocol.CLIENT_SECRET_JWT);\nreturn idp;\n}\n"
},
{
"change_type": "MODIFY",
"old_path": "testsuite/integration-arquillian/tests/base/src/test/java/org/keycloak/testsuite/client/FAPI1Test.java",
"new_path": "testsuite/integration-arquillian/tests/base/src/test/java/org/keycloak/testsuite/client/FAPI1Test.java",
"diff": "@@ -316,7 +316,7 @@ public class FAPI1Test extends AbstractClientPoliciesTest {\n// Register client (default authenticator)\nString clientUUID = createClientByAdmin(\"foo\", (ClientRepresentation clientRep) -> {\nclientRep.setClientAuthenticatorType(JWTClientSecretAuthenticator.PROVIDER_ID);\n- clientRep.setSecret(\"secret\");\n+ clientRep.setSecret(\"atleast-14chars-password\");\n});\nClientRepresentation client = getClientByAdmin(clientUUID);\nAssert.assertFalse(client.isPublicClient());\n@@ -336,7 +336,7 @@ public class FAPI1Test extends AbstractClientPoliciesTest {\n// Check PKCE with S256, redirectUri and nonce/state set. Login should be successful\nsuccessfulLoginAndLogout(\"foo\", false, (String code) -> {\n- String signedJwt = getClientSecretSignedJWT(\"secret\", Algorithm.HS256);\n+ String signedJwt = getClientSecretSignedJWT(\"atleast-14chars-password\", Algorithm.HS256);\nreturn doAccessTokenRequestWithClientSignedJWT(code, signedJwt, codeVerifier, DefaultHttpClient::new);\n});\n}\n"
},
{
"change_type": "MODIFY",
"old_path": "testsuite/integration-arquillian/tests/base/src/test/java/org/keycloak/testsuite/oauth/ClientAuthSecretSignedJWTTest.java",
"new_path": "testsuite/integration-arquillian/tests/base/src/test/java/org/keycloak/testsuite/oauth/ClientAuthSecretSignedJWTTest.java",
"diff": "@@ -92,6 +92,9 @@ public class ClientAuthSecretSignedJWTTest extends AbstractKeycloakTest {\nprivate static final String PROFILE_NAME = \"ClientSecretRotationProfile\";\nprivate static final String POLICY_NAME = \"ClientSecretRotationPolicy\";\nprivate static final String OIDC = \"openid-connect\";\n+\n+ // BCFIPS approved mode requires at least 112 bits (14 characters) long SecretKey for \"client-secret-jwt\" authentication\n+ private static final String CLIENT_SECRET = \"atleast-14chars-password\";\nprivate static final ObjectMapper objectMapper = new ObjectMapper();\n@Rule\n@@ -142,7 +145,7 @@ public class ClientAuthSecretSignedJWTTest extends AbstractKeycloakTest {\n}\n};\nString algorithm = Algorithm.HS256;\n- jwtProvider.setClientSecret(\"password\", algorithm);\n+ jwtProvider.setClientSecret(CLIENT_SECRET, algorithm);\nString jwt = jwtProvider.createSignedRequestToken(oauth.getClientId(), getRealmInfoUrl(), algorithm);\nOAuthClient.AccessTokenResponse response = doAccessTokenRequest(code,\njwt);\n@@ -180,7 +183,6 @@ public class ClientAuthSecretSignedJWTTest extends AbstractKeycloakTest {\nClientRepresentation clientRep = null;\nfinal String realmName = \"test\";\nfinal String clientId = \"test-app\";\n- final String clientSecret = \"password\";\ntry {\nclientResource = ApiUtil.findClientByClientId(adminClient.realm(realmName), clientId);\nclientRep = clientResource.toRepresentation();\n@@ -188,11 +190,11 @@ public class ClientAuthSecretSignedJWTTest extends AbstractKeycloakTest {\nclientResource.update(clientRep);\noauth.clientId(clientId);\n- oauth.doLogin(\"test-user@localhost\", clientSecret);\n+ oauth.doLogin(\"test-user@localhost\", \"password\");\nevents.expectLogin().client(clientId).assertEvent();\nString code = oauth.getCurrentQuery().get(OAuth2Constants.CODE);\n- OAuthClient.AccessTokenResponse response = doAccessTokenRequest(code, getClientSignedJWT(clientSecret, 20, Algorithm.HS256));\n+ OAuthClient.AccessTokenResponse response = doAccessTokenRequest(code, getClientSignedJWT(CLIENT_SECRET, 20, Algorithm.HS256));\nassertEquals(400, response.getStatusCode());\nassertEquals(\"invalid_client\", response.getError());\n} catch (Exception e) {\n@@ -213,7 +215,7 @@ public class ClientAuthSecretSignedJWTTest extends AbstractKeycloakTest {\n.assertEvent();\nString code = oauth.getCurrentQuery().get(OAuth2Constants.CODE);\n- OAuthClient.AccessTokenResponse response = doAccessTokenRequest(code, getClientSignedJWT(\"password\", 20, algorithm));\n+ OAuthClient.AccessTokenResponse response = doAccessTokenRequest(code, getClientSignedJWT(CLIENT_SECRET, 20, algorithm));\nassertEquals(200, response.getStatusCode());\noauth.verifyToken(response.getAccessToken());\n@@ -245,7 +247,7 @@ public class ClientAuthSecretSignedJWTTest extends AbstractKeycloakTest {\n}\nprivate void processAuthenticateWithAlgorithm(String algorithm, Integer secretLength) throws Exception{\n- String cidConfidential= createClientByAdmin(\"jwt-client\",\"jwt-client\",\"password\",algorithm);\n+ String cidConfidential= createClientByAdmin(\"jwt-client\",\"jwt-client\",CLIENT_SECRET,algorithm);\nClientResource clientResource = adminClient.realm(REALM_NAME).clients().get(cidConfidential);\nconfigureDefaultProfileAndPolicy();\n@@ -292,7 +294,7 @@ public class ClientAuthSecretSignedJWTTest extends AbstractKeycloakTest {\n.assertEvent();\nString code = oauth.getCurrentQuery().get(OAuth2Constants.CODE);\n- String clientSignedJWT = getClientSignedJWT(\"password\", 20);\n+ String clientSignedJWT = getClientSignedJWT(CLIENT_SECRET, 20);\nOAuthClient.AccessTokenResponse response = doAccessTokenRequest(code, clientSignedJWT);\nassertEquals(200, response.getStatusCode());\n@@ -329,7 +331,7 @@ public class ClientAuthSecretSignedJWTTest extends AbstractKeycloakTest {\n*/\n@Test\npublic void authenticateWithInvalidRotatedClientSecretPolicyIsEnable() throws Exception {\n- String cidConfidential= createClientByAdmin(\"jwt-client\",\"jwt-client\",\"password\",Algorithm.HS256);\n+ String cidConfidential= createClientByAdmin(\"jwt-client\",\"jwt-client\",CLIENT_SECRET,Algorithm.HS256);\nClientResource clientResource = adminClient.realm(REALM_NAME).clients().get(cidConfidential);\nconfigureDefaultProfileAndPolicy();\nString firstSecret = clientResource.getSecret().getValue();\n"
},
{
"change_type": "MODIFY",
"old_path": "testsuite/integration-arquillian/tests/base/src/test/resources/client-auth-test/testrealm-jwt-client-secret.json",
"new_path": "testsuite/integration-arquillian/tests/base/src/test/resources/client-auth-test/testrealm-jwt-client-secret.json",
"diff": "],\n\"adminUrl\": \"http://localhost:8180/auth/realms/master/app/admin\",\n\"clientAuthenticatorType\": \"client-secret-jwt\",\n- \"secret\": \"password\"\n+ \"secret\": \"atleast-14chars-password\"\n}\n],\n\"roles\" : {\n"
}
] | Java | Apache License 2.0 | keycloak/keycloak | BCFIPS approved mode: Some tests failing due the short secret for client-secret-jwt client authentication
Closes #16678 |
339,410 | 27.01.2023 10:23:08 | -3,600 | 7933f0489d4fcd7ac5c66ec80450c771cb330814 | Align startup of Quarkus with the regular startup to ensure boostrap locks are created.
Also fixing an issue where DBLockGlobalLockProviderFactory held on to an old session, which lead to a closed DB connection on Quarkus.
Closes | [
{
"change_type": "MODIFY",
"old_path": "model/jpa/src/main/java/org/keycloak/connections/jpa/updater/liquibase/lock/LiquibaseDBLockProvider.java",
"new_path": "model/jpa/src/main/java/org/keycloak/connections/jpa/updater/liquibase/lock/LiquibaseDBLockProvider.java",
"diff": "@@ -40,7 +40,7 @@ public class LiquibaseDBLockProvider implements DBLockProvider {\nprivate static final Logger logger = Logger.getLogger(LiquibaseDBLockProvider.class);\n// 10 should be sufficient\n- private int DEFAULT_MAX_ATTEMPTS = 10;\n+ private final int DEFAULT_MAX_ATTEMPTS = 10;\nprivate final LiquibaseDBLockProviderFactory factory;\n@@ -83,9 +83,6 @@ public class LiquibaseDBLockProvider implements DBLockProvider {\n// Assumed transaction was rolled-back and we want to start with new DB connection\nprivate void restart() {\nsafeCloseConnection();\n- this.dbConnection = null;\n- this.lockService = null;\n- initialized = false;\nlazyInit();\n}\n@@ -187,6 +184,9 @@ public class LiquibaseDBLockProvider implements DBLockProvider {\nif (dbConnection != null) {\ntry {\ndbConnection.close();\n+ dbConnection = null;\n+ lockService = null;\n+ initialized = false;\n} catch (SQLException e) {\nlogger.warn(\"Failed to close connection\", e);\n}\n"
},
{
"change_type": "MODIFY",
"old_path": "model/legacy-private/src/main/java/org/keycloak/models/dblock/DBLockGlobalLockProvider.java",
"new_path": "model/legacy-private/src/main/java/org/keycloak/models/dblock/DBLockGlobalLockProvider.java",
"diff": "@@ -21,7 +21,6 @@ import org.jboss.logging.Logger;\nimport org.keycloak.models.KeycloakSession;\nimport org.keycloak.models.KeycloakSessionTaskWithResult;\nimport org.keycloak.models.locking.GlobalLockProvider;\n-import org.keycloak.models.utils.KeycloakModelUtils;\nimport java.time.Duration;\nimport java.util.Objects;\n@@ -69,8 +68,12 @@ public class DBLockGlobalLockProvider implements GlobalLockProvider {\nLOG.debug(\"DBLockGlobalLockProvider does not support setting timeToWaitForLock per lock.\");\n}\n- try {\n+ if (dbLockProvider.getCurrentLock() != null) {\n+ throw new IllegalStateException(\"this lock is not reentrant, already locked for \" + dbLockProvider.getCurrentLock());\n+ }\n+\ndbLockProvider.waitForLock(stringToNamespace(lockName));\n+ try {\nreturn task.run(session);\n} finally {\nreleaseLock(lockName);\n"
},
{
"change_type": "MODIFY",
"old_path": "model/legacy-private/src/main/java/org/keycloak/models/dblock/DBLockGlobalLockProviderFactory.java",
"new_path": "model/legacy-private/src/main/java/org/keycloak/models/dblock/DBLockGlobalLockProviderFactory.java",
"diff": "@@ -28,15 +28,11 @@ import org.keycloak.provider.EnvironmentDependentProviderFactory;\npublic class DBLockGlobalLockProviderFactory implements GlobalLockProviderFactory, EnvironmentDependentProviderFactory {\npublic static final String PROVIDER_ID = \"dblock\";\n- private DBLockManager dbLockManager;\n@Override\npublic GlobalLockProvider create(KeycloakSession session) {\n- if (dbLockManager == null) {\n- dbLockManager = new DBLockManager(session);\n+ DBLockManager dbLockManager = new DBLockManager(session);\ndbLockManager.checkForcedUnlock();\n- }\n-\nreturn new DBLockGlobalLockProvider(session, dbLockManager.getDBLock());\n}\n"
},
{
"change_type": "MODIFY",
"old_path": "quarkus/runtime/src/main/java/org/keycloak/quarkus/runtime/integration/jaxrs/QuarkusKeycloakApplication.java",
"new_path": "quarkus/runtime/src/main/java/org/keycloak/quarkus/runtime/integration/jaxrs/QuarkusKeycloakApplication.java",
"diff": "@@ -21,8 +21,8 @@ import java.util.Set;\nimport java.util.stream.Collectors;\nimport javax.ws.rs.ApplicationPath;\n-import org.keycloak.exportimport.ExportImportManager;\n-import org.keycloak.models.utils.PostMigrationEvent;\n+\n+import org.keycloak.models.KeycloakSessionFactory;\nimport org.keycloak.quarkus.runtime.integration.QuarkusKeycloakSessionFactory;\nimport org.keycloak.services.resources.KeycloakApplication;\nimport org.keycloak.quarkus.runtime.services.resources.QuarkusWelcomeResource;\n@@ -36,17 +36,10 @@ public class QuarkusKeycloakApplication extends KeycloakApplication {\n}\n@Override\n- protected void startup() {\n+ public KeycloakSessionFactory createSessionFactory() {\nQuarkusKeycloakSessionFactory instance = QuarkusKeycloakSessionFactory.getInstance();\n- sessionFactory = instance;\ninstance.init();\n- ExportImportManager exportImportManager = bootstrap();\n-\n- if (exportImportManager.isRunExport()) {\n- exportImportManager.runExport();\n- }\n-\n- sessionFactory.publish(new PostMigrationEvent(sessionFactory));\n+ return instance;\n}\n@Override\n"
},
{
"change_type": "MODIFY",
"old_path": "services/src/main/java/org/keycloak/services/resources/KeycloakApplication.java",
"new_path": "services/src/main/java/org/keycloak/services/resources/KeycloakApplication.java",
"diff": "@@ -82,7 +82,7 @@ public class KeycloakApplication extends Application {\nprotected Set<Object> singletons = new HashSet<>();\nprotected Set<Class<?>> classes = new HashSet<>();\n- protected static KeycloakSessionFactory sessionFactory;\n+ private static KeycloakSessionFactory sessionFactory;\npublic KeycloakApplication() {\n@@ -237,7 +237,7 @@ public class KeycloakApplication extends Application {\n}\n- public static KeycloakSessionFactory createSessionFactory() {\n+ protected KeycloakSessionFactory createSessionFactory() {\nDefaultKeycloakSessionFactory factory = new DefaultKeycloakSessionFactory();\nfactory.init();\nreturn factory;\n"
}
] | Java | Apache License 2.0 | keycloak/keycloak | Align startup of Quarkus with the regular startup to ensure boostrap locks are created.
Also fixing an issue where DBLockGlobalLockProviderFactory held on to an old session, which lead to a closed DB connection on Quarkus.
Closes #16642 |
339,465 | 30.01.2023 16:01:57 | -3,600 | 33ff9ef17e9c85b1460ae8c05bf785fbfa5cc414 | Fix remaining failing tests with BCFIPS approved mode
* Fix remaining failing tests with BCFIPS approved mode
Closes | [
{
"change_type": "MODIFY",
"old_path": "common/src/main/java/org/keycloak/common/crypto/CryptoIntegration.java",
"new_path": "common/src/main/java/org/keycloak/common/crypto/CryptoIntegration.java",
"diff": "@@ -9,6 +9,9 @@ import java.util.stream.Collectors;\nimport java.util.stream.Stream;\nimport java.util.stream.StreamSupport;\n+import javax.net.ssl.KeyManagerFactory;\n+import javax.net.ssl.TrustManagerFactory;\n+\nimport org.jboss.logging.Logger;\nimport org.keycloak.common.util.BouncyIntegration;\n@@ -75,6 +78,9 @@ public class CryptoIntegration {\nStringBuilder builder = new StringBuilder(\"Security properties: [ \\n\")\n.append(\" Java security properties file: \" + System.getProperty(\"java.security.properties\") + \"\\n\")\n.append(\" Default keystore type: \" + KeyStore.getDefaultType() + \"\\n\")\n+ .append(\" KeyManagerFactory.getDefaultAlgorithm(): \" + KeyManagerFactory.getDefaultAlgorithm() + \"\\n\")\n+ .append(\" TrustManagerFactory.getDefaultAlgorithm(): \" + TrustManagerFactory.getDefaultAlgorithm() + \"\\n\")\n+ .append(\" Default keystore type: \" + KeyStore.getDefaultType() + \"\\n\")\n.append(\" keystore.type.compat: \" + Security.getProperty(\"keystore.type.compat\") + \"\\n\");\nStream.of(\"javax.net.ssl.trustStoreType\", \"javax.net.ssl.trustStore\", \"javax.net.ssl.trustStoreProvider\",\n\"javax.net.ssl.keyStoreType\", \"javax.net.ssl.keyStore\", \"javax.net.ssl.keyStoreProvider\")\n"
},
{
"change_type": "MODIFY",
"old_path": "crypto/fips1402/src/test/java/org/keycloak/crypto/fips/test/FIPS1402SslTest.java",
"new_path": "crypto/fips1402/src/test/java/org/keycloak/crypto/fips/test/FIPS1402SslTest.java",
"diff": "@@ -12,6 +12,7 @@ import javax.net.ssl.KeyManagerFactory;\nimport javax.net.ssl.SSLContext;\nimport javax.net.ssl.SSLEngine;\nimport javax.net.ssl.SSLSessionContext;\n+import javax.net.ssl.TrustManagerFactory;\nimport org.bouncycastle.crypto.CryptoServicesRegistrar;\nimport org.jboss.logging.Logger;\n@@ -103,6 +104,16 @@ public class FIPS1402SslTest {\ntestSSLContext(keyMgrFact);\n}\n+ @Test\n+ public void testDefaultTruststore() throws Exception {\n+ String defaultAlg = TrustManagerFactory.getDefaultAlgorithm();\n+ logger.infof(\"Default trust manager factory algorithm: %s\", defaultAlg);\n+ TrustManagerFactory trustManagerFactory = TrustManagerFactory.getInstance(defaultAlg);\n+\n+ // This may fail if default truststore is \"pkcs12\" and security property \"keystore.type.compat\" is set to false\n+ trustManagerFactory.init((KeyStore) null);\n+ }\n+\nprivate KeyStore loadKeystore(String type, String password) throws Exception {\nKeyStore keystore = KeyStore.getInstance(type);\nInputStream in = FIPS1402SslTest.class.getClassLoader().getResourceAsStream(\"bcfips-keystore.\" + type.toLowerCase());\n"
},
{
"change_type": "MODIFY",
"old_path": "server-spi-private/src/main/java/org/keycloak/provider/ConfigurationValidationHelper.java",
"new_path": "server-spi-private/src/main/java/org/keycloak/provider/ConfigurationValidationHelper.java",
"diff": "@@ -19,6 +19,7 @@ package org.keycloak.provider;\nimport org.keycloak.component.ComponentModel;\nimport org.keycloak.component.ComponentValidationException;\n+import org.keycloak.utils.StringUtil;\nimport java.util.List;\n@@ -46,18 +47,8 @@ public class ConfigurationValidationHelper {\nString value = model.getConfig().getFirst(property.getName());\nif (value != null && !property.getOptions().contains(value)) {\n- StringBuilder options = new StringBuilder();\n- int i = 1;\n- for (String o : property.getOptions()) {\n- if (i == property.getOptions().size()) {\n- options.append(\" or \");\n- } else if (i > 1) {\n- options.append(\", \");\n- }\n- options.append(o);\n- i++;\n- }\n- throw new ComponentValidationException(\"''{0}'' should be {1}\", property.getLabel(), options.toString());\n+ String options = StringUtil.joinValuesWithLogicalCondition(\"or\", property.getOptions());\n+ throw new ComponentValidationException(\"''{0}'' should be {1}\", property.getLabel(), options);\n}\nreturn this;\n"
},
{
"change_type": "MODIFY",
"old_path": "server-spi/src/main/java/org/keycloak/utils/StringUtil.java",
"new_path": "server-spi/src/main/java/org/keycloak/utils/StringUtil.java",
"diff": "*/\npackage org.keycloak.utils;\n+import java.util.Collection;\n+\npublic class StringUtil {\npublic static boolean isBlank(String str) {\n@@ -26,4 +28,28 @@ public class StringUtil {\nreturn str != null && !\"\".equals(str.trim());\n}\n+ /**\n+ * Calling:\n+ * <pre>joinValuesWithLogicalCondition(\"or\", Arrays.asList(\"foo\", \"bar\", \"baz\", \"caz\" ))</pre>\n+ * will return \"foo, bar, baz or caz\"\n+ *\n+ * @param conditionText condition\n+ * @param values values to be joined with the condition at the end\n+ * @return see the example above\n+ */\n+ public static String joinValuesWithLogicalCondition(String conditionText, Collection<String> values) {\n+ StringBuilder options = new StringBuilder();\n+ int i = 1;\n+ for (String o : values) {\n+ if (i == values.size()) {\n+ options.append(\" \" + conditionText + \" \");\n+ } else if (i > 1) {\n+ options.append(\", \");\n+ }\n+ options.append(o);\n+ i++;\n+ }\n+ return options.toString();\n+ }\n+\n}\n\\ No newline at end of file\n"
},
{
"change_type": "MODIFY",
"old_path": "testsuite/integration-arquillian/servers/auth-server/common/fips/kc.java.security",
"new_path": "testsuite/integration-arquillian/servers/auth-server/common/fips/kc.java.security",
"diff": "@@ -54,6 +54,6 @@ fips.ssl.TrustManagerFactory.algorithm=PKIX\n# JKS keystore type supports loading only JKS keystore files and the PKCS12\n# keystore type supports loading only PKCS12 keystore files.\n#\n-# This is set to false as BCFIPS providers don't support JKS\n-keystore.type.compat=false\n-fips.keystore.type.compat=false\n+# This is set to true as when set to false on OpenJDK 17 and PKCS12 is default keystore type, loading of default truststore (from java cacerts) fails.\n+#keystore.type.compat=false\n+#fips.keystore.type.compat=false\n"
},
{
"change_type": "MODIFY",
"old_path": "testsuite/integration-arquillian/tests/base/src/main/java/org/keycloak/testsuite/util/KeyUtils.java",
"new_path": "testsuite/integration-arquillian/tests/base/src/main/java/org/keycloak/testsuite/util/KeyUtils.java",
"diff": "@@ -15,6 +15,9 @@ import java.security.spec.InvalidKeySpecException;\nimport java.security.spec.PKCS8EncodedKeySpec;\nimport java.security.spec.X509EncodedKeySpec;\nimport java.util.Base64;\n+import java.util.List;\n+\n+import static org.junit.Assert.fail;\n/**\n* @author mhajas\n@@ -59,4 +62,23 @@ public class KeyUtils {\nthrow new RuntimeException(\"Active key not found\");\n}\n+ /**\n+ * @return key sizes, which are expected to be supported by Keycloak server for {@link org.keycloak.keys.GeneratedRsaKeyProviderFactory} and {@link org.keycloak.keys.GeneratedRsaEncKeyProviderFactory}.\n+ */\n+ public static String[] getExpectedSupportedRsaKeySizes() {\n+ String expectedKeySizes = System.getProperty(\"auth.server.supported.rsa.key.sizes\");\n+ if (expectedKeySizes == null || expectedKeySizes.trim().isEmpty()) {\n+ fail(\"System property 'auth.server.supported.rsa.key.sizes' should be set\");\n+ }\n+ return expectedKeySizes.split(\",\");\n+ }\n+\n+ /**\n+ * @return Lowest key size supported by Keycloak server for {@link org.keycloak.keys.GeneratedRsaKeyProviderFactory}.\n+ * It is usually 1024, but can be 2048 in some environments (typically in FIPS environments)\n+ */\n+ public static int getLowestSupportedRsaKeySize() {\n+ return Integer.parseInt(getExpectedSupportedRsaKeySizes()[0]);\n+ }\n+\n}\n"
},
{
"change_type": "MODIFY",
"old_path": "testsuite/integration-arquillian/tests/base/src/test/java/org/keycloak/testsuite/adapter/servlet/SAMLServletAdapterTest.java",
"new_path": "testsuite/integration-arquillian/tests/base/src/test/java/org/keycloak/testsuite/adapter/servlet/SAMLServletAdapterTest.java",
"diff": "@@ -649,7 +649,7 @@ public class SAMLServletAdapterTest extends AbstractSAMLServletAdapterTest {\n}\n}\n- private static final KeyPair NEW_KEY_PAIR = KeyUtils.generateRsaKeyPair(1024);\n+ private static final KeyPair NEW_KEY_PAIR = KeyUtils.generateRsaKeyPair(org.keycloak.testsuite.util.KeyUtils.getLowestSupportedRsaKeySize());\nprivate static final String NEW_KEY_PRIVATE_KEY_PEM = PemUtils.encodeKey(NEW_KEY_PAIR.getPrivate());\nprivate PublicKey createKeys(String priority) throws Exception {\n"
},
{
"change_type": "MODIFY",
"old_path": "testsuite/integration-arquillian/tests/base/src/test/java/org/keycloak/testsuite/admin/ServerInfoTest.java",
"new_path": "testsuite/integration-arquillian/tests/base/src/test/java/org/keycloak/testsuite/admin/ServerInfoTest.java",
"diff": "@@ -29,6 +29,7 @@ import org.keycloak.representations.info.ProviderRepresentation;\nimport org.keycloak.representations.info.ServerInfoRepresentation;\nimport org.keycloak.testsuite.AbstractKeycloakTest;\nimport org.keycloak.testsuite.Assert;\n+import org.keycloak.testsuite.util.KeyUtils;\nimport org.keycloak.testsuite.util.KeystoreUtils;\nimport java.util.List;\n@@ -36,7 +37,6 @@ import java.util.Map;\nimport static org.junit.Assert.assertEquals;\nimport static org.junit.Assert.assertNotNull;\n-import static org.junit.Assert.fail;\n/**\n* @author <a href=\"mailto:sthorger@redhat.com\">Stian Thorgersen</a>\n@@ -67,10 +67,6 @@ public class ServerInfoTest extends AbstractKeycloakTest {\nassertNotNull(info.getCryptoInfo());\nAssert.assertNames(info.getCryptoInfo().getSupportedKeystoreTypes(), KeystoreUtils.getSupportedKeystoreTypes());\n- String expectedSupportedRsaKeySizes = System.getProperty(\"auth.server.supported.rsa.key.sizes\");\n- if (expectedSupportedRsaKeySizes == null || expectedSupportedRsaKeySizes.trim().isEmpty()) {\n- fail(\"Property 'auth.server.supported.rsa.key.sizes' not set\");\n- }\nComponentTypeRepresentation rsaGeneratedProviderInfo = info.getComponentTypes().get(KeyProvider.class.getName())\n.stream()\n.filter(componentType -> GeneratedRsaKeyProviderFactory.ID.equals(componentType.getId()))\n@@ -79,7 +75,7 @@ public class ServerInfoTest extends AbstractKeycloakTest {\n.stream()\n.filter(configProp -> Attributes.KEY_SIZE_KEY.equals(configProp.getName()))\n.findFirst().orElseThrow(() -> new RuntimeException(\"Not found provider with ID 'rsa-generated'\"));\n- Assert.assertNames(keySizeRep.getOptions(), expectedSupportedRsaKeySizes.split(\",\"));\n+ Assert.assertNames(keySizeRep.getOptions(), KeyUtils.getExpectedSupportedRsaKeySizes());\nassertEquals(Version.VERSION, info.getSystemInfo().getVersion());\nassertNotNull(info.getSystemInfo().getServerTime());\n"
},
{
"change_type": "MODIFY",
"old_path": "testsuite/integration-arquillian/tests/base/src/test/java/org/keycloak/testsuite/forms/ResetPasswordTest.java",
"new_path": "testsuite/integration-arquillian/tests/base/src/test/java/org/keycloak/testsuite/forms/ResetPasswordTest.java",
"diff": "@@ -55,6 +55,7 @@ import org.keycloak.testsuite.updaters.ClientAttributeUpdater;\nimport org.keycloak.testsuite.util.BrowserTabUtil;\nimport org.keycloak.testsuite.util.GreenMailRule;\nimport org.keycloak.testsuite.util.InfinispanTestTimeServiceRule;\n+import org.keycloak.testsuite.util.KerberosUtils;\nimport org.keycloak.testsuite.util.MailUtils;\nimport org.keycloak.testsuite.util.OAuthClient;\nimport org.keycloak.testsuite.util.RealmBuilder;\n@@ -1094,6 +1095,8 @@ public class ResetPasswordTest extends AbstractTestRealmKeycloakTest {\n// KEYCLOAK-15239\n@Test\npublic void resetPasswordWithSpnegoEnabled() throws IOException, MessagingException {\n+ KerberosUtils.assumeKerberosSupportExpected();\n+\n// Just switch SPNEGO authenticator requirement to alternative. No real usage of SPNEGO needed for this test\nAuthenticationExecutionModel.Requirement origRequirement = AbstractKerberosTest.updateKerberosAuthExecutionRequirement(AuthenticationExecutionModel.Requirement.ALTERNATIVE, testRealm());\n"
},
{
"change_type": "MODIFY",
"old_path": "testsuite/integration-arquillian/tests/base/src/test/java/org/keycloak/testsuite/keys/GeneratedRsaKeyProviderTest.java",
"new_path": "testsuite/integration-arquillian/tests/base/src/test/java/org/keycloak/testsuite/keys/GeneratedRsaKeyProviderTest.java",
"diff": "@@ -36,9 +36,12 @@ import org.keycloak.testsuite.AssertEvents;\nimport org.keycloak.testsuite.admin.ApiUtil;\nimport org.keycloak.testsuite.pages.AppPage;\nimport org.keycloak.testsuite.pages.LoginPage;\n+import org.keycloak.testsuite.util.KeyUtils;\n+import org.keycloak.utils.StringUtil;\nimport javax.ws.rs.core.Response;\nimport java.security.interfaces.RSAPublicKey;\n+import java.util.Arrays;\nimport java.util.List;\nimport static org.junit.Assert.*;\n@@ -226,7 +229,7 @@ public class GeneratedRsaKeyProviderTest extends AbstractKeycloakTest {\n}\n@Test\n- public void invalidKeysizeForEnd() throws Exception {\n+ public void invalidKeysizeForEnc() throws Exception {\ninvalidKeysize(GeneratedRsaEncKeyProviderFactory.ID);\n}\n@@ -235,7 +238,8 @@ public class GeneratedRsaKeyProviderTest extends AbstractKeycloakTest {\nrep.getConfig().putSingle(\"keySize\", \"1234\");\nResponse response = adminClient.realm(\"test\").components().add(rep);\n- assertErrror(response, \"'Key size' should be 1024, 2048 or 4096\");\n+ String expectedKeySizesDisplay = StringUtil.joinValuesWithLogicalCondition(\"or\", Arrays.asList(KeyUtils.getExpectedSupportedRsaKeySizes()));\n+ assertErrror(response, \"'Key size' should be \" + expectedKeySizesDisplay);\n}\nprotected void assertErrror(Response response, String error) {\n"
},
{
"change_type": "MODIFY",
"old_path": "testsuite/integration-arquillian/tests/base/src/test/java/org/keycloak/testsuite/keys/KeyRotationTest.java",
"new_path": "testsuite/integration-arquillian/tests/base/src/test/java/org/keycloak/testsuite/keys/KeyRotationTest.java",
"diff": "@@ -268,7 +268,7 @@ public class KeyRotationTest extends AbstractKeycloakTest {\n}\nprivate Map<String, String> createKeys(String priority) throws Exception {\n- KeyPair keyPair = KeyUtils.generateRsaKeyPair(1024);\n+ KeyPair keyPair = KeyUtils.generateRsaKeyPair(org.keycloak.testsuite.util.KeyUtils.getLowestSupportedRsaKeySize());\nString privateKeyPem = PemUtils.encodeKey(keyPair.getPrivate());\nPublicKey publicKey = keyPair.getPublic();\n"
},
{
"change_type": "MODIFY",
"old_path": "testsuite/integration-arquillian/tests/base/src/test/java/org/keycloak/testsuite/migration/JsonFileImport198MigrationTest.java",
"new_path": "testsuite/integration-arquillian/tests/base/src/test/java/org/keycloak/testsuite/migration/JsonFileImport198MigrationTest.java",
"diff": "*/\npackage org.keycloak.testsuite.migration;\n+import org.junit.BeforeClass;\nimport org.junit.Test;\nimport org.keycloak.exportimport.util.ImportUtils;\nimport org.keycloak.representations.idm.RealmRepresentation;\n+import org.keycloak.testsuite.util.KerberosUtils;\nimport org.keycloak.testsuite.utils.io.IOUtil;\nimport org.keycloak.util.JsonSerialization;\n@@ -34,6 +36,12 @@ import java.util.Map;\n*/\npublic class JsonFileImport198MigrationTest extends AbstractJsonFileImportMigrationTest {\n+ @BeforeClass\n+ public static void checkKerberosSupportedByAuthServer() {\n+ // Requires 'KERBEROS' feature on the server, due some kerberos provider present in the JSON\n+ KerberosUtils.assumeKerberosSupportExpected();\n+ }\n+\n@Override\npublic void addTestRealms(List<RealmRepresentation> testRealms) {\nMap<String, RealmRepresentation> reps = null;\n"
},
{
"change_type": "MODIFY",
"old_path": "testsuite/integration-arquillian/tests/base/src/test/java/org/keycloak/testsuite/saml/AbstractSamlTest.java",
"new_path": "testsuite/integration-arquillian/tests/base/src/test/java/org/keycloak/testsuite/saml/AbstractSamlTest.java",
"diff": "@@ -88,11 +88,29 @@ public abstract class AbstractSamlTest extends AbstractAuthTest {\n}\n- // Set date to past; then: openssl req -x509 -newkey rsa:1024 -keyout key.pem -out cert.pem -days 1 -nodes -subj '/CN=http:\\/\\/localhost:8080\\/sales-post-sig\\/'\n- public static final String SAML_CLIENT_SALES_POST_SIG_EXPIRED_PRIVATE_KEY = \"MIICdwIBADANBgkqhkiG9w0BAQEFAASCAmEwggJdAgEAAoGBAMrGzRp3HVf6Ti75rl5mPAPXua8APCCLANikzOd82VI0R8Ml0UAchkfRUBvBedobJIn9r8wwxMeXLmKsMynW52SYeC/Zx5b5K6ayMS3GWJIgqLpp/n1piUeI4sbJXlUj9UtW+QTpGhrHt9n7s7znwoNqGDUkjmyZiekEspjdfzzlAgMBAAECgYBJvPFo5lftXkCAJJucCGFapGAJm3RCAUpVfdhldakxk4FlHaNyRO0vwJX5AeplvekTpQUAo9trGTbs+uHAHT4XWOnwhHHyBRkWdiwXX9bzNdHnIwf/0SLIBBYUk0hoWEDvpklBPqllM215a0sEnB2ykYSsMDBSkFB7Ah+RK7zTAQJBAOw9v7SsfIhOXci9vnkQPuQpL8T4kwj7nWi+YtRGrXbF/bJGwjsgXN5i7otwBV/W+TNzI5H7s2opPUXdIxfP9C0CQQDbvIcxXjwjO1hjXXY4axiT1sxU8Oq1bds033atMoN9pib7IxkWh6ouOQZT8bxwQ2ElH0rswZ0/2CusrIUIekaZAkEAk9UUSQiDKXz4vSzXq8SZxodriDQRNtbVqv0wtSvBUwkU9+HFm+BlnRiFtCYWhuHsseCESs8ad/10hWqbkkQkxQJAZOvN2+rADB5xlhGS/o6RlzUMW+bapcFy8HHB/AI7SjZJqQaRuztL+jbOpTddqOIJeBdLPjoekvgh9wi1gRNH4QJBAMjfB1xYxmztfbUcUuOsATz3s7StprOAukd+hhBiMukxcKhi1IQp7tFhfFe/+xUY3fSh1a3KlyItFKxp68EdDRk=\";\n- public static final String SAML_CLIENT_SALES_POST_SIG_EXPIRED_PUBLIC_KEY = \"MIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQDKxs0adx1X+k4u+a5eZjwD17mvADwgiwDYpMznfNlSNEfDJdFAHIZH0VAbwXnaGySJ/a/MMMTHly5irDMp1udkmHgv2ceW+SumsjEtxliSIKi6af59aYlHiOLGyV5VI/VLVvkE6Roax7fZ+7O858KDahg1JI5smYnpBLKY3X885QIDAQAB\";\n- public static final String SAML_CLIENT_SALES_POST_SIG_EXPIRED_CERTIFICATE = \"MIICMTCCAZqgAwIBAgIJAPlizW20Nhe6MA0GCSqGSIb3DQEBCwUAMDAxLjAsBgNVBAMMJWh0dHA6Ly9sb2NhbGhvc3Q6ODA4MC9zYWxlcy1wb3N0LXNpZy8wHhcNMTYwODI5MDg1MjMzWhcNMTYwODMwMDg1MjMzWjAwMS4wLAYDVQQDDCVodHRwOi8vbG9jYWxob3N0OjgwODAvc2FsZXMtcG9zdC1zaWcvMIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQDKxs0adx1X+k4u+a5eZjwD17mvADwgiwDYpMznfNlSNEfDJdFAHIZH0VAbwXnaGySJ/a/MMMTHly5irDMp1udkmHgv2ceW+SumsjEtxliSIKi6af59aYlHiOLGyV5VI/VLVvkE6Roax7fZ+7O858KDahg1JI5smYnpBLKY3X885QIDAQABo1MwUTAdBgNVHQ4EFgQUE9C6Ck0jsdY+sjN064ZYwYkZJr4wHwYDVR0jBBgwFoAUE9C6Ck0jsdY+sjN064ZYwYkZJr4wDwYDVR0TAQH/BAUwAwEB/zANBgkqhkiG9w0BAQsFAAOBgQBuypHw5DMDBgfI6LcXBiCjpiQP3DLRLdwthh/RfCnZT7PrhXRJV8RMm8EqxqtEgfg2SKqMyA02uxMKH0p277U2iQveSDAaICTJRxtyFm6FERtgLNlsekusC2I14gZpLe84oHDf6L1w3dKFzzLEC9+bHg/XCg/KthWxW8iuVct5qg==\";\n-\n+ // Set date to past (For example with \"faketime\" utility); then: openssl req -x509 -newkey rsa:2048 -keyout key.pem -out cert.pem -days 1 -nodes -subj '/CN=http:\\/\\/localhost:8080\\/sales-post-sig\\/'\n+ public static final String SAML_CLIENT_SALES_POST_SIG_EXPIRED_PRIVATE_KEY = \"MIIEpQIBAAKCAQEA3SMEGYw330CS++XP0KqoFz2UezUxZAhkLv5C93hf5FPGw9QpPmimpGcsN8RCy4DDYOGrbuJLd8GkoBCkmp7xTqQMx/nrUvzDCAWAUSnxnBVgCsq9KbpI5sdacOHd0oEI9pQdRQ71Rj+tipeIt+Fy8S17bkpGBYjQk3xdusMX8E9LR04ksp0C9o2mvX+U0QCrF8HqVCCO9gMJJNOGaot7a3+QaTWnNrPguhMuHgJ6LlsyOUYNFQw5rdxs8Vz2mOsIGvWn1Em/c+KCcMltTIhOhDY3zW3ZrFL3Vwq4kTQ74ju9Qp1qyyQOOJmig6LLm31LQvQHPQWkY7rRcp9VBMRPcQIDAQABAoIBAQDPUpvuY9KiIYVsWvoqFUWAfIBvvuAue9uJX2JjZ1zn0U+Bm7CLTUwmyH/hTMSezHrgotK6I7lDbq4sT04zlJ6B7zX4aqwg4s7q/1VdQui9QCEKHSeaLodYrkBxoqD4UXeYziZe73YvRVYroIRSeTDtQon9Te82Ex4RmEC771rLNZ38rm2EsF2+GfNIavumo458TBmX0DI8w3QwlSMEeXaNZqch2adZSDxehrOFeqzZ9o8KtgCfrJ5P11vgXlKnVGFa7Pfndrc6XacfYhKAtTyX3Bgx9FFaOK+W5k5/XXc2UTbUV6aNmiQdNp5CrjoZ/DuttWFGwOWfg9zSG3i5wwLRAoGBAPR7IWPk1Ejf8+4vGvDED3ZDc94DINrFjszaVZBt2w/Hx0uePdeojulHhTBFMFUtV2Dn8vpG7D9TxDeZj7tmKSHE3/j1DXE6jpo72Z+iOR5byO/HmgiV0kblKxXnZfDy5/cq/Cy6GTJ2MU6k50SDgIIq86gWCXbRwveX9E66qlHdAoGBAOeOUEiuGC332m7N2wfUobBbczNviSWeAzIFP4t15u0QHRhMDeRmfE4xuWS4aL1vfsyTOrxaN5GJ2QeAIdkM42dSA0FqzzumRd9T8VdeJ+J2GGB+ALNmTHNuz8jWepLVD2F1GBhs+gkSh5yS1p+FUodQWkWC5YLI/y2rySpbiPylAoGBAJpV0LJbFpgaqMbH/d3YJ1qlIlQY7XiuFoPDoRhYAV5o46sc7jViNzWU7MOYKfbbdLm8M2tDsogXvVrMGixXRcgHnMxxBldge/1pouxfYGeF0cds3hRlYCVZLmXZekUtUrp57E/f+2AbtOzMtSJPUaTasI5/uuHDca0TxCqfND4RAoGAWS6Fm0h6BZJVLaHZPw3U7FB8cQ3/G17dSjGdRMA3HYy8N/Rq0VHrhE5AYhtoM7Wyd2YpFAwHJOWbkfj2kFsXZl6+5D4X7JhghuAUrpqT7/Od9ePxryayQS8nlemNMeofT2DC0/1822uokVQ4lx3JKFZ5PhZpANMa/OMRyl+QxgUCgYEA4D5YyD5wHz7fNFyaUrgJr4dFLG9vqRv8Pm9IozBAmNumi25Gi7gyi/WN8DrVbsRiq4ywiKiikui5TW3/RR51OYDnX3YCnWE5AGV4okci3PlclJ/UsPjlUOzNlXW7Wr0pFCcJc/WuQm1lgho/o6QGbMbS/BSwxBrUl/bUEp4IZKc=\";\n+ public static final String SAML_CLIENT_SALES_POST_SIG_EXPIRED_PUBLIC_KEY = \"MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEA3SMEGYw330CS++XP0KqoFz2UezUxZAhkLv5C93hf5FPGw9QpPmimpGcsN8RCy4DDYOGrbuJLd8GkoBCkmp7xTqQMx/nrUvzDCAWAUSnxnBVgCsq9KbpI5sdacOHd0oEI9pQdRQ71Rj+tipeIt+Fy8S17bkpGBYjQk3xdusMX8E9LR04ksp0C9o2mvX+U0QCrF8HqVCCO9gMJJNOGaot7a3+QaTWnNrPguhMuHgJ6LlsyOUYNFQw5rdxs8Vz2mOsIGvWn1Em/c+KCcMltTIhOhDY3zW3ZrFL3Vwq4kTQ74ju9Qp1qyyQOOJmig6LLm31LQvQHPQWkY7rRcp9VBMRPcQIDAQAB\";\n+ public static final String SAML_CLIENT_SALES_POST_SIG_EXPIRED_CERTIFICATE = \"-----BEGIN CERTIFICATE-----\\n\" +\n+ \"MIIDQTCCAimgAwIBAgIUT8qwq3DECizGLB2tQAaaNSGAVLgwDQYJKoZIhvcNAQEL\\n\" +\n+ \"BQAwMDEuMCwGA1UEAwwlaHR0cDovL2xvY2FsaG9zdDo4MDgwL3NhbGVzLXBvc3Qt\\n\" +\n+ \"c2lnLzAeFw0yMzAxMjcxNjAwMDBaFw0yMzAxMjgxNjAwMDBaMDAxLjAsBgNVBAMM\\n\" +\n+ \"JWh0dHA6Ly9sb2NhbGhvc3Q6ODA4MC9zYWxlcy1wb3N0LXNpZy8wggEiMA0GCSqG\\n\" +\n+ \"SIb3DQEBAQUAA4IBDwAwggEKAoIBAQDdIwQZjDffQJL75c/QqqgXPZR7NTFkCGQu\\n\" +\n+ \"/kL3eF/kU8bD1Ck+aKakZyw3xELLgMNg4atu4kt3waSgEKSanvFOpAzH+etS/MMI\\n\" +\n+ \"BYBRKfGcFWAKyr0pukjmx1pw4d3SgQj2lB1FDvVGP62Kl4i34XLxLXtuSkYFiNCT\\n\" +\n+ \"fF26wxfwT0tHTiSynQL2jaa9f5TRAKsXwepUII72Awkk04Zqi3trf5BpNac2s+C6\\n\" +\n+ \"Ey4eAnouWzI5Rg0VDDmt3GzxXPaY6wga9afUSb9z4oJwyW1MiE6ENjfNbdmsUvdX\\n\" +\n+ \"CriRNDviO71CnWrLJA44maKDosubfUtC9Ac9BaRjutFyn1UExE9xAgMBAAGjUzBR\\n\" +\n+ \"MB0GA1UdDgQWBBR4R5i1kWMxzzdQ3TdgI/MuNLChSDAfBgNVHSMEGDAWgBR4R5i1\\n\" +\n+ \"kWMxzzdQ3TdgI/MuNLChSDAPBgNVHRMBAf8EBTADAQH/MA0GCSqGSIb3DQEBCwUA\\n\" +\n+ \"A4IBAQAacI/f9YFVTUCGXfh/FCVBQI20bgOs9D6IpIhN8L5kEnY6Ox5t00b9G5Bz\\n\" +\n+ \"64alK3WMR3DdhTEpufX8IMFpMlme/JnnOQXkfmIvzbev4iIKxcKFvS8qNXav8PVx\\n\" +\n+ \"wDApuzgxEq/XZCtFXhDS3q1jGRmlOr+MtQdCNQuJmxy7kOoFPY+UYjhSXTZVrCyF\\n\" +\n+ \"I0LYJQfcZ69bYXd+5h1U3UsN4ZvsBgnrz/IhhadaCtTZVtvyr/uzHiJpqT99VO9/\\n\" +\n+ \"7lwh2zL8ihPyOUVDjdYxYyCi+BHLRB+udnVAfo7t3fbxMi1gV9xVcYaqTJgSArsY\\n\" +\n+ \"M8mxv8p5mhTa8TJknzs4V3Dm+PHs\\n\" +\n+ \"-----END CERTIFICATE-----\";\npublic static final String SAML_ASSERTION_CONSUMER_URL_SALES_POST_ENC = AUTH_SERVER_SCHEME + \"://localhost:\" + (AUTH_SERVER_SSL_REQUIRED ? AUTH_SERVER_PORT : 8080) + \"/sales-post-enc/saml\";\npublic static final String SAML_CLIENT_ID_SALES_POST_ENC = \"http://localhost:8280/sales-post-enc/\";\npublic static final String SAML_CLIENT_SALES_POST_ENC_PRIVATE_KEY = \"MIICXQIBAAKBgQDb7kwJPkGdU34hicplwfp6/WmNcaLh94TSc7Jyr9Undp5pkyLgb0DE7EIE+6kSs4LsqCb8HDkB0nLD5DXbBJFd8n0WGoKstelvtg6FtVJMnwN7k7yZbfkPECWH9zF70VeOo9vbzrApNRnct8ZhH5fbflRB4JMA9L9R+LbURdoSKQIDAQABAoGBANtbZG9bruoSGp2s5zhzLzd4hczT6Jfk3o9hYjzNb5Z60ymN3Z1omXtQAdEiiNHkRdNxK+EM7TcKBfmoJqcaeTkW8cksVEAW23ip8W9/XsLqmbU2mRrJiKa+KQNDSHqJi1VGyimi4DDApcaqRZcaKDFXg2KDr/Qt5JFD/o9IIIPZAkEA+ZENdBIlpbUfkJh6Ln+bUTss/FZ1FsrcPZWu13rChRMrsmXsfzu9kZUWdUeQ2Dj5AoW2Q7L/cqdGXS7Mm5XhcwJBAOGZq9axJY5YhKrsksvYRLhQbStmGu5LG75suF+rc/44sFq+aQM7+oeRr4VY88Mvz7mk4esdfnk7ae+cCazqJvMCQQCx1L1cZw3yfRSn6S6u8XjQMjWE/WpjulujeoRiwPPY9WcesOgLZZtYIH8nRL6ehEJTnMnahbLmlPFbttxPRUanAkA11MtSIVcKzkhp2KV2ipZrPJWwI18NuVJXb+3WtjypTrGWFZVNNkSjkLnHIeCYlJIGhDd8OL9zAiBXEm6kmgLNAkBWAg0tK2hCjvzsaA505gWQb4X56uKWdb0IzN+fOLB3Qt7+fLqbVQNQoNGzqey6B4MoS1fUKAStqdGTFYPG/+9t\";\n"
},
{
"change_type": "MODIFY",
"old_path": "testsuite/integration-arquillian/tests/base/testsuites/fips-suite",
"new_path": "testsuite/integration-arquillian/tests/base/testsuites/fips-suite",
"diff": "@@ -21,3 +21,4 @@ KcSamlEncryptedIdTest\nKcSamlSignedBrokerTest\nKcSamlSpDescriptorTest\nKerberosLdapTest\n+TrustStoreEmailTest\n"
}
] | Java | Apache License 2.0 | keycloak/keycloak | Fix remaining failing tests with BCFIPS approved mode (#16699)
* Fix remaining failing tests with BCFIPS approved mode
Closes #16698 |
339,410 | 30.01.2023 11:23:14 | -3,600 | c6aba2e3de5f0e6263cec9c367bae6dd45e652dc | Make LockAcquiringTimeoutException a RuntimeException
Closes | [
{
"change_type": "MODIFY",
"old_path": "model/map-hot-rod/src/main/java/org/keycloak/models/map/storage/hotRod/connections/DefaultHotRodConnectionProviderFactory.java",
"new_path": "model/map-hot-rod/src/main/java/org/keycloak/models/map/storage/hotRod/connections/DefaultHotRodConnectionProviderFactory.java",
"diff": "*/\npackage org.keycloak.models.map.storage.hotRod.connections;\n-import org.infinispan.client.hotrod.Flag;\nimport org.infinispan.client.hotrod.RemoteCache;\nimport org.infinispan.client.hotrod.RemoteCacheManager;\nimport org.infinispan.client.hotrod.RemoteCacheManagerAdmin;\n@@ -29,7 +28,6 @@ import org.infinispan.query.remote.client.ProtobufMetadataManagerConstants;\nimport org.jboss.logging.Logger;\nimport org.keycloak.models.KeycloakSession;\nimport org.keycloak.models.KeycloakSessionFactory;\n-import org.keycloak.models.locking.LockAcquiringTimeoutException;\nimport org.keycloak.models.map.storage.hotRod.locking.HotRodLocksUtils;\nimport org.keycloak.models.map.storage.hotRod.common.HotRodEntityDescriptor;\nimport org.keycloak.models.map.storage.hotRod.common.CommonPrimitivesProtoSchemaInitializer;\n@@ -155,8 +153,6 @@ public class DefaultHotRodConnectionProviderFactory implements HotRodConnectionP\n}\nLOG.infof(\"HotRod client configuration was successful.\");\n- } catch (LockAcquiringTimeoutException e) {\n- throw new RuntimeException(e);\n} finally {\nif (!HotRodLocksUtils.removeWithInstanceIdentifier(locksCache, HOT_ROD_INIT_LOCK_NAME)) {\nthrow new RuntimeException(\"Cannot release HotRod init lock\");\n"
},
{
"change_type": "MODIFY",
"old_path": "model/map-hot-rod/src/main/java/org/keycloak/models/map/storage/hotRod/locking/HotRodGlobalLockProvider.java",
"new_path": "model/map-hot-rod/src/main/java/org/keycloak/models/map/storage/hotRod/locking/HotRodGlobalLockProvider.java",
"diff": "package org.keycloak.models.map.storage.hotRod.locking;\n-import org.infinispan.client.hotrod.Flag;\nimport org.infinispan.client.hotrod.RemoteCache;\nimport org.jboss.logging.Logger;\nimport org.keycloak.models.KeycloakSession;\n"
},
{
"change_type": "MODIFY",
"old_path": "model/map-jpa/src/main/java/org/keycloak/models/map/storage/jpa/JpaMapStorageProviderFactory.java",
"new_path": "model/map-jpa/src/main/java/org/keycloak/models/map/storage/jpa/JpaMapStorageProviderFactory.java",
"diff": "@@ -76,7 +76,6 @@ import org.keycloak.models.UserLoginFailureModel;\nimport org.keycloak.models.UserModel;\nimport org.keycloak.models.UserSessionModel;\nimport org.keycloak.models.locking.GlobalLockProvider;\n-import org.keycloak.models.locking.LockAcquiringTimeoutException;\nimport org.keycloak.models.map.client.MapProtocolMapperEntity;\nimport org.keycloak.models.map.client.MapProtocolMapperEntityImpl;\nimport org.keycloak.models.map.common.DeepCloner;\n@@ -516,13 +515,9 @@ public class JpaMapStorageProviderFactory implements\n}\nprivate void update(Class<?> modelType, Connection connection, KeycloakSession session) {\n- try {\nsession.getProvider(GlobalLockProvider.class).withLock(modelType.getName(), lockedSession -> {\nlockedSession.getProvider(MapJpaUpdaterProvider.class).update(modelType, connection, config.get(\"schema\"));\nreturn null;\n});\n- } catch (LockAcquiringTimeoutException e) {\n- throw new RuntimeException(\"Acquiring \" + modelType.getName() + \" failed.\", e);\n- }\n}\n}\n"
},
{
"change_type": "MODIFY",
"old_path": "quarkus/runtime/src/main/java/org/keycloak/quarkus/runtime/storage/legacy/database/LegacyJpaConnectionProviderFactory.java",
"new_path": "quarkus/runtime/src/main/java/org/keycloak/quarkus/runtime/storage/legacy/database/LegacyJpaConnectionProviderFactory.java",
"diff": "@@ -52,7 +52,6 @@ import org.keycloak.models.KeycloakSession;\nimport org.keycloak.models.KeycloakSessionFactory;\nimport org.keycloak.models.dblock.DBLockGlobalLockProvider;\nimport org.keycloak.models.locking.GlobalLockProvider;\n-import org.keycloak.models.locking.LockAcquiringTimeoutException;\nimport org.keycloak.provider.EnvironmentDependentProviderFactory;\nimport org.keycloak.provider.ProviderConfigProperty;\nimport org.keycloak.provider.ProviderConfigurationBuilder;\n@@ -290,27 +289,19 @@ public class LegacyJpaConnectionProviderFactory extends AbstractJpaConnectionPro\nprivate void update(Connection connection, String schema, KeycloakSession session, JpaUpdaterProvider updater) {\nGlobalLockProvider globalLock = session.getProvider(GlobalLockProvider.class);\n- try {\nglobalLock.withLock(DBLockGlobalLockProvider.DATABASE, innerSession -> {\nupdater.update(connection, schema);\nreturn null;\n});\n- } catch (LockAcquiringTimeoutException e) {\n- throw new RuntimeException(\"Acquiring database failed.\", e);\n- }\n}\nprivate void export(Connection connection, String schema, File databaseUpdateFile, KeycloakSession session,\nJpaUpdaterProvider updater) {\nGlobalLockProvider globalLock = session.getProvider(GlobalLockProvider.class);\n- try {\nglobalLock.withLock(DBLockGlobalLockProvider.DATABASE, innerSession -> {\nupdater.export(connection, schema, databaseUpdateFile);\nreturn null;\n});\n- } catch (LockAcquiringTimeoutException e) {\n- throw new RuntimeException(\"Acquiring database failed.\", e);\n- }\n}\n@Override\n"
},
{
"change_type": "MODIFY",
"old_path": "server-spi-private/src/main/java/org/keycloak/models/locking/LockAcquiringTimeoutException.java",
"new_path": "server-spi-private/src/main/java/org/keycloak/models/locking/LockAcquiringTimeoutException.java",
"diff": "@@ -22,9 +22,7 @@ import java.time.Instant;\n/**\n* This exception is thrown when acquiring a lock times out.\n*/\n-public final class LockAcquiringTimeoutException extends Exception {\n-\n- private LockAcquiringTimeoutException() {}\n+public final class LockAcquiringTimeoutException extends RuntimeException {\n/**\n*\n"
},
{
"change_type": "MODIFY",
"old_path": "services/src/main/java/org/keycloak/services/resources/KeycloakApplication.java",
"new_path": "services/src/main/java/org/keycloak/services/resources/KeycloakApplication.java",
"diff": "@@ -33,7 +33,6 @@ import org.keycloak.models.RealmModel;\nimport org.keycloak.models.UserModel;\nimport org.keycloak.models.UserProvider;\nimport org.keycloak.models.locking.GlobalLockProvider;\n-import org.keycloak.models.locking.LockAcquiringTimeoutException;\nimport org.keycloak.models.utils.KeycloakModelUtils;\nimport org.keycloak.models.utils.PostMigrationEvent;\nimport org.keycloak.models.utils.RepresentationToModel;\n@@ -143,11 +142,7 @@ public class KeycloakApplication extends Application {\n@Override\npublic void run(KeycloakSession session) {\nGlobalLockProvider locks = session.getProvider(GlobalLockProvider.class);\n- try {\nexportImportManager[0] = locks.withLock(GlobalLockProvider.Constants.KEYCLOAK_BOOT, innerSession -> bootstrap());\n- } catch (LockAcquiringTimeoutException e) {\n- throw new RuntimeException(\"Acquiring keycloak-boot lock failed.\", e);\n- }\n}\n});\n"
},
{
"change_type": "MODIFY",
"old_path": "testsuite/model/src/test/java/org/keycloak/testsuite/model/globalLock/GlobalLocksTest.java",
"new_path": "testsuite/model/src/test/java/org/keycloak/testsuite/model/globalLock/GlobalLocksTest.java",
"diff": "@@ -67,7 +67,6 @@ public class GlobalLocksTest extends KeycloakModelTest {\nGlobalLockProvider lockProvider = s.getProvider(GlobalLockProvider.class);\nLOG.infof(\"Iteration %d entered session\", index);\n- try {\nlockProvider.withLock(LOCK_NAME, Duration.ofSeconds(60), innerSession -> {\nLOG.infof(\"Iteration %d entered locked block\", index);\n@@ -84,9 +83,6 @@ public class GlobalLocksTest extends KeycloakModelTest {\nresultingList.add(c);\nreturn null;\n});\n- } catch (LockAcquiringTimeoutException e) {\n- throw new RuntimeException(e);\n- }\n}));\nassertThat(resultingList, hasSize(numIterations));\n@@ -145,7 +141,6 @@ public class GlobalLocksTest extends KeycloakModelTest {\n.forEach(i ->\ninComittedTransaction(s -> {\nGlobalLockProvider lockProvider = s.getProvider(GlobalLockProvider.class);\n- try {\nlockProvider.withLock(\"LOCK_\" + i, session -> {\nlocksAcquired.countDown();\ntry {\n@@ -156,9 +151,6 @@ public class GlobalLocksTest extends KeycloakModelTest {\n}\nreturn null;\n});\n- } catch (LockAcquiringTimeoutException e) {\n- throw new RuntimeException(e);\n- }\n})\n);\n});\n"
}
] | Java | Apache License 2.0 | keycloak/keycloak | Make LockAcquiringTimeoutException a RuntimeException
Closes #16690 |
339,144 | 30.01.2023 16:50:40 | -3,600 | 20a7a5acdb93d0bd624af0db0dd524824dcd677e | fix: consider identity provider models from third-party packages | [
{
"change_type": "MODIFY",
"old_path": "model/jpa/src/main/java/org/keycloak/models/jpa/RealmAdapter.java",
"new_path": "model/jpa/src/main/java/org/keycloak/models/jpa/RealmAdapter.java",
"diff": "@@ -19,6 +19,9 @@ package org.keycloak.models.jpa;\nimport org.keycloak.Config;\nimport org.jboss.logging.Logger;\n+import org.keycloak.broker.provider.IdentityProvider;\n+import org.keycloak.broker.provider.IdentityProviderFactory;\n+import org.keycloak.broker.social.SocialIdentityProvider;\nimport org.keycloak.common.enums.SslRequired;\nimport org.keycloak.common.util.MultivaluedHashMap;\nimport org.keycloak.common.util.Time;\n@@ -1197,7 +1200,7 @@ public class RealmAdapter implements LegacyRealmModel, JpaModel<RealmEntity> {\n}\nprivate IdentityProviderModel entityToModel(IdentityProviderEntity entity) {\n- IdentityProviderModel identityProviderModel = new IdentityProviderModel();\n+ IdentityProviderModel identityProviderModel = getModelFromProviderFactory(entity.getProviderId());\nidentityProviderModel.setProviderId(entity.getProviderId());\nidentityProviderModel.setAlias(entity.getAlias());\nidentityProviderModel.setDisplayName(entity.getDisplayName());\n@@ -1218,6 +1221,21 @@ public class RealmAdapter implements LegacyRealmModel, JpaModel<RealmEntity> {\nreturn identityProviderModel;\n}\n+ private IdentityProviderModel getModelFromProviderFactory(String providerId) {\n+ Optional<IdentityProviderFactory> factory = Stream.concat(session.getKeycloakSessionFactory().getProviderFactoriesStream(IdentityProvider.class),\n+ session.getKeycloakSessionFactory().getProviderFactoriesStream(SocialIdentityProvider.class))\n+ .filter(providerFactory -> Objects.equals(providerFactory.getId(), providerId))\n+ .map(IdentityProviderFactory.class::cast)\n+ .findFirst();\n+\n+ if (factory.isPresent()) {\n+ return factory.get().createConfig();\n+ } else {\n+ logger.warn(\"Couldn't find a suitable identity provider factory for \" + providerId);\n+ return new IdentityProviderModel();\n+ }\n+ }\n+\n@Override\npublic IdentityProviderModel getIdentityProviderByAlias(String alias) {\nreturn getIdentityProvidersStream()\n"
},
{
"change_type": "MODIFY",
"old_path": "server-spi/src/main/java/org/keycloak/models/IdentityProviderModel.java",
"new_path": "server-spi/src/main/java/org/keycloak/models/IdentityProviderModel.java",
"diff": "@@ -70,6 +70,8 @@ public class IdentityProviderModel implements Serializable {\nprivate String displayName;\n+ private String displayIconClasses;\n+\nprivate IdentityProviderSyncMode syncMode;\n/**\n@@ -96,6 +98,7 @@ public class IdentityProviderModel implements Serializable {\nthis.addReadTokenRoleOnCreate = model.addReadTokenRoleOnCreate;\nthis.firstBrokerLoginFlowId = model.getFirstBrokerLoginFlowId();\nthis.postBrokerLoginFlowId = model.getPostBrokerLoginFlowId();\n+ this.displayIconClasses = model.getDisplayIconClasses();\n}\n}\n@@ -206,7 +209,7 @@ public class IdentityProviderModel implements Serializable {\n}\npublic String getDisplayIconClasses() {\n- return null;\n+ return displayIconClasses;\n}\n/**\n"
}
] | Java | Apache License 2.0 | keycloak/keycloak | fix: consider identity provider models from third-party packages |
339,465 | 02.02.2023 08:34:50 | -3,600 | 51bed81814574d254c07f091936483cf97716fa7 | Fixes for OOB endpoint and KeycloakSanitizer | [
{
"change_type": "MODIFY",
"old_path": "services/src/main/java/org/keycloak/forms/login/freemarker/FreeMarkerLoginFormsProvider.java",
"new_path": "services/src/main/java/org/keycloak/forms/login/freemarker/FreeMarkerLoginFormsProvider.java",
"diff": "@@ -275,6 +275,7 @@ public class FreeMarkerLoginFormsProvider implements LoginFormsProvider {\nnew OAuthGrantBean(accessCode, client, clientScopesRequested));\nbreak;\ncase CODE:\n+ attributes.remove(\"message\"); // No need to include \"message\" attribute as error is included in separate field anyway\nattributes.put(OAuth2Constants.CODE, new CodeBean(accessCode, messageType == MessageType.ERROR ? getFirstMessageUnformatted() : null));\nbreak;\ncase X509_CONFIRM:\n"
},
{
"change_type": "MODIFY",
"old_path": "services/src/main/java/org/keycloak/theme/KeycloakSanitizerMethod.java",
"new_path": "services/src/main/java/org/keycloak/theme/KeycloakSanitizerMethod.java",
"diff": "@@ -19,6 +19,7 @@ package org.keycloak.theme;\nimport freemarker.template.TemplateMethodModelEx;\nimport freemarker.template.TemplateModelException;\n+import org.owasp.html.Encoding;\nimport java.util.List;\nimport java.util.regex.Matcher;\n@@ -40,11 +41,36 @@ public class KeycloakSanitizerMethod implements TemplateMethodModelEx {\n}\nString html = list.get(0).toString();\n+\n+ html = decodeHtmlFull(html);\n+\nString sanitized = KeycloakSanitizerPolicy.POLICY_DEFINITION.sanitize(html);\nreturn fixURLs(sanitized);\n}\n+\n+ // Fully decode HTML. Assume it can be encoded multiple times\n+ private String decodeHtmlFull(String html) {\n+ if (html == null) return null;\n+\n+ int MAX_DECODING_COUNT = 5; // Max count of attempts for decoding HTML (in case it was encoded multiple times)\n+ String decodedHtml;\n+\n+ for (int i = 0; i < MAX_DECODING_COUNT; i++) {\n+ decodedHtml = Encoding.decodeHtml(html);\n+ if (decodedHtml.equals(html)) {\n+ // HTML is decoded. We can return it\n+ return html;\n+ } else {\n+ // Next attempt\n+ html = decodedHtml;\n+ }\n+ }\n+\n+ return \"\";\n+ }\n+\nprivate String fixURLs(String msg) {\nMatcher matcher = HREF_PATTERN.matcher(msg);\nif (matcher.find()) {\n"
},
{
"change_type": "MODIFY",
"old_path": "services/src/test/java/org/keycloak/theme/KeycloakSanitizerTest.java",
"new_path": "services/src/test/java/org/keycloak/theme/KeycloakSanitizerTest.java",
"diff": "@@ -73,6 +73,22 @@ public class KeycloakSanitizerTest {\nhtml.set(0, \"<p><a href=\\\"javascript:alert('hello!');\\\">link</a></p>\");\nassertResult(\"<p>link</p>\", html);\n+ html.set(0, \"<p><a href=\\\"javascript:alert(document.domain);\\\">link</a></p>\");\n+ assertResult(\"<p>link</p>\", html);\n+\n+ html.set(0, \"<p><a href=\\\"javascript:alert(document.domain);\\\">link</a></p>\");\n+ assertResult(\"<p>link</p>\", html);\n+\n+ // Effectively same as previous case, but with \\0 character added\n+ html.set(0, \"<p><a href=\\\"javascript&\\0colon;alert(document.domain);\\\">link</a></p>\");\n+ assertResult(\"<p>link</p>\", html);\n+\n+ html.set(0, \"<p><a href=\\\"javascript&amp;\\0colon;alert(document.domain);\\\">link</a></p>\");\n+ assertResult(\"<p>link</p>\", html);\n+\n+ html.set(0, \"<p><a href=\\\"javascript&amp;amp;amp;amp;amp;amp;amp;amp;amp;amp;\\0colon;alert(document.domain);\\\">link</a></p>\");\n+ assertResult(\"\", html);\n+\nhtml.set(0, \"<p><a href=\\\"https://localhost?key=123&msg=abc\\\">link</a></p>\");\nassertResult(\"<p><a href=\\\"https://localhost?key=123&msg=abc\\\" rel=\\\"nofollow\\\">link</a></p>\", html);\n"
},
{
"change_type": "ADD",
"old_path": null,
"new_path": "testsuite/integration-arquillian/tests/base/src/main/java/org/keycloak/testsuite/pages/InstalledAppRedirectPage.java",
"diff": "+/*\n+ * Copyright 2022 Red Hat, Inc. and/or its affiliates\n+ * and other contributors as indicated by the @author tags.\n+ *\n+ * Licensed under the Apache License, Version 2.0 (the \"License\");\n+ * you may not use this file except in compliance with the License.\n+ * You may obtain a copy of the License at\n+ *\n+ * http://www.apache.org/licenses/LICENSE-2.0\n+ *\n+ * Unless required by applicable law or agreed to in writing, software\n+ * distributed under the License is distributed on an \"AS IS\" BASIS,\n+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n+ *\n+ * See the License for the specific language governing permissions and\n+ * limitations under the License.\n+ *\n+ */\n+\n+package org.keycloak.testsuite.pages;\n+\n+import java.net.URI;\n+import java.net.URISyntaxException;\n+\n+import org.junit.Assert;\n+import org.keycloak.OAuth2Constants;\n+import org.keycloak.common.util.KeycloakUriBuilder;\n+import org.keycloak.services.Urls;\n+import org.openqa.selenium.By;\n+import org.openqa.selenium.NoSuchElementException;\n+import org.openqa.selenium.WebElement;\n+import org.openqa.selenium.support.FindBy;\n+\n+/**\n+ * Page represented by code.ftl. It is used by \"Installed applications\" (KeycloakInstalled)\n+ *\n+ * @author <a href=\"mailto:mposolda@redhat.com\">Marek Posolda</a>\n+ */\n+public class InstalledAppRedirectPage extends AbstractPage {\n+\n+ @FindBy(id = \"code\")\n+ private WebElement code;\n+\n+ @FindBy(id = \"kc-page-title\")\n+ private WebElement pageTitle;\n+\n+ @FindBy(className = \"alert-error\")\n+ private WebElement errorBox;\n+\n+ @Override\n+ public void open() {\n+ throw new UnsupportedOperationException(\"Use method: open(code, error, errorDescription)\");\n+ }\n+\n+\n+ public void open(String realmName, String code, String error, String errorDescription) {\n+ try {\n+ KeycloakUriBuilder kcUriBuilder = KeycloakUriBuilder.fromUri(Urls.realmInstalledAppUrnCallback(new URI(oauth.AUTH_SERVER_ROOT), realmName));\n+ if (code != null) {\n+ kcUriBuilder.queryParam(OAuth2Constants.CODE, code);\n+ }\n+ if (error != null) {\n+ kcUriBuilder.queryParam(OAuth2Constants.ERROR, error);\n+ }\n+ if (errorDescription != null) {\n+ kcUriBuilder.queryParam(OAuth2Constants.ERROR_DESCRIPTION, errorDescription);\n+ }\n+ String oobEndpointUri = kcUriBuilder.build().toString();\n+ driver.navigate().to(oobEndpointUri);\n+ } catch (URISyntaxException use) {\n+ throw new IllegalArgumentException(use);\n+ }\n+ }\n+\n+ @Override\n+ public boolean isCurrent() {\n+ throw new UnsupportedOperationException(\"Use method 'isCurrentExpectSuccess' or 'isCurrentExpectError'\");\n+ }\n+\n+\n+ public String getSuccessCode() {\n+ Assert.assertEquals(\"Success code\", getPageTitleText());\n+ return code.getAttribute(\"value\");\n+ }\n+\n+ public String getPageTitleText() {\n+ return pageTitle.getText();\n+ }\n+\n+ // Check if link is present inside title or error box\n+ public void assertLinkBackToApplicationNotPresent() {\n+ try {\n+ pageTitle.findElement(By.tagName(\"a\"));\n+ throw new AssertionError(\"Link was present inside title\");\n+ } catch (NoSuchElementException nsee) {\n+ // Ignore\n+ }\n+\n+ try {\n+ errorBox.findElement(By.tagName(\"a\"));\n+ throw new AssertionError(\"Link was present inside error box\");\n+ } catch (NoSuchElementException nsee) {\n+ // Ignore\n+ }\n+\n+ }\n+}\n"
},
{
"change_type": "MODIFY",
"old_path": "testsuite/integration-arquillian/tests/base/src/test/java/org/keycloak/testsuite/error/EscapeErrorPageTest.java",
"new_path": "testsuite/integration-arquillian/tests/base/src/test/java/org/keycloak/testsuite/error/EscapeErrorPageTest.java",
"diff": "@@ -56,12 +56,12 @@ public class EscapeErrorPageTest extends AbstractKeycloakTest {\n@Test\npublic void ampersandEscape() {\n- checkMessage(\"<img src="something">\", \"<img src=\\\"something\\\">\");\n+ checkMessage(\"<img src="something">\", \"\");\n}\n@Test\npublic void hexEscape() {\n- checkMessage(\"<img src=something/>\", \"<img src=something/>\");\n+ checkMessage(\"<img src=something/>\", \"\");\n}\n@Test\n"
},
{
"change_type": "MODIFY",
"old_path": "testsuite/integration-arquillian/tests/base/src/test/java/org/keycloak/testsuite/oauth/AuthorizationCodeTest.java",
"new_path": "testsuite/integration-arquillian/tests/base/src/test/java/org/keycloak/testsuite/oauth/AuthorizationCodeTest.java",
"diff": "@@ -31,7 +31,7 @@ import org.keycloak.representations.idm.RealmRepresentation;\nimport org.keycloak.testsuite.AbstractKeycloakTest;\nimport org.keycloak.testsuite.AssertEvents;\nimport org.keycloak.testsuite.pages.ErrorPage;\n-import org.keycloak.testsuite.pages.PageUtils;\n+import org.keycloak.testsuite.pages.InstalledAppRedirectPage;\nimport org.keycloak.testsuite.util.ClientManager;\nimport org.keycloak.testsuite.util.OAuthClient;\nimport org.openqa.selenium.By;\n@@ -58,6 +58,9 @@ public class AuthorizationCodeTest extends AbstractKeycloakTest {\n@Page\nprivate ErrorPage errorPage;\n+ @Page\n+ private InstalledAppRedirectPage installedAppPage;\n+\n@Override\npublic void addTestRealms(List<RealmRepresentation> testRealms) {\nRealmRepresentation realmRepresentation = loadJson(getClass().getResourceAsStream(\"/testrealm.json\"), RealmRepresentation.class);\n@@ -92,16 +95,30 @@ public class AuthorizationCodeTest extends AbstractKeycloakTest {\noauth.doLogin(\"test-user@localhost\", \"password\");\n- String title = PageUtils.getPageTitle(driver);\n- Assert.assertEquals(\"Success code\", title);\n-\n- driver.findElement(By.id(OAuth2Constants.CODE)).getAttribute(\"value\");\n+ installedAppPage.getSuccessCode();\nevents.expectLogin().detail(Details.REDIRECT_URI, oauth.AUTH_SERVER_ROOT + \"/realms/test/protocol/openid-connect/oauth/oob\").assertEvent().getDetails().get(Details.CODE_ID);\nClientManager.realm(adminClient.realm(\"test\")).clientId(\"test-app\").removeRedirectUris(Constants.INSTALLED_APP_URN);\n}\n+ @Test\n+ public void authorizationRequestInstalledAppErrors() throws IOException {\n+ String error = \"<p><a href=\\\"javascript&colon;alert(document.domain);\\\">Back to application</a></p>\";\n+ installedAppPage.open(\"test\", null, error, null);\n+\n+ // Assert text escaped and not \"a\" link present\n+ installedAppPage.assertLinkBackToApplicationNotPresent();\n+ Assert.assertEquals(\"Error code: <p>Back to application</p>\", installedAppPage.getPageTitleText());\n+\n+ error = \"<p><a href=\\\"http://foo.com\\\">Back to application</a></p>\";\n+ installedAppPage.open(\"test\", null, error, null);\n+\n+ // In this case, link is not sanitized as it is valid link, however it is escaped and not shown as a link\n+ installedAppPage.assertLinkBackToApplicationNotPresent();\n+ Assert.assertEquals(\"Error code: <p><a href=\\\"http://foo.com\\\" rel=\\\"nofollow\\\">Back to application</a></p>\", installedAppPage.getPageTitleText());\n+ }\n+\n@Test\npublic void authorizationValidRedirectUri() throws IOException {\nClientManager.realm(adminClient.realm(\"test\")).clientId(\"test-app\").addRedirectUris(oauth.getRedirectUri());\n"
},
{
"change_type": "MODIFY",
"old_path": "themes/src/main/resources/theme/base/login/code.ftl",
"new_path": "themes/src/main/resources/theme/base/login/code.ftl",
"diff": "<#if code.success>\n${msg(\"codeSuccessTitle\")}\n<#else>\n- ${msg(\"codeErrorTitle\", code.error)}\n+ ${kcSanitize(msg(\"codeErrorTitle\", code.error))}\n</#if>\n<#elseif section = \"form\">\n<div id=\"kc-code\">\n<p>${msg(\"copyCodeInstruction\")}</p>\n<input id=\"code\" class=\"${properties.kcTextareaClass!}\" value=\"${code.code}\"/>\n<#else>\n- <p id=\"error\">${code.error}</p>\n+ <p id=\"error\">${kcSanitize(code.error)}</p>\n</#if>\n</div>\n</#if>\n"
}
] | Java | Apache License 2.0 | keycloak/keycloak | Fixes for OOB endpoint and KeycloakSanitizer (#16773)
(cherry picked from commit 91ac2fb9dd50808ff5c76d639594ba14a8d0d016) |
339,465 | 03.02.2023 10:09:26 | -3,600 | 0e374c7a450f431bdb66828c73afde1a5d7c7305 | Any tests using PhantomJS failing in some linux environments
closes | [
{
"change_type": "MODIFY",
"old_path": "testsuite/integration-arquillian/pom.xml",
"new_path": "testsuite/integration-arquillian/pom.xml",
"diff": "<dballocator.skip>false</dballocator.skip>\n</properties>\n</profile>\n+\n+ <!-- Workaround for issues related to PhantomJS in some newer linux environment. See for example here for more details https://github.com/nodejs/node/issues/43132 -->\n+ <profile>\n+ <id>phantomjs-openssl-workaround</id>\n+ <activation>\n+ <os>\n+ <family>unix</family>\n+ </os>\n+ </activation>\n+ <build>\n+ <pluginManagement>\n+ <plugins>\n+ <plugin>\n+ <artifactId>maven-surefire-plugin</artifactId>\n+ <configuration>\n+ <environmentVariables>\n+ <OPENSSL_CONF>/dev/null</OPENSSL_CONF>\n+ </environmentVariables>\n+ </configuration>\n+ </plugin>\n+ </plugins>\n+ </pluginManagement>\n+ </build>\n+ </profile>\n</profiles>\n<repositories>\n"
}
] | Java | Apache License 2.0 | keycloak/keycloak | Any tests using PhantomJS failing in some linux environments
closes #16818 |
339,465 | 03.02.2023 12:00:09 | -3,600 | d495f29a4d15a80b26cb9bd64d246605c4d9309f | Support to run BCFIPS approved mode tests on GH actions
Closes | [
{
"change_type": "MODIFY",
"old_path": ".github/workflows/ci.yml",
"new_path": ".github/workflows/ci.yml",
"diff": "@@ -417,6 +417,10 @@ jobs:\nneeds: build\nruns-on: ubuntu-latest\ntimeout-minutes: 45\n+ strategy:\n+ matrix:\n+ mode: [non-strict, strict]\n+ fail-fast: false\nsteps:\n- uses: actions/checkout@v3\n@@ -429,9 +433,12 @@ jobs:\n- name: Run base tests\nrun: |\n+ declare -A PARAMS\n+ PARAMS[\"non-strict\"]=\"\"\n+ PARAMS[\"strict\"]=\"-Dauth.server.fips.mode=strict -Dauth.server.supported.keystore.types=BCFKS -Dauth.server.keystore.type=bcfks -Dauth.server.supported.rsa.key.sizes=2048,4096\"\nTESTS=`testsuite/integration-arquillian/tests/base/testsuites/suite.sh fips`\necho \"Tests: $TESTS\"\n- ./mvnw test -Dsurefire.rerunFailingTestsCount=${{ env.SUREFIRE_RERUN_FAILING_COUNT }} -nsu -B -Pauth-server-quarkus,auth-server-fips140-2 -Dtest=$TESTS -pl testsuite/integration-arquillian/tests/base | misc/log/trimmer.sh\n+ ./mvnw test -Dsurefire.rerunFailingTestsCount=${{ env.SUREFIRE_RERUN_FAILING_COUNT }} -nsu -B -Pauth-server-quarkus,auth-server-fips140-2 ${PARAMS[\"${{ matrix.mode }}\"]} -Dtest=$TESTS -pl testsuite/integration-arquillian/tests/base | misc/log/trimmer.sh\n- name: Upload JVM Heapdumps\nif: always()\n"
}
] | Java | Apache License 2.0 | keycloak/keycloak | Support to run BCFIPS approved mode tests on GH actions
Closes #16440 |
339,303 | 18.01.2023 01:11:23 | 0 | 5db64133b8e14b05d580f04ee142e2fb59bfcffc | Add Attribute to Group Mapper for SAML IDP
Cleansing code as PR Comment
Add test for Advanced Attribute to Group Mapper
Closes | [
{
"change_type": "ADD",
"old_path": null,
"new_path": "services/src/main/java/org/keycloak/broker/saml/mappers/AbstractAttributeToGroupMapper.java",
"diff": "+/*\n+ * Copyright 2023 Red Hat, Inc. and/or its affiliates\n+ * and other contributors as indicated by the @author tags.\n+ *\n+ * Licensed under the Apache License, Version 2.0 (the \"License\");\n+ * you may not use this file except in compliance with the License.\n+ * You may obtain a copy of the License at\n+ *\n+ * http://www.apache.org/licenses/LICENSE-2.0\n+ *\n+ * Unless required by applicable law or agreed to in writing, software\n+ * distributed under the License is distributed on an \"AS IS\" BASIS,\n+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n+ * See the License for the specific language governing permissions and\n+ * limitations under the License.\n+ */\n+package org.keycloak.broker.saml.mappers;\n+\n+import org.jboss.logging.Logger;\n+import org.keycloak.broker.provider.AbstractIdentityProviderMapper;\n+import org.keycloak.broker.provider.BrokeredIdentityContext;\n+import org.keycloak.broker.provider.ConfigConstants;\n+import org.keycloak.models.GroupModel;\n+import org.keycloak.models.IdentityProviderMapperModel;\n+import org.keycloak.models.KeycloakSession;\n+import org.keycloak.models.RealmModel;\n+import org.keycloak.models.UserModel;\n+import org.keycloak.models.utils.KeycloakModelUtils;\n+\n+/**\n+ * Abstract class that handles the logic for importing and updating brokered users for all mappers that map a SAML\n+ * attribute into a {@code Keycloak} group.\n+ *\n+ * @author <a href=\"mailto:denis.bernard@avanade.com\">Denis Bernard</a>,\n+ */\n+public abstract class AbstractAttributeToGroupMapper extends AbstractIdentityProviderMapper {\n+\n+ private static final Logger LOG = Logger.getLogger(AbstractAttributeToGroupMapper.class);\n+\n+\n+ @Override\n+ public void importNewUser(KeycloakSession session, RealmModel realm, UserModel user, IdentityProviderMapperModel mapperModel, BrokeredIdentityContext context) {\n+ GroupModel group = this.getGroup(realm, mapperModel);\n+ if (group == null) {\n+ return;\n+ }\n+\n+ if (this.applies(mapperModel, context)) {\n+ user.joinGroup(group);\n+ }\n+ }\n+\n+ @Override\n+ public void updateBrokeredUser(KeycloakSession session, RealmModel realm, UserModel user, IdentityProviderMapperModel mapperModel, BrokeredIdentityContext context) {\n+ GroupModel group = this.getGroup(realm, mapperModel);\n+ if (group == null) {\n+ return;\n+ }\n+\n+ String groupId = group.getId();\n+ if (!context.hasMapperAssignedGroup(groupId)) {\n+ if (this.applies(mapperModel, context)) {\n+ context.addMapperAssignedGroup(groupId);\n+ user.joinGroup(group);\n+ } else {\n+ user.leaveGroup(group);\n+ }\n+ }\n+ }\n+\n+ /**\n+ * This method must be implemented by subclasses and they must return {@code true} if their mapping can be applied\n+ * (i.e. user has the SAML attribute that should be mapped) or {@code false} otherwise.\n+ *\n+ * @param mapperModel a reference to the {@link IdentityProviderMapperModel}.\n+ * @param context a reference to the {@link BrokeredIdentityContext}.\n+ * @return {@code true} if the mapping can be applied or {@code false} otherwise.\n+ */\n+ protected abstract boolean applies(final IdentityProviderMapperModel mapperModel, final BrokeredIdentityContext context);\n+\n+ /**\n+ * Obtains the {@link GroupModel} corresponding the group configured in the specified\n+ * {@link IdentityProviderMapperModel}.\n+ * If the group doesn't correspond to one of the realm's client group or to one of the realm's group, this method\n+ * returns {@code null}.\n+ *\n+ * @param realm a reference to the realm.\n+ * @param mapperModel a reference to the {@link IdentityProviderMapperModel} containing the configured group.\n+ * @return the {@link GroupModel} that corresponds to the mapper model group or {@code null}, if the group could not be found\n+ */\n+\n+ private GroupModel getGroup(final RealmModel realm, final IdentityProviderMapperModel mapperModel) {\n+ String groupPath = mapperModel.getConfig().get(ConfigConstants.GROUP);\n+ GroupModel group = KeycloakModelUtils.findGroupByPath(realm, groupPath);\n+\n+ if (group == null) {\n+ LOG.warnf(\"Unable to find group by path '%s' referenced by mapper '%s' on realm '%s'.\", groupPath, mapperModel.getName(), realm.getName());\n+ }\n+ return group;\n+ }\n+}\n"
},
{
"change_type": "ADD",
"old_path": null,
"new_path": "services/src/main/java/org/keycloak/broker/saml/mappers/AdvancedAttributeToGroupMapper.java",
"diff": "+/*\n+ * Copyright 2023 Red Hat, Inc. and/or its affiliates\n+ * and other contributors as indicated by the @author tags.\n+ *\n+ * Licensed under the Apache License, Version 2.0 (the \"License\");\n+ * you may not use this file except in compliance with the License.\n+ * You may obtain a copy of the License at\n+ *\n+ * http://www.apache.org/licenses/LICENSE-2.0\n+ *\n+ * Unless required by applicable law or agreed to in writing, software\n+ * distributed under the License is distributed on an \"AS IS\" BASIS,\n+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n+ * See the License for the specific language governing permissions and\n+ * limitations under the License.\n+ */\n+\n+package org.keycloak.broker.saml.mappers;\n+\n+\n+import org.keycloak.broker.provider.BrokeredIdentityContext;\n+import org.keycloak.broker.provider.ConfigConstants;\n+import org.keycloak.broker.saml.SAMLEndpoint;\n+import org.keycloak.broker.saml.SAMLIdentityProviderFactory;\n+import org.keycloak.dom.saml.v2.assertion.AssertionType;\n+import org.keycloak.dom.saml.v2.assertion.AttributeStatementType;\n+import org.keycloak.models.IdentityProviderMapperModel;\n+import org.keycloak.models.IdentityProviderSyncMode;\n+import org.keycloak.provider.ProviderConfigProperty;\n+\n+import java.util.ArrayList;\n+import java.util.Arrays;\n+import java.util.HashSet;\n+import java.util.List;\n+import java.util.Map;\n+import java.util.Set;\n+import java.util.stream.Collectors;\n+\n+import static org.keycloak.utils.RegexUtils.valueMatchesRegex;\n+\n+/**\n+ * @author <a href=\"mailto:denis.bernard@avanade.com\">Denis Bernard</a>\n+ */\n+public class AdvancedAttributeToGroupMapper extends AbstractAttributeToGroupMapper {\n+\n+ public static final String PROVIDER_ID = \"saml-advanced-group-idp-mapper\";\n+ public static final String ATTRIBUTE_PROPERTY_NAME = \"attributes\";\n+ public static final String ARE_ATTRIBUTE_VALUES_REGEX_PROPERTY_NAME = \"are.attribute.values.regex\";\n+\n+ private static final Set<IdentityProviderSyncMode> IDENTITY_PROVIDER_SYNC_MODES = new HashSet<>(Arrays.asList(IdentityProviderSyncMode.values()));\n+\n+ public static final String[] COMPATIBLE_PROVIDERS = {\n+ SAMLIdentityProviderFactory.PROVIDER_ID\n+ };\n+\n+ private static final List<ProviderConfigProperty> configProperties =\n+ new ArrayList<>();\n+\n+ static {\n+ ProviderConfigProperty attributeMappingProperty = new ProviderConfigProperty();\n+ attributeMappingProperty.setName(ATTRIBUTE_PROPERTY_NAME);\n+ attributeMappingProperty.setLabel(\"Attributes\");\n+ attributeMappingProperty.setHelpText(\"Name and value of the attributes to search for in token. You can reference nested attributes using a '.', i.e. 'address.locality'. To use dot (.) literally, escape it with backslash (\\\\.)\");\n+ attributeMappingProperty.setType(ProviderConfigProperty.MAP_TYPE);\n+ configProperties.add(attributeMappingProperty);\n+\n+ ProviderConfigProperty isAttributeRegexProperty = new ProviderConfigProperty();\n+ isAttributeRegexProperty.setName(ARE_ATTRIBUTE_VALUES_REGEX_PROPERTY_NAME);\n+ isAttributeRegexProperty.setLabel(\"Regex Attribute Values\");\n+ isAttributeRegexProperty.setHelpText(\"If enabled attribute values are interpreted as regular expressions.\");\n+ isAttributeRegexProperty.setType(ProviderConfigProperty.BOOLEAN_TYPE);\n+ configProperties.add(isAttributeRegexProperty);\n+\n+ ProviderConfigProperty groupProperty = new ProviderConfigProperty();\n+ groupProperty.setName(ConfigConstants.GROUP);\n+ groupProperty.setLabel(\"Group\");\n+ groupProperty.setHelpText(\"Group to assign the user to if attribute is present.\");\n+ groupProperty.setType(ProviderConfigProperty.GROUP_TYPE);\n+ configProperties.add(groupProperty);\n+ }\n+\n+ @Override\n+ public boolean supportsSyncMode(IdentityProviderSyncMode syncMode) {\n+ return IDENTITY_PROVIDER_SYNC_MODES.contains(syncMode);\n+ }\n+\n+ @Override\n+ public List<ProviderConfigProperty> getConfigProperties() {\n+ return configProperties;\n+ }\n+\n+ @Override\n+ public String getId() {\n+ return PROVIDER_ID;\n+ }\n+\n+ @Override\n+ public String[] getCompatibleProviders() {\n+ return COMPATIBLE_PROVIDERS;\n+ }\n+\n+ @Override\n+ public String getDisplayCategory() {\n+ return \"Group Importer\";\n+ }\n+\n+ @Override\n+ public String getDisplayType() {\n+ return \"Advanced Attribute to Group\";\n+ }\n+\n+ @Override\n+ public String getHelpText() {\n+ return \"If all attributes exists, assign the user to the specified group.\";\n+ }\n+\n+ protected boolean applies(final IdentityProviderMapperModel mapperModel, final BrokeredIdentityContext context) {\n+ Map<String, String> attributes = mapperModel.getConfigMap(ATTRIBUTE_PROPERTY_NAME);\n+ boolean areAttributeValuesRegexes = Boolean.parseBoolean(mapperModel.getConfig().get(ARE_ATTRIBUTE_VALUES_REGEX_PROPERTY_NAME));\n+\n+ AssertionType assertion = (AssertionType) context.getContextData().get(SAMLEndpoint.SAML_ASSERTION);\n+ Set<AttributeStatementType> attributeAssertions = assertion.getAttributeStatements();\n+ if (attributeAssertions == null) {\n+ return false;\n+ }\n+\n+ for (Map.Entry<String, String> attribute : attributes.entrySet()) {\n+ String attributeKey = attribute.getKey();\n+ List<Object> attributeValues = attributeAssertions.stream()\n+ .flatMap(statements -> statements.getAttributes().stream())\n+ .filter(choiceType -> attributeKey.equals(choiceType.getAttribute().getName())\n+ || attributeKey.equals(choiceType.getAttribute().getFriendlyName()))\n+ // Several statements with same name are treated like one with several values\n+ .flatMap(choiceType -> choiceType.getAttribute().getAttributeValue().stream())\n+ .collect(Collectors.toList());\n+\n+ boolean attributeValueMatch = areAttributeValuesRegexes ? valueMatchesRegex(attribute.getValue(), attributeValues) : attributeValues.contains(attribute.getValue());\n+ if (!attributeValueMatch) {\n+ return false;\n+ }\n+ }\n+\n+ return true;\n+ }\n+}\n"
},
{
"change_type": "MODIFY",
"old_path": "services/src/main/resources/META-INF/services/org.keycloak.broker.provider.IdentityProviderMapper",
"new_path": "services/src/main/resources/META-INF/services/org.keycloak.broker.provider.IdentityProviderMapper",
"diff": "@@ -25,6 +25,7 @@ org.keycloak.broker.oidc.mappers.ExternalKeycloakRoleToRoleMapper\norg.keycloak.broker.oidc.mappers.UserAttributeMapper\norg.keycloak.broker.oidc.mappers.UsernameTemplateMapper\norg.keycloak.broker.saml.mappers.AdvancedAttributeToRoleMapper\n+org.keycloak.broker.saml.mappers.AdvancedAttributeToGroupMapper\norg.keycloak.broker.saml.mappers.AttributeToRoleMapper\norg.keycloak.broker.saml.mappers.UserAttributeMapper\norg.keycloak.broker.saml.mappers.XPathAttributeMapper\n"
},
{
"change_type": "MODIFY",
"old_path": "testsuite/integration-arquillian/tests/base/src/test/java/org/keycloak/testsuite/admin/IdentityProviderTest.java",
"new_path": "testsuite/integration-arquillian/tests/base/src/test/java/org/keycloak/testsuite/admin/IdentityProviderTest.java",
"diff": "@@ -567,7 +567,7 @@ public class IdentityProviderTest extends AbstractAdminTest {\ncreate(createRep(\"saml\", \"saml\"));\nprovider = realm.identityProviders().get(\"saml\");\nmapperTypes = provider.getMapperTypes();\n- assertMapperTypes(mapperTypes, \"saml-user-attribute-idp-mapper\", \"saml-role-idp-mapper\", \"saml-username-idp-mapper\", \"saml-advanced-role-idp-mapper\", \"saml-xpath-attribute-idp-mapper\");\n+ assertMapperTypes(mapperTypes, \"saml-user-attribute-idp-mapper\", \"saml-role-idp-mapper\", \"saml-username-idp-mapper\", \"saml-advanced-role-idp-mapper\", \"saml-advanced-group-idp-mapper\", \"saml-xpath-attribute-idp-mapper\");\n}\nprivate void assertMapperTypes(Map<String, IdentityProviderMapperTypeRepresentation> mapperTypes, String ... mapperIds) {\n"
},
{
"change_type": "MODIFY",
"old_path": "testsuite/integration-arquillian/tests/base/src/test/java/org/keycloak/testsuite/broker/AbstractGroupBrokerMapperTest.java",
"new_path": "testsuite/integration-arquillian/tests/base/src/test/java/org/keycloak/testsuite/broker/AbstractGroupBrokerMapperTest.java",
"diff": "/*\n- * Copyright 2022 Red Hat, Inc. and/or its affiliates\n+ * Copyright 2023 Red Hat, Inc. and/or its affiliates\n* and other contributors as indicated by the @author tags.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n"
},
{
"change_type": "ADD",
"old_path": null,
"new_path": "testsuite/integration-arquillian/tests/base/src/test/java/org/keycloak/testsuite/broker/KcSamlAdvancedAttributeToGroupMapperTest.java",
"diff": "+package org.keycloak.testsuite.broker;\n+\n+import com.google.common.collect.ImmutableList;\n+import com.google.common.collect.ImmutableMap;\n+import org.junit.Test;\n+import org.keycloak.admin.client.CreatedResponseUtil;\n+import org.keycloak.admin.client.resource.IdentityProviderResource;\n+import org.keycloak.broker.provider.ConfigConstants;\n+import org.keycloak.broker.saml.mappers.AdvancedAttributeToGroupMapper;\n+import org.keycloak.models.IdentityProviderMapperModel;\n+import org.keycloak.models.IdentityProviderMapperSyncMode;\n+import org.keycloak.representations.idm.IdentityProviderMapperRepresentation;\n+import org.keycloak.representations.idm.IdentityProviderRepresentation;\n+import org.keycloak.representations.idm.UserRepresentation;\n+\n+import javax.ws.rs.core.Response;\n+import java.util.List;\n+\n+import static org.keycloak.testsuite.broker.KcSamlBrokerConfiguration.ATTRIBUTE_TO_MAP_FRIENDLY_NAME;\n+\n+/**\n+ * @author <a href=\"mailto:external.martin.idel@bosch.io\">Martin Idel</a>,\n+ * <a href=\"mailto:daniel.fesenmeyer@bosch.io\">Daniel Fesenmeyer</a>\n+ */\n+public class KcSamlAdvancedAttributeToGroupMapperTest extends AbstractGroupBrokerMapperTest {\n+\n+ private static final String ATTRIBUTES = \"[\\n\" +\n+ \" {\\n\" +\n+ \" \\\"key\\\": \\\"\" + ATTRIBUTE_TO_MAP_FRIENDLY_NAME + \"\\\",\\n\" +\n+ \" \\\"value\\\": \\\"value 1\\\"\\n\" +\n+ \" },\\n\" +\n+ \" {\\n\" +\n+ \" \\\"key\\\": \\\"\" + KcOidcBrokerConfiguration.ATTRIBUTE_TO_MAP_NAME_2 + \"\\\",\\n\" +\n+ \" \\\"value\\\": \\\"value 2\\\"\\n\" +\n+ \" }\\n\" +\n+ \"]\";\n+\n+\n+ @Override\n+ protected BrokerConfiguration getBrokerConfiguration() {\n+ return new KcSamlBrokerConfiguration();\n+ }\n+\n+ @Override\n+ protected String createMapperInIdp(IdentityProviderRepresentation idp, String claimsOrAttributeRepresentation,\n+ boolean areClaimsOrAttributeValuesRegexes, IdentityProviderMapperSyncMode syncMode, String groupValue) {\n+ IdentityProviderMapperRepresentation advancedAttributeToGroupMapper = new IdentityProviderMapperRepresentation();\n+ advancedAttributeToGroupMapper.setName(\"advanced-attribute-to-group-mapper\");\n+ advancedAttributeToGroupMapper.setIdentityProviderMapper(AdvancedAttributeToGroupMapper.PROVIDER_ID);\n+ advancedAttributeToGroupMapper.setConfig(ImmutableMap.<String, String> builder()\n+ .put(IdentityProviderMapperModel.SYNC_MODE, syncMode.toString())\n+ .put(AdvancedAttributeToGroupMapper.ATTRIBUTE_PROPERTY_NAME, claimsOrAttributeRepresentation)\n+ .put(AdvancedAttributeToGroupMapper.ARE_ATTRIBUTE_VALUES_REGEX_PROPERTY_NAME,\n+ Boolean.valueOf(areClaimsOrAttributeValuesRegexes).toString())\n+ .put(ConfigConstants.GROUP, MAPPER_TEST_GROUP_PATH)\n+ .build());\n+\n+ IdentityProviderResource idpResource = realm.identityProviders().get(idp.getAlias());\n+ advancedAttributeToGroupMapper.setIdentityProviderAlias(bc.getIDPAlias());\n+ Response response = idpResource.addMapper(advancedAttributeToGroupMapper);\n+ return CreatedResponseUtil.getCreatedId(response);\n+ }\n+\n+ @Test\n+ public void attributeFriendlyNameGetsConsideredAndMatchedToGroup() {\n+ createAdvancedGroupMapper(ATTRIBUTES, false,KcOidcBrokerConfiguration.ATTRIBUTE_TO_MAP_NAME_2);\n+ createUserInProviderRealm(ImmutableMap.<String, List<String>> builder()\n+ .put(ATTRIBUTE_TO_MAP_FRIENDLY_NAME, ImmutableList.<String> builder().add(\"value 1\").build())\n+ .put(KcOidcBrokerConfiguration.ATTRIBUTE_TO_MAP_NAME_2,\n+ ImmutableList.<String> builder().add(\"value 2\").build())\n+ .build());\n+\n+ logInAsUserInIDPForFirstTime();\n+ UserRepresentation user = findUser(bc.consumerRealmName(), bc.getUserLogin(), bc.getUserEmail());\n+ assertThatUserHasBeenAssignedToGroup(user, MAPPER_TEST_GROUP_PATH);\n+ }\n+\n+}\n"
}
] | Java | Apache License 2.0 | keycloak/keycloak | Add Attribute to Group Mapper for SAML IDP
Cleansing code as PR Comment
Add test for Advanced Attribute to Group Mapper
Closes #12950 |
339,410 | 02.02.2023 18:45:08 | -3,600 | 48aae83891f0174766246e4a12a35f59ae3be5f7 | Close prepared statement used to set the lock timeout
Closes | [
{
"change_type": "MODIFY",
"old_path": "model/map-jpa/src/main/java/org/keycloak/models/map/storage/jpa/JpaMapStorageProviderFactory.java",
"new_path": "model/map-jpa/src/main/java/org/keycloak/models/map/storage/jpa/JpaMapStorageProviderFactory.java",
"diff": "@@ -22,6 +22,7 @@ import java.sql.Connection;\nimport java.sql.DatabaseMetaData;\nimport java.sql.DriverManager;\nimport java.sql.PreparedStatement;\n+import java.sql.ResultSet;\nimport java.sql.SQLException;\nimport java.util.HashMap;\nimport java.util.LinkedHashMap;\n@@ -288,8 +289,16 @@ public class JpaMapStorageProviderFactory implements\nif (lockTimeout != null) {\nem.unwrap(SessionImpl.class)\n.doWork(connection -> {\n- PreparedStatement preparedStatement = connection.prepareStatement(\"SET LOCAL lock_timeout = '\" + lockTimeout + \"';\");\n- preparedStatement.execute();\n+ // 'SET LOCAL lock_timeout = ...' can't be used with parameters in a prepared statement, leads to an\n+ // 'ERROR: syntax error at or near \"$1\"'\n+ // on PostgreSQL.\n+ // Using 'set_config()' instead as described here: https://www.postgresql.org/message-id/CAKFQuwbMaoO9%3DVUY1K0Nz5YBDyE6YQ9A_A6ncCxD%2Bt0yK1AxJg%40mail.gmail.com\n+ // See https://www.postgresql.org/docs/13/functions-admin.html for the documentation on this function\n+ try (PreparedStatement preparedStatement = connection.prepareStatement(\"SELECT set_config('lock_timeout', ?, true)\")) {\n+ preparedStatement.setString(1, String.valueOf(lockTimeout));\n+ ResultSet resultSet = preparedStatement.executeQuery();\n+ resultSet.close();\n+ }\n});\n} else {\nlogger.warnf(\"Database %s used without lockTimeout option configured. This can result in deadlock where one connection waits for a pessimistic write lock forever.\", databaseShortName);\n"
}
] | Java | Apache License 2.0 | keycloak/keycloak | Close prepared statement used to set the lock timeout
Closes #16801 |
339,281 | 05.02.2023 21:45:48 | -3,600 | fc9e9e6fda02049def5761c048e52be107fa0d47 | Add support for file store configuration into Quarkus
Closes | [
{
"change_type": "MODIFY",
"old_path": "quarkus/config-api/src/main/java/org/keycloak/config/StorageOptions.java",
"new_path": "quarkus/config-api/src/main/java/org/keycloak/config/StorageOptions.java",
"diff": "package org.keycloak.config;\n+import static java.util.function.Predicate.not;\n+\nimport org.keycloak.models.map.storage.hotRod.common.AutogeneratedHotRodDescriptors;\nimport org.keycloak.models.map.storage.hotRod.common.HotRodEntityDescriptor;\n@@ -32,7 +34,8 @@ public class StorageOptions {\njpa(\"jpa\"),\nchm(\"concurrenthashmap\"),\n- hotrod(\"hotrod\");\n+ hotrod(\"hotrod\"),\n+ file(\"file\");\nprivate final String provider;\n@@ -263,6 +266,7 @@ public class StorageOptions {\n.category(OptionCategory.STORAGE)\n.description(descriptionForStorageAreas(\"single use objects\"))\n.buildTime(true)\n+ .expectedValues(Stream.of(StorageType.values()).filter(not(StorageType.file::equals)).toArray(StorageType[]::new))\n.build();\npublic static final Option<String> STORAGE_PUBLIC_KEY_STORAGE_STORE = new OptionBuilder<>(\"storage-public-key-storage\", String.class)\n@@ -324,6 +328,11 @@ public class StorageOptions {\n.hidden()\n.build();\n+ public static final Option<String> STORAGE_FILE_DIR= new OptionBuilder<>(\"storage-file-dir\", String.class)\n+ .category(OptionCategory.STORAGE)\n+ .description(\"Root directory for file map store.\")\n+ .build();\n+\nprivate static String descriptionForStorageAreas(String areaAsText) {\nreturn \"Sets a storage mechanism for \" + areaAsText + \".\";\n}\n"
},
{
"change_type": "MODIFY",
"old_path": "quarkus/runtime/pom.xml",
"new_path": "quarkus/runtime/pom.xml",
"diff": "</exclusion>\n</exclusions>\n</dependency>\n+ <dependency>\n+ <groupId>org.snakeyaml</groupId>\n+ <artifactId>snakeyaml-engine</artifactId>\n+ <exclusions>\n+ <exclusion>\n+ <groupId>*</groupId>\n+ <artifactId>*</artifactId>\n+ </exclusion>\n+ </exclusions>\n+ </dependency>\n<dependency>\n<groupId>com.google.zxing</groupId>\n<artifactId>core</artifactId>\n"
},
{
"change_type": "MODIFY",
"old_path": "quarkus/runtime/src/main/java/org/keycloak/quarkus/runtime/configuration/mappers/StoragePropertyMappers.java",
"new_path": "quarkus/runtime/src/main/java/org/keycloak/quarkus/runtime/configuration/mappers/StoragePropertyMappers.java",
"diff": "@@ -230,7 +230,7 @@ final class StoragePropertyMappers {\nfromOption(StorageOptions.STORAGE_SINGLE_USE_OBJECT_STORE)\n.to(\"kc.spi-single-use-object-map-storage-provider\")\n.mapFrom(\"storage\")\n- .transformer(StoragePropertyMappers::resolveMapStorageProvider)\n+ .transformer(StoragePropertyMappers::resolveMapStorageProviderSingleUseObjects)\n.paramLabel(\"type\")\n.build(),\nfromOption(StorageOptions.STORAGE_PUBLIC_KEY_STORAGE_STORE)\n@@ -298,6 +298,11 @@ final class StoragePropertyMappers {\nfromOption(StorageOptions.STORAGE_HOTROD_CACHE_REINDEX)\n.to(\"kc.spi-connections-hot-rod-default-reindex-caches\")\n.paramLabel(\"[cache1,cache2,...]|all\")\n+ .build(),\n+ fromOption(StorageOptions.STORAGE_FILE_DIR)\n+ .to(\"kc.spi-map-storage-file-dir\")\n+ .mapFrom(\"storage\")\n+ .paramLabel(\"dir\")\n.build()\n};\n}\n@@ -366,6 +371,21 @@ final class StoragePropertyMappers {\nreturn value;\n}\n+ private static Optional<String> resolveMapStorageProviderSingleUseObjects(Optional<String> value, ConfigSourceInterceptorContext context) {\n+ try {\n+ if (value.isPresent()) {\n+ return of(value.map(StorageType::valueOf)\n+ .filter(not(StorageType.file::equals))\n+ .map(StorageType::getProvider)\n+ .orElse(StorageType.chm.getProvider()));\n+ }\n+ } catch (IllegalArgumentException iae) {\n+ throw new IllegalArgumentException(\"Invalid storage provider: \" + value.orElse(null), iae);\n+ }\n+\n+ return value;\n+ }\n+\nprivate static Optional<String> resolveMapStorageProviderPublicKeyStorage(Optional<String> value, ConfigSourceInterceptorContext context) {\ntry {\nif (value.isPresent()) {\n"
},
{
"change_type": "MODIFY",
"old_path": "quarkus/tests/integration/src/test/resources/org/keycloak/it/cli/dist/approvals/cli/help/HelpCommandDistTest.testStartDevHelpAll.unix.approved.txt",
"new_path": "quarkus/tests/integration/src/test/resources/org/keycloak/it/cli/dist/approvals/cli/help/HelpCommandDistTest.testStartDevHelpAll.unix.approved.txt",
"diff": "Binary files a/quarkus/tests/integration/src/test/resources/org/keycloak/it/cli/dist/approvals/cli/help/HelpCommandDistTest.testStartDevHelpAll.unix.approved.txt and b/quarkus/tests/integration/src/test/resources/org/keycloak/it/cli/dist/approvals/cli/help/HelpCommandDistTest.testStartDevHelpAll.unix.approved.txt differ\n"
},
{
"change_type": "MODIFY",
"old_path": "quarkus/tests/integration/src/test/resources/org/keycloak/it/cli/dist/approvals/cli/help/HelpCommandDistTest.testStartHelpAll.unix.approved.txt",
"new_path": "quarkus/tests/integration/src/test/resources/org/keycloak/it/cli/dist/approvals/cli/help/HelpCommandDistTest.testStartHelpAll.unix.approved.txt",
"diff": "Binary files a/quarkus/tests/integration/src/test/resources/org/keycloak/it/cli/dist/approvals/cli/help/HelpCommandDistTest.testStartHelpAll.unix.approved.txt and b/quarkus/tests/integration/src/test/resources/org/keycloak/it/cli/dist/approvals/cli/help/HelpCommandDistTest.testStartHelpAll.unix.approved.txt differ\n"
},
{
"change_type": "MODIFY",
"old_path": "quarkus/tests/integration/src/test/resources/org/keycloak/it/cli/dist/approvals/cli/help/HelpCommandDistTest.testStartOptimizedHelpAll.unix.approved.txt",
"new_path": "quarkus/tests/integration/src/test/resources/org/keycloak/it/cli/dist/approvals/cli/help/HelpCommandDistTest.testStartOptimizedHelpAll.unix.approved.txt",
"diff": "Binary files a/quarkus/tests/integration/src/test/resources/org/keycloak/it/cli/dist/approvals/cli/help/HelpCommandDistTest.testStartOptimizedHelpAll.unix.approved.txt and b/quarkus/tests/integration/src/test/resources/org/keycloak/it/cli/dist/approvals/cli/help/HelpCommandDistTest.testStartOptimizedHelpAll.unix.approved.txt differ\n"
}
] | Java | Apache License 2.0 | keycloak/keycloak | Add support for file store configuration into Quarkus
Closes #16821 |
339,138 | 29.11.2021 04:12:40 | -10,800 | 5f39aeb5907c33e889144b66a65f83909534a3a1 | Pre-authorization hook for client policies
Closes | [
{
"change_type": "MODIFY",
"old_path": "server-spi/src/main/java/org/keycloak/services/clientpolicy/ClientPolicyEvent.java",
"new_path": "server-spi/src/main/java/org/keycloak/services/clientpolicy/ClientPolicyEvent.java",
"diff": "@@ -30,6 +30,7 @@ public enum ClientPolicyEvent {\nUPDATED,\nVIEW,\nUNREGISTER,\n+ PRE_AUTHORIZATION_REQUEST,\nAUTHORIZATION_REQUEST,\nIMPLICIT_HYBRID_TOKEN_RESPONSE,\nTOKEN_REQUEST,\n"
},
{
"change_type": "MODIFY",
"old_path": "services/src/main/java/org/keycloak/protocol/oidc/endpoints/AuthorizationEndpoint.java",
"new_path": "services/src/main/java/org/keycloak/protocol/oidc/endpoints/AuthorizationEndpoint.java",
"diff": "@@ -45,6 +45,7 @@ import org.keycloak.services.ErrorPageException;\nimport org.keycloak.services.Urls;\nimport org.keycloak.services.clientpolicy.ClientPolicyException;\nimport org.keycloak.services.clientpolicy.context.AuthorizationRequestContext;\n+import org.keycloak.services.clientpolicy.context.PreAuthorizationRequestContext;\nimport org.keycloak.services.messages.Messages;\nimport org.keycloak.services.resources.LoginActionsService;\nimport org.keycloak.services.util.CacheControlUtil;\n@@ -144,6 +145,12 @@ public class AuthorizationEndpoint extends AuthorizationEndpointBase {\ncheckSsl();\ncheckRealm();\n+\n+ try {\n+ session.clientPolicy().triggerOnEvent(new PreAuthorizationRequestContext(clientId, params));\n+ } catch (ClientPolicyException cpe) {\n+ throw new ErrorPageException(session, authenticationSession, cpe.getErrorStatus(), cpe.getErrorDetail());\n+ }\ncheckClient(clientId);\nrequest = AuthorizationEndpointRequestParserProcessor.parseRequest(event, session, client, params, AuthorizationEndpointRequestParserProcessor.EndpointType.OIDC_AUTH_ENDPOINT);\n"
},
{
"change_type": "ADD",
"old_path": null,
"new_path": "services/src/main/java/org/keycloak/services/clientpolicy/context/PreAuthorizationRequestContext.java",
"diff": "+/*\n+ * Copyright 2023 Red Hat, Inc. and/or its affiliates\n+ * and other contributors as indicated by the @author tags.\n+ *\n+ * Licensed under the Apache License, Version 2.0 (the \"License\");\n+ * you may not use this file except in compliance with the License.\n+ * You may obtain a copy of the License at\n+ *\n+ * http://www.apache.org/licenses/LICENSE-2.0\n+ *\n+ * Unless required by applicable law or agreed to in writing, software\n+ * distributed under the License is distributed on an \"AS IS\" BASIS,\n+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n+ * See the License for the specific language governing permissions and\n+ * limitations under the License.\n+ */\n+\n+package org.keycloak.services.clientpolicy.context;\n+\n+import javax.ws.rs.core.MultivaluedMap;\n+\n+import org.keycloak.services.clientpolicy.ClientPolicyContext;\n+import org.keycloak.services.clientpolicy.ClientPolicyEvent;\n+\n+/**\n+ * @author <a href=\"mailto:demetrio@carretti.pro\">Dmitry Telegin</a>\n+ */\n+public class PreAuthorizationRequestContext implements ClientPolicyContext {\n+\n+ private final String clientId;\n+ private final MultivaluedMap<String, String> requestParameters;\n+\n+ public PreAuthorizationRequestContext(String clientId, MultivaluedMap<String, String> requestParameters) {\n+ this.clientId = clientId;\n+ this.requestParameters = requestParameters;\n+ }\n+\n+ @Override\n+ public ClientPolicyEvent getEvent() {\n+ return ClientPolicyEvent.PRE_AUTHORIZATION_REQUEST;\n+ }\n+\n+ public String getClientId() {\n+ return clientId;\n+ }\n+\n+ public MultivaluedMap<String, String> getRequestParameters() {\n+ return requestParameters;\n+ }\n+\n+}\n"
},
{
"change_type": "MODIFY",
"old_path": "services/src/main/java/org/keycloak/services/clientpolicy/executor/RejectRequestExecutor.java",
"new_path": "services/src/main/java/org/keycloak/services/clientpolicy/executor/RejectRequestExecutor.java",
"diff": "@@ -38,6 +38,6 @@ public class RejectRequestExecutor implements ClientPolicyExecutorProvider<Clien\n@Override\npublic void executeOnEvent(ClientPolicyContext context) throws ClientPolicyException {\n- throw new ClientPolicyException(OAuthErrorException.INVALID_REQUEST, \"request not allowed\");\n+ throw new ClientPolicyException(OAuthErrorException.INVALID_REQUEST, \"Request not allowed\");\n}\n}\n"
},
{
"change_type": "MODIFY",
"old_path": "testsuite/integration-arquillian/tests/base/src/test/java/org/keycloak/testsuite/client/policies/AbstractClientPoliciesTest.java",
"new_path": "testsuite/integration-arquillian/tests/base/src/test/java/org/keycloak/testsuite/client/policies/AbstractClientPoliciesTest.java",
"diff": "@@ -204,7 +204,7 @@ public abstract class AbstractClientPoliciesTest extends AbstractKeycloakTest {\nprotected static final String ERR_MSG_MISSING_NONCE = \"Missing parameter: nonce\";\nprotected static final String ERR_MSG_MISSING_STATE = \"Missing parameter: state\";\nprotected static final String ERR_MSG_CLIENT_REG_FAIL = \"Failed to send request\";\n- protected static final String ERR_MSG_REQ_NOT_ALLOWED = \"request not allowed\";\n+ protected static final String ERR_MSG_REQ_NOT_ALLOWED = \"Request not allowed\";\nprotected ClientRegistration reg;\n"
},
{
"change_type": "MODIFY",
"old_path": "testsuite/integration-arquillian/tests/base/src/test/java/org/keycloak/testsuite/client/policies/ClientPoliciesExtendedEventTest.java",
"new_path": "testsuite/integration-arquillian/tests/base/src/test/java/org/keycloak/testsuite/client/policies/ClientPoliciesExtendedEventTest.java",
"diff": "@@ -19,6 +19,7 @@ package org.keycloak.testsuite.client.policies;\nimport static org.junit.Assert.assertEquals;\nimport static org.junit.Assert.assertNotNull;\n+import static org.junit.Assert.assertTrue;\nimport static org.junit.Assert.fail;\nimport static org.keycloak.testsuite.admin.AbstractAdminTest.loadJson;\nimport static org.keycloak.testsuite.admin.ApiUtil.findUserByUsername;\n@@ -537,4 +538,32 @@ public class ClientPoliciesExtendedEventTest extends AbstractClientPoliciesTest\nassertEquals(ClientPolicyEvent.RESOURCE_OWNER_PASSWORD_CREDENTIALS_RESPONSE.toString(), response.getError());\nassertEquals(\"Exception thrown intentionally\", response.getErrorDescription());\n}\n+\n+ @Test\n+ public void testExtendedClientPolicyIntefacesForPreAuthorizationRequest() throws Exception {\n+ // register profiles\n+ String json = (new ClientProfilesBuilder()).addProfile(\n+ (new ClientProfileBuilder()).createProfile(PROFILE_NAME, \"Den Forste Profilen\")\n+ .addExecutor(TestRaiseExceptionExecutorFactory.PROVIDER_ID,\n+ createTestRaiseExeptionExecutorConfig(Arrays.asList(ClientPolicyEvent.PRE_AUTHORIZATION_REQUEST)))\n+ .toRepresentation()\n+ ).toString();\n+ updateProfiles(json);\n+\n+ // register policies\n+ json = (new ClientPoliciesBuilder()).addPolicy(\n+ (new ClientPolicyBuilder()).createPolicy(POLICY_NAME, \"La Premiere Politique\", Boolean.TRUE)\n+ .addCondition(AnyClientConditionFactory.PROVIDER_ID, createAnyClientConditionConfig())\n+ .addProfile(PROFILE_NAME)\n+ .toRepresentation()\n+ ).toString();\n+ updatePolicies(json);\n+\n+ // Authorization Request\n+ oauth.realm(REALM_NAME);\n+ oauth.clientId(\"foo\");\n+ oauth.openLoginForm();\n+ assertTrue(errorPage.isCurrent());\n+ assertEquals(\"Exception thrown intentionally\", errorPage.getError());\n+ }\n}\n"
},
{
"change_type": "MODIFY",
"old_path": "testsuite/integration-arquillian/tests/base/src/test/java/org/keycloak/testsuite/client/policies/ClientPoliciesTest.java",
"new_path": "testsuite/integration-arquillian/tests/base/src/test/java/org/keycloak/testsuite/client/policies/ClientPoliciesTest.java",
"diff": "@@ -24,6 +24,7 @@ import static org.hamcrest.Matchers.is;\nimport static org.hamcrest.Matchers.not;\nimport static org.hamcrest.Matchers.notNullValue;\nimport static org.junit.Assert.assertEquals;\n+import static org.junit.Assert.assertTrue;\nimport static org.junit.Assert.fail;\nimport static org.keycloak.testsuite.admin.AbstractAdminTest.loadJson;\nimport static org.keycloak.testsuite.admin.ApiUtil.findClientResourceByClientId;\n@@ -909,8 +910,8 @@ public class ClientPoliciesTest extends AbstractClientPoliciesTest {\ntry {\noauth.clientId(clientBetaId);\noauth.openLoginForm();\n- assertEquals(OAuthErrorException.INVALID_REQUEST, oauth.getCurrentQuery().get(OAuth2Constants.ERROR));\n- assertEquals(ERR_MSG_REQ_NOT_ALLOWED, oauth.getCurrentQuery().get(OAuth2Constants.ERROR_DESCRIPTION));\n+ assertTrue(errorPage.isCurrent());\n+ assertEquals(ERR_MSG_REQ_NOT_ALLOWED, errorPage.getError());\nrevertToBuiltinProfiles();\nsuccessfulLoginAndLogout(clientBetaId, \"secretBeta\");\n} catch (Exception e) {\n"
}
] | Java | Apache License 2.0 | keycloak/keycloak | Pre-authorization hook for client policies
Closes #9017 |
339,410 | 08.02.2023 15:33:43 | -3,600 | 9ecd589690227443ebeadf212429a4da6d40eccf | Update docs to enable downstream processing
Relates to: | [
{
"change_type": "MODIFY",
"old_path": "docs/guides/src/main/server/configuration-production.adoc",
"new_path": "docs/guides/src/main/server/configuration-production.adoc",
"diff": "@@ -22,7 +22,7 @@ In a production environment, Keycloak instances usually run in a private network\nFor details on the endpoint categories and instructions on how to configure the public hostname for them, see the <@links.server id=\"hostname\"/> guide.\n== Reverse proxy in a distributed environment\n-Apart from <<Setting the hostname for Keycloak>>, production environments usually include a reverse proxy / load balancer component. It separates and unifies access to the network used by your company or organization. For a Keycloak production environment, this component is recommended.\n+Apart from <@links.server id=\"hostname\"/>, production environments usually include a reverse proxy / load balancer component. It separates and unifies access to the network used by your company or organization. For a Keycloak production environment, this component is recommended.\nFor details on configuring proxy communication modes in Keycloak, see the <@links.server id=\"reverseproxy\"/> guide. That guide also recommends which paths should be hidden from public access and which paths should be exposed so that Keycloak can secure your applications.\n"
},
{
"change_type": "MODIFY",
"old_path": "docs/guides/src/main/templates/links.adoc",
"new_path": "docs/guides/src/main/templates/links.adoc",
"diff": "-<#macro server id>\n-link:{links_server_${id}_url}[{links_server_${id}_name}]\n-</#macro>\n\\ No newline at end of file\n+<#macro server id>link:{links_server_${id}_url}[{links_server_${id}_name}]</#macro>\n\\ No newline at end of file\n"
}
] | Java | Apache License 2.0 | keycloak/keycloak | Update docs to enable downstream processing (#16595)
Relates to: #16475 |
641,014 | 17.06.2020 12:28:29 | -32,400 | 613b1e7a0408ffcc1c48d39d2348fff8e21c14c3 | setting up the repository | [
{
"change_type": "ADD",
"old_path": null,
"new_path": ".gitignore",
"diff": "+# Byte-compiled / optimized / DLL files\n+__pycache__/\n+*.py[cod]\n+*$py.class\n+\n+# C extensions\n+*.so\n+\n+# Distribution / packaging\n+.Python\n+build/\n+develop-eggs/\n+dist/\n+downloads/\n+eggs/\n+.eggs/\n+lib/\n+lib64/\n+parts/\n+sdist/\n+var/\n+wheels/\n+pip-wheel-metadata/\n+share/python-wheels/\n+*.egg-info/\n+.installed.cfg\n+*.egg\n+MANIFEST\n+\n+# PyInstaller\n+# Usually these files are written by a python script from a template\n+# before PyInstaller builds the exe, so as to inject date/other infos into it.\n+*.manifest\n+*.spec\n+\n+# Installer logs\n+pip-log.txt\n+pip-delete-this-directory.txt\n+\n+# Unit test / coverage reports\n+htmlcov/\n+.tox/\n+.nox/\n+.coverage\n+.coverage.*\n+.cache\n+nosetests.xml\n+coverage.xml\n+*.cover\n+*.py,cover\n+.hypothesis/\n+.pytest_cache/\n+\n+# Translations\n+*.mo\n+*.pot\n+\n+# Django stuff:\n+*.log\n+local_settings.py\n+db.sqlite3\n+db.sqlite3-journal\n+\n+# Flask stuff:\n+instance/\n+.webassets-cache\n+\n+# Scrapy stuff:\n+.scrapy\n+\n+# Sphinx documentation\n+docs/_build/\n+\n+# PyBuilder\n+target/\n+\n+# Jupyter Notebook\n+.ipynb_checkpoints\n+\n+# IPython\n+profile_default/\n+ipython_config.py\n+\n+# pyenv\n+.python-version\n+\n+# pipenv\n+# According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.\n+# However, in case of collaboration, if having platform-specific dependencies or dependencies\n+# having no cross-platform support, pipenv may install dependencies that don't work, or not\n+# install all needed dependencies.\n+#Pipfile.lock\n+\n+# PEP 582; used by e.g. github.com/David-OConnor/pyflow\n+__pypackages__/\n+\n+# Celery stuff\n+celerybeat-schedule\n+celerybeat.pid\n+\n+# SageMath parsed files\n+*.sage.py\n+\n+# Environments\n+.env\n+.venv\n+env/\n+venv/\n+ENV/\n+env.bak/\n+venv.bak/\n+\n+# Spyder project settings\n+.spyderproject\n+.spyproject\n+\n+# Rope project settings\n+.ropeproject\n+\n+# mkdocs documentation\n+/site\n+\n+# mypy\n+.mypy_cache/\n+.dmypy.json\n+dmypy.json\n+\n+# Pyre type checker\n+.pyre/\n+\n+# additionals\n+.vscode/\n+.DS_Store\n+logs/\n+*.csv\n+*.npy\n+*.html\n"
},
{
"change_type": "ADD",
"old_path": "images/overview.png",
"new_path": "images/overview.png",
"diff": "Binary files /dev/null and b/images/overview.png differ\n"
},
{
"change_type": "ADD",
"old_path": "images/recommended_fashion_items.png",
"new_path": "images/recommended_fashion_items.png",
"diff": "Binary files /dev/null and b/images/recommended_fashion_items.png differ\n"
},
{
"change_type": "ADD",
"old_path": "images/statistics_of_obd.png",
"new_path": "images/statistics_of_obd.png",
"diff": "Binary files /dev/null and b/images/statistics_of_obd.png differ\n"
}
] | Python | Apache License 2.0 | st-tech/zr-obp | setting up the repository |
641,014 | 18.06.2020 14:12:24 | -32,400 | c45d980b6c1f53089753a1707e104e7dd224f722 | setting up the repo | [
{
"change_type": "MODIFY",
"old_path": ".gitignore",
"new_path": ".gitignore",
"diff": "@@ -132,6 +132,5 @@ dmypy.json\n.vscode/\n.DS_Store\nlogs/\n-*.csv\n*.npy\n*.html\n"
},
{
"change_type": "MODIFY",
"old_path": "README.md",
"new_path": "README.md",
"diff": "@@ -43,14 +43,12 @@ Currently, Open Bandit Dataset & Pipeline facilitate evaluation and comparison r\n## Installation\n-<!--\n-# TODO: activate pip install\n1. You can install OBP using Python's package manager `pip`.\n```\npip install obp\n-``` -->\n+```\n1. You can install OBP from source.\n```bash\n"
},
{
"change_type": "ADD",
"old_path": null,
"new_path": "setup.py",
"diff": "+\n+from obp.version import __version__\n+from setuptools import setup, find_packages\n+from os import path\n+import sys\n+\n+here = path.abspath(path.dirname(__file__))\n+sys.path.insert(0, path.join(here, 'obp'))\n+\n+print('version')\n+print(__version__)\n+\n+with open(path.join(here, 'README.md'), encoding='utf-8') as f:\n+ long_description = f.read()\n+\n+setup(name='obp',\n+ version=__version__,\n+ description='Open Bandit Dataset and Pipeline',\n+ url='https://github.com/st-tech/zr-obp',\n+ author='ZOZO Technologies, Inc.',\n+ author_email='saito.y.bj@m.titech.ac.jp',\n+ keywords=['bandit algorithms', 'off-policy evaluation'],\n+ long_description=long_description,\n+ long_description_content_type='text/markdown',\n+ install_requires=[\n+ 'numpy>=1.18.1',\n+ 'scikit-learn>=0.23.1',\n+ 'scipy>=1.4.1',\n+ 'tqdm>=4.41.1',\n+ 'pandas>=0.25.1',\n+ 'pyyaml>=5.1',\n+ ],\n+ license=\"Apache License\",\n+ packages=find_packages(exclude=['obd', 'examples', 'tests']),\n+ classifiers=[\n+ 'Topic :: Scientific/Engineering :: Artificial Intelligence',\n+ 'Intended Audience :: Science/Research',\n+ 'Programming Language :: Python :: 3.7',\n+ 'Programming Language :: Python :: 3.8',\n+ 'License :: OSI Approved :: Apache Software License',\n+ ],\n+ )\n"
}
] | Python | Apache License 2.0 | st-tech/zr-obp | setting up the repo |
641,014 | 24.06.2020 02:33:26 | -32,400 | d9d0bc83a91960e13cbf97f989c9a39944a3c569 | move logistic_bandits to obp | [
{
"change_type": "MODIFY",
"old_path": "examples/obd/cf_policy_selection.py",
"new_path": "examples/obd/cf_policy_selection.py",
"diff": "@@ -9,7 +9,7 @@ from sklearn.experimental import enable_hist_gradient_boosting\nfrom sklearn.ensemble import HistGradientBoostingClassifier\nfrom dataset import OBDWithContextSets\n-from logistic_bandit import LogisticTS, LogisticEpsilonGreedy, LogisticUCB\n+from obp.policy import LogisticTS, LogisticEpsilonGreedy, LogisticUCB\nfrom obp.simulator import OfflineBanditSimulator\nfrom obp.utils import estimate_confidence_interval_by_bootstrap\n"
},
{
"change_type": "DELETE",
"old_path": "examples/obd/logistic_bandit.py",
"new_path": null,
"diff": "-from dataclasses import dataclass\n-\n-import numpy as np\n-from scipy.optimize import minimize\n-\n-from obp.policy import BaseContextualPolicy\n-\n-\n-@dataclass\n-class LogisticEpsilonGreedy(BaseContextualPolicy):\n- \"\"\"Logistic Epsilon Greedy.\"\"\"\n- epsilon: float = 0.\n- policy_name: str = f'logistic_egreedy_{epsilon}'\n-\n- def __post_init__(self) -> None:\n- \"\"\"Initialize class.\"\"\"\n- super().__post_init__()\n- self.model_list = [\n- MiniBatchLogisticRegression(\n- lambda_=self.lambda_list[i], alpha=self.alpha_list[i], dim=self.dim)\n- for i in np.arange(self.n_actions)]\n- self.reward_lists = [[] for i in np.arange(self.n_actions)]\n- self.context_lists = [[] for i in np.arange(self.n_actions)]\n-\n- def select_action(self, context: np.ndarray) -> np.ndarray:\n- \"\"\"Select action for new data.\"\"\"\n- if self.action_counts.min() == 0:\n- return self.random_.choice(self.n_actions, size=self.len_list, replace=False)\n- else:\n- if self.random_.rand() > self.epsilon:\n- theta = np.array([model.predict_proba(context) for model in self.model_list]).flatten()\n- unsorted_max_arms = np.argpartition(-theta, self.len_list)[:self.len_list]\n- return unsorted_max_arms[np.argsort(-theta[unsorted_max_arms])]\n- else:\n- return self.random_.choice(self.n_actions, size=self.len_list, replace=False)\n-\n- def update_params(self, action: int, reward: float, context: np.ndarray) -> None:\n- \"\"\"Update parameters.\"\"\"\n- self.n_trial += 1\n- self.action_counts[action] += 1\n- self.reward_lists[action].append(reward)\n- self.context_lists[action].append(context)\n- if self.n_trial % self.batch_size == 0:\n- for action, model in enumerate(self.model_list):\n- if not len(self.reward_lists[action]) == 0:\n- model.fit(X=np.concatenate(self.context_lists[action], axis=0),\n- y=np.array(self.reward_lists[action]))\n- self.reward_lists = [[] for i in np.arange(self.n_actions)]\n- self.context_lists = [[] for i in np.arange(self.n_actions)]\n-\n-\n-@dataclass\n-class LogisticUCB(BaseContextualPolicy):\n- \"\"\"Logistic Upper Confidence Bound.\"\"\"\n- epsilon: float = 0.\n- policy_name: str = f'logistic_ucb_{epsilon}'\n-\n- def __post_init__(self) -> None:\n- \"\"\"Initialize class.\"\"\"\n- super().__post_init__()\n- self.model_list = [\n- MiniBatchLogisticRegression(\n- lambda_=self.lambda_list[i], alpha=self.alpha_list[i], dim=self.dim)\n- for i in np.arange(self.n_actions)]\n- self.reward_lists = [[] for i in np.arange(self.n_actions)]\n- self.context_lists = [[] for i in np.arange(self.n_actions)]\n-\n- def select_action(self, context: np.ndarray) -> np.ndarray:\n- \"\"\"Select action for new data.\"\"\"\n- if self.action_counts.min() == 0:\n- return self.random_.choice(self.n_actions, size=self.len_list, replace=False)\n- else:\n- theta = np.array([model.predict_proba(context)\n- for model in self.model_list]).flatten()\n- std = np.array([np.sqrt(np.sum((model._q ** (-1)) * (context ** 2)))\n- for model in self.model_list]).flatten()\n- ucb_score = theta + self.epsilon * std\n- unsorted_max_arms = np.argpartition(-ucb_score, self.len_list)[:self.len_list]\n- return unsorted_max_arms[np.argsort(-ucb_score[unsorted_max_arms])]\n-\n- def update_params(self, action: int, reward: float, context: np.ndarray) -> None:\n- \"\"\"Update parameters.\"\"\"\n- self.n_trial += 1\n- self.action_counts[action] += 1\n- self.reward_lists[action].append(reward)\n- self.context_lists[action].append(context)\n- if self.n_trial % self.batch_size == 0:\n- for action, model in enumerate(self.model_list):\n- if not len(self.reward_lists[action]) == 0:\n- model.fit(X=np.concatenate(self.context_lists[action], axis=0),\n- y=np.array(self.reward_lists[action]))\n- self.reward_lists = [[] for i in np.arange(self.n_actions)]\n- self.context_lists = [[] for i in np.arange(self.n_actions)]\n-\n-\n-@dataclass\n-class LogisticTS(BaseContextualPolicy):\n- \"\"\"Logistic Thompson Sampling.\"\"\"\n- policy_name: str = 'logistic_ts'\n-\n- def __init__(self) -> None:\n- \"\"\"Initialize class.\"\"\"\n- super().__post_init__()\n- self.model_list = [\n- MiniBatchLogisticRegression(\n- lambda_=self.lambda_list[i], alpha=self.alpha_list[i], dim=self.dim)\n- for i in np.arange(self.n_actions)]\n- self.reward_lists = [[] for i in np.arange(self.n_actions)]\n- self.context_lists = [[] for i in np.arange(self.n_actions)]\n-\n- def select_action(self, context: np.ndarray) -> np.ndarray:\n- \"\"\"Select action for new data.\"\"\"\n- if self.action_counts.min() == 0:\n- return self.random_.choice(self.n_actions, size=self.len_list, replace=False)\n- else:\n- theta = np.array([model.predict_proba_with_sampling(context)\n- for model in self.model_list]).flatten()\n- unsorted_max_arms = np.argpartition(-theta, self.len_list)[:self.len_list]\n- return unsorted_max_arms[np.argsort(-theta[unsorted_max_arms])]\n-\n- def update_params(self, action: int, reward: float, context: np.ndarray) -> None:\n- \"\"\"Update parameters.\"\"\"\n- self.n_trial += 1\n- self.action_counts[action] += 1\n- self.reward_lists[action].append(reward)\n- self.context_lists[action].append(context)\n- if self.n_trial % self.batch_size == 0:\n- for action, model in enumerate(self.model_list):\n- if not len(self.reward_lists[action]) == 0:\n- model.fit(X=np.concatenate(self.context_lists[action], axis=0),\n- y=np.array(self.reward_lists[action]))\n- self.reward_lists = [[] for i in np.arange(self.n_actions)]\n- self.context_lists = [[] for i in np.arange(self.n_actions)]\n-\n-\n-@dataclass\n-class MiniBatchLogisticRegression:\n- \"\"\"MiniBatch Online Logistic Regression Model.\"\"\"\n- lambda_: float\n- alpha: float\n- dim: int\n-\n- def __post_init__(self) -> None:\n- \"\"\"Initialize Class.\"\"\"\n- self._m = np.zeros(self.dim)\n- self._q = np.ones(self.dim) * self.lambda_\n-\n- def loss(self, w: np.ndarray, *args) -> float:\n- \"\"\"Calculate loss function.\"\"\"\n- X, y = args\n- return 0.5 * (self._q * (w - self._m)).dot(w - self._m) + np.log(1 + np.exp(-y * w.dot(X.T))).sum()\n-\n- def grad(self, w: np.ndarray, *args) -> np.ndarray:\n- \"\"\"Calculate gradient.\"\"\"\n- X, y = args\n- return self._q * (w - self._m) + (-1) * (((y * X.T) / (1. + np.exp(y * w.dot(X.T)))).T).sum(axis=0)\n-\n- def sample(self) -> np.ndarray:\n- \"\"\"Sample coefficient vector from the prior distribution.\"\"\"\n- return self.random_.normal(self._m, self.sd(), size=self.dim)\n-\n- def fit(self, X: np.ndarray, y: np.ndarray):\n- \"\"\"Update coefficient vector by the mini-batch data.\"\"\"\n- self._m = minimize(self.loss, self._m, args=(X, y), jac=self.grad, method=\"L-BFGS-B\",\n- options={'maxiter': 20, 'disp': False}).x\n- P = (1 + np.exp(1 + X.dot(self._m))) ** (-1)\n- self._q = self._q + (P * (1 - P)).dot(X ** 2)\n-\n- def sd(self) -> np.ndarray:\n- \"\"\"Standard deviation for the coefficient vector.\"\"\"\n- return self.alpha * (self._q)**(-1.0)\n-\n- def predict_proba(self, X: np.ndarray) -> np.ndarray:\n- \"\"\"Predict extected probability by the expected coefficient.\"\"\"\n- return sigmoid(X.dot(self._m))\n-\n- def predict_proba_with_sampling(self, X: np.ndarray) -> np.ndarray:\n- \"\"\"Predict extected probability by the sampled coefficient.\"\"\"\n- return sigmoid(X.dot(self.sample()))\n-\n-\n-def sigmoid(x: np.ndarray) -> np.ndarray:\n- \"\"\"Calculate sigmoid function.\"\"\"\n- return 1. / (1. + np.exp(-x))\n"
}
] | Python | Apache License 2.0 | st-tech/zr-obp | move logistic_bandits to obp |
641,014 | 24.06.2020 02:35:52 | -32,400 | 2dd7cd4488ccf955da9a411801e24de8e8e21819 | add logistic bandits | [
{
"change_type": "MODIFY",
"old_path": "obp/policy/contextual.py",
"new_path": "obp/policy/contextual.py",
"diff": "+# Copyright (c) ZOZO Technologies, Inc. All rights reserved.\n+# Licensed under the Apache 2.0 License.\n+\nfrom abc import ABCMeta, abstractmethod\nfrom dataclasses import dataclass\nfrom typing import Optional\nimport numpy as np\n+from scipy.optimize import minimize\nfrom sklearn.utils import check_random_state\n+from ..utils import sigmoid\n+\n@dataclass\nclass BaseContextualPolicy(metaclass=ABCMeta):\n@@ -13,32 +19,32 @@ class BaseContextualPolicy(metaclass=ABCMeta):\nParameters\n----------\ndim: int\n- The dimension of context vectors.\n+ Dimension of context vectors.\nn_actions: int\n- The number of actions.\n+ Number of actions.\nlen_list: int, default: 1\n- The length of a list of recommended actions in each impression.\n+ Length of a list of recommended actions in each impression.\nWhen Open Bandit Dataset is used, 3 shouled be set.\nbatch_size: int, default: 1\n- The number of samples used in a batch parameter update.\n+ Number of samples used in a batch parameter update.\nn_trial: int, default: 0\nCurrent number of trials in a bandit simulation.\nalpha_: float, default: 1.\n- A prior parameter for the online logistic regression.\n+ Prior parameter for the online logistic regression.\nlambda_: float, default: 1.\n- A regularization hyperparameter for the online logistic regression.\n+ Regularization hyperparameter for the online logistic regression.\nrandom_state: int, default: None\nControls the random seed in sampling actions.\npolicy_type: str, default: 'contextual'\n- The type of the bandit policy.\n+ Type of bandit policy such as 'contextfree', 'contextual', and 'combinatorial'\n\"\"\"\ndim: int\nn_actions: int\n@@ -51,7 +57,7 @@ class BaseContextualPolicy(metaclass=ABCMeta):\npolicy_type: str = 'contextual'\ndef __post_init__(self) -> None:\n- \"\"\"Initialize Class.\"\"\"\n+ \"\"\"Initialize class.\"\"\"\nself.random_ = check_random_state(self.random_state)\nself.alpha_list = self.alpha_ * np.ones(self.n_actions)\nself.lambda_list = self.lambda_ * np.ones(self.n_actions)\n@@ -60,7 +66,7 @@ class BaseContextualPolicy(metaclass=ABCMeta):\nself.context_lists = [[] for i in np.arange(self.n_actions)]\ndef initialize(self) -> None:\n- \"\"\"Initialize Parameters.\"\"\"\n+ \"\"\"Initialize policy parameters.\"\"\"\nself.n_trial = 0\nself.random_ = check_random_state(self.random_state)\nself.action_counts = np.zeros(self.n_actions, dtype=int)\n@@ -76,3 +82,367 @@ class BaseContextualPolicy(metaclass=ABCMeta):\ndef update_params(self, action: float, reward: float, context: np.ndarray) -> None:\n\"\"\"Update policy parameters.\"\"\"\npass\n+\n+\n+@dataclass\n+class LogisticEpsilonGreedy(BaseContextualPolicy):\n+ \"\"\"Logistic Epsilon Greedy.\n+\n+ Parameters\n+ ----------\n+ dim: int\n+ Dimension of context vectors.\n+\n+ n_actions: int\n+ Number of actions.\n+\n+ len_list: int, default: 1\n+ Length of a list of recommended actions in each impression.\n+ When Open Bandit Dataset is used, 3 shouled be set.\n+\n+ batch_size: int, default: 1\n+ Number of samples used in a batch parameter update.\n+\n+ n_trial: int, default: 0\n+ Current number of trials in a bandit simulation.\n+\n+ alpha_: float, default: 1.\n+ Prior parameter for the online logistic regression.\n+\n+ lambda_: float, default: 1.\n+ Regularization hyperparameter for the online logistic regression.\n+\n+ random_state: int, default: None\n+ Controls the random seed in sampling actions.\n+\n+ policy_type: str, default: 'contextual'\n+ Type of bandit policy such as 'contextfree', 'contextual', and 'combinatorial'.\n+\n+ epsilon: float, default: 0.\n+ Exploration hyperparameter that must take value in the range of [0., 1.].\n+\n+ policy_name: str, default: f'logistic_egreedy_{epsilon}'.\n+ Name of bandit policy.\n+ \"\"\"\n+ epsilon: float = 0.\n+ policy_name: str = f'logistic_egreedy_{epsilon}'\n+\n+ assert 0 <= epsilon <= 1, f'epsilon must be in [0, 1], but {epsilon} is set.'\n+\n+ def __post_init__(self) -> None:\n+ \"\"\"Initialize class.\"\"\"\n+ super().__post_init__()\n+ self.model_list = [\n+ MiniBatchLogisticRegression(\n+ lambda_=self.lambda_list[i], alpha=self.alpha_list[i], dim=self.dim)\n+ for i in np.arange(self.n_actions)]\n+ self.reward_lists = [[] for i in np.arange(self.n_actions)]\n+ self.context_lists = [[] for i in np.arange(self.n_actions)]\n+\n+ def select_action(self, context: np.ndarray) -> np.ndarray:\n+ \"\"\"Select action for new data.\n+\n+ Parameters\n+ ----------\n+ context: array\n+ Observed context vector.\n+\n+ Returns\n+ ----------\n+ selected_actions: array\n+ List of selected actions.\n+ \"\"\"\n+ if self.action_counts.min() == 0:\n+ return self.random_.choice(self.n_actions, size=self.len_list, replace=False)\n+ else:\n+ if self.random_.rand() > self.epsilon:\n+ theta = np.array([model.predict_proba(context) for model in self.model_list]).flatten()\n+ unsorted_max_arms = np.argpartition(-theta, self.len_list)[:self.len_list]\n+ return unsorted_max_arms[np.argsort(-theta[unsorted_max_arms])]\n+ else:\n+ return self.random_.choice(self.n_actions, size=self.len_list, replace=False)\n+\n+ def update_params(self, action: int, reward: float, context: np.ndarray) -> None:\n+ \"\"\"Update policy parameters.\n+\n+ Parameters\n+ ----------\n+ action: int\n+ Selected action by the policy.\n+\n+ reward: float\n+ Observed reward for the chosen action and position.\n+\n+ context: array\n+ Observed context vector.\n+ \"\"\"\n+ self.n_trial += 1\n+ self.action_counts[action] += 1\n+ self.reward_lists[action].append(reward)\n+ self.context_lists[action].append(context)\n+ if self.n_trial % self.batch_size == 0:\n+ for action, model in enumerate(self.model_list):\n+ if not len(self.reward_lists[action]) == 0:\n+ model.fit(X=np.concatenate(self.context_lists[action], axis=0),\n+ y=np.array(self.reward_lists[action]))\n+ self.reward_lists = [[] for i in np.arange(self.n_actions)]\n+ self.context_lists = [[] for i in np.arange(self.n_actions)]\n+\n+\n+@dataclass\n+class LogisticUCB(BaseContextualPolicy):\n+ \"\"\"Logistic Upper Confidence Bound.\n+\n+ Parameters\n+ ----------\n+ dim: int\n+ Dimension of context vectors.\n+\n+ n_actions: int\n+ Number of actions.\n+\n+ len_list: int, default: 1\n+ Length of a list of recommended actions in each impression.\n+ When Open Bandit Dataset is used, 3 shouled be set.\n+\n+ batch_size: int, default: 1\n+ Number of samples used in a batch parameter update.\n+\n+ n_trial: int, default: 0\n+ Current number of trials in a bandit simulation.\n+\n+ alpha_: float, default: 1.\n+ Prior parameter for the online logistic regression.\n+\n+ lambda_: float, default: 1.\n+ Regularization hyperparameter for the online logistic regression.\n+\n+ random_state: int, default: None\n+ Controls the random seed in sampling actions.\n+\n+ policy_type: str, default: 'contextual'\n+ Type of bandit policy such as 'contextfree', 'contextual', and 'combinatorial'.\n+\n+ epsilon: float, default: 0.\n+ Exploration hyperparameter that must take value in the range of [0., 1.].\n+\n+ policy_name: str, default: f'logistic_ucb_{epsilon}'.\n+ Name of bandit policy.\n+\n+ References\n+ ----------\n+ Lihong Li, Wei Chu, John Langford, and Robert E Schapire.\n+ \"A Contextual-bandit Approach to Personalized News Article Recommendation,\" 2010.\n+ \"\"\"\n+ epsilon: float = 0.\n+ policy_name: str = f'logistic_ucb_{epsilon}'\n+\n+ assert 0 <= epsilon <= 1, f'epsilon must be in [0, 1], but {epsilon} is set.'\n+\n+ def __post_init__(self) -> None:\n+ \"\"\"Initialize class.\"\"\"\n+ super().__post_init__()\n+ self.model_list = [\n+ MiniBatchLogisticRegression(\n+ lambda_=self.lambda_list[i], alpha=self.alpha_list[i], dim=self.dim)\n+ for i in np.arange(self.n_actions)]\n+ self.reward_lists = [[] for i in np.arange(self.n_actions)]\n+ self.context_lists = [[] for i in np.arange(self.n_actions)]\n+\n+ def select_action(self, context: np.ndarray) -> np.ndarray:\n+ \"\"\"Select action for new data.\n+\n+ Parameters\n+ ----------\n+ context: array\n+ Observed context vector.\n+\n+ Returns\n+ ----------\n+ selected_actions: array\n+ List of selected actions.\n+ \"\"\"\n+ if self.action_counts.min() == 0:\n+ return self.random_.choice(self.n_actions, size=self.len_list, replace=False)\n+ else:\n+ theta = np.array([model.predict_proba(context)\n+ for model in self.model_list]).flatten()\n+ std = np.array([np.sqrt(np.sum((model._q ** (-1)) * (context ** 2)))\n+ for model in self.model_list]).flatten()\n+ ucb_score = theta + self.epsilon * std\n+ unsorted_max_arms = np.argpartition(-ucb_score, self.len_list)[:self.len_list]\n+ return unsorted_max_arms[np.argsort(-ucb_score[unsorted_max_arms])]\n+\n+ def update_params(self, action: int, reward: float, context: np.ndarray) -> None:\n+ \"\"\"Update policy parameters.\n+\n+ Parameters\n+ ----------\n+ action: int\n+ Selected action by the policy.\n+\n+ reward: float\n+ Observed reward for the chosen action and position.\n+\n+ context: array\n+ Observed context vector.\n+ \"\"\"\n+ self.n_trial += 1\n+ self.action_counts[action] += 1\n+ self.reward_lists[action].append(reward)\n+ self.context_lists[action].append(context)\n+ if self.n_trial % self.batch_size == 0:\n+ for action, model in enumerate(self.model_list):\n+ if not len(self.reward_lists[action]) == 0:\n+ model.fit(X=np.concatenate(self.context_lists[action], axis=0),\n+ y=np.array(self.reward_lists[action]))\n+ self.reward_lists = [[] for i in np.arange(self.n_actions)]\n+ self.context_lists = [[] for i in np.arange(self.n_actions)]\n+\n+\n+@dataclass\n+class LogisticTS(BaseContextualPolicy):\n+ \"\"\"Logistic Thompson Sampling.\n+\n+ Parameters\n+ ----------\n+ dim: int\n+ Dimension of context vectors.\n+\n+ n_actions: int\n+ Number of actions.\n+\n+ len_list: int, default: 1\n+ Length of a list of recommended actions in each impression.\n+ When Open Bandit Dataset is used, 3 shouled be set.\n+\n+ batch_size: int, default: 1\n+ Number of samples used in a batch parameter update.\n+\n+ n_trial: int, default: 0\n+ Current number of trials in a bandit simulation.\n+\n+ alpha_: float, default: 1.\n+ Prior parameter for the online logistic regression.\n+\n+ lambda_: float, default: 1.\n+ Regularization hyperparameter for the online logistic regression.\n+\n+ random_state: int, default: None\n+ Controls the random seed in sampling actions.\n+\n+ policy_type: str, default: 'contextual'\n+ Type of bandit policy such as 'contextfree', 'contextual', and 'combinatorial'.\n+\n+ policy_name: str, default: f'logistic_ts'.\n+ Name of bandit policy.\n+\n+ References\n+ ----------\n+ Olivier Chapelle and Lihong Li.\n+ \"An empirical evaluation of thompson sampling,\" 2011.\n+ \"\"\"\n+ policy_name: str = 'logistic_ts'\n+\n+ def __init__(self) -> None:\n+ \"\"\"Initialize class.\"\"\"\n+ super().__post_init__()\n+ self.model_list = [\n+ MiniBatchLogisticRegression(\n+ lambda_=self.lambda_list[i], alpha=self.alpha_list[i], dim=self.dim)\n+ for i in np.arange(self.n_actions)]\n+ self.reward_lists = [[] for i in np.arange(self.n_actions)]\n+ self.context_lists = [[] for i in np.arange(self.n_actions)]\n+\n+ def select_action(self, context: np.ndarray) -> np.ndarray:\n+ \"\"\"Select action for new data.\n+\n+ Parameters\n+ ----------\n+ context: array\n+ Observed context vector.\n+\n+ Returns\n+ ----------\n+ selected_actions: array\n+ List of selected actions.\n+ \"\"\"\n+ if self.action_counts.min() == 0:\n+ return self.random_.choice(self.n_actions, size=self.len_list, replace=False)\n+ else:\n+ theta = np.array([model.predict_proba_with_sampling(context)\n+ for model in self.model_list]).flatten()\n+ unsorted_max_arms = np.argpartition(-theta, self.len_list)[:self.len_list]\n+ return unsorted_max_arms[np.argsort(-theta[unsorted_max_arms])]\n+\n+ def update_params(self, action: int, reward: float, context: np.ndarray) -> None:\n+ \"\"\"Update policy parameters.\n+\n+ Parameters\n+ ----------\n+ action: int\n+ Selected action by the policy.\n+\n+ reward: float\n+ Observed reward for the chosen action and position.\n+\n+ context: array\n+ Observed context vector.\n+ \"\"\"\n+ self.n_trial += 1\n+ self.action_counts[action] += 1\n+ self.reward_lists[action].append(reward)\n+ self.context_lists[action].append(context)\n+ if self.n_trial % self.batch_size == 0:\n+ for action, model in enumerate(self.model_list):\n+ if not len(self.reward_lists[action]) == 0:\n+ model.fit(X=np.concatenate(self.context_lists[action], axis=0),\n+ y=np.array(self.reward_lists[action]))\n+ self.reward_lists = [[] for i in np.arange(self.n_actions)]\n+ self.context_lists = [[] for i in np.arange(self.n_actions)]\n+\n+\n+@dataclass\n+class MiniBatchLogisticRegression:\n+ \"\"\"MiniBatch Online Logistic Regression Model.\"\"\"\n+ lambda_: float\n+ alpha: float\n+ dim: int\n+\n+ def __post_init__(self) -> None:\n+ \"\"\"Initialize Class.\"\"\"\n+ self._m = np.zeros(self.dim)\n+ self._q = np.ones(self.dim) * self.lambda_\n+\n+ def loss(self, w: np.ndarray, *args) -> float:\n+ \"\"\"Calculate loss function.\"\"\"\n+ X, y = args\n+ return 0.5 * (self._q * (w - self._m)).dot(w - self._m) + np.log(1 + np.exp(-y * w.dot(X.T))).sum()\n+\n+ def grad(self, w: np.ndarray, *args) -> np.ndarray:\n+ \"\"\"Calculate gradient.\"\"\"\n+ X, y = args\n+ return self._q * (w - self._m) + (-1) * (((y * X.T) / (1. + np.exp(y * w.dot(X.T)))).T).sum(axis=0)\n+\n+ def sample(self) -> np.ndarray:\n+ \"\"\"Sample coefficient vector from the prior distribution.\"\"\"\n+ return self.random_.normal(self._m, self.sd(), size=self.dim)\n+\n+ def fit(self, X: np.ndarray, y: np.ndarray):\n+ \"\"\"Update coefficient vector by the mini-batch data.\"\"\"\n+ self._m = minimize(self.loss, self._m, args=(X, y), jac=self.grad, method=\"L-BFGS-B\",\n+ options={'maxiter': 20, 'disp': False}).x\n+ P = (1 + np.exp(1 + X.dot(self._m))) ** (-1)\n+ self._q = self._q + (P * (1 - P)).dot(X ** 2)\n+\n+ def sd(self) -> np.ndarray:\n+ \"\"\"Standard deviation for the coefficient vector.\"\"\"\n+ return self.alpha * (self._q)**(-1.0)\n+\n+ def predict_proba(self, X: np.ndarray) -> np.ndarray:\n+ \"\"\"Predict extected probability by the expected coefficient.\"\"\"\n+ return sigmoid(X.dot(self._m))\n+\n+ def predict_proba_with_sampling(self, X: np.ndarray) -> np.ndarray:\n+ \"\"\"Predict extected probability by the sampled coefficient.\"\"\"\n+ return sigmoid(X.dot(self.sample()))\n"
}
] | Python | Apache License 2.0 | st-tech/zr-obp | add logistic bandits |
641,014 | 24.06.2020 17:21:22 | -32,400 | b00ace0a88e9df75a97836b2faacba2a73beec65 | create policy.base module | [
{
"change_type": "MODIFY",
"old_path": "obp/policy/__init__.py",
"new_path": "obp/policy/__init__.py",
"diff": "+from .base import *\nfrom .contextfree import *\nfrom .contextual import *\n"
},
{
"change_type": "ADD",
"old_path": null,
"new_path": "obp/policy/base.py",
"diff": "+# Copyright (c) ZOZO Technologies, Inc. All rights reserved.\n+# Licensed under the Apache 2.0 License.\n+\n+from abc import ABCMeta, abstractmethod\n+from dataclasses import dataclass\n+from typing import Optional\n+\n+import numpy as np\n+from sklearn.utils import check_random_state\n+\n+\n+@dataclass\n+class BaseContextFreePolicy(metaclass=ABCMeta):\n+ \"\"\"Base class for context-free bandit policies.\n+\n+ Parameters\n+ ----------\n+ n_actions: int\n+ Number of actions.\n+\n+ len_list: int, default: 1\n+ Length of a list of recommended actions in each impression.\n+ When Open Bandit Dataset is used, 3 shouled be set.\n+\n+ batch_size: int, default: 1\n+ Number of samples used in a batch parameter update.\n+\n+ n_trial: int, default: 0\n+ Current number of trials in a bandit simulation.\n+\n+ random_state: int, default: None\n+ Controls the random seed in sampling actions.\n+\n+ policy_type: str, default: 'contextfree'\n+ Type of the bandit policy such as 'contextfree', 'contextual', and 'combinatorial'.\n+ \"\"\"\n+ n_actions: int\n+ len_list: int = 1\n+ batch_size: int = 1\n+ n_trial: int = 0\n+ random_state: Optional[int] = None\n+ policy_type: str = 'contextfree'\n+\n+ def __post_init__(self) -> None:\n+ \"\"\"Initialize Class.\"\"\"\n+ self.random_ = check_random_state(self.random_state)\n+ self.action_counts = np.zeros(self.n_actions, dtype=int)\n+ self.action_counts_temp = np.zeros(self.n_actions, dtype=int)\n+ self.reward_counts_temp = np.zeros(self.n_actions)\n+ self.reward_counts = np.zeros(self.n_actions)\n+\n+ def initialize(self) -> None:\n+ \"\"\"Initialize Parameters.\"\"\"\n+ self.n_trial = 0\n+ self.random_ = check_random_state(self.random_state)\n+ self.action_counts = np.zeros(self.n_actions, dtype=int)\n+ self.action_counts_temp = np.zeros(self.n_actions, dtype=int)\n+ self.reward_counts_temp = np.zeros(self.n_actions)\n+ self.reward_counts = np.zeros(self.n_actions)\n+\n+ @abstractmethod\n+ def select_action(self) -> np.ndarray:\n+ \"\"\"Select a list of actions.\"\"\"\n+ pass\n+\n+ @abstractmethod\n+ def update_params(self, action: int, reward: float) -> None:\n+ \"\"\"Update policy parameters.\"\"\"\n+ pass\n+\n+\n+@dataclass\n+class BaseContextualPolicy(metaclass=ABCMeta):\n+ \"\"\"Base class for contextual bandit policies.\n+\n+ Parameters\n+ ----------\n+ dim: int\n+ Dimension of context vectors.\n+\n+ n_actions: int\n+ Number of actions.\n+\n+ len_list: int, default: 1\n+ Length of a list of recommended actions in each impression.\n+ When Open Bandit Dataset is used, 3 shouled be set.\n+\n+ batch_size: int, default: 1\n+ Number of samples used in a batch parameter update.\n+\n+ n_trial: int, default: 0\n+ Current number of trials in a bandit simulation.\n+\n+ alpha_: float, default: 1.\n+ Prior parameter for the online logistic regression.\n+\n+ lambda_: float, default: 1.\n+ Regularization hyperparameter for the online logistic regression.\n+\n+ random_state: int, default: None\n+ Controls the random seed in sampling actions.\n+\n+ policy_type: str, default: 'contextual'\n+ Type of bandit policy such as 'contextfree', 'contextual', and 'combinatorial'\n+ \"\"\"\n+ dim: int\n+ n_actions: int\n+ len_list: int = 1\n+ batch_size: int = 1\n+ n_trial: int = 0\n+ alpha_: float = 1.\n+ lambda_: float = 1.\n+ random_state: Optional[int] = None\n+ policy_type: str = 'contextual'\n+\n+ def __post_init__(self) -> None:\n+ \"\"\"Initialize class.\"\"\"\n+ self.random_ = check_random_state(self.random_state)\n+ self.alpha_list = self.alpha_ * np.ones(self.n_actions)\n+ self.lambda_list = self.lambda_ * np.ones(self.n_actions)\n+ self.action_counts = np.zeros(self.n_actions, dtype=int)\n+ self.reward_lists = [[] for i in np.arange(self.n_actions)]\n+ self.context_lists = [[] for i in np.arange(self.n_actions)]\n+\n+ def initialize(self) -> None:\n+ \"\"\"Initialize policy parameters.\"\"\"\n+ self.n_trial = 0\n+ self.random_ = check_random_state(self.random_state)\n+ self.action_counts = np.zeros(self.n_actions, dtype=int)\n+ self.reward_lists = [[] for i in np.arange(self.n_actions)]\n+ self.context_lists = [[] for i in np.arange(self.n_actions)]\n+\n+ @abstractmethod\n+ def select_action(self, context: np.ndarray) -> np.ndarray:\n+ \"\"\"Select a list of actions.\"\"\"\n+ pass\n+\n+ @abstractmethod\n+ def update_params(self, action: float, reward: float, context: np.ndarray) -> None:\n+ \"\"\"Update policy parameters.\"\"\"\n+ pass\n"
},
{
"change_type": "MODIFY",
"old_path": "obp/policy/contextfree.py",
"new_path": "obp/policy/contextfree.py",
"diff": "# Copyright (c) ZOZO Technologies, Inc. All rights reserved.\n# Licensed under the Apache 2.0 License.\n-from abc import ABCMeta, abstractmethod\nfrom dataclasses import dataclass\nfrom typing import List, Optional\nimport numpy as np\n-from sklearn.utils import check_random_state\n-\n-@dataclass\n-class BaseContextFreePolicy(metaclass=ABCMeta):\n- \"\"\"Base class for context-free bandit policies.\n-\n- Parameters\n- ----------\n- n_actions: int\n- Number of actions.\n-\n- len_list: int, default: 1\n- Length of a list of recommended actions in each impression.\n- When Open Bandit Dataset is used, 3 shouled be set.\n-\n- batch_size: int, default: 1\n- Number of samples used in a batch parameter update.\n-\n- n_trial: int, default: 0\n- Current number of trials in a bandit simulation.\n-\n- random_state: int, default: None\n- Controls the random seed in sampling actions.\n-\n- policy_type: str, default: 'contextfree'\n- Type of the bandit policy such as 'contextfree', 'contextual', and 'combinatorial'.\n- \"\"\"\n- n_actions: int\n- len_list: int = 1\n- batch_size: int = 1\n- n_trial: int = 0\n- random_state: Optional[int] = None\n- policy_type: str = 'contextfree'\n-\n- def __post_init__(self) -> None:\n- \"\"\"Initialize Class.\"\"\"\n- self.random_ = check_random_state(self.random_state)\n- self.action_counts = np.zeros(self.n_actions, dtype=int)\n- self.action_counts_temp = np.zeros(self.n_actions, dtype=int)\n- self.reward_counts_temp = np.zeros(self.n_actions)\n- self.reward_counts = np.zeros(self.n_actions)\n-\n- def initialize(self) -> None:\n- \"\"\"Initialize Parameters.\"\"\"\n- self.n_trial = 0\n- self.random_ = check_random_state(self.random_state)\n- self.action_counts = np.zeros(self.n_actions, dtype=int)\n- self.action_counts_temp = np.zeros(self.n_actions, dtype=int)\n- self.reward_counts_temp = np.zeros(self.n_actions)\n- self.reward_counts = np.zeros(self.n_actions)\n-\n- @abstractmethod\n- def select_action(self) -> np.ndarray:\n- \"\"\"Select a list of actions.\"\"\"\n- raise NotImplementedError\n-\n- @abstractmethod\n- def update_params(self, action: int, reward: float) -> None:\n- \"\"\"Update policy parameters.\"\"\"\n- raise NotImplementedError\n+from .base import BaseContextFreePolicy\n@dataclass\n"
},
{
"change_type": "MODIFY",
"old_path": "obp/policy/contextual.py",
"new_path": "obp/policy/contextual.py",
"diff": "# Copyright (c) ZOZO Technologies, Inc. All rights reserved.\n# Licensed under the Apache 2.0 License.\n-from abc import ABCMeta, abstractmethod\nfrom dataclasses import dataclass\n-from typing import Optional\nimport numpy as np\nfrom scipy.optimize import minimize\n-from sklearn.utils import check_random_state\n+from .base import BaseContextualPolicy\nfrom ..utils import sigmoid\n-@dataclass\n-class BaseContextualPolicy(metaclass=ABCMeta):\n- \"\"\"Base class for contextual bandit policies.\n-\n- Parameters\n- ----------\n- dim: int\n- Dimension of context vectors.\n-\n- n_actions: int\n- Number of actions.\n-\n- len_list: int, default: 1\n- Length of a list of recommended actions in each impression.\n- When Open Bandit Dataset is used, 3 shouled be set.\n-\n- batch_size: int, default: 1\n- Number of samples used in a batch parameter update.\n-\n- n_trial: int, default: 0\n- Current number of trials in a bandit simulation.\n-\n- alpha_: float, default: 1.\n- Prior parameter for the online logistic regression.\n-\n- lambda_: float, default: 1.\n- Regularization hyperparameter for the online logistic regression.\n-\n- random_state: int, default: None\n- Controls the random seed in sampling actions.\n-\n- policy_type: str, default: 'contextual'\n- Type of bandit policy such as 'contextfree', 'contextual', and 'combinatorial'\n- \"\"\"\n- dim: int\n- n_actions: int\n- len_list: int = 1\n- batch_size: int = 1\n- n_trial: int = 0\n- alpha_: float = 1.\n- lambda_: float = 1.\n- random_state: Optional[int] = None\n- policy_type: str = 'contextual'\n-\n- def __post_init__(self) -> None:\n- \"\"\"Initialize class.\"\"\"\n- self.random_ = check_random_state(self.random_state)\n- self.alpha_list = self.alpha_ * np.ones(self.n_actions)\n- self.lambda_list = self.lambda_ * np.ones(self.n_actions)\n- self.action_counts = np.zeros(self.n_actions, dtype=int)\n- self.reward_lists = [[] for i in np.arange(self.n_actions)]\n- self.context_lists = [[] for i in np.arange(self.n_actions)]\n-\n- def initialize(self) -> None:\n- \"\"\"Initialize policy parameters.\"\"\"\n- self.n_trial = 0\n- self.random_ = check_random_state(self.random_state)\n- self.action_counts = np.zeros(self.n_actions, dtype=int)\n- self.reward_lists = [[] for i in np.arange(self.n_actions)]\n- self.context_lists = [[] for i in np.arange(self.n_actions)]\n-\n- @abstractmethod\n- def select_action(self, context: np.ndarray) -> np.ndarray:\n- \"\"\"Select a list of actions.\"\"\"\n- pass\n-\n- @abstractmethod\n- def update_params(self, action: float, reward: float, context: np.ndarray) -> None:\n- \"\"\"Update policy parameters.\"\"\"\n- pass\n-\n-\n@dataclass\nclass LogisticEpsilonGreedy(BaseContextualPolicy):\n\"\"\"Logistic Epsilon Greedy.\n"
}
] | Python | Apache License 2.0 | st-tech/zr-obp | create policy.base module |
641,014 | 26.06.2020 21:48:35 | -32,400 | 1a9a44be15b3bb2d6b1403ef7bf6c18708b2f35d | define BanditPolicyClass in policy module | [
{
"change_type": "MODIFY",
"old_path": "obp/policy/base.py",
"new_path": "obp/policy/base.py",
"diff": "from abc import ABCMeta, abstractmethod\nfrom dataclasses import dataclass\n-from typing import Optional\n+from typing import Optional, Union\nimport numpy as np\nfrom sklearn.utils import check_random_state\n@@ -139,3 +139,6 @@ class BaseContextualPolicy(metaclass=ABCMeta):\ndef update_params(self, action: float, reward: float, context: np.ndarray) -> None:\n\"\"\"Update policy parameters.\"\"\"\npass\n+\n+\n+BaiditPolicyType = Union[BaseContextFreePolicy, BaseContextualPolicy]\n"
},
{
"change_type": "MODIFY",
"old_path": "obp/simulator.py",
"new_path": "obp/simulator.py",
"diff": "from dataclasses import dataclass\nimport logging\nfrom tqdm import tqdm\n-from typing import Union, List, Optional\n+from typing import List, Optional\nimport numpy as np\nfrom sklearn.base import BaseEstimator\nfrom obp.dataset import TRAIN_DICT\n-from obp.policy import BaseContextFreePolicy, BaseContextualPolicy\n+from obp.policy import BanditPolicyType\nfrom obp.utils import check_is_fitted\n-BanditPolicyType = Union[BaseContextFreePolicy, BaseContextualPolicy]\n-\n@dataclass\nclass OfflineBanditSimulator:\n"
}
] | Python | Apache License 2.0 | st-tech/zr-obp | define BanditPolicyClass in policy module |
641,014 | 30.06.2020 06:18:21 | -32,400 | a3411bd8c93e0e0924a780eb1f95c760abd5cb9d | add module comments | [
{
"change_type": "MODIFY",
"old_path": "obp/dataset.py",
"new_path": "obp/dataset.py",
"diff": "# Copyright (c) ZOZO Technologies, Inc. All rights reserved.\n# Licensed under the Apache 2.0 License.\n+\"\"\"Dataset Class for Logged Bandit Feedback.\"\"\"\nfrom abc import ABCMeta, abstractmethod\nfrom dataclasses import dataclass\nfrom pathlib import Path\n"
},
{
"change_type": "MODIFY",
"old_path": "obp/ope/estimators.py",
"new_path": "obp/ope/estimators.py",
"diff": "# Copyright (c) ZOZO Technologies, Inc. All rights reserved.\n# Licensed under the Apache 2.0 License.\n+\"\"\"Off-Policy Estimators.\"\"\"\nfrom abc import ABCMeta, abstractmethod\nfrom dataclasses import dataclass\nfrom typing import Dict, Optional\n"
},
{
"change_type": "MODIFY",
"old_path": "obp/ope/meta.py",
"new_path": "obp/ope/meta.py",
"diff": "# Copyright (c) ZOZO Technologies, Inc. All rights reserved.\n# Licensed under the Apache 2.0 License.\n+\"\"\"Off-Policy Evaluation Class to Streamline OPE.\"\"\"\nfrom dataclasses import dataclass\nimport logging\nfrom typing import Dict, List, Optional, Tuple\n"
},
{
"change_type": "MODIFY",
"old_path": "obp/ope/regression_model.py",
"new_path": "obp/ope/regression_model.py",
"diff": "# Copyright (c) ZOZO Technologies, Inc. All rights reserved.\n# Licensed under the Apache 2.0 License.\n+\"\"\"Regression Model Class for Model-dependent OPE estimators.\"\"\"\nfrom dataclasses import dataclass\nimport numpy as np\n"
},
{
"change_type": "MODIFY",
"old_path": "obp/policy/base.py",
"new_path": "obp/policy/base.py",
"diff": "# Copyright (c) ZOZO Technologies, Inc. All rights reserved.\n# Licensed under the Apache 2.0 License.\n+\"\"\"Abstract Base Class for Bandit Algorithms.\"\"\"\nfrom abc import ABCMeta, abstractmethod\nfrom dataclasses import dataclass\nfrom typing import Optional, Union\n"
},
{
"change_type": "MODIFY",
"old_path": "obp/policy/contextfree.py",
"new_path": "obp/policy/contextfree.py",
"diff": "# Copyright (c) ZOZO Technologies, Inc. All rights reserved.\n# Licensed under the Apache 2.0 License.\n+\"\"\"Context-Free Bandit Algorithms.\"\"\"\nfrom dataclasses import dataclass\nfrom typing import List, Optional\n@@ -50,7 +51,7 @@ class EpsilonGreedy(BaseContextFreePolicy):\nReturns\n----------\n- selected_actions: array\n+ selected_actions: array-like shape (len_list, )\nList of selected actions.\n\"\"\"\nself.n_trial += 1\n@@ -164,7 +165,7 @@ class BernoulliTS(BaseContextFreePolicy):\nReturns\n----------\n- selected_actions: array\n+ selected_actions: array-like shape (len_list, )\nList of selected actions.\n\"\"\"\nself.n_trial += 1\n"
},
{
"change_type": "MODIFY",
"old_path": "obp/policy/contextual.py",
"new_path": "obp/policy/contextual.py",
"diff": "# Copyright (c) ZOZO Technologies, Inc. All rights reserved.\n# Licensed under the Apache 2.0 License.\n+\"\"\"Contextual Bandit Algorithms.\"\"\"\nfrom dataclasses import dataclass\nimport numpy as np\n@@ -75,7 +76,7 @@ class LogisticEpsilonGreedy(BaseContextualPolicy):\nReturns\n----------\n- selected_actions: array\n+ selected_actions: array-like shape (len_list, )\nList of selected actions.\n\"\"\"\nif self.action_counts.min() == 0:\n@@ -185,7 +186,7 @@ class LogisticUCB(BaseContextualPolicy):\nReturns\n----------\n- selected_actions: array\n+ selected_actions: array-like shape (len_list, )\nList of selected actions.\n\"\"\"\nif self.action_counts.min() == 0:\n@@ -290,7 +291,7 @@ class LogisticTS(BaseContextualPolicy):\nReturns\n----------\n- selected_actions: array\n+ selected_actions: array-like shape (len_list, )\nList of selected actions.\n\"\"\"\nif self.action_counts.min() == 0:\n"
},
{
"change_type": "MODIFY",
"old_path": "obp/utils.py",
"new_path": "obp/utils.py",
"diff": "# Copyright (c) ZOZO Technologies, Inc. All rights reserved.\n# Licensed under the Apache 2.0 License.\n+\"\"\"Useful Tools.\"\"\"\nfrom inspect import isclass\nfrom typing import Dict, Optional\n"
}
] | Python | Apache License 2.0 | st-tech/zr-obp | add module comments |
641,014 | 30.06.2020 13:19:37 | -32,400 | 74265bb71c388d13074e42b9a7598e80ae1fb9e8 | fix module comments | [
{
"change_type": "MODIFY",
"old_path": "obp/policy/base.py",
"new_path": "obp/policy/base.py",
"diff": "# Copyright (c) ZOZO Technologies, Inc. All rights reserved.\n# Licensed under the Apache 2.0 License.\n-\"\"\"Abstract Base Class for Bandit Algorithms.\"\"\"\n+\"\"\"Base Interfaces for Bandit Algorithms.\"\"\"\nfrom abc import ABCMeta, abstractmethod\nfrom dataclasses import dataclass\nfrom typing import Optional, Union\n"
},
{
"change_type": "MODIFY",
"old_path": "obp/simulator.py",
"new_path": "obp/simulator.py",
"diff": "# Copyright (c) ZOZO Technologies, Inc. All rights reserved.\n# Licensed under the Apache 2.0 License.\n+\"\"\"Offline Bandit Simulator.\"\"\"\nfrom tqdm import tqdm\nimport numpy as np\n"
}
] | Python | Apache License 2.0 | st-tech/zr-obp | fix module comments |
641,014 | 03.07.2020 22:25:44 | -32,400 | 3ae70481c0bdb35a75413438fab079fafdce0e23 | modify output of nonparametric bootstrap function | [
{
"change_type": "MODIFY",
"old_path": "obp/dataset.py",
"new_path": "obp/dataset.py",
"diff": "@@ -67,7 +67,7 @@ class OpenBanditDataset(BaseBanditDataset):\ndef __post_init__(self) -> None:\n\"\"\"Initialize Open Bandit Dataset Class.\"\"\"\nself.data_path = self.data_path / self.behavior_policy / self.campaign\n- self.raw_data_file = f'{self.campaign}.zip'\n+ self.raw_data_file = f'{self.campaign}.csv'\nself.load_raw_data()\nself.pre_process()\n"
},
{
"change_type": "MODIFY",
"old_path": "obp/utils.py",
"new_path": "obp/utils.py",
"diff": "@@ -33,17 +33,20 @@ def estimate_confidence_interval_by_bootstrap(samples: np.ndarray,\nReturns\n----------\n- estimated_ci: Dict[str, float]\n+ estimated_confidence_interval: Dict[str, float]\nDictionary storing the estimated mean and upper-lower confidence bounds.\n\"\"\"\nboot_samples = list()\nrandom_ = check_random_state(random_state)\nfor _ in np.arange(n_bootstrap_samples):\nboot_samples.append(np.mean(random_.choice(samples, size=samples.shape[0])))\n- lower = np.percentile(boot_samples, 100 * (alpha / 2))\n- upper = np.percentile(boot_samples, 100 * (1. - alpha / 2))\n- estimated_ci = dict(mean=np.mean(boot_samples), lower=lower, upper=upper)\n- return estimated_ci\n+ lower_bound = np.percentile(boot_samples, 100 * (alpha / 2)).round(5)\n+ upper_bound = np.percentile(boot_samples, 100 * (1. - alpha / 2)).round(5)\n+ return {\n+ 'mean': np.mean(boot_samples),\n+ f'{100 * (1. - alpha)}% CI (lower)': lower_bound,\n+ f'{100 * (1. - alpha)}% CI (upper)': upper_bound\n+ }\n@_deprecate_positional_args\n"
}
] | Python | Apache License 2.0 | st-tech/zr-obp | modify output of nonparametric bootstrap function |
641,014 | 03.07.2020 22:26:48 | -32,400 | b26e10589dd2bf6c4ae6c672709e4c746757ffef | adjust examples to the new implementation of obp | [
{
"change_type": "DELETE",
"old_path": "examples/obd/cf_policy_selection.py",
"new_path": null,
"diff": "-import argparse\n-from pathlib import Path\n-import yaml\n-\n-import numpy as np\n-import pandas as pd\n-from sklearn.calibration import CalibratedClassifierCV\n-from sklearn.experimental import enable_hist_gradient_boosting\n-from sklearn.ensemble import HistGradientBoostingClassifier\n-\n-from dataset import OBDWithContextSets\n-from obp.policy import LogisticTS, LogisticEpsilonGreedy, LogisticUCB\n-from obp.simulator import OfflineBanditSimulator\n-from obp.utils import estimate_confidence_interval_by_bootstrap\n-\n-\n-cf_policy_dict = dict(\n- logistic_egreedy=LogisticEpsilonGreedy,\n- logistic_ts=LogisticTS,\n- logistic_ucb=LogisticUCB)\n-\n-\n-with open('./conf/lightgbm.yaml', 'rb') as f:\n- hyperparams = yaml.safe_load(f)['model']\n-\n-\n-if __name__ == '__main__':\n- parser = argparse.ArgumentParser(description='run counterfactual policy search')\n- parser.add_argument('--n_splits', '-n_s', type=int, default=1)\n- parser.add_argument('--n_estimators', '-n_e', type=int, default=2)\n- parser.add_argument('--context_set', '-cont', type=str, choices=['1', '2'], required=True)\n- parser.add_argument('--counterfactual_policy', '-cf_pol', type=str,\n- choices=['logistic_egreedy', 'logistic_ts', 'logistic_ucb'], required=True)\n- parser.add_argument('--epsilon', '-eps', type=float, default=0.1)\n- parser.add_argument('--behavior_policy', '-b_pol', type=str, choices=['bts', 'random'], required=True)\n- parser.add_argument('--campaign', '-camp', type=str, choices=['all', 'men', 'women'], required=True)\n- args = parser.parse_args()\n- print(args)\n-\n- n_splits = args.n_splits\n- n_estimators = args.n_estimators\n- context_set = args.context_set\n- counterfactual_policy = args.counterfactual_policy\n- epsilon = args.epsilon\n- behavior_policy = args.behavior_policy\n- campaign = args.campaign\n- estimators = ['dm', 'ipw', 'dr']\n-\n- obd = OBDWithContextSets(\n- behavior_policy=behavior_policy,\n- campaign=campaign,\n- data_path=Path('.').resolve().parents[1] / 'obd',\n- context_set=context_set)\n-\n- random_state = 12345\n- kwargs = dict(n_actions=obd.n_actions, len_list=obd.len_list, dim=obd.dim_context, epsilon=epsilon)\n- policy = cf_policy_dict[counterfactual_policy](**kwargs)\n- policy_name = policy.policy_name + '_' + context_set\n-\n- np.random.seed(random_state)\n- # split dataset into training and test sets\n- train, test = obd.split_data(random_state=random_state)\n- ground_truth = np.mean(test['reward'])\n-\n- # define a regression model\n- lightgbm = HistGradientBoostingClassifier(**hyperparams)\n- regression_model = CalibratedClassifierCV(lightgbm, method='isotonic', cv=2)\n- # bagging prediction for the policy value of the counterfactual policy\n- ope_results = {est: np.zeros(n_estimators) for est in estimators}\n- for seed in np.arange(n_estimators):\n- # run a bandit algorithm on logged bandit feedback\n- # and conduct off-policy evaluation by using the result of the simulation\n- train_boot = obd.sample_bootstrap(train=train)\n- sim = OfflineBanditSimulator(\n- train=train_boot, regression_model=regression_model, X_action=obd.X_action)\n- sim.simulate(policy=policy)\n- ope_results['dm'][seed] = sim.direct_method()\n- ope_results['ipw'][seed] = sim.inverse_probability_weighting()\n- ope_results['dr'][seed] = sim.doubly_robust()\n-\n- policy.initialize()\n-\n- # estimated policy value at each train-test split\n- print('=' * 25)\n- print(f'random_state={random_state}')\n- print('-----')\n- for est_name in estimators:\n- relative_estimated_policy_value = np.mean(ope_results[est_name]) / ground_truth\n- print(f'{est_name.upper()}: {np.round(relative_estimated_policy_value, 6)}')\n- print('=' * 25, '\\n')\n-\n- # estimate confidence intervals by nonparametric bootstrap method\n- relative_ope_results_with_ci = {est: dict() for est in estimators}\n- for est_name in estimators:\n- relative_ope_results_with_ci[est_name] = estimate_confidence_interval_by_bootstrap(\n- samples=ope_results[est_name] / ground_truth, random_state=random_state)\n-\n- # save cf policy selection results\n- save_path = Path('./logs') / behavior_policy / campaign / 'cf_policy_selection'\n- save_path.mkdir(exist_ok=True, parents=True)\n- pd.DataFrame(relative_ope_results_with_ci).T.to_csv(save_path / f'{policy_name}.csv')\n"
},
{
"change_type": "MODIFY",
"old_path": "examples/obd/dataset.py",
"new_path": "examples/obd/dataset.py",
"diff": "@@ -4,46 +4,30 @@ import numpy as np\nimport pandas as pd\nfrom sklearn.decomposition import PCA\n-from obp.dataset import OpenBanditDataset, TRAIN_DICT\n+from obp.dataset import OpenBanditDataset\n@dataclass\n-class OBDWithContextSets(OpenBanditDataset):\n+class OBDWithInteractionFeatures(OpenBanditDataset):\ncontext_set: str = '1'\ndef pre_process(self) -> None:\n+\nif self.context_set == '1':\n- self._pre_process_context_set_1()\n+ super().pre_process()\nelif self.context_set == '2':\nself._pre_process_context_set_2()\n- def sample_bootstrap(self, train: TRAIN_DICT) -> TRAIN_DICT:\n- \"\"\"Sample bootstrap training sampels to make the bagging prediction.\"\"\"\n- boot_idx = np.random.choice(np.arange(self.train_size), size=self.train_size)\n- train_boot = dict(\n- n_data=self.train_size,\n- n_actions=self.n_actions,\n- action=train['action'][boot_idx],\n- position=train['position'][boot_idx],\n- reward=train['reward'][boot_idx],\n- pscore=train['pscore'][boot_idx],\n- X_policy=train['X_policy'][boot_idx, :],\n- X_reg=train['X_reg'][boot_idx, :],\n- X_user=train['X_user'][boot_idx, :])\n-\n- return train_boot\n-\ndef _pre_process_context_set_1(self) -> None:\n\"\"\"Create Context Set 1 (c.f., Section 5.2)\"\"\"\nuser_cols = self.data.columns.str.contains('user_feature')\n- self.X_policy = pd.get_dummies(self.data.loc[:, user_cols], drop_first=True).values\n+ self.context = pd.get_dummies(self.data.loc[:, user_cols], drop_first=True).values\ndef _pre_process_context_set_2(self) -> None:\n\"\"\"Create Context Set 2 (c.f., Section 5.2)\"\"\"\n- user_cols = self.data.columns.str.contains('user_feature')\n- Xuser = pd.get_dummies(self.data.loc[:, user_cols], drop_first=True).values\n+ super().pre_process()\naffinity_cols = self.data.columns.str.contains('affinity')\nXaffinity = self.data.loc[:, affinity_cols].values\n- self.X_policy = PCA(n_components=30).fit_transform(np.c_[Xuser, Xaffinity])\n+ self.context = PCA(n_components=30).fit_transform(np.c_[self.context, Xaffinity])\n"
},
{
"change_type": "DELETE",
"old_path": "examples/obd/eval_regression_model.py",
"new_path": null,
"diff": "-import argparse\n-from typing import Tuple, Dict\n-from pathlib import Path\n-import pickle\n-import yaml\n-\n-import numpy as np\n-import pandas as pd\n-from sklearn.base import BaseEstimator\n-from sklearn.calibration import CalibratedClassifierCV\n-from sklearn.experimental import enable_hist_gradient_boosting\n-from sklearn.ensemble import HistGradientBoostingClassifier\n-from sklearn.metrics import log_loss, roc_auc_score\n-\n-from obp.dataset import OpenBanditDataset\n-from obp.utils import estimate_confidence_interval_by_bootstrap\n-from dataset import OBDWithContextSets\n-\n-\n-def train_eval_lgbm(dataset: OpenBanditDataset,\n- n_splits: int,\n- hyperparams: Dict) -> Tuple[Dict[int, BaseEstimator], Dict[str, np.ndarray]]:\n- \"\"\"Train and Evaluate LightGBM as a regression model.\"\"\"\n- regression_model_dict = dict()\n- performance_dict = {metric: np.zeros(n_splits) for metric in ['auc', 'rce']}\n- for seed in np.arange(n_splits):\n- train, test = dataset.split_data(random_state=seed)\n- Xtr, ytr = train['X_reg'], train['reward']\n- Xte, yte = test['X_reg'], test['reward']\n- # define classifier and make predictions\n- clf = HistGradientBoostingClassifier(**hyperparams)\n- calibrated_clf = CalibratedClassifierCV(clf, method='isotonic', cv=2)\n- calibrated_clf.fit(Xtr, ytr)\n- ypred = calibrated_clf.predict_proba(Xte)[:, 1]\n- # evaluate prediction accuracies (AUC and RCE)\n- performance_dict['auc'][seed] = roc_auc_score(y_true=yte, y_score=ypred)\n- rce_mean = log_loss(y_true=yte, y_pred=np.ones_like(yte) * np.mean(ytr))\n- rce_clf = log_loss(y_true=yte, y_pred=ypred)\n- performance_dict['rce'][seed] = (rce_mean - rce_clf) / rce_clf\n- # save model file\n- regression_model_dict[seed] = calibrated_clf\n-\n- return regression_model_dict, performance_dict\n-\n-\n-with open('./conf/lightgbm.yaml', 'rb') as f:\n- hyperparams = yaml.safe_load(f)['model']\n-\n-\n-if __name__ == '__main__':\n- parser = argparse.ArgumentParser(description='train regression model with LightGBM')\n- parser.add_argument('--n_splits', '-n_s', type=int, default=1)\n- parser.add_argument('--behavior_policy', '-b_pol', type=str, choices=['bts', 'random'], required=True)\n- parser.add_argument('--campaign', '-camp', type=str, choices=['all', 'men', 'women'], required=True)\n- args = parser.parse_args()\n- print(args)\n-\n- obd = OBDWithContextSets(\n- behavior_policy=args.behavior_policy,\n- campaign=args.campaign,\n- data_path=Path('.').resolve().parents[1] / 'obd')\n-\n- regression_model_dict, performance_dict = train_eval_lgbm(\n- dataset=obd, n_splits=args.n_splits, hyperparams=hyperparams)\n-\n- # save trained regression models\n- log_path = Path('./logs') / args.behavior_policy / args.campaign\n- log_path.mkdir(exist_ok=True, parents=True)\n- with open(log_path / 'model.pkl', mode='wb') as f:\n- pickle.dump(regression_model_dict, f)\n-\n- # verbose\n- print('=' * 25)\n- for metric, values in performance_dict.items():\n- print(f'{metric.upper()}: {np.round(np.mean(values), 6)}')\n- print('=' * 25, '\\n')\n-\n- # save regression model performance\n- regression_model_results = dict()\n- for metric, values in performance_dict.items():\n- regression_model_results[metric] = estimate_confidence_interval_by_bootstrap(values)\n- pd.DataFrame(regression_model_results).T.to_csv(log_path / 'regression_model_performance.csv')\n"
},
{
"change_type": "ADD",
"old_path": null,
"new_path": "examples/obd/evaluate_counterfactual_policy.py",
"diff": "+import argparse\n+from pathlib import Path\n+import yaml\n+\n+import numpy as np\n+import pandas as pd\n+from sklearn.calibration import CalibratedClassifierCV\n+from sklearn.experimental import enable_hist_gradient_boosting\n+from sklearn.ensemble import HistGradientBoostingClassifier\n+\n+from dataset import OBDWithInteractionFeatures\n+from obp.policy import LogisticTS, LogisticEpsilonGreedy, LogisticUCB\n+from obp.simulator import run_bandit_simulation\n+from obp.ope import (\n+ RegressionModel,\n+ OffPolicyEvaluation,\n+ InverseProbabilityWeighting,\n+ DirectMethod,\n+ DoublyRobust\n+)\n+\n+\n+with open('./conf/lightgbm.yaml', 'rb') as f:\n+ hyperparams = yaml.safe_load(f)['model']\n+\n+counterfactual_policy_dict = dict(\n+ logistic_egreedy=LogisticEpsilonGreedy,\n+ logistic_ts=LogisticTS,\n+ logistic_ucb=LogisticUCB\n+)\n+\n+if __name__ == '__main__':\n+ parser = argparse.ArgumentParser(description='run off-policy evaluation of a counterfactual bandit policy.')\n+ parser.add_argument('--context_set', '-cont', type=str, choices=['1', '2'], required=True)\n+ parser.add_argument('--counterfactual_policy', '-cf_pol', type=str,\n+ choices=['logistic_egreedy', 'logistic_ts', 'logistic_ucb'], required=True)\n+ parser.add_argument('--epsilon', '-eps', type=float, default=0.1)\n+ parser.add_argument('--behavior_policy', '-b_pol', type=str, choices=['bts', 'random'], required=True)\n+ parser.add_argument('--campaign', '-camp', type=str, choices=['all', 'men', 'women'], required=True)\n+ parser.add_argument('--random_state', type=int, default=12345)\n+ args = parser.parse_args()\n+ print(args)\n+\n+ context_set = args.context_set\n+ counterfactual_policy = args.counterfactual_policy\n+ epsilon = args.epsilon\n+ behavior_policy = args.behavior_policy\n+ campaign = args.campaign\n+ random_state = args.random_state\n+\n+ obd = OBDWithInteractionFeatures(\n+ behavior_policy=behavior_policy,\n+ campaign=campaign,\n+ data_path=Path('.').resolve().parents[1] / 'obd',\n+ context_set=context_set\n+ )\n+\n+ kwargs = dict(n_actions=obd.n_actions, len_list=obd.len_list, dim=obd.dim_context, epsilon=epsilon)\n+ policy = counterfactual_policy_dict[counterfactual_policy](**kwargs)\n+ policy_name = policy.policy_name + '_' + context_set\n+\n+ np.random.seed(random_state)\n+ # split dataset into training and test sets\n+ train, test = obd.split_data(random_state=random_state)\n+ # ground-truth policy value of the random policy\n+ # , which is the empirical mean of the factual (observed) rewards\n+ ground_truth = np.mean(test['reward'])\n+\n+ # a base ML model for regression model used in Direct Method and Doubly Robust\n+ base_model = CalibratedClassifierCV(HistGradientBoostingClassifier(**hyperparams))\n+ # run a counterfactual bandit algorithm on logged bandit feedback data\n+ selected_actions = run_bandit_simulation(train=train, policy=policy)\n+ # estimate the policy value of a given counterfactual algorithm by the three OPE estimators.\n+ ope = OffPolicyEvaluation(\n+ train=train,\n+ regression_model=RegressionModel(base_model=base_model),\n+ action_context=obd.action_context,\n+ ope_estimators=[InverseProbabilityWeighting(), DirectMethod(), DoublyRobust()]\n+ )\n+ estimated_policy_value, estimated_interval = ope.summarize_off_policy_estimates(selected_actions=selected_actions)\n+\n+ # estimated policy value at each train-test split\n+ print('=' * 70)\n+ print(f'random_state={random_state}: counterfactual policy={policy_name}')\n+ print('-' * 70)\n+ estimated_policy_value['relative_estimated_policy_value'] =\\\n+ estimated_policy_value.estimated_policy_value / ground_truth\n+ print(estimated_policy_value)\n+ print('=' * 70)\n+\n+ # save counterfactual policy evaluation results\n+ save_path = Path('./logs') / behavior_policy / campaign / 'cf_policy_selection'\n+ save_path.mkdir(exist_ok=True, parents=True)\n+ pd.DataFrame(estimated_policy_value).to_csv(save_path / f'{policy_name}.csv')\n+ # save visualization of the off-policy evaluation results\n+ ope.visualize_off_policy_estimates(\n+ selected_actions=selected_actions,\n+ fig_dir=save_path,\n+ fig_name=f'{policy_name}.png'\n+ )\n"
},
{
"change_type": "ADD",
"old_path": null,
"new_path": "examples/obd/evaluate_off_policy_estimators.py",
"diff": "+import argparse\n+from pathlib import Path\n+import yaml\n+\n+import numpy as np\n+import pandas as pd\n+from sklearn.calibration import CalibratedClassifierCV\n+from sklearn.experimental import enable_hist_gradient_boosting\n+from sklearn.ensemble import HistGradientBoostingClassifier\n+\n+from obp.dataset import OpenBanditDataset\n+from obp.simulator import run_bandit_simulation\n+from obp.policy import Random, BernoulliTS\n+from obp.ope import (\n+ RegressionModel,\n+ CompareOffPolicyEstimators,\n+ InverseProbabilityWeighting,\n+ DirectMethod,\n+ DoublyRobust\n+)\n+from obp.utils import estimate_confidence_interval_by_bootstrap\n+\n+\n+with open('./conf/lightgbm.yaml', 'rb') as f:\n+ hyperparams = yaml.safe_load(f)['model']\n+\n+# configurations to reproduce the Bernoulli Thompson Sampling policy\n+# used in ZOZOTOWN production\n+with open('./conf/prior_bts.yaml', 'rb') as f:\n+ production_prior_for_bts = yaml.safe_load(f)\n+\n+with open('./conf/batch_size_bts.yaml', 'rb') as f:\n+ production_batch_size_for_bts = yaml.safe_load(f)\n+\n+counterfactual_policy_dict = dict(\n+ bts=BernoulliTS,\n+ random=Random\n+)\n+\n+if __name__ == '__main__':\n+ parser = argparse.ArgumentParser(description='evaluate off-policy estimators')\n+ parser.add_argument('--n_splits', '-n_s', type=int, default=1)\n+ parser.add_argument('--counterfactual_policy', '-c_pol', type=str, choices=['bts', 'random'], required=True)\n+ parser.add_argument('--behavior_policy', '-b_pol', type=str, choices=['bts', 'random'], required=True)\n+ parser.add_argument('--campaign', '-camp', type=str, choices=['all', 'men', 'women'], required=True)\n+ parser.add_argument('--random_state', type=int, default=12345)\n+ args = parser.parse_args()\n+ print(args)\n+\n+ n_splits = args.n_splits\n+ counterfactual_policy = args.counterfactual_policy\n+ behavior_policy = args.behavior_policy\n+ campaign = args.campaign\n+ random_state = args.random_state\n+ data_path = Path('.').resolve().parents[1] / 'obd'\n+\n+ obd = OpenBanditDataset(\n+ behavior_policy=behavior_policy,\n+ campaign=campaign,\n+ data_path=data_path\n+ )\n+\n+ kwargs = dict(n_actions=obd.n_actions, len_list=obd.len_list, random_state=random_state)\n+ if behavior_policy == 'random':\n+ kwargs['alpha'] = production_prior_for_bts[campaign]['alpha']\n+ kwargs['beta'] = production_prior_for_bts[campaign]['beta']\n+ kwargs['batch_size'] = production_batch_size_for_bts[campaign]\n+ policy = counterfactual_policy_dict[behavior_policy](**kwargs)\n+ # compared OPE estimators\n+ ope_estimators = [\n+ DirectMethod(),\n+ InverseProbabilityWeighting(),\n+ DoublyRobust()\n+ ]\n+ # a base ML model for regression model used in Direct Method and Doubly Robust\n+ base_model = CalibratedClassifierCV(HistGradientBoostingClassifier(**hyperparams))\n+\n+ evaluation_of_ope_results = {est.estimator_name: np.zeros(n_splits) for est in ope_estimators}\n+ for s in np.arange(n_splits):\n+ # split dataset into training and test sets\n+ train, test = obd.split_data(test_size=0.3, random_state=s)\n+ # run a counterfactual bandit algorithm on logged bandit feedback data\n+ selected_actions = run_bandit_simulation(train=train, policy=policy)\n+ # evaluate the estimation performance of OPE estimators\n+ compare_ope = CompareOffPolicyEstimators(\n+ train=train,\n+ factual_rewards=test['reward'],\n+ action_context=obd.action_context,\n+ regression_model=RegressionModel(base_model=base_model),\n+ ope_estimators=ope_estimators\n+ )\n+ relative_estimation_errors = compare_ope.evaluate_performance_of_estimators(\n+ selected_actions=selected_actions\n+ )\n+ policy.initialize()\n+ # store relative estimation errors of OPE estimators at each split\n+ for estimator_name, relative_estimation_error in relative_estimation_errors.items():\n+ evaluation_of_ope_results[estimator_name][s] = relative_estimation_error\n+\n+ # estimate confidence intervals of relative estimation by nonparametric bootstrap method\n+ evaluation_of_ope_results_with_ci = {est.estimator_name: dict() for est in ope_estimators}\n+ for estimator_name in evaluation_of_ope_results_with_ci.keys():\n+ evaluation_of_ope_results_with_ci[estimator_name] = estimate_confidence_interval_by_bootstrap(\n+ samples=evaluation_of_ope_results[estimator_name],\n+ random_state=random_state\n+ )\n+ evaluation_of_ope_results_df = pd.DataFrame(evaluation_of_ope_results_with_ci).T\n+\n+ print('=' * 50)\n+ print(f'random_state={random_state}')\n+ print('-' * 50)\n+ print(evaluation_of_ope_results_df)\n+ print('=' * 50)\n+\n+ # save results of evaluation of off-policy estimators\n+ log_path = Path('./logs') / behavior_policy / campaign\n+ evaluation_of_ope_results_df.to_csv(log_path / 'comparison_of_ope_estimators.csv')\n"
},
{
"change_type": "ADD",
"old_path": null,
"new_path": "examples/obd/note.md",
"diff": "+```bash\n+python evaluate_counterfactual_policy.py\\\n+ --context_set 1\\\n+ --counterfactual_policy logistic_ucb\\\n+ --epsilon 0.1\\\n+ --behavior_policy bts\\\n+ --campaign men\n+```\n+\n+```bash\n+python evaluate_off_policy_estimators.py\\\n+ --n_splits 5\\\n+ --counterfactual_policy random\\\n+ --behavior_policy bts\\\n+ --campaign men\n+```\n"
},
{
"change_type": "DELETE",
"old_path": "examples/obd/off_policy_estimator_selection.py",
"new_path": null,
"diff": "-import argparse\n-from pathlib import Path\n-import yaml\n-\n-import numpy as np\n-import pandas as pd\n-from sklearn.calibration import CalibratedClassifierCV\n-from sklearn.experimental import enable_hist_gradient_boosting\n-from sklearn.ensemble import HistGradientBoostingClassifier\n-\n-from dataset import OBDWithContextSets\n-from obp.simulator import OfflineBanditSimulator\n-from obp.policy import Random, BernoulliTS\n-from obp.utils import estimate_confidence_interval_by_bootstrap\n-\n-\n-cf_policy_dict = dict(bts=Random, random=BernoulliTS) # Dict[behavior policy, counterfactual policy]\n-\n-with open('./conf/lightgbm.yaml', 'rb') as f:\n- hyperparams = yaml.safe_load(f)['model']\n-\n-with open('./conf/prior_bts.yaml', 'rb') as f:\n- production_prior_for_bts = yaml.safe_load(f)\n-\n-with open('./conf/batch_size_bts.yaml', 'rb') as f:\n- production_batch_size_for_bts = yaml.safe_load(f)\n-\n-if __name__ == '__main__':\n- parser = argparse.ArgumentParser(description='evaluate off-policy estimators')\n- parser.add_argument('--n_splits', '-n_s', type=int, default=1)\n- parser.add_argument('--n_estimators', '-n_e', type=int, default=2)\n- parser.add_argument('--behavior_policy', '-b_pol', type=str, choices=['bts', 'random'], required=True)\n- parser.add_argument('--campaign', '-camp', type=str, choices=['all', 'men', 'women'], required=True)\n- args = parser.parse_args()\n- print(args)\n-\n- n_splits = args.n_splits\n- n_estimators = args.n_estimators\n- behavior_policy = args.behavior_policy\n- campaign = args.campaign\n-\n- obd = OBDWithContextSets(\n- behavior_policy=behavior_policy,\n- campaign=campaign,\n- data_path=Path('.').resolve().parents[1] / 'obd')\n-\n- random_state = 12345\n- kwargs = dict(n_actions=obd.n_actions, len_list=obd.len_list, random_state=random_state)\n- if behavior_policy == 'random':\n- kwargs['alpha'] = production_prior_for_bts[campaign]['alpha']\n- kwargs['beta'] = production_prior_for_bts[campaign]['beta']\n- kwargs['batch_size'] = production_batch_size_for_bts[campaign]\n- policy = cf_policy_dict[behavior_policy](**kwargs)\n-\n- np.random.seed(random_state)\n- estimators = ['dm', 'ipw', 'dr']\n- ope_results = {est: np.zeros(n_splits) for est in estimators}\n- for random_state in np.arange(n_splits):\n- train, test = obd.split_data(random_state=random_state)\n- reward_test = test['reward']\n-\n- # define a regression model\n- lightgbm = HistGradientBoostingClassifier(**hyperparams)\n- regression_model = CalibratedClassifierCV(lightgbm, method='isotonic', cv=2)\n- # bagging prediction for the policy value of the counterfactual policy\n- ope_results_temp = {est: np.zeros(n_estimators) for est in estimators}\n- for seed in np.arange(n_estimators):\n- # run a bandit algorithm on logged bandit feedback\n- # and conduct off-policy evaluation by using the result of the simulation\n- train_boot = obd.sample_bootstrap(train=train)\n- # regression_model = regression_model_dict[random_state]\n- sim = OfflineBanditSimulator(\n- train=train_boot, regression_model=regression_model, X_action=obd.X_action)\n- sim.simulate(policy=policy)\n- ope_results_temp['dm'][seed] = sim.direct_method()\n- ope_results_temp['ipw'][seed] = sim.inverse_probability_weighting()\n- ope_results_temp['dr'][seed] = sim.doubly_robust()\n-\n- policy.initialize()\n-\n- # results of OPE at each train-test split\n- print('=' * 25)\n- print(f'random_state={random_state}')\n- print('-----')\n- ground_truth = np.mean(reward_test)\n- for est_name in estimators:\n- estimated_policy_value = np.mean(ope_results_temp[est_name])\n- relative_estimation_error_of_est = np.abs((estimated_policy_value - ground_truth) / ground_truth)\n- ope_results[est_name][random_state] = relative_estimation_error_of_est\n- print(f'{est_name.upper()}: {np.round(relative_estimation_error_of_est, 6)}')\n- print('=' * 25, '\\n')\n-\n- # estimate confidence intervals by nonparametric bootstrap method\n- ope_results_with_ci = {est: dict() for est in estimators}\n- for est_name in estimators:\n- ope_results_with_ci[est_name] = estimate_confidence_interval_by_bootstrap(\n- samples=ope_results[est_name], random_state=random_state)\n-\n- # save results of off-policy estimator selection\n- log_path = Path('./logs') / behavior_policy / campaign\n- pd.DataFrame(ope_results_with_ci).T.to_csv(log_path / 'off_policy_estimator_selection.csv')\n"
}
] | Python | Apache License 2.0 | st-tech/zr-obp | adjust examples to the new implementation of obp |
641,014 | 04.07.2020 19:17:49 | -32,400 | 1e8e08181919c8a594bda42225e5b4cd4ac75b74 | implement some properties and bootstrap sampling | [
{
"change_type": "MODIFY",
"old_path": "obp/dataset.py",
"new_path": "obp/dataset.py",
"diff": "from abc import ABCMeta, abstractmethod\nfrom dataclasses import dataclass\nfrom pathlib import Path\n-from typing import Tuple, Dict, Union\n+from typing import Tuple, Dict, Union, Optional\nimport numpy as np\nimport pandas as pd\nfrom scipy.stats import rankdata\nfrom sklearn.preprocessing import LabelEncoder\nfrom sklearn.model_selection import train_test_split\n+from sklearn.utils import check_random_state\n-LogBanditFeedback = Dict[str, Union[str, np.ndarray]]\n+BanditFeedback = Dict[str, Union[str, np.ndarray]]\nclass BaseBanditDataset(metaclass=ABCMeta):\n@@ -72,18 +73,64 @@ class OpenBanditDataset(BaseBanditDataset):\nself.load_raw_data()\nself.pre_process()\n- self.n_rounds = self.action.shape[0]\n- self.n_actions = self.action.max() + 1\n- self.dim_context = self.context.shape[1]\n+ @property\n+ def n_rounds(self) -> int:\n+ \"\"\"Total number of rounds in the dataset.\"\"\"\n+ return self.data.shape[0]\n+\n+ @property\n+ def n_actions(self) -> int:\n+ \"\"\"Number of actions.\"\"\"\n+ return self.action.max() + 1\n+\n+ @property\n+ def dim_context(self) -> int:\n+ \"\"\"Dimension of context vectors.\"\"\"\n+ return self.context.shape[1]\n+\n+ @property\n+ def len_list(self) -> int:\n+ \"\"\"Length of recommendation lists.\"\"\"\n+ return self.position.max() + 1\n+\n+ @classmethod\n+ def calc_on_policy_policy_value_estimate(cls,\n+ behavior_policy: str,\n+ campaign: str,\n+ data_path: Path = Path('./obd')) -> float:\n+ \"\"\"Calculate on-policy (used as a ground-truth policy value).\n+\n+ Parameters\n+ ----------\n+ behavior_policy: str\n+ Name of the behavior policy that generated the log data.\n+ Must be 'random' or 'bts'.\n+\n+ campaign: str\n+ One of the three possible campaigns (i.e., \"all\", \"men\", and \"women\").\n+\n+ data_path: Path, default: Path('./obd')\n+ Path that stores Open Bandit Dataset.\n+\n+ Returns\n+ ---------\n+ on_policy_policy_value_estimate: float\n+ Estimated on-policy policy value of behavior policy, i.e., :math:`T^{-1} \\\\sum_{t=1}^T Y_t`.\n+ This parameter is used as a ground-truth policy value in the evaluation of OPE estimators.\n+\n+ \"\"\"\n+ return cls(\n+ behavior_policy=behavior_policy,\n+ campaign=campaign,\n+ data_path=data_path\n+ ).reward.mean()\ndef load_raw_data(self) -> None:\n\"\"\"Load raw open bandit dataset.\"\"\"\n-\nself.data = pd.read_csv(self.data_path / self.raw_data_file, index_col=0)\nself.data.sort_values('timestamp', inplace=True)\nself.action = self.data['item_id'].values\n- self.pos = (rankdata(self.data['position'].values, 'dense') - 1).astype(int)\n- self.len_list = self.pos.max() + 1\n+ self.position = (rankdata(self.data['position'].values, 'dense') - 1).astype(int)\nself.reward = self.data['click'].values\nself.pscore = self.data['propensity_score'].values\n@@ -96,10 +143,55 @@ class OpenBanditDataset(BaseBanditDataset):\nitem_feature_cat = item_context.drop('item_feature_0', 1).apply(LabelEncoder().fit_transform)\nself.action_context = pd.concat([item_feature_cat, item_feature_0], 1).values\n+ def obtain_batch_bandit_feedback(self) -> BanditFeedback:\n+ \"\"\"Obtain batch logged bandit feedback.\"\"\"\n+ return dict(\n+ n_rounds=self.n_rounds,\n+ n_actions=self.n_actions,\n+ action=self.action,\n+ position=self.position,\n+ reward=self.reward,\n+ pscore=self.pscore,\n+ context=self.context,\n+ action_context=self.action_context\n+ )\n+\n+ def sample_bootstrap_bandit_feedback(self, random_state: Optional[int] = None) -> BanditFeedback:\n+ \"\"\"Sample bootstrap logged bandit feedback.\n+\n+ Parameters\n+ -----------\n+ random_state: int, default: None\n+ Controls the random seed in sampling actions.\n+\n+ Returns\n+ --------\n+ bootstrap_bandit_feedback: BanditFeedback\n+ Bootstrapped logged bandit feedback independently sampled from the original data with replacement.\n+\n+ \"\"\"\n+ random_ = check_random_state(random_state)\n+ bootstrap_idx = random_.choice(\n+ np.arange(self.n_rounds),\n+ size=self.n_rounds,\n+ replace=True\n+ )\n+\n+ return dict(\n+ n_rounds=self.n_rounds,\n+ n_actions=self.n_actions,\n+ action=self.action[bootstrap_idx],\n+ position=self.position[bootstrap_idx],\n+ reward=self.reward[bootstrap_idx],\n+ pscore=self.pscore[bootstrap_idx],\n+ context=self.context[bootstrap_idx, :],\n+ action_context=self.action_context\n+ )\n+\ndef split_data(self,\ntest_size: Union[int, float] = 0.3,\nis_timeseries_split: bool = False,\n- random_state: int = 0) -> Tuple[LogBanditFeedback, LogBanditFeedback]:\n+ random_state: int = 0) -> Tuple[BanditFeedback, BanditFeedback]:\n\"\"\"Split dataset into training and test sets.\nParameters\n@@ -116,17 +208,17 @@ class OpenBanditDataset(BaseBanditDataset):\nReturns:\n----------\n- train: LogBanditFeedback\n+ train: BanditFeedback\nDictionary storing the training set after preprocessing.\n- test: LogBanditFeedback\n+ test: BanditFeedback\nDictionary storing the test set after preprocessing.\n\"\"\"\nif is_timeseries_split:\ntest_size = test_size if isinstance(test_size, int) else np.int(test_size * self.n_rounds)\ntrain_size = np.int(self.n_rounds - test_size)\naction_train, action_test = self.action[:train_size], self.action[train_size:]\n- pos_train, pos_test = self.pos[:train_size], self.pos[train_size:]\n+ pos_train, pos_test = self.position[:train_size], self.position[train_size:]\nreward_train, reward_test = self.reward[:train_size], self.reward[train_size:]\npscore_train, pscore_test = self.pscore[:train_size], self.pscore[train_size:]\ncontext_train, context_test = self.context[:train_size], self.context[train_size:]\n@@ -135,12 +227,13 @@ class OpenBanditDataset(BaseBanditDataset):\npscore_train, pscore_test, context_train, context_test =\\\ntrain_test_split(\nself.action,\n- self.pos,\n+ self.position,\nself.reward,\nself.pscore,\nself.context,\ntest_size=test_size,\n- random_state=random_state)\n+ random_state=random_state\n+ )\nself.train_size = action_train.shape[0]\nself.test_size = action_test.shape[0]\n@@ -152,7 +245,8 @@ class OpenBanditDataset(BaseBanditDataset):\nreward=reward_train,\npscore=pscore_train,\ncontext=context_train,\n- action_context=self.action_context)\n+ action_context=self.action_context\n+ )\ntest = dict(\nn_rounds=self.test_size,\nn_actions=self.n_actions,\n@@ -161,6 +255,7 @@ class OpenBanditDataset(BaseBanditDataset):\nreward=reward_test,\npscore=pscore_test,\ncontext=context_test,\n- action_context=self.action_context)\n+ action_context=self.action_context\n+ )\nreturn train, test\n"
}
] | Python | Apache License 2.0 | st-tech/zr-obp | implement some properties and bootstrap sampling |
641,014 | 04.07.2020 19:18:18 | -32,400 | 008ecd3e2f5c58fdb718f5224fdea0d789b0210e | unify OffPolicyEvaluation and ComapreOffPolicyEstimators | [
{
"change_type": "MODIFY",
"old_path": "obp/ope/meta.py",
"new_path": "obp/ope/meta.py",
"diff": "@@ -14,8 +14,8 @@ import seaborn as sns\nfrom .estimators import BaseOffPolicyEstimator\nfrom .regression_model import RegressionModel\n-from ..dataset import LogBanditFeedback\n-from ..utils import estimate_confidence_interval_by_bootstrap, check_is_fitted\n+from ..dataset import BanditFeedback\n+from ..utils import check_is_fitted\n@dataclass\n@@ -29,8 +29,8 @@ class OffPolicyEvaluation:\nParameters\n-----------\n- train: LogBanditFeedback\n- Training set of logged bandit feedback data to be used in offline bandit simulation.\n+ bandit_feedback: BanditFeedback\n+ Logged bandit feedback data to be used in offline bandit simulation.\nope_estimators: List[BaseOffPolicyEstimator]\nList of OPE estimators used to evaluate the policy value of counterfactual (or evaluation) policy.\n@@ -42,8 +42,46 @@ class OffPolicyEvaluation:\nregression_model: RegressionModel, default: None\nRegression model that predicts the mean reward function :math:`E[Y | X, A]`.\n+ Examples\n+ ----------\n+ # a case for implementing OPE of the BernoulliTS policy\n+ # using log data generated by the Random policy\n+ >>> from obp.dataset import OpenBanditDataset\n+ >>> from obp.policy import BernoulliTS\n+ >>> from obp.simulator import run_bandit_simulation\n+ >>> from obp.ope import OffPolicyEvaluation, ReplayMethod\n+\n+ # (1) Data loading and preprocessing\n+ >>> dataset = OpenBanditDataset(behavior_policy='random', campaign='all')\n+ >>> train, test = dataset.split_data(test_size=0.3, random_state=42)\n+ >>> train.keys()\n+ dict_keys(['n_rounds', 'n_actions', 'action', 'position', 'reward', 'pscore', 'context', 'action_context'])\n+\n+ # (2) Offline Bandit Simulation\n+ >>> counterfactual_policy = BernoulliTS(n_actions=dataset.n_actions, len_list=dataset.len_list)\n+ >>> selected_actions = run_bandit_simulation(train=train, policy=counterfactual_policy)\n+ >>> selected_actions\n+ array([[24, 14, 30],\n+ [30, 27, 24],\n+ [14, 12, 32],\n+ ...,\n+ [17, 13, 30],\n+ [20, 34, 6],\n+ [30, 3, 20]])\n+\n+ # (3) Off-Policy Evaluation\n+ >>> ope = OffPolicyEvaluation(train=train, ope_estimators=[ReplayMethod()])\n+ >>> estimated_policy_value = ope.estimate_policy_values(selected_actions=selected_actions)\n+ >>> estimated_policy_value\n+ {'rm': 0.003717..}\n+\n+ # estimated performance of BernoulliTS relative to the ground-truth performance of Random\n+ >>> relative_policy_value_of_bernoulli_ts = estimated_policy_value['rm'] / test['reward'].mean()\n+ >>> relative_policy_value_of_bernoulli_ts\n+ 1.21428...\n+\n\"\"\"\n- train: LogBanditFeedback\n+ bandit_feedback: BanditFeedback\nope_estimators: List[BaseOffPolicyEstimator]\naction_context: Optional[np.ndarray] = None\nregression_model: Optional[RegressionModel] = None\n@@ -55,10 +93,14 @@ class OffPolicyEvaluation:\nlogging.info(\"a fitted regression model is given.\")\nelse:\nlogging.info(\"the given regression model is not fitted, and thus train it here...\")\n- self.regression_model.fit(train=self.train, action_context=self.action_context)\n+ self.regression_model.fit(\n+ bandit_feedback=self.bandit_feedback,\n+ action_context=self.action_context\n+ )\nelse:\nlogging.warning(\n- \"regression model is not given; model dependent estimators such as DM or DR cannot be used.\")\n+ \"regression model is not given; model dependent estimators such as DM or DR cannot be used.\"\n+ )\nself.ope_estimators_ = dict()\nfor estimator in self.ope_estimators:\n@@ -66,12 +108,16 @@ class OffPolicyEvaluation:\ndef _create_estimator_inputs(self, selected_actions: np.ndarray) -> Dict[str, np.ndarray]:\n\"\"\"Create input dictionary to estimate policy value by subclasses of `BaseOffPolicyEstimator`\"\"\"\n- estimator_inputs = {input_: self.train[input_] for input_ in ['reward', 'pscore']}\n+ estimator_inputs = {input_: self.bandit_feedback[input_] for input_ in ['reward', 'pscore']}\nestimator_inputs['action_match'] =\\\n- self.train['action'] == selected_actions[np.arange(self.train['n_rounds']), self.train['position']]\n+ self.bandit_feedback['action'] == selected_actions[\n+ np.arange(self.bandit_feedback['n_rounds']), self.bandit_feedback['position']]\nif self.regression_model is not None:\nestimator_inputs['estimated_rewards_by_reg_model'] = self.regression_model.predict(\n- train=self.train, action_context=self.action_context, selected_actions=selected_actions)\n+ bandit_feedback=self.bandit_feedback,\n+ action_context=self.action_context,\n+ selected_actions=selected_actions\n+ )\nreturn estimator_inputs\ndef estimate_policy_values(self, selected_actions: np.ndarray) -> Dict[str, float]:\n@@ -159,13 +205,15 @@ class OffPolicyEvaluation:\n\"\"\"\npolicy_value_df = pd.DataFrame(\nself.estimate_policy_values(selected_actions=selected_actions),\n- index=['estimated_policy_value'])\n+ index=['estimated_policy_value']\n+ )\npolicy_value_interval_df = pd.DataFrame(\nself.estimate_intervals(\nselected_actions=selected_actions,\nalpha=alpha,\nn_bootstrap_samples=n_bootstrap_samples,\n- random_state=random_state))\n+ random_state=random_state)\n+ )\nreturn policy_value_df.T, policy_value_interval_df.T\n@@ -208,7 +256,8 @@ class OffPolicyEvaluation:\nestimated_round_rewards_df = pd.DataFrame(estimated_round_rewards_dict)\nestimated_round_rewards_df.rename(\ncolumns={key: key.upper() for key in estimated_round_rewards_dict.keys()},\n- inplace=True) # use uppercase as column names\n+ inplace=True\n+ )\nfig, ax = plt.subplots(figsize=(8, 6))\nsns.barplot(data=estimated_round_rewards_df, ax=ax,\n@@ -222,40 +271,9 @@ class OffPolicyEvaluation:\nfig_name = fig_name if fig_name is not None else 'estimated_policy_value.png'\nfig.savefig(str(fig_dir / fig_name))\n-\n-@dataclass\n-class CompareOffPolicyEstimators(OffPolicyEvaluation):\n- \"\"\"Class to compare estimation performance of multiple off-policy estimators.\n-\n- Note\n- ------\n- When you use model dependent estimators such as Direct Method and Doubly Robust,\n- you must give action context and regression model when defining this class.\n-\n- Parameters\n- -----------\n- train: LogBanditFeedback\n- Training set of logged bandit feedback data to be used in offline bandit simulation.\n-\n- ope_estimators: List[BaseOffPolicyEstimator]\n- List of OPE estimators used to evaluate the policy value of counterfactual (or evaluation) policy.\n- Estimators must follow the interface of `obp.ope.BaseOffPolicyEstimator`.\n-\n- action_context: array-like, shape (n_actions, dim_action_context), default: None\n- Context vectors used as input to predict the mean reward function.\n-\n- regression_model: RegressionModel, default: None\n- Regression model that predicts the mean reward function :math:`E[R | X, A]`.\n-\n- \"\"\"\n- factual_rewards: np.ndarray = None\n-\n- def __post_init__(self):\n- \"\"\"Initialize class.\"\"\"\n- self.ground_truth_policy_value = np.mean(self.factual_rewards)\n- return super().__post_init__()\n-\n- def evaluate_performance_of_estimators(self, selected_actions: np.ndarray) -> Dict[str, float]:\n+ def evaluate_performance_of_estimators(self,\n+ selected_actions: np.ndarray,\n+ ground_truth_policy_value: float) -> Dict[str, float]:\n\"\"\"Evaluate results of off-policy estimators by relative estimation error.\nEvaluate the performacnce of off-policy estimators by the following relative estimation error.\n@@ -272,6 +290,10 @@ class CompareOffPolicyEstimators(OffPolicyEvaluation):\nselected_actions: array-like, shape (n_rounds, len_list)\nLists of actions selected by counterfactual (or evaluation) policy at each round in offline bandit simulation.\n+ ground_truth policy value: int\n+ Ground_truth policy value of a counterfactual policy, i.e., :math:`V(\\\\pi)`.\n+ With Open Bandit Dataset, in general, we use an on-policy estimate of the policy value as ground-truth.\n+\nReturns\n----------\nrelative_estimation_error_dict: Dict[str, float]\n@@ -283,39 +305,10 @@ class CompareOffPolicyEstimators(OffPolicyEvaluation):\nfor estimator_name, estimator in self.ope_estimators_.items():\nestimated_policy_value = estimator.estimate_policy_value(**estimator_inputs)\nrelative_estimation_error_dict[estimator_name] =\\\n- np.abs((estimated_policy_value - self.ground_truth_policy_value) / self.ground_truth_policy_value)\n+ np.abs((estimated_policy_value - ground_truth_policy_value) / ground_truth_policy_value)\nreturn relative_estimation_error_dict\n- def estimate_confidence_interval_of_ground_truth(self,\n- alpha: float = 0.05,\n- n_bootstrap_samples: int = 100,\n- random_state: Optional[int] = None) -> Dict[str, float]:\n- \"\"\"Estimate confidence intercal of ground truth policy value.\n-\n- Parameters\n- ----------\n- alpha: float, default: 0.05\n- P-value.\n-\n- n_bootstrap_samples: int, default: 100\n- Number of resampling performed in the bootstrap procedure.\n-\n- random_state: int, default: None\n- Controls the random seed in bootstrap sampling.\n-\n- Returns\n- ----------\n- estimated_confidence_interval_of_ground_truth: Dict[str, float]\n- Dictionary containing confidence interval of ground truth policy value estimate by nonparametric bootstrap procedure.\n-\n- \"\"\"\n- return estimate_confidence_interval_by_bootstrap(\n- samples=self.factual_rewards,\n- alpha=alpha,\n- n_bootstrap_samples=n_bootstrap_samples,\n- random_state=random_state)\n-\ndef summarize_estimators_comparison(self, selected_actions: np.ndarray) -> pd.DataFrame:\n\"\"\"Summarize performance comparison of given off-policy estimators.\n@@ -332,6 +325,7 @@ class CompareOffPolicyEstimators(OffPolicyEvaluation):\n\"\"\"\nrelative_estimation_error_df = pd.DataFrame(\nself.evaluate_performance_of_estimators(selected_actions=selected_actions),\n- index=['relative_estimation_error']).T\n+ index=['relative_estimation_error']\n+ )\n- return relative_estimation_error_df\n+ return relative_estimation_error_df.T\n"
}
] | Python | Apache License 2.0 | st-tech/zr-obp | unify OffPolicyEvaluation and ComapreOffPolicyEstimators |
641,014 | 04.07.2020 19:18:36 | -32,400 | de6bc8ccd9b921f97a6c63d5ac792c70abba4277 | adjust to the change of OBP implementations | [
{
"change_type": "MODIFY",
"old_path": "examples/obd/evaluate_counterfactual_policy.py",
"new_path": "examples/obd/evaluate_counterfactual_policy.py",
"diff": "@@ -55,24 +55,30 @@ if __name__ == '__main__':\ncontext_set=context_set\n)\n- kwargs = dict(n_actions=obd.n_actions, len_list=obd.len_list, dim=obd.dim_context, epsilon=epsilon)\n+ kwargs = dict(\n+ n_actions=obd.n_actions,\n+ len_list=obd.len_list,\n+ dim=obd.dim_context,\n+ random_state=random_state\n+ )\n+ if counterfactual_policy != 'logistic_ts':\n+ kwargs['epsilon'] = epsilon\npolicy = counterfactual_policy_dict[counterfactual_policy](**kwargs)\n- policy_name = policy.policy_name + '_' + context_set\n+ policy_name = f'{policy.policy_name}_{context_set}'\n- np.random.seed(random_state)\n# split dataset into training and test sets\n- train, test = obd.split_data(random_state=random_state)\n+ bandit_feedback = obd.obtain_batch_bandit_feedback()\n# ground-truth policy value of the random policy\n# , which is the empirical mean of the factual (observed) rewards\n- ground_truth = np.mean(test['reward'])\n+ ground_truth = bandit_feedback['reward'].mean()\n# a base ML model for regression model used in Direct Method and Doubly Robust\nbase_model = CalibratedClassifierCV(HistGradientBoostingClassifier(**hyperparams))\n# run a counterfactual bandit algorithm on logged bandit feedback data\n- selected_actions = run_bandit_simulation(train=train, policy=policy)\n+ selected_actions = run_bandit_simulation(bandit_feedback=bandit_feedback, policy=policy)\n# estimate the policy value of a given counterfactual algorithm by the three OPE estimators.\nope = OffPolicyEvaluation(\n- train=train,\n+ bandit_feedback=bandit_feedback,\nregression_model=RegressionModel(base_model=base_model),\naction_context=obd.action_context,\nope_estimators=[InverseProbabilityWeighting(), DirectMethod(), DoublyRobust()]\n"
},
{
"change_type": "MODIFY",
"old_path": "examples/obd/evaluate_off_policy_estimators.py",
"new_path": "examples/obd/evaluate_off_policy_estimators.py",
"diff": "@@ -13,7 +13,7 @@ from obp.simulator import run_bandit_simulation\nfrom obp.policy import Random, BernoulliTS\nfrom obp.ope import (\nRegressionModel,\n- CompareOffPolicyEstimators,\n+ OffPolicyEvaluation,\nInverseProbabilityWeighting,\nDirectMethod,\nDoublyRobust\n@@ -39,7 +39,7 @@ counterfactual_policy_dict = dict(\nif __name__ == '__main__':\nparser = argparse.ArgumentParser(description='evaluate off-policy estimators')\n- parser.add_argument('--n_splits', '-n_s', type=int, default=1)\n+ parser.add_argument('--n_boot_samples', '-n_b', type=int, default=1)\nparser.add_argument('--counterfactual_policy', '-c_pol', type=str, choices=['bts', 'random'], required=True)\nparser.add_argument('--behavior_policy', '-b_pol', type=str, choices=['bts', 'random'], required=True)\nparser.add_argument('--campaign', '-camp', type=str, choices=['all', 'men', 'women'], required=True)\n@@ -47,7 +47,7 @@ if __name__ == '__main__':\nargs = parser.parse_args()\nprint(args)\n- n_splits = args.n_splits\n+ n_boot_samples = args.n_boot_samples\ncounterfactual_policy = args.counterfactual_policy\nbehavior_policy = args.behavior_policy\ncampaign = args.campaign\n@@ -61,11 +61,11 @@ if __name__ == '__main__':\n)\nkwargs = dict(n_actions=obd.n_actions, len_list=obd.len_list, random_state=random_state)\n- if behavior_policy == 'random':\n+ if counterfactual_policy == 'bts':\nkwargs['alpha'] = production_prior_for_bts[campaign]['alpha']\nkwargs['beta'] = production_prior_for_bts[campaign]['beta']\nkwargs['batch_size'] = production_batch_size_for_bts[campaign]\n- policy = counterfactual_policy_dict[behavior_policy](**kwargs)\n+ policy = counterfactual_policy_dict[counterfactual_policy](**kwargs)\n# compared OPE estimators\nope_estimators = [\nDirectMethod(),\n@@ -74,28 +74,35 @@ if __name__ == '__main__':\n]\n# a base ML model for regression model used in Direct Method and Doubly Robust\nbase_model = CalibratedClassifierCV(HistGradientBoostingClassifier(**hyperparams))\n+ # ground-truth policy value of a counterfactual policy\n+ # , which is estimated with factual (observed) rewards (on-policy estimation)\n+ ground_truth_policy_value = OpenBanditDataset.calc_on_policy_policy_value_estimate(\n+ behavior_policy=counterfactual_policy,\n+ campaign=campaign,\n+ data_path=data_path\n+ )\n- evaluation_of_ope_results = {est.estimator_name: np.zeros(n_splits) for est in ope_estimators}\n- for s in np.arange(n_splits):\n- # split dataset into training and test sets\n- train, test = obd.split_data(test_size=0.3, random_state=s)\n+ evaluation_of_ope_results = {est.estimator_name: np.zeros(n_boot_samples) for est in ope_estimators}\n+ for b in np.arange(n_boot_samples):\n+ # sample bootstrap from batch logged bandit feedback\n+ boot_bandit_feebdack = obd.sample_bootstrap_bandit_feedback(random_state=b)\n# run a counterfactual bandit algorithm on logged bandit feedback data\n- selected_actions = run_bandit_simulation(train=train, policy=policy)\n+ selected_actions = run_bandit_simulation(bandit_feedback=boot_bandit_feebdack, policy=policy)\n# evaluate the estimation performance of OPE estimators\n- compare_ope = CompareOffPolicyEstimators(\n- train=train,\n- factual_rewards=test['reward'],\n+ ope = OffPolicyEvaluation(\n+ bandit_feedback=boot_bandit_feebdack,\naction_context=obd.action_context,\nregression_model=RegressionModel(base_model=base_model),\nope_estimators=ope_estimators\n)\n- relative_estimation_errors = compare_ope.evaluate_performance_of_estimators(\n- selected_actions=selected_actions\n+ relative_estimation_errors = ope.evaluate_performance_of_estimators(\n+ selected_actions=selected_actions,\n+ ground_truth_policy_value=ground_truth_policy_value\n)\npolicy.initialize()\n# store relative estimation errors of OPE estimators at each split\nfor estimator_name, relative_estimation_error in relative_estimation_errors.items():\n- evaluation_of_ope_results[estimator_name][s] = relative_estimation_error\n+ evaluation_of_ope_results[estimator_name][b] = relative_estimation_error\n# estimate confidence intervals of relative estimation by nonparametric bootstrap method\nevaluation_of_ope_results_with_ci = {est.estimator_name: dict() for est in ope_estimators}\n@@ -112,6 +119,6 @@ if __name__ == '__main__':\nprint(evaluation_of_ope_results_df)\nprint('=' * 50)\n- # save results of evaluation of off-policy estimators\n+ # save results of the evaluation of off-policy estimators\nlog_path = Path('./logs') / behavior_policy / campaign\nevaluation_of_ope_results_df.to_csv(log_path / 'comparison_of_ope_estimators.csv')\n"
}
] | Python | Apache License 2.0 | st-tech/zr-obp | adjust to the change of OBP implementations |
641,014 | 04.07.2020 19:39:13 | -32,400 | 3d9b7f9f42d86c48055582f864669ac6c05b8f72 | update README and quickstart | [
{
"change_type": "MODIFY",
"old_path": "examples/quickstart/quickstart.ipynb",
"new_path": "examples/quickstart/quickstart.ipynb",
"diff": "\"# (1) Data loading and preprocessing\\n\",\n\"# specify path of dataset\\n\",\n\"data_path = Path('.').resolve().parents[1] / 'obd'\\n\",\n- \"# load and preprocess raw data in \\\"Men\\\" campaign collected by the Random policy (behavior policy here)\\n\",\n+ \"# load and preprocess raw data in \\\"Women\\\" campaign collected by the Random policy (behavior policy here)\\n\",\n\"dataset = OpenBanditDataset(behavior_policy='random', campaign='women', data_path=data_path)\\n\",\n- \"# split the original data into 80% training and 20% test sets\\n\",\n+ \"# obtain logged bandit feedback generated by behavior polciy\\n\",\n\"bandit_feedback = dataset.obtain_batch_bandit_feedback()\\n\",\n\"\\n\",\n\"bandit_feedback.keys() # `train` is a dictionary storing logged bandit feedback\"\n"
}
] | Python | Apache License 2.0 | st-tech/zr-obp | update README and quickstart |
641,014 | 04.07.2020 23:18:22 | -32,400 | f0d931346109c1d20faedfeb61bd11b8b7239201 | disable timeseries split | [
{
"change_type": "MODIFY",
"old_path": "obp/dataset.py",
"new_path": "obp/dataset.py",
"diff": "@@ -190,7 +190,6 @@ class OpenBanditDataset(BaseBanditDataset):\ndef split_data(self,\ntest_size: Union[int, float] = 0.3,\n- is_timeseries_split: bool = False,\nrandom_state: int = 0) -> Tuple[BanditFeedback, BanditFeedback]:\n\"\"\"Split dataset into training and test sets.\n@@ -200,9 +199,6 @@ class OpenBanditDataset(BaseBanditDataset):\nIf float, should be between 0.0 and 1.0 and represent the proportion of the dataset to include in the test split.\nIf int, represents the absolute number of test samples.\n- is_timeseries_split: bool, default: False\n- If true, split data by time series.\n-\nrandom_state: int, default: 0\nControls the shuffling applied to the data before applying the split.\n@@ -214,15 +210,6 @@ class OpenBanditDataset(BaseBanditDataset):\ntest: BanditFeedback\nDictionary storing the test set after preprocessing.\n\"\"\"\n- if is_timeseries_split:\n- test_size = test_size if isinstance(test_size, int) else np.int(test_size * self.n_rounds)\n- train_size = np.int(self.n_rounds - test_size)\n- action_train, action_test = self.action[:train_size], self.action[train_size:]\n- pos_train, pos_test = self.position[:train_size], self.position[train_size:]\n- reward_train, reward_test = self.reward[:train_size], self.reward[train_size:]\n- pscore_train, pscore_test = self.pscore[:train_size], self.pscore[train_size:]\n- context_train, context_test = self.context[:train_size], self.context[train_size:]\n- else:\naction_train, action_test, pos_train, pos_test, reward_train, reward_test,\\\npscore_train, pscore_test, context_train, context_test =\\\ntrain_test_split(\n"
}
] | Python | Apache License 2.0 | st-tech/zr-obp | disable timeseries split |
641,014 | 09.07.2020 18:23:48 | -32,400 | 434c6db8b20a439175bd818fc116668a35928e0e | fix attribution error in LogisticTS | [
{
"change_type": "MODIFY",
"old_path": "obp/policy/contextual.py",
"new_path": "obp/policy/contextual.py",
"diff": "\"\"\"Contextual Bandit Algorithms.\"\"\"\nfrom dataclasses import dataclass\n+from typing import Optional\nimport numpy as np\n+from sklearn.utils import check_random_state\nfrom scipy.optimize import minimize\n+\nfrom .base import BaseContextualPolicy\nfrom ..utils import sigmoid\n@@ -263,13 +266,18 @@ class LogisticTS(BaseContextualPolicy):\n\"\"\"\npolicy_name: str = 'logistic_ts'\n- def __init__(self) -> None:\n+ def __post_init__(self) -> None:\n\"\"\"Initialize class.\"\"\"\nsuper().__post_init__()\nself.model_list = [\nMiniBatchLogisticRegression(\n- lambda_=self.lambda_list[i], alpha=self.alpha_list[i], dim=self.dim)\n- for i in np.arange(self.n_actions)]\n+ lambda_=self.lambda_list[i],\n+ alpha=self.alpha_list[i],\n+ dim=self.dim,\n+ random_state=self.random_state\n+ )\n+ for i in np.arange(self.n_actions)\n+ ]\nself.reward_lists = [[] for i in np.arange(self.n_actions)]\nself.context_lists = [[] for i in np.arange(self.n_actions)]\n@@ -327,11 +335,13 @@ class MiniBatchLogisticRegression:\nlambda_: float\nalpha: float\ndim: int\n+ random_state: Optional[int] = None\ndef __post_init__(self) -> None:\n\"\"\"Initialize Class.\"\"\"\nself._m = np.zeros(self.dim)\nself._q = np.ones(self.dim) * self.lambda_\n+ self.random_ = check_random_state(self.random_state)\ndef loss(self, w: np.ndarray, *args) -> float:\n\"\"\"Calculate loss function.\"\"\"\n"
}
] | Python | Apache License 2.0 | st-tech/zr-obp | fix attribution error in LogisticTS |
641,014 | 19.07.2020 09:33:13 | -32,400 | e34c3eb3c17c5899d46460b88df6bb33d53c96ae | add relative option to visualize method | [
{
"change_type": "MODIFY",
"old_path": "obp/ope/meta.py",
"new_path": "obp/ope/meta.py",
"diff": "@@ -224,8 +224,8 @@ class OffPolicyEvaluation:\ndef visualize_off_policy_estimates(self,\nselected_actions: np.ndarray,\nalpha: float = 0.05,\n+ relative: bool = False,\nn_bootstrap_samples: int = 100,\n- random_state: Optional[int] = None,\nfig_dir: Optional[Path] = None,\nfig_name: Optional[str] = None) -> None:\n\"\"\"Visualize estimated policy values by given off-policy evaluation.\n@@ -241,8 +241,9 @@ class OffPolicyEvaluation:\nn_bootstrap_samples: int, default: 100\nNumber of resampling performed in the bootstrap procedure.\n- random_state: int, default: None\n- Controls the random seed in bootstrap sampling.\n+ relative: bool, default: False,\n+ If True, the method visualizes the estimated policy values of counterfactual policy\n+ relative to the ground-truth policy value of behavior policy\nfig_dir: Path, default: None\nDierctory to store the bar figure.\n@@ -262,6 +263,8 @@ class OffPolicyEvaluation:\ncolumns={key: key.upper() for key in estimated_round_rewards_dict.keys()},\ninplace=True\n)\n+ if relative:\n+ estimated_round_rewards_df /= self.bandit_feedback['reward'].mean()\nfig, ax = plt.subplots(figsize=(8, 6))\nsns.barplot(data=estimated_round_rewards_df, ax=ax,\n"
}
] | Python | Apache License 2.0 | st-tech/zr-obp | add relative option to visualize method |
641,014 | 19.07.2020 10:05:56 | -32,400 | 8c505b79921cd41f3f904df5a45ca04762df8db3 | add some dataset descriptions | [
{
"change_type": "MODIFY",
"old_path": "README.md",
"new_path": "README.md",
"diff": "@@ -50,6 +50,7 @@ Each campaign randomly used either the Random algorithm or the Bernoulli Thompso\n<img width=\"70%\" src=\"./images/statistics_of_obd.png\" />\n</p>\n+Please see [./obd/README.md](./obd/README.md) for the description of the dataset.\n## Open Bandit Pipeline (OBP)\n"
},
{
"change_type": "ADD",
"old_path": "images/dataset.png",
"new_path": "images/dataset.png",
"diff": "Binary files /dev/null and b/images/dataset.png differ\n"
},
{
"change_type": "MODIFY",
"old_path": "obd/README.md",
"new_path": "obd/README.md",
"diff": "@@ -25,8 +25,17 @@ Here is a detailed description of the fields (they are comma-separated in the CS\n- position: the position of an item being recommended (1, 2, or 3 correspond to left, center, and right position of the ZOZOTOWN recommendation interface, respectively).\n- click: target variable that indicates if an item was clicked (1) or not (0).\n- propensity_score: the probability of an item being recommended at each position.\n-- user feature 0-4: user-related feature values\n-- user-item affinity 0-: user-item affinity scores induced by the number of past clicks observed between each user-item pair\n+- user feature 0-4: user-related feature values.\n+- user-item affinity 0-: user-item affinity scores induced by the number of past clicks observed between each user-item pair.\n+\n+<p align=\"center\">\n+ <img width=\"85%\" src=\"../images/dataset.png\" />\n+ <figcaption>\n+ <p align=\"center\">\n+ Structure of Open Bandit Dataset\n+ </p>\n+ </figcaption>\n+</p>\n**item_context.csv**\n- item_id: index of items as arms (index ranges from 0-80 in \"All\" campaign, 0-33 for \"Men\" campaign, and 0-46 \"Women\" campaign).\n"
}
] | Python | Apache License 2.0 | st-tech/zr-obp | add some dataset descriptions |
641,014 | 22.07.2020 08:07:42 | -32,400 | 1b50ecce0e29124b1e6814a09a6939febbd54891 | add synthetic dataset class | [
{
"change_type": "ADD",
"old_path": null,
"new_path": "obp/dataset/__init__.py",
"diff": "+from .base import *\n+from .real import *\n+from .synthetic import *\n"
},
{
"change_type": "ADD",
"old_path": null,
"new_path": "obp/dataset/base.py",
"diff": "+# Copyright (c) ZOZO Technologies, Inc. All rights reserved.\n+# Licensed under the Apache 2.0 License.\n+\n+\"\"\"Abstract Base Class for Logged Bandit Feedback.\"\"\"\n+from abc import ABCMeta, abstractmethod\n+from typing import Dict, Union\n+\n+import numpy as np\n+\n+BanditFeedback = Dict[str, Union[str, np.ndarray]]\n+\n+\n+class BaseRealBanditDataset(metaclass=ABCMeta):\n+ \"\"\"Base Class for Real-World Bandit Dataset.\"\"\"\n+\n+ @abstractmethod\n+ def load_raw_data(self) -> None:\n+ \"\"\"Load raw dataset.\"\"\"\n+ raise NotImplementedError()\n+\n+ @abstractmethod\n+ def pre_process(self) -> None:\n+ \"\"\"Preprocess raw dataset.\"\"\"\n+ raise NotImplementedError()\n+\n+ @abstractmethod\n+ def obtain_batch_bandit_feedback(self) -> None:\n+ \"\"\"Obtain batch logged bandit feedback.\"\"\"\n+ raise NotImplementedError()\n+\n+\n+class BaseSyntheticBanditDataset(metaclass=ABCMeta):\n+ \"\"\"Base Class for Synthetic Bandit Dataset.\"\"\"\n+\n+ @abstractmethod\n+ def obtain_batch_bandit_feedback(self) -> None:\n+ \"\"\"Obtain batch logged bandit feedback.\"\"\"\n+ raise NotImplementedError()\n"
},
{
"change_type": "ADD",
"old_path": null,
"new_path": "obp/dataset/real.py",
"diff": "+# Copyright (c) ZOZO Technologies, Inc. All rights reserved.\n+# Licensed under the Apache 2.0 License.\n+\n+\"\"\"Dataset Class for Real-World Logged Bandit Feedback.\"\"\"\n+from dataclasses import dataclass\n+from pathlib import Path\n+from typing import Tuple, Union, Optional\n+\n+import numpy as np\n+import pandas as pd\n+from scipy.stats import rankdata\n+from sklearn.preprocessing import LabelEncoder\n+from sklearn.model_selection import train_test_split\n+from sklearn.utils import check_random_state\n+from .base import BaseRealBanditDataset, BanditFeedback\n+\n+\n+@dataclass\n+class OpenBanditDataset(BaseRealBanditDataset):\n+ \"\"\"Class for loading and preprocessing Open Bandit Dataset.\n+\n+ Note\n+ -----\n+ Users are free to implement their own featuer engineering by overriding `pre_process` method.\n+\n+ Parameters\n+ ----------\n+ behavior_policy: str\n+ Name of the behavior policy that generated the log data.\n+ Must be 'random' or 'bts'.\n+\n+ campaign: str\n+ One of the three possible campaigns (i.e., \"all\", \"men\", and \"women\").\n+\n+ data_path: Path, default: Path('./obd')\n+ Path that stores Open Bandit Dataset.\n+\n+ dataset_name: str, default: 'obd'\n+ Name of the dataset.\n+\n+ \"\"\"\n+ behavior_policy: str\n+ campaign: str\n+ data_path: Path = Path('./obd')\n+ dataset_name: str = 'obd'\n+\n+ def __post_init__(self) -> None:\n+ \"\"\"Initialize Open Bandit Dataset Class.\"\"\"\n+ self.data_path = self.data_path / self.behavior_policy / self.campaign\n+ self.raw_data_file = f'{self.campaign}.csv'\n+\n+ self.load_raw_data()\n+ self.pre_process()\n+\n+ @property\n+ def n_rounds(self) -> int:\n+ \"\"\"Total number of rounds in the dataset.\"\"\"\n+ return self.data.shape[0]\n+\n+ @property\n+ def n_actions(self) -> int:\n+ \"\"\"Number of actions.\"\"\"\n+ return self.action.max() + 1\n+\n+ @property\n+ def dim_context(self) -> int:\n+ \"\"\"Dimension of context vectors.\"\"\"\n+ return self.context.shape[1]\n+\n+ @property\n+ def len_list(self) -> int:\n+ \"\"\"Length of recommendation lists.\"\"\"\n+ return self.position.max() + 1\n+\n+ @classmethod\n+ def calc_on_policy_policy_value_estimate(cls,\n+ behavior_policy: str,\n+ campaign: str,\n+ data_path: Path = Path('./obd')) -> float:\n+ \"\"\"Calculate on-policy (used as a ground-truth policy value).\n+\n+ Parameters\n+ ----------\n+ behavior_policy: str\n+ Name of the behavior policy that generated the log data.\n+ Must be 'random' or 'bts'.\n+\n+ campaign: str\n+ One of the three possible campaigns (i.e., \"all\", \"men\", and \"women\").\n+\n+ data_path: Path, default: Path('./obd')\n+ Path that stores Open Bandit Dataset.\n+\n+ Returns\n+ ---------\n+ on_policy_policy_value_estimate: float\n+ Estimated on-policy policy value of behavior policy, i.e., :math:`T^{-1} \\\\sum_{t=1}^T Y_t`.\n+ This parameter is used as a ground-truth policy value in the evaluation of OPE estimators.\n+\n+ \"\"\"\n+ return cls(\n+ behavior_policy=behavior_policy,\n+ campaign=campaign,\n+ data_path=data_path\n+ ).reward.mean()\n+\n+ def load_raw_data(self) -> None:\n+ \"\"\"Load raw open bandit dataset.\"\"\"\n+ self.data = pd.read_csv(self.data_path / self.raw_data_file, index_col=0)\n+ self.data.sort_values('timestamp', inplace=True)\n+ self.action = self.data['item_id'].values\n+ self.position = (rankdata(self.data['position'].values, 'dense') - 1).astype(int)\n+ self.reward = self.data['click'].values\n+ self.pscore = self.data['propensity_score'].values\n+\n+ def pre_process(self) -> None:\n+ \"\"\"Preprocess raw open bandit dataset.\"\"\"\n+ user_cols = self.data.columns.str.contains('user_feature')\n+ self.context = pd.get_dummies(self.data.loc[:, user_cols], drop_first=True).values\n+ item_context = pd.read_csv(self.data_path / 'item_context.csv', index_col=0)\n+ item_feature_0 = item_context['item_feature_0']\n+ item_feature_cat = item_context.drop('item_feature_0', 1).apply(LabelEncoder().fit_transform)\n+ self.action_context = pd.concat([item_feature_cat, item_feature_0], 1).values\n+\n+ def obtain_batch_bandit_feedback(self) -> BanditFeedback:\n+ \"\"\"Obtain batch logged bandit feedback.\"\"\"\n+ return dict(\n+ n_rounds=self.n_rounds,\n+ n_actions=self.n_actions,\n+ action=self.action,\n+ position=self.position,\n+ reward=self.reward,\n+ pscore=self.pscore,\n+ context=self.context,\n+ action_context=self.action_context\n+ )\n+\n+ def sample_bootstrap_bandit_feedback(self, random_state: Optional[int] = None) -> BanditFeedback:\n+ \"\"\"Sample bootstrap logged bandit feedback.\n+\n+ Parameters\n+ -----------\n+ random_state: int, default: None\n+ Controls the random seed in sampling actions.\n+\n+ Returns\n+ --------\n+ bootstrap_bandit_feedback: BanditFeedback\n+ Bootstrapped logged bandit feedback independently sampled from the original data with replacement.\n+\n+ \"\"\"\n+ random_ = check_random_state(random_state)\n+ bootstrap_idx = random_.choice(\n+ np.arange(self.n_rounds),\n+ size=self.n_rounds,\n+ replace=True\n+ )\n+\n+ return dict(\n+ n_rounds=self.n_rounds,\n+ n_actions=self.n_actions,\n+ action=self.action[bootstrap_idx],\n+ position=self.position[bootstrap_idx],\n+ reward=self.reward[bootstrap_idx],\n+ pscore=self.pscore[bootstrap_idx],\n+ context=self.context[bootstrap_idx, :],\n+ action_context=self.action_context\n+ )\n+\n+ def split_data(self,\n+ test_size: Union[int, float] = 0.3,\n+ random_state: int = 0) -> Tuple[BanditFeedback, BanditFeedback]:\n+ \"\"\"Split dataset into training and test sets.\n+\n+ Parameters\n+ ----------\n+ test_size: int, float, default=0.3\n+ If float, should be between 0.0 and 1.0 and represent the proportion of the dataset to include in the test split.\n+ If int, represents the absolute number of test samples.\n+\n+ random_state: int, default: 0\n+ Controls the shuffling applied to the data before applying the split.\n+\n+ Returns:\n+ ----------\n+ train: BanditFeedback\n+ Dictionary storing the training set after preprocessing.\n+\n+ test: BanditFeedback\n+ Dictionary storing the test set after preprocessing.\n+ \"\"\"\n+ action_train, action_test, pos_train, pos_test, reward_train, reward_test,\\\n+ pscore_train, pscore_test, context_train, context_test =\\\n+ train_test_split(\n+ self.action,\n+ self.position,\n+ self.reward,\n+ self.pscore,\n+ self.context,\n+ test_size=test_size,\n+ random_state=random_state\n+ )\n+\n+ self.train_size = action_train.shape[0]\n+ self.test_size = action_test.shape[0]\n+ train = dict(\n+ n_rounds=self.train_size,\n+ n_actions=self.n_actions,\n+ action=action_train,\n+ position=pos_train,\n+ reward=reward_train,\n+ pscore=pscore_train,\n+ context=context_train,\n+ action_context=self.action_context\n+ )\n+ test = dict(\n+ n_rounds=self.test_size,\n+ n_actions=self.n_actions,\n+ action=action_test,\n+ position=pos_test,\n+ reward=reward_test,\n+ pscore=pscore_test,\n+ context=context_test,\n+ action_context=self.action_context\n+ )\n+\n+ return train, test\n"
},
{
"change_type": "ADD",
"old_path": null,
"new_path": "obp/dataset/synthetic.py",
"diff": "+# Copyright (c) ZOZO Technologies, Inc. All rights reserved.\n+# Licensed under the Apache 2.0 License.\n+\n+\"\"\"Class for Generating Synthetic Logged Bandit Feedback.\"\"\"\n+from dataclasses import dataclass\n+from typing import Optional, Callable\n+\n+import numpy as np\n+from sklearn.utils import check_random_state\n+\n+from .base import BaseSyntheticBanditDataset, BanditFeedback\n+from ..utils import sigmoid, softmax\n+\n+\n+@dataclass\n+class SyntheticBanditDataset(BaseSyntheticBanditDataset):\n+ \"\"\"Class for generating synthetic bandit dataset.\n+\n+ Note\n+ -----\n+ By calling the `obtain_batch_bandit_feedback` method several times,\n+ we have different bandit samples with the same setting.\n+ This can be used to estimate confidence intervals of performance of OPE estimators.\n+\n+ If None is set as `behavior_policy_function`, the synthetic data will be context-free bandit feedback.\n+\n+ Parameters\n+ ----------\n+ n_actions: int\n+ Number of actions.\n+\n+ dim_context: int\n+ Dimetion of context vectors.\n+\n+ dim_action_context: int\n+ Dimetion of context vectors for each action.\n+\n+ reward_function: Callable[[np.ndarray, np.ndarray], np.ndarray]], default: None\n+ Function generating expected reward with context and action context vectors,\n+ i.e., :math:`\\\\mu: \\\\mathcal{X} \\\\times \\\\mathcal{A} \\\\rightarrow \\\\mathbb{R}`.\n+ If None is set, context **independent** expected reward for each action will be\n+ sampled from the uniform distribution automatically.\n+\n+ behavior_policy_function: Callable[[np.ndarray, np.ndarray], np.ndarray], default: None\n+ Function generating probability distribution over action space,\n+ i.e., :math:`\\\\pi: \\\\mathcal{X} \\\\rightarrow \\\\Delta(\\\\mathcal{A})`.\n+ If None is set, context **independent** probability of choosing each action will be\n+ sampled from the uniform distribution automatically (context-free behavior policy).\n+\n+ random_state: int, default: None\n+ Controls the random seed in sampling dataset.\n+\n+ dataset_name: str, default: 'synthetic_contextual_bandit_dataset'\n+ Name of the dataset.\n+\n+ Examples\n+ ----------\n+\n+ .. code-block:: python\n+\n+ >>> import numpy as np\n+ >>> from obp.dataset import (\n+ SyntheticBanditDataset,\n+ linear_reward_function,\n+ linear_behavior_policy\n+ )\n+\n+ # generate synthetic contextual bandit feedback with 10 actions.\n+ >>> dataset = SyntheticBanditDataset(\n+ n_actions=10,\n+ dim_context=5,\n+ dim_action_context=5,\n+ reward_function=linear_reward_function,\n+ behavior_policy=linear_behavior_policy,\n+ random_state=12345\n+ )\n+ >>> bandit_feedback = dataset.obtain_batch_bandit_feedback(n_rounds=100000)\n+ >>> print(bandit_feedback)\n+ {\n+ 'n_rounds': 100000,\n+ 'n_actions': 10,\n+ 'context': array([[ 0.06987669, 0.24667411, -0.0118616 , 1.00481159, 1.32719461],\n+ [-0.91926156, -1.54910644, 0.0221846 , 0.75836315, -0.66052433],\n+ [ 0.86258008, -0.0100319 , 0.05000936, 0.67021559, 0.85296503],\n+ ...,\n+ [ 0.09658876, 2.03636863, 0.40584106, -0.49167468, -0.44993244],\n+ [-1.13892634, -1.71173775, -0.98117438, 1.84662775, -1.47738898],\n+ [ 1.19581374, -2.24630358, 0.25097774, -0.12573204, -1.07518047]]),\n+ 'action': array([0, 3, 7, ..., 9, 2, 1]),\n+ 'position': array([0, 0, 0, ..., 0, 0, 0]),\n+ 'reward': array([1, 0, 0, ..., 1, 0, 0]),\n+ 'expected_reward': array([[0.8698448 , 0.97494761, 0.92409382, ..., 0.6376252 , 0.08465611, 0.89849959],\n+ [0.34926094, 0.75759475, 0.49435996, ..., 0.12381323, 0.00737264, 0.41551479],\n+ [0.79536206, 0.9576852 , 0.87623866, ..., 0.50575962, 0.05104108, 0.83734861],\n+ ...,\n+ [0.75640208, 0.94759281, 0.84976797, ..., 0.44980427, 0.04120034, 0.80441657],\n+ [0.16113759, 0.52798049, 0.25921362, ..., 0.04814004, 0.00265123, 0.20282803],\n+ [0.20438664, 0.59934274, 0.31878273, ..., 0.06335114, 0.00354244, 0.25388019]]),\n+ 'pscore': array([0.1083297 , 0.09498828, 0.08607129, ..., 0.11173138, 0.10396257, 0.12499258])\n+ }\n+\n+ \"\"\"\n+ n_actions: int\n+ dim_context: int\n+ dim_action_context: int\n+ reward_function: Optional[Callable[[np.ndarray, np.ndarray], np.ndarray]] = None\n+ behavior_policy_function: Optional[Callable[[np.ndarray, np.ndarray], np.ndarray]] = None\n+ random_state: Optional[int] = None\n+ dataset_name: str = 'synthetic_contextual_bandit_dataset'\n+\n+ def __post_init__(self) -> None:\n+ \"\"\"Initialize Class.\"\"\"\n+ self.random_ = check_random_state(self.random_state)\n+ self.sample_action_context()\n+ if self.reward_function is None:\n+ self.sample_contextfree_expected_reward()\n+ if self.behavior_policy_function is None:\n+ self.sample_contextfree_behaivor_policy()\n+\n+ @property\n+ def len_list(self) -> int:\n+ \"\"\"Length of recommendation lists.\"\"\"\n+ return 1\n+\n+ def sample_action_context(self) -> None:\n+ \"\"\"Sample action context vectors from the standard normal distribution.\"\"\"\n+ self.action_context = self.random_.normal(\n+ size=(self.n_actions, self.dim_action_context)\n+ )\n+\n+ def sample_contextfree_expected_reward(self) -> np.ndarray:\n+ \"\"\"Sample expected reward for each action from the uniform distribution.\"\"\"\n+ self.expected_reward = self.random_.uniform(size=self.n_actions)\n+\n+ def sample_contextfree_behaivor_policy(self) -> np.ndarray:\n+ \"\"\"Sample probability of choosing each action from the dirichlet distribution.\"\"\"\n+ alpha = self.random_.uniform(size=self.n_actions)\n+ self.behavior_policy = self.random_.dirichlet(alpha=alpha)\n+\n+ def obtain_batch_bandit_feedback(self, n_rounds: int) -> BanditFeedback:\n+ \"\"\"Obtain batch logged bandit feedback.\n+\n+ Parameters\n+ ----------\n+ n_rounds: int\n+ Number of rounds for synthetic bandit feedback data.\n+\n+ Returns\n+ ---------\n+ bandit_feedback: BanditFeedback\n+ Context-free synthetic bandit feedback dataset.\n+\n+ \"\"\"\n+ context = self.random_.normal(\n+ size=(n_rounds, self.dim_context)\n+ )\n+\n+ if self.behavior_policy_function is None:\n+ action = self.random_.choice(\n+ np.arange(self.n_actions),\n+ p=self.behavior_policy,\n+ size=n_rounds\n+ )\n+ pscore = self.behavior_policy[action]\n+ else:\n+ behavior_policy_ = self.behavior_policy_function(\n+ context=context,\n+ action_context=self.action_context\n+ )\n+ action = np.array(\n+ [\n+ self.random_.choice(\n+ np.arange(self.n_actions),\n+ p=behavior_policy_[i],\n+ )\n+ for i in np.arange(n_rounds)\n+ ]\n+ )\n+ pscore = behavior_policy_[np.arange(n_rounds), action]\n+\n+ if self.reward_function is None:\n+ expected_reward_ = self.expected_reward\n+ reward = self.random_.binomial(n=1, p=expected_reward_[action])\n+ else:\n+ expected_reward_ = self.reward_function(\n+ context=context,\n+ action_context=self.action_context\n+ )\n+ reward = self.random_.binomial(n=1, p=expected_reward_[np.arange(n_rounds), action])\n+ return dict(\n+ n_rounds=n_rounds,\n+ n_actions=self.n_actions,\n+ context=context,\n+ action=action,\n+ position=np.zeros(n_rounds, dtype=int),\n+ reward=reward,\n+ expected_reward=expected_reward_,\n+ pscore=pscore\n+ )\n+\n+\n+def linear_reward_function(context: np.ndarray, action_context: np.ndarray) -> np.ndarray:\n+ \"\"\"Linear mean reward function for synthetic bandit datasets.\"\"\"\n+ logits = np.zeros((context.shape[0], action_context.shape[0]))\n+ coef_ = np.random.uniform(size=context.shape[1])\n+ action_coef_ = np.random.uniform(size=action_context.shape[1])\n+ for d in np.arange(action_context.shape[0]):\n+ action_context_ = action_context[d]\n+ logits[:, d] = context @ coef_ + action_context_ @ action_coef_\n+\n+ return sigmoid(logits)\n+\n+\n+def linear_behavior_policy(context: np.ndarray, action_context: np.ndarray) -> np.ndarray:\n+ \"\"\"Linear contextual behavior policy for synthetic bandit datasets.\"\"\"\n+ logits = np.zeros((context.shape[0], action_context.shape[0]))\n+ coef_ = np.random.uniform(size=context.shape[1])\n+ action_coef_ = np.random.uniform(size=action_context.shape[1])\n+ for d in np.arange(action_context.shape[0]):\n+ action_context_ = action_context[d]\n+ logits[:, d] = context @ coef_ + action_context_ @ action_coef_\n+\n+ return softmax(logits)\n"
}
] | Python | Apache License 2.0 | st-tech/zr-obp | add synthetic dataset class |
641,014 | 22.07.2020 08:08:03 | -32,400 | 0ed71c402e9348cbb8b5f6592251213d26fc3e51 | create simulator module | [
{
"change_type": "ADD",
"old_path": null,
"new_path": "obp/simulator/__init__.py",
"diff": "+from .simulator import *\n"
},
{
"change_type": "ADD",
"old_path": null,
"new_path": "obp/simulator/simulator.py",
"diff": "+# Copyright (c) ZOZO Technologies, Inc. All rights reserved.\n+# Licensed under the Apache 2.0 License.\n+\n+\"\"\"Offline Bandit Simulator.\"\"\"\n+from tqdm import tqdm\n+\n+import numpy as np\n+\n+from ..dataset import BanditFeedback\n+from ..policy import BanditPolicy\n+\n+\n+def run_bandit_simulation(bandit_feedback: BanditFeedback, policy: BanditPolicy) -> np.ndarray:\n+ \"\"\"Run bandit algorithm on logged bandit feedback data.\n+\n+ Parameters\n+ ----------\n+ bandit_feedback: BanditFeedback\n+ Logged bandit feedback data to be used in offline bandit simulation.\n+\n+ policy: BanditPolicy\n+ Bandit policy to be used evaluated in offline bandit simulation (i.e., counterfactual or evaluation policy).\n+\n+ Returns\n+ --------\n+ selected_actions: array-like shape (n_rounds, len_list)\n+ Lists of actions selected by counterfactual (or evaluation) policy at each round in offline bandit simulation.\n+\n+ \"\"\"\n+ _check_bandit_feedback(bandit_feedback=bandit_feedback)\n+\n+ policy_ = policy\n+ selected_actions_list = list()\n+ dim_context = bandit_feedback['context'].shape[1]\n+ for action_, reward_, position_, context_ in\\\n+ tqdm(\n+ zip(\n+ bandit_feedback['action'],\n+ bandit_feedback['reward'],\n+ bandit_feedback['position'],\n+ bandit_feedback['context']\n+ ),\n+ total=bandit_feedback['n_rounds']\n+ ):\n+\n+ # select a list of actions\n+ if policy_.policy_type == 'contextfree':\n+ selected_actions = policy_.select_action()\n+ elif policy_.policy_type == 'contextual':\n+ selected_actions = policy_.select_action(context_.reshape(1, dim_context))\n+ action_match_ = action_ == selected_actions[position_]\n+ # update parameters of a bandit policy\n+ # only when selected actions&positions are equal to logged actions&positions\n+ if action_match_:\n+ if policy_.policy_type == 'contextfree':\n+ policy_.update_params(action=action_, reward=reward_)\n+ elif policy_.policy_type == 'contextual':\n+ policy_.update_params(action=action_, reward=reward_, context=context_.reshape(1, dim_context))\n+ selected_actions_list.append(selected_actions)\n+\n+ return np.array(selected_actions_list)\n+\n+\n+def _check_bandit_feedback(bandit_feedback: BanditFeedback) -> RuntimeError:\n+ \"\"\"Check keys of input BanditFeedback dict.\"\"\"\n+ for key_ in ['action', 'position', 'reward', 'pscore', 'context']:\n+ if key_ not in bandit_feedback:\n+ raise RuntimeError(f\"Missing key of {key_} in 'bandit_feedback'.\")\n"
}
] | Python | Apache License 2.0 | st-tech/zr-obp | create simulator module |
641,014 | 22.07.2020 10:54:38 | -32,400 | b9f1e84dce47c0f211475ae18bbe3d530d4f0602 | fix errors in self-normalized estimators | [
{
"change_type": "MODIFY",
"old_path": "obp/ope/estimators.py",
"new_path": "obp/ope/estimators.py",
"diff": "@@ -300,7 +300,7 @@ class SelfNormalizedInverseProbabilityWeighting(InverseProbabilityWeighting):\n.. math::\n\\\\hat{V}_{SNIPW} (\\\\pi) =\n- \\\\frac{1}{\\\\sum_{t=1}^T \\\\frac{1}{p_t} } \\\\sum_{t=1}^T \\\\frac{\\\\mathbb{I} \\\\{ \\\\pi (x_t) = a_t \\\\}}{p_t} Y_t\n+ \\\\frac{1}{\\\\sum_{t=1}^T \\\\frac{\\\\mathbb{I} \\\\{ \\\\pi (x_t) = a_t \\\\}}{p_t} } \\\\sum_{t=1}^T \\\\frac{\\\\mathbb{I} \\\\{ \\\\pi (x_t) = a_t \\\\}}{p_t} Y_t\nwhere :math:`p_t` is probability of an action :math:`a` was chosen by behavior policy at round :math:`t` called the *propensity score*.\n@@ -355,8 +355,7 @@ class SelfNormalizedInverseProbabilityWeighting(InverseProbabilityWeighting):\nRewards estimated by the SNIPW estimator for each round.\n\"\"\"\n- sn_weight = pscore.shape[0] / pscore\n- return sn_weight * (action_match * reward)\n+ return (action_match * reward) / pscore / (action_match / pscore).mean()\n@dataclass\n@@ -630,7 +629,7 @@ class SelfNormalizedDoublyRobust(DoublyRobust):\n.. math::\n\\\\hat{V}_{SNDR} (\\\\pi) =\n- \\\\frac{1}{\\\\sum_{t=1}^T \\\\frac{1}{p_t}} \\\\sum_{t=1}^T \\\\frac{\\\\mathbb{I} \\\\{ \\\\pi (x_t) = a_t \\\\}}{p_t} (Y_t - \\\\hat{\\\\mu} (x_t, a_t)) + \\\\hat{\\\\mu} (x_t, a_t)\n+ \\\\frac{1}{\\\\sum_{t=1}^T \\\\frac{\\\\mathbb{I} \\\\{ \\\\pi (x_t) = a_t \\\\}}{p_t}} \\\\sum_{t=1}^T \\\\frac{\\\\mathbb{I} \\\\{ \\\\pi (x_t) = a_t \\\\}}{p_t} (Y_t - \\\\hat{\\\\mu} (x_t, a_t)) + \\\\hat{\\\\mu} (x_t, a_t)\nwhere :math:`p_t` is the probability of an action :math:`a` was chosen by behavior policy at round :math:`t` called the *propensity score*.\n:math:`\\\\hat{\\\\mu}` is the regression function and :math:`\\\\hat{\\\\mu} (x_t, a_t)` is an estimated rewards for round :math:`t`.\n@@ -687,8 +686,10 @@ class SelfNormalizedDoublyRobust(DoublyRobust):\nRewards estimated by the SNDR estimator for each round.\n\"\"\"\n- sn_weight = pscore.shape[0] / pscore\n- return (sn_weight * action_match * (reward - estimated_rewards_by_reg_model)) + estimated_rewards_by_reg_model\n+ round_rewards = (action_match * (reward - estimated_rewards_by_reg_model) / pscore)\n+ round_rewards += estimated_rewards_by_reg_model\n+ round_rewards /= (action_match / pscore).mean()\n+ return round_rewards\n@dataclass\n@@ -713,7 +714,7 @@ class SwitchDoublyRobust(DoublyRobust):\nParameters\n----------\n- tau: float, default: 1.0\n+ tau: float, default: 1000\nSwitching hyperparameter. When the density ratio is larger than this parameter\nthe DM estimator is applied, otherwise the DR esitmator is applied.\nThis hyperparameter should be larger than 1., otherwise it is meaningless.\n@@ -730,7 +731,7 @@ class SwitchDoublyRobust(DoublyRobust):\n\"Optimal and Adaptive Off-policy Evaluation in Contextual Bandits\", 2016.\n\"\"\"\n- tau: float = 1.0\n+ tau: float = 1000\nestimator_name: str = 'switch-dr'\nassert tau >= 1., f'switching hyperparameter should be larger than 1. but {tau} is given.'\n"
}
] | Python | Apache License 2.0 | st-tech/zr-obp | fix errors in self-normalized estimators |
641,014 | 22.07.2020 10:58:15 | -32,400 | 3237d0173660d50882ef20600ec1e26d2d332b4e | add a formal example with synthetic data | [
{
"change_type": "ADD",
"old_path": null,
"new_path": "examples/synthetic/README.md",
"diff": "+# Examples with Synthetic Data\n+Here, we use synthetic bandit dataset and pipeline to evaluate OPE estimators.\n+\n+\n+## Running experiments\n+\n+**Example Experimet. Evaluating Off-Policy Estimators**\n+\n+We evaluate the estimation performance of Direct Method (DM), Inverse Probability Weighting (IPW), Self-Normalized Inverse Probability Weighting (SNIPW), Doubly Robust (DR), Self-Normalized Doubly Robust (SNDR), and Switch Doubly Robust (Switch-DR).\n+[`./evaluate_off_policy_estimators.py`](./evaluate_off_policy_estimators.py) implements the evaluation of OPE estimators.\n+\n+```bash\n+# run evaluation of OPE estimators.\n+python evaluate_off_policy_estimators.py\\\n+ --n_runs $n_runs\\\n+ --n_rounds $n_rounds\\\n+ --n_actions $n_actions\\\n+ --dim_context $dim_context\\\n+ --dim_action_context $dim_action_context\\\n+ --counterfactual_policy $counterfactual_policy\\\n+ --random_state $random_state\n+```\n+where `$n_runs` specifies the number of simulation runs in the experiment to estimate confidence intervals of the performance of OPE estimators.\n+`$n_rounds` and `$n_actions` specify the number of rounds and the number of actions for the synthetic bandit data.\n+`$dim_context` and `$dim_action_context` specify the dimension of context vectors characterizing each round and action, respectively.\n+`$counterfactual_policy` specifies the counterfactual policy.\n+They should be one of 'bts', 'random', 'logistic_ts', 'logistic_ucb', and 'logistic_egreedy'.\n+\n+For example, the following command compares the estimation performance of the OPE estimators by synthetic bandit feedback data with 100,000 rounds, 20 actions, context vectors with five dimensions.\n+\n+```bash\n+python evaluate_off_policy_estimators.py\\\n+ --n_runs 10\\\n+ --n_rounds 100000\\\n+ --n_actions 20\\\n+ --dim_context 5\\\n+ --dim_action_context 5\\\n+ --counterfactual_policy logistic_ts\\\n+ --random_state 12345\n+\n+# relative estimation errors (lower is better) and their 95% confidence intervals of OPE estimators.\n+# our evaluation of OPE procedure suggests that IPW and SNIPW perform better than other\n+# model dependent estimators including DM, DR, SNDR, and Switch-DR.\n+# ============================================================\n+# random_state=12345\n+# ------------------------------------------------------------\n+# mean 95.0% CI (lower) 95.0% CI (upper)\n+# dm 0.084652 0.05387 0.11658\n+# ipw 0.023547 0.01196 0.03720\n+# snipw 0.031046 0.01254 0.05261\n+# dr 0.034639 0.02392 0.04739\n+# sndr 0.065582 0.03284 0.10466\n+# switch-dr 0.050021 0.03090 0.07106\n+# ============================================================\n+```\n+\n+Let's try the evaluation of OPE with other experimental settings!\n"
},
{
"change_type": "ADD",
"old_path": null,
"new_path": "examples/synthetic/evaluate_off_policy_estimators.py",
"diff": "+import argparse\n+from pathlib import Path\n+\n+import numpy as np\n+import pandas as pd\n+from sklearn.calibration import CalibratedClassifierCV\n+from sklearn.ensemble import RandomForestClassifier as RandomForest\n+from obp.dataset import (\n+ SyntheticBanditDataset,\n+ linear_behavior_policy,\n+ linear_reward_function\n+)\n+from obp.simulator import run_bandit_simulation\n+from obp.policy import (\n+ Random,\n+ BernoulliTS,\n+ LogisticEpsilonGreedy,\n+ LogisticTS,\n+ LogisticUCB\n+)\n+from obp.ope import (\n+ RegressionModel,\n+ OffPolicyEvaluation,\n+ InverseProbabilityWeighting,\n+ SelfNormalizedInverseProbabilityWeighting,\n+ DirectMethod,\n+ DoublyRobust,\n+ SelfNormalizedDoublyRobust,\n+ SwitchDoublyRobust\n+)\n+from obp.utils import estimate_confidence_interval_by_bootstrap\n+\n+\n+counterfactual_policy_dict = dict(\n+ bts=BernoulliTS,\n+ random=Random,\n+ logistic_egreedy=LogisticEpsilonGreedy,\n+ logistic_ts=LogisticTS,\n+ logistic_ucb=LogisticUCB\n+)\n+\n+# hyperparameters of the regression model\n+hyperparams = dict(n_estimators=10, random_state=12345)\n+\n+if __name__ == '__main__':\n+ parser = argparse.ArgumentParser(description='evaluate off-policy estimators with synthetic data.')\n+ parser.add_argument('--n_runs', type=int, default=1,\n+ help='number of simulations in the experiment.')\n+ parser.add_argument('--n_rounds', type=int, default=10000,\n+ help='number of rounds for synthetic bandit feedback.')\n+ parser.add_argument('--n_actions', type=int, default=10,\n+ help='number of actions for synthetic bandit feedback.')\n+ parser.add_argument('--dim_context', type=int, default=5,\n+ help='dimensions of context vectors characterizing each round.')\n+ parser.add_argument('--dim_action_context', type=int, default=5,\n+ help='dimensions of context vectors characterizing each action.')\n+ parser.add_argument('--counterfactual_policy', type=str, required=True,\n+ choices=['bts', 'random', 'logistic_ts', 'logistic_ucb', 'logistic_egreedy'],\n+ help='counterfacutual policy, bts, random, logistic_ts, logistic_ucb, or logistic_egreedy.')\n+ parser.add_argument('--random_state', type=int, default=12345)\n+ args = parser.parse_args()\n+ print(args)\n+\n+ n_runs = args.n_runs\n+ n_rounds = args.n_rounds\n+ n_actions = args.n_actions\n+ dim_context = args.dim_context\n+ dim_action_context = args.dim_action_context\n+ counterfactual_policy = args.counterfactual_policy\n+ random_state = args.random_state\n+\n+ dataset = SyntheticBanditDataset(\n+ n_actions=n_actions,\n+ dim_context=dim_context,\n+ dim_action_context=dim_action_context,\n+ reward_function=linear_reward_function,\n+ behavior_policy_function=linear_behavior_policy,\n+ random_state=random_state\n+ )\n+\n+ # hyparparameters for counterfactual policies\n+ kwargs = dict(\n+ n_actions=dataset.n_actions,\n+ len_list=dataset.len_list,\n+ random_state=random_state\n+ )\n+ if 'logistic' in counterfactual_policy:\n+ kwargs['dim'] = dim_context\n+ if counterfactual_policy in ['logistic_ucb', 'logistic_egreedy']:\n+ kwargs['epsilon'] = 0.01\n+ policy = counterfactual_policy_dict[counterfactual_policy](**kwargs)\n+ # compared OPE estimators\n+ ope_estimators = [\n+ DirectMethod(),\n+ InverseProbabilityWeighting(),\n+ SelfNormalizedInverseProbabilityWeighting(),\n+ DoublyRobust(),\n+ SelfNormalizedDoublyRobust(),\n+ SwitchDoublyRobust()\n+ ]\n+ # a base ML model for regression model used in Direct Method and Doubly Robust\n+ base_model = CalibratedClassifierCV(RandomForest(**hyperparams))\n+\n+ evaluation_of_ope_results = {est.estimator_name: np.zeros(n_runs) for est in ope_estimators}\n+ for i in np.arange(n_runs):\n+ # sample a new set of logged bandit feedback\n+ bandit_feedback = dataset.obtain_batch_bandit_feedback(n_rounds=n_rounds)\n+ # run a counterfactual bandit algorithm on logged bandit feedback data\n+ selected_actions = run_bandit_simulation(bandit_feedback=bandit_feedback, policy=policy)\n+ # estimate the ground-truth policy values of the counterfactual policy\n+ # using the full expected reward contained in the bandit feedback dictionary\n+ ground_truth_policy_value =\\\n+ bandit_feedback['expected_reward'][np.arange(n_rounds), selected_actions.flatten()].mean()\n+ # evaluate the estimation performance of OPE estimators\n+ ope = OffPolicyEvaluation(\n+ bandit_feedback=bandit_feedback,\n+ action_context=dataset.action_context,\n+ regression_model=RegressionModel(base_model=base_model),\n+ ope_estimators=ope_estimators\n+ )\n+ relative_estimation_errors = ope.evaluate_performance_of_estimators(\n+ selected_actions=selected_actions,\n+ ground_truth_policy_value=ground_truth_policy_value\n+ )\n+ policy.initialize()\n+ # store relative estimation errors of OPE estimators at each split\n+ for estimator_name, relative_estimation_error in relative_estimation_errors.items():\n+ evaluation_of_ope_results[estimator_name][i] = relative_estimation_error\n+\n+ # estimate confidence intervals of relative estimation by nonparametric bootstrap method\n+ evaluation_of_ope_results_with_ci = {est.estimator_name: dict() for est in ope_estimators}\n+ for estimator_name in evaluation_of_ope_results_with_ci.keys():\n+ evaluation_of_ope_results_with_ci[estimator_name] = estimate_confidence_interval_by_bootstrap(\n+ samples=evaluation_of_ope_results[estimator_name],\n+ random_state=random_state\n+ )\n+ evaluation_of_ope_results_df = pd.DataFrame(evaluation_of_ope_results_with_ci).T\n+\n+ print('=' * 60)\n+ print(f'random_state={random_state}')\n+ print('-' * 60)\n+ print(evaluation_of_ope_results_df)\n+ print('=' * 60)\n+\n+ # save results of the evaluation of off-policy estimators in './logs' directory.\n+ log_path = Path('./logs')\n+ log_path.mkdir(exist_ok=True, parents=True)\n+ evaluation_of_ope_results_df.to_csv(log_path / 'comparison_of_ope_estimators.csv')\n"
}
] | Python | Apache License 2.0 | st-tech/zr-obp | add a formal example with synthetic data |
641,014 | 29.07.2020 13:05:50 | -32,400 | 8e100fda28c192a4d4e727b7c562b841f96023aa | git add docs | [
{
"change_type": "MODIFY",
"old_path": "docs/index.rst",
"new_path": "docs/index.rst",
"diff": "@@ -34,17 +34,31 @@ Supported Algorithms and OPE Estimators\nBandit Algorithms\n----------------------\n+ * Online\n+\n* Context-free\n* Random\n* Epsilon Greedy\n* Bernoulli Thompson Sampling\n- * Contextual\n+ * Contextual (Linear)\n+\n+ * Linear Epsilon Greedy\n+ * Linear Thompson Sampling :cite:`Agrawal2013`\n+ * Linear Upper Confidence Bound :cite:`Li2010`\n+\n+ * Contextual (Logistic)\n* Logistic Epsilon Greedy\n* Logistic Thompson Sampling :cite:`Chapelle2011`\n- * Logistic Upper Confidence Bound :cite:`Li2010` :cite:`Mahajan2012`\n+ * Logistic Upper Confidence Bound :cite:`Mahajan2012`\n+\n+ * Offline (Off-Policy Learning) :cite:`Dudik2014`\n+\n+ * Direct Method\n+ * Inverse Probability Weighting\n+ * Doubly Robust\nOPE Estimators\n----------------------\n"
},
{
"change_type": "MODIFY",
"old_path": "docs/obp.rst",
"new_path": "docs/obp.rst",
"diff": "@@ -18,7 +18,9 @@ policy module\nobp.policy.base\nobp.policy.contextfree\n- obp.policy.contextual\n+ obp.policy.linear\n+ obp.policy.logistic\n+ obp.policy.offline\ndataset module\n@@ -32,7 +34,7 @@ dataset module\nsimulator module\n----------------\n+------------------\n.. autosummary::\n:toctree: _autosummary\n"
},
{
"change_type": "MODIFY",
"old_path": "docs/refs.bib",
"new_path": "docs/refs.bib",
"diff": "year={2016}\n}\n+@inproceedings{Agrawal2013,\n+ title={Thompson sampling for contextual bandits with linear payoffs},\n+ author={Agrawal, Shipra and Goyal, Navin},\n+ booktitle={International Conference on Machine Learning},\n+ pages={127--135},\n+ year={2013}\n+}\n+\n@inproceedings{Mahajan2012,\ntitle={Logucb: an explore-exploit algorithm for comments recommendation},\nauthor={Mahajan, Dhruv Kumar and Rastogi, Rajeev and Tiwari, Charu and Mitra, Adway},\n"
}
] | Python | Apache License 2.0 | st-tech/zr-obp | git add docs |
641,014 | 04.08.2020 16:55:41 | -32,400 | 398153e464f9dd663cc048be7322de26510e4126 | add linear and off-policy bandits | [
{
"change_type": "MODIFY",
"old_path": "obp/policy/__init__.py",
"new_path": "obp/policy/__init__.py",
"diff": "from .base import *\nfrom .contextfree import *\n-from .contextual import *\n+from .linear import *\n+from .logistic import *\n+from .offline import *\n"
},
{
"change_type": "MODIFY",
"old_path": "obp/policy/contextfree.py",
"new_path": "obp/policy/contextfree.py",
"diff": "@@ -54,12 +54,9 @@ class EpsilonGreedy(BaseContextFreePolicy):\nselected_actions: array-like shape (len_list, )\nList of selected actions.\n\"\"\"\n- self.n_trial += 1\n- if self.random_.rand() > self.epsilon:\n- unsorted_max_arms = np.argpartition(-self.reward_counts, self.len_list)[\n- : self.len_list\n- ]\n- return unsorted_max_arms[np.argsort(-self.reward_counts[unsorted_max_arms])]\n+ if (self.random_.rand() > self.epsilon) and (self.action_counts.min() > 0):\n+ reward_preds = self.reward_counts / self.action_counts\n+ return reward_preds.argsort()[::-1][: self.len_list]\nelse:\nreturn self.random_.choice(\nself.n_actions, size=self.len_list, replace=False\n@@ -76,6 +73,7 @@ class EpsilonGreedy(BaseContextFreePolicy):\nreward: float\nObserved reward for the chosen action and position.\n\"\"\"\n+ self.n_trial += 1\nself.action_counts_temp[action] += 1\nn, old_reward = self.action_counts_temp[action], self.reward_counts_temp[action]\nself.reward_counts_temp[action] = (old_reward * (n - 1) / n) + (reward / n)\n@@ -172,13 +170,11 @@ class BernoulliTS(BaseContextFreePolicy):\nselected_actions: array-like shape (len_list, )\nList of selected actions.\n\"\"\"\n- self.n_trial += 1\ntheta = self.random_.beta(\na=self.reward_counts + self.alpha,\nb=(self.action_counts - self.reward_counts) + self.beta,\n)\n- unsorted_max_arms = np.argpartition(-theta, self.len_list)[: self.len_list]\n- return unsorted_max_arms[np.argsort(-theta[unsorted_max_arms])]\n+ return theta.argsort()[::-1][: self.len_list]\ndef update_params(self, action: int, reward: float) -> None:\n\"\"\"Update policy parameters.\n@@ -191,6 +187,7 @@ class BernoulliTS(BaseContextFreePolicy):\nreward: float\nObserved reward for the chosen action and position.\n\"\"\"\n+ self.n_trial += 1\nself.action_counts_temp[action] += 1\nself.reward_counts_temp[action] += reward\nif self.n_trial % self.batch_size == 0:\n"
},
{
"change_type": "RENAME",
"old_path": "obp/policy/contextual.py",
"new_path": "obp/policy/logistic.py",
"diff": "# Copyright (c) ZOZO Technologies, Inc. All rights reserved.\n# Licensed under the Apache 2.0 License.\n-\"\"\"Contextual Bandit Algorithms.\"\"\"\n+\"\"\"Contextual Logistic Bandit Algorithms.\"\"\"\nfrom dataclasses import dataclass\nfrom typing import Optional\n@@ -84,19 +84,11 @@ class LogisticEpsilonGreedy(BaseContextualPolicy):\nselected_actions: array-like shape (len_list, )\nList of selected actions.\n\"\"\"\n- if self.action_counts.min() == 0:\n- return self.random_.choice(\n- self.n_actions, size=self.len_list, replace=False\n- )\n- else:\nif self.random_.rand() > self.epsilon:\ntheta = np.array(\n[model.predict_proba(context) for model in self.model_list]\n).flatten()\n- unsorted_max_arms = np.argpartition(-theta, self.len_list)[\n- : self.len_list\n- ]\n- return unsorted_max_arms[np.argsort(-theta[unsorted_max_arms])]\n+ return theta.argsort()[::-1][: self.len_list]\nelse:\nreturn self.random_.choice(\nself.n_actions, size=self.len_list, replace=False\n@@ -206,11 +198,6 @@ class LogisticUCB(BaseContextualPolicy):\nselected_actions: array-like shape (len_list, )\nList of selected actions.\n\"\"\"\n- if self.action_counts.min() == 0:\n- return self.random_.choice(\n- self.n_actions, size=self.len_list, replace=False\n- )\n- else:\ntheta = np.array(\n[model.predict_proba(context) for model in self.model_list]\n).flatten()\n@@ -221,10 +208,7 @@ class LogisticUCB(BaseContextualPolicy):\n]\n).flatten()\nucb_score = theta + self.epsilon * std\n- unsorted_max_arms = np.argpartition(-ucb_score, self.len_list)[\n- : self.len_list\n- ]\n- return unsorted_max_arms[np.argsort(-ucb_score[unsorted_max_arms])]\n+ return ucb_score.argsort()[::-1][: self.len_list]\ndef update_params(self, action: int, reward: float, context: np.ndarray) -> None:\n\"\"\"Update policy parameters.\n@@ -325,19 +309,10 @@ class LogisticTS(BaseContextualPolicy):\nselected_actions: array-like shape (len_list, )\nList of selected actions.\n\"\"\"\n- if self.action_counts.min() == 0:\n- return self.random_.choice(\n- self.n_actions, size=self.len_list, replace=False\n- )\n- else:\ntheta = np.array(\n- [\n- model.predict_proba_with_sampling(context)\n- for model in self.model_list\n- ]\n+ [model.predict_proba_with_sampling(context) for model in self.model_list]\n).flatten()\n- unsorted_max_arms = np.argpartition(-theta, self.len_list)[: self.len_list]\n- return unsorted_max_arms[np.argsort(-theta[unsorted_max_arms])]\n+ return theta.argsort()[::-1][: self.len_list]\ndef update_params(self, action: int, reward: float, context: np.ndarray) -> None:\n\"\"\"Update policy parameters.\n"
}
] | Python | Apache License 2.0 | st-tech/zr-obp | add linear and off-policy bandits |
641,014 | 04.08.2020 16:56:16 | -32,400 | a67b7f75204b4f96f6603989e883296b40f00b9b | add random_state to example functions | [
{
"change_type": "MODIFY",
"old_path": "obp/dataset/synthetic.py",
"new_path": "obp/dataset/synthetic.py",
"diff": "@@ -6,6 +6,7 @@ from dataclasses import dataclass\nfrom typing import Optional, Callable\nimport numpy as np\n+from numpy import random\nfrom sklearn.utils import check_random_state\nfrom .base import BaseSyntheticBanditDataset, BanditFeedback\n@@ -162,7 +163,9 @@ class SyntheticBanditDataset(BaseSyntheticBanditDataset):\npscore = self.behavior_policy[action]\nelse:\nbehavior_policy_ = self.behavior_policy_function(\n- context=context, action_context=self.action_context\n+ context=context,\n+ action_context=self.action_context,\n+ random_state=self.random_state,\n)\naction = np.array(\n[\n@@ -180,7 +183,9 @@ class SyntheticBanditDataset(BaseSyntheticBanditDataset):\nreward = self.random_.binomial(n=1, p=expected_reward_[action])\nelse:\nexpected_reward_ = self.reward_function(\n- context=context, action_context=self.action_context\n+ context=context,\n+ action_context=self.action_context,\n+ random_state=self.random_state,\n)\nreward = self.random_.binomial(\nn=1, p=expected_reward_[np.arange(n_rounds), action]\n@@ -197,10 +202,10 @@ class SyntheticBanditDataset(BaseSyntheticBanditDataset):\n)\n-def linear_reward_function(\n- context: np.ndarray, action_context: np.ndarray\n+def logistic_reward_function(\n+ context: np.ndarray, action_context: np.ndarray, random_state: Optional[int] = None,\n) -> np.ndarray:\n- \"\"\"Linear mean reward function for synthetic bandit datasets.\n+ \"\"\"Logistic mean reward function for synthetic bandit datasets.\nParameters\n-----------\n@@ -210,6 +215,9 @@ def linear_reward_function(\naction_context: array-like, shape (n_actions, dim_action_context)\nContext vectors characterizing each action.\n+ random_state: int, default: None\n+ Controls the random seed in sampling dataset.\n+\nReturns\n---------\nexpected_reward: array-like, shape (n_rounds, n_actions)\n@@ -217,17 +225,19 @@ def linear_reward_function(\ni.e., :math:`\\\\mu: \\\\mathcal{X} \\\\times \\\\mathcal{A} \\\\rightarrow \\\\mathbb{R}`.\n\"\"\"\n+ random_ = check_random_state(random_state)\nlogits = np.zeros((context.shape[0], action_context.shape[0]))\n# each arm has different coefficient vectors\n- coef_ = np.random.uniform(size=(action_context.shape[0], context.shape[1]))\n+ coef_ = random_.uniform(size=(action_context.shape[0], context.shape[1]))\n+ action_coef_ = random_.uniform(size=action_context.shape[1])\nfor d in np.arange(action_context.shape[0]):\n- logits[:, d] = context @ coef_[d]\n+ logits[:, d] = context @ coef_[d] + action_context[d] @ action_coef_\nreturn sigmoid(logits)\ndef linear_behavior_policy(\n- context: np.ndarray, action_context: np.ndarray\n+ context: np.ndarray, action_context: np.ndarray, random_state: Optional[int] = None,\n) -> np.ndarray:\n\"\"\"Linear contextual behavior policy for synthetic bandit datasets.\n@@ -239,6 +249,9 @@ def linear_behavior_policy(\naction_context: array-like, shape (n_actions, dim_action_context)\nContext vectors characterizing each action.\n+ random_state: int, default: None\n+ Controls the random seed in sampling dataset.\n+\nReturns\n---------\nbehavior_policy: array-like, shape (n_rounds, n_actions)\n@@ -246,11 +259,11 @@ def linear_behavior_policy(\ni.e., :math:`\\\\pi: \\\\mathcal{X} \\\\rightarrow \\\\Delta(\\\\mathcal{A})`.\n\"\"\"\n+ random_ = check_random_state(random_state)\nlogits = np.zeros((context.shape[0], action_context.shape[0]))\n- coef_ = np.random.uniform(size=context.shape[1])\n- action_coef_ = np.random.uniform(size=action_context.shape[1])\n+ coef_ = random_.uniform(size=context.shape[1])\n+ action_coef_ = random_.uniform(size=action_context.shape[1])\nfor d in np.arange(action_context.shape[0]):\n- action_context_ = action_context[d]\n- logits[:, d] = context @ coef_ + action_context_ @ action_coef_\n+ logits[:, d] = context @ coef_ + action_context[d] @ action_coef_\nreturn softmax(logits)\n"
}
] | Python | Apache License 2.0 | st-tech/zr-obp | add random_state to example functions |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.