Projektdokumentation Spiel Kryptogramm-Raten

Transkript

1 Projektdokumentation Spiel Kryptogramm-Raten Projektteilnehmer: Carsten Giesler Maik Köppen Gruppenleiter: Prof. Dr. Jürgen Cleve Marcel Brätz 20. Juni 2008

2 Inhaltsverzeichnis 1 Projektarbeit Aufgabenstellung Anforderungen Dokumente zur Abgabe Implementierung Ziele Projektverlauf Gantt-Diagramm Zeitlicher Verlauf Umsetzung Funktionsweise der Chire Umsetzung/ Implementierung der Chire Fertiges Programm Produktfunktionen Benutzeroberäche Schwierigkeiten während der Implementierung 15 4 Ausblick 16 5 Klassendokumentation 17 6 Glossar 19 Abbildungsverzeichnis 20 Tabellenverzeichnis 21 Literaturverzeichnis 22 2

3 1 Projektarbeit 1.1 Aufgabenstellung Es soll ein einfaches Kryptographiespiel entworfen werden, indem ein einfacher Satz mittels einer monoalphabetischen Chire verschlüsselt wird. Der Benutzer muss die Nomenklatur für das Rätsel herausnden oder erraten. Zum Verschlüsseln könnte vorzugsweise die Kamasutra-Chire verwendet werden. Das gesamte Spiel sollte in PHP programmiert werden und anschlieÿend über den Kryptographie-Spielplatz Version 2 veröentlicht werden und nutzbar sein. Desweiteren ist eine Präsentation sowie Dokumentation über das Projekt nach der Fertigstellung des Programms durchzuführen bzw. anzufertigen. 1.2 Anforderungen Dokumente zur Abgabe Alle Dokumente auÿer die Klassendokumentation und die Präsentation sollen in L A TEX über das Programm LYX geschrieben werden. Bei der Abgabe werden diese Dateien sowie ein daraus erzeugtes PDF-Dokument in StudIP hochgeladen. Grundlage hierfür ist folgende Quelle: [Brä08] Vor dem eigentlichen Projektstart soll ein Pichtenheft erstellt werden. Somit ist gewährleistet, dass die Aufgabenstellung dem Projektteam verständlich ist und es bildet die Grundlage für die Anforderungen und Aufgaben des Projektes. Desweiteren sind Projektzwischenberichte erforderlich, um den aktuellen Stand dem Gruppenleiter mitzuteilen. Dies dient dazu, um den Fortschritt der Implementierung aufzuzeigen sowie die Erfolge und Problemfelder einzelner Phasen zu dokumentieren. In den Zwischenberichten soll darüber hinaus ein Abgleich mit den Pichtenheften geschaen werden. Mindestens alle 2 Wochen soll ein Projekttagebuch erstellt werden. Diese dienen zur Grundlage für die Zwischenberichte und dokumentieren den zeitlichen Verlauf des Projektes. 3

4 1.3. ZIELE KAPITEL 1. PROJEKTARBEIT Die Abschlussdokumentation erfolgt in Form eines abschlieÿenden Projektberichtes. Hierbei werden nochmals die Aufgabenstellung und deren Anforderungen dargestellt und die daraus resultierende Umsetzung näher erläutert. Abschlieÿend soll eine Klassendokumentation angefertigt werden, die den programmiertechnischen Teil des Projektes nach auÿen oenlegt. Abschlieÿend wird eine Präsentation erstellt Implementierung Das Spiel soll über das KSB-Workbench implementiert werden. Das Spiel wird in den Kryptographie-Spielplatz Version 2 eingebunden und muss sich dementsprechend diesem optisch anpassen. Die Programmierung soll mittels PHP erfolgen. Dabei ist der Quellcode möglichst kurz zu halten und die einzelnen Funktionen sollen möglichst genau beschrieben werden. Desweiteren soll der Quelltext in UTF-8 kodiert sein. Als Richtlinie diente das folgende Tool auf der Seite rumkin.com: Ziele Das Programm soll möglichst benutzerfreundlich umgesetzt werden. Aussenstehende Personen sollen nicht durch eine umständliche Bedienung zusätzlich verunsichert werden. Zusätzliche Ziele sind Hilfen, die zur Unterstützung während des Spiels eingesetzt werden können und eine Auösung des Rätsels. 4

