Technische Dokumentation SilentStatistikTool

Transkript

1 Technische Dokumentation SilentStatistikTool Version 1.0 Marko Schröder

2 Inhalt Einleitung... 3 Klasse Program... 3 Klasse ArgumentHandler... 3 Bereitgestellte Variablen... 3 Bereitgestellte Methoden... 4 UML... 5 Klasse Localization... 6 Bereitgestellte Variablen... 6 Bereitgestellte Methoden... 6 UML... 6 Komplettes UML... 7

3 Einleitung Diese Anwendung ermöglicht es dem Benutzer Datenverkehr in einem definierten Zeitraum aufzuzeichnen. Die gesammelten Daten werden in eine Datenstruktur zum Erstellen von Statistiken überführt und anschließend in einer Datei gespeichert. Diese Datei kann zu einem späteren Zeitpunkt mit dem Statistik Tool wieder geöffnet werden. Klasse Program Dies ist die Hauptklasse des Programms. Hier wird überprüft ob der der WinPcap-Treiber installiert ist und, wenn dies der Fall, ist eine Instanz der ArgumentHandler-Klasse erstellt. Dieser Klasse werden die Kommandozeilenparameter übergeben. Ob der WinPcap-Treiber installiert ist, erkennt das Programm in dem es zwei Registrierungsschlüssel liest: SOFTWARE\Microsoft\Windows\CurrentVersion\Uninstall\WinPcapInst o für x86-windows SOFTWARE\Wow6432Node\Microsoft\Windows\CurrentVersion\Uninstall\WinPcapInst o für x64-windows Klasse ArgumentHandler Diese Klasse verarbeitet die ihr übergebenen Kommandozeilenparameter. Sie zeigt dem Benutzer eine Liste der, zum Capture-Vorgang zur Verfügung stehenden, Netzwerkgeräte und startet den Capture. Bereitgestellte Variablen 1) public String[] Arguments { get; set; } Die, dem Programm übergebenen, Kommandozeilenparamater 2) private DataProcessor dp; Eine Instant des DataProcessors. Dieser übernimmt die Datenverarbeitung der einzelnen gesammelten Pakete. 3) private PacketGatherer gatherer; Eine Instanz des PacketGatherers. Durch diesen wird der Capture-Vorgang durchgeführt. 4) private int interfaceid; ID eines Netzwerkgerätes 5) private int capturetime; Die Zeit in der Daten gesammelt werden sollen. 6) private String path; Der Pfad an dem die Statistik-Datei gespeichert werden soll. 7) private System.Timers.Timer timer; Eine Instanz der Timers-Klasse. Durch diese wird Capture-Dauer gesteuert. 8) private System.Threading.AutoResetEvent timerevent; Event auf den der Hauptthread wartet, bis der Timer abgelaufen ist. 9) private Localization lc = new Localization(); Zuständig für das Laden von lokalisierten Strings.

