Skip to content

Latest commit

 

History

History
62 lines (38 loc) · 3.53 KB

README.md

File metadata and controls

62 lines (38 loc) · 3.53 KB
Raw

8g-firewall-caddyserver

This repo started as an attempt to port the great 7G Firewall from Jeff Star to Caddy. Recently the 8G-Firewall was released, so some files here are updated.

Prerequisite

Request inspection is done with the help of the map directive of Caddy. For the map directive to work as expected in the snippets you need a Caddy release of 2.4.6 or newer, see Download-Page, the last test I did with Caddy v.2.7.6.

Note that Caddy release 2.5.1 introduced a breaking change:

Caddyfile: The map directive now casts outputs to the appropriate scalar type
if possible (int, float, bool). If you need to force a string, you may use
double quotes or backticks

The current changes in the files in the examples/ directory make the setup work with release 2.5.1.

How to use

Take a look at the example Caddyfile. It imports a snippet examples/8g-caddy.snippet that holds all the patterns and examples/8g-enforce.snippet that aborts matched connections with a 403 or 405 status code.

Feel free to create a response more pleasing to the eye but avoid redirecting or rewriting to a script that dynamically creates content and therefore further load on the server.

Working with the latest 8G-Firewall.txt rules

If you want to work with the latest 8G-Firewall.txt file from the original author:

The PHP script transform-8g.php does the work of reading the original rules and rewriting them to a Caddy config file syntax. This is just a helper script to speed things up. It certainly will have to be updated if the original file content changes in newer versions.

transform-8g.php expects the 8G-Firewall.conf (tested is version 1.3) and simply applies some regular expressions and string replacements. The result is a Caddy snippet that can be imported where needed. See the example Caddyfile and the examples/8g-caddy.snippet.

  1. Go to the 8G Firewall page and download und unzip the ZIP file.
  2. Run the php transform-8g.php script after copying the 8G-Firewall.txt file of the ZIP archive into the same directory, redirect output to a file (see below)
# copy 8G-Firewall.txt into same directory as the PHP script
php transform-8g.php > examples/8g-caddy.snippet

Todo and bugs

  • find an equivalent for two patterns that either not compile or differ in regex flavor/nuances (see comments in transform.php)
  • write tests for every section to make sure the patterns match what they are supposed to match (AFAIK there is currently no test suite for the rules. Update: A tiny start can be found in the tests directory.)
  • The remote_host map is of no use until a variable is used (from an external module?) that does a reverse lookup of the requesting IP address, as strings are matched by the firewall
  • provide a HTTP status code 403 snippet that matches (is triggered by) the mapped variables

Variables:

  • Use the equivalent of the respective mod_rewrite variable to the Caddy server variable (see Semantics.md).
  • Verify the equivalent is in the same processed state of request normalization so that every pattern matches the intended payload

License

For 7G, see https://perishablepress.com/7g-firewall/#license For 8G, see https://perishablepress.com/8g-firewall/#license-disclaimer

Disclaimer

See https://perishablepress.com/7g-firewall/#disclaimer For 8G, see https://perishablepress.com/8g-firewall/#license-disclaimer