Fix redaction of options #75
Conversation
| self.flags.redact_partial(fmt, inner)?; | ||
| if let RedactionLength::Partial = &self.flags.redact_length { | ||
| self.flags.redact_partial(fmt, inner)?; | ||
| } else { | ||
| self.flags.redact_full(fmt, inner)?; | ||
| } |
There was a problem hiding this comment.
Here is the bug. If the value being redacted is of type Option then redact_partial is called no matter what, even if that option was assigned #[redact]
| @@ -24,7 +24,7 @@ fn main() { | |||
| id: 1, | |||
| first_name: "John".to_string(), | |||
| last_name: "Doe".to_string(), | |||
| email: "johndoe@example.com".to_string(), | |||
| email: Some("johndoe@example.com".to_string()), | |||
There was a problem hiding this comment.
Without my change in src/private.rs this will print the following:
Customer {
id: 1,
first_name: "****",
last_name: "***",
email: Some(
"joh****@*******.com", <--- partial redaction even though I did not specify that
),
age: **,
}
|
How does opening a PR work in this repo? Are there tests I need to run and report status of? I see there is a workflow with three "expected" checks but I am not sure if anything is actionable by me at this point |
|
Hello! Nice catch and thanks for this PR 😄 We'll review this as soon as we can, in the meantime I'll approve the workflow so that they can run |
|
Hello @nick-schafhauser thank you for this PR! Can you please reformat the code? |
Thank you! I have pushed a new commit after running |
MaeIsBad
force-pushed
the
partial_redaction_on_option_bug_fix
branch
from
984c8ac
to
f86a3e5
Compare
Currently on
masterthere is a bug which hardcodes partial redaction for Options.The exact line can be found here: https://github.com/primait/veil/pull/75/files#diff-db6d7ee4e2c406f36b3c82c694cbe07a593a6b7c6f4c7585a742c9990560810cL170
I have added a new test to
veil-tests/src/redaction_tests.rswhich demonstrates this bug if you run it without any of the other code introduced in this PR. That new test will pass with the code introduced here (really just a copy-paste from other code in the repo).