Entwicklerdokumentation

Transkript

1 Ad-hoc Chatsystem für Mobile Netze Gruppe 4 Softwareentwicklungspraktikum Sommersemester 2007 Entwicklerdokumentation Auftraggeber Technische Universität Braunschweig Institut für Betriebssysteme und Rechnerverbund Prof. Dr.-Ing. Lars Wolf Mühlenpfordtstraße 23, 1. OG Braunschweig Betreuer: Sven Lahde, Oliver Wellnitz, Wolf-Bastian Pöttner Phasenverantwortlicher: Norman Dankert Auftragnehmer Name Alexander Hoffmann Christoph Peltz Norman Dankert Sven Hesse alexhoffmann84@web.de kris@keeg.de n.dankert@tu-bs.de drmccoy@users.sourceforge.net Braunschweig,

2 Entwicklerdokumentation INHALTSVERZEICHNIS Inhaltsverzeichnis 1 Projektdetails Allgemeine Funktionsweise Weiterleitung von Nachrichten Analyse der Produktfunktionen Analyse von Funktionalität F10: öffentlichen Kanal erstellen Grobanalyse Feinanalyse Analyse von Funktionalität F11: öffentlichem Kanal beitreten Grobanalyse Feinanalyse Analyse von Funktionalität F12: öffentlichen Kanal verlassen Grobanalyse Feinanalyse Analyse von Funktionalität F20: geschlossenen Kanal erstellen Grobanalyse Feinanalyse Analyse von Funktionalität F21: geschlossenem Kanal beitreten Grobanalyse Feinanalyse Analyse von Funktionalität F30: Kanäle auflisten Grobanalyse Feinanalyse Analyse von Funktionalität F40: Nachrichten schreiben Grobanalyse Feinanalyse Analyse von Funktionalität F50: Peerliste aktivieren Grobanalyse Feinanalyse Analyse von Funktionalität F51: Peerliste deaktivieren Grobanalyse Feinanalyse Analyse von Funktionalität F52: Peer hinzufügen Grobanalyse Feinanalyse Analyse von Funktionalität F53: Peer entfernen Grobanalyse Feinanalyse Analyse von Funktionalität F60: Alle erreichbaren Teilnehmer auflisten Grobanalyse Feinanalyse

3 Entwicklerdokumentation INHALTSVERZEICHNIS 3 Resultierende Softwarearchitektur Komponentenspezifikation Schnittstellenspezifikation Protokolle für die Benutzung der Komponenten Verteilungsentwurf 26 5 Erfüllung der Kriterien Musskriterien Wunschkriterien Abgrenzungskriterien Implementierungsentwurf Gesamtsystem Implementierung der Komponente S10: UDP Klassendiagramm Klasse UDP Klasse Listener Klasse Sender Klasse SendHellos Implementierung der Komponente S20: Channel Klassendiagramm Klasse Channel Klasse ClosedChannel Klasse PublicChannel Klasse AnonymousChannel Klasse ChannelManager Implementierung der Komponente S30: Message Klassendiagramm Klasse Message Klasse ChanneledMessage Implementierung der Komponente S40: User Klassendiagramm Klasse User Klasse UserList Klasse UserManager Klasse Purger Implementierung der Komponente S50: EventManager Klassendiagramm Klasse EventManager Implementierung der Komponente S60: Crypt Klassendiagramm Klasse CertificateManager Implementierung der Komponente S70: RoutingTable

4 Entwicklerdokumentation INHALTSVERZEICHNIS Klassendiagramm Klasse RoutingTable Klass PeerAddr Klasse RoutingData Klasse Peer Implementierung der Komponente S80: Network Klassendiagramm Klasse Network Datenmodell Diagramm Erläuterung

5 Entwicklerdokumentation ABBILDUNGSVERZEICHNIS Abbildungsverzeichnis 1 Allgemeine Funktionsweise Weiterleitung von Nachrichten Aktivitätsdiagramm für Funktion F Sequenzdiagramm für Funktion F Aktivitätsdiagramm für Funktion F Sequenzdiagramm für Funktion F Aktivitätsdiagramm für Funktion F Sequenzdiagramm für Funktion F Aktivitätsdiagramm für Funktion F Sequenzdiagramm für Funktion F Aktivitätsdiagramm für Funktion F Sequenzdiagramm für Funktion F Aktivitätsdiagramm für Funktion F Sequenzdiagramm für Funktion F Aktivitätsdiagramm für Funktion F Sequenzdiagramm für Funktion F Aktivitätsdiagramm für Funktion F Sequenzdiagramm für Funktion F Aktivitätsdiagramm für Funktion F Sequenzdiagramm für Funktion F Aktivitätsdiagramm für Funktion F Sequenzdiagramm für Funktion F Aktivitätsdiagramm für Funktion F Sequenzdiagramm für Funktion F Aktivitätsdiagramm für Funktion F Sequenzdiagramm für Funktion F Komponenten von MAdChat Verteilungsentwurf Komponenten von MAdChat Klassendiagramm - UDP Klassendiagramm - Channel Klassendiagramm - Message Klassendiagramm - User Klassendiagramm - Event Klassendiagramm - Crypt Klassendiagramm - RoutingTable Klassendiagramm - Network Datenmodell

6 Entwicklerdokumentation 1 PROJEKTDETAILS 1 Projektdetails 1.1 Allgemeine Funktionsweise Abbildung 1: Allgemeine Funktionsweise Nachdem MAdChat gestartet wurde, ist es Betriebsbereit und versucht ein Netz zu finden bzw. ein eigenes aufzubauen. Ist dies gelungen, kann der Nutzer chatten oder andere Nutzer Nachrichten über den neuen Knoten weiterleiten. Das Programm kann durch den Befehl des Benutzers beendet werden, speichert jedoch vorher noch diverse Einstellungen und sendet NACKs für nicht zugestellte Nachrichten zurück und verwirft diese. Erhält der Client eine Nachricht, analysiert er diese und verifiziert sowohl Struktur als auch Inhalt. Sollte es Unstimmigkeiten geben, ist diese Nachricht ungültig und wird nicht weiter bearbeitet. Ist die Nachricht jedoch gültig, wird überprüft, ob sie nur weitergeleitet werden soll, oder der Nutzer des Clients ebenfalls ein Empfänger ist - in diesem Fall wird sie dem Nutzer angezeigt und gegebenenfalls vorher entschlüsselt und anschließend ebenfalls weitergeleitet, falls der Nutzer nicht der einzige Empfänger gewesen ist. Will der Nutzer eine Nachricht versenden, so prüft der Client ob diese verschlüsselt werden muss und tut dies gegebenenfalls. Anschließend wird die Nachricht an ihre Empfänger, also die Nutzer, mit denen der Nutzer im selben Kanal ist, weitergeleitet. Wurde die Nachricht weitergeleitet oder zwischengespeichert, wartet MAdChat auf neue Nachrichten. 1.2 Weiterleitung von Nachrichten Für jeden Empfänger einer Nachricht, also alle Chatteilnehmer eines Kanals bzw. alle in der Nachricht aufgelisteten Chatteilenhmer, wird dieser Statechart abgearbeitet. Sollte die Liste der Empfänger leer sein (der Benutzer war also der letzte Empfänger), wird nichts weitergeleitet. Ist ein Chatteilnehmer aufgrund einer Netztrennung nicht mehr erreichbar, wird der Inhalt der Nachricht solange zwischengespeichert, bis dieser Chatteilnehmer wieder erreichbar ist. 6

