* [Presentation](#presentation) * [Installation](#installation) * [Help](#faq) * [Related tools](#related_tools) Presentation === Mptcpanalyzer is a tool conceived to help with MPTCP pcap analysis (as [mptcptrace] for instance). It accepts packet capture files (\*.pcap) as inputs and from there you can: - list MPTCP connections - compute statistics on a specific MPTCP connection (list of subflows, reinjections, subflow actual contributions...) - export a CSV file with MPTCP fields - plot one way delays - ... Commands are self documented with autocompletion. The interpreter with autocompletion that can generate & display plots such as the following: ``` cabal configure --enable-profiling cabal run mptcpanalyzer "load-pcap examples/client_2_filtered.pcapng" -- +RTS -xc ``` # Installation You will need a wireshark version __>= 3.6.0__ . Until changes are upstreamed, you will need this fork of optparse-applicative - https://github.com/teto/optparse-applicative/tree/quantum-wip-16.1 to get autocompletion working # How to use mptcpanalyzer can run into 2 modes: 1. interactive mode (default): an interpreter with some basic completion will accept your commands. There is also interactive help. 2. otherwise, it will consider the unknow arguments as one command, the same that could be used interactively For example, we can load mptcp pcaps (available at [wireshark wiki](https://wiki.wireshark.org/SampleCaptures#MPTCP) or in this [folder](./examples)). ``` mptcpanalyzer "map-tcp examples/client_2_filtered.pcapng examples/server_2_filtered.pcapng 0" mptcpanalyzer "load-pcap examples/client_2_filtered.pcapng" ``` or for a live analysis: ``` plot-mptcp-live 10.0.0.1 10.0.0.2 33784 5201 client lo -f examples/client_2_cleaned_start.pcapng ``` See [this blog](http://teto.github.io/tags/mptcp.html) for more tutorials about mptcpanalyzer. NB: in a local repository, you can run the previous command prefixed with `mptcpanalyzer$ cabal run -- COMMAND`. # How to develop/contribute See [CONTRIBUTING](./CONTRIBUTING.md). ## Dependencies - [polysemy](polysemy) to handle effects - [Frames](frames) to analyze data - [haskell-chart](haskell-chart) with the svg backend - [wireshark](wireshark-mptcp) to convert packet captures (.pcapng) to csv files. # Roadmap - improve caching - improve autocompletion - live statistics/plotting - plugins ? - ability to leverage the API in ihaskell ? # Related tools Similar software: | Tool | Description | |------------------------|-------------------------------------------------------------------------------| | [mptcptrace] | C based: [an example](http://blog.multipath-tcp.org/blog/html/2015/02/02/mptcptrace_demo.html) | | [mptcpplot] | C based developed at NASA: [generated output example](https://roland.grc.nasa.gov/~jishac/mptcpplot/) | # Acknowledgements This project is founded by . [mptcptrace]: https://bitbucket.org/bhesmans/mptcptrace [mptcpplot]: https://github.com/nasa/multipath-tcp-tools/ [hk-img]: https://img.shields.io/hackage/v/mptcpanalyzer.svg?logo=haskell [hk]: https://hackage.haskell.org/package/mptcpanalyzer [replica]: https://github.com/berewt/REPLica wireshark-mptcp: https://www.wireshark.org/docs/dfref/m/mptcp.html polysemy: https://hackage.haskell.org/package/polysemy diagrams: https://hackage.haskell.org/package/diagrams frames: https://hackage.haskell.org/package/Frames shelltestrunner: https://github.com/simonmichael/shelltestrunner