update cli proto-l4-argument, add basic example to readme

Author: superstes

README.md

@@ -15,6 +15,51 @@ You can find the documentation at: [ftf.oxl.app](https://ftf.oxl.app)
 
 ----
 
+## CLI Example
+
+For more see: [ftf.oxl.app - Usage - Run](https://ftf.oxl.app/usage/3_run.html)
+
+```bash
+ftf-cli --firewall-system 'linux_netfilter' \
+        --file-interfaces 'testdata/plugin_translate_linux_interfaces.json' \
+        --file-routes 'testdata/plugin_translate_linux_routes.json' \
+        --file-route-rules 'testdata/plugin_translate_linux_route-rules.json' \
+        --file-ruleset 'testdata/plugin_translate_netfilter_ruleset.json' \
+        --src-ip 10.0.0.1 \
+        --dst-ip 172.17.10.6
+
+> 🛈 ROUTER: Packet inbound-interface: wan
+> 🛈 ROUTER: Packet inbound-route: 0.0.0.0/0, gw 10.255.255.254, metric 600, scope remote
+> 🛈 FIREWALL: Processing Chain: Table nat ip4 | Chain PREROUTING ip4 nat
+> 🛈 FIREWALL: > Chain PREROUTING | Rule 0
+> 🛈 FIREWALL: > Chain PREROUTING | Sub-Chain: DOCKER
+> 🛈 FIREWALL: > Chain DOCKER | Rule 0
+> 🛈 FIREWALL: > Chain DOCKER | Rule 1
+> 🛈 ROUTER: Packet outbound-interface: docker0
+> 🛈 ROUTER: Packet outbound-route: 172.17.0.0/16, scope link
+> 🛈 FIREWALL: Processing Chain: Table filter ip4 | Chain FORWARD ip4 filter
+> 🛈 FIREWALL: > Chain FORWARD | Rule 0
+> 🛈 FIREWALL: > Chain FORWARD | Sub-Chain: DOCKER-USER
+> 🛈 FIREWALL: > Chain DOCKER-USER | Rule 0
+> 🛈 FIREWALL: > Chain FORWARD | Rule 1
+> 🛈 FIREWALL: > Chain FORWARD | Sub-Chain: DOCKER-FORWARD
+> 🛈 FIREWALL: > Chain DOCKER-FORWARD | Rule 0
+> 🛈 FIREWALL: > Chain DOCKER-FORWARD | Sub-Chain: DOCKER-CT
+> 🛈 FIREWALL: > Chain DOCKER-CT | Rule 0
+> 🛈 FIREWALL: > Chain DOCKER-FORWARD | Rule 1
+> 🛈 FIREWALL: > Chain DOCKER-FORWARD | Sub-Chain: DOCKER-ISOLATION-STAGE-1
+> 🛈 FIREWALL: > Chain DOCKER-ISOLATION-STAGE-1 | Rule 0
+> 🛈 FIREWALL: > Chain DOCKER-FORWARD | Rule 2
+> 🛈 FIREWALL: > Chain DOCKER-FORWARD | Sub-Chain: DOCKER-BRIDGE
+> 🛈 FIREWALL: > Chain DOCKER-BRIDGE | Rule 0
+> 🛈 FIREWALL: > Chain DOCKER-BRIDGE | Sub-Chain: DOCKER
+> 🛈 FIREWALL: > Chain DOCKER | Rule 0
+> 🛈 FIREWALL: > Chain DOCKER | Rule 1
+> ✖ FIREWALL: Packet blocked by rule: {'action': 'drop', 'seq': 1, 'raw': Rule: #22 | Matches: [ni_in != ['docker0'], ni_out == ['docker0']]}
+```
+
+----
+
 ## Roadmap
 
 ### 2025

docs/source/usage/3_run.rst

@@ -44,7 +44,7 @@ This is also a good way to test your setup at first!
     >                         Packet source-IP
     >   -d DST_IP, --dst-ip DST_IP
     >                         Packet destination-IP
-    >   -4 {tcp,udp,icmp,icmpv6}, --proto-l4 {tcp,udp,icmp,icmpv6}
+    >   -4 {tcp,udp,icmp}, --proto {tcp,udp,icmp}
     >                         Packet Layer-4 protocol
     >   -p PORT, --port PORT  Packet destination-port (if L4-proto is tcp/udp)
     >   -n, --no-color        Disable output colors

src/firewall_test/cli.py

@@ -29,8 +29,8 @@ def main():
         required=True,
     )
     parser.add_argument(
-        '-4', '--proto-l4', help='Packet Layer-4 protocol',
-        choices=['tcp', 'udp', 'icmp', 'icmpv6'], default='tcp',
+        '-4', '--proto', help='Packet Layer-4 protocol',
+        choices=['tcp', 'udp', 'icmp'], default='tcp',
     )
     parser.add_argument(
         '-p', '--port', help='Packet destination-port (if L4-proto is tcp/udp)',