7 Entwicklerdokumentation 1 PROJEKTDETAILS Abbildung 2: Weiterleitung von Nachrichten Falls dem nicht so ist, wird der Peer aus der Routingtabelle ausgewählt, über den der Chatteilnehmer erreichbar ist. Existiert bereits eine Nachricht mit dem gleichen Inhalt an diesen Peer, so wird der Chatteilnehmer der Empfängerliste der Nachricht hinzugefügt. Sollte dies nicht der Fall sein, so wird eine neue Nachricht an den Peer erstellt, über den der Chatteilnehmer erreichbar ist und danach die Empfängerliste um den Chatteilnehmer erweitert. Wurden alle Chatteilnehmer abgearbeitet, werden die Nachrichten an die Peers versendet. 7

8 Entwicklerdokumentation 2 ANALYSE DER PRODUKTFUNKTIONEN 2 Analyse der Produktfunktionen Im folgenden Kapitel werden die Funktionen aus dem Pflichtenheft jeweils in einem Aktivitätsdiagramm (Grobanalyse) und in einem Sequenzdiagramm (Feinanalyse) näher erläutert und beschrieben. In den Diagrammen sind die einzelnen Komponenten und deren Methoden enthalten wie sie im Feinentwurf dargestellt sind. Bei Benutzer handelt es sich dabei um den Nutzer, der über die GUI das Programm MAdChat benutzt. Das Objekt Benutzer entspricht also gleichzeitig auch die Eingabe und Ausgabe von MAdChat. 2.1 Analyse von Funktionalität F10: öffentlichen Kanal erstellen Grobanalyse Abbildung 3: Aktivitätsdiagramm für Funktion F10 Diese Funktion dient dazu einen öffentlichen Kanal im Netz zu erstellen. Der Benutzer gibt dabei über ein Eingabefeld den gewünschten Namen ein und bestätigt die Eingabe. Die Komponente Channel, die alle vorhandenen und zu erzeugenden Kanäle durch den Channel- Manager verwaltet, überprüft, ob ein Kanal mit gleichem Namen schon vorhanden ist. Wenn ja, wird der Nutzer durch versenden einer JOIN-message (Aufgabe von UDP) dem Kanal hinzugefügt. Wenn ein solcher Kanal noch nicht existiert, wird dieser erstellt, der Nutzer hinzugefügt und dem Netz durch eine CHANNEL-message der neue Kanal mitgeteilt. 8

9 Entwicklerdokumentation 2 ANALYSE DER PRODUKTFUNKTIONEN Abbildung 4: Sequenzdiagramm für Funktion F Feinanalyse Im oberen Teil des Diagramms dargestellt, ist der gewünschte Kanal noch nicht vorhanden. Es wird createchannel() aufgerufen, wodurch ein neuer Kanal erzeugt wird. Channel fügt den neuen Kanal hinzu und durch UDP wird mit einer CHANNEL-message der neue Kanal dem Netz mitgeteilt. Im unteren Teil ist der gewünschte Kanal bereits im Netz vorhanden, wodurch Channel veranlasst wird, den Nutzer dem Kanal hinzuzufügen. Dies geschieht durch verschicken einer JOIN-message durch UDP. Wird das Beitrittwunsch bestätigt setzt Channel den Nutzer auf die Mitgliederliste. Die Änderung wird mit broadcast() im Netz verteilt. 2.2 Analyse von Funktionalität F11: öffentlichem Kanal beitreten Grobanalyse Möchte der Benutzer einem bereits vorhandenen öffentlichen Kanal beitreten, wählt er diesen aus der Kanalliste aus. Ist der Kanal in diesem Moment nicht erreichbar, wird eine Fehlermeldung angezeigt. Ist der Kanal noch vorhanden, wird durch UDP eine JOIN-message verschickt und der Nutzer wird durch User (verwaltet alle Nutzer im Netz) der Mitgliederliste hinzugefügt. Der Kanal mit seinen Mitgliedern wird dem Benutzer dann durch Channel in einem neuen Tab dargestellt Feinanalyse Der Benutzer teilt Channel mit, dass er einem Kanal vom Typ PublicChannel beitreten möchte. Channel erzeugt eine JOIN-message die durch UDP dem Netz mitgeteilt wird und die Komponente User setzt den Benutzer auf die Liste. 9

10 Entwicklerdokumentation 2 ANALYSE DER PRODUKTFUNKTIONEN Abbildung 5: Aktivitätsdiagramm für Funktion F11 Abbildung 6: Sequenzdiagramm für Funktion F Analyse von Funktionalität F12: öffentlichen Kanal verlassen Grobanalyse Der Benutzer verlässt einen öffentlichen Kanal, indem er den zugehörigen Tab schließt. Der Nutzer wird aus der Nutzerliste durch User entfernt und der Kanal wird in Channel entfernt, nachdem eine LEAVE-message durch UDP versendet wurde Feinanalyse Durch leave() wird Channel mitgeteilt, dass der Kanal verlassen wird. Channel erzeugt eine Nachricht vom Typ LeaveMessage, während User mit erase() den Benutzer aus der Liste entfernt. Die Nachricht zum Verlassen wird schließlich durch UDP gesendet. 10

11 Entwicklerdokumentation 2 ANALYSE DER PRODUKTFUNKTIONEN Abbildung 7: Aktivitätsdiagramm für Funktion F12 Abbildung 8: Sequenzdiagramm für Funktion F Analyse von Funktionalität F20: geschlossenen Kanal erstellen Grobanalyse Abbildung 9: Aktivitätsdiagramm für Funktion F20 11

