Quick start guide german translation

Dies ist die gekürzte und übersetzte Fassung der englischen Schnellstartanleitung zu Lehrzwecken für die Nestor School 2016.

Installation

PET ist ein Java Programm, muss daher nicht installiert werden und läuft auf allen gängigen Betriebssystemen. Es benötigt aber Java 7 (oder höher) welches hier heruntergeladen werden kann: http://www.java.com/download

Lade die neuste Version von PET hier runter und extrahiere das ZIP Archiv: https://github.com/pericles-project/pet/releases/latest

Führe die .jar Datei aus (Windows: Doppelklick, Linux/OS X: java -jar PeriCAT.jar).

Erste Schritte

Lerne die grafische Benutzeroberfläche kennen

Beim ersten Start von PET wird sich die grafische Benutzeroberfläche (GUI "Graphical User Interface") öffnen.

Die GUI ist in Registerkarten ("Tabs") organisiert, wie in folgendem Bildschirmschnappschuss zu sehen ist:

1. Der “Monitored files”-Tab zeigt eine Liste von Dateien die mit PET untersucht werden sollen
2. In dem “Modules”-Tab können Module zum Sammeln von Informationen hinzugefügt und konfiguriert werden
3. Der “Environment information”-Tab zeigt die gesammelten Umgebungsinformationen die für alle Dateien der Umgebung gleichermaßen gültig sind
4. Der “Events”-Tab führt alle aufgezeichneten Umgebungsereignisse auf, die von dem Tool erkannt wurden
5. Die gesammelten Umgebungsinformationen die zu einer bestimmten Datei gehören (und somit nicht für alle untersuchten Dateien gültig sind) können in dem "Monitored files"-Tab angesehen werden, indem die dazugehörige Datei ausgewählt wird.
6. Profile erlauben es die Module und die zu untersuchenden Dateien zu ordnen. So können mehrere Szenarien in PET konfiguriert werden.
7. Unten in der Benutzeroberfläche sind Knöpfe um das Sammeln der Informationen zu steuern

Füge eine Datei hinzu

Öffnen Sie den "Monitored files"-Tab und fügen Sie mit dem "Add Files"-Knopf eine Datei hinzu, die von PET untersucht werden soll. Es wird sich ein Dialog zum Hinzufügen der Datei öffnen. Beim Sammeln von Umgebungsinformationen werden Informationen gesammelt die für diese Dateien wichtig sind. Die Dateien werden dabei nicht von PET verändert.

Selektieren Sie ein Modul zum Sammeln von Informationen

Öffnen sie den "Modules"-Tab. Dieser verwaltet die Liste von Modulen die definieren welche Informationen gesammelt werden sollen. Klicken Sie den "Add new modules"-Knopf, um Module dieser Liste hinzuzufügen. Eine Oberfläche zum Konfigurieren der Module öffnet sich, wenn dieses in der Liste ausgewählt wird.

Starten Sie einen Schnappschusssammelvorgang

Klicken Sie den "Snapshot"-Knopf unten links in der Benutzeroberfläche. Dies wird einen einzelnen Sammelvorgang starten, bei dem jedes Modul einmal ausgeführt wird.

Betrachten Sie die Ergebnisse

Sie können die gesammelten Umgebungsinformationen im "Environment information"-Tab betrachten. Die Datei abhängigien Informationen können in dem "Monitored files"-Tab betrachtet werden.

PET verstehen

Es folgt ein tieferer Blick in die Funktionalitäten von PET.

Profile und Entwurfsvorlagen

PET organisiert die Dateien und Module zum Sammeln von Informationen in Profilen, um verschiedene Konfigurationen für verschiedene Szenarien laden zu können. Beim Start des Tools wird ein leeres Profil geladen. Existierende Profile können mit der "Select profile:"-Combobox oben in der Benutzeroberfläche ausgewählt werden.

Der Knopf "New profile (from template)" erlaubt das Erstellen von Profilen basierend auf vorkonfigurierten Entwurfsvorlagen für spezielle Szenarien. Es ist auch möglich Profile als Entwurfsvorlagen zu exportieren, um sie anderen PET-Benutzern zu schicken die dann Profile aus diesen Vorlagen erstellen können.

Eine Entwurfsvorlage beinhaltet die vorkonfigurierten Module, aber nicht die Dateien, da diese auf anderen Computern wahrscheinlich nicht vorhanden sind.

Die gespeicherten Entwurfsvorlagen können in folgendem Ordner gefunden werden: .../PET_data/config/profile_templates/ Es ist auch möglich diese JSON Konfigurationsdateien manuell zu ändern. Alle Vorlagen aus diesem Ordner können vom laufenden Programm aus als Profile geladen werden.

Zwei verschiedene Modi zum Sammeln von Informationen

PET bietet zwei Modi zum Sammeln von Informationen an:

1. Schnappschuss Modus: In diesem Modus wird jedes Modul zum Sammeln von Informationen einmal gestartet. Die Module zum Beobachten von Umgebungsereignissen werden in diesem Modus nicht ausgeführt. Der Sammelvorgang kann duch Klicken auf den "Snapshot"-Knopf ausgeführt werden.

