SingleSignOn Schnittstelle

Transkript

1 SingleSignOn Schnittstelle Integration vom Seminar-Shop mit der Partnerseite unter Verwendung der Seminar-Shop Formulare 1 Grundidee: Eine Website übernimmt den Seminar-Shop Content und wünscht, dass ein User auf seiner Website nur einen Zugangscode benutzen muss, um alle Dienste dieser Website nützen zu können. Die Adressdaten und die Passwortverwaltung sollen auf der Website verbleiben und können von fremden Diensten genutzt werden. Der Kunde soll bei einer Neuregistrierung so wenige Klicks als möglich machen müssen um zum Registrierungsformular zu kommen. Er soll seine Daten nur einmal erfassen müssen. Er soll sich mit seiner Benutzerkennung dort anmelden können, wo es der Dienst erfordert, und danach auch für andere Dienste eingeloggt bleiben. Je nach Dienst ergeben sich dabei folgende Probleme: - Unterschiedliche Struktur der notwendigen Daten - Unterschiedliche Stellen an denen man sich einloggen kann - Übergabe des eingeloggten Zustandes an die Partner Website. - Unterschiedliche Server erfordern unterschiedliche Session IDs - Verlust einer Session bedeutet erneutes einloggen. Im Folgenden wird eine Lösung beschrieben, wie diese Anforderungen in Verbindung mit Seminar-Shop optimal erfüllt werden. Bei der Lösung sind folgende Zustände für einen User zu berücksichtigen: - Der User hat sich auf der fremden Website eingeloggt, geht in den Seminar-Shop und ist dort unbekannt. - Der User hat sich auf der fremden Website eingeloggt, geht in den Seminar-Shop und ist dort bekannt. - Der User verfügt auf der Website über einen persönlichen Zugang und will sich im Seminar-Shop damit anmelden. - Der User verfügt auf der Website über keinen persönlichen Zugang und wird im Seminar-Shop zur Registrierung aufgefordert. Ziel unserer Lösung war es, in diesen Situationen möglichst wenig Verwirrungen zu schaffen, und dennoch allen Anforderungen gerecht zu werden. Als Verbindung zu einem User wird bei der Website und im Seminar-Shop eine GUID (General User ID) verspeichert, die den User auf beiden Seiten eindeutig identifiziert, und dennoch seine Benutzerkennung nur auf dem Server der Website belässt. Seminar-Shop GmbH - Salzburg * SingleSignOn V02.02 Seite 1 von 1

2 2 Ansichtenbeschreibung für den User Login Ansicht: Inkl. Fehlermeldung Erstanmeldungsformular: Abfrage Privatperson / Firma Erstanmeldungsformular: Inkl. Fehlermeldung Nach dem Speichern der Erstanmeldung in Seminar-Shop erfolgt eine Prüfung des Benutzernamens und Passwortes beim Partner. Wenn vorhanden Meldung in ROT dass Benutzer bereits vorhanden ist. Wenn ein Vorschlag für einen gültigen Benutzernamen geliefert wird, wird dieser ebenfalls in der Meldung angezeigt. Bei einem beim Partner bereits eingeloggten Kunden wird die GUID im Link mitgegeben. Dadurch kann der User beim Seminar-Shop gespeichert und anschließend eingeloggt werden. Sollte der Fall eintreten, dass mehrere Daten nicht vorhanden sind, wird der User automatisch auf unserem Erstanmeldungsformular mit den bereits vorhandenen Daten, weitergeleitet (vgl. 4.2 Log-In und 4.3 Direkter Log-In). Seminar-Shop GmbH - Salzburg * SingleSignOn V02.02 Seite 2 von 2

