Softwareentwicklungspraktikum Sommersemester Pflichtenheft

Transkript

1 Ad-hoc Chatsystem für Mobile Netze Gruppe 4 Softwareentwicklungspraktikum Sommersemester 2007 Pflichtenheft 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: Christoph Peltz 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 Pflichtenheft INHALTSVERZEICHNIS Inhaltsverzeichnis 1 Zielbestimmungen Musskriterien Wunschkriterien Abgrenzungskriterien Produkteinsatz Anwendungsbereiche Zielgruppen Betriebsbedingungen Produktübersicht 6 4 Produktfunktionen öffentliche Kanäle geschlossene Kanäle Kanäle Nachrichten Peerliste Chatteilnehmer Produktdaten 17 6 Produktleistungen 18 7 Qualitätsanforderungen 19 8 Benutzungsoberfläche Struktur Hauptfenster Kanaltab Bildschirmlayout Nichtfunktionale Anforderungen Technische Produktumgebung Software Hardware Orgware Glossar 23 2

3 Pflichtenheft 1 ZIELBESTIMMUNGEN 1 Zielbestimmungen MAdChat ist ein Chatprogramm für Ad-Hoc Netze, dass mehreren Chatteilnehmern erlaubt, sich über mobile Geräte zu unterhalten. Es implementiert das Peer-to-Peer Chatprotokoll nach draft-strauss-p2p-chat-08 1 und legt damit eine Kommuniktionsschicht über das Ad- Hoc Netz. 1.1 Musskriterien Das Netz Kanäle Das Chatnetz besteht aus einer beliebigen Anzahl von Clients. Das Netz leitet Nachrichten dynamisch von einem Client zum nächsten, egal wo diese sich befinden. Das Netz speichert Nachrichten für Clients, die momentan nicht erreichbar sind. Das Netz besteht aus beliebig vielen Kanälen. Zwei Netze, die durch mindestens einen Client verbunden sind, werden zusammengeführt. Es exisitiert ein permanenter Kanal zur anonymen Unterhaltung. Es gibt zwei Arten von Kanälen: offene und geschlossene. Die Gesamtzahl der Kanäle ist nicht begrenzt. Jeder Kanal hat einen eindeutigen Namen und eine eindeutige ID. Jeder Chatteilnehmer in einem Kanal erhält die Nachricht, die ein anderer Chatteilnehmer an diesen Kanal gesendet hat. Werden Netze zusammengeführt und es existieren offene Kanäle mit dem selben Namen, so werden diese verschmolzen. Geschlossene Kanäle werden nicht verschmolzen. Geschlossene Kanäle sind mit einem Schlüssel gesichert. Chatteilnehmer Der Chatteilnehmer hat einen eindeutigen Namen und eine eindeutige ID. Ein Chatteilnehmer kann Nachrichten an Kanäle senden. Der Chatteilnehmer kann einen neuen Kanal erstellen, einem vorhandenen beitreten oder ihn verlassen. Der Chatteilnehmer kann sich mit seinem mobilen Gerät frei bewegen, ohne zu befürchten, dass Nachrichten verloren gehen

4 Pflichtenheft 1 ZIELBESTIMMUNGEN Der Chatteilnehmer kann in mehreren Kanälen gleichzeitig sein. Ein beliebiger Chatteilnehmer eines geschlossenen Kanals verwaltet dessen Schlüssel. Nachrichten Nachrichten werden Hop-by-Hop im Netz weitergeleitet. Nachrichten in geschlossenen Kanälen werden verschlüsselt übertragen. Nachrichten die nicht zugestellt werden konnten, werden zwischengespeichert und später übertragen. Nachrichten an den anonymen Kanal, werden nach dem Zwiebelprinzip anonymisiert. Nachrichten können Anhänge enthalten. Verzögerte Nachrichten werden dem Chatteilnehmer besonders angezeigt und in den Kontext eingeordnet. 1.2 Wunschkriterien Eine Liste von Chatteilnehmern, deren Nachrichten man nicht erhalten möchte (ignore list). Absicherung gegen Attacken gegen das Netz, zum Beispiel Denial-of-Service Attacken. Der Chatteilnehmer erhält Statusinformationen über das Netz in dem er sich befindet. 1.3 Abgrenzungskriterien Der Chatteilnehmer muss eigenständig die Konfiguration seiner Hardware übernehmen. 4