5 1.4. PROJEKTVERLAUF KAPITEL 1. PROJEKTARBEIT 1.4 Projektverlauf Gantt-Diagramm Abbildung 1.1: Gantt-Diagramm Anhand des Gantt-Diagramms kann man sehr gut den zeitlichen Umfang einzelner Positionen erkennen. Dabei nehmen die Einarbeitungsphase, die Implementierungsphase und die Dokumentation den gröÿten Stellenwert während des Projektverlaufs. Die Dokumentation zog sich von Anfang bis zum Ende der Bearbeitungsdauer des Projektes hin. Durch geeignete Arbeitsteilung konnte für jeden Projektteilnehmer der zeitliche Aufwand in Grenzen gehalten werden, wodurch sich die gesamte Projektarbeit sehr eektiv und ezient gestalten lieÿ. 5

6 1.4. PROJEKTVERLAUF KAPITEL 1. PROJEKTARBEIT Zeitlicher Verlauf Tabelle 1.1: Verlauf Auswahl des Projektthemas Beginn des Projektablaufs Abgabe des Pichtenheftes Abgabe des überarbeiteten Pichtenheftes Einarbeiten in PHP mittels des Tutorials vorgefertigten Klassen und Funktionen besprochen und zu verstehen versucht konkrete Analyse der vorgefertigten Klassen Abgabe des ersten Pichtenheftes Einarbeiten in PHP mittels des Tutorials Überlegungen zur Umsetzung des Buchstabenaustausches Besprechung der weiteren Vorgehensweise der Umsetzung Beginn der Realisierung Implementierung Implementierung Absprache mit Projektleiter Marcel Brätz über weiteren Verlauf und zusätzliche Implementierungstipps Implementierung Einbinden ins Workbench Verbesserung des Programms Fertigstellung des Spiels Projektdokumentation Projektdokumentation Projektdokumentation 6

7 2 Umsetzung 2.1 Funktionsweise der Chire Die Funktionsweise der Kamasutra-Chire ist sehr einfach. Die Buchstaben werden zufällig vertauscht und der zu verschlüsselnde Text dementsprechend umgewandelt. Beispielsweise steht für ein A ein T und für ein B das I. Hinter diesem Austausch steckt keinerlei erkennbares System. Nur durch die entsprechende Nomenklatur kann ein sinnvolles Entschlüsseln ermöglicht werden. Beispiel einer Nomenklatur: Tabelle 2.1: Nomenklatur A B C D E F G H I J K L M N O P Q R S T U V W X Y Z C N A F I R T Z E J S L D B K V W X Y G M P Q O U H So wird aus dem Text Hallo Welt folgende Buchstabenreihe: ZCLLK QILG Die Schwachstelle dieser Chire ist wie bei allen anderen monoalphabetischen Chiren die leichte Lösbarkeit. Mittels einer Häugkeitsanalyse ist jede monoalphabetische Chiffre zu entschlüsseln. 2.2 Umsetzung/ Implementierung der Chire Die programmiertechnische Umsetzung erfolgte in PHP, einer Skriptsprache welche für die Erstellung von dynamischen Webseiten geeignet ist. An dieser Stelle wird nur auf einige elementare Funktionen Bezug genommen. Die zu verschlüsselnden Sätze sind Lebens- und Bauernweisheiten, die in einer kleinen SQLite Datenbank gespeichert sind. Von dort aus werden sie mittels einer Abfrage im Quelltext zufällig ausgewählt und einer Variablen $wert übergeben. Mit dieser Variablen kann dann weitergearbeitet werden. 7

