(SH-2086) Use double quote to prevent globbing and word splitting

[philipjonsen]

Description

If you would like some more help, just write me a mail.

Description

Problematic code:

echo $1
for i in $*; do :; done # this one and the next one also apply to expanding arrays.
for i in $@; do :; done

Correct code:

echo "$1"
for i in "$@"; do :; done # or, 'for i; do'

Rationale

The first line in the problematic example looks like "print the first argument". In reality, it does a number of things:

Split the first argument by IFS (spaces, tabs and line feeds).
Expand each of the resulting strings as if it were a glob.
Join all the resulting strings with spaces.
Print the result.

The second line looks like "iterate through all arguments". This line is actually shorthand for the following steps:

Join all the arguments by the first character of IFS (space)
Split them by IFS
Expand each of them as globs
Iterate on the resulting list.

The third line skips the joining part.

Quoting variables prevents word splitting and glob expansion, and prevents the script from breaking when input contains spaces, line feeds, glob characters and such.

Strictly speaking, only expansions themselves need to be quoted, but for stylistic reasons, entire arguments with multiple variable and literal parts are often quoted as one:

$HOME/$dir/dist/bin/$file # Unquoted (bad)
"$HOME"/"$dir"/dist/bin/"$file" # Minimal quoting (good)
"$HOME/$dir/dist/bin/$file" # Canonical quoting (good)

When quoting composite arguments, make sure to exclude globs and brace expansions, which lose their special meaning in double quotes: "$HOME/$dir/src/.c" will not expand, but "$HOME/$dir/src"/.c will.

Note that $( ) starts a new context, and variables in it have to be quoted independently:

echo "This $variable is quoted $(but this $variable is not)"
echo "This $variable is quoted $(and now this "$variable" is too)"

Exceptions

Sometimes you want to split on spaces, like when building a command line:

options="-j 5 -B"
make $options file

Just quoting this doesn't work. Instead, you should have used an array (bash, ksh, zsh):

options=(-j 5 -B) # ksh: set -A options -- -j 5 -B
make "${options[@]}" file

or a function (POSIX):

make_with_flags() { make -j 5 -B "$@"; }
make_with_flags file

To split on spaces but not perform glob expansion, POSIX has a set -f to disable globbing. You can disable word splitting by setting IFS=''.

Similarly, you might want an optional argument:

debug=""
[[ $1 == "--trace-commands" ]] && debug="-x"
bash $debug script

Quoting this doesn't work, since in the default case, "$debug" would expand to one empty argument while $debug would expand into zero arguments. In this case, you can use an array with zero or one elements as outlined above, or you can use an unquoted expansion with an alternate value:

debug=""
[[ $1 == "--trace-commands" ]] && debug="yes"
bash ${debug:+"-x"} script

This is better than an unquoted value because the alternative value can be properly quoted, e.g. wget ${output:+ -o "$output"}.

Here are two common cases where this warning seems unnecessary but may still be beneficial:

cmd <<< $var # Requires quoting on Bash 3 (but not 4+)
: ${var=default} # Should be quoted to avoid DoS when var='//

Occurrences

There are 67 occurrences of this issue in the repository.

See all occurrences on DeepSource → app.deepsource.com/gh/philipjonsen/mern-stack-ecommerce/issue/SH-2086/occurrences/