refactor(vault-keyring): rename env vars and add disable-keyring support

- Rename VAULT_DUMMY_PASS -> VAULT_DISABLE_KEYRING, KEYRING_SERVICE ->
  VAULT_KEYRING_SERVICE, KEYRING_USERNAME -> VAULT_KEYRING_USERNAME
- Add VAULT_DISABLE_KEYRING mode: prints VAULT_PASSWORD when set,
  falls back to dummy value when password is empty
- Add [vault-keyring] prefix to log messages

Author: flaudisio

scripts/vault-keyring.sh

@@ -20,15 +20,15 @@ set -o pipefail
 
 : "${DEBUG:=""}"
 
-: "${VAULT_DUMMY_PASS:=""}"
-: "${VAULT_PASSWORD:=""}"
+: "${VAULT_DISABLE_KEYRING:=""}"
+: "${VAULT_KEYRING_SERVICE:="linux-setup-playbook"}"
+: "${VAULT_KEYRING_USERNAME:="ansible-vault-password"}"
 
-: "${KEYRING_SERVICE:="linux-setup-playbook"}"
-: "${KEYRING_USERNAME:="ansible-vault-password"}"
+: "${VAULT_PASSWORD:=""}"
 
 function _msg()
 {
-    echo "$*" >&2
+    echo "[vault-keyring] $*" >&2
 }
 
 function _run()
@@ -44,13 +44,13 @@ function use_keyring()
     if [[ ! -t 0 ]] ; then
         _msg "Saving password provided via stdin"
         password="$( < /dev/stdin )"
-        echo "$password" | _run keyring set "$KEYRING_SERVICE" "$KEYRING_USERNAME"
+        echo "$password" | _run keyring set "$VAULT_KEYRING_SERVICE" "$VAULT_KEYRING_USERNAME"
         exit $?
     fi
 
     case "$1" in
         ""|get)
-            if ! _run keyring get "$KEYRING_SERVICE" "$KEYRING_USERNAME" ; then
+            if ! _run keyring get "$VAULT_KEYRING_SERVICE" "$VAULT_KEYRING_USERNAME" ; then
                 _msg "Error: Vault password was not found on keyring or could not be fetched from it"
                 exit 1
             fi
@@ -64,10 +64,10 @@ function use_keyring()
                 exit 2
             fi
 
-            echo "$password" | _run keyring set "$KEYRING_SERVICE" "$KEYRING_USERNAME"
+            echo "$password" | _run keyring set "$VAULT_KEYRING_SERVICE" "$VAULT_KEYRING_USERNAME"
         ;;
         del|delete)
-            _run keyring del "$KEYRING_SERVICE" "$KEYRING_USERNAME"
+            _run keyring del "$VAULT_KEYRING_SERVICE" "$VAULT_KEYRING_USERNAME"
         ;;
         *)
             echo "Error: unknown option: $1" >&2
@@ -78,19 +78,25 @@ function use_keyring()
 
 function main()
 {
-    if [[ -n "$VAULT_DUMMY_PASS" ]] ; then
-        _msg "[vault-keyring] VAULT_DUMMY_PASS variable is defined, printing dummy string to stdout"
-        echo "dummy"
-        exit 0
-    fi
-
     case "$1" in
         -D|--debug)
             DEBUG=1
             shift
         ;;
     esac
 
+    if [[ -n "$VAULT_DISABLE_KEYRING" ]] ; then
+        if [[ -n "$VAULT_PASSWORD" ]] ; then
+            _msg "VAULT_DISABLE_KEYRING variable is defined, printing VAULT_PASSWORD to stdout"
+            echo "$VAULT_PASSWORD"
+        else
+            _msg "Warning: VAULT_DISABLE_KEYRING is defined but VAULT_PASSWORD is empty, printing dummy value"
+            echo "dummy-value"
+        fi
+
+        exit 0
+    fi
+
     use_keyring "$@"
 }