This Apache HTTP Server demo module will compare the argument values passed with the request-URI with a list of blacklisted terms configured in httpd.conf. If a case-sensitive substring-match is found, the request will be redirected to an error page. Only field values, but not field names, are considered.
To configure the blacklist, use the Blacklist entry with a comma-separated list of terms in the httpd.conf config file, e.g.
Blacklist foo,bar,baz
Use the following, or similar, URIs to test the module.
| Example URI | Effect |
|---|---|
| https://localhost:4242/index.html | Shows index.html |
| https://localhost:4242/anyfile.html?name=philipp&hello=world | mod_tscdemo shows a list of blacklist terms and parsed arguments |
| https://localhost:4242/anyfile.html?name=philipp&hello=barbapapa&field=value | mod_tscdemo redirects to the error page |
- Use of Docker for Apache HTTP Server module development
- Building Apache HTTP Server modules using C++
- Minimal but meaningful module functionality
- Static code analysis using cppcheck, including checking of
ap_rprintfstring formatting - Unit-testing the module using Catch (https://catch-lib.net)
- Integration-testing the module using Catch and libcurl
- Continuous integration using Travis CI
Build a Docker image using an Apache image as a base and adding development tools in a second layer.
docker build -t http_dev docker
To create and run a container from the Docker image built above.
docker run -dit --name apachedev -v PATH_TO_HTDOCS:/usr/local/apache2/htdocs -v PATH_TO_THIS_MOD_DIR:/root/mod_tscdemo -w /root/mod_tscdem -p 4242:80 httpd_dev
PATH_TO_HTDOCS is the path to the htdocs directory of this repository. PATH_TO_THIS_MOD_DIR is the path to the root of this repository.
Once the container is running, open a bash on the container.
docker exec -it apachedev bash
Uncomment the Blacklist entry in the httpd.conf file.
sed -i '/^#Blacklist.*/s/^#//' /usr/local/apache2/conf/httpd.conf
Build and install the module, and restart Apache to load the module.
./build.sh
apachectl restart
build.sh first runs static code analysis and if that succeeds, builds, installs and activates the module.
Build and run the unit and integration tests.
./run_tests.sh
Note that the integration tests will only succeed if httpd.conf contains a Blacklist entry with at least bar as one of the blacklist terms.
- How to use g++ and apxs to build C++ modules: https://stackoverflow.com/questions/42605138/how-can-i-write-an-apache-module-in-c
- Apache HTTP Server 2.4 module developer guide: https://httpd.apache.org/docs/2.4/developer/modguide.html
- Apache2 API reference: https://ci.apache.org/projects/httpd/trunk/doxygen/
- Docker reference: https://docs.docker.com/engine/reference/commandline/docker/