isabella232 / nginx-modsecurity-ubuntu

Ubuntu package for modsecurity-nginx

Ubuntu package for ModSecurity-Nginx

This project contains the packaging specifications of the ModSecurity Nginx module for Ubuntu 18.04. It packages ModSecurity-Nginx as a dynamic module.

Table of contents:

• Installation through PPA
• Building the package
  • On Ubuntu 18.04
  • On other Linux distros, other Ubuntu versions or other OSes
• Development
  • Anatomy
  • Workflow
  • Shortening the development cycle
  • Upgrading modsecurity-nginx, libmodsecurity and Nginx
• Maintenance and troubleshooting
  • When Ubuntu upgrades Nginx
  • Releasing a package update

Installation through PPA

A prebuilt package is available through the phusion.nl/misc PPA.

sudo add-apt-repository ppa:phusion.nl/misc
sudo apt update
sudo apt install libnginx-mod-http-modsecurity

Building the package

You can build a package either on Ubuntu 18.04, or on any system that supports Docker Linux containers.

On Ubuntu 18.04

1. Install Debian package building tools: apt install devscripts eatmydata wget git
2. Run: make

If building succeeds then this will output a file libnginx-mod-http-modsecurity_xxxx.deb.

If building fails then that is likely because you need to have some libraries installed. Look at the error message, install libraries as appropriate, then try again.

On other Linux distros, other Ubuntu versions or other OSes

1. Enter our Ubuntu 18.04 build environment Docker container: ./enter-docker.sh
2. Inside the container, run: make

This will output a file libnginx-mod-http-modsecurity_xxxx.deb.

Development

This section describes how you should approach making changes to the packaging specifications. Just like when building a package, you can do development either on Ubuntu 18.04, or on any system that supports Docker Linux containers.

Anatomy

• The spec/ directory contains the Debian packaging specifications (that is, the files that are usually found within the debian/ directory).
• The Makefile is used to download source files and build the package. It also specifies which version of libmodsecurity and Nginx to compile against.
• build-docker.sh, enter-docker.sh and docker-env/ are related to the Docker-based build environment.

Workflow

The development workflow involves the use of make. You do not have to use Debian packaging tools (like dpkg-buildpackage) directly. Here is how a typical workflow looks like:

1. Make changes in the Makefile or the spec/ directory.
2. Run make dev.
3. Check whether the resulting .deb file is satisfactory. Go back to step 1 if not.

make dev performs the following actions:

• It downloads the ModSecurity-nginx, libmodsecurity and Nginx sources and bundle them together into a single Debian-packaging-style orig tarball. This is only done once.
• It extracts the orig tarball into libnginx-mod-http-modsecurity-x.x.x and copies the spec/ directory into libnginx-mod-http-modsecurity-x.x.x/debian/.
• It runs dpkg-buildpackage on the libnginx-mod-http-modsecurity-x.x.x directory in order to build the .deb package.

Shortening the development cycle

dpkg-buildpackage can take quite a while, which is very annoying when you want to changes. There are two ways to make dpkg-buildpackage faster and thus shorten the development cycle:

1. By using ccache.
2. By invoking Make with DPKG_BUILDPACKAGE_ARGS=-nc: make dev DPKG_BUILDPACKAGE_ARGS=-nc

If you are using our Docker container, then ccache is already set up for you (though the ccache directory will be wiped when you exit the container).

With regard to DPKG_BUILDPACKAGE_ARGS=-nc: as you may know, by default dpkg-buildpackage cleans existing build products during the beginning of each invocation. If you did not make any changes to the compilation instructions then this means that all the source files are being recompiled on every dpkg-buildpackage invocation. Even though ccache makes recompilations faster, ideally you want to avoid recompiling at all. With -nc, you tell dpkg-buildpackage not to clean existing build products.

Upgrading modsecurity-nginx, libmodsecurity and Nginx

To upgrade the version of modsecurity-nginx, libmodsecurity or the version of Nginx that we compile against, edit the version numbers in the Makefile. Specifically, modify MODSECURITY_REF, LIBMODSECURITY_REF org NGINX_VERSION.

Be sure to follow the instructions in the comments. Modifying one variable often involves having to modify other variables/files as well.

Maintenance and troubleshooting

When Ubuntu upgrades Nginx

Nginx dynamic modules are only compatible against the exact same Nginx version number. From time to time, Ubuntu may upgrade their Nginx package, which breaks compatibility with our ModSecurity-nginx package. When this happens, then you need to:

1. Upgrade the Nginx version that we compile against (see "Upgrading modsecurity-nginx, libmodsecurity and Nginx").
2. Release a package update (see "Releasing a package update").

Releasing a package update

1. Open the Makefile and check whether you need to update PACKAGE_VERSION and PACKAGE_REVISION. See the comments for instructions.
2. Edit spec/changelog and ensure that there is a changelog entry that matches PACKAGE_VERSION and PACKAGE_REVISION. You must do this because the Debian packaging tools extract the version number from the changelog file. The changelog entry's version number must correspond to the value of $(PACKAGE_VERSION)-$(PACKAGE_REVISION) as specified in the Makefile.
3. Rebuild the package from scratch: make clean && make

You are then ready to upload the package to your preferred APT repository. The exact instructions depends on your repository. Here are instructions for uploading to the Phusion PPA on Launchpad:

1. If using Docker, import your GPG private key into the Docker container:

   a. On your host OS, export your GPG private key to a file, located inside the same directory as enter-docker.sh. b. Inside the container, run: gpg --import yourkeyfile.asc c. Inside the container, run: gpg --edit-key [email protected] d. Inside the GPG prompt, run: trust. Select "ultimate". Then run: quit.

2. Sign the source package: debsign *source.changes

3. Upload to the Phusion PPA using dput: dput ppa:phusion.nl/misc *source.changes

4. If using Docker, delete the private key file that you exported in step 1.