Skip to content

Redact operational info from server info #51190

New issue

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

Sign up for GitHub

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

Already on GitHub? Sign in to your account

Open
michalvavrik wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Redact operational info from server info #51190

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 0 additions & 2 deletions ...l/jpa/src/main/java/org/keycloak/connections/jpa/DefaultJpaConnectionProviderFactory.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -280,8 +280,6 @@ protected void prepareOperationalInfo(Connection connection) {
try {
operationalInfo = new LinkedHashMap<>();
DatabaseMetaData md = connection.getMetaData();
operationalInfo.put("databaseUrl", md.getURL());
operationalInfo.put("databaseUser", md.getUserName());
operationalInfo.put("databaseProduct", md.getDatabaseProductName() + " " + md.getDatabaseProductVersion());
operationalInfo.put("databaseDriver", md.getDriverName() + " " + md.getDriverVersion());

Expand Down
2 changes: 0 additions & 2 deletions ...rg/keycloak/quarkus/runtime/storage/database/jpa/QuarkusJpaConnectionProviderFactory.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -251,8 +251,6 @@ private void createOperationalInfo(Connection connection) {
try {
operationalInfo = new LinkedHashMap<>();
DatabaseMetaData md = connection.getMetaData();
operationalInfo.put("databaseUrl", md.getURL());
operationalInfo.put("databaseUser", md.getUserName());
operationalInfo.put("databaseProduct", md.getDatabaseProductName() + " " + md.getDatabaseProductVersion());
operationalInfo.put("databaseDriver", md.getDriverName() + " " + md.getDriverVersion());
operationalInfo.put("migrationTimeout", getMigrationTransactionTimeout() + " seconds");
Expand Down
22 changes: 22 additions & 0 deletions tests/base/src/test/java/org/keycloak/tests/admin/ServerInfoPermissionsTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,10 +18,13 @@



import java.util.Objects;

import jakarta.ws.rs.ForbiddenException;

import org.keycloak.models.AdminRoles;
import org.keycloak.representations.info.ServerInfoRepresentation;
import org.keycloak.representations.info.SpiInfoRepresentation;
import org.keycloak.testframework.annotations.InjectRealm;
import org.keycloak.testframework.annotations.KeycloakIntegrationTest;
import org.keycloak.testframework.realm.ManagedRealm;
Expand Down Expand Up @@ -85,6 +88,25 @@ public void testServerInfo() throws Exception {
Assert.assertNull(serverInfo.getSystemInfo().getServerTime());
Assert.assertNull(serverInfo.getCpuInfo());
Assert.assertNull(serverInfo.getMemoryInfo());

// databaseUrl and databaseUser are never exposed in server info
assertDatabaseConnectionInfoNotExposed(clients.get("master-admin").serverInfo().getInfo());
assertDatabaseConnectionInfoNotExposed(clients.get("master-admin-" + AdminRoles.MANAGE_REALM).serverInfo().getInfo());
}

private void assertDatabaseConnectionInfoNotExposed(ServerInfoRepresentation serverInfo) {
SpiInfoRepresentation jpa = serverInfo.getProviders().get("connectionsJpa");
Assert.assertNotNull("connectionsJpa SPI should be present", jpa);
boolean foundDatabaseUrl = jpa.getProviders().values().stream()
.map(p -> p.getOperationalInfo())
.filter(Objects::nonNull)
.anyMatch(info -> info.containsKey("databaseUrl"));
Assert.assertFalse("connectionsJpa operationalInfo should not contain databaseUrl", foundDatabaseUrl);
boolean foundDatabaseUser = jpa.getProviders().values().stream()
.map(p -> p.getOperationalInfo())
.filter(Objects::nonNull)
.anyMatch(info -> info.containsKey("databaseUser"));
Assert.assertFalse("connectionsJpa operationalInfo should not contain databaseUser", foundDatabaseUser);
}

protected static class PermissionsTestRealm extends PermissionsTestRealmConfig1 {
Expand Down
Loading