KNF:SSOnotification: verschil tussen versies

Huidige versie van 31 okt 2023 om 15:33

Wat is een SSO notificatie?

Met een SSO notificatie (ook wel vooraanmelding genoemd) kan een Identity Provider ervoor zorgen dat zijn gebruikers het WAYF (Where Are You From) scherm van Entree Federatie automatisch overslaan. Dit is het scherm waar de gebruiker zijn school selecteert.

Dankzij de SSO notificatie hoeft de gebruiker minder handelingen uit te voeren tijdens het inlogproces en wordt het gebruiksgemak vergroot.

Hoe werkt een SSO notificatie?

Nadat een gebruiker is ingelogd bij zijn Identity Provider (bijvoorbeeld een ELO of via Windows authenticatie), verstuurt de Identity Provider een SSO notificatie verzoek naar Entree Federatie. Deze plaats vervolgens een cookie in de browser van de gebruiker met daarin de versleutelde authenticatie URL van de Identity Provider. Op het moment dat een gebruiker via Entree Federatie wil inloggen bij een aangesloten dienstleverancier zal Entree Federatie het SSO notificatie cookie uitlezen en de gebruiker direct doorsturen naar de authenticatie URL van zijn Identity Provider, waarmee het WAYF scherm dus is overgeslagen.

Hoe SSO notificatie werkt binnen het authenticatie proces is te zien in deze presentatie.

Implementatie met redirect

Opbouw redirect URL

De URL waarnaartoe de redirect wordt gedaan bestaat uit vier onderdelen:

Voor productie: https://ssonot.entree.kennisnet.nl/?id=<identifier van de IdP>&url=<url-encoded ELO URL>&redirectUri=<url-encoded redirect URL>
Voor staging: https://ssonot.entree-s.kennisnet.nl/?id=<identifier van de IdP>&url=<url-encoded ELO URL>&redirectUri=<url-encoded redirect URL>

Parameters:

id: De unieke identifier waarmee de Identity Provider bekend is binnen Entree Federatie. Dit is het entityId uit de metadata van de Identity Provider. De live data van de WAYF is via een publiek JSON bestand beschikbaar via: https://engine.entree.kennisnet.nl/sso/wayfsearch
url: De URL (url-encoded) van de omgeving waar de redirect vandaan komt. Dit wordt in de Entree Federatie applicatie gebruikt voor verificatie.
redirectUri: De redirectURI (url-encoded), dit is de URL waar de gebruiker naar teruggestuurd wordt na het plaatsen van het SSO notificatie cookie. Dit zal in veel gevallen hetzelfde zijn als de URL waar de redirect vandaan komt, maar kan indien gewenst dus ook afwijken.

De redirect URL krijgt daarmee de volgende constructie:
https://ssonot.entree.kennisnet.nl/?id=<identifier van de IdP>&url=<url-encoded ELO URL>&redirectUri=<url-encoded redirect URL>

Whitelist

LET OP: Voordat de SSO notificatie wordt geïmplementeerd moet de URL van de ELO of schoolportaal waarvandaan de redirect wordt uitgevoerd (zie Foutmeldingen) toegevoegd worden aan de whitelist van Entree Federatie. Neem hiervoor contact op met Kennisnet.

Voorbeeld

In onderstaande voorbeeld is http://authenticate.example.org de identifier van de IdP, http://www.example.org de URL waarvandaan de redirect wordt uitgevoerd en http://www.kennisnet.nl de URL waar de gebruiker naar wordt toegestuurd na het plaatsen van de SSO notificatie cookie.
https://ssonot.entree.kennisnet.nl/?id=http://authenticate.example.org&url=http%3A%2F%2Fwww.example.org&redirectUri=http%3A%2F%2Fwww.kennisnet.nl

Foutmeldingen

Als de ingestelde identifier van de IdP niet bekend is binnen Entree Federatie zal de redirect call resulteren in een 400 HTTP status code (Bad request).
Wanneer de URL waarvandaan de call gedaan wordt niet aan de whitelist van Entree Federatie is toegevoegd zal de redirect call ook een 401 HTTP status code (Unauthorized) opleveren.
Wanneer de redirectUri niet aan de whitelist van Entree Federatie is toegevoegd zal de redirect call een 401 HTTP status code (Unauthorized) opleveren.
Neem in deze gevallen contact op met Kennisnet.

Waarom alleen nog via redirect?

