Python: Add shlex.quote as command injection sanitizer#23
Open
mrigankpawagi wants to merge 1 commit into
Open
Conversation
shlex.quote (Python 3) and pipes.quote (Python 2) properly escape shell metacharacters, preventing command injection when user input is incorporated into shell commands. These were already sanitizers for py/shell-command-constructed-from-input but not for py/command-line-injection.
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 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.
Fix
Adds
shlex.quote()andpipes.quote()(deprecated alias) as sanitizers for thepy/command-line-injectionquery.Problem
shlex.quote()is the standard Python function for escaping shell metacharacters in command arguments. It wraps the string in single quotes and escapes any existing single quotes. Code that usesshlex.quote()before passing user input to shell commands is safe from command injection, but the query currently flags it anyway.Validation
Python docs: https://docs.python.org/3/library/shlex.html#shlex.quote - "Return a shell-escaped version of the string s. The returned value is a string that can safely be used as one token in a shell command line."