Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
lukasbischof authored Apr 13, 2017
1 parent 8f1f306 commit 242334b
Showing 1 changed file with 25 additions and 1 deletion.
26 changes: 25 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,27 @@
# Orsum Occulendi (Vier Gewinnt)
# Orsum Occulendi “Vorhaben des Verbergens” (Vier Gewinnt über AES)

Das Vier-Gewinnt Spiel auf Server-Client basis. Der Server hält das Spiel und einzelne Clients können über einen Server zusammen spielen. Dabei wird die ganze Kommunikation mit AES verschlüsselt.

## Setup
Das Projekt ist ein eclipse-Projekt. Nach dem Klonen kann man einfach unter 'Import' -> 'Eclipse Projekt in Workspace importieren' das Projekt in die IDE laden.

## Aufbau
Das Projekt hat ein default-package mit einer "Main" Klasse. Diese Klasse ist eine ausführbare Klasse, mit der man dann über die Konsole auswählen kann, ob man einen Server, einen Client oder die Testing-CLI starten möchte.

## Der Client
Der Client ist in dem Package 'client' zu finden. Er besitzt eine eigene Main-Klasse, die man separat starten kann.

## Der Server
Der Server ist in dem Package server zu finden. Auch er hat eine eigene Main-Klasse, die jedoch nur eine Kommandozeilenapplikation startet.

## Die Verschlüsselung
Alle für die Verschlüsselung wesentliche Pakete sind in dem Package 'crypto' zu finden. Dieses ist in ein Subpackage 'aes' und 'rsa' sowie 'cli' unterteilt

#### AES
Im AES Paket befindet sich die eigene Implementation des AES Algorithmus. AES wird für die symmetrische Verschlüsselung zwischen Client und Server verwendet.

#### RSA
In dem RSA Paket befindet sich ein Wrapper, welcher die für den Handshake zwischen Server und Client zentralen Methoden bereitstellt.

#### CLI
In dem CLI Paket sind einige Klassen für das Testen des AES Algorithmus vorhanden.

0 comments on commit 242334b

Please sign in to comment.