diff --git a/README.md b/README.md new file mode 100644 index 0000000..b33e437 --- /dev/null +++ b/README.md @@ -0,0 +1,27 @@ +# Nix Daemon Wireshark Dissector + +Wireshark lua dissector for the Nix daemon Unix domain socket. A useful tool to debug the Nix daemon protocol. + +![Screenshot showing a Wireshark window dissecting the Nix daemon protocol](./doc/img/screenshot.png) + +## Usage + +With flakes: + +```bash +nix run .# +``` + +Without flakes: + +```bash +"$(nix-build)/bin/snoop-nix-daemon" +``` + +A Wireshark window appears and start to dissect the packets passing through `/nix/var/nix/daemon-socket/socket`, the Nix daemon socket. + +## Background + +Wireshark cannot listen to Unix domain sockets out of the box. We leverage the [sockdump](https://github.com/mechpen/sockdump/tree/master) tool to capture the daemon packets before sending them to Wireshark's stdin. Under the hood, sockdump uses BPF (through BCC) to intercept the Unix socket packets. We need the root privilege to load this BPF program to the kernel. + +In this repository, you can also find a Lua wireshark dissector in charge of parsing the Nix daemon protocol. diff --git a/doc/img/screenshot.png b/doc/img/screenshot.png new file mode 100644 index 0000000..dd5bac3 Binary files /dev/null and b/doc/img/screenshot.png differ