1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
|
# This file should be sourced by all test-scripts
#
# This scripts sets the following:
# $GNUPGHOME Full path to test GPG directory
# $PASS Full path to password-store script to test
# $GPG Name of gpg executable
# $PASSWORD_STORE_KEY GPG key id of testing key
# $PASSWORD_STORE_TEST_HOME This folder
#
# Constants
PASSWORD_STORE_TEST_HOME="$(cd "$(dirname "$BASH_SOURCE")"; pwd)"
#
# Find the pass script
PASS="${PASSWORD_STORE_TEST_HOME}/../src/password-store.sh"
if [[ ! -e $PASS ]]; then
echo "Could not find password-store.sh"
exit 1
fi
#
# GnuPG configuration
# Where the test keyring and test key id
# Note: the assumption is the test key is unencrypted.
export GNUPGHOME="${PASSWORD_STORE_TEST_HOME}/gnupg/"
chmod 700 "$GNUPGHOME"
export PASSWORD_STORE_KEY="3DEEA12D" # "Password-store Test Key"
GPG="gpg"
which gpg2 &>/dev/null && GPG="gpg2"
# We don't want to use any running agent.
# We want an agent to appear to pass to be running.
# We don't need a real agent. Hence:
export GPG_AGENT_INFO=" "
# pass_init()
#
# Initialize a password store, setting PASSWORD_STORE_DIR
#
# Arguments: None
# Returns: Nothing, sets PASSWORD_STORE_DIR
pass_init() {
export PASSWORD_STORE_DIR="${SHARNESS_TRASH_DIRECTORY}/test-store/"
echo "Initializing test password store (${PASSWORD_STORE_DIR}) with key ${PASSWORD_STORE_KEY}"
if [[ -d "${PASSWORD_STORE_DIR}" ]] ; then
echo "Removing old store"
rm -rf "${PASSWORD_STORE_DIR}"
if [[ -d "${PASSWORD_STORE_DIR}" ]] ; then
echo "Removal failed."
return 1
fi
fi
$PASS init ${PASSWORD_STORE_KEY} || return 1
echo "Initialization of ${PASSWORD_STORE_DIR} complete."
}
# check_cred()
#
# Check to make sure the given credential looks valid.
# Meaning it exists and has at least one line.
#
# Arguments: <credential name>
# Returns: 0 if valid looking, 1 otherwise
check_cred() {
if [[ "$#" -ne 1 ]]; then
echo "$0: Bad arguments"
return 1
fi
local cred="$1"
shift
echo "Checking credential ${cred}"
if ! $PASS show "$cred"; then
echo "Credential ${cred} does not exist"
return 1
fi
if [[ -z "$($PASS show "$cred")" ]]; then
echo "Credential ${cred} empty"
return 1
fi
}
# check_no_cred()
#
# Check to make sure the given credential does not exist.
# Use to validate removal, moving, etc.
#
# Arguments: <credential name>
# Returns: 0 if credential does not exist, 1 otherwise
check_no_cred() {
if [[ "$#" -ne 1 ]]; then
echo "$0: Bad arguments"
return 1
fi
local cred="$1"
shift
echo "Checking for lack of credential ${cred}"
$PASS show "$cred" || return 0
echo "Credential ${cred} exists."
return 1
}
# create_cred()
#
# Create a credential with the given name and, optionally, password.
# Credential must not already exist.
#
# Arguments: <credential name> [<password>]
# Returns: 0 on success, 1 otherwise.
create_cred() {
if ! [[ "$#" -gt 0 && "$#" -lt 3 ]]; then
echo "$0: Bad arguments"
return 1
fi
local cred="$1"
shift
echo "Creating credential ${cred}"
if ! check_no_cred "$cred"; then
echo "Credential already exists"
return 1
fi
if [[ "$#" -eq 1 ]]; then
local password="$1"
shift
echo "Using password \"$password\" for $cred"
# TODO: Working around bug with 'pass insert' returning non-zero.
# Fix this code to exit on error when that is fixed.
$PASS insert -e "$cred" <<<"$password" || true
else
echo "Generating random password for $cred"
if ! $PASS generate "${cred}" 24 > /dev/null; then
echo "Failed to create credential ${cred}"
return 1
fi
fi
return 0
}
# verify_password()
#
# Verify a given credential exists and has the given password.
#
# Arguments: <credential name> <password>
# Returns: 0 on success, 1 otherwise.
verify_password() {
if [[ "$#" -ne 2 ]]; then
echo "$0: Bad arguments"
return 1
fi
local cred="$1"
shift
local expected="$1"
shift
echo "Verifing credential ${cred} has password \"${expected}\""
check_cred "$cred" || return 1
local actualfile="${SHARNESS_TRASH_DIRECTORY}/verify-password-actual.$RANDOM.$RANDOM.$RANDOM.$RANDOM"
local expectedfile="${SHARNESS_TRASH_DIRECTORY}/verify-password-expected.$RANDOM.$RANDOM.$RANDOM.$RANDOM"
$PASS show "$TEST_CRED" | sed -n 1p > "$actualfile" &&
echo "$expected" > "$expectedfile" &&
test_cmp "$expectedfile" "$actualfile"
}
# canonicalize_gpg_keys()
#
# Resolves key names to key ids.
#
# Arguments: <key name>...
# Returns: 0, and echos keys on new lines
canonicalize_gpg_keys() {
$GPG --list-keys --keyid-format long "$@" | sed -n 's/sub *.*\/\([A-F0-9]\{16\}\) .*/\1/p' | sort -u
}
# gpg_keys_from_encrypted_file()
#
# Finds keys used to encrypt a .gpg file.
#
# Arguments: <gpg file>
# Returns 0, and echos keys on new lines
gpg_keys_from_encrypted_file() {
$GPG -v --list-only --keyid-format long "$1" 2>&1 | cut -d ' ' -f 5 | sort -u
}
# gpg_keys_from_group()
#
# Finds keys used in gpg.conf group
#
# Arguments: <group>
# Returns: 0, and echos keys on new lines, which might be non-canonical
gpg_keys_from_group() {
$GPG --list-config --with-colons | sed -n "s/^cfg:group:$1:\\(.*\\)/\\1/p" | tr ';' '\n'
}
# Initialize the test harness
. ./sharness.sh
|