Skip to content

[FLINK-40539][sql-gateway] Redact sensitive values in SET; and session config responses #29082

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

Merged
gaborgsomogyi merged 1 commit into from
Sep 4, 2026
Merged

[FLINK-40539][sql-gateway] Redact sensitive values in SET; and session config responses #29082

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
5 changes: 4 additions & 1 deletion ...ain/java/org/apache/flink/table/gateway/rest/handler/session/GetSessionConfigHandler.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@

package org.apache.flink.table.gateway.rest.handler.session;

import org.apache.flink.configuration.ConfigurationUtils;
import org.apache.flink.runtime.rest.handler.HandlerRequest;
import org.apache.flink.runtime.rest.handler.RestHandlerException;
import org.apache.flink.runtime.rest.messages.EmptyRequestBody;
Expand Down Expand Up @@ -59,8 +60,10 @@ protected CompletableFuture<GetSessionConfigResponseBody> handleRequest(
SessionHandle sessionHandle =
request.getPathParameter(SessionHandleIdPathParameter.class);
Map<String, String> sessionConfig = this.service.getSessionConfig(sessionHandle);
Map<String, String> redactedSessionConfig =
ConfigurationUtils.hideSensitiveValues(sessionConfig);
return CompletableFuture.completedFuture(
new GetSessionConfigResponseBody(sessionConfig));
new GetSessionConfigResponseBody(redactedSessionConfig));
} catch (SqlGatewayException e) {
throw new RestHandlerException(
e.getMessage(), HttpResponseStatus.INTERNAL_SERVER_ERROR, e);
Expand Down
5 changes: 4 additions & 1 deletion ...way/src/main/java/org/apache/flink/table/gateway/service/operation/OperationExecutor.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@
import org.apache.flink.client.program.ClusterClient;
import org.apache.flink.configuration.CheckpointingOptions;
import org.apache.flink.configuration.Configuration;
import org.apache.flink.configuration.ConfigurationUtils;
import org.apache.flink.core.execution.SavepointFormatType;
import org.apache.flink.runtime.client.JobStatusMessage;
import org.apache.flink.streaming.api.environment.StreamExecutionEnvironment;
Expand Down Expand Up @@ -623,7 +624,9 @@ private ResultFetcher callSetOperation(
return ResultFetcher.fromTableResult(handle, TABLE_RESULT_OK, false);
} else if (setOp.getKey().isEmpty() && setOp.getValue().isEmpty()) {
// show all properties
Map<String, String> configMap = tableEnv.getConfig().getConfiguration().toMap();
Map<String, String> configMap =
ConfigurationUtils.hideSensitiveValues(
tableEnv.getConfig().getConfiguration().toMap());
return ResultFetcher.fromResults(
handle,
ResolvedSchema.of(
Expand Down
25 changes: 25 additions & 0 deletions ...k-sql-gateway/src/test/java/org/apache/flink/table/gateway/rest/SessionRelatedITCase.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@

package org.apache.flink.table.gateway.rest;

import org.apache.flink.configuration.GlobalConfiguration;
import org.apache.flink.runtime.rest.messages.EmptyMessageParameters;
import org.apache.flink.runtime.rest.messages.EmptyRequestBody;
import org.apache.flink.runtime.rest.messages.EmptyResponseBody;
Expand Down Expand Up @@ -158,6 +159,30 @@ void testGetSessionConfiguration() throws Exception {
}
}

@Test
void testGetSessionConfigurationHidesSensitiveValues() throws Exception {
Map<String, String> sensitiveProperties = new HashMap<>();
sensitiveProperties.put("s3.secret-key", "super-secret-value");
CompletableFuture<OpenSessionResponseBody> openResponse =
sendRequest(
openSessionHeaders,
emptyParameters,
new OpenSessionRequestBody(SESSION_NAME, sensitiveProperties));
SessionHandle handle =
new SessionHandle(UUID.fromString(openResponse.get().getSessionHandle()));
SessionMessageParameters parameters = new SessionMessageParameters(handle);

CompletableFuture<GetSessionConfigResponseBody> future =
sendRequest(GetSessionConfigHeaders.getInstance(), parameters, emptyRequestBody);
Map<String, String> getProperties = future.get().getProperties();

assertThat(getProperties).containsKey("s3.secret-key");
assertThat(getProperties.get("s3.secret-key"))
.isEqualTo(GlobalConfiguration.HIDDEN_CONTENT);

sendRequest(closeSessionHeaders, parameters, emptyRequestBody).get();
}

@Test
void testTouchSession() throws Exception {
Session session =
Expand Down
30 changes: 30 additions & 0 deletions ...rc/test/java/org/apache/flink/table/gateway/service/SqlGatewayServiceStatementITCase.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@
import org.apache.flink.api.common.RuntimeExecutionMode;
import org.apache.flink.configuration.Configuration;
import org.apache.flink.configuration.ExecutionOptions;
import org.apache.flink.configuration.GlobalConfiguration;
import org.apache.flink.core.testutils.CommonTestUtils;
import org.apache.flink.table.api.ResultKind;
import org.apache.flink.table.data.RowData;
Expand All @@ -46,14 +47,17 @@
import java.nio.file.Path;
import java.time.Duration;
import java.util.Collections;
import java.util.HashMap;
import java.util.Iterator;
import java.util.List;
import java.util.Map;
import java.util.function.BiFunction;
import java.util.stream.Collectors;

import static org.apache.flink.table.gateway.api.config.SqlGatewayServiceConfigOptions.SQL_GATEWAY_SESSION_PLAN_CACHE_ENABLED;
import static org.apache.flink.table.gateway.service.utils.SqlGatewayServiceTestUtil.awaitOperationTermination;
import static org.apache.flink.table.gateway.service.utils.SqlGatewayServiceTestUtil.createInitializedSession;
import static org.apache.flink.table.gateway.service.utils.SqlGatewayServiceTestUtil.fetchAllResults;
import static org.apache.flink.table.gateway.service.utils.SqlGatewayServiceTestUtil.fetchResults;
import static org.assertj.core.api.Assertions.assertThat;

Expand Down Expand Up @@ -286,6 +290,32 @@ void testResultKind() throws Exception {
sessionHandle, "SET;", resultKindGetter, ResultKind.SUCCESS_WITH_CONTENT);
}

@Test
void testSetHidesSensitiveValues() throws Exception {
SessionHandle sessionHandle = createInitializedSession(service);

runAndAwait(sessionHandle, "SET 's3.secret-key' = 'super-secret-value';");

OperationHandle setAllHandle = runAndAwait(sessionHandle, "SET;");
List<RowData> rows = fetchAllResults(service, sessionHandle, setAllHandle);

Map<String, String> properties = new HashMap<>();
for (RowData row : rows) {
properties.put(row.getString(0).toString(), row.getString(1).toString());
}

assertThat(properties).containsKey("s3.secret-key");
assertThat(properties.get("s3.secret-key")).isEqualTo(GlobalConfiguration.HIDDEN_CONTENT);
}

private OperationHandle runAndAwait(SessionHandle sessionHandle, String statement)
throws Exception {
OperationHandle operationHandle =
service.executeStatement(sessionHandle, statement, -1, new Configuration());
awaitOperationTermination(service, sessionHandle, operationHandle);
return operationHandle;
}

private <T> void validateResultSetField(
SessionHandle sessionHandle,
String statement,
Expand Down