Add brief readme.

This commit is contained in:
Félix Baylac Jacqué 2023-09-14 15:01:13 +02:00
parent 52d66241d8
commit d18bc9a385
2 changed files with 27 additions and 0 deletions

27
README.md Normal file
View File

@ -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.

BIN
doc/img/screenshot.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 163 KiB