{{Header}}
{{title|title=
/bin/bash - Proper Whitespace Handling - Whitespace Safety - End-of-Options Parameter Security
}}
{{#seo:
|description=Supporting multiple command line parameters with spaces in wrapper scripts and Use of End-of-Options Parameter (--).
}}
<div class="mininav">
* [[Dev/coding style]]
* [[Dev/bash]]
</div>
{{intro|
Supporting multiple command line parameters with spaces in wrapper scripts and End-of-Options Parameter (--) for better security.
}}
= safe echo =
TODO

* {{VideoLink
|videoid=lq98MM2ogBk
|text=bash's echo command is broken 
}}
* {{VideoLink
|videoid=ft0_cw54qak
|text=echo is broken: a follow-up video 
}}

shellcheck bug reports:

* [https://github.com/koalaman/shellcheck/issues/2674 Warn on echo "$var" when $var might be -e #2674]
* https://github.com/koalaman/shellcheck/issues?q=is%3Aissue+is%3Aopen+echo+in%3Atitle

helper-scripts:

* https://github.com/Kicksecure/helper-scripts/blob/master/usr/libexec/helper-scripts/safe_echo.sh

A drop-in replacement safe_echo would be useful to have.

Based on echo:

* implementation: abort if first character is a <code>-</code>
* advantage: supports colors etc.
* disadvantage: break on legitimate output such as "--example"

Based on printf:

* disadvantage: no support for colors etc.
* advantae: does not break if first character is <code>-</code>

= Bash Proper Whitespace Handling =
<pre>
#!/bin/bash

## https://yakking.branchable.com/posts/whitespace-safety/

set -e

app_user=user
lib_dir="/tmp/test/lib/program with space/something spacy"
main_app_dir="/tmp/test/home/user/folder with space/abc"
mkdir -p "$lib_dir"
mkdir -p "$main_app_dir"

declare -a cmd

cmd+=("cp")
cmd+=("-r")
cmd+=("${lib_dir}")
cmd+=("${main_app_dir}/")

"${cmd[@]}"
</pre>

= Use of End-of-Options Parameter (--) =

The end-of-options parameter "<code>--</code>" is crucial because otherwise inputs might be mistaken for command options. This might even be a security risk. Here are examples using the `sponge` command:

{{CodeSelect|code=
echo test | sponge -a testfilename  
}}

Result: OK. This works because "testfilename" doesn't look like an option.

{{CodeSelect|code=
echo test | sponge -a --testfilename
}}

Result: Fail. The command interprets "--testfilename" as a series of options:

<pre>
sponge: invalid option -- '-'
sponge: invalid option -- 't'
sponge: invalid option -- 'e'
...
test
</pre>

{{CodeSelect|code=
echo test | sponge -a -- --testfilename
}}

Result: OK. The `--` signals that "--testfilename" is a filename, not an option.

Conclusion:

* The "<code>--</code>" parameter marks the end of command options.
* Use "<code>--</code>" add the end of a command prevent misinterpretation.
* This technique is applicable to many Unix/Linux commands, not just <code>sponge</code>.

= nounset - Check if Variable Exists  =

<pre>
#!/bin/bash

set -x
set -e
set -o nounset

## Enable for testing.
#unset HOME

if [ -z "${HOME+x}" ]; then
    echo "Error: HOME is not set."
fi

echo "$HOME"
</pre>

= Safely Using Find with End-Of-Options =

Example:

Note: Variable could be different. Could be for example <code>--/usr</code>.

{{CodeSelect|code=
folder_name="/usr"
}}

{{CodeSelect|code=
printf '%s' "${folder_name}" {{!}} find -files0-from - -perm /u=s,g=s -print0
}}

Of if <code>safe_echo_nonewline</code> is available from helper-scripts.

{{CodeSelect|code=
# shellcheck disable=SC1091
source /usr/libexec/helper-scripts/safe_echo.sh
safe_echo_nonewline "${folder_name}" {{!}} find -files0-from - -perm /u=s,g=s -print0
}}

Not using bash's built-in <code>echo</code>, because it does not support end-of-options ("<code>--</code>").

Not using <code>/usr/bin/echo</code>, because it does not support end-of-options ("<code>--</code>").

{{CodeSelect|code=
## Broken!
## The '-n' option is needed to avoid piping a newline to 'find'.
echo -n -- "${folder_name}" {{!}} find -files0-from - -perm /u=s,g=s -print0
}}

= misc =
<pre>
base_name="${file_name##*/}"
file_extension="${base_name##*.}"
</pre>

= coding style =
* use:
** shellcheck
** <code>safe-rm</code>
** <code>scurl</code>
** <code>str_replace</code>
** <code>append-once</code>
* use <code>${variable}</code> style
* use shell options

<pre>
set -o errexit
set -o nounset
set -o errtrace
set -o pipefail
</pre>

= See Also =
* https://github.com/anordal/shellharden/blob/master/how_to_do_things_safely_in_bash.md

{{Footer}}

[[Category: Design]]