12 Entwicklerdokumentation 2 ANALYSE DER PRODUKTFUNKTIONEN Der Benutzer gibt beim Erstellen des Kanals zusätzlich an, dass dieser geschlossen sein soll. Für die eindeutige ChannelID wird der lokale Hostname verwendet. Die Komponente Crypt verschlüsselt dann den Kanal und Channel erstellt diesen. UDP teilt dem Netz den neuen Kanal mit. Beim Benutzer öffnet sich ein neuer Kanaltab Feinanalyse Abbildung 10: Sequenzdiagramm für Funktion F20 Nachdem der Benutzer den Kanalnamen für den zu erstellenden Kanal eingegeben hat, wird mit getlocalhostname() der lokale Hostname wiedergegeben. Damit wird dann der Kanal durch Crypt verschlüsselt und wiedergegeben. Channel erstellt den neuen Kanal und veranlasst UDP eine CHANNEL-message zu verschicken, um dem Netz den neuen Kanal mitzuteilen. 2.5 Analyse von Funktionalität F21: geschlossenem Kanal beitreten Grobanalyse Der Beuntzer wählt aus einer Liste einen geschlossenen Kanal aus dem er beitreten möchte. Ist der Kanal immer noch im Netz zu erreichen, wird eine JOIN-message verschickt. Hat ein anderer Benutzer, der bereits Mitglied des Kanals ist, den Beitrittwunsch bestätigt, wird die entsprechende KEY-message empfangen und durch Crypt entschlüsselt. Channel fügt den Benutzer dann dem Kanal hinzu Feinanalyse Durch die Methode join() wird Channel der Beitrittwunsch des Benutzers mitgeteilt. UDP verschickt daraufhin mit broadcast() die JOIN-message. Ist der Beitrittwunsch bestätigt, wird mit getprivatekey() der Crypt Komponente der angeforderte Schlüssel des Kanals entschlüsselt und an Channel wiedergegeben. 12

13 Entwicklerdokumentation 2 ANALYSE DER PRODUKTFUNKTIONEN Abbildung 11: Aktivitätsdiagramm für Funktion F21 Abbildung 12: Sequenzdiagramm für Funktion F Analyse von Funktionalität F30: Kanäle auflisten Grobanalyse Abbildung 13: Aktivitätsdiagramm für Funktion F30 13

14 Entwicklerdokumentation 2 ANALYSE DER PRODUKTFUNKTIONEN Der Benutzer hat die Möglichkeit alle vorhandenen Kanäle im Netz anzeigen zu lassen. Dafür werden die Kanäle, die Channel bekannt sind, in einer Liste dem Benutzer wiedergegeben Feinanalyse Abbildung 14: Sequenzdiagramm für Funktion F30 Das Anzeigen der Kanäle wird in der Komponente Channel durch die Methode getchannels() realisiert. 2.7 Analyse von Funktionalität F40: Nachrichten schreiben Grobanalyse Abbildung 15: Aktivitätsdiagramm für Funktion F40 Innerhalb eines Kanals kann der Benutzer Textnachrichten verschicken, die allen anderen Nutzern im Kanal angezeigt werden. Diese Nachrichten werden in einem Texteingabefeld vom Benutzer eingetippt und per Eingabetaste verschickt. Die Komponente Message erzeugt dann eine ChatMessage mit der Signatur des Benutzers. Wird die Nachricht innerhalb eines geschlossenen Kanals verschickt, wird sie zusätzlich durch Crypt verschlüsselt. UDP sendet die Nachricht schließlich an alle Nutzer des Kanals. 14

15 Entwicklerdokumentation 2 ANALYSE DER PRODUKTFUNKTIONEN Feinanalyse Abbildung 16: Sequenzdiagramm für Funktion F40 Im oberen Teil ist das Versenden einer Nachricht in einem offenen Kanal dargestellt. Im unteren Teil wird eine Nachricht im geschlossenen Kanal versendet, die durch encryptdes() vor dem Einreihen zum Senden in UDP noch durch Crypt verschlüsselt wird. 2.8 Analyse von Funktionalität F50: Peerliste aktivieren Grobanalyse Abbildung 17: Aktivitätsdiagramm für Funktion F50 Das aktivieren der Peerliste entspricht einem Infrastrukturmodus, in dem man feste IP- Adressen eingeben kann um ein geschlossenes Netz zu simulieren (vor allem für Testzwecke). Der Infrastrukturmodus wird durch die Komponente UDP verwaltet Feinanalyse Die Peerliste wird durch die Methode enable() aktiviert. Mit der Methode getpeerlist() werden die Peers abgerufen. 15

16 Entwicklerdokumentation 2 ANALYSE DER PRODUKTFUNKTIONEN Abbildung 18: Sequenzdiagramm für Funktion F Analyse von Funktionalität F51: Peerliste deaktivieren Grobanalyse Abbildung 19: Aktivitätsdiagramm für Funktion F51 Die Peerliste wird durch einen Klick des Benutzers deaktiviert Feinanalyse Abbildung 20: Sequenzdiagramm für Funktion F51 Die Methode zum Deaktivieren ist disable() in UDP Analyse von Funktionalität F52: Peer hinzufügen Grobanalyse Der Benutzer kann einen neuen Peer in die Liste eintragen. UDP fügt den gewünschten Peer dann hinzu. 16

17 Entwicklerdokumentation 2 ANALYSE DER PRODUKTFUNKTIONEN Abbildung 21: Aktivitätsdiagramm für Funktion F Feinanalyse Abbildung 22: Sequenzdiagramm für Funktion F52 Das Eintragen eines Peers wird durch die Methode addpeer() innerhalb UDP erledigt Analyse von Funktionalität F53: Peer entfernen Grobanalyse Abbildung 23: Aktivitätsdiagramm für Funktion F53 Der Peer, der entfernt werden soll wird vom Benutzer ausgewähl. UDP entfernt denn Peer dann. 17

18 Entwicklerdokumentation 2 ANALYSE DER PRODUKTFUNKTIONEN Abbildung 24: Sequenzdiagramm für Funktion F Feinanalyse Der Benutzer wählt den zu entfernenden Peer aus. Die Methode delpeer() entfernt dann den Peer Analyse von Funktionalität F60: Alle erreichbaren Teilnehmer auflisten Grobanalyse Abbildung 25: Aktivitätsdiagramm für Funktion F60 Wenn der Benutzer sich mit dem Netz verbindet, wird automatisch ein anonymer Kanal erstellt. Da alle erreichbaren Nutzer immer Mitglied dieses Kanals sind, werden sie in diesem Kanal aufgelistet Feinanalyse Beim Verbinden wird der Channelmanager aufgerufen, der den anonymen Kanal erstellt und von User alle erreichbaren Nutzer holt und in den Kanal einträgt. 18

19 Entwicklerdokumentation 3 RESULTIERENDE SOFTWAREARCHITEKTUR Abbildung 26: Sequenzdiagramm für Funktion F60 3 Resultierende Softwarearchitektur 3.1 Komponentenspezifikation Abbildung 27: Komponenten von MAdChat MAdChat besteht aus madchat (dem Front-End mit GUI) und libmadchat. Das Front-End ist nur dafür verantwortlich, mit dem Nutzer zu interagieren, während alles, was das Chatprotokoll betrifft, Aufgabe der Library ist. 19

