Entree Federatie: Single Sign On query

Met ingang van 1 juli 2019 maakt Entree Federatie gebruik van een nieuw Endpoint voor de SSO query. Per 1 september 2020 zal het oude endpoint uitgezet worden.

Inleiding

De SSOquery heeft als voornaamste functie het verklikken van de inlogstatus. Een veelgebruikte naam is dan ook wel de inlogstatusverklikker.

Deze functie biedt de mogelijkheid om te controleren of een gebruiker direct ingelogd kan worden zonder het inlogscherm te tonen. Ook toegang geven tot, of het zichtbaar maken van bepaalde content behoort tot een van de gebruikte usecases.

Met deze functie kan de gebruikerservaring verbeterd worden door bijvoorbeeld:

Een 'Inlogknop' niet te tonen en direct de authenticatie te starten met een ingelogde gebruiker als gevolg
Zichtbaar maken dat de gebruiker nog niet ingelogd is, maar dit wel moet doen om bepaalde content te zien

Let op:
Om misbruik van deze functionaliteit te voorkomen dient het domein opgenomen te worden in de whitelist van Entree Federatie. Neem daarom contact op met Kennisnet als je gebruik wilt maken van SSO query.

Werking

Zodra de vraag aan de Entree Federatie gesteld wordt, kunnen er drie antwoorden worden geven op de SSOQuery:

false: De gebruiker heeft geen SSO sessie en is voor zover bekend bij de Entree Federatie nergens ingelogd. Het is dus onbekend of de gebruiker wel of niet kan inloggen via Entree Federatie.
true: De gebruiker heeft een SSO sessie en kan hoogstwaarschijnlijk inloggen zonder gebruikersinteractie
remote: De gebruiker heeft geen SSO sessie, maar er is wel een SSO notificatie cookie gevonden. De gebruiker is al ingelogd in zijn eigen systeem(ELO) en kan hoogstwaarschijnlijk inloggen zonder gebruikersinteractie

Implementatie

De query bestaat uit een simpele HTTP GET met slechts een parameter: response_url (deze parameter moet in de URL worden URL encoded/UTF-8).
De volgende urls kunnen worden gebruikt:

Staging environment:
https://ssoquery.aselect-s.entree.kennisnet.nl/openaselect/sso/ssoquery?response_url=<URL>

Live environment:
https://ssoquery.aselect.entree.kennisnet.nl/openaselect/sso/ssoquery?response_url=<URL>

Voorbeeld

De dienst stelt de vraag: https://ssoquery.aselect.entree.kennisnet.nl/openaselect/sso/ssoquery?response_url=https%3A%2F%2Ftestapplicatie.kennisnet.nl

Entree Federatie redirect naar: https://testapplicatie.kennisnet.nl?result=true

Voorbeeld implementatie

SSO query

<html>
   <script>
      var queryUrl = 'https://ssoquery.aselect-s.entree.kennisnet.nl/openaselect/sso/ssoquery';
      var responseUrl = 'https://domeinnaam/ssoresult.php';

      function isLoggedIn() {
         var xhr = new XMLHttpRequest();
         xhr.open("GET", ssoQuery, true);
         xhr.withCredentials = true;
         xhr.onreadystatechange = function () {
            if (xhr.readyState === 4) {
               if (xhr.status === 200 && JSON.parse(xhr.responseText)['result'] === 'true') {
                  window.location.href = '/autorisaties/app.html#/home';
               } else {
                  window.location.href = '/autorisaties/login/';
               }
            }
         };
         xhr.ontimeout = function () {
            window.location.href = '/autorisaties/login/';
         };
         xhr.send();
      }
      isLoggedIn();
   </script>
</html>

SSO query result

<?php
        $result = array_key_exists('result', $_GET) ? $_GET['result'] : false;

        $resultValue = ($result === false ? '*none*' : $result);

?>
<html>
        <head>
                <title>SSO query result</title>
        </head>
        <body>
                <p>SSO query result is <?php print $resultValue; ?>.</p>
        </body>
</html>

KNF:Single Sign On query