Mask secrets in CommandInvokedEvent and Command logger #25307
Conversation
This file contains 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
pzygielo
reviewed
Jan 5, 2025
| subject); | ||
| eventService.getCommandInvokedTopic() | ||
| .publish(event); | ||
| } | ||
|
|
||
| private ParameterMap maskSecretParameters(ParameterMap parameters) { |
There was a problem hiding this comment.
Could it be static and have unit test?
There was a problem hiding this comment.
OK. I will add this specific case into the CommandLoggerTest tests.
pzygielo
reviewed
Jan 5, 2025
| @@ -1642,12 +1643,22 @@ public void executeFromCheckpoint(JobManager.Checkpoint checkpoint, boolean reve | |||
| private void publishCommandInvokedEvent(ExecutionContext invocation, Subject subject) { | |||
| final CommandInvokedEvent event = new CommandInvokedEvent( | |||
| invocation.name(), | |||
| invocation.parameters(), | |||
| maskSecretParameters(invocation.parameters()), | |||
There was a problem hiding this comment.
The current failures suggest (to me), that invocation.parameters() can be null.
Extracted ExecutionContext inner class to package-private class CommandRunnerExecutionContext. Was too big and deserved a file on its own. Moved mask method to ParameterMap and added unit tests.
A test to verfiy that the command logger doesn't log passwords
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
This fixes a security issue in the Command Logger feature, which allowed to expose passwords used in some admin commands. This fix replaces passwords in the logged messages by "******".