20 Entwicklerdokumentation 3 RESULTIERENDE SOFTWAREARCHITEKTUR Die einzelnen Komponenten von libmadchat sind UDP, Channel, Message, User, Event, Crypt, RoutingTable und Network. In der folgenden Schnittstellenspezifikation werden alle öffentlichen Methoden der einzelnen Komponenten erläutert, die dann insgesamt die einzelnen Schnittstellen, wie im Diagramm zu sehen, darstellen. 3.2 Schnittstellenspezifikation Schnittstelle Aufgabenbeschreibung /S10/: UDP Operation Beschreibung Udp (Network network, ost::tpport Konstruktor. port=8888) void send (Message msg, Sende eine Nachricht. ost::ipv4address ip, ost::tpport port=8888) void broadcast (Message msg) Broadcaste eine Nachricht. Message* receive() Empfange eine gegebenenfalls vorliegende Nachricht. Infrastructure* getinfrastructure() Gibt ein Infrastruktur-Objekt zurück. std::string getlocalhostname() const Gibt den local hostname zurück. void setlocalpeer (const PeerAddr Setzt lokale Adresse. peer) void queueforsending (Message *msg) Reiht Nachricht fürs Senden ein. 20

21 Entwicklerdokumentation 3 RESULTIERENDE SOFTWAREARCHITEKTUR Schnittstelle Aufgabenbeschreibung /S20/: Channel Operation Beschreibung Channel (ChannelManager manager, Konstruktor. const std::string name, const std::string id, const std::string key=, KeyType keytype=keynokey) bool isexistent () const Gibt Kanel zurück falls dieser noch im Netz ist. std::string getname () const Gibt den Kanalnamen zurück. std::string getid () const Gibt die KanalID zurück. KeyType getkeytype () const Gibt den Schlüsseltyp zurück. std::string getkey () const Gibt den Schlüssel zurück. UserList* getmembers () const Gibt die Benutzer eines Kanals zurück. timet getlastchannel () const Gibt Wert zurück wenn die letzte CHANNEL-message erhalten wurde. bool getnochannel () const Gibt an ob eine CHANNELmessage gesendet werden konnte oder nicht. void setkey (const std::string key, Setzt Schlüssel. KeyType type) void setkey (const std::string key, Setzt Schlüssel. const std::string type) bool empty () Gibt zurück ob im Kanal Nutzer sind. bool hasmember (const std::string id) Gibt an ob der Nutzer im Kanal ist. void receivedchannel () CHANNEL-message wurde empfangen. virtual void join () Betrete den Kanal. virtual void leave () Verlasse den Kanal. virtual void confirmjoin (const UserPtr user) Bestätigt den Beitritt eines anderen Nutzers. virtual void send (ChatMessage msg) Sendet eine Nachricht im aktuellen Kanal. virtual ChannelMessage* Erzeugt eine CHANNELmessage. createchannelmessage () static KeyType getkeytype (const std::string type) Gibt den Schlüsseltyp im String zurück. static std::string getkeytype (KeyType type) Gibt den Schlüssel als String zurück. 21

22 Entwicklerdokumentation 3 RESULTIERENDE SOFTWAREARCHITEKTUR Schnittstelle Aufgabenbeschreibung /S30/: Message Operation Beschreibung virtual Message* clone () const=0 Verfielfätigt die Nachricht. Type gettype () Gibt den Typ der Nachricht zurück. std::string getid () Gibt die ID der Nachricht zurück. unsigned int getttl () Gibt die TTL (Time-to-live) zurück. unsigned int getdelay () Gibt die Laufzeit der Nachricht zurück. SignType getsigntype () Gibt den Typ der Signatur zurück. std::string getsignature () Gibt die Signatur zurück. bool getownsignature () Gibt an ob eigene Signatur berechnet wurde. std::string getsender () Gibt den Sender der Nachricht zurück. std::list< std::string > getreceivers Gibt die Empfänger zurück. () PeerAddr getpeer () Gibt den Peer zurück von wo aus die Nachricht gesendet wurde oder wohin sie gesendet werden soll. timet getreceivedtime () Gibt zurück wann die Nachricht gesendet wurde. virtual bool getflood () Gibt an ob die Nachricht im ganzen Netz geflutet werden soll. virtual bool isnackable () Gibt an ob ein NAck gesendet wird, wenn die Nachricht nicht ankommt. virtual bool needsack () Gibt an ob die Nachricht ein Ack braucht. void createnewid () Erzeugt eine neue NachrichtenID. void setid (const std::string id) Setzt die NachrichtenID. void setttl (unsigned int ttl) Setzt die TTL der Nachricht. void setdelay (unsigned int delay) Setzt die Laufzeit der Nachricht. void setsignature (const std::string Setzt die Signatur. signature, SignType type) virtual void setsender (const Setzt den Sender der Nachricht. std::string sender) void setreceiver (const std::string Setzt den Empfänger der Nachricht. receiver) 22 void setreceivers (UserList receivers) Setzt die Empfänger anhand der Nutzerliste. void setpeer (const ost::ipv4address ip= , ost::tpport port=0) Setzt die IP und den Port aus einer empfangenen Nachricht. void setreceivedtime (timet time) Gibt die Zeit wenn die Nachricht angekommen ist.

23 Entwicklerdokumentation 3 RESULTIERENDE SOFTWAREARCHITEKTUR Schnittstelle Aufgabenbeschreibung /S30/: Message Operation Beschreibung bool issignaturevalid (RSA *pubkey) Gibt an ob die Signatur korrekt ist. std::string toxml() Konvertiert die Nachricht nach einen XML-String. virtual void fillfromxml (xmldocptr doc, xmlnodeptr node)=0 Generiert eine Nachricht aus einem XML-Dokument. virtual void evaluate (Network network)=0 Evaluiert die Nachricht über das Netz. static Message* fromxml (std::string xml) Kovertiert aus dem XML-String eine Nachricht. static Message* fromxml (xmldocptr doc, xmlnodeptr root) Konvertiert aus dem XML- Dokument eine Nachricht. 23

24 Entwicklerdokumentation 3 RESULTIERENDE SOFTWAREARCHITEKTUR Schnittstelle Aufgabenbeschreibung /S40/: User Operation Beschreibung User (UserManager manager, Konstruktor. std::string id) bool isexistent () Gibt an ob der Nutzer noch im Netz exisitiert. bool ispeer () Gibt an ob der Nutzer direkt erreichbar ist. std::string getid () Gibt die ID des Nutzers zurück. std::string getgreeting () Gibt das Greeting zurück. int getversion () Gibt die Version zurück. void setgreeting (const std::string Setzt das Greeting. greeting) void setversion (int version) Setzt die Version. timet lastseen () Gibt den letzten Zeitpunkt zurück, an dem eine HELLOmessage empfangen wurde. void seendirect () Zeigt an, dass eine HELLOmessage empfangen wurde. void seenindirect () Zeigt an, dass eine ROUTINGmessage empfangen wurde. timet lastaskedforcert () Zeigt an, wann das letzte mal nach dem Zertifikat gefragt wurde. void askedforcert () Zeigt an, dass gerade nach dem Zertifikat gefragt wurde. bool haspublickey () Zeigt an, ob der Schlüssel eines anderen Nutzers bekannt ist. RSA* getpublickey () Gibt den Schlüssel eines anderen Nutzers zurück. 24