8 2.2. UMSETZUNG/ IMPLEMENTIERUNG DER CHIFFRE KAPITEL 2. UMSETZUNG Hier der Quelltext zur Funktion holespruch(): Abbildung 2.1: Funktion holespruch() Im Vorfeld wird mittels der Funktion kreation ein zufälliger Chiriercode generiert, welcher das komplette Alphabet einmal durchmischt. Dies geschieht mit Hilfe der Funktion array_rand(). Diese Funktionen sorgen dafür, dass zufällige Buchstaben aus dem Alphabet genommen werden und anschlieÿend in eine extra Variable $code gespeichert werden. Damit die Buchstaben nicht doppelt verwendet werden, kürzt die Funktion array_splice() die Buchstaben aus dem Alphabet heraus. Hier der Quelltext: Abbildung 2.2: Funktion kreation() Die Funktion kodieren sorgt dafür, dass der aus der Datenbank geholte Spruch mit dem Code aus der Funktion kreation verschlüsselt wird. Anschlieÿend wird der Spruch rückläug mit der Klatur entschlüsselt. Ist der Code der Klatur gleich, heben die beiden sich auf und das Rätsel ist gelöst. Dies geschieht im Wesentlichen innerhalb der For- Each-Schleifen innerhalb der Funktion kodieren. 8

9 2.3. FERTIGES PROGRAMM KAPITEL 2. UMSETZUNG Hier nochmals der Quelltext: Abbildung 2.3: Funktion kodieren() 2.3 Fertiges Programm Produktfunktionen Das Programm besitzt folgende Funktionen: Es wird ein zufälliger Spruch mittels RANDOM() aus einer Datenbank entnommen und mit der Kamasutra-Chire verschlüsselt. Nomenklatur kann mittels eines Wechsler-Buttons herausgefunden werden. In Textfeld werden 2 Buchstaben eingegeben und dann mittels der ENTER-Taste und des Wechsler-Buttons vertauscht. Dabei können die letzten Schritte mittels des Rueckgaengig-Buttons in der Reihenfolge revidiert werden. Die rückgängig gemachten Schritten können mittels des Wiederherstellen-Buttons bis zum letzten Bearbeitungsschritt wiederhergestellt werden. Der Button Neues Spiel erzeugt ein neues Spiel mit einem neuen Spruch. Die Eingaben können mit Hilfe des Buttons Alle Eingaben zuruecksetzen zurückgesetzt werden. Die Nomenklatur und die Veränderungen werden wieder in den Ausgangszustand versetzt. 9

10 2.3. FERTIGES PROGRAMM KAPITEL 2. UMSETZUNG Beim Versuch Sonderzeichen oder Zahlen in das Textfeld einzugeben und zu vertauschen, wird der Benutzer mittels einer Textnachricht auf diesen Fehler hingewiesen. Bei ungenügenden Eingaben wird der Benutzer ebenfalls durch eine Textnachricht darauf hingewiesen. Wenn der verschlüsselte Text vollständig gelöst wurde, wird der Nutzer durch eine Nachricht auf den Erfolg hingewiesen. Es kann die Hilfe Hamming genutzt werden, die die Anzahl der übereinstimmenden Buchstaben der Nomenklatur anzeigt. Dazu muss der Button Hamming betätigt werden und die Lösungshilfe wird angezeigt. Bei Betätigung des Buttons Auoesung wird die Lösung des Rätsels angezeigt. Dazu gehört einerseits der Geheimtext und andererseits die korrekte Nomenklatur Benutzeroberäche Anhand der folgenden Grak ist die Oberäche des Kryptographiespielplatz mit dem Beschreibungstext des Ratespiels zu erkennen: Abbildung 2.4: Oberäche Kryptographiespielplatz 10

