Debian Codegraph @

test

raw
1 #!/bin/bash
2
3 #----------------------------------------------------------------------
4 # ACME client written with process isolation and minimal privileges in mind
5 # (test suite)
6 # Copyright © 2015-2021 Guilhem Moulin <[email protected]>
7 #
8 # This program is free software: you can redistribute it and/or modify
9 # it under the terms of the GNU General Public License as published by
10 # the Free Software Foundation, either version 3 of the License, or
11 # (at your option) any later version.
12 #
13 # This program is distributed in the hope that it will be useful,
14 # but WITHOUT ANY WARRANTY; without even the implied warranty of
15 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 # GNU General Public License for more details.
17 #
18 # You should have received a copy of the GNU General Public License
19 # along with this program. If not, see <https://www.gnu.org/licenses/>.
20 #----------------------------------------------------------------------
21
22 set -ue
23 PATH="/usr/bin:/bin"
24 export PATH
25
26 usage() {
27 local rv="${1-0}"
28 echo "Usage: $0 [--deb|--dev] [TEST..]" >&2
29 exit $rv
30 }
31
32 # Setup: for any subdomain under $DOMAINNAME,
33 # http://$subdomain.$DOMAINNAME/.well-known/acme-challenge/$challenge
34 # must be routed to this machine.
35 # This can be done with a wildcard DNS record and opening tcp/80 in firewall.
36 DOMAINNAME="lacme-test.guilhem.org"
37 ACMEAPI_SERVER="https://acme-staging-v02.api.letsencrypt.org/directory"
38
39 MODE="dev"
40 DISTRIBUTION="sid"
41 BUILDDIR="build/test"
42 while [ $# -gt 0 ]; do
43 case "$1" in
44 --deb) MODE="deb"; shift;;
45 --dev) MODE="dev"; shift;;
46 --help|-h) usage 0;;
47 -*) echo "Error: Unknown option $1" >&2; usage 1;;
48 --) shift; break;;
49 *) break;
50 esac
51 done
52
53 cd "$(dirname -- "$0")"
54 declare -a TESTS=()
55 if [ $# -eq 0 ]; then
56 # always start with registration, the account key might be new
57 TESTS+=( "register" )
58 for t in tests/*; do
59 if [ "$t" != "tests/register" ] && [ "${t#tests/account-encrypted-}" = "$t" ] && [ -f "$t" ]; then
60 # skip registration and non-interactive tests
61 TESTS+=( "${t#tests/}" )
62 fi
63 done
64 else
65 for t in "$@"; do
66 t="${t#tests/}"
67 if [ -f "tests/$t" ]; then
68 TESTS+=( "$t" )
69 else
70 echo "Error: '$t': no such test" >&2
71 exit 1
72 fi
73 done
74 fi
75
76 if [ "$MODE" = "deb" ]; then
77 DISTRIBUTION="$(dpkg-parsechangelog -S Distribution)"
78 [ "$DISTRIBUTION" != "UNRELEASED" ] || DISTRIBUTION="sid"
79 PKG_DESTDIR="${XDG_CACHE_HOME:-"$HOME/.cache"}/build-area"
80 fi
81
82 ACCOUNT_KEY="$BUILDDIR/account.key"
83 mkdir -pv -- "$BUILDDIR"
84 if [ ! -f "$ACCOUNT_KEY" ]; then
85 # keep the account key (up to `make clean`) to avoid hitting
86 # rate-liming -- currently 50 registrations per 3h per IP, see
87 # https://letsencrypt.org/docs/staging-environment/
88 echo "Generating account key $ACCOUNT_KEY..." >&2
89 openssl genpkey -algorithm RSA -out "$ACCOUNT_KEY"
90 fi
91
92 ARCH="$(dpkg-architecture -qDEB_BUILD_ARCH)"
93 CHROOT=""
94
95 cleanup() {
96 if [ -n "$CHROOT" ]; then
97 schroot -c "$CHROOT" -e
98 fi
99 }
100 trap cleanup EXIT INT TERM
101
102 run() {
103 local t="tests/$1" rootdir version sub
104 if [ ! -f "$t" ]; then
105 echo "Error: '$1': no such test" >&2
106 exit 1
107 fi
108
109 # Don't need to rebuild for each test, but editing the code at the
110 # same time might cause `make install` to rebuild a wrong version
111 make all -- \
112 BUILDDIR="$BUILDDIR" \
113 DESTDIR="" \
114 exec_prefix="/usr" \
115 datadir="/usr/share" \
116 runstatedir="/run" \
117 lacme_www_user=_lacme-www \
118 lacme_www_group=nogroup \
119 lacme_client_user=_lacme-client \
120 lacme_client_group=nogroup \
121 acmeapi_server="$ACMEAPI_SERVER"
122
123 CHROOT="$(schroot -c "$DISTRIBUTION-$ARCH-sbuild" -b)"
124 rootdir="/run/schroot/mount/$CHROOT"
125
126 if [ "$MODE" = "deb" ]; then
127 version="$(dpkg-parsechangelog -S Version)"
128 echo "Installing lacme $version into $CHROOT..." >&2
129 install -vt "$rootdir/dev/shm" -m0644 -- \
130 "$PKG_DESTDIR/lacme_${version}_all.deb" \
131 "$PKG_DESTDIR/lacme-accountd_${version}_all.deb"
132 sudo schroot -d"/" -c "$CHROOT" -r -- \
133 env DEBIAN_FRONTEND="noninteractive" apt install -y \
134 "/dev/shm/lacme_${version}_all.deb" \
135 "/dev/shm/lacme-accountd_${version}_all.deb"
136
137 elif [ "$MODE" = "dev" ]; then
138 echo "Installing lacme dev into $CHROOT..." >&2
139 sudo make install -- \
140 BUILDDIR="$BUILDDIR" \
141 DESTDIR="$rootdir" \
142 exec_prefix="$rootdir/usr" \
143 datadir="$rootdir/usr/share" \
144 runstatedir="$rootdir/run"
145 sudo schroot -d"/" -c "$CHROOT" -r -- \
146 env DEBIAN_FRONTEND="noninteractive" apt install -y \
147 adduser \
148 libconfig-tiny-perl \
149 libcrypt-openssl-rsa-perl \
150 libjson-perl \
151 libnet-ssleay-perl \
152 libtimedate-perl \
153 libwww-perl \
154 openssl
155 sudo schroot -d"/" -c "$CHROOT" -r -- \
156 adduser --force-badname --system \
157 --home /nonexistent --no-create-home \
158 --gecos "lacme www user" \
159 --quiet _lacme-www
160 sudo schroot -d"/" -c "$CHROOT" -r -- \
161 adduser --force-badname --system \
162 --home /nonexistent --no-create-home \
163 --gecos "lacme client user" \
164 --quiet _lacme-client
165 fi
166
167 # set up staging environment, see https://letsencrypt.org/docs/staging-environment/
168 sudo install -oroot -groot -m0644 -vt "$rootdir/usr/share/lacme" certs-staging/*.pem
169 sudo install -oroot -groot -m0644 -vT "$BUILDDIR/certs-staging/ca-certificates.crt" \
170 "$rootdir/usr/share/lacme/ca-certificates.crt"
171 sudo schroot -d"/" -c "$CHROOT" -r -- \
172 sed -ri "0,/^#?server\\s*=.*/ {s||server = $ACMEAPI_SERVER|}" /etc/lacme/lacme.conf
173
174 # install account key and configure lacme accordingly
175 sudo install -oroot -groot -m0600 -vT -- "$BUILDDIR/account.key" \
176 "$rootdir/etc/lacme/account.key"
177 sudo schroot -d"/" -c "$CHROOT" -r -- \
178 sed -ri '0,\|^#?privkey\s*=.*| {s||privkey = file:/etc/lacme/account.key|}' \
179 /etc/lacme/lacme-accountd.conf
180
181 # use lacme's internal webserver bound to INADDR_ANY port 80
182 sudo schroot -d"/" -c "$CHROOT" -r -- \
183 sed -ri 's|^#?listen\s*=.*|listen = 0.0.0.0|' /etc/lacme/lacme.conf
184
185 # use a sample lacme-certs.conf, with a random subdomain so we can
186 # verify that challenges are answered correctly
187 sub="$(head -c10 /dev/urandom | base32 -w0)"
188 sudo tee "$rootdir/etc/lacme/lacme-certs.conf.d/simpletest-rsa.conf" >/dev/null <<- EOF
189 [simpletest-rsa]
190 certificate-key = /etc/lacme/simpletest.rsa.key
191 certificate-chain = /etc/lacme/simpletest.rsa.crt
192 subject = /CN=${sub,,[A-Z]}.$DOMAINNAME
193 EOF
194 sudo schroot -d"/" -c "$CHROOT" -r -- \
195 openssl genpkey -algorithm RSA -out /etc/lacme/simpletest.rsa.key
196
197 # copy test wrapper and unit file
198 local testdir="/dev/shm/lacme.test"
199 sudo install -oroot -groot -m0700 -d -- "$rootdir$testdir"
200 sudo install -oroot -groot -m0755 -T -- /dev/stdin "$rootdir$testdir/run" <<-EOF
201 STDERR="$testdir/stderr"
202 touch "\$STDERR"
203 fail() {
204 set +x
205 local rv=\$? i
206 if [ \$rv -eq 0 ]; then rv=1; fi
207 if [ -s "\$STDERR" ]; then
208 echo "vvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvv"
209 cat <"\$STDERR" >&2
210 echo "^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^"
211 fi
212 [ \$# -eq 0 ] || echo "Error: \$*" >&2
213 exit \$rv
214 }
215 grepstderr() {
216 grep "\$@" <"\$STDERR" || fail
217 }
218 ngrepstderr() {
219 ! grep "\$@" <"\$STDERR" || fail
220 }
221 set -x
222 EOF
223 sudo tee -a "$rootdir$testdir/run" >/dev/null <"$t"
224
225 sudo schroot -d"/" -c "$CHROOT" -r -- env -i \
226 USER="root" \
227 HOME="/root" \
228 SHELL="/bin/sh" \
229 LOGNAME="root" \
230 TERM="$TERM" \
231 PATH="/usr/sbin:/usr/bin:/sbin:/bin" \
232 DOMAINNAME="$DOMAINNAME" \
233 sh -ue "$testdir/run" || return $?
234 }
235
236 RV=0
237 declare -a PASSED=() FAILED=()
238 for t in "${TESTS[@]}"; do
239 run "$t" && rv=0 || rv=$?
240 if [ -n "$CHROOT" ]; then
241 # clean up
242 schroot -c "$CHROOT" -e
243 CHROOT=""
244 fi
245 if [ $rv -eq 0 ]; then
246 PASSED+=( "$t" )
247 else
248 FAILED+=( "$t" )
249 RV=$rv
250 break # stop at the first failure
251 fi
252 done
253
254 echo >&2
255 echo "================================================================================" >&2
256
257 echo "PASSED: ${PASSED[*]:-"(none)"}" >&2
258 if [ ${#FAILED[@]} -gt 0 ]; then
259 echo "FAILED: ${FAILED[*]}" >&2
260 fi
261 exit $RV