3 3 Voraussetzungen Anforderungen für den Partner: 1. Erstanmeldung (siehe 4.1) 2. Login (siehe 4.2) 3. Direkter Login (siehe 4.3) 4. Passwort vergessen (siehe 4.4) User-Kennung (GUID): Um einen sicheren Datenaustausch zu gewährleisten ist eine eindeutige (beim Partner, wie auch beim Seminar-Shop) User-Kennung notwendig. Diese Kennung ist auch bei allen, schon in der Datenbank befindlichen Usern erforderlich, weil für User die noch nicht im Seminar-Shop eingeloggt waren zur Verfügung stehen muss. Die User-Kennung (GUID) muss vom Partner gespeichert wie auch gewartet werden. Unsere Empfehlung ist z. B.: 3stellige Kennung + 16stellige Zufallszahl. BSP.: GUID=sta0y23gf53s23z67gd Session ID (SID) Damit der User zwischen den beiden Servern seine Informationen nicht verliert und sich wirklich nur einmal einlogen muss, müssen bei jedem Datenaustausch die jeweiligen Session IDs mitgegeben und in der jeweils anderen Session gespeichert werden. BSP: GSID=aee38f3552e03570b8ef2bb0a9776fec für Seminar-Shop und SID=bcf83af6187a19b7f9040c857dcbbd4e für die der Website Voraussetzung für den Datenaustausch: Die Daten müssen von der Website in einer Form bereitgestellt werden, die ein einfaches Abholen der Daten ermöglicht. Die Vorgangsweise des Seminar-Shop ist es, für eine Funktion, die einen angemeldeten Benutzer erfordert, das Anmeldeformular des Seminar-Shops aufzurufen. Nach erfolgter Anmeldung kann der Benutzer die gewünschte Funktion ausführen. Für den Fall, dass die Daten des Benutzers noch nicht in der Seminar-Shop Datenbank gespeichert sind, wird ein vom Partner bereitgestelltes Script aufgerufen, welches die Daten bereitstellt. Vorteile Übernahme der Daten nur wenn es auch notwendig ist. Partner behält die volle Kontrolle über die bereitgestellten Daten. Datenübernahme erfolgt auf Anfrage und kann jederzeit durch den Partner unterbunden werden. Die Datenbank des Partners wird nur vom eigenen Script abgefragt. Kein direkter Zugriff. Individuelle Implementierung für individuelle Situationen auf Partner-Seite möglich! Seminar-Shop GmbH - Salzburg * SingleSignOn V02.02 Seite 3 von 3

4 Datenaustausch mit einem XML Datenformat Anhand des Internet-Standards XML können Daten ausgetauscht werden. Zu diesem Zweck wird vom Seminar-Shop eine DTD bereitgestellt, welche das XML Datenformat bestimmt. Die Spezifikation des Austauschformates sieht vor, dass alle notwendigen Daten ausgefüllt sein müssen, auch mehrere Datensätze übergeben werden können (hier nicht erforderlich), alle wichtigen Zusatzinformationen in Form von Attributen vordefiniert sind. Im folgenden die Definition des Austauschformates in der DTD-Syntax: SingleSignOn-DTD: <!-- Seminar-Shop.com SingleSignOn Version > <!ELEMENT userlist (user*)> <!ATTLIST userlist wsid ID #REQUIRED> <!ELEMENT user (data)> <!ATTLIST user guid ID #REQUIRED> <!ELEMENT data (kundentyp,firmenname1?,firmenname2?,strasse,land,plz,ort,telefon1, telefon2?,handy?,fax?, ,f_ ?,url_homepage?,firmenbuch?,uidnr?,branche?, anrede,akad_titel?,vorname,nachname,position?,datum_erfassung,datum_aenderung)> <!ATTLIST data exists ("true false") #REQUIRED> <!ELEMENT kundentyp ("1 2") #REQUIRED> <!ELEMENT firmenname1 (#PCDATA)> <!ELEMENT firmenname2 (#PCDATA)> <!ELEMENT strasse (#PCDATA)> <!ELEMENT land (#PCDATA)> <!ELEMENT plz (#PCDATA)> <!ELEMENT ort (#PCDATA)> <!ELEMENT telefon1 (#PCDATA)> <!ELEMENT telefon2 (#PCDATA)> <!ELEMENT handy (#PCDATA)> <!ELEMENT fax (#PCDATA)> <!ELEMENT (#PCDATA)> <!ELEMENT f_ ("0 1") #REQUIRED> <!ELEMENT url_homepage (#PCDATA)> <!ELEMENT firmenbuch (#PCDATA)> <!ELEMENT uidnr (#PCDATA)> <!ELEMENT branche (#PCDATA)> <!ELEMENT anrede ("H F") #REQUIRED> <!ELEMENT akad-titel (#PCDATA)> <!ELEMENT vorname (#PCDATA)> <!ELEMENT nachname (#PCDATA)> <!ELEMENT position (#PCDATA)> <!ELEMENT datum_erfassung (#PCDATA)> <!ELEMENT datum_aenderung (#PCDATA)> Seminar-Shop GmbH - Salzburg * SingleSignOn V02.02 Seite 4 von 4