Wanneer vanuit een Identity Provider via een AJAX call of een iframe Entree Federatie een SSO notificatie cookie laat plaatsen dan is dit een third party cookie. Third party cookies (cookies van derden) worden geplaatst door andere domeinen (in dit geval Entree Federatie) dan het domein van de website die je op dat moment bezoekt (de Identity Provider). Sommige organisaties gebruiken third party cookies voor het volgen van gebruikers wanneer deze verschillende websites bezoekt. Aangezien dit type third party cookies (ook wel tracking cookies genoemd) een inbreuk kunnen maken op de privacy van gebruikers wordt het gebruik hiervan steeds meer ontmoedigd door browsers en vaak ook geblokkeerd.

Hierdoor kan het voorkomen dat ook het SSO notificatie cookie niet geplaatst wordt. De gebruiker kan in zo'n geval nog steeds inloggen via Entree Federatie, maar zal wel zelf zijn of haar school moeten selecteren op het WAYF scherm van Entree Federatie. Aangezien browsers hebben aangegeven om op termijn third party cookies helemaal te blokkeren kan het plaatsen van een SSO notificatie het beste gebeuren door middel van een redirect.

Realm meesturen in SSO noticatie

De realm kan in een SSO notifcatie cookie call worden opgenomen als de optionele parameter ‘realm’: https://ssonot.entree.kennisnet.nl/?id=https%3A%2F%2Fsaml.magister.net&url=https%3A%2F%2Fsaml.magister.net&realm=magis.dalton00HI&redirectUri=https%3A%2F%2Fwww.kennisnet.nl

Let op: de parameters ‘id’, ‘url’ en ‘redirectUri’ zijn nog steeds verplicht (technisch gesproken is de ‘redirectUri’ niet verplicht, maar tegenwoordig wel noodzakelijk omdat AJAX calls niet meer werken).

Tijdens de authenticatie wordt er wel gevalideerd op de realm in het SSO notificatie cookie:

Wanneer realm scoping niet is ingesteld voor de IdP, dan wordt de gebruiker naar de IdP doorgestuurd, maar zonder een realm in het scoping element.
Wanneer de combinatie van het entityID van de IdP en de realm bestaat, dan wordt de de gebruiker naar de IdP doorgestuurd en de realm opgenomen in het scoping element.
Wanneer de realm onbekend is in Entree Federatie, dan wordt de gebruiker doorgestuurd naar de IdP, maar zonder een realm in het scoping element.
Wanneer de realm wel bekend is in Entree Federatie, maar niet voor de IdP in het SSO notificatie cookie, dan wordt de gebruiker doorgestuurd naar de IdP, maar zonder een realm in het scoping element.

@@ Regel 1: / Regel 1: @@
 {{Talen}}
