Swift: Make the cleartext logging query consistent with other cleartext-* queries. #13163
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
MathiasVP
reviewed
May 16, 2023
Contributor
MathiasVP
left a comment
MathiasVP
left a comment
There was a problem hiding this comment.
A comment and a suggestion, but otherwise this LGTM
Comment on lines
+24
to
+26
| "This operation writes '" + sink.toString() + | ||
| "' to a log file. It may contain unencrypted sensitive data from $@.", source, | ||
| source.getNode().toString() |
Contributor
There was a problem hiding this comment.
We have a lot of very different alert messages across languages for this query:
- Go: "$@ flows to a logging call."
- Python: "This expression logs $@ as clear text."
- JS: "This logs sensitive data returned by $@ as clear text."
- Ruby: "This logs sensitive data returned by $@ as clear text."
Are any of those alert messages better than the one we have right now for Swift?
Contributor
Author
There was a problem hiding this comment.
The main thing I care about is describing the source in the string, so that in a list of results (e.g. on MRVA) ones that are different from the others immediately stand out (without having to click through). The phrasing I've gone for here is just similar to the other swift/cleartext-* queries.
I do like the Go one for it's simplicity, but I think what we have is clear and consistent.
Co-authored-by: Mathias Vorreiter Pedersen <[email protected]>
MathiasVP
approved these changes
May 23, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
Make the cleartext logging query consistent with other
cleartext-*queries.swift/clear-text-*toswift/cleartext-*, to match the other queries; we don't like to change query IDs, but doing it before public beta will have negligible effect compared to after.