Use only pure f-strings for logs, avoid %s/%r formatting #772
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
This is secure, as Python checks for the existence of args/kwargs in `logging` before doing the printf-style formatting — see `logging.LogRecord.getMessage()`:
```python
msg = str(self.msg)
if self.args:
msg = msg % self.args
```
If we do not pass the args/kwargs, the formatting will not be invoked, so injections of format specifiers via user-side resource fields are not possible — they will be logged "as is".
Signed-off-by: Sergey Vasilyev <nolar@nolar.info>
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 is secure, as Python checks for the existence of args/kwargs in
loggingbefore doing the printf-style formatting — seelogging.LogRecord.getMessage():If we do not pass the args/kwargs, the formatting will not be invoked, so injections of format specifiers via user-side resource fields are not possible — they will be logged "as is".