read environment variables from files and start sub-process

unsecret.md

unsecret

⛔ [DEPRECATED] Active as a real project instead, development as a gist has been discontinued.

Unsecret is an inverted wrapper: It will arrange to set the value of one or several environment variables from the content of files before starting a program. This is useful when you have a Docker image that can only be configured using environment variables, but you wish to transmit settings (secrets?) to the container using a secret mechanism such as Docker secrets. Obviously, the secrets will be accessible and visible at the host running the container (since they are given to the underlying container through environment variables), but at least, you would have transmitted the value to the host using a secure mechanism.

Provided you have a file called my-test with the content 12345, the following command would print out MY_TEST with the value 12345 in the list of environment variables printed out at the console.

./unsecret.sh -e MY_TEST -- env

For more details, run the script with --help.

LICENSE

Copyright 2020 Emmanuel Frécon <[email protected]>

Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:

1. Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.

2. Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation and/or
other materials provided with the distribution.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

unsecret.sh

#!/bin/sh

set -e

UNSECRET_VERBOSE=${UNSECRET_VERBOSE:-0}
UNSECRET_ROOTDIR=${UNSECRET_ROOTDIR:-}
UNSECRET_ENVSET=${UNSECRET_ENVSET:-}
UNSECRET_AUTO=${UNSECRET_AUTO:-}

# Print usage on stderr and exit
usage() {
    exitcode="${1:-0}"
    cat <<USAGE >&2

Description:

  $0 will read environment variables from files and start a sub-process

Usage:
  $0 [-option arg --long-option(=)arg] (--) command

  where all dash-led options/flags are as follows (long options can be followed
  by an equal sign). The command, if present is executed once environment
  variables have been set.

  Flags:
    -v | --verbose
        Be more verbose
    -h | --help
        Print this help and exit

  Options:
    -r | --root | --root(-)dir
        Root directory under which to locate all files. Default to empty.
    -e | --env(ironment)
        Variable specification, see below. Can be repeated several times.
    -a | --auto)
        For all existing variables ending with this suffix, a variable will
        be created without the suffix and with the content of the file.

Details:

  Environment variable specifications are composed of the name of a variable,
  followed by the colon sign, followed by the file location at which to find the
  value of the variable. When the file path is relative, it will be relative to
  the root directory, specified through --root. If the root directory is empty,
  the file will be relative to the current directory.

  The colon and file specification are optional. When they are not present, the
  script will convert the name of the environment variable to lower case,
  replace all occurrences of an underscore (_) by a dash (-) and look for a file
  with that name.

USAGE
    exit "$exitcode"
}

while [ $# -gt 0 ]; do
    case "$1" in
    -v | --verbose)
        UNSECRET_VERBOSE=1; shift 1;;

    -r | --root-dir | --root | --rootdir)
        UNSECRET_ROOTDIR=$2; shift 2;;
    --root-dir=* | --root=* | --rootdir=*)
        UNSECRET_ROOTDIR="${1#*=}"; shift 1;;
    
    -e | --env | --environment)
        UNSECRET_ENVSET=$(printf '%s\n%s' "$2" "$UNSECRET_ENVSET"); shift 2;;
    --env | --environment)
        UNSECRET_ENVSET=$(printf '%s\n%s' "${1#*=}" "$UNSECRET_ENVSET"); shift 1;;

    -a | --auto )
        UNSECRET_AUTO=$2; shift 2;;
    --auto=*)
        UNSECRET_AUTO="${1#*=}"; shift 1;;
    
    -h | --help)
        usage; shift 1;;

    --)
        shift
        break
        ;;

    -*)
        usage 1
        exit
        ;;

    *)
        break
        ;;
    esac
done

warn() {
    printf "%s\n" "$*" 1>&2
}

verbose() {
    if [ "$UNSECRET_VERBOSE" = "1" ]; then printf "%s\n" "$*" 1>&2; fi
}

setvar() {
    if [ -z "$2" ]; then
        _fpath=$(printf %s\\n "$1" | tr '[:upper:]' '[:lower:]' | tr '_' '-')
    else
        _fpath=$2
    fi
    # Relative path from root dir when root dir is not empty.
    if [ -n "$UNSECRET_ROOTDIR" ]; then
        firstchar=$(printf %s\\n "$2" | cut -c1-1)
        if [ "$firstchar" != "/" ] && [ "$firstchar" != "~" ]; then
            _fpath="${UNSECRET_ROOTDIR%%/}/${_fpath}"
        fi
    fi
    value=$(cat "$_fpath")
    verbose "Setting $1 with content of $_fpath"
    export "${1}=${value}"
    unset _fpath
}

if [ -n "$UNSECRET_AUTO" ]; then
    while IFS= read -r setter; do
        varname=$(printf %s\\n "$setter"|sed -E 's/([^=]+)=(.*)/\1/'|sed "s/${UNSECRET_AUTO}\$//")
        fpath=$(printf %s\\n "$setter"|sed -E 's/([^=]+)=(.*)/\2/')
        setvar "$varname" "$fpath"
    done <<EOC
$(env | grep -E ".*${UNSECRET_AUTO}=.*")
EOC
fi

while read -r cmd; do
    if [ -n "$(printf %s\\n "$cmd" | sed -E 's/^[[:space:]]*$//g')" ]; then
        varname=$(printf %s\\n "$cmd"|awk -F ":" '{print $1}')
        # Path to file is directly specified or comes from name of variable.
        fpath=$(printf %s\\n "$cmd"|awk -F ":" '{print $2}')
        setvar "$varname" "$fpath"
    fi
done <<EOC
$UNSECRET_ENVSET
EOC

# Execute further the rest of the command-line arguments, with environment
# hopefully properly set.
[ "$#" -gt "0" ] && exec "$@"