olivier/PyFRC2G
1
1
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Actualiser README.md

Browse Source
This commit is contained in:
Olivier
2025-11-22 14:04:45 +01:00
parent f50898e255
commit f50e7ef09a
1 changed files with 6 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
README.md
View File

@@ -1,6 +1,6 @@
# PyFRC2G # PyFRC2G
Script python de conversion de règles firewall **PfSense** en graphique. Scripts python de conversion de règles firewall **PfSense** et **OPNSense** en vision graphique des flux.
![rules](./img/convert-rules-to-graph.png) ![rules](./img/convert-rules-to-graph.png)
@@ -14,8 +14,9 @@ Le script a été codé pour répondre à deux objectifs :
* Script basé sur **Python** (développé et testé sur GNU/Linux). * Script basé sur **Python** (développé et testé sur GNU/Linux).
* Utilisation de l'API de pfSense fournie par [pfSense REST API Package](https://pfrest.org/). * Utilisation de l'API de pfSense fournie par [pfSense REST API Package](https://pfrest.org/).
* Utilisation de l'API intégrée d'OPNSense.
* Génération des flux graphiques avec la bibliothèque python **Graphviz**. * Génération des flux graphiques avec la bibliothèque python **Graphviz**.
* Génération d'un fichier PNG par interface. * Génération d'un fichier PDF A4 avec une page par interface.
* Distinction entre un VLAN/réseau de destination et un hôte de destination. * Distinction entre un VLAN/réseau de destination et un hôte de destination.
* Mapping des interfaces, des ports et des destnations. * Mapping des interfaces, des ports et des destnations.
* Coloration pour les actions PASS et BLOCK. * Coloration pour les actions PASS et BLOCK.
@@ -28,14 +29,14 @@ Le script a été codé pour répondre à deux objectifs :
Installation des bibliothèques Python : Installation des bibliothèques Python :
```Bash ```Bash
pip install requests graphviz pip install requests graphviz reportlab
``` ```
2. pfSense
Installation de **pfSense REST API Package** : [https://github.com/jaredhendrickson13/pfsense-api?tab=readme-ov-file#quickstart](https://github.com/jaredhendrickson13/pfsense-api?tab=readme-ov-file#quickstart) Installation de **pfSense REST API Package** : [https://github.com/jaredhendrickson13/pfsense-api?tab=readme-ov-file#quickstart](https://github.com/jaredhendrickson13/pfsense-api?tab=readme-ov-file#quickstart)
Une fois le paquet **pfSense REST API** installé, configurez la ou les interface(s) d'écoute sur **pfSense** puis générez une clé qui nous servira pour l'authentification à l'API. Une fois le paquet **pfSense REST API** installé, configurez la ou les interface(s) d'écoute sur **pfSense** puis générez une clé qui nous servira pour l'authentification à l'API.
2. Configuration du script 3. Configuration du script
Récupérez les fichiers **pyfrc2g.py** et **config.py**. Récupérez les fichiers **pyfrc2g.py** et **config.py**.