KNF:Realm scoping: verschil tussen versies

Uit Kennisnet Developers Documentatie
Naar navigatie springen Naar zoeken springen
Regel 1: Regel 1:
 
{{Talen}}
 
{{Talen}}
Sommige Identity Providers worden door meerdere scholen gebruikt, dit is met name het geval bij Elektronische Leeromgevingen. Vaak hebben deze applicaties een eigen WAYF ('''W'''here '''A'''re '''Y'''ou '''F'''rom) scherm waar de gebruiker zijn school moet selecteren. Om te voorkomen dat een gebruiker eerst zijn school op het WAYF scherm van Entree Federatie moet selecteren en vervolgens nogmaals op het WAYF scherm van de Identity Provider, kan er gebruik gemaakt worden van BRIN scoping. Dit maakt het mogelijk om het tweede WAYF scherm over te slaan.
+
Sommige Identity Providers worden door meerdere scholen gebruikt, dit is met name het geval bij Elektronische Leeromgevingen. Vaak hebben deze applicaties een eigen WAYF ('''W'''here '''A'''re '''Y'''ou '''F'''rom) scherm waar de gebruiker zijn school moet selecteren. Om te voorkomen dat een gebruiker eerst zijn school op het WAYF scherm van Entree Federatie moet selecteren en vervolgens nogmaals op het WAYF scherm van de Identity Provider, kan er gebruik gemaakt worden van Realm scoping. Dit maakt het mogelijk om het tweede WAYF scherm over te slaan.
   
'''LET OP:''' Om gebruik te kunnen maken van BRIN scoping moet dit door Kennisnet geconfigureerd worden voor de Identity Provider. Neem hiervoor contact op met [https://support.kennisnet.org/Tickets/Submit Kennisnet].
+
'''LET OP:''' Om gebruik te kunnen maken van Realm scoping moet dit door Kennisnet geconfigureerd worden voor de Identity Provider. Neem hiervoor contact op met [https://support.kennisnet.org/Tickets/Submit Kennisnet].
   
==BRIN-nummer==
+
==Realm==
  +
De realm staat achter het @ bij de uid van gebruikers. Dit bevat een waarde waarmee de school geidentificeerd kan worden.
De Basisregistratie Instellingen (BRIN) is een register dat door het Nederlandse Ministerie van OCW wordt beheerd. Iedere onderwijsinstelling wordt hierin geïdentificeerd aan de hand van een zogenaamd BRIN-nummer, bestaande uit vier alfanumerieke karakters. Het BRIN-nummer kan worden aangevuld met een tweecijferige code om een vestiging aan te duiden. Deze code van zes karakters wordt het vestigingsnummer genoemd.
 
   
  +
Realms worden automatisch toegevoegd aan Entree Federatie nadat een school de controle koppeling heeft gedaan, realms kunnen ook handmatig worden toegevoegd indien deze ontbreekt.
Voorbeelden van BRIN nummers zijn:
 
  +
* BRIN-nummer: 99ZZ
 
  +
Een overzicht van alle bekend realms kan worden terug gevonden in onderstaand json bestand:
* Vestigingsnummer: 99ZZ01
 
  +
https://aselect.entree.kennisnet.nl/openaselect/sso/wayfsearch2?type=getAll&spCode
   
 
==Scoping==
 
==Scoping==
Scoping is een onderdeel van de SAML 2.0 specificatie. BRIN scoping is dan ook alleen beschikbaar voor Identity Providers met een koppeling op basis van het SAML 2.0 protocol.
+
Scoping is een onderdeel van de SAML 2.0 specificatie. Realm scoping is dan ook alleen beschikbaar voor Identity Providers met een koppeling op basis van het SAML 2.0 protocol.
   
 
{{Info|Scoping biedt een Service Provider de mogelijkheid om een Identity Provider in een AuthnRequest mee te geven aan een proxy Identity Provider. Hiermee geeft de Service Provider bij de proxy Identity Provider aan dat alleen de Identity Provider in het ''<Scoping>'' element gebruikt mag worden.}}
 
{{Info|Scoping biedt een Service Provider de mogelijkheid om een Identity Provider in een AuthnRequest mee te geven aan een proxy Identity Provider. Hiermee geeft de Service Provider bij de proxy Identity Provider aan dat alleen de Identity Provider in het ''<Scoping>'' element gebruikt mag worden.}}
   
In het geval van BRIN scoping wordt dus een BRIN nummer in het ''<Scoping>'' element van een AuthnRequest meegegeven aan de proxy Identity Provider om aan te geven voor welke school de gebruiker moet worden geauthentiseerd.
+
In het geval van Realm scoping wordt dus een Realm in het ''<Scoping>'' element van een AuthnRequest meegegeven aan de proxy Identity Provider om aan te geven voor welke school de gebruiker moet worden geauthentiseerd.
   
 
<syntaxhighlight lang="xml">
 
<syntaxhighlight lang="xml">
Regel 23: Regel 24:
 
<Scoping>
 
<Scoping>
 
<IDPList>
 
<IDPList>
<IDPEntry ProviderID="99ZZ" />
+
<IDPEntry ProviderID="realm" />
 
</IDPList>
 
</IDPList>
  +
<RequesterID>Entity ID SP</RequesterID>
 
...
 
...
 
</Scoping>
 
</Scoping>
Regel 31: Regel 33:
 
</syntaxhighlight>
 
</syntaxhighlight>
   
Het attribuut ''ProviderID'' van het ''IDPEntry'' element bevat het BRIN nummer van de school die de gebruiker geselecteerd heeft in het WAYF scherm van Entree Federatie.
+
Het attribuut ''ProviderID'' van het ''IDPEntry'' element bevat de Realm van de school die de gebruiker geselecteerd heeft in het WAYF scherm van Entree Federatie.
   
 
{{Warn| Het kan voorkomen dat het AuthnRequest geen ''<Scoping>'' element bevat. Dit gebeurt in het scenario wanneer de gebruiker geen school hoeft te selecteren op het WAYF scherm van Entree Federatie, omdat er een SSO notificatie cookie beschikbaar is (meer informatie over [[KNF:SSOnotification | SSO notificatie]]). <br/>
 
{{Warn| Het kan voorkomen dat het AuthnRequest geen ''<Scoping>'' element bevat. Dit gebeurt in het scenario wanneer de gebruiker geen school hoeft te selecteren op het WAYF scherm van Entree Federatie, omdat er een SSO notificatie cookie beschikbaar is (meer informatie over [[KNF:SSOnotification | SSO notificatie]]). <br/>

Versie van 7 sep 2020 12:21

Nl.gif Nederlands En.gif English

Sommige Identity Providers worden door meerdere scholen gebruikt, dit is met name het geval bij Elektronische Leeromgevingen. Vaak hebben deze applicaties een eigen WAYF (Where Are You From) scherm waar de gebruiker zijn school moet selecteren. Om te voorkomen dat een gebruiker eerst zijn school op het WAYF scherm van Entree Federatie moet selecteren en vervolgens nogmaals op het WAYF scherm van de Identity Provider, kan er gebruik gemaakt worden van Realm scoping. Dit maakt het mogelijk om het tweede WAYF scherm over te slaan.

LET OP: Om gebruik te kunnen maken van Realm scoping moet dit door Kennisnet geconfigureerd worden voor de Identity Provider. Neem hiervoor contact op met Kennisnet.

Realm

De realm staat achter het @ bij de uid van gebruikers. Dit bevat een waarde waarmee de school geidentificeerd kan worden.

Realms worden automatisch toegevoegd aan Entree Federatie nadat een school de controle koppeling heeft gedaan, realms kunnen ook handmatig worden toegevoegd indien deze ontbreekt.

Een overzicht van alle bekend realms kan worden terug gevonden in onderstaand json bestand: https://aselect.entree.kennisnet.nl/openaselect/sso/wayfsearch2?type=getAll&spCode

Scoping

Scoping is een onderdeel van de SAML 2.0 specificatie. Realm scoping is dan ook alleen beschikbaar voor Identity Providers met een koppeling op basis van het SAML 2.0 protocol.

Info.gif Scoping biedt een Service Provider de mogelijkheid om een Identity Provider in een AuthnRequest mee te geven aan een proxy Identity Provider. Hiermee geeft de Service Provider bij de proxy Identity Provider aan dat alleen de Identity Provider in het <Scoping> element gebruikt mag worden.

In het geval van Realm scoping wordt dus een Realm in het <Scoping> element van een AuthnRequest meegegeven aan de proxy Identity Provider om aan te geven voor welke school de gebruiker moet worden geauthentiseerd.

<AuthnRequest> 
   ... 
   <Scoping> 
      <IDPList> 
         <IDPEntry ProviderID="realm" /> 
      </IDPList> 
	  <RequesterID>Entity ID SP</RequesterID>
      ... 
   </Scoping> 
   ...
</AuthnRequest>

Het attribuut ProviderID van het IDPEntry element bevat de Realm van de school die de gebruiker geselecteerd heeft in het WAYF scherm van Entree Federatie.

Warn.gif Het kan voorkomen dat het AuthnRequest geen <Scoping> element bevat. Dit gebeurt in het scenario wanneer de gebruiker geen school hoeft te selecteren op het WAYF scherm van Entree Federatie, omdat er een SSO notificatie cookie beschikbaar is (meer informatie over SSO notificatie).

Als de proxy Identity Provider dan geen andere methode heeft om vast te stellen bij welke school de gebruiker hoort, dan zal deze alsnog een WAYF scherm moeten tonen.