mirror of
https://github.com/lgcosta/pf-linux-port.git
synced 2026-11-12 20:15:36 -03:00
lgcosta
cc67531602
O problema da primeira serie era a sensacao de 'quadro a quadro': a captura era a saida de um script despejada em blocos. Agora cada video e uma sessao shell de verdade. - record.py: abre um pty, faz SSH no firewall e digita os comandos tecla a tecla (~34 c/s, com jitter). O tty remoto ecoa, o kernel responde ao vivo; a captura e asciicast v2 com timestamps. 'bash --noediting' evita que o editor de linha redesenhe o comando e o tty o repita (a linha aparecia duplicada). - record.py --pace: segura a tela enquanto a voz fala - cada batida dura o trecho de audio que a acompanha, de modo que uma unica captura serve as duas versoes de idioma. - record.py --ensure-pf: garante pf.ko carregado antes de gravar. Sem isso uma fase que roda 'rmmod' (ativacao) pode derrubar o /dev/pf de outra gravacao concorrentes - foi exatamente o que quebrou a fase de roteamento na primeira tentativa. - make_audio.py: geracao da narracao pelo MiniMax TTS, uma voz feminina por idioma (English_ConfidentWoman / Portuguese_ConfidentWoman), um arquivo por segmento. A API devolve o audio em hexadecimal, nao base64. - render_video.py: reproduz a captura por um emulador de terminal e escreve os frames direto no ffmpeg como RGB bruto (um PNG por frame era uma ordem de grandeza mais lento). Desenha o diagrama de rede do lab por cima do terminal nas fases de roteamento e balanceamento, destacando o caminho em discussao, e queima a legenda da narracao. - assemble.py: mixa os segmentos de audio na linha do tempo. - join.py: emenda as fases com crossfade sobre um cartao de capitulo e sincroniza o audio na mesma linha do tempo. - build-all.sh: roda o pipeline inteiro. Arte de fundo e audio vem do MiniMax; a geracao de video do MiniMax nao esta habilitada nesta conta (erro 2068 em todos os modelos), entao as transicoes sao renderizadas localmente com ffmpeg. 16 videos: 7 fases + filme completo, em ingles e portugues, com legenda queimada.
102 lines
5.6 KiB
Markdown
102 lines
5.6 KiB
Markdown
# PF on Linux
|
||
|
||
Port of the OpenBSD **PF** (packet filter) to **Linux 7.3.4** as an
|
||
out-of-tree kernel module — the real PF engine (`pf.c`, `pf_norm.c`,
|
||
`pf_table.c`, `pf_lb.c`, … ported from OpenBSD 8.0 sources) driven by the
|
||
real OpenBSD `pfctl` over the `/dev/pf` ioctl ABI. (A second module for the
|
||
`pfq` qdisc arrives with M5.)
|
||
|
||
**Status:** the filter core, stateful filtering, tables, anchors, NAT
|
||
(`nat-to`/`rdr-to`/`binat-to`), forced routing (`route-to`/`dup-to`), `divert`
|
||
and `pflog` are **verified in a real libvirt lab** (14/14 gates green). The
|
||
remaining features (queue attachment/pacing, af-to) are still pending — honest per-feature status:
|
||
[`docs/en/feature-matrix.md`](docs/en/feature-matrix.md).
|
||
Demo (asciinema): [`docs/en/demo.md`](docs/en/demo.md).
|
||
Design: [`docs/superpowers/specs/2026-11-11-pf-linux-port-design.md`](docs/superpowers/specs/2026-11-11-pf-linux-port-design.md)
|
||
· plan: [`docs/superpowers/plans/2026-11-11-pf-linux-port.md`](docs/superpowers/plans/2026-11-11-pf-linux-port.md).
|
||
|
||
## Milestones
|
||
|
||
| Milestone | Scope | Status (2026-11-11) |
|
||
|---|---|---|
|
||
| M0 | repo, scripts, kernel build, VM boots the custom kernel | done |
|
||
| M1 | compat layer, `pf.ko` loads, `/dev/pf`, `pfctl -f` / `-s info` | done |
|
||
| M2 | filter core: rules/states/tables/anchors, VM gates 01–04 | **done** — gates 01/02/03/04 green |
|
||
| M3 | NAT (`nat-to`/`rdr-to`/`binat-to`), scrub | **done** — gates 05/06/07/09 (incl. 2 MB integrity through a redirect, min-ttl/max-mss measured) |
|
||
| M4 | route-to/dup-to/reply-to, divert e2e, pflog | **done** — divert (11), pflog (12), route-to/dup-to (08), pools (10), reply-to (13) verified |
|
||
| M5 | queues: HFSC back end in the data path | **done (mechanical)** — gate 15: queues load, hfsc attaches, `pfctl -s queue -v` reports class stats, a 2 MB queued flow is counted by the class. `bandwidth` = HFSC linkshare (guarantee, not cap; 8.0 has no upperlimit syntax) |
|
||
| M6 | docs complete, patchset tidy, full suite green, tagged release | **done** — docs EN+PT-BR, 11/11 suite green, tagged (v0.5.0) |
|
||
|
||
## What you get (planned)
|
||
|
||
| Area | Feature |
|
||
|---|---|
|
||
| Filtering | rules, anchors, quick, `match`/`block`(drop/return/return-rst)/`pass`, `keep state`, syncookies |
|
||
| State/Tables | stateful firewall engine, `pfr` tables (radix + hash, `pfctl -t`) |
|
||
| NAT | `nat-to` (port pools, sticky-port, static-port), `rdr-to`, `binat-to` |
|
||
| Scrub | fragment reassembly, overlap drop, `min-ttl`/`max-mss`/`df`/`no-df`, `set reassemble` |
|
||
| QoS (ALTQ successor) | `queue`/`queue on` with OpenBSD 8.0 `ifq` schedulers: **HFSC verified in the data path** (gate 15), priq default, FQ-CoDel compiled; `pfctl -s queue -v` works |
|
||
| Divert | `divert-to` / `divert` tag + `pdivert` relay over an in-module `PF_DIVERT` socket family (verified: packet to userspace and back) |
|
||
| Route | `route-to`/`dup-to`/`reply-to` + pools (`round-robin`, `source-hash`) verified (`fail-to` no longer exists in OpenBSD 8.0) |
|
||
| Logging | `pflogd` via `/dev/pflog` (DLT_PFLOG pcap, OpenBSD record layout) — verified |
|
||
| Control | `/dev/pf` (0600), OpenBSD 8.0 ioctl ABI, Linux build of `pfctl` (single binary) |
|
||
|
||
Not in scope: `pfsync`/CARP failover, IPsec/pfkey, `ftp-proxy`, per-netns PF
|
||
instances, classic-ALTQ-only schedulers (cbq/wfq/red — removed upstream before
|
||
OpenBSD 8.0).
|
||
|
||
## Screencasts
|
||
|
||
Seven narrated screencasts per language (English and Portuguese), 1080p30 with
|
||
burned-in subtitles, the lab's network diagram drawn over the terminal, and a
|
||
continuous film that crossfades the phases together. Every video is a **real
|
||
shell session** against the Alpine VMs — commands typed key by key, the kernel
|
||
answering live — with a MiniMax female voice narrating:
|
||
|
||
```sh
|
||
./scripts/screencast/build-all.sh # -> out/screencast/{en,pt}/*.mp4
|
||
```
|
||
|
||
Details, per-phase breakdown and the YouTube description text:
|
||
[`docs/en/screencast.md`](docs/en/screencast.md) ·
|
||
[`docs/pt-BR/screencast.md`](docs/pt-BR/screencast.md)
|
||
|
||
## Quick start
|
||
|
||
Full recipe: [`docs/en/install.md`](docs/en/install.md). Short version
|
||
(commands are read from the scripts; a fresh-clone end-to-end run is still
|
||
pending):
|
||
|
||
```sh
|
||
./scripts/fetch-sources.sh # OpenBSD 8.0 sources (C3SL mirror, sha256-pinned)
|
||
./scripts/vendorize.sh # stage the pristine files we port
|
||
./scripts/build-kernel.sh # kernel 7.3.4: bzImage + modules_prepare (export patch: none needed)
|
||
./scripts/build-module.sh # -> module/pf.ko
|
||
make -C tools # -> tools/out/pfctl (static), ABI harness
|
||
sudo insmod module/pf.ko # /dev/pf (0600) + netfilter hooks
|
||
sudo pfctl -f /etc/pf.conf && sudo pfctl -e
|
||
```
|
||
|
||
Read [`docs/en/pf-guide.md`](docs/en/pf-guide.md) **before** enabling PF on a
|
||
path you need: only the M2 filter core is gated today; NAT/scrub/queues/
|
||
divert/pflog are not usable yet ([`docs/en/feature-matrix.md`](docs/en/feature-matrix.md)).
|
||
|
||
VM validation lab (Alpine on libvirt): [`docs/en/vm-lab.md`](docs/en/vm-lab.md).
|
||
Documentação em português: [`README.pt-BR.md`](README.pt-BR.md) e
|
||
[`docs/pt-BR/`](docs/pt-BR/README.md).
|
||
|
||
## Layout
|
||
|
||
- `module/` — kernel sources (ported PF + compat layer; the `pfq` qdisc lands with M5)
|
||
- `tools/` — pfctl (static Linux build), pdivert relay source, ABI harness (`pflogd` not ported yet)
|
||
- `patches/kernel/` — Linux core patch set (currently empty; evidence in `p1-needs.txt`, see `docs/en/patches.md`)
|
||
- `scripts/` — fetch/build/patch/VM automation
|
||
- `tests/` — VM suite (`tests/vm/NN-*.sh`, scapy helpers)
|
||
- `docs/en/` + `docs/pt-BR/` — full bilingual documentation
|
||
- `docs/superpowers/` — design spec + implementation plan
|
||
|
||
## License
|
||
|
||
Ported OpenBSD code retains its original [ISC license and copyright notices](LICENSE).
|
||
New Linux-side code: ISC.
|