source: mod_gnutls/test/Makefile.am @ a1ce49d

proxy-ticket
Last change on this file since a1ce49d was a1ce49d, checked in by Fiona Klute <fiona.klute@…>, 5 months ago

Include test suite documentation in release tarballs

Git is the primary source for development, but people who download
version tarballs should still get the full documentation.

  • Property mode set to 100644
File size: 11.8 KB
Line 
1SUBDIRS = tests
2
3test_scripts = test-00_basic.bash \
4        test-01_serverwide_priorities.bash \
5        test-02_cache_in_vhost.bash \
6        test-03_cachetimeout_in_vhost.bash \
7        test-04_basic_nosni.bash \
8        test-05_mismatched-priorities.bash \
9        test-06_verify_sni_a.bash \
10        test-07_verify_sni_b.bash \
11        test-08_verify_no_sni_fallback_to_first_vhost.bash \
12        test-09_verify_no_sni_fails_with_wrong_order.bash \
13        test-10_basic_client_verification.bash \
14        test-11_basic_client_verification_fail.bash \
15        test-12_cgi_variables.bash \
16        test-13_cgi_variables_no_client_cert.bash \
17        test-14_resume_session.bash
18if USE_MSVA
19test_scripts += test-15_basic_msva.bash
20endif
21test_scripts += test-16_view-status.bash \
22        test-17_cgi_vars_large_cert.bash \
23        test-18_client_verification_wrong_cert.bash \
24        test-19_TLS_reverse_proxy.bash \
25        test-20_TLS_reverse_proxy_client_auth.bash \
26        test-21_TLS_reverse_proxy_wrong_cert.bash \
27        test-22_TLS_reverse_proxy_crl_revoke.bash \
28        test-23_TLS_reverse_proxy_mismatched_priorities.bash \
29        test-24_pkcs11_cert.bash \
30        test-25_Disable_TLS_1.0.bash \
31        test-26_redirect_HTTP_to_HTTPS.bash \
32        test-27_OCSP_server.bash \
33        test-28_HTTP2_support.bash \
34        test-29_force_handshake_vhost.bash \
35        test-30_ip_based_vhosts.bash \
36        test-31_vhost_SNI_serveralias_match.bash \
37        test-32_vhost_SNI_serveralias_mismatch.bash \
38        test-33_vhost_SNI_serveralias_missinghost.bash \
39        test-34_TLS_reverse_proxy_h2.bash
40
41TEST_EXTENSIONS = .bash
42TESTS = $(test_scripts)
43
44dist_check_SCRIPTS = netns_py.bash $(test_scripts)
45
46check_PROGRAMS = pgpcrc
47pgpcrc_SOURCES = pgpcrc.c
48
49# build OCSP database tool
50if ENABLE_OCSP_TEST
51check_PROGRAMS += gen_ocsp_index
52gen_ocsp_index_SOURCES = gen_ocsp_index.c cert_helper.c
53gen_ocsp_index_CFLAGS = $(LIBGNUTLS_CFLAGS)
54gen_ocsp_index_LDFLAGS = $(LIBGNUTLS_LIBS)
55noinst_HEADERS = cert_helper.h
56endif
57
58# Python tools for tests
59noinst_PYTHON = https-test-client.py mgstest/http.py mgstest/__init__.py \
60        mgstest/hooks.py mgstest/services.py mgstest/tests.py runtest.py
61
62# Identities in the miniature CA, server, and client environment for
63# the test suite
64shared_identities = authority authority/client
65pgp_identities = $(shared_identities)
66x509_only_identities = authority/server authority/imposter \
67        authority/subca authority/subca/server \
68        rogueca rogueca/rogueclient
69if ENABLE_OCSP_TEST
70x509_only_identities += authority/ocsp-responder authority/subca/ocsp-responder
71endif
72x509_identities = $(shared_identities) $(x509_only_identities)
73identities = $(shared_identities) $(x509_only_identities)
74# Append strings after ":=" to each identity to generate a list of
75# necessary files
76pgp_tokens = $(pgp_identities:=/cert.pgp) \
77        $(pgp_identities:=/secret.pgp)
78x509_keys = $(x509_identities:=/secret.key)
79x509_certs = $(x509_identities:=/x509.pem)
80x509_tokens = $(x509_certs) $(x509_keys)
81tokens = $(x509_tokens)
82if USE_MSVA
83tokens += $(pgp_tokens)
84endif
85
86if !DISABLE_FLOCK
87# flock command for write access to the authority keyring
88GPG_FLOCK = @FLOCK@ authority/lock
89endif
90
91include $(srcdir)/test_ca.mk
92
93# Test cases trying to create keys and certificates in parallel causes
94# race conditions. Ensure that all keys and certificates are generated
95# before tests get to run.
96#
97# NOTE: Once the support files have been generated, test cases can be
98# run with multiple jobs, but real parallelization would require
99# dynamic port assignments. At the moment, lock files ensure that only
100# one Apache instance (possibly plus a proxy back end instance) is
101# running at any time, so test cases actually have to wait for each
102# other - just not in any particular order.
103check_DATA = $(tokens) authority/server/crl.pem
104
105MOSTLYCLEANFILES = cache/* logs/* outputs/* authority/server/crl.pem
106
107cert_templates = authority/template.in authority/client/template.in \
108        authority/imposter/template.in authority/ocsp-responder/template \
109        authority/server/template.in \
110        authority/subca/template.in authority/subca/server/template.in \
111        authority/subca/ocsp-responder/template \
112        rogueca/template rogueca/rogueclient/template.in
113generated_templates = authority/template authority/client/template \
114        authority/imposter/template rogueca/rogueclient/template \
115        authority/server/template
116
117# Delete X.509 private keys on full clean. Note that unless you need
118# to generate fresh keys, the "mostlyclean" target should be
119# sufficient (see below).
120CLEANFILES = $(x509_keys)
121
122# Delete X.509 certificates and generated templates on "mostlyclean"
123# target. Certificates can be rebuilt without generating new key
124# pairs, and regenerating them makes it possible to change identities
125# (e.g. host names) without wasting time on new keys (which would
126# happen after "clean").
127MOSTLYCLEANFILES += $(x509_certs) $(generated_templates) $(identities:=/uid)
128
129
130# Delete PGP keyrings on "mostlyclean" target. They are created from
131# the X.509 private keys and certificates with an expiration time of
132# one day, so regenerating them is both fast and frequently
133# necessary.
134pgp_patterns = /*.pgp /*.pgp.raw /*.gpg /*.gpg~ /gpg.conf \
135        /*.kbx /*.kbx~ /S.gpg-agent /private-keys-v1.d/*
136MOSTLYCLEANFILES += $(foreach pat,$(pgp_patterns),$(pgp_identities:=$(pat))) \
137        authority/lock authority/tofu.db
138# GnuPG random pool, no need to regenerate on every build
139CLEANFILES += authority/random_seed
140
141# GnuPG 2 starts gpg-agent processes per GNUPGHOME (one for every PGP
142# identity) while creating the PGP certificates. This target is called
143# by both "check-local" and "mostlyclean-local": The former because
144# agent processes are started while preparing for "check" and are no
145# longer needed afterwards, the latter to make sure they are gone
146# along with their certificates.
147stop-gnupg-agent:
148        for id in $(pgp_identities) $(msva_home); do \
149                GNUPGHOME=$$id/ gpgconf --kill gpg-agent || true; \
150        done
151
152check-local: stop-gnupg-agent
153
154# Delete lock files for test servers on "mostlyclean" target.
155MOSTLYCLEANFILES += *.lock
156
157# rule to build MSVA trust database
158if USE_MSVA
159msva_home = msva.gnupghome
160check_DATA += $(msva_home)/trustdb.gpg authority/client/uid
161MOSTLYCLEANFILES += $(foreach pat,$(pgp_patterns),$(msva_home)$(pat))
162$(msva_home)/trustdb.gpg: authority/minimal.pgp authority/client/cert.pgp
163        mkdir -p -m 0700 $(dir $@)
164        GNUPGHOME=$(dir $@) gpg --import < $<
165        printf "%s:6:\n" "$$(GNUPGHOME=authority/ gpg --with-colons --list-secret-keys --fingerprint | grep ^fpr: | cut -f 10 -d :)" | GNUPGHOME=$(dir $@) gpg --import-ownertrust
166        GNUPGHOME=$(dir $@) gpg --import < authority/client/cert.pgp
167        printf "keyserver does-not-exist.example\n" > $(msva_home)/gpg.conf
168endif
169
170if ENABLE_OCSP_TEST
171# rules to build OCSP database
172ocsp_index_data = authority/ocsp_index.txt authority/ocsp_index.txt.attr \
173        authority/subca/ocsp_index.txt authority/subca/ocsp_index.txt.attr
174check_DATA += $(ocsp_index_data)
175MOSTLYCLEANFILES += $(ocsp_index_data)
176
177# The "find" command builds a list of all certificates directly below
178# the CA that aren't for the ocsp-responder.
179%/ocsp_index.txt: $(x509_tokens) gen_ocsp_index
180        ./gen_ocsp_index $$(find $(*) -mindepth 2 -maxdepth 2 ! -path '*/ocsp-responder/*' -name x509.pem) > $@
181
182%/ocsp_index.txt.attr:
183        @mkdir -m 0700 -p $(dir $@)
184        echo "unique_subject = no" > $@
185
186# Build certificate chain files. Note that intermediate tokens must be
187# listed explicitly, or the dependency chain will be broken because
188# the higher level pattern matches, too.
189chain_tokens = authority/server/x509-chain.pem \
190        authority/subca/x509-chain.pem \
191        authority/subca/server/x509-chain.pem
192check_DATA += $(chain_tokens)
193MOSTLYCLEANFILES += $(chain_tokens) authority/x509-chain.pem
194endif
195
196# SoftHSM tokens. Note that the SoftHSM 2 token is a directory and
197# hence has to be treated slightly differently.
198SOFTHSM_TOKEN = authority/server/softhsm.db
199SOFTHSM2_TOKEN = authority/server/softhsm2.db
200
201# Tokens should be cleaned whether or not the matching SoftHSM version
202# was detected on the last ./configure run.
203MOSTLYCLEANFILES += $(SOFTHSM_TOKEN)
204# included in mostlyclean-local below
205clean-softhsm2-db:
206        -rm -rf $(SOFTHSM2_TOKEN)
207
208if HAVE_SOFTHSM1
209check_DATA += $(SOFTHSM_TOKEN)
210endif HAVE_SOFTHSM1
211
212if HAVE_SOFTHSM2
213check_DATA += $(SOFTHSM2_TOKEN)
214endif HAVE_SOFTHSM2
215
216check_DATA += make-test-dirs
217extra_dirs = logs cache outputs
218make-test-dirs:
219        mkdir -p $(extra_dirs)
220
221.PHONY: make-test-dirs clean-softhsm2-db stop-gnupg-agent
222
223
224mostlyclean-local: clean-softhsm2-db stop-gnupg-agent
225        -rmdir $(pgp_identities:=/private-keys-v1.d) || true
226if USE_MSVA
227        -rmdir $(msva_home)/private-keys-v1.d || true
228endif
229
230# Delete test data directories, and wait for test services to
231# exit. The reason for the wait is that Apache instances may take some
232# time to exit and delete their PID files. Occasionally some PID files
233# where still around during "distcheck" runs by the time the target
234# checked if the build directory was really empty after "distclean",
235# breaking the build. Delaying "clean-local" until PID files are gone
236# avoids this issue, and the timeout will expose actually unclean
237# stops.
238clean-local:
239        -rmdir $(extra_dirs) || true
240if USE_MSVA
241        -rmdir $(msva_home) || true
242endif
243        wait=0; \
244        while ls *.pid && test "$$wait" -lt "@TEST_LOCK_WAIT@"; do \
245                wait=$$(($$wait + 1)); \
246                echo "waiting for test services to exit ($$wait seconds)"; \
247                sleep 1; \
248        done
249
250# Apache configuration and data files
251apache_data = base_apache.conf cgi_module.conf data/dump.cgi data/ocsp.cgi \
252        data/test.txt mime.types proxy_mods.conf
253
254# Documentation for the test system
255test_doc = README.md sample_fail.yml sample_test.yml
256
257EXTRA_DIST = $(apache_data) $(cert_templates) $(shared_identities:=/uid.in) \
258        common.bash authority/server/crl.template softhsm.bash $(test_doc)
259
260# Lockfile for the main Apache process
261test_lockfile = ./test.lock
262# Lockfile for the proxy backend Apache process (if any)
263backend_lockfile = ./backend.lock
264# Lockfile for the OCSP server Apache process (if any)
265ocsp_lockfile = ./ocsp.lock
266
267# port for the main Apache server
268TEST_PORT ?= 9932
269# port for MSVA in test cases that use it
270MSVA_PORT ?= 9933
271# port for TLS proxy backend server
272BACKEND_PORT ?= 9934
273# port for the OCSP responder
274if ENABLE_OCSP_TEST
275OCSP_PORT ?= 9936
276OCSP_URI_TEMPLATE = ocsp_uri = http://$(TEST_HOST):$(OCSP_PORT)/ocsp/
277endif
278# maximum time to wait for MSVA startup (milliseconds)
279TEST_SERVICE_MAX_WAIT ?= 10000
280# wait loop time for MSVA startup (milliseconds)
281TEST_SERVICE_WAIT ?= 400
282
283AM_TESTS_ENVIRONMENT = export APACHE2=@APACHE2@; \
284        export AP_LIBEXECDIR=@AP_LIBEXECDIR@; \
285        export PYTHON="@PYTHON@"; \
286        export TEST_LOCK_WAIT="@TEST_LOCK_WAIT@"; \
287        export TEST_IP="@TEST_IP@"; \
288        export TEST_HOST="@TEST_HOST@"; \
289        export TEST_PORT="$(TEST_PORT)"; \
290        export MSVA_PORT="$(MSVA_PORT)"; \
291        export TEST_SERVICE_MAX_WAIT="$(TEST_SERVICE_MAX_WAIT)"; \
292        export TEST_SERVICE_WAIT="$(TEST_SERVICE_WAIT)"; \
293        export TEST_QUERY_TIMEOUT="@TEST_QUERY_TIMEOUT@"; \
294        export BACKEND_HOST="@TEST_HOST@"; \
295        export BACKEND_PORT="$(BACKEND_PORT)"; \
296        export HTTP_CLI="@HTTP_CLI@";
297
298if HAVE_SOFTHSM
299AM_TESTS_ENVIRONMENT += export SOFTHSM="@SOFTHSM@"; \
300        export SOFTHSM_MAJOR_VERSION="@SOFTHSM_MAJOR_VERSION@"; \
301        export SOFTHSM_LIB="@SOFTHSM_LIB@";
302endif
303
304if ENABLE_OCSP_TEST
305AM_TESTS_ENVIRONMENT += export OPENSSL="@OPENSSL@"; \
306        export OCSP_PORT="$(OCSP_PORT)";
307endif
308
309if ENABLE_NETNS
310AM_TESTS_ENVIRONMENT += export UNSHARE="@UNSHARE@"; \
311        export USE_TEST_NAMESPACE=1;
312endif
313# Without flock tests must not run in parallel, and PID files are used
314# to prevent conflicts between server instances. Otherwise set lock
315# files for flock.
316if DISABLE_FLOCK
317AM_TESTS_ENVIRONMENT += export TEST_LOCK="apache2.pid"; \
318        export BACKEND_LOCK="backend.pid"; \
319        export OCSP_LOCK="ocsp.pid";
320.NOTPARALLEL:
321else
322AM_TESTS_ENVIRONMENT += export FLOCK="@FLOCK@"; \
323        export TEST_LOCK="$(test_lockfile)"; \
324        export BACKEND_LOCK="$(backend_lockfile)"; \
325        export OCSP_LOCK="$(ocsp_lockfile)";
326endif
327
328# Echo AM_TESTS_ENVIRONMENT. This can be useful for debugging, e.g. if
329# you want to manually run an Apache instance with Valgrind using the
330# same configuration as a test case.
331show-test-env: export TEST_ENV=$(AM_TESTS_ENVIRONMENT)
332show-test-env:
333        @echo "$${TEST_ENV}"
Note: See TracBrowser for help on using the repository browser.