Skip to content

Pipe: Mask sensitive attributes in sink subtask display strings #17737

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
luoluoyuyu wants to merge 1 commit into
base: master
Choose a base branch
from
+20 −5
Open

Pipe: Mask sensitive attributes in sink subtask display strings #17737

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
1 change: 1 addition & 0 deletions ...pipe-api/src/main/java/org/apache/iotdb/pipe/api/customizer/parameter/PipeParameters.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -429,6 +429,7 @@ public static class ValueHider {

static {
KEYS.add("ssl.trust-store-pwd");
KEYS.add("scp.password");
KEYS.add("password");
}

Expand Down
24 changes: 19 additions & 5 deletions ...rc/main/java/org/apache/iotdb/db/pipe/agent/task/subtask/sink/PipeSinkSubtaskManager.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -91,6 +91,7 @@ public synchronized String register(
final int sinkNum;
boolean realTimeFirst = false;
String attributeSortedString = generateAttributeSortedString(pipeSinkParameters);
final String attributeDisplayString = generateAttributeDisplayString(pipeSinkParameters);
if (isDataRegionSink) {
sinkNum =
pipeSinkParameters.getIntOrDefault(
Expand Down Expand Up @@ -119,7 +120,9 @@ public synchronized String register(
sinkNum = 1;
attributeSortedString = "schema_" + attributeSortedString;
}
environment.setAttributeSortedString(attributeSortedString);
final String attributeDisplayStringWithPrefix =
isDataRegionSink ? "data_" + attributeDisplayString : "schema_" + attributeDisplayString;
environment.setAttributeSortedString(attributeDisplayStringWithPrefix);

if (!attributeSortedString2SubtaskLifeCycleMap.containsKey(attributeSortedString)) {
final PipeSinkSubtaskExecutor executor = executorSupplier.get();
Expand Down Expand Up @@ -168,9 +171,10 @@ public synchronized String register(
final PipeSinkSubtask pipeSinkSubtask =
new PipeSinkSubtask(
String.format(
"%s_%s_%s", attributeSortedString, environment.getCreationTime(), sinkIndex),
"%s_%s_%s",
attributeDisplayStringWithPrefix, environment.getCreationTime(), sinkIndex),
environment.getCreationTime(),
attributeSortedString,
attributeDisplayStringWithPrefix,
sinkIndex,
pendingQueue,
pipeSink);
Expand All @@ -181,7 +185,7 @@ public synchronized String register(

LOGGER.info(
DataNodePipeMessages.PIPE_SINK_SUBTASKS_WITH_ATTRIBUTES_IS_BOUNDED,
attributeSortedString,
attributeDisplayStringWithPrefix,
executor.getWorkingThreadName(),
executor.getCallbackThreadName());
attributeSortedString2SubtaskLifeCycleMap.put(
Expand Down Expand Up @@ -264,13 +268,23 @@ public UnboundedBlockingPendingQueue<Event> getPipeSinkPendingQueue(
.getPendingQueue();
}

private String generateAttributeSortedString(final PipeParameters pipeConnectorParameters) {
private static String generateAttributeSortedString(
final PipeParameters pipeConnectorParameters) {
final TreeMap<String, String> sortedStringSourceMap =
new TreeMap<>(pipeConnectorParameters.getAttribute());
sortedStringSourceMap.remove(SystemConstant.RESTART_OR_NEWLY_ADDED_KEY);
return sortedStringSourceMap.toString();
}

/** Masked attribute string for logs, metrics and exception messages. */
private static String generateAttributeDisplayString(
final PipeParameters pipeConnectorParameters) {
final TreeMap<String, String> filteredAttributes =
new TreeMap<>(pipeConnectorParameters.getAttribute());
filteredAttributes.remove(SystemConstant.RESTART_OR_NEWLY_ADDED_KEY);
return new PipeParameters(filteredAttributes).toString();
}

///////////////////////// Singleton Instance Holder /////////////////////////

private PipeSinkSubtaskManager() {
Expand Down
Loading