5 Die etwas verständlichere Erläuterung dieser Angabe folgt vorerst in Form eines Musters. Seminar-Partner-XML: <?xml version="1.0" encoding="iso "?> - <userlist wsid="99"> - <user guid="starrk5b492xnmsugcb"> - <data exists="true"> <kundentyp>2</kundentyp> <firmenname1>seminar-shop GmbH</firmenname1> <firmenname2 /> <strasse>ziegeleistrasse 31</strasse> <land>at</land> <plz>5020</plz> <ort>salzburg</ort> <telefon1>+43(0) </telefon1> <telefon2 /> <handy /> <fax /> < >marketing@seminar-shop.com</ > <f_ >1</f_ > <url_homepage> <firmenbuch>fn k</firmenbuch> <uidnr>atu </uidnr> <branche /> <anrede>h</anrede> <akad-titel>dkfm.</akad-titel> <vorname>volkmar</vorname> <nachname>iro</nachname> <position>geschäftsführer</position> <datum_erfassung> </datum_erfassung> <datum_aenderung> </datum_aenderung> </data> </user> </userlist> Das hier dargestellte Muster ist gültig und kann als Vorlage herangezogen werden. Im folgenden noch eine Erläuterung der einzelnen Felder für das Austauschformat. Element / Attribut Erforder -lich Bedeutung userlist Ja Bezeichnet das gesamte XML Dokument als das XML- Austauschdokument. Alle weiteren Angaben (User) sind durch dieses Element eingeschlossen. Im allgemeinen wird es sich immer nur um einen User handeln. wsid Ja Das Attribut gibt die Herkunft des Dokuments bekannt (Website ID). user Ja Dieses Element ist einmal für jeden Datensatz, sprich User vorhanden. Es sind alle nachfolgenden Elemente von diesem eingeschlossen. guid Ja Dieses Attribut enthält den eindeutigen (gemeinsamen) Bezeichner für den User. data Ja Dieses Element enthält alle Elemente (Attribute) eines User. exists Ja Das Attribut enthält den Wert true wenn der Datensatz vorhanden ist und false wenn nicht. kundentyp Ja Gibt, an ob es sich bei diesem Eintrag um eine Privatperson (1) oder eine Firma (2) handelt. Mögliche Wert für dieses Element sind 1 bzw. 2. firmenname1 Ja Enthält den Namen der Firma. Die Angabe erforderlich ist nur im Falle der Existenz des Abschnittes Firma zu sehen! firmenname2 Nein Enthält einen zweiten Namen der Firma strasse Ja Strasse (Anschrift) land Ja Land (Anschrift) der Person bzw. der Firma (falls es sich um keine Privatperson handelt) nach ISO plz Ja Postleitzahl (Anschrift) ort Ja Ort (Anschrift) telefon1 Ja Die erste (wichtigste) Telefonnummer Seminar-Shop GmbH - Salzburg * SingleSignOn V02.02 Seite 5 von 5

