Add a basic README, outlining the idea and usage

This commit is contained in:
maride 2019-11-28 13:57:03 +01:00
parent e41a957e8d
commit b8d9eeaed0

30
README.md Normal file
View File

@ -0,0 +1,30 @@
# pancap
## Idea
If you get access to a [PCAP](https://en.wikipedia.org/wiki/Pcap) file, for example during a CTF or captured on your own, you usually have the problem of overlooking all the relevant information to get a basic idea of the capture file. This gets worse if the capture file includes lots of white noise or irrelevant traffic - often included in the capture file to cloak *interesting* packets in a bunch of packets to YouTube, Reddit, Twitter and others.
*pancap* addresses this problem. With multiple submodules, it analyzes the given PCAP file and extracts useful information out of it. In many cases, this saves you a lot of time and can point you into the right direction.
## Usage
Simply run
`go get git.darknebu.la/maride/pancap`
This will also build `pancap` and place it into your `GOBIN` directory - means you can directly execute it!
In any use case, you need to specify the file you want to analyze, simply handed over to pancap with the `-file` flag.
Example usage:
`pancap -file ~/Schreibtisch/mitschnitt.pcapng`
This will give you a result similar to this:
<script id="asciicast-x19gUpdnQoeUx498mPS0Grw6B" src="https://asciinema.org/a/x19gUpdnQoeUx498mPS0Grw6B.js" async></script>
## Contributions
... yes please! There are still a lot of modules missing.
If you are brave enough, you can even implement another Link Type. Pancap currently only supports `Ethernet` (which, to be honest, fits most cases well), but `USB` might be interesting, too. Especially sniffed keyboard and mouse packets are hard to analyze by hand...