25 Entwicklerdokumentation 3 RESULTIERENDE SOFTWAREARCHITEKTUR Schnittstelle Aufgabenbeschreibung /S50/: Event Operation Beschreibung Event (Type type, const ChatMessage msg) Konstruktor für eine Chatmessage. Event (Type type, const NAckMessage msg) Konstruktor für eine NAck- message- Event (Type type, const ChannelPtr chn, const UserPtr user) Konstruktor für einen Kanal und einen Nutzer. Event (Type type, const ChannelPtr chn) Konstruktor nur für einen Kanal. Event (Type type, const UserPtr user) Konstruktor nur für einen Nutzer. Event (const Event right) Konstruktor. Event operator=(const Event right) Type gettype() Gibt den Typ zurück. ChatMessage* getmessage() Gibt eine Nachricht vom Typ ChatMessage zurück. NAckMessage* getnack() Gibt eine NAck-message zurück. ChannelPtr getchannel() Gibt den Kanal zurück. UserPtr getuser() Gibt den Nutzer zurück. 25

26 Entwicklerdokumentation 3 RESULTIERENDE SOFTWAREARCHITEKTUR Schnittstelle Aufgabenbeschreibung /S60/: Crypt Operation Beschreibung CertificateManager (const std::string Konstruktor basepath, std::string rootcert) std::string add (X509 *cert) Fügt ein neues X509-Zertifikat hinzu und gibt die ID zurück. std::string addfile (std::string certfile) Fügt ein X509-Zertifikat aus der Datei hinzu. std::string addmem (std::string certstring) Fügt ein X509-Zertifikat hinzu mit Base64 DER String. bool setprivatekey (std::string keyfile) Verifiziert die Signatur von key- File mit RSA key. bool save() Speichert alle Zertifikate im angegebenen Ordner. bool load() Lädt abgespeicherte Zertifikate. bool haspublickey (const std::string id) Überprüft ob der Schlüssel des Nutzers bereits vorhanden ist. RSA* getpublickey (const std::string id) Gibt den öffentlichen Schlüssel des Nutzers im RSA-Format wieder. RSA* getprivatekey() Gibt den privaten Schlüssel std::string getcertificate (const std::string id) zurück. Gibt das Zerifikat des Nutzers im PEM-Format zurück. Schnittstelle /S70/: Routing- Table Aufgabenbeschreibung Operation Beschreibung RoutingTable (Network network) void update (const Message *msg) PeerAddr findroute (const std::string destination, unsigned int offset) void purge() Konstruktor Aktualisiert die Routing Informationen entsprechend des Nachrichtentyps. Findet den Peer an den die Nachricht geschickt werden soll. Purger. 26

27 Entwicklerdokumentation 3 RESULTIERENDE SOFTWAREARCHITEKTUR Schnittstelle Aufgabenbeschreibung /S80/: Network Operation Beschreibung Network (const std::string certbase, Konstruktor const std::string rootcert, const std::string usercert, const std::string privkey, ost::tpportt port=8888) UserPtr getlocaluser() Gibt den lokalen Benutzer zurück. Udp* getudp () Gibt Udp zurück. ChannelManager* Gibt den ChannelManager getchannelmanager() zurück. RoutingTable* getroutingtable() Gibt die RoutingTable zurück. UserManager* getusermanager() Gibt den UserManager zurück. EventManager* geteventmanager() Gibt den EventManager zurück. CertificateManager* getcertificatemanager() Gibt den CertificateManager zurück. void getinfrastructure(bool on) Schaltet den Infrastrukturmodus an und aus. 3.3 Protokolle für die Benutzung der Komponenten Es ist nicht sinnvoll, die Komponenten wiederzuverwenden, da sie zu sehr an das Protokoll und MAdChat angepasst sind. 27

28 Entwicklerdokumentation 4 VERTEILUNGSENTWURF 4 Verteilungsentwurf Auf jedem Knoten läuft im Ad-Hoc Betrieb jeweils eine Instanz von MAdChat, die sich wiederum der Bibliothek bedient um mit anderen Knoten zu kommunizieren. Die einzelnen Instanzen können jeweils andere Front-Ends nutzen, wie zum Beispiel ncmadchat, ein mögliches ncurses-front-end. Abbildung 28: Verteilungsentwurf 28

29 Entwicklerdokumentation 5 ERFÜLLUNG DER KRITERIEN 5 Erfüllung der Kriterien 5.1 Musskriterien Die folgenden Kriterien sind unabdingbar und müssen durch das Produkt erfüllt werden: Das Netz /M30/ Ein Peer speichert die Nachrichten für einen Client, der momentan nicht erreichbar ist, zwischen Peer wiederholt senden, wenn Zielclient wieder in Routingtabelle oder sendet NACK zurück bei Ablauf der TTL /M40/ Das Netz besteht aus beliebig vielen Kanälen Erfüllung durch dynamische Datenstrukturen zur Speicherung der Kanaldaten /M50/ Zwei Netze, die durch mindestens einen Client verbunden sind, werden zusammengeführt Verbindungsclient übermittelt Routinginformationen des einen Netzes an das Andere und vice versa Kanäle /M100/ Es existiert ein permanenter Kanal zur anonymen Unterhaltung, in dem sich alle Clients des Netzes befinden Kanal ist Standardkanal bei Start des Programms und wird realisiert durch eine eigene Klasse /M110/ Es gibt zusätzlich zwei Arten von Kanälen: offene und geschlossene Realisierung durch zwei verschiedene Klassen, eine mit und die andere ohne Verschlüsselungsfunktionen /M120/ Die Gesamtzahl der Kanäle ist nicht begrenzt Erfüllung durch dynamische Datenstrukturen zur Verwaltung der Kanäle /M130/ Jeder Kanal hat einen Namen und eine eindeutige ID Name vom Ersteller gegeben und ID wird automatisch generiert. /M140/ Jeder Chatteilnehmer in einem Kanal erhält die Nachricht, die ein anderer Chatteilnehmer an diesen Kanal gesendet hat Empfängerliste der Nachricht ist gleich der Teilnehmerliste des Kanals. Aufteilung in Einzelnachrichten anhand der Routingtabelle (Wer ist über welchen Peer erreichbar). Es gibt allerdings eine Situation in der dies nicht gewährleistet werden kann. Wenn sich gerade zwei Teilnetze verbunden haben und es in beiden einen öffentlichen Kanal mit gleichem Namen gibt (die ja dann zusammengefügt werden), kann es in der Phase, in der noch nicht alle Teilnehmer des Kanals über die neuen Mitlgieder informiert sind dazu kommen, dass nicht alle wirklichen Mitglieder des Kanals eine Nachricht erhalten. Das Verhalten ist allerdings konsistent zu der GUI, alle Teilnehmer, die bei einem Client angezeigt werden, werden auch die Nachricht bekommen 29

