[Feature-17398][Task] Avoid leaking sensitive Dinky task logs #18397
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,71 @@ | ||
| /* | ||
| * Licensed to the Apache Software Foundation (ASF) under one or more | ||
| * contributor license agreements. See the NOTICE file distributed with | ||
| * this work for additional information regarding copyright ownership. | ||
| * The ASF licenses this file to You under the Apache License, Version 2.0 | ||
| * (the "License"); you may not use this file except in compliance with | ||
| * the License. You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS IS" BASIS, | ||
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| * See the License for the specific language governing permissions and | ||
| * limitations under the License. | ||
| */ | ||
|
|
||
| package org.apache.dolphinscheduler.plugin.task.dinky; | ||
|
|
||
| import org.apache.dolphinscheduler.plugin.task.api.log.SensitiveDataConverter; | ||
| import org.apache.dolphinscheduler.plugin.task.api.model.Property; | ||
|
|
||
| import java.util.List; | ||
| import java.util.Map; | ||
| import java.util.Set; | ||
| import java.util.TreeSet; | ||
|
|
||
| final class DinkyLogSanitizer { | ||
|
|
||
| private DinkyLogSanitizer() { | ||
| throw new UnsupportedOperationException("Utility class"); | ||
| } | ||
|
|
||
| static String summarizeParameters(final DinkyParameters parameters) { | ||
| if (parameters == null) { | ||
| return "null"; | ||
| } | ||
| return "address=" + sanitizeMessage(parameters.getAddress()) | ||
| + ", taskId=" + sanitizeMessage(parameters.getTaskId()) | ||
| + ", online=" + parameters.isOnline() | ||
| + ", localParamKeys=" + summarizeLocalParamKeys(parameters.getLocalParams()); | ||
| } | ||
|
|
||
| static String summarizeVariables(final Map<String, String> variables) { | ||
| if (variables == null || variables.isEmpty()) { | ||
| return "size=0, keys=[]"; | ||
| } | ||
| Set<String> keys = new TreeSet<>(variables.keySet()); | ||
| return "size=" + variables.size() + ", keys=" + keys; | ||
| } | ||
|
|
||
| static String sanitizeMessage(final Object message) { | ||
| if (message == null) { | ||
| return null; | ||
| } | ||
| return SensitiveDataConverter.maskSensitiveData(String.valueOf(message)); | ||
| } | ||
|
|
||
| private static Set<String> summarizeLocalParamKeys(final List<Property> localParams) { | ||
| Set<String> keys = new TreeSet<>(); | ||
| if (localParams == null) { | ||
| return keys; | ||
| } | ||
| for (Property property : localParams) { | ||
| if (property != null && property.getProp() != null) { | ||
| keys.add(property.getProp()); | ||
| } | ||
| } | ||
| return keys; | ||
| } | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,111 @@ | ||
| /* | ||
| * Licensed to the Apache Software Foundation (ASF) under one or more | ||
| * contributor license agreements. See the NOTICE file distributed with | ||
| * this work for additional information regarding copyright ownership. | ||
| * The ASF licenses this file to You under the Apache License, Version 2.0 | ||
| * (the "License"); you may not use this file except in compliance with | ||
| * the License. You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS IS" BASIS, | ||
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| * See the License for the specific language governing permissions and | ||
| * limitations under the License. | ||
| */ | ||
|
|
||
| package org.apache.dolphinscheduler.plugin.task.dinky; | ||
|
|
||
| import static org.junit.jupiter.api.Assertions.assertFalse; | ||
| import static org.junit.jupiter.api.Assertions.assertNull; | ||
| import static org.junit.jupiter.api.Assertions.assertTrue; | ||
|
|
||
| import org.apache.dolphinscheduler.plugin.task.api.TaskExecutionContext; | ||
| import org.apache.dolphinscheduler.plugin.task.api.model.Property; | ||
|
|
||
| import java.lang.reflect.Method; | ||
| import java.util.Arrays; | ||
| import java.util.HashMap; | ||
| import java.util.Map; | ||
|
|
||
| import org.junit.jupiter.api.Test; | ||
|
|
||
| import com.fasterxml.jackson.databind.node.JsonNodeFactory; | ||
|
|
||
| class DinkyLogSanitizerTest { | ||
|
|
||
| @Test | ||
| void testSummarizeVariablesDoesNotExposeValues() { | ||
| Map<String, String> variables = new HashMap<>(); | ||
| variables.put("accessKeyId", "AKIA_TEST"); | ||
| variables.put("accessKeySecret", "SECRET_TEST"); | ||
| variables.put("businessDate", "2026-07-06"); | ||
|
|
||
| String summary = DinkyLogSanitizer.summarizeVariables(variables); | ||
|
|
||
| assertTrue(summary.contains("size=3")); | ||
| assertTrue(summary.contains("accessKeyId")); | ||
| assertTrue(summary.contains("accessKeySecret")); | ||
| assertTrue(summary.contains("businessDate")); | ||
| assertFalse(summary.contains("AKIA_TEST")); | ||
| assertFalse(summary.contains("SECRET_TEST")); | ||
| assertFalse(summary.contains("2026-07-06")); | ||
| } | ||
|
|
||
| @Test | ||
| void testSummarizeParametersDoesNotExposeLocalParamValues() { | ||
| DinkyParameters parameters = new DinkyParameters(); | ||
| parameters.setAddress("http://dinky:8888"); | ||
| parameters.setTaskId("1001"); | ||
| parameters.setOnline(true); | ||
| parameters.setLocalParams(Arrays.asList( | ||
| new Property("accessKeyId", null, null, "AKIA_TEST"), | ||
| new Property("businessDate", null, null, "2026-07-06"))); | ||
|
|
||
| String summary = DinkyLogSanitizer.summarizeParameters(parameters); | ||
|
|
||
| assertTrue(summary.contains("address=http://dinky:8888")); | ||
| assertTrue(summary.contains("taskId=1001")); | ||
| assertTrue(summary.contains("online=true")); | ||
| assertTrue(summary.contains("localParamKeys=[accessKeyId, businessDate]")); | ||
| assertFalse(summary.contains("AKIA_TEST")); | ||
| assertFalse(summary.contains("2026-07-06")); | ||
| } | ||
|
|
||
| @Test | ||
| void testSanitizeMessageMasksSensitiveValues() { | ||
| String message = "{\"accessKeyId\":\"AKIA_TEST\",\"accessKeySecret\":\"SECRET_TEST\"}"; | ||
|
|
||
| String sanitized = DinkyLogSanitizer.sanitizeMessage(message); | ||
|
|
||
| assertTrue(sanitized.contains("accessKeyId")); | ||
| assertTrue(sanitized.contains("accessKeySecret")); | ||
| assertFalse(sanitized.contains("AKIA_TEST")); | ||
| assertFalse(sanitized.contains("SECRET_TEST")); | ||
| } | ||
|
|
||
| @Test | ||
| void testSanitizeMessageMasksSensitiveValuesInJsonNodeMessage() { | ||
| String message = "{\"accessKeyId\":\"AKIA_TEST\",\"accessKeySecret\":\"SECRET_TEST\"}"; | ||
|
|
||
| String sanitized = DinkyLogSanitizer.sanitizeMessage(JsonNodeFactory.instance.textNode(message)); | ||
|
|
||
| assertTrue(sanitized.contains("accessKeyId")); | ||
| assertTrue(sanitized.contains("accessKeySecret")); | ||
| assertFalse(sanitized.contains("AKIA_TEST")); | ||
| assertFalse(sanitized.contains("SECRET_TEST")); | ||
| } | ||
|
|
||
| @Test | ||
| void testParseMalformedResponseReturnsNullWithoutExposingRawResponse() throws Exception { | ||
|
Member
There was a problem hiding this comment. This only asserts that the return value is null; it does not capture or inspect any log event. The test would also pass with the old implementation even if the raw response were written through the exception log.
Contributor
Author
There was a problem hiding this comment. Addressed in
Validation: |
||
| DinkyTask task = new DinkyTask(new TaskExecutionContext()); | ||
| Method parseMethod = DinkyTask.class.getDeclaredMethod("parse", String.class); | ||
| parseMethod.setAccessible(true); | ||
|
|
||
| Object result = parseMethod.invoke(task, | ||
| "malformed response accessKeyId=AKIA_TEST accessKeySecret=SECRET_TEST"); | ||
|
|
||
| assertNull(result); | ||
| } | ||
| } | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
.*?does not distinguish an escaped quote from the actual string terminator.eg, given valid JSON:
result output:
Uh oh!
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Fixed in
1e61609d. I replaced the lazy quoted-value match with quote-aware delimiter scanning, so escaped quotes are not treated as the end of the value. Known-sensitive masking now also runs before the legacy configured patterns, preventing the old password regex from truncating the value first.The exact JSON example now becomes
{"password":"******","bucket":"ds"}.Validation:
SensitiveDataConverterTestpassed 7/7,DinkyLogSanitizerTestpassed 5/5, and Spotless passed for both task-api and task-dinky.