4 Bereitgestellte Methoden 1) public ArgumentHandler() Standardkonstruktor. Initialisiert dp, gatherer sowie timer außerdem wird ein Eventhandler für das CancelKeyPress-Event des Programms registriert, um vor dem Beenden des Programms noch Aufräumarbeiten durchführen zu können. 2) public ArgumentHandler(String[] args) : this() Konstruktor. Weißt args der entsprechenden Variable zu. 3) public void processarguments() Überprüft, ob dem Programm eine korrekte Anzahl an Argumenten übergeben wurde (zwischen 0, 1 oder 3). Im Fehlerfall oder wenn die Anzahl der Argumente 0 ist wird showhelp() aufgerufen. Bei nur einem Argument wird überprüft ob dieses -i, -v oder -- version ist und entweder showinterfaces() oder showversion() aufgerufen. Bei drei Argumenten wird startcaptureprocess() aufgerufen. 4) private void startcaptureprocess() Um einen Capture-Vorgang zu startetn muss das Programm mit folgenden Parametern gestartet werden: SilentStat -i<x> <N> <File> (SilentStat -i1 60 dump.sd) Die Methode versucht nun als erstes die Interface ID zu parsen und in interfaceid zu schreiben. Da die ausgegebene Liste bei 1 startet, die interne Liste des PacketGatherers jedoch bei 0, muss zunächst die interfaceid dekrementiert werden. Ist die nun erhalten Zahl kleiner 0 oder existiert kein Interface mit dieser ID innerhalb des PacketGatherers, wird eine Fehlermeldung ausgegeben und das Programm endet. Als nächstes wird versucht die Dauer des Capture-Vorgangs zu parsen. Da der eingesetzte Timer intern mit Millisekunden rechnet, darf die gewünschte Dauer maximal int.maxvalue / 1000 groß sein. Ist dies der Fall, wird der eingegebene wird mit 1000 multipliziert und kann so später dem Timer zugewiesen werden. Ist die eingegebene Zahl 0 so wird capturetime auf int.maxvalue gesetzt, um den Capture-Vorgang mit der maximalen Dauer zu starten ( Sekunden). Das letzte Argument beschreibt den Pfad, an dem die Statistik-Datei abschließend gespeichert werden soll. Um sicherzustellen dass die gewünschte Datei erstellt werden kann, wird zu Testzwecken eine leere Datei am gewünschten Speicherort erstellt. Sind alle vorherigen Schritte erfolgreich beendet worden, so kann nun der eigentliche Capture gestartet werden. Hierzu wird zunächst der PacketGatherer mit allen benötigten Informationen versorgt (Registrierung des PacketsCapturedEvent-Eventhandlers, setzen des ActiveDevices, etc ), danach folgt die Initialisierung des timer-objekts. Abschließend wird der Capture-Vorgang sowie der Timer gestartet und per timerevent.waitone() darauf gewartet das der Timer endet. 5) void timer_elapsed(object sender, System.Timers.ElapsedEventArgs e) Eventhandler für das Elapsed-Event des Timers. Dieser wird nur einmal aufgerufen (wenn der Timer abgelaufen ist) und stoppt den Capture-Vorgang. Außerdem werden die gesammelten Daten per dp.savestatisticsdata() in die gewünschte Datei geschrieben. Abschließend wird timerevent.set() aufgerufen um den wartenden Hauptthread darüber zu informieren, dass der Capture-Vorgang beendet wurde.

5 6) void gatherer_packetscapturedevent(object sender, packetscapturedeventargs e) Eventhandler für das packetscapturedevent des PacketGatherers. Die CaptureList des packetscaptured Events wird an die process()-methode des DataProcessors weitergegeben und von diesem bearbeitet. 7) private void showversion() Gibt die Version des Programms aus. Die Informationen hierfür werden per Reflection aus der Assembly geholt. 8) private void showinterfaces() Gibt eine Liste der auf dem Rechner zur Verfügung stehenden Netzwerkgeräte aus. Die Daten Stammen aus der DevListAddr-Liste des PacketGatherers. 9) private void showhelp() Gibt die Hilfe der Anwendung aus. Die Lokalisierten Strings dieser Ausgabe stammen aus der Instanz des Localization Objekts. UML

6 Klasse Localization Diese Klasse verwaltet einen eigenen RessourceManager und ermöglicht es der Applikation lokalisierte Strings aus einer Ressource-Datei zu laden. Bereitgestellte Variablen 1) private ResourceManager rm; Eigener RessourceManager zum verwalten der lokalisierten Strings. 2) private String resourcepath; Der Pfad zu den Ressource-Dateien. Bereitgestellte Methoden 1) public Localization() Konstruktor. Initialisiert ressourcepath mit dem Pfad zu den Ressource-Dateien. Dieser wird per Reflection aus der Assembly geholt. Des Weiteren wird der der RessourceManager rm initialisiert. Diesem wird der Präfix der Ressource-Dateien sowie der ressourcepath übergeben. 2) public String getstring(string name) Gibt einen lokalisierten String zurück. Wenn der gesuchte String nicht in der Ressource Datei gefunden wird, so wird Localization missing! zurückgegeben. UML

7 Komplettes UML