Difference between revisions of "Wiimms mkw-ana (tool)"

From Custom Mario Kart
Jump to navigation Jump to search
(mkw-ana v0.09)
Line 16: Line 16:
 
|-
 
|-
 
! Current Version:
 
! Current Version:
−
| 0.08, 2013-03-14
+
| 0.09, 2013-05-04
 
|}
 
|}
  
Line 122: Line 122:
  
 
mkw-ana v0.08 r1509 - 2013-03-14
 
mkw-ana v0.08 r1509 - 2013-03-14
−
 
 
  - Detection of different network packet types:
 
  - Detection of different network packet types:
 
   ARP, IP, IMCP, TCP, UDP and DNS(UDP).
 
   ARP, IP, IMCP, TCP, UDP and DNS(UDP).
Line 135: Line 134:
 
   a list of all global and command specific options.
 
   a list of all global and command specific options.
  
 +
 +
mkw-ana v0.09 r1532 - 2013-05-04
 +
 +
- Tool supports reading of bzip2 compressed tcpdump files.
 +
- Command FLOWRATES will now scan all IP packets with correct sender.
 +
- New option: --min-race=NUM: If a Grand Prix (single or team) is aborted, the
 +
  results of the Grand Prix are only used in the statstics, if NUM races has
 +
  been completed. The default is 2 and possible values are 0..4.
 +
- Option --hex-only is now ignored and will be removed in the future.
 +
- New option: --native (-n): If set, some known values, records or packets
 +
  are printed in native format instead as hex number. If set twice, some other
 +
  values, that will destroy the column layout of the hexdump, will printed in
 +
  native format too. This option replaces --hex-only.
 +
- If using -nn (2x --native), some more known values are printed in native
 +
  presentaion as part of the hex dumps.
 +
- Some minor bugs fixed.
 
</pre></spoiler>
 
</pre></spoiler>
  
Line 143: Line 158:
 
<spoiler><pre>
 
<spoiler><pre>
  
−
mkw-ana v0.08/x86_64 r1509 -- Dirk Clemens -- 2013-03-14
+
mkw-ana v0.09/x86_64 r1532 -- Dirk Clemens -- 2013-05-04
 
--------------------------------------------------------
 
--------------------------------------------------------
  
Line 217: Line 232:
  
 
     --bmg file    Read a BMG text file to scan online chat messages and
 
     --bmg file    Read a BMG text file to scan online chat messages and
−
                     track, drive and vehicle names. Disable auto load of BMG
+
                     track, driver and vehicle names. Disable auto load of BMG
−
                     files. Multiple usage allowed
+
                     files. Multiple usage is possible.
 
     --team file    Read a text file for team assignments and disable auto load
 
     --team file    Read a text file for team assignments and disable auto load
−
                     of team files. Multiple usage allowed
+
                     of team files. Multiple usage is possible.
  
 
Command specific options with common description:
 
Command specific options with common description:
Line 237: Line 252:
 
                     tool 'tail -f'.
 
                     tool 'tail -f'.
 
     --ip addr      Define an address (IP or DNS name) for filtering. Only
 
     --ip addr      Define an address (IP or DNS name) for filtering. Only
−
                     packets from an to this host are accepted, all others are
+
                     packets from and to this host are accepted, all others are
 
                     ignored.
 
                     ignored.
 
     --home addr    Define an address (IP or DNS name) as home client.
 
     --home addr    Define an address (IP or DNS name) as home client.
Line 266: Line 281:
 
                     or DNS name) or allowed by --receive-ip, --send or
 
                     or DNS name) or allowed by --receive-ip, --send or
 
                     --receive. --sip is a short cut for --send-ip.
 
                     --receive. --sip is a short cut for --send-ip.
 +
    --transfer-ip addr
 +
                    Dump only network packets receiced or send by the entered
 +
                    address (IP or DNS name) or allowed by --send or
 +
                    --receive. --tip is a short cut for --transfer-ip and both
 +
                    are short cuts for '--rip addr --sip addr.
 
   -L --length ranges Dump only UDP packets with specified UDP data length. The
 
   -L --length ranges Dump only UDP packets with specified UDP data length. The
 
                     8 bytes long UDP header does not count.
 
                     8 bytes long UDP header does not count.
