fix(escape-cli-args): Always use quotes to escape CLI arguments #53
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
dhh
reviewed
Feb 20, 2023
lib/mrsk/utils.rb
Outdated
| @@ -5,7 +5,7 @@ module Mrsk::Utils | |||
| def argumentize(argument, attributes, redacted: false) | |||
| Array(attributes).flat_map do |k, v| | |||
| if v.present? | |||
| [ argument, redacted ? redact("#{k}=#{v}") : "#{k}=#{v}" ] | |||
| [ argument, redacted ? redact("#{k}=\"#{v}\"") : "#{k}=\"#{v}\"" ] | |||
There was a problem hiding this comment.
Don't we need to escape any potential "'s inside the v?
There was a problem hiding this comment.
Yes thank you ! I've used the dump function which does exactly that, and added a gsub escape for backticks which are not escaped by this function.
* main: Bump version for 0.8.0 Remove images of the same name before pulling a new one Changed to a timeout Better language Switch to ruby-based retry
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.
What's the identified issue ?
Mrsk currently does not escape the command line arguments it concatenates for the docker commands.
This make mrsk very susceptible to unescaped characters errors, as the following example demonstrates with an environment string that contains the symbol
&:Which subsequently creates this docker run issue :
This is due to the
argumentizefunction not escaping the characters.What fix does this PR introduce ?
This PR forces all
argumentizedCLI arguments to be escaped, thus making the produced commands safe to run.What's important to note
Labels are argumentized the same way that environment variables are, which means I also had to change the way we use traefik labels that use backticks in the code. Result should be 1:1 with what existed before, but I also had to revamp most of the tests to account for this change.
We might have wanted to make two different
argumentizefunctions, but I don't love it because of code duplication and because I think it's always better to escape characters.In the future we might want to create a special case for integers, but iirc everything that bash passes is a string so I didn't do that here and noticed no behavior
Tests are passing and this has been tested on a mrsk deploy.