Fix unintended data modification when redacted environment variables #1657
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
When I did the change to redact environment variable values in policy engine error messages, I create a "false positive error message" bug. If any policy check were to be denied that involved environment variables in the check, then environment variables would be listed as a cause even if they weren't. This was because the previous redacting code was changing the data object used to determine the errors. The updated data object had the redacted environment variables which would never match so all error messages would include that the envs were invalid. This commit fixes that issue but creating a new object when redacting, the original object is still used to data checking and if redaction has been done, the new data object is used for generating the error message. The current test system makes this somewhat hard to test for. I will be adding tests to cover "false positive error messages" in the not so distant future. In the meantime, this commit addresses the bug before it makes to production. Signed-off-by: Sean T. Allen <seanallen@microsoft.com>
anmaxvl
approved these changes
Feb 13, 2023
helsaawy
approved these changes
Feb 13, 2023
| @@ -318,6 +318,11 @@ func (policy *regoEnforcer) getReasonNotAllowed(enforcementPoint string, input i | |||
|
|
|||
| func (policy *regoEnforcer) redactSensitiveData(input inputData) inputData { | |||
| if v, k := input["envList"]; k { | |||
There was a problem hiding this comment.
unrelated, should this be v, ok?
There was a problem hiding this comment.
yes. shall i do another PR for that?
There was a problem hiding this comment.
should it be ok or exists or what? i cant remember the go convention.
I felt very "DUR" when I found this. |
KenGordon
pushed a commit
to KenGordon/hcsshim
that referenced
this pull request
May 17, 2024
…icrosoft#1657) When I did the change to redact environment variable values in policy engine error messages, I create a "false positive error message" bug. If any policy check were to be denied that involved environment variables in the check, then environment variables would be listed as a cause even if they weren't. This was because the previous redacting code was changing the data object used to determine the errors. The updated data object had the redacted environment variables which would never match so all error messages would include that the envs were invalid. This commit fixes that issue but creating a new object when redacting, the original object is still used to data checking and if redaction has been done, the new data object is used for generating the error message. The current test system makes this somewhat hard to test for. I will be adding tests to cover "false positive error messages" in the not so distant future. In the meantime, this commit addresses the bug before it makes to production. Signed-off-by: Sean T. Allen <seanallen@microsoft.com> (cherry picked from commit 3489fc4)
KenGordon
pushed a commit
to KenGordon/hcsshim
that referenced
this pull request
May 17, 2024
…ironment variables (microsoft#1657) Fix unintended data modification when redacted environment variables (microsoft#1657) When I did the change to redact environment variable values in policy engine error messages, I create a "false positive error message" bug. If any policy check were to be denied that involved environment variables in the check, then environment variables would be listed as a cause even if they weren't. This was because the previous redacting code was changing the data object used to determine the errors. The updated data object had the redacted environment variables which would never match so all error messages would include that the envs were invalid. This commit fixes that issue but creating a new object when redacting, the original object is still used to data checking and if redaction has been done, the new data object is used for generating the error message. The current test system makes this somewhat hard to test for. I will be adding tests to cover "false positive error messages" in the not so distant future. In the meantime, this commit addresses the bug before it makes to production. Signed-off-by: Sean T. Allen <seanallen@microsoft.com> (cherry picked from commit 3489fc4) Related work items: microsoft#1657
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.
When I did the change to redact environment variable values in policy engine error messages, I create a "false positive error message" bug.
If any policy check were to be denied that involved environment variables in the check, then environment variables would be listed as a cause even if they weren't. This was because the previous redacting code was changing the data object used to determine the errors.
The updated data object had the redacted environment variables which would never match so all error messages would include that the envs were invalid.
This commit fixes that issue but creating a new object when redacting, the original object is still used to data checking and if redaction has been done, the new data object is used for generating the error message.
The current test system makes this somewhat hard to test for. I will be adding tests to cover "false positive error messages" in the not so distant future. In the meantime, this commit addresses the bug before it makes to production.
Signed-off-by: Sean T. Allen seanallen@microsoft.com