From d421615d207e1d55d5198c8ccdc947caaded0e0f Mon Sep 17 00:00:00 2001 From: AleaJactaEst Date: Mon, 11 Jan 2021 21:27:59 +0100 Subject: [PATCH] update README --- README.md | 34 ++++++++++++++++++++++++++++------ 1 file changed, 28 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index febf97a..59a62d6 100644 --- a/README.md +++ b/README.md @@ -8,16 +8,38 @@ Convert pcap (capture network) on yaml file to see communication between server ## Usage +### Install library + +``` +# Si python3 est par defaut +pip install pypcapfile + +# Sinon +pip3 install pypcapfile +``` + ### Launch network capture -sudo tcpdump -i [networkd card] -w [Pcap output] - -ex.: sudo tcpdump -i eth0 -w capture-2020-11-28-17-37-57.pcap +Commande: +``` +sudo tcpdump -i [networkd card] -w [Pcap output] +``` +Exemple: +``` +sudo tcpdump -i eth0 -w capture-2020-11-28-17-37-57.pcap +``` ### Extract information -python3 spykhanat.py -m [localization msg.xml] --yaml [Yaml Output file] -w [localisation database.xml] -p [Pcap input] --filter-host-service='[Ip address: Port server khaganat]' --csv='[file output CSV {comma separator} - extract only normal message]' -Ex.: python3 spykhanat.py -m ~/khanat/khanat-opennel-code/code/ryzom/common/data_common/msg.xml --yaml capture-2020-11-28-17-37-57.yml -w ~/khanat/khanat-opennel-code/code/ryzom/common/data_common/database.xml -p capture-2020-11-28-17-37-57.pcap --filter-host-service='127.0.0.1:47851' --csv capture-2020-11-28-17-37-57.csv +Commande: +``` +python3 spykhanat.py -m [localization msg.xml] --yaml [Yaml Output file] -w [localisation database.xml] -p [Pcap input] --filter-host-service='[Ip address: Port server khaganat]' --csv='[file output CSV {comma separator} - extract only normal message]' +``` + +Exemple: +``` +python3 spykhanat.py -m ~/khanat/khanat-opennel-code/code/ryzom/common/data_common/msg.xml --yaml capture-2020-11-28-17-37-57.yml -w ~/khanat/khanat-opennel-code/code/ryzom/common/data_common/database.xml -p capture-2020-11-28-17-37-57.pcap --filter-host-service='127.0.0.1:47851' --csv capture-2020-11-28-17-37-57.csv +``` ### Analyze result @@ -39,5 +61,5 @@ Detail message format (ex.: <0:31> (Sint32) CurrentSendNumber => 42 : 0000000000 * Format data (Signed/Unsigned Integer, String, Number of bit) * Function (type of value, function in khaganat) * Value : value in integer - * Value in binary + * Value in est par defaut binary * Value convert for khaganat (sometimes is keyword)