Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/TKCERT/pfFocus
Generate meaningful output from your pfSense configuration backup, like Markdown documentation.
https://github.com/TKCERT/pfFocus
configuration-backup documentation documentation-generator firewalls pfsense pfsense-backup python
Last synced: 4 months ago
JSON representation
Generate meaningful output from your pfSense configuration backup, like Markdown documentation.
- Host: GitHub
- URL: https://github.com/TKCERT/pfFocus
- Owner: TKCERT
- License: gpl-3.0
- Created: 2017-08-10T10:06:20.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2023-09-13T15:40:34.000Z (over 1 year ago)
- Last Synced: 2024-08-02T17:37:27.015Z (7 months ago)
- Topics: configuration-backup, documentation, documentation-generator, firewalls, pfsense, pfsense-backup, python
- Language: Python
- Homepage:
- Size: 342 KB
- Stars: 291
- Watchers: 18
- Forks: 32
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# pfFocus
[](https://github.com/TKCERT/pfFocus/actions/workflows/check.yml)
[](https://github.com/TKCERT/pfFocus/actions/workflows/docker.yml)
This simple tool allows you to convert a full configuration backup of a *pf*Sense firewall into some meaningful output format, like Markdown or YAML. It enables you to **focus** on the important parts of your firewall configuration and allows you to get a quick overview of the most important settings.
## Requirements
* Python 3.6+
* defusedxml==0.5.0
* PyYAML==5.4
## Screenshots
**Before:** Configuration backup as XML
**After:** Markdown documentation
## Features
pfFocus currently supports the following configuration sections:
* Basic system information
* List of interfaces, VLANs, bridges, gateways and static mappings
* List of DHCP ranges and aliases
* NAT rules with alias and interface resolution
* Outbound NAT rules with alias and interface resolution
* Filter rules with alias and interface resolution
* DNS forwarder (DNSmasq) configuration
* OpenVPN server and client configurations
* Syslog and sysctl configuration
## Installation
Install into existing Python environment:
```bash
pip install git+https://github.com/TKCERT/pfFocus.git#egg=pfFocus
```
Combine this with `--user` or `pipx` or `pipenv` for isolated installation.
## Usage
Main formatting tool: ```pf-format```
```bash
pf-format
```
Examples:
```bash
pf-format -i config-backup.xml -f md -o test.md
pf-format -i config-backup.xml -f yaml -o test.yaml
```
Test parsing tool: ```pf-parse```
```bash
pf-parse [-h] input_path
```
Examples:
```bash
pf-parse config-backup.xml
```
### Usage via Docker
When using pfFocus via Docker, you don't need to download it from Github, and you don't need to install Python or any libraries. Only Docker is required.
It runs this command inside Docker: `pfFocus-format -q -f md -i - -o -`, which means it works with `STDIN` and `STDOUT` instead of files.
```bash
docker run --rm -i ghcr.io/tkcert/pffocus < input.xml > output.md
```
If you want you can set up an alias for it in bash:
```bash
alias pf-format="docker run --rm -i ghcr.io/tkcert/pffocus"
```
Then you can use it like a normal Unix command, with pipes and redirects:
```bash
pf-format < input.xml > output.md
```
## Roadmap
Some ideas for the future development of pfFocus:
* Producing additional output formats, especially structured formats like CSV.
* Using these structured formats to enable easy diff'ing of configurations.
* Maybe functionality to correlate rule configurations of different firewalls.
## Credits
* Thomas Patzke ([@thomaspatzke](https://github.com/thomaspatzke)) for
* valuable suggestions and feedback
* Florian Roth ([@Cyb3rOps](https://twitter.com/Cyb3rOps)) for
* giving it the name *pfFocus*
* the very nice and gorgeous logo