chore: remove shell usage in shutdown subprocess #43
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.
What was the problem/requirement? (What/Why)
When the worker is instructed in a
UpdateWorkerSchedule
API response to shut down the worker host, it launches a subprocess using theshell=True
argument tosubprocess.Popen
. While the command is hard-coded and does not use user-supplied input, the worker agent code does not require the use of a shell and we should demonstrate best-practices and prevent any future possibility of unquoted shell command exploit.What was the solution? (How)
Switch from using a shell command string and
shell=True
to instead provide a list of strings for the command andshell=False
.What is the impact of this change?
The Worker Agent no longer uses a shell command-string when creating a subprocess for shutting down the host. This helps protect against a future potential regression where untrusted input is used to form the command. It also removes the unnecessary overhead for spawning a shell to run the desired command.
How was this change tested?
Updated the unit tests which now pass.
Was this change documented?
No
Is this a breaking change?
No