30 Entwicklerdokumentation 5 ERFÜLLUNG DER KRITERIEN /M150/ Werden Netze zusammengeführt und es existieren offene Kanäle mit dem selben Namen, so werden diese verschmolzen Die Teilnehmerlisten der beiden namensgleichen Kanäle werden vereint. Dies wird unter anderem über die CHANNEL Nachrichten erreicht, als auch über MESSAGE Nachrichten, die an diesen Kanal gehen und mehr/andere Empfänger haben als der Kanal (dies ist mit ein Zeichen, dass sich zwei identische Kanäle im Netz befinden) /M160/ Geschlossene Kanäle werden nicht verschmolzen Die Kanäle werden getrennt weiterverwaltet, da dies über die ID und nicht über den Namen geschieht. Nutzer des einen Netzes haben für gewöhnlich nicht die Absicht, Mitglied des geschlossenen Kanals des anderen Netzes zu sein. Für den Fall, dass ein Nutzer nach dem zusammenfügen der beiden Netze auch in beiden Kanälen ist (also wenn er auch in den anderen eingeladen wurde), so werden die Kanäle in der Benutzerschnittstelle durch ein künstliches Suffix auseinandergehalten. /M170/ Geschlossene Kanäle sind mit einem Schlüssel gesichert Die Nachrichten werden mit diesem Schlüssel verschlüsselt, so dass nur Mitglieder des Kanals mit diesem Schlüssel, diese entschlüsseln können. Diese Schlüssel werden beim erstellen eines geschlossenen Kanals erstellt und können danach nicht mehr verändert werden. Chatteilnehmer /M200/ Der Chatteilnehmer hat einen Namen und eine eindeutige ID Der Name kann von jedem Nutzer selbst gewählt werden. Die ID wird durch das vom IBR ausgestellte Zertifikat gegeben /M210/ Die Kommunikation der Chatteilnehmer untereinander erfolgt ausschließlich über Kanäle Ist der Chatteilnehmer Mitglied in einem Kanal, wird nach /M140/ fortgefahren. Ist er kein Mitglied, kann er keine Nachrichten senden /M220/ Der Chatteilnehmer kann einen neuen Kanal erstellen, einem vorhandenen beitreten oder ihn verlassen Wird ein neuer Kanal erstellt tritt der Teilnehmer automatisch ihm bei und es werden CHANNEL Nachrichten ins Netz gesendet um die Existenz eines neuen Kanals bekannt zu machen. Will er einen Vorhandenen erstellen, wird er automatisch diesem beitreten, es sei denn es ist ein geschlossener Kanal. Verlassen kann er nur einen offenen Kanal. Geschlossene bleiben solange bestehen, bis alle Mitglieder offline sind und damit der Schlüssel verschwindet. All dies wird durch die Modifizierung der CHANNEL Nachrichten erreicht /M240/ Der Chatteilnehmer kann in mehreren Kanälen gleichzeitig sein Der Client zeigt für jeden Kanal einen Tab an, zwischen denen der Nutzer wechseln kann, um im jeweils aktiven Kanal Nachrichten zu schreiben. Intern wird eine Datenstruktur über den User geführt, in der auch alle Kanäle vermerkt sind, in denen er Mitglied ist 30

31 Entwicklerdokumentation 5 ERFÜLLUNG DER KRITERIEN /M250/ Ein beliebiger Chatteilnehmer eines geschlossenen Kanals verwaltet dessen Schlüssel Dieser Chatteilnehmer antwortet auf die Schlüsselanfragen von außenstehenden Nutzern, die beitreten wollen und sendet, falls genehmigt, den Schlüssel an den außenstehenden Nutzer Nachrichten /M300/ Nachrichten werden Hop-by-Hop im Netz weitergeleitet Mithilfe der Routingtabelle wird immer der möglichst beste Peer, über den eine Nachricht zum Endziel gelangt, ausgewählt. Zusätzlich wird überprüft ob man immer wieder die selbe Nachricht weiterleiten soll. Wenn dies nämlich der Fall ist muss eine andere Route gefunden werden (vgl. /M20/) /M310/ Nachrichten in geschlossenen Kanälen werden verschlüsselt übertragen Verschlüsselt erfolgt symmetrisch mit Hilfe des Kanalschlüssels, der beim Erstellen des Kanals ebenfalls erstellt wurde /M320/ Nachrichten die nicht zugestellt werden konnten, werden zwischengespeichert und später übertragen Regelmäßige Überprüfung der Routingtabelle, ob das Ziel erreichbar ist. Nach Ablauf der TTL wird ein NACK zurückgesendet und die Nachricht verworfen /M330/ Nachrichten an den anonymen Kanal werden nach dem Zwiebelprinzip anonymisiert Mehrfachverschlüsselung der Nachricht an eine Reihe von Empfängern, die diese nacheinander entschlüsseln, bevor sie beim Ziel ankommt, welches sie dann im Netz flutet (an alle erreichbaren Teilnehmer sendet). So ist eine Rückverfolgung sehr unwahrscheinlich /M340/ Nachrichten können sowohl Text als auch Binärdaten enthalten Falls ein Benutzer einen Anhang (Text- oder Binärdatei) auswählt, wird dieser im Base64 Format in die Nachricht eingebaut. Dabei ist die maximale Nachrichtengröße von Byte zu beachten /M350/ Verzögerte Nachrichten werden dem Chatteilnehmer besonders angezeigt und in den Kontext eingeordnet Hervorhebung der später eingehenden Nachricht, sowie einen Hinweis auf deren Eingang 5.2 Wunschkriterien Die Erfüllung folgender Kriterien für das abzugebende Produkt wird angestrebt: /W10/ Eine Liste von Chatteilnehmern, deren Nachrichten man nicht erhalten möchte (ignore list) Nachrichten von Nutzern auf der Liste werden verworfen und nicht angezeigt. Nicht möglich im anonymen Kanal 31

32 Entwicklerdokumentation 5 ERFÜLLUNG DER KRITERIEN /W30/ Der Chatteilnehmer erhält Statusinformationen über das Netz in dem er sich befindet Daten, die der Client speichert und verwaltet, werden dem Nutzer auf geeignete Weise angezeigt 5.3 Abgrenzungskriterien Folgende Funktionalität wird nicht durch das Produkt, sondern wie folgt beschrieben anderweitig erfüllt: /A10/ Der Chatteilnehmer muss eigenständig die Konfiguration seiner Hardware übernehmen Einstellung der Funknetzwerkkarte auf Ad-Hoc Modus bzw. eintragen der Peers in die Liste für den Infrastrukturmodus 32

33 Entwicklerdokumentation 6 IMPLEMENTIERUNGSENTWURF 6 Implementierungsentwurf 6.1 Gesamtsystem Abbildung 29: Komponenten von MAdChat Erläuterung: MAdChat besteht aus madchat (dem Front-End mit GUI) und libmadchat. Das Front-End ist nur dafür verantwortlich, mit dem Nutzer zu interagieren, während alles, was das Chatprotokoll betrifft, Aufgabe der Library ist. Die einzelnen Komponenten von libmadchat sind UDP, Channel, Message, User, Event, Crypt, RoutingTable und Network. 33