6 telefon2 Nein alternatives Telefon, z. B.: Mobiltelefon handy Nein Mobiltelefon der Person fax Nein Faxnummer Ja -Adresse der Person (falls nicht vorhanden, die der Firma) f_ Nein Bestimmt ob die Person (Firma) per über etwaige Informationen (z.b. Newsletter) benachrichtigt werden möchte. Mögliche Werte für dieses Element sind 0 (falls nein) und 1 (falls ja). Wird nichts angegeben so ist die Default- Einstellung 1. url_homepage Nein Homepage der Person (Firma) firmenbuch Nein Firmenbuch-Nr. (=optional) uidnr Nein UID-Nr. (=optional) branche Nein Branche in der das Unternehmen (nur bei Firmenkunden) tätig ist. anrede Ja H für Herr, F für Frau akad-titel Nein Kann einen akademischen Titel wie beispielsweise Dr., Dipl.Ing. enthalten. Dieses Feld kann entfallen. vorname Ja Enthält den Vornamen der Person nachname Ja Enthält den Nachnamen der Person position Nein Position im Unternehmen, z.b. Geschäftsführer datum_erfassung Ja Erfassungs-/Erstanmeldungsdatum der Person bzw. Firma datum_aenderung Ja Änderungsdatum der Person bzw. Firma (z.b. wenn Stammdaten geändert wurden) Abbildung 1: XML-Felder Seminar-Shop GmbH - Salzburg * SingleSignOn V02.02 Seite 6 von 6

7 4 Szenarios 4.1 Erstanmeldung Der User ist auf der Partnerseite nicht registriert und möchte sich anmelden. - Schritt 1: User füllt das Erstanmeldungsformular (auf Seminar-Shop) aus. - Schritt 2: Die eingegebenen Daten werden einer Formularprüfung unterzogen. Dazu werden alle Pflichtfelder auf ihre Korrektheit (Länge, Sonderzeichen, etc.) überprüft. - Schritt 3: Vom Erstanmeldungsmodul aus wird ein Script (CheckUser) auf der Seite des Partners aufgerufen (Übergabeparameter: Benutzername, Passwort) das überprüft ob die Kombination Benutzername/Passwort bereits vorhanden ist. - Schritt 3a Benutzer ist bereits vorhanden: Das Script des Partners gibt eine Fehlermeldung (z.b. false) zurück. Der User kommt zum Erstanmeldungsformular (inkl. Fehlermeldung von Seminar-Shop) zurück. Zurück zu Schritt 2. - Schritt 3b Benutzer ist noch nicht vorhanden: Das Script des Partners generiert eine GUID (General UserID) und gibt diese zurück. Die Daten werden in der Seminar-Shop Datenbank gespeichert. - Schritt 4: Es wird ein Script (SaveUser) auf der Seite des Partners aufgerufen (Übergabeparameter: Benutzername, Passwort) das den Speichervorgang auf der Seite des Partners vornimmt. Dazu wird von diesem Script das Script (GetUserXML) auf Seminar-Shop aufgerufen (Übergabeparameter: Benutzername, Passwort) durch das die Benutzerdaten zurückgegeben werden. - Schritt 5: Bei erfolgreicher Speicherung gibt das Script (SaveUser) ein OK zurück (z.b. true ). - Schritt 5a Benutzer wurde erfolgreich gespeichert: Benutzername und Passwort werden durch einen dynamisch generierten Benutzername bzw. Passwort ersetzt. - Schritt 5b Benutzer wurde nicht erfolgreich gespeichert: Benutzername und Passwort bleiben, so wie diese der Erstanmelder eingegeben hat, in der Seminar-Shop Datenbank erhalten. Somit ist eine Erstanmeldung auf alle Fälle garantiert. Seminar-Shop GmbH - Salzburg * SingleSignOn V02.02 Seite 7 von 7