+==Wat is een SSO notificatie?==
-Wanneer een school is aangesloten via een eigen koppeling (ELO/ADFS of anderszins federatief) kan men de keuze voor het inlogscherm overslaan.
+Met een SSO notificatie (ook wel vooraanmelding genoemd) kan een Identity Provider ervoor zorgen dat zijn gebruikers het WAYF ('''W'''here '''A'''re '''Y'''ou '''F'''rom) scherm van Entree Federatie automatisch overslaan. Dit is het scherm waar de gebruiker zijn school selecteert.<br/>
-Dit gebeurt middels een cookie die wordt geplaatst '''nadat''' de gebruiker in zijn eigen omgeving is ingelogd (bijvoorbeeld intranet pagina of startpagina van de elo waar de gebruiker terecht komt).
+[[Bestand:Wayf01.PNG|border|400px|Where Are You From (WAYF) scherm]]
+<br/><br/>
+Dankzij de SSO notificatie hoeft de gebruiker minder handelingen uit te voeren tijdens het inlogproces en wordt het gebruiksgemak vergroot.
+==Hoe werkt een SSO notificatie?==
-Dit cookie bevat informatie die alleen vertelt welke school er uit het inlogscherm gekozen moet worden.
+Nadat een gebruiker is ingelogd bij zijn Identity Provider (bijvoorbeeld een ELO of via Windows authenticatie), verstuurt de Identity Provider een SSO notificatie verzoek naar Entree Federatie. Deze plaats vervolgens een cookie in de browser van de gebruiker met daarin de versleutelde authenticatie URL van de Identity Provider. Op het moment dat een gebruiker via Entree Federatie wil inloggen bij een aangesloten dienstleverancier zal Entree Federatie het SSO notificatie cookie uitlezen en de gebruiker direct doorsturen naar de authenticatie URL van zijn Identity Provider, waarmee het WAYF scherm dus is overgeslagen.
+Hoe SSO notificatie werkt binnen het authenticatie proces is te zien in [https://prezi.com/eq2xjhid1fxf/entree-federatie-authenticatie/ deze presentatie].
+== Implementatie met redirect ==
-Hiervoor kan het onderstaande script (of webpart voor SharePoint) gebruikt worden. In dit script moet de Elo Id en de Elo URL aangepast worden.
+===Opbouw redirect URL===
-[[file:EntreeSSONotificatie.txt]]
+De URL waarnaartoe de redirect wordt gedaan bestaat uit vier onderdelen:
+* Voor '''productie''': <nowiki>https://ssonot.entree.kennisnet.nl/?id=<identifier van de IdP>&url=<url-encoded ELO URL>&redirectUri=<url-encoded redirect URL></nowiki>
-Elo Id: de unieke identifier van de koppeling (kan opgevraagd worden bij Kennisnet).
+* Voor '''staging''': <nowiki>https://ssonot.entree-s.kennisnet.nl/?id=<identifier van de IdP>&url=<url-encoded ELO URL>&redirectUri=<url-encoded redirect URL></nowiki>
-Elo URL: https://*.domeinnaam.nl (dit moet de locatie/domein zijn waar het script staat).
+Parameters:
+* '''id:''' De unieke identifier waarmee de Identity Provider bekend is binnen Entree Federatie. Dit is het entityId uit de metadata van de Identity Provider. De live data van de WAYF is via een publiek JSON bestand beschikbaar via: https://engine.entree.kennisnet.nl/sso/wayfsearch
+* '''url:''' De URL (url-encoded) van de omgeving waar de redirect vandaan komt. Dit wordt in de Entree Federatie applicatie gebruikt voor verificatie.
+* '''redirectUri:''' De redirectURI (url-encoded), dit is de URL waar de gebruiker naar teruggestuurd wordt na het plaatsen van het SSO notificatie cookie. Dit zal in veel gevallen hetzelfde zijn als de URL waar de redirect vandaan komt, maar kan indien gewenst dus ook afwijken.
+De redirect URL krijgt daarmee de volgende constructie:<br>
-Daarnaast moet de Elo URL worden geregistreerd bij Kennisnet, zodat deze kan worden toegevoegd aan de white list.
+''<nowiki>https://ssonot.entree.kennisnet.nl/?id=<identifier van de IdP>&url=<url-encoded ELO URL>&redirectUri=<url-encoded redirect URL></nowiki>''
+===Whitelist===
+'''LET OP:''' Voordat de SSO notificatie wordt geïmplementeerd moet de URL van de ELO of schoolportaal waarvandaan de redirect wordt uitgevoerd (zie [[KNF:SSO_notificatie_middels_een_redirect#Foutmeldingen | Foutmeldingen]]) toegevoegd worden aan de whitelist van Entree Federatie. Neem hiervoor contact op met [mailto:support@kennisnet.nl Kennisnet].
-== Voorbeeld zonder SSOnotificatie: ==
+===Voorbeeld===
+In onderstaande voorbeeld is ''<nowiki>http://authenticate.example.org</nowiki>''  de identifier van de IdP, ''<nowiki>http://www.example.org</nowiki>'' de URL waarvandaan de redirect wordt uitgevoerd en ''<nowiki>http://www.kennisnet.nl</nowiki>'' de URL waar de gebruiker naar wordt toegestuurd na het plaatsen van de SSO notificatie cookie.<br>
-#'''Leerling/Docent logt in op de ELO/Active directory'''
+''<nowiki>https://ssonot.entree.kennisnet.nl/?id=http://authenticate.example.org&url=http%3A%2F%2Fwww.example.org&redirectUri=http%3A%2F%2Fwww.kennisnet.nl</nowiki>''
-#*Ga naar de [https://referentie.entree.kennisnet.nl/ReferentieELO/app ReferentieELO]
-#'''Leerling/Docent klikt op een link naar lesmateriaal of content'''
-#*Klik 'Naar dienst'
-#'''Het WAYF (Where Are You From) scherm wordt nu getoond (Het inlogsysteem weet immers nog niet met welke school het te maken heeft)'''
-#*Kies 'Inloggen via je school'
-#*Zoek en kies 'Referentie Klant Organisatie'
-#*Klik verder
-#'''Deze stap is uniek voor de ReferentieELO, omdat er dummydata ingevuld kan worden. Normaliter worden onder water de attributen van de ingelogde Leerling/Docent doorgegeven'''
-#*Vul eventueel dummydata in
-#*Klik op 'Naar dienst'
-#'''Gebruiker is ingelogd, attributen van ingelogde gebruiker worden getoond.'''
+===Foutmeldingen===
-== Voorbeeld met SSOnotificatie: ==
+Als de ingestelde identifier van de IdP niet bekend is binnen Entree Federatie zal de redirect call resulteren in een 400 HTTP status code (Bad request).<br>
-#'''Leerling/Docent logt in op de ELO/Active directory'''
+Wanneer de URL waarvandaan de call gedaan wordt niet aan de whitelist van Entree Federatie is toegevoegd zal de redirect call ook een 401 HTTP status code (Unauthorized) opleveren.<br>
-#*Ga naar de [https://referentie.entree.kennisnet.nl/ReferentieELO/app ReferentieELO]
+Wanneer de redirectUri niet aan de whitelist van Entree Federatie is toegevoegd zal de redirect call een 401 HTTP status code (Unauthorized) opleveren.<br>
-#*Klik op "SSO Notificatie" (Onderwater of handmatig wordt de SSOnotificatie url aangeroepen)
+Neem in deze gevallen contact op met [mailto:support@kennisnet.nl Kennisnet].
-#'''Leerling/Docent klinkt linkje naar lesmateriaal of content'''
-#*Klik 'Naar dienst'<br/> <span style="color:#ff0000">Het WAYF (Where Are You From) scherm wordt '''niet''' getoond (Het inlogsysteem leest het cookie uit welke is geplaatst via de SSOnotificatie en weet nu welke school geselecteerd moet worden)</span>
-#'''Deze stap is uniek voor de ReferentieELO, omdat er dummydata ingevuld kan worden. Normaliter worden onder water de attributen van de ingelogde Leerling/Docent doorgegeven'''
-#*Vul eventueel dummydata in
-#*Klik op 'Naar dienst'
-#'''Gebruiker is ingelogd, attributen van ingelogde gebruiker worden getoond.'''
+===Waarom alleen nog via redirect?===
-[[Categorie:Kennisnet Federatie]]
+Wanneer vanuit een Identity Provider via een AJAX call of een iframe Entree Federatie een SSO notificatie cookie laat plaatsen dan is dit een third party cookie. Third party cookies (cookies van derden) worden geplaatst door andere domeinen (in dit geval Entree Federatie) dan het domein van de website die je op dat moment bezoekt (de Identity Provider).
+Sommige organisaties gebruiken third party cookies voor het volgen van gebruikers wanneer deze verschillende websites bezoekt. Aangezien dit type third party cookies (ook wel tracking cookies genoemd) een inbreuk kunnen maken op de privacy van gebruikers wordt het gebruik hiervan steeds meer ontmoedigd door browsers en vaak ook geblokkeerd.
+Hierdoor kan het voorkomen dat ook het SSO notificatie cookie niet geplaatst wordt. De gebruiker kan in zo'n geval nog steeds inloggen via Entree Federatie, maar zal wel zelf zijn of haar school moeten selecteren op het WAYF scherm van Entree Federatie. Aangezien browsers hebben aangegeven om op termijn third party cookies helemaal te blokkeren kan het plaatsen van een SSO notificatie het beste gebeuren door middel van een redirect.
+==Realm meesturen in SSO noticatie==
+De realm kan in een SSO notifcatie cookie call worden opgenomen als de optionele parameter ‘realm’:
+https://ssonot.entree.kennisnet.nl/?id=https%3A%2F%2Fsaml.magister.net&url=https%3A%2F%2Fsaml.magister.net&realm=magis.dalton00HI&redirectUri=https%3A%2F%2Fwww.kennisnet.nl
+Let op: de parameters ‘id’, ‘url’ en ‘redirectUri’ zijn nog steeds verplicht (technisch gesproken is de ‘redirectUri’ niet verplicht, maar tegenwoordig wel noodzakelijk omdat AJAX calls niet meer werken).
+Tijdens de authenticatie wordt er wel gevalideerd op de realm in het SSO notificatie cookie:
+# Wanneer realm scoping niet is ingesteld voor de IdP, dan wordt de gebruiker naar de IdP doorgestuurd, maar zonder een realm in het scoping element.
+# Wanneer de combinatie van het entityID van de IdP en de realm bestaat, dan wordt de de gebruiker naar de IdP doorgestuurd en de realm opgenomen in het scoping element.
+# Wanneer de realm onbekend is in Entree Federatie, dan wordt de gebruiker doorgestuurd naar de IdP, maar zonder een realm in het scoping element.
+# Wanneer de realm wel bekend is in Entree Federatie, maar niet voor de IdP in het SSO notificatie cookie, dan wordt de gebruiker doorgestuurd naar de IdP, maar zonder een realm in het scoping element.
+[[Categorie:Entree Federatie]]