34 Entwicklerdokumentation 6 IMPLEMENTIERUNGSENTWURF 6.2 Implementierung der Komponente S10: UDP Die Komponente UDP kümmert sich um die einzelnen UDP-Pakete Klassendiagramm Abbildung 30: Klassendiagramm - UDP 34

35 Entwicklerdokumentation 6 IMPLEMENTIERUNGSENTWURF Klasse UDP Erläuterungen: Durch diese Klasse kann die Klasse Network UDP-Pakete empfangen und versenden. Da das direkt geschieht, ohne auf das Chatprotokoll zu beachten, haben andere Klassen oder gar das Front-End kein Zugriff darauf. Notwendige Attribute mutexin : ost::mutex mutexout : ost::mutex network : Network broadcast : ost::udpbroadcast socketin : ost::udpsocket socketout : ost::udpsocket port : ost::tpport t localpeer : PeerAddr localhostname : std::string recbuf [63000] : char inframode : Infrastructure receivedids : SharedSearchRingBuffer< std::string, 1000 > receivedanon : SharedSearchRingBuffer< std::string, 10 > awaitingkey : SharedList< Message * > listener : MAdChat::Udp::Listener * sendhellos : MAdChat::Udp::SendHellos * sender : MAdChat::Udp::Sender * 35

36 Entwicklerdokumentation 6 IMPLEMENTIERUNGSENTWURF Aufgabe Aufgaben-ID Name der Aufgabe Beschreibung - Udp(Network &network, ost::tpport t Konstruktor der Klasse UDP. port=8888) F40 send(message&msg, Sendet eine Nachricht vom Typ Message ost::ipv4address ip, ost::tpport t an die angegebene IP. port=8888) - broadcast(message &msg) Sendet eine Nachricht an alle Benutzer im Netz. - receive() : Message Empfängt eine Nachricht. - getinfrastructure() : Infrastructure Gibt ein Objekt vom Typ Infrastructure zurück. - getlocalhostname() : std::string Gibt den Namen des lokalen Host zurück. - setlocalpeer(const PeerAddr peer) Setzt die Adresse des lokalen Peers. F40 queueforsending(message *msg) Reiht eine Nachricht zum Senden ein. - start() Startet das Senden von HELLOmessages sowie den Listener und Sender. - send(ost::udpsocket *udpsocket, Interne Funktion zum Senden eines const std::string &str) Strings über einen UDPSocket. - nack(message *msg) Ablehnung einer Nachricht. Notwendige Kommunikationspartner Name der Klasse Network Message NAckMessage ObscureMessage Dauerhaft? Klasse Listener Erläuterungen: Die Klasse Listener fragt ständig nach neuen Nachrichten und evaluiert diese. Notwendige Attribute parent : Udp * 36

37 Entwicklerdokumentation 6 IMPLEMENTIERUNGSENTWURF Aufgabe Aufgaben-ID Name der Aufgabe Beschreibung - Listener(Udp &parent) Der Konstruktor der Klasse. - run() Funktion zum starten des Listener. Notwendige Kommunikationspartner Name der Klasse Udp Dauerhaft? ja Klasse Sender Erläuterungen: Die Klasse Sender reiht Nachrichten zum Senden in eine Liste ein. Notwendige Attribute parent : Udp * sendqueue : SharedQueue< Message * > awaitingack : SharedMultiMap< std::string, Message * > Aufgabe Aufgaben-ID Name der Aufgabe Beschreibung - Sender(Udp &parent) Konstruktor der Klasse. - run() Funktion zum Starten. - queuemessage(message *msg) Reiht die Nachricht zum Senden ein. Notwendige Kommunikationspartner Name der Klasse Udp Dauerhaft? Klasse SendHellos Erläuterungen: Diese Klasse ist für das ständige Versenden von HELLO-messages zuständig. Notwendige Attribute parent : Udp * id : std::string 37

38 Entwicklerdokumentation 6 IMPLEMENTIERUNGSENTWURF Aufgabe Aufgaben-ID Name der Aufgabe Beschreibung - SendHellos (Udp &parent, const std::string &id) Konstruktor der Klasse. - run() Startet das Senden von HELLOmessages. Notwendige Kommunikationspartner Name der Klasse Udp Dauerhaft? 38

39 Entwicklerdokumentation 6 IMPLEMENTIERUNGSENTWURF 6.3 Implementierung der Komponente S20: Channel In der Komponente Channel sind die Klassen für die Repräsentation von öffentlichen, privaten und dem anonymen Kanal enthalten. Sie ist Teil der Bibliothek Klassendiagramm Abbildung 31: Klassendiagramm - Channel 39

40 Entwicklerdokumentation 6 IMPLEMENTIERUNGSENTWURF Klasse Channel Erläuterungen: Kapselt die Eigenheiten eines generischen Kanals. Von ihr werden die Klassen PublicChannel, PrivateChannel und AnonymChannel abgeleitet und spezialisiert. Notwendige Attribute mutex : ost::mutex manager : ChannelManager * nochannel : bool name : std::string id : std::string keytype : KeyType key : std::string members : UserList * waitingconfirm : UserList * lastchn : time t existent : bool keytypenames [] : static const char * 40

41 Entwicklerdokumentation 6 IMPLEMENTIERUNGSENTWURF Aufgabe Aufgaben-ID Name der Aufgabe Beschreibung - Channel(ChannelManager &manager, Konstruktor der Klasse. const std::string &na- me, const std::string &id, const std::string &key=, KeyType keytype=key NOKEY) - isexistent() Gibt Kanel zurück falls dieser noch im Netz ist. - getname() Gibt den Kanalnamen zurück. - getid() Gibt die KanalID zurück. - getkeytype() Gibt den Schlüsseltyp zurück. - getkey() Gibt den Schlüssel zurück. F60 getmembers() Überprüft, ob der User mit der angegeben ID in dem Kanal Mitglied ist. Wenn ja wird dieses Mitglied zurückgegeben. - getlastchannel() Gibt Wert zurück wenn die letzte CHANNEL-message erhalten wurde. - getnochannel() Gibt an ob eine CHANNEL-message gesendet werden konnte oder nicht. - setkey(const std::string &key, KeyType Setzt Schlüssel vom Typ KeyType. type) - setkey(const std::string &key, const Setzt Schlüssel. std::string &type) - empty() Gibt zurück ob im Kanal Nutzer sind. - hasmember(const std::string &id) Gibt an ob der Nutzer im Kanal ist. - receivedchannel() CHANNEL-message wurde empfangen. F11 join() Betrete den Kanal. F12 leave() Verlasse den Kanal. - confirmjoin(const UserPtr &user) Bestätigt den Beitritt eines anderen Nutzers. F40 send(chatmessage &msg) Sendet eine Nachricht im aktuellen Kanal. - createchannelmessage() Erzeugt eine CHANNEL-message. - getkeytype(const std::string &type) Gibt den Schlüsseltyp im String zurück. - getkeytype (KeyType type) Gibt den Schlüssel als String zurück. - sendinternal(channeledmessage &msg) Interne Methode zum Senden von Nachrichten. 41