8 Seminar-Shop GmbH - Salzburg * SingleSignOn V02.02 Seite 8 von 8

9 4.2 Log In Der User ist auf der Partnerseite registriert und möchte sich anmelden. - Schritt 1: User gibt im Log-In Modul (auf Seminar-Shop) Benutzername und Passwort ein. - Schritt 2: Vom Log-In Modul aus wird ein Script (GetUserXML) auf der Seite des Partners aufgerufen (Übergabeparameter: Benutzername, Passwort) das überprüft ob die Kombination Benutzername/Passwort bereits vorhanden ist. - Schritt 2a Benutzer/Passwort ist nicht vorhanden: Das Script des Partners gibt eine Fehlermeldung (im erzeugten XML anstatt der Benutzerdaten beim Attribut data exists der Wert false mitgegeben) zurück. Der User kommt zum Log-In Modul (inkl. Fehlermeldung) zurück. - Schritt 2b Benutzer/Passwort ist vorhanden: Das Script des Partners gibt die Benutzerdaten im XML-Austauschformat (inkl. GUID) zurück. - Schritt 3: in der Seminar-Shop Datenbank wird überprüft ob die GUID bereits vorhanden ist. - Schritt 3a GUID ist bereits vorhanden: Der User wird auf Seminar-Shop eingeloggt. - Schritt 3b GUID ist nicht vorhanden: Es wird überprüft ob alle notwendigen Daten (vgl. Pflichtfelder) gefüllt sind. - Schritt 4a alle Pflichtfelder sind gefüllt: Benutzerdaten werden in der Seminar-Shop Datenbank gespeichert der User ist eingeloggt. - Schritt 4b nicht alle Pflichtfelder sind gefüllt: Benutzer kommt zum Erstanmeldungsformular (von Seminar-Shop) mit den Vorbelegungen (aufgrund der übermittelten Partnerdaten) die Daten werden gespeichert der User ist eingeloggt. Seminar-Shop GmbH - Salzburg * SingleSignOn V02.02 Seite 9 von 9

10 Seminar-Shop GmbH - Salzburg * SingleSignOn V02.02 Seite 10 von 10

11 4.3 Direkter Log In Der User ist auf der Partnerseite bereits angemeldet. Der Partner muss auf seiner Seite im Seminar-Shop Link die GUID als Variable mitübergeben. - Schritt 1: Der User ist auf der Partner Seite bereits eingeloggt. Der Seminar- Shop wird mit der WSID (Website ID) und der GUID des Users aufgerufen. - Schritt 2: in der Seminar-Shop Datenbank wird überprüft ob die GUID bereits vorhanden ist. - Schritt 2a GUID ist bereits vorhanden: Der User wird auf Seminar-Shop eingeloggt. - Schritt 2b GUID ist nicht vorhanden: Es wird ein Script (GetUserXML) auf der Seite des Partners aufgerufen (Übergabeparameter: GUID) das die Benutzerdaten im XML Austauschformat zurückgibt. Weiter mit Schritt 3. - Schritt 3: Es wird überprüft ob alle notwendigen Daten (Pflichtfelder) gefüllt sind. - Schritt 3a alle Pflichtfelder sind gefüllt: Benutzerdaten werden in der Seminar-Shop Datenbank gespeichert der User ist eingeloggt. - Schritt 3b nicht alle Pflichtfelder sind gefüllt: Benutzer kommt zum Erstanmeldungsformular (von Seminar-Shop) mit den Vorbelegungen (aufgrund der übermittelten Partnerdaten) die Daten werden gespeichert der User ist eingeloggt. Seminar-Shop GmbH - Salzburg * SingleSignOn V02.02 Seite 11 von 11

12 4.4 Passwort vergessen Der User wird auf das Passwort vergessen Formular des Partners umgeleitet. Passwort vergessen: Link geht direkt auf das Formular des Partners Seminar-Shop GmbH - Salzburg * SingleSignOn V02.02 Seite 12 von 12