Merge commit 'dkg/master'
[monkeysphere.git] / tests / basic
1 #!/usr/bin/env bash
2
3 # Tests to ensure that the monkeysphere is working
4
5 # Authors: 
6 #   Daniel Kahn Gillmor <dkg@fifthhorseman.net>
7 #   Jameson Rollins <jrollins@fifthhorseman.net>
8 #   Micah Anderson <micah@riseup.net> 
9 #
10 # Copyright: 2008-2009
11 # License: GPL v3 or later
12
13 # these tests should all be able to run as a non-privileged user.
14
15 # all subcommands in this script should complete without failure:
16 set -e
17 # piped commands should return the code of the first non-zero return
18 set -o pipefail
19
20 ## make sure that the right tools are installed to run the test.  the
21 ## test has *more* requirements than plain ol' monkeysphere:
22 which socat || { echo "You must have socat installed to run this test." ; exit 1; }
23
24 ## FIXME: other checks?
25
26 # gpg command for test admin user
27 gpgadmin() {
28     GNUPGHOME="$TEMPDIR"/admin/.gnupg gpg "$@"
29 }
30
31 # test ssh connection
32 # first argument is expected return code from ssh connection
33 ssh_test() {
34     umask 0077
35
36     CODE=${1:-0}
37
38     # start the ssh daemon on the socket
39     echo "##### starting ssh server..."
40     socat EXEC:"/usr/sbin/sshd -f ${SSHD_CONFIG} -i -D -e" "UNIX-LISTEN:${SOCKET}" 2> "$TEMPDIR"/sshd.log &
41     SSHD_PID="$!"
42
43     # wait until the socket is created before continuing
44     while [ ! -S "$SOCKET" ] ; do
45         sleep 1
46     done
47
48     set +e
49
50     # make a client connection to the socket
51     echo "##### starting ssh client..."
52     ssh-agent bash -c \
53         "monkeysphere subkey-to-ssh-agent && ssh -F $TEMPDIR/testuser/.ssh/config testhost true"
54     RETURN="$?"
55
56     # kill the sshd process if it's still running
57     kill "$SSHD_PID"
58     SSHD_PID=
59
60     set -e
61
62     echo "##### return $RETURN"
63     if [ "$RETURN" = "$CODE" ] ; then
64         echo "##### ssh connection test returned as desired"
65         return 0
66     else
67         echo "##### ssh connection test failed.  expected return code $CODE"
68         return 1
69     fi
70 }
71
72 failed_cleanup() {
73     # FIXME: can we be more verbose here?
74     echo 'FAILED!'
75     read -p "press enter to cleanup and remove tmp:"
76
77     cleanup
78 }
79
80 get_gpg_prng_arg() {
81     if (gpg --quick-random --version >/dev/null 2>&1) ; then
82         echo quick-random
83     elif (gpg --debug-quick-random --version >/dev/null 2>&1) ; then
84         echo debug-quick-random
85     fi
86 }
87
88 cleanup() {
89     echo "### removing temp dir..."
90     rm -rf "$TEMPDIR"
91
92     if [ "$SSHD_PID" ] ; then
93         echo "### killing off lingering sshd..."
94         kill "$SSHD_PID"
95     fi
96
97     wait
98 }
99
100 SSHD_PID=
101
102 ## setup trap
103 trap failed_cleanup EXIT
104
105
106 ### SETUP VARIABLES
107 ## set up some variables to ensure that we're operating strictly in
108 ## the tests, not system-wide:
109
110 export TESTDIR=$(pwd)
111
112 # make temp dir
113 TEMPDIR="$TESTDIR"/tmp
114 if [ -e "$TEMPDIR" ] ; then
115     echo "tempdir '$TEMPDIR' already exists."
116     exit 1
117 fi
118 mkdir "$TEMPDIR"
119
120 # Use the local copy of executables first, instead of system ones.
121 # This should help us test without installing.
122 export PATH="$TESTDIR"/../src:"$TESTDIR"/../src/keytrans:"$PATH"
123
124 export MONKEYSPHERE_SYSDATADIR="$TEMPDIR"
125 export MONKEYSPHERE_SYSCONFIGDIR="$TEMPDIR"
126 export MONKEYSPHERE_SYSSHAREDIR="$TESTDIR"/../src
127 export MONKEYSPHERE_MONKEYSPHERE_USER=$(whoami)
128 export MONKEYSPHERE_CHECK_KEYSERVER=false
129 export MONKEYSPHERE_LOG_LEVEL=DEBUG
130
131 export SSHD_CONFIG="$TEMPDIR"/sshd_config
132 export SOCKET="$TEMPDIR"/ssh-socket
133
134 # Make sure $DISPLAY is set to convince ssh and monkeysphere to fall
135 # back on $SSH_ASKPASS.  Make sure it's not set to the current actual
136 # $DISPLAY (if one exists) because this test suite should not be doing
137 # *anything* with any running X11 session.
138 export DISPLAY=monkeys
139
140 ### CONFIGURE ENVIRONMENTS
141
142 # copy in admin and testuser home to tmp
143 echo "### copying admin and testuser homes..."
144 cp -a "$TESTDIR"/home/admin "$TEMPDIR"/
145 cp -a "$TESTDIR"/home/testuser "$TEMPDIR"/
146
147 # set up environment for testuser
148 TESTHOME="$TEMPDIR"/testuser
149 export GNUPGHOME="$TESTHOME"/.gnupg
150 export SSH_ASKPASS="$TESTHOME"/.ssh/askpass
151 export MONKEYSPHERE_HOME="$TESTHOME"/.monkeysphere
152 cat <<EOF >> "$TESTHOME"/.ssh/config
153 UserKnownHostsFile $TESTHOME/.ssh/known_hosts
154 IdentityFile $TESTHOME/.ssh/no-such-identity
155 ProxyCommand $TESTHOME/.ssh/proxy-command %h %p $SOCKET
156 EOF
157 cat <<EOF >> "$MONKEYSPHERE_HOME"/monkeysphere.conf
158 KNOWN_HOSTS=$TESTHOME/.ssh/known_hosts
159 EOF
160 get_gpg_prng_arg >> "$GNUPGHOME"/gpg.conf
161
162 # set up sshd
163 echo "### configuring sshd..."
164 cp etc/ssh/sshd_config "$SSHD_CONFIG"
165 # write the sshd_config
166 cat <<EOF >> "$SSHD_CONFIG"
167 HostKey ${MONKEYSPHERE_SYSDATADIR}/ssh_host_rsa_key
168 AuthorizedKeysFile ${MONKEYSPHERE_SYSDATADIR}/authentication/authorized_keys/%u
169 EOF
170
171 # set up monkeysphere-server
172 echo "### configuring monkeysphere..."
173 mkdir -p -m 750 "$MONKEYSPHERE_SYSDATADIR"/host
174 mkdir -p -m 700 "$MONKEYSPHERE_SYSDATADIR"/authentication
175 mkdir -p -m 700 "$MONKEYSPHERE_SYSDATADIR"/authentication/authorized_keys
176 mkdir -p -m 750 "$MONKEYSPHERE_SYSDATADIR"/authentication/sphere
177 mkdir -p -m 700 "$MONKEYSPHERE_SYSDATADIR"/tmp
178 cp etc/monkeysphere/monkeysphere-server.conf "$TEMPDIR"/monkeysphere-server.conf
179 cat <<EOF >> "$TEMPDIR"/monkeysphere-server.conf
180 AUTHORIZED_USER_IDS="$MONKEYSPHERE_HOME/authentication/authorized_user_ids"
181 EOF
182 cat <<EOF > "$MONKEYSPHERE_SYSDATADIR"/authentication/sphere/gpg.conf
183 primary-keyring ${MONKEYSPHERE_SYSDATADIR}/authentication/sphere/pubring.gpg
184 keyring ${MONKEYSPHERE_SYSDATADIR}/authentication/core/pubring.gpg
185 EOF
186
187
188 ### SERVER TESTS
189
190 # create a new host key
191 echo "### generating server key..."
192 # add gpg.conf with quick-random
193 get_gpg_prng_arg >> "$MONKEYSPHERE_SYSCONFIGDIR"/host/gpg.conf
194 echo | monkeysphere-host expert gen-key --length 1024 --expire 0 testhost
195 # remove the gpg.conf
196 rm "$MONKEYSPHERE_SYSCONFIGDIR"/host/gpg.conf
197
198 HOSTKEYID=$( monkeysphere-host show-key | grep '^OpenPGP fingerprint: ' | cut -f3 -d\  )
199
200 # certify it with the "Admin's Key".
201 # (this would normally be done via keyservers)
202 echo "### certifying server key..."
203 monkeysphere-authentication expert gpg-cmd "--armor --export $HOSTKEYID" | gpgadmin --import
204 echo y | gpgadmin --command-fd 0 --sign-key "$HOSTKEYID"
205
206 # FIXME: how can we test publish-key without flooding junk into the
207 # keyservers?
208
209 # add admin as identity certifier for testhost
210 echo "### adding admin as certifier..."
211 echo y | monkeysphere-authentication add-id-certifier "$TEMPDIR"/admin/.gnupg/pubkey.gpg
212
213
214 ### TESTUSER TESTS
215
216 # generate an auth subkey for the test user that expires in 2 days
217 echo "### generating key for testuser..."
218 monkeysphere gen-subkey --expire 2
219
220 # add server key to testuser keychain
221 echo "### export server key to testuser..."
222 gpgadmin --armor --export "$HOSTKEYID" | gpg --import
223
224 # teach the "server" about the testuser's key
225 echo "### export testuser key to server..."
226 gpg --export testuser | monkeysphere-authentication gpg-cmd --import
227 echo "### update server authorized_keys file for this testuser..."
228 monkeysphere-authentication update-users $(whoami)
229
230 # connect to test sshd, using monkeysphere-ssh-proxycommand to verify
231 # the identity before connection.  This should work in both directions!
232 echo "### ssh connection test for success..."
233 ssh_test
234
235 # remove the testuser's authorized_user_ids file, update, and make
236 # sure that the ssh authentication FAILS
237 echo "### removing testuser authorized_user_ids and updating..."
238 mv "$TESTHOME"/.monkeysphere/authorized_user_ids{,.bak}
239 monkeysphere-authentication update-users $(whoami)
240 echo "### ssh connection test for server authentication denial..."
241 ssh_test 255
242 mv "$TESTHOME"/.monkeysphere/authorized_user_ids{.bak,}
243
244 # put improper permissions on authorized_user_ids file, update, and
245 # make sure ssh authentication FAILS
246 echo "### setting group writability on authorized_user_ids and updating..."
247 chmod g+w "$TESTHOME"/.monkeysphere/authorized_user_ids
248 monkeysphere-authentication update-users $(whoami)
249 echo "### ssh connection test for server authentication denial..."
250 ssh_test 255
251 chmod g-w "$TESTHOME"/.monkeysphere/authorized_user_ids
252 echo "### setting other writability on authorized_user_ids and updating..."
253 chmod o+w "$TESTHOME"/.monkeysphere/authorized_user_ids
254 monkeysphere-authentication update-users $(whoami)
255 echo "### ssh connection test for server authentication denial..."
256 ssh_test 255
257 chmod o-w "$TESTHOME"/.monkeysphere/authorized_user_ids
258
259
260 trap - EXIT
261
262 echo
263 echo "Monkeysphere basic tests completed successfully!"
264 echo
265
266 cleanup