Last active
August 1, 2024 08:55
-
-
Save leucos/a9f42e111a8cfc2ebf6e to your computer and use it in GitHub Desktop.
ansible-vault pre-commit hook
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
#!/bin/sh | |
# | |
# Pre-commit hook that verifies if all files containing 'vault' in the name | |
# are encrypted. | |
# If not, commit will fail with an error message | |
# | |
# Original author: @ralovely | |
# https://www.reinteractive.net/posts/167-ansible-real-life-good-practices | |
# | |
# File should be .git/hooks/pre-commit and executable | |
FILES_PATTERN='.*vault.*\.*$|digital_ocean\.ini|do_env\.sh' | |
REQUIRED='ANSIBLE_VAULT' | |
EXIT_STATUS=0 | |
wipe="\033[1m\033[0m" | |
yellow='\033[1;33m' | |
# carriage return hack. Leave it on 2 lines. | |
cr=' | |
' | |
for f in $(git diff --cached --name-only | grep -E $FILES_PATTERN) | |
do | |
# test for the presence of the required bit. | |
MATCH=`head -n1 $f | grep --no-messages $REQUIRED` | |
if [ ! $MATCH ] ; then | |
# Build the list of unencrypted files if any | |
UNENCRYPTED_FILES="$f$cr$UNENCRYPTED_FILES" | |
EXIT_STATUS=1 | |
fi | |
done | |
if [ ! $EXIT_STATUS = 0 ] ; then | |
echo '# COMMIT REJECTED' | |
echo '# Looks like unencrypted ansible-vault files are part of the commit:' | |
echo '#' | |
while read -r line; do | |
if [ -n "$line" ]; then | |
echo -e "#\t${yellow}unencrypted: $line${wipe}" | |
fi | |
done <<< "$UNENCRYPTED_FILES" | |
echo '#' | |
echo "# Please encrypt them with 'ansible-vault encrypt <file>'" | |
echo "# (or force the commit with '--no-verify')." | |
exit $EXIT_STATUS | |
fi | |
exit $EXIT_STATUS |
When committing I get:
.git/hooks/pre-commit: 38: Syntax error: redirection unexpected
@tuomastielinen #!/bin/sh
on Ubuntu is using the dash shell which does not have the <<< redirection operator.
Simply change the shell to bash #!/bin/bash
.
Danger Will Robinson!
If the vault is encrypted on the file system but unencrypted in the staging area then this hook will let the commit go through causing an unencrypted vault to be committed.
Fix:
Change line 23 to:
MATCH=`git show :$f | head -n1 | grep --no-messages $REQUIRED`
git show
uses the file content as it is in the git staging, not the file system.
Thanks @cniesen, seems to be working now.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Many thanks!