2. Kontinuierlicher Sammelmodus: Dieser Modus kann in einem Sheer-Curation-Szenario verwendet werden. Die Module zum Beobachten der Umgebung werden gestartet und basierend auf den beobachteten Ereignissen werden kontinuierlich Informationen über die Umgebung gesammelt. Der Modus kann gestartet oder gestoppt werden, indem der "Start/Stop monitor"-Knopf unten in der Benutzeroberfläche geklickt wird.

Datei abhängige Informationen und Datei unabhängige Umgebungsinformationen

Die Umgebungsinformationen die gesammelt werden können entweder Datei abhängig sein und sich für jede beobachtete Datei ändern, oder sie sind Datei unabhängig und bleiben für alle Dateien gültig.

Module zum Sammeln von Informationen und Module zum Beobachten der Umgebung

Es gibt drei verschiedene Arten von Modulen in PET: Module die Datei abhängige Informationen sammeln, Module die Datei unabhängige Informationen sammeln und Module die die Umgebung beobachten um Umgebungsereignisse zu melden und das Sammeln von Informationen durch die anderen Module auszulösen.

Die verfügbaren Module können mit einer detailierten Beschreibung im "modules"-Tab durchgesehen werden, in dem auf den "Add new modules"-Knopf geklickt wird.

Konfiguration eines Moduls

Derzeit müssen die Module noch durch eine JSON-Datein konfiguriert werden. Eine kompfortablere Benutzeroberfläche für die Konfiguration der Module ist der Hauptpunkt auf der Wunschliste für eine spätere PET-Version.

Die Module können im "modules"-Tab durch eine JSON-Datei konfiguriert werden. Die Konfiguration muss dabei exakt der JSON-Syntax entsprechen. Durch einen Klick auf "Save and use configuration" wird die Syntax kontrolliert und im Falle von Syntaxfehlern eine Fehlermeldung angezeigt. Der "Reload config file"-Knopf kann dazu verwendet weren um die ursprüngliche Konfiguration wiederherzustellen.

Folgende Informationen beinhaltet die Konfigurationsdatei:

• Die “class” Option beinhaltet den namen der Java-Klasse des assoziierten Modules und sollte nicht geändert werden. Er wird gebraucht um das konfigurierte Modul zu laden.
• “moduleName” ist der Name des Modultyps. Dieser Wert darf auch nicht geändert werden. Wenn Sie den angezeigten Namen eines Modules ändern wollen, dann ändern Sie stattdessen den Wert von "moduleDisplayName".
• “moduleVersion” Dieser Wert zeigt die Versionsnummer des Modules an und sollte nicht geändert werden.
• Die “enabled” Option zeigt an ob das Modul momentan für das Sammeln von Informationen verwendet wird oder nicht. Um diesen Wert schnell zu ändern kann ebenso der Radioknopf oben rechts in der Benutzeroberfläche verwendet werden. Einige Module deaktivieren sich selber, wenn sie weitere Konfiguration benötigen um richtig laufen zu können. *“recordEvents” TODO
• “supportedSystems” beinhaltet eine Liste von Betriebssystemen, die von dem Modul unterstützt werden. Nicht alle Module funktionieren in jedem Betriebssystem. Manche Module können Betriebssystemspezifisch konfiguriert werden. Dann sollte diese Liste so konfiguriert werden, dass sie alle Systeme beinhaltet in denen das Modul laufen kann. “SYSTEM_INDEPENDENT” ist die voreingestellte Option, die besagt dass ein Modul auf jedem System läuft. Die verfügbaren Optionen sind: "OS_X", "SOLARIS", "BSD", "LINUX", und / oder "WINDOWS".

TODO "Under Construction"...

• “fileFilter” lets you restrict the file types on that a file-dependent module is executed, or that a daemon module is looking for. It can also be important for some file-independent modules that operate on system files. The five options are described in the following
  • “fileExtensionFilter”: Define a regex to filter the file extensions. Therefore use the java regex syntax
  • “inclusiveMimeType”: Consider only files of a specific mime type. For example “application/pdf”
  • “inclusiveMediaType”: Consider only files of the specific media type. For example “text”
  • “exclusiveMediaType”: Consider files of all media types, except that ones that are added here.
  • “exclusiveMimeType”: Consider files of all mime types, except that ones that are added here.
• “eventAddToProfile” TODO: is this the option to write events to a file?

These are the default options. All further options are customized implementations that can vary depending on the regarded module. The descriptions of the modules should also help with the configuration.

Browsing extraction results

The “Environment information”-tab provides the extracted file-independent information, whereas the extracted file-dependent information can be found at the “Monitored files”-tab by selecting one of the files in the list. By default an “information tree” is displayed that shows the extracted information sorted by extraction dates and extraction modules inserted into a tree structure. A double click on a result will open it in JSON format in a new window. An display mode intended for the visualisation of changes of environment information can be accessed by clicking the “Visualise information change”-button. Therefore an extraction module has to be selected in the combo box above. This mode will show the results of the selected module for all past extraction runs in a table, whereby the first row shows the corresponding date of extraction. The table can be opened in fullscreen mode and exported for further analysis. If no extraction module was selected, and the “Visualise information change”-button is clicked, the last extraction result is compared to the previous result with highlighted differences. The “Show information in JSON”-button displays the same information as the information change display, but uses the JSON format instead of a table.

It highly depends on the actual use case, which of the displaying modes are the appropriate ones.