Skip to content

Commit

Permalink
doc: Update instructions and introduction to filtergen.
Browse files Browse the repository at this point in the history
  • Loading branch information
jaqx0r committed Apr 14, 2024
1 parent 25a5925 commit b0451aa
Showing 1 changed file with 22 additions and 8 deletions.
30 changes: 22 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,11 +10,17 @@ level description language. It doesn't support all of the whizz-bang
features of the latest and greatest packet filters, but supports a
decent subset which is sufficient for me.

It currently supports only Linux iptables and ipchains. Cisco IOS has
been begun, but is incomplete. Darren Reed's ipfilter may be supported
at some stage. It doesn't generate optimal rulesets, and has a few
limitations which need to be removed, but is still a useful tool.
## FILTER SUPPORT

`filtergen` currently supports generating filters for:

* Linux iptables, ipchains direct command execution
* Linux iptables-restore, ipchains-restore input files.
* Cisco IOS (experimental, incomplete)
* ipfliter (experimental, incomplete)

Filters can be generated from `filtergen`s internal language (see USAGE below)
or from existing `ipchains-save` or `iptables-save` output.

## WARNING!

Expand All @@ -24,10 +30,11 @@ ipchains or iptables drivers leak packets.

## LICENCE

It was written, and is copyrighted by me <matthew@hairy.beasts.org>,
It was written, and copyrighted by <matthew@hairy.beasts.org>
and made available you you under the terms of the GNU General Public
Licence.

The current maintainer is Jamie Wilkinson.

## WHY?

Expand Down Expand Up @@ -71,6 +78,16 @@ around the rules that they output. This can be disabled with "-n":
The rulesets generated with this option may not be complete, but the
flag is useful to allow one to see what sort of output is generated.

Futher details can be found in the [`filtergen.8`](filtergen.8),
[`filter_syntax.5`](filter_syntax.5), and
[`filter_backends.7`](filter_backends.7) manpages.

## FGADM

A helpful admin tool called `fgadm` is also included which manages compilation
and application of the generated filter.

Further details can be found in the [`fgadm.8`](fgadm.8) manpage.

## SYNTAX

Expand Down Expand Up @@ -181,6 +198,3 @@ sudo apt install expect
```

should be sufficient in order to run `bazel test //...`



0 comments on commit b0451aa

Please sign in to comment.