5 Pflichtenheft 2 PRODUKTEINSATZ 2 Produkteinsatz 2.1 Anwendungsbereiche MadChat liefert dem Anwender die Möglichkeit, ohne vorhandene Infrastruktur, jederzeit und überall mit anderen Anwendern in Verbindung zu treten um mit ihnen zu kommunizieren und/oder Daten auszutauschen. 2.2 Zielgruppen Benutzer von mobilen Endgeräten, welche den Hardwareansprüchen genügen und die Interesse an einem dynamisch wachsenden Netz haben. 2.3 Betriebsbedingungen Das Netz bzw. die Netze sind in ihrer Topologie flexibel und entstehen, wann immer mehrere Knoten aufeinandertreffen und zerfallen, sobald sich Knoten von ihm wieder entfernen. Betriebsdauer: täglich, 24 Stunden Wartungsfrei 5

6 Pflichtenheft 3 PRODUKTÜBERSICHT 3 Produktübersicht Offenen Kanal erstellen {abstract} Kanal erstellen Geschlossenen Kanal erstellen Chatteilnehmer auflisten <<includes>> Benutzer Kanaele auflisten <<includes>> Offenen Kanal verlassen Offenem Kanal beitreten {abstract} Kanal beitreten Geschlossenem Kanal beitreten Der Benutzer kann alle im Netz vorhandenen Benutzer, sowie im Netz vorhandene Kanäle auflisten. Ebenso kann er einen neuen Kanal erstellen und ihm beitreten, bzw. einem vorhanden beitreten. Dabei wird aufgrund der Verschlüsselung zwischen Offenen und Geschlossenen unterschieden. Falls gewünscht, kann man einen offenen Kanal auch wieder verlassen. Nachricht senden Benutzer Nachricht empfangen Mitglieder auflisten In jedem Kanal, in dem sich der Benutzer findet, kann er eine Nachricht an die anderen Benutzer im Kanal senden, die Nachrichten der anderen Benutzer empfangen und sich einen Überblick darüber verschaffen, wer sich in diesem Kanal befindet. 6

7 Pflichtenheft 3 PRODUKTÜBERSICHT Peerliste aktivieren Benutzer Peerliste deaktivieren Peer hinzufuegen Peer entfernen Für den Testbetrieb ist es dem Benutzer möglich eine Peerverwaltung zu verwenden, um so das Ad-Hoc Netz zu simulieren. 7

8 Pflichtenheft 4 PRODUKTFUNKTIONEN 4 Produktfunktionen 4.1 öffentliche Kanäle /F10/ Geschäftsprozess: öffentlichen Kanal erstellen Ziel: Der Nutzer erstellt einen öffentlichen Kanal mit angegebenen Namen. Nachbedingung Erfolg: Der öffentliche Kanal wurde erstellt und den anderen Teilnehmern bekannt gemacht. Nachbedingung Fehlschlag: Der öffentliche Kanal wurde nicht erstellt und dem Nutzer wird eine Fehlermeldung ausgegeben. Auslösendes Ereignis: Eingabe des Nutzers. 1 Testen, ob es bereits solch einen Kanal gibt, wenn ja wird /F11/ ausgeführt und dann mit 3 weitergemacht. 2 Kanal wird erstellt und /F11/ wird ausgeführt. 3 Kanal den anderen Chatteilnehmern bekannt machen. /F11/ Geschäftsprozess: öffentlichem Kanal beitreten Ziel: Der Nutzer tritt dem spezifizierten öffentlichen Kanal bei. Außerdem existiert der gewünschte Kanal. Nachbedingung Erfolg: Der Nutzer ist nun auf der Mitgliederliste des gewünschten Kanals und kann über ihn Nachrichten schreiben und empfangen. 8

