Redact S3 credentials from logs #10811
Draft
Conversation
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
|
Congratulations on your first Pull Request and welcome to the Apache CloudStack community! If you have any issues or are unsure about any anything please check our Contribution Guide (https://github.com/apache/cloudstack/blob/main/CONTRIBUTING.md)
|
DaanHoogland
reviewed
May 5, 2025
Comment on lines
+288
to
+293
| DataStoreTO store = safeCmd.getDataStore(); | ||
| if (store instanceof S3TO) { | ||
| ((S3TO) store).setAccessKey("***REDACTED***"); | ||
| ((S3TO) store).setSecretKey("***REDACTED***"); | ||
| } | ||
| logger.debug(LogUtils.logGsonWithoutException("Executing command %s [%s].", safeCmd.getClass().getSimpleName(), safeCmd)); |
There was a problem hiding this comment.
code looks good, but it seems this should be in LogUtils. There is other obfuscation code also scattered across the code base, so definately not a 👎 but a mere suggestion.
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.
Description
This PR addresses a security issue where S3 credentials used for Secondary Storage were being logged in plain text in CloudStack logs (
access.logandmanagement-server.log). Even when debug logging is enabled, secret credentials such asaccessKeyandsecretKeyshould never appear in logs.Fix details:
accessKeyandsecretKeyfrom theS3TOobject before loggingDownloadCommandinNfsSecondaryStorageResource.java.NfsSecondaryStorageResourceTest.javato verify that credentials are redacted.Steps to reproduce the issue:
/var/log/cloudstack/management/access.logormanagement-server.log— credentials will be printed.Fixes: #10339
Types of changes
Bug Severity
How Has This Been Tested?
S3TOand verifies thatsetAccessKey("***REDACTED***")andsetSecretKey("***REDACTED***")are called duringexecuteRequest.