Skip to content

Latest commit

 

History

History
59 lines (43 loc) · 2.26 KB

README.md

File metadata and controls

59 lines (43 loc) · 2.26 KB

📦 pkt

stateless firewall with yara like rules in python

‼️ Important stuff

In these docs when I'm referring to the OSI model and the various layers that the protocols are in, use this image to see what I mean:

The OSI model

This only works on linux. This is only designed for linux. There will most likely be no support for operating systems other than linux.

📖 Docs

📜 Making rules

There are two yara files, default.yar and default_RAW.yar. The first one should contain rules matched against 'info.yml' in each packet directory. The second one is matched against the raw.bin file in each packet directory

  • default.yar
    • Should contain properly formatted yara rule(s)
    • Matched against the parsed packed data in info.yml
      • Stored in format: l<osi model layer>_<packet type>_<attribute>_<optional sub-attribute>, e.g.
      • l4_tcp_port_dst, l3_ipv4_src, or l6_tls_version
  • default_RAW.yar
    • Should contain properly formatted yara rule(s)
    • Matched against raw packet data (raw bytes starting at the network layer) in raw.bin

🤖 Systemd unit

To run pkt as a daemon, you first need to install everything and make sure it works.

After that, use these commands to interact with the daemon:

./run_pkt.sh --service start # starts the service (only after installed)
./run_pkt.sh --service stop # stops the service
./run_pkt.sh --service restart # restarts the service (only after installed)
./run_pkt.sh --service install # installs and enables the service
./run_pkt.sh --service uninstall # uninstalls and disables the service

🤨 How to run?

You need:

  • linux
  • iptables
  • less
  • build-essential python-dev libnetfilter-queue-dev on debian, find out what these packages are for your distribution
  • python >= 3.10
    • Why? I use match case
  • root/sudo permissions

Run:

sudo pip3 install -r requirements.txt
less run_pkt.sh
echo -e \\nONLY PRESS ENTER\\nif you have:\\n\\n1. read through the script carefully\\n2. trust everything that it does\\notherwise, press Ctrl+C
read && ./run_pkt.sh