Line 308: Line 328:
 
   -a --ascii        Append an ASCII character dump behind the hexdump. This
 
   -a --ascii        Append an ASCII character dump behind the hexdump. This
 
                     option is ignored if using --one-line.
 
                     option is ignored if using --one-line.
−
   -x --hex-only      Some known values, records or packets are printed in
+
   -n --native        If set, some known values, records or packets are printed
−
                     native format instead as hex number. If option --hex-only
+
                     in native format instead as hex number. If set twice, some
−
                     is set, all data is printed as hex number. --hex is a
+
                    other values, that will destroy the column layout of the
−
                     short cut.
+
                     hexdump, will printed in native format too.
 +
  -x --hex-only      This option is replaced by --native and ignored. It will
 +
                     be removed in future versions.
 
   -d --delta        If set, record data is compared with the data of the
 
   -d --delta        If set, record data is compared with the data of the
 
                     previous record of same type and client. If a byte is
 
                     previous record of same type and client. If a byte is
Line 319: Line 341:
 
                       The parameter is a comma separated list of INDEX,
 
                       The parameter is a comma separated list of INDEX,
 
                     INDEX1:, INDEX1:INDEX2 and INDEX#LENGTH elements.
 
                     INDEX1:, INDEX1:INDEX2 and INDEX#LENGTH elements.
 +
 +
    --min-race num  This is a statistic option: If a Grand Prix (single or
 +
                    team) is aborted, the results of the Grand Prix are only
 +
                    used in the statstics, if NUM races has been completed.
 +
                    The default is 2 and possible values are 0..4.
  
 
     --log file      Log into the file using the same output as command LOG. If
 
     --log file      Log into the file using the same output as command LOG. If
Line 339: Line 366:
 
     --mii dir      Extract Miis to the already existing directory 'dir'.
 
     --mii dir      Extract Miis to the already existing directory 'dir'.
 
                     Existing Mii files will be overwritten.
 
                     Existing Mii files will be overwritten.
 +
 
</pre></spoiler>
 
</pre></spoiler>
  
Line 370: Line 398:
 
=== Options ===
 
=== Options ===
 
=== Download ===
 
=== Download ===
−
Here is the v0.08 of the tool mkw-ana:
+
Here is the v0.09 of the tool mkw-ana:
−
[http://download.wiimm.de/mkw-ana/mkw-ana-v0.08-r1509.zip mkw-ana-v0.08-r1509.zip] (320 kB)
+
[http://download.wiimm.de/mkw-ana/mkw-ana-v0.09-r1532.zip mkw-ana-v0.09-r1532.zip] (340 kB)
 
* It contains binaries for:
 
* It contains binaries for:
 
** Linux i386
 
** Linux i386

Revision as of 11:14, 4 May 2013

Wiimms mkw-ana
File:Wiimms-SZS-Tools.png
Author: Wiimm
Operating Systems: Linux (i386,x86_64),
Windows (cygwin).
Software Type: Mario Kart Wii network analyzer
File Formats: PCAP 2.4 (tcpdump), BMG (text).
Current Version: 0.09, 2013-05-04

The tools mkw-ana is a new project by Wiimm to analyze the network protocol of Mario Kart Wii.



In Progress
This article is managed by Wiimm, the developer, and will grow slowly. Feel free to edit typos and grammatical or speech issues.

Intention

In November 2012, Wiimm decided to analyze the network protocol of Mario Kart Wii. The main goal was to discover online cheaters. Another goal is to set up his own server if any time Nintendo will shut down its servers.

So the main feature is to dump the packets of a tcpdump (done by tcpdump or wireshark) in a user-friendly format. After first experiments, it becomes also a live racing statistic tool.

Terms and definition

Template:MKWii Network Terms

The Tool

Change log

Show text


Built-in Help

Let's start with the built-in help as an overview about the tool:

Show text


General Description

The tool started as simple hex dumper reading network dumps in PCAP format. In the first phase of the tool, the textual dumps of wireshark and tcpdump were much better. But after only a few days, the tool learned to handle records, clients, users, friend codes and Miis. From this moment the tool was better to analyze the Mario Kart Wii traffic.

Now, mkw-ana split the traffic into records and scans some data to detect stages of the online meeting. Stages are for example room, prepare race, count down, racing and end of race. It is able to separate races into events (grand prix and team rand prix) and to calculate racing tables. Racing data can also be exported to support live statistics.

At the moment there are three different kinds of hexdumps. All 3 are able to dump in one line mode to have large tables. Tool less is here a very good tool for vertical and horizontal scrolling. The stages are includes into the dump as comment lines. The dumped records can be filters by sending, receiving, proxy, record types, stage types and packet length. It is also possible to select the dumped bytes by indices and ranges.

Another feature is, that mkw-ana can read comment files. If making videos of the dumped meetings, you can write such comment file. Each line starts with a timestamp followed by a comment. Virtual Dub is a good tool for this job. Then you must synchronize the comment file with the network dump. The start of the first game ("GO" in the video) is a very good point for synchronization. Here is an example of a comment file (in german): 

>2012-12-05 19:10:39.745 - 12:22.792
0:00:00.000 Video Start

0:12:22.792 Rennen 1.1, GO!
0:12:54.123 Tinti wird angekündigt, T=0:31.322
0:14:17.924 Power wird angekündigt, T=1:55.120
0:15:33.633 Blitz schlägt ein, T=1:35.326
...
Notes
  • The first line ist the real time of the start of the race minus the video time stamp. This is the synchronisation. An synchronisation can be done multiple times.
  • The line with video timestamp and comment follow. The focus of the comment change as the point of interest.

???

Dumping Data

Options

Download

Here is the v0.09 of the tool mkw-ana: mkw-ana-v0.09-r1532.zip (340 kB)

  • It contains binaries for:
    • Linux i386
    • Linux x86_64
    • Cygwin/Windows (A Cygwin system[1] must be installed).
  • Some scripts as examples.
  • Some BMG text examples.
  • Some doc files.

It is an alpha distribution and and only minimal support will be given at the moment.

Capture the network data

First you must capture the network traffic of the Wii. Therefore you must redirect it to a PC running a capture software. There are 3 general ways to to this:

  • If you have a manageable switch, enable port mirroring and send all Wii traffic to a PC.
  • Use your PC as router.
  • Use old network hubs (not switches). A hub will mirror all traffic of all ports to all others; it's just a multi port repeater and will slow down your network.

Use a software like tcpdump or wireshark to capture the data. Best is to save the captured data directly to a file or to send it to other commands like mkw-ana for a live analysis.

It's also possible to save the data to a file and to make a live analysis at the same time. Use the following command pipe: 

tcpdump -w- -U -i eth1 host wii | tee save.dump | mkw-ana ...

If using wireshark, save the dump to a file and use the following command for a live analysis: 

mkw-ana --follow DUMPFILE ...

Live Statistics

mkw-ana can scan the network traffic in real time and can produce makedoc or php data files. Together with ssh and an cgi script, a live statistic is created. Live means that the tables are updates 2-5 seconds after the race have finished.

How it works

The whole job is done by 3 processes:

  1. First, you must capture the network traffic like described above. Then use one of the commands: 
    ... | mkw-ana log --md  DATAFILE
... | mkw-ana log --php DATAFILE
mkw-ana --follow DUMPFILE log --md  DATAFILE
mkw-ana --follow DUMPFILE log --php DATAFILE
  2. Each time, a new DATAFILE is written, it must be transferred to the web server. A script using shh, sftp scp or ftp within an endless loop will do this job automatically.
  3. Last not least, a CGI or PHP script running at the web server must read the data files to serve a html-page to the visitors.

To see, what live means, visit the live statistics on Wednesday or Thursday between 19:10 and 20:30 CET (Central European Time).

Links

Footnotes

  1. ↑ Cygwin, a Linux like environment for Windows.


Template:MKWii Network Protocol

Retrieved from "https://wiki.tockdom.com/w/index.php?title=Wiimms_mkw-ana_(tool)&oldid=38924"