11 2.3. FERTIGES PROGRAMM KAPITEL 2. UMSETZUNG Hier ist die Spieloberäche dargestellt: Abbildung 2.5: Spiel_Ausgangslage 11

12 2.3. FERTIGES PROGRAMM KAPITEL 2. UMSETZUNG Bei fehlerhafter Eingabe erscheint folgende Meldung: Abbildung 2.6: Spiel_Fehler 12

13 2.3. FERTIGES PROGRAMM KAPITEL 2. UMSETZUNG Beim Nutzen der Hilfe Hamming: Abbildung 2.7: Spiel_Hilfe 13

14 2.3. FERTIGES PROGRAMM KAPITEL 2. UMSETZUNG Beim Nutzen der Auoesung: Abbildung 2.8: Spiel_Auoesung 14

15 3 Schwierigkeiten während der Implementierung Folgende Schwierigkeiten sind während der Projektbearbeitung aufgetreten: Einarbeitung in PHP Verständnis vom Prinzip der SESSIONS in PHP Das Einbinden in die graphische Oberäche vom Kryptographiespielplatz Das Einbinden der Datenbank, sodass die Sprüche auch zufällig ausgewählt werden + perfekte Funktionalität aller Buttons Alle hier aufgeführten Probleme konnten gelöst werden! 15

16 4 Ausblick Folgende Punkte könnten zudem noch realisiert werden: graphische Aufbereitung des Spiels mittels Buchstabenbilder Möglichkeit, dass Nutzer Sprüche selber einfügen kann Bestenliste, die nach Zeit oder wenigsten Spielzügen bewertet wird (natürlich nicht bei Benutzung der Lösung oder deren Hilfen) Möglichkeit auch mit anderen Chiren zu arbeiten 16

17 5 Klassendokumentation Inventur aller Systemdaten Abbildung 5.1: Klassendoku1 Hier wird die Einordnung des Spiels in das KSB-Workbench und der Pfad und die dazugehörige Programmdatei nochmals abgebildet. 17

18 KAPITEL 5. KLASSENDOKUMENTATION SESSION Abbildung 5.2: Klassendoku2 An dieser Stelle ist unter anderem nochmals der zufällig ausgewählte Spruch zu erkennen und mit welchem Code dieser verschlüsselt wurde. 18

19 6 Glossar PHP LyX (Hypertext Preprocessor) Skriptsprache zur Erstellung von dynamischen Webseiten, welche Datenbanken wie MySQL unterstützt Graphisches Textprogramm, welches auf das L A TEX System aufgebaut ist LaTeX PDF System zur Erstellung von Texten, welches eine Weiterentwicklung von TEX ist (Portable Document Format) standardisiertes Dateiformat für Dokumente UTF-8 (Unicode Transformation Format) weitverbreiteste Kodierung für Unicode-Zeichen [wik08] KSB-Workbench Entwicklungsumgebung für PHP, welches von Marcel Brätz geschrieben wurde SQLite Software Bibliothek, welches ein SQL-Datenbanksystem enthält SESSIONS Methode, um Daten an nachfolgende Scripte zu übergeben Chire Geheimtext/ Verfahren, welches Buchstaben vertauscht, ersetzt [Sin01] StudIP (Studienbegleitender Internetsupport von Präsenzlehre) Platform zur Organisation des Studiums und Datenaustausch 19

20 Abbildungsverzeichnis 1.1 Gantt-Diagramm Funktion holespruch() Funktion kreation() Funktion kodieren() Oberäche Kryptographiespielplatz Spiel_Ausgangslage Spiel_Fehler Spiel_Hilfe Spiel_Auoesung Klassendoku Klassendoku

21 Tabellenverzeichnis 1.1 Verlauf Nomenklatur

22 Literaturverzeichnis [Brä08] Marcel Brätz. Projekte der Kryptographie-Vorlesung an der HSW-SS2008. Marcel Brätz, [Sin01] Simon Singh. Geheime Botschaften. dtv, [wik08]