mirror of
https://github.com/rawiriblundell/wiki.bash-hackers.org
synced 2024-12-26 06:20:41 +01:00
106 lines
4.0 KiB
Markdown
106 lines
4.0 KiB
Markdown
# Config files for your script
|
|
|
|
|
|
|
|
## General
|
|
|
|
For this task, you don't have to write large parser routines (unless you
|
|
want it 100% secure or you want a special file syntax) - you can use the
|
|
Bash source command. The file to be sourced should be formated in
|
|
key="value" format, otherwise bash will try to interpret commands:
|
|
|
|
#!/bin/bash
|
|
echo "Reading config...." >&2
|
|
source /etc/cool.cfg
|
|
echo "Config for the username: $cool_username" >&2
|
|
echo "Config for the target host: $cool_host" >&2
|
|
|
|
So, where do these variables come from? If everything works fine, they
|
|
are defined in /etc/cool.cfg which is a file that's sourced into the
|
|
current script or shell. Note: this is **not** the same as executing
|
|
this file as a script! The sourced file most likely contains something
|
|
like:
|
|
|
|
cool_username="guest"
|
|
cool_host="foo.example.com"
|
|
|
|
These are normal statements understood by Bash, nothing special. Of
|
|
course (and, a big disadvantage under normal circumstances) the sourced
|
|
file can contain **everything** that Bash understands, including
|
|
malicious code!
|
|
|
|
The `source` command also is available under the name `.` (dot). The
|
|
usage of the dot is identical:
|
|
|
|
#!/bin/bash
|
|
echo "Reading config...." >&2
|
|
. /etc/cool.cfg #note the space between the dot and the leading slash of /etc.cfg
|
|
echo "Config for the username: $cool_username" >&2
|
|
echo "Config for the target host: $cool_host" >&2
|
|
|
|
## Per-user configs
|
|
|
|
There's also a way to provide a system-wide config file in /etc and a
|
|
custom config in ~/(user's home) to override system-wide defaults. In
|
|
the following example, the if/then construct is used to check for the
|
|
existance of a user-specific config:
|
|
|
|
#!/bin/bash
|
|
echo "Reading system-wide config...." >&2
|
|
. /etc/cool.cfg
|
|
if [ -r ~/.coolrc ]; then
|
|
echo "Reading user config...." >&2
|
|
. ~/.coolrc
|
|
fi
|
|
|
|
## Secure it
|
|
|
|
As mentioned earlier, the sourced file can contain anything a Bash
|
|
script can. Essentially, it **is** an included Bash script. That creates
|
|
security issues. A malicicios person can "execute" arbitrary code when
|
|
your script is sourcing its config file. You might want to allow only
|
|
constructs in the form `NAME=VALUE` in that file (variable assignment
|
|
syntax) and maybe comments (though technically, comments are
|
|
unimportant). Imagine the following "config file", containing some
|
|
malicious code:
|
|
|
|
# cool config file for my even cooler script
|
|
username=god_only_knows
|
|
hostname=www.example.com
|
|
password=secret ; echo rm -rf ~/*
|
|
parameter=foobar && echo "You've bene pwned!";
|
|
# hey look, weird code follows...
|
|
echo "I am the skull virus..."
|
|
echo rm -fr ~/*
|
|
mailto=netadmin@example.com
|
|
|
|
You don't want these `echo`-commands (which could be any other
|
|
commands!) to be executed. One way to be a bit safer is to filter only
|
|
the constructs you want, write the filtered results to a new file and
|
|
source the new file. We also need to be sure something nefarious hasn't
|
|
been added to the end of one of our name=value parameters, perhaps using
|
|
; or && command separators. In those cases, perhaps it is simplest to
|
|
just ignore the line entirely. Egrep (`grep -E`) will help us here, it
|
|
filters by description:
|
|
|
|
#!/bin/bash
|
|
configfile='/etc/cool.cfg'
|
|
configfile_secured='/tmp/cool.cfg'
|
|
|
|
# check if the file contains something we don't want
|
|
if egrep -q -v '^#|^[^ ]*=[^;]*' "$configfile"; then
|
|
echo "Config file is unclean, cleaning it..." >&2
|
|
# filter the original to a new file
|
|
egrep '^#|^[^ ]*=[^;&]*' "$configfile" > "$configfile_secured"
|
|
configfile="$configfile_secured"
|
|
fi
|
|
|
|
# now source it, either the original or the filtered variant
|
|
source "$configfile"
|
|
|
|
**<u>To make clear what it does:</u>** egrep checks if the file contains
|
|
something we don't want, if yes, egrep filters the file and writes the
|
|
filtered contents to a new file. If done, the original file name is
|
|
changed to the name stored in the variable `configfile`. The file named
|
|
by that variable is sourced, as if it were the original file.
|