42 Entwicklerdokumentation 6 IMPLEMENTIERUNGSENTWURF Notwendige Kommunikationspartner Name der Klasse ChannelManager UserManager JoinMessage LeaveMessage Dauerhaft? Klasse ClosedChannel Erläuterungen: Repräsentiert einen geschlossenen Kanal.Ein geschlossener Kanal hat einen Schlüssel, mit dem die Übertragungen verschlüsselt werden. Notwendige Attribute keine Aufgabe Aufgaben-ID Name der Aufgabe Beschreibung - ClosedChannel(ChannelManager Konsruktor der Klasse. &manager, const std::string &name, const std::string &id, const std::string &key=, KeyType keytype=key NOKEY) F21 join() Funktion zum Beitreten eines geschlossenen Kanals. - leave() Verlässt den Kanal. - confirmjoin(const UserPtr &user) Bestätigt ein Beitrittsversuch eines anderen Nutzers. F40 send(chatmessage &msg) Sendet eine verschlüsselte Nachricht innerhalb des Kanals. - createchannelmessage() Generiert eine CHANNEL-message. - merge(userlist &users, const Private Funktion. std::string &id=) - join(const JoinMessage &msg) Private Funktion, die eine JOINmessage verarbeitet. - leave(const LeaveMessage &msg) Private Funktion, die eine LEAVEmessage verarbeitet. Notwendige Kommunikationspartner Name der Klasse ChannelManager Dauerhaft? 42

43 Entwicklerdokumentation 6 IMPLEMENTIERUNGSENTWURF Klasse PublicChannel Erläuterungen: Die Klasse PublicChannel repräsentiert einen offenen Kanal innerhalb des Netzes. Notwendige Attribute keine Aufgabe Aufgaben-ID Name der Aufgabe Beschreibung - PublicChannel(ChannelManager Der Konstruktor. &manager, const std::string &name, const std::string &id) F10 join() Betritt einen öffentlichen Kanal. F12 leave() Verlassen eines öffentlichen Kanals. F40 send(chatmessage &msg) Senden einer Nachricht innerhalb des Kanals. - createchannelmessage() Generiert eine CHANNEL-message. - merge(userlist &users, const Private Funktion, die zwei Kanäle zusammfügt. std::string &id=) - join(const JoinMessage &msg) Private Funktion, die eine JOINmessage verarbeitet. - leave(const LeaveMessage &msg) Private Funktion, die eine LEAVEmessage verarbeitet. Notwendige Kommunikationspartner Name der Klasse ChannelManager Dauerhaft? ja Klasse AnonymousChannel Erläuterungen: Diese Klasse beinhaltet die Funktionen für den anonymen Kanal. Notwendige Attribute keine 43

44 Entwicklerdokumentation 6 IMPLEMENTIERUNGSENTWURF Aufgabe Aufgaben-ID Name der Aufgabe Beschreibung - AnonymousChannel(ChannelManager Der Konstruktor. &manager) F40 send(chatmessage &msg) Sendet Nachrichten innerhalb des Kanals. - createchannelmessage() Generiert eine CHANNEL-message. - merge(userlist &users, const Vereinigt zwei anonyme Kanäle. std::string &id=) - join(const JoinMessage &msg) Private Funktion, die eine JOINmessage verarbeitet. - leave(const LeaveMessage &msg) Private Funktion, die eine LEAVEmessage verarbeitet. Notwendige Kommunikationspartner Name der Klasse ChannelManager Dauerhaft? Klasse ChannelManager Erläuterungen: Der ChannelManager verwaltet die einzelnen Kanäle im Netz. Notwendige Attribute network : Network * channels : ChannelList nametoids : IdList anonchn : ChannelPtr sendchn : MAdChat::ChannelManager::SendChannel * 44

45 Entwicklerdokumentation 6 IMPLEMENTIERUNGSENTWURF Aufgabe Aufgaben-ID Name der Aufgabe Beschreibung - ChannelManager(Network &network) Der Konstruktor. - getchannels() Gibt alle bekannten Channels zurück. - getchannelbyid(const std::string Findet einen Kanal anhand der ID. &id) F10 createchannel(const std::string &name, bool closed, UserList &members) Erstellt einen Kanael mit vorhandenen Nutzern. F10 createchannel(const std::string &name, Erstellt einen Kanal. bool closed) - start() Startet das Senden von CHANNELmessages. - addchannel(const ChannelPtr &chn, UserList &members) Fügt einen vorhandenen Kanal mit seinen Nutzern hinzu. - addchannel(const std::string &name, Fügt einen vorhandenen Kanal hinzu. const std::string &id, bool closed, UserList &members) - delchannel(const ChannelPtr &chn) Löscht einen Kanal. - send(channeledmessage &msg) Sendet eine Nachricht vom Typ ChanneledMessage. - addchannel(const ChannelPtr &chn) Einfache Funktion zum Hinzufügen von Kanälen. - addchannel(const ChannelMessage Fügt einen Kanal entsprechend einer &msg) CHANNEL-message hinzu. Notwendige Kommunikationspartner Name der Klasse Channel AnonymousChannel PublicChannel ClosedChannel ChannelMessage SendChannel Network Dauerhaft? 45

46 6 IMPLEMENTIERUNGSENTWURF Entwicklerdokumentation 6.4 Implementierung der Komponente S30: Message Die Komponete Message hat die Aufgabe Nachrichten des Systems darzustellen, sie aus den empfangenen XML-Daten zu generieren oder aus ihnen XML-Daten zu generieren und zu validieren Klassendiagramm Abbildung 32: Klassendiagramm - Message 46

47 Entwicklerdokumentation 6 IMPLEMENTIERUNGSENTWURF Klasse Message Erläuterungen: Diese Klasse repräsentiert eine Nachricht die gesendet oder empfangen wurde. Die Klasse Network hat uneingeschränkten Zugriff auf alle Attribute, um protokollspezifische Nachrichten zu generieren. Alle anderen Teile des Systems haben nur eingeschränkten Zugriff auf die Attribute. Von dieser Klasse abgeleitet werden die einzelnen Nachrichtentypen wie sie in der Protokollspezifikation beschrieben wurden: HELLO-message, ACK-message, NACKmessage, GETCERTIFICATE-message, CERTIFICATE-message, ROUTING-message und OBSCUREmessage. Notwendige Attribute type : Type id : std::string ttl : unsigned int delay : unsigned int ownsignature : bool signtype : SignType signature : std::string unknownsigntype : std::string sender : std::string receivers : std::list< std::string > peer : PeerAddr receivedtime : time t idcount: static int signtypenames [] : static const char * 47