9 Pflichtenheft 4 PRODUKTFUNKTIONEN Nachbedingung Fehlschlag: Der Nutzer konnte der Mitgliederliste nicht hinzugefügt werden und ist somit nicht dem Kanal beigetreten. Auslösendes Ereignis: Befehl des Nutzers 1 Der Nutzer gibt den Kanal an, dem er beitreten möchte. 2 Es wird versucht den Nutzer zur Mitgliederliste hinzuzufügen. 3 Die neue Besetzung des Kanals wird den anderen Chatteilnehmern bekannt gemacht. /F12/ Geschäftsprozess: öffentlichen Kanal verlassen Ziel: Der Nutzer verlässt einen spezifizierten öffentlichen Kanal. Außerdem ist er Mitglied eines öffnetlichen Kanals. Nachbedingung Erfolg: Der Nutzer ist aus einem öffentlichen Kanal ausgetreten, erhält also keine Nachrichten mehr über ihn. Nachbedingung Fehlschlag: Der Nutzer konnte nicht aus der Mitgliederliste des öffentlichen Kanals entfernt werden und ist somit immernoch in dem Kanal vertreten. Auslösendes Ereignis: Befehl des Nutzers. 1 Der Nutzer wird aus der Mitgliederliste des Kanals entfernt. 2 Die neue Besetzung des Kanals wird den anderen Chatteilnehmern bekannt gemacht. 9

10 Pflichtenheft 4 PRODUKTFUNKTIONEN 4.2 geschlossene Kanäle /F20/ Geschäftsprozess: geschlossenen Kanal erstellen Ziel: Der Nutzer erstellt einen geschlossenen Kanal mit angegebenen Namen. Der angegebene Kanal existiert noch nicht. Nachbedingung Erfolg: Der geschlossene Kanal wurde eröffnet, ein Schlüssel wurde für diesen erstellt und den anderen Teilnehmern wurde der Kanal bekannt gemacht. Nachbedingung Fehlschlag: Der geschlossene Kanal wurde nicht erstellt und dem Nutzer wird eine Fehlermeldung ausgegeben. Auslösendes Ereignis: Eingeabe des Nutzers. 1 Testen, ob es bereits solch einen Kanal gibt, wenn ja dann ist die Erstellung fehlgeschlagen. 2 Kanal erstellen, Schlüssel erstellen und dem Kanal beitreten (/F21/). 3 Kanal den anderen Chatteilnehmern bekannt machen. /F21/ Geschäftsprozess: geschlossenem Kanal beitreten Ziel: Der Nutzer tritt einen privaten Kanal mit angegebenen Namen bei. Außerdem wurde er in den Channel eingeladen oder besitzt dessen Schlüssel. Nachbedingung Erfolg: Der Nutzer besitzt nun den Schlüssel zu dem privaten Kanal und kann nun in diesem Kanal Nachrichten empfangen und senden. Nachbedingung Fehlschlag: Der Nutzer konnte den Schlüssel für den privaten Kanal nicht erhalten und ihm wird eine Fehlermeldung ausgegeben. 10

11 Pflichtenheft 4 PRODUKTFUNKTIONEN Auslösendes Ereignis: Hinzufügen des Nutzers zu einem privaten Kanal durch einen anderen Nutzer. Erstellung eines solchen privaten Kanals (/F20/) 1 Nutzer A fügt Nutzer B in die Liste für Kanal C ein. 2 Nutzer B hat durch eine CHANNEL Meldung erkannt, dass er eingeladen wurde. Er fordert den Schlüssel für C von A an. 3 B hat den Schlüssel erhalten und tritt damit C bei. 4.3 Kanäle /F30/ Geschäftsprozess: Kanäle auflisten Ziel: Der Nutzer erhält eine Liste von verfügbaren Kanälen. Nachbedingung Erfolg: Der Nutzer hat die Liste der Kanäle erhalten. Nachbedingung Fehlschlag: Der Nutzer hat die Liste nicht erhalten. Auslösendes Ereignis: Befehl des Nutzers 1 Alle Kanäle, die MAdChat mithilfe der CHANNEL Meldungen bekannt gemacht wurden, werden dem Nutzer angezeigt. /F31/ Kanaldaten KanalID (eindeutig) 11

12 Pflichtenheft 4 PRODUKTFUNKTIONEN Kanalname Teilnehmerliste KanalTyp (offen oder geschlossen) Schlüssel (falls geschlossen) 4.4 Nachrichten /F40/ Geschäftsprozess: Nachrichten schreiben Ziel: Der Nutzer schreibt eine Nachricht in einem Kanal und die anderen Chatteilnehmer empfangen sie. Nachbedingung Erfolg: Alle Empfänger haben die Nachricht erhalten. Nachbedingung Fehlschlag: Die Nachricht hat nur einige oder keinen Empfänger erreicht. Auslösendes Ereignis: Befehl des Nutzers 1 Die Nachricht des Nutzers erstellt, signiert und dann hop-by-hop zu den Empfängern übertragen. Wenn die Nachricht in dem anonymen Kanal versendet wird, so wird sie nach dem Zwiebelprinziep verpackt und verschlüsselt und der Reihe nach an verschiedene Peers weitergeleitet. 2 Der Empfänger validiert erstmal die Syntax der Nachricht, dann die Signatur und zeigt sie am Ende dem Nutzer an. /F41/ Nachrichtendaten NachrichtenID (eindeutig) NachrichtenTyp (Hello, ACK, NACK, Channel, Join, Leave, GetKey, Key, Routing, Message, Obscure, GetCertificate, Certificate) 12

13 Pflichtenheft 4 PRODUKTFUNKTIONEN Absender Empfängerliste Zeitstempel Verzögerung TTL Flood Inhalt 4.5 Peerliste /F50/ Geschäftsprozess: Peerliste aktivieren Ziel: Die Peerliste wird aktiviert und danach gelten nurnoch die Knoten als Peers, die in dieser Liste stehen. Nachbedingung Erfolg: Peerliste wurde aktiviert und nur Knoten in der Liste gelten als Peers. Nachbedingung Fehlschlag: Die Peerliste konnte nicht aktiviert werden. Die Peers werden nicht eingeschränkt. Auslösendes Ereignis: Befehl des Nutzers 1 Die Peerliste wird als aktiv gesetzt. 2 Es werden nurnoch diejenigen Knoten als Peers angesehen, die in der Liste stehen. /F51/ Geschäftsprozess: Peerliste deaktivieren 13

14 Pflichtenheft 4 PRODUKTFUNKTIONEN Ziel: Die Peerliste wird deaktiviert und die Einschränkungen aufgehoben. Die Peerliste wurde aktiviert (/F50/). Nachbedingung Erfolg: Die Peerliste konnte deaktiviert werden. Nachbedingung Fehlschlag: Die Peerliste konnte nicht deaktiviert werden. Somit sind die Peers immernoch eingeschränkt. Auslösendes Ereignis: Befehl des Nutzers 1 Die Peerliste wird als nicht aktiv gesetzt. 2 Es werden wieder alle Knoten mit einer direkten Verbindung zum Nutzer als Peers angesehen. /F52/ Geschäftsprozess: Peer hinzufügen Ziel: Ein Peer soll der Liste hinzugefügt werden Nachbedingung Erfolg: Der angegebene Knoten wird von nun an als Peer behandelt. Nachbedingung Fehlschlag: Der Knoten konnte nicht hinzugefügt werden. Auslösendes Ereignis: Befehl des Nutzers 1 Der Knoten, der hinzugefügt werden soll wir abgefragt. 2 Es wird getestet ob am angebenen Knoten ebenfalls ein Chat läuft, wenn nicht wird abgebrochen. 14

15 Pflichtenheft 4 PRODUKTFUNKTIONEN 3 Der Knoten wird nun zur Liste hinzugefügt und gilt fortan als Peer. /F53/ Geschäftsprozess: Peer entfernen Ziel: Ein Peer soll von der Liste entfernt werden. Außerdem ist mindestens ein Peer in der Liste. Nachbedingung Erfolg: Der angegebene Knoten wurde aus der Liste entfernt. Nachbedingung Fehlschlag: Der Knoten ist immernoch in der Liste. Auslösendes Ereignis: Befehl des Nutzers 1 Der Knoten, der entfernt werden soll wird ausgewählt. 2 Der Knoten wird aus der Liste entfernt und ist somit kein Peer mehr. /F54/ Routingdaten (gilt auch für normalen Betriebsmodus) ZielBenutzerID KnotenBenutzerID (des Benutzers, über den der andere Benutzer erreicht werden kann) Entfernung (Sprünge, die man bis zum Zielbenutzer benötigt) 4.6 Chatteilnehmer /F60/ Geschäftsprozess: Alle erreichbaren Teilnehmer auflisten Ziel: Der Nutzer erhält eine Liste von erreichbaren Chatteilnehmern. 15

16 Pflichtenheft 4 PRODUKTFUNKTIONEN Nachbedingung Erfolg: Der Nutzer hat eine Liste mit den erreichbaren Chatteilnehmern erhalten. Nachbedingung Fehlschlag: Der Nutzer hat keine solche Liste erhalten. Auslösendes Ereignis: Befehl des Nutzers 1 Es wird eine Liste von Teilnehmern aus der Routing-Tabelle, in der ja alle erreichbaren Teilnehmer drinstehen, generiert und dem Nutzer angezeigt. /F70/ Benutzerdaten BenutzerID (eindeutig) Benutzername (eindeutig) Kanalliste 16

17 Pflichtenheft 5 PRODUKTDATEN 5 Produktdaten /D10/.509 Zertifikate: BenutzerZertifikat RootZertifikat (des IBR) /D20/ persönliche Einstellungen Diverse Einstellungen der GUI von MAdChat 17

18 Pflichtenheft 6 PRODUKTLEISTUNGEN 6 Produktleistungen /L10/ Ein neuer Knoten in Reichweite wird innerhalb von 3 Sekunden aufgespürt. 18

19 Pflichtenheft 7 QUALITÄTSANFORDERUNGEN 7 Qualitätsanforderungen Produktqualität sehr wichtig wichtig weniger wichtig unwichtig Funktionalität Richtigkeit Interoperabilität Sicherheit Zuverlässigkeit Reife Fehlertoleranz Benutzbarkeit Verständlichkeit Erlernbarkeit Bedienbarkeit Effizienz Verbrauchsverhalten Änderbarkeit Modifizierbarkeit Stabilität Prüfbarkeit Übertragbarkeit Anpassbarkeit Installierbarkeit Verbrauchsverhalten: Verbrauch von Systemressourcen Modifizierbarkeit: Änderung des Quelltextes durch Dritte Prüfbarkeit: Möglichkeit die Programmteile auf korrekte Funktion zu prüfen Anpassbarkeit: Programm an andere Umgebungen anpassen (z.b. Betriebssystem) 19

20 Pflichtenheft 8 BENUTZUNGSOBERFLÄCHE 8 Benutzungsoberfläche 8.1 Struktur Im Folgenden wird die grobe Struktur einer fehlerfreien bzw. konfliktfreien Benutzung des Systems gezeigt. Fehlereingaben haben in der Regel einen Rücksprung auf das Hauptfenster mit einer akkumulierten Fehlermeldung zur Folge Hauptfenster Öffentlichen Kanal erstellen /F10/ Öffentlichem Kanal beitreten /F11/ Kanaltab Privaten Kanal erstellen /F20/ Privatem Kanal beitreten /F21/ Kanaltab Hauptfenster Kanäle auflisten /F30/ Alle erreichbaren Teilnehmer auflisten /F60/ Kanaltab Für jeden Kanal, in dem der Teilnehmer Mitglied ist, existiert ein Kanaltab. Kanaltab Nachricht schreiben /F40/ Öffentlichen Kanal verlassen /F12/ Hauptfenster 8.2 Bildschirmlayout Das Layout richtet sich nach bekannten IRC-Programmen, wie zum Beispiel Chat. Für jeden beigetretenen Kanal öffnet sich ein Tab, das zur Kommunikation innerhalb des Kanals dient. An der rechten Seite des Fenster wird die Mitgliederliste im aktuellen Kanal dargestellt. 20

21 Pflichtenheft 9 NICHTFUNKTIONALE ANFORDERUNGEN 9 Nichtfunktionale Anforderungen /NF10/ Das Produkt ist auf einem Mac und unter Linux lauffähig. /NF20/ Das Produkt ist quelloffen, frei verfügbar und kann immer weitergegeben werden. /NF30/ Das Produkt kann jederzeit weiterentwickelt werden. /NF40/ Die Anzahl der Benutzer ist unbegrenzt. /NF50/ Die Benutzeroberfläche ist intuitiv bedienbar. 21

22 Pflichtenheft 10 TECHNISCHE PRODUKTUMGEBUNG 10 Technische Produktumgebung 10.1 Software Betriebssystem: Linux, Mac OS Fenstersystem: wxwidgets 10.2 Hardware Computer mit Funknetzwerk nach und Grafikbildschirm 10.3 Orgware Netzwerkkarte: Für den Ad-Hoc Betrieb konfiguriert Identifikation: Vom IBR ausgestelltes.509 Zertifikat 22

23 Pflichtenheft 11 GLOSSAR 11 Glossar Peer: Chatteilnehmer, zu dem man eine direkte Verbindung hat Knoten: Ein Chatteilnehmer 23