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

From Custom Mario Kart
Jump to navigation Jump to search
(Update to v0.15)
Line 16: Line 16:
 
|-
 
|-
 
! Current Version:
 
! Current Version:
−
| v0.14, 2013-10-19
+
| v0.15, 2014-01-04
 
|}
 
|}
  
Line 40: Line 40:
  
 
<pre>
 
<pre>
 +
mkw-ana v0.15 r1703 - 2014-01-04
  
 +
- Cup index is now read from BMG.
 +
- Update of BMG files.
 +
- New option --log-mode=list (or short --lmd=list): Define, which elements
 +
  are included into the log file or output. Allowed keywords are: STATUS,
 +
  SELECT, DRIVER, RACE, EVENT, TOTAL, CHEATS, NONE and ALL (default).
 +
</pre>
 +
 +
;Old change log:
 +
<spoiler><pre>
 
mkw-ana v0.14 r1688 - 2013-10-19
 
mkw-ana v0.14 r1688 - 2013-10-19
  
Line 46: Line 56:
 
   than 32 tracks). Allowed keywords are DISABLED, AUTO (default), ENABLED.
 
   than 32 tracks). Allowed keywords are DISABLED, AUTO (default), ENABLED.
 
   Without parameter, CT-CODE support is enabled.
 
   Without parameter, CT-CODE support is enabled.
−
</pre>
 
  
−
;Old change log:
 
−
<spoiler><pre>
 
−
mkw-ana v0.11 r1622 - 2013-07-14
 
  
−
- More record types are detected now, some only as unnamed hex-records.
+
mkw-ana v0.13 r1683 - 2013-09-07
−
- The 'PREFIX*' records are renamed to 'ROOM*', because they are only send in
+
 
−
  room events. For non room events, there exists the prefix record 'GLOBAL'.
+
  - Improved built-in help system. Type "mkw-ana help help" for details.
−
- Optimized event detection, including world wide races and battles.
+
  - New option --ana=file: Opens a output file to store analysis data.
−
- A first battle stage detection works now. Battle records are different from
+
  - New option: --ana-mode=list (short: --amd=list):
−
  racing rcords and not analysed yet.
+
   Print only the specified events to the analysis file.
−
  - New command: COUNT: Count the record types. Together with option --verbose
+
  - New options --hms and --hms-info to print relative timestamps in HH:MM:SS.
−
  it shows all defined record types with short and long names.
 
−
- Event and race numbers are now incremented at begin of an event.
 
−
  - Track, driver, vehicle and engine names are now available in (us)english
 
−
  and german without loading a BMG text file. The default output language is
 
−
  english. If option --de is set, the default output language is switched to
 
−
  german. However, a loaded BMG text file may override all names.
 
−
  - Bug fix: Daylight saving is now recognized.
 
−
- The checksum of each UDP packet is now checked and invalid packets are
 
−
  dropped silently. If option --checksum is set, the packets are not dropped.
 
−
   This makes only sense for hex dumps. If option --checksum is set twice, the
 
−
  checksums are not calculated and assumed to be correct.
 
−
  - Some minor printing and counting bugs fixed.
 
−
- Windows only: Cygwin update to v1.7.20 2013-06-07.
 
−
- Windows only: The needed Cygwin DLL files are now delivered too.
 
  
  
Line 91: Line 83:
  
  
−
mkw-ana v0.13 r1683 - 2013-09-07
 
−
 
−
- Improved built-in help system. Type "mkw-ana help help" for details.
 
−
- New option --ana=file: Opens a output file to store analysis data.
 
−
- New option: --ana-mode=list (short: --amd=list):
 
−
  Print only the specified events to the analysis file.
 
−
- New options --hms and --hms-info to print relative timestamps in HH:MM:SS.
 
 
</pre></spoiler>
 
</pre></spoiler>
  
Line 106: Line 91:
 
<spoiler><pre>
 
<spoiler><pre>
  
−
mkw-ana v0.14/x86_64 r1688 -- Dirk Clemens -- 2013-10-19
+
mkw-ana v0.15/x86_64 r1703 -- Dirk Clemens -- 2014-01-04
 
--------------------------------------------------------
 
--------------------------------------------------------
  
Line 342: Line 327:
 
                     already existent file. If the filename is only '-', then
 
                     already existent file. If the filename is only '-', then
 
                     log to stdout.
 
                     log to stdout.
 +
    --log-mode list Define, which elements are included into the log file (see
 +
                    --log). --lmd is a short cut. A comma separated list of
 +
                    keywords is expected: STATUS, SELECT, DRIVER, RACE, EVENT,
 +
                    TOTAL, CHEATS, NONE and ALL (default).
 
     --md file      Create a MakeDoc script with results after each race.
 
     --md file      Create a MakeDoc script with results after each race.
 
     --mdx file      Create a MakeDoc script with results after each race. Same
 
     --mdx file      Create a MakeDoc script with results after each race. Same

Revision as of 10:48, 4 January 2014

Wiimms mkw-ana
File:Wiimms-SZS-Tools.png
Author: Wiimm
Operating Systems: Linux (i386,x86_64),
Windows (Cygwin).
Software Type: Mario Kart Wii network traffic analyzer
File Formats: PCAP 2.4 (tcpdump), bzip2 compression, BMG (text).
Current Version: v0.15, 2014-01-04

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



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

mkw-ana v0.15 r1703 - 2014-01-04

 - Cup index is now read from BMG.
 - Update of BMG files.
 - New option --log-mode=list (or short --lmd=list): Define, which elements
   are included into the log file or output. Allowed keywords are: STATUS,
   SELECT, DRIVER, RACE, EVENT, TOTAL, CHEATS, NONE and ALL (default).
Old 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 is 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.
  • The name of the comment file must be the same as the network dump, but it must have the extension ".info" instead of ".eth".

???

Dumping Data

Options

Download

You can find the latest and some old distributions here
Content
  • Binaries for:
    • Linux i386
    • Linux x86_64
    • Cygwin/Windows (Needed Cygwin[1] DLL files are delivered. Best is to install a Cygwin system).
  • Some scripts as examples.
  • Some BMG text examples.
  • Some doc files.
Sometimes I upload single tool updates for testers
And remember
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 ...

It is important to filter the data by host ip_or_name, because foreign traffic interfere the wii traffic analysis and will have curious side effects.

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 ssh, 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

References

  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=56185"