Introductie

Welkom bij Topicus KeyHub.

KeyHub zorgt voor het authenticeren van gebruikers en het autoriseren van alle gekoppelde systemen. Hoe dit in zijn werk gaat, wordt in deze handleiding beschreven.

Principes van Topicus KeyHub

KeyHub werkt volgens het principe centrale authenticatie, decentrale autorisatie. Dit houdt in dat iedere gebruiker zich in principe eenmalig authenticeert (centraal) en vervolgens via verschillende groepen toegang krijgt tot alle gegevens die gekoppeld zijn aan die betreffende groepen. Het beheren van groepen wordt door verschillende groepsmanagers gedaan (decentraal).

Bij Topicus KeyHub staat veiligheid centraal. Dit betekent ook dat het inloggen op KeyHub alleen toegestaan is met behulp van two-factor-authentication. Iedere gebruiker moet derhalve de beschikking hebben over ten minste een compatibele two-factor-authentication methode. Topicus KeyHub ondersteunt de TOTP en WebAuthn protocollen. Elk FIDO2-compatibel apparaat kan gebruikt worden voor WebAuthn. Voorbeelden zijn de bekende USB security keys, zoals o.a. Yubico, Feitian en Google die verkopen. Voor TOTP zijn ook verschillende alternatieven voorhanden, bijvoorbeeld de Topicus KeyHub-app of de Google Authenticator-app.

Indeling van de handleiding

Dit document is opgedeeld in twee delen: het eerste gedeelte beschrijft het proces voor reguliere gebruikers van KeyHub waarin onder andere het registreren en het dagelijkse gebruik van KeyHub worden toegelicht. Het tweede gedeelte gaat in op de beheerfuncties en het koppelen van nieuwe systemen.

Getting Started

Registratie

Je account in KeyHub kan je zelf aanmaken. Ga naar het webadres waar KeyHub voor jouw organisatie draait (meestal https://keyhub.<jouw_organisatie>.com), klik op ‘Registreer’ en volg de stappen op het scherm.

Browser-extensie

KeyHub heeft een eigen browser-extensie. Hiermee wordt het nog eenvoudiger om wachtwoorden uit KeyHub op websites in te vullen. Ga naar www.topicus-keyhub.com/browser-extensions en kies de extensie voor jouw browser. Je wordt vervolgens naar de webpagina geleid waar je de extensie kan installeren.

Na het installeren van de extensie ga je in KeyHub naar “Profiel > instellingen” en klik daar op ‘browser-extensie koppelen’.

Nu zal je rechts bovenaan in je browser een icoon zien staan van KeyHub. Als je daarop klikt, kan je direct je wachtwoorden uit de kluizen van KeyHub halen.

Mobiele app

Maakt jouw organisatie gebruik van de 2-factor authenticatie van KeyHub, dan kan je de Topicus KeyHub app gebruiken. Deze is te vinden in de app-stores van Apple en Android en hiermee krijg je een push-notificatie als je in KeyHub een 2FA-code moet invoeren. Je hoeft dan alleen nog maar op ‘Login’ te drukken in plaats van de 6-cijferige code over te tikken.

Een alternatief voor de KeyHub-app is bijvoorbeeld Google Authenticator of Microsoft Authenticator. Deze beide apps werken ook prima, maar dan zal je geen push-notificatie krijgen en moet je de 6-cijferige code zelf overtikken.

Security keys

Naast TOTP-gebaseerde apps kun je ook elke FIDO2-compatibele security key gebruiken voor 2-factor authenticatie. Topicus KeyHub ondersteund het WebAuthn-protocol, zodat je elke compatibele hardware security key (soms ook wel een "dongle" genoemd) kunt gebruiken.

Op sommige apparaten kun je zelfs je besturingssysteem koppelen als software-gebaseerde security key, zodat je bijvoorbeeld de ingebouwde vingerafdrukscanner kunt gebruiken als tweede factor.

Handleiding

Kom je in KeyHub zelf iets tegen dat je niet direct begrijpt, kan de handleiding mogelijk hulp bieden. Klik onder PROFIEL op het vraagteken en de handleiding wordt geopend op een nieuw tabblad. Hier vind je uitvoerige informatie over KeyHub.

Persoonlijke kluis

Als je ingelogd bent in KeyHub kan je naar Kluizen gaan ('Vaults' in het Engels). Hier wordt onder andere je ‘Persoonlijke kluis’ getoond. Deze persoonlijke kluis is bedoeld voor al jouw eigen, zakelijke wachtwoorden. Denk hier bijvoorbeeld aan het systeem voor urenregistratie, verlofaanvragen en andere systemen waar jij persoonlijk op inlogt met een gebruikersnaam en wachtwoord.

Zet ook het wachtwoord van je harde-schijf-encryptie in de kluis van KeyHub zodat je deze niet kan vergeten!

Groepen in KeyHub

In KeyHub wordt alles geregeld via groepen. Iedere groep geeft toegang tot één of meerdere applicaties, servers of wachtwoordkluizen en de verantwoordelijkheid hiervan ligt bij één of meerdere groepsmanagers. Je kan zelf de groepen kan aanvragen die voor jou specifiek van toepassing zijn. Ga naar Mijn Groepen en klik daar op ‘Aanvragen’. Je ziet vervolgens een lijst met groepen die er al zijn binnen jouw organisatie. Zoek daar de groepen die voor jouw functie of werkzaamheden van toepassing zijn en klik op ‘vraag aan’.

Een aanvraag dient altijd door een groepsmanager goedgekeurd te worden.

Wachtwoorden en groepskluizen

Naast je persoonlijke kluis heeft KeyHub ook groepskluizen. Iedere groep heeft een eigen kluis om wachtwoorden, externe 2FA-codes en bestanden veilig in op te slaan. Als je een wachtwoord hebt die je wilt opslaan in KeyHub, kies dan de groep waar dit wachtwoord bij hoort en maak een nieuwe kluisregel aan. Hier kan je het wachtwoord in plaatsen. Als je wilt, kan je KeyHub ook een nieuw, sterk wachtwoord laten genereren. Na opslaan zal iedereen die binnen die groep zit direct kunnen beschikken over het wachtwoord.

Zet ook je SSL-certificaten in een kluis zodat je deze niet meer op een fileshare hoeft te bewaren!

Profiel en instellingen

Je hebt in KeyHub je eigen profiel-pagina. Hierop kan je onder andere de voorkeurstaal veranderen. Ook kan je via deze weg zien welke applicaties over welke data kunnen beschikken en waar je overal bent ingelogd.

Wisselen van telefoon

Het komt nog wel eens voor dat je een nieuwe telefoon krijgt. In dat geval moet je ook direct je 2FA-code aanpassen zodat je deze op je nieuwe telefoon weer kan genereren. Dit kan direct vanuit KeyHub via de Profiel-pagina. Bedenk je wel dat je hiervoor je oude 2FA-code nodig hebt! Mocht je die kwijt zijn, bijvoorbeeld omdat je oude telefoon kapot gegaan is, dan heb je een 2FA-reset nodig. Deze kan je aanvragen via de login-pagina van KeyHub en zal te allen tijde goedgekeurd dienen te worden door één of meer gebruikers uit je organisatie.

SSH-keys

Als je veel gebruik maakt van Unix-based omgevingen, kan je daarop met een SSH-key inloggen. Deze SSH-key kan je in KeyHub opslaan zodat single sign-on naar bijvoorbeeld Linux of Unix-omgevingen nog eenvoudiger wordt.

Groepsmanagers

Ieder groep heeft één of meerdere groepsmanagers. Een groepsmanager is iemand die de verantwoordelijkheid draagt over alles wat er in die groep gebeurt. Een groep kan toegang geven tot bijvoorbeeld applicaties, servers en/of wachtwoorden en de groepsmanager is daarvoor verantwoordelijk. Ook kan een groepsmanager groepsleden uit de groep zetten en andere leden tot manager promoveren.

Gebruik

1. Registreren en inloggen

Om van KeyHub gebruik te kunnen maken, is een account noodzakelijk. Er zijn twee manieren om een account aan te maken, namelijk via handmatig registreren of via een activatiecode.

Beide opties zijn te kiezen vanaf het loginscherm.

Loginscherm
Afbeelding 1. Loginscherm

1.1. Registreren

In de meeste gevallen kan een KeyHub-account handmatig aangemaakt worden. Kies hiervoor de optie Registreer op het loginscherm. Vervolgens kan via een drietal stappen het account worden aangemaakt.

1.1.1. Stap 1: Account aanmaken

Een KeyHub-account wordt gevalideerd tegen een bestaande 'directory', bijvoorbeeld een LDAP. Om een nieuw KeyHub-account aan te maken zal dus eerst de betreffende directory geselecteerd moeten worden. Waarschijnlijk is er slechts één directory beschikbaar en zal de standaardselectie correct zijn.

Nieuw account registreren met LDAP
Afbeelding 2. Nieuw account registreren met LDAP

Bij een registratie binnen een LDAP-directory dient de gebruikersnaam en het wachtwoord van de betreffende gebruiker in die directory ingevoerd te worden. Indien deze niet bekend is: dit betreft waarschijnlijk dezelfde gebruikersnaam/wachtwoord als die bijvoorbeeld voor de e-mail of het inloggen op het netwerk gebruikt wordt.

Nieuw account registreren met externe directory
Afbeelding 3. Nieuw account registreren met externe directory

Indien het account zich bevindt in een externe directory zal het bovenstaande scherm getoond worden. De gebruiker dient zich via de getoonde link aan te melden op het externe systeem. Hoe dit inlogproces er uit ziet is afhankelijk van het gebruikte systeem. Na het aanmelden zal de gebruiker terugkomen op het registratiescherm van KeyHub, waar dan de gekozen gebruiker getoond wordt.

Zowel bij een LDAP- als een externe directory kan ingesteld zijn dat gebruikers hun KeyHub-gebruikersnaam kunnen kiezen. Indien dit aan staat, zal er bij beide schermen en extra veld getoond worden waarin deze gebruikersnaam ingevuld kan worden. De gekozen gebruikersnaam zal overal binnen KeyHub gelden. De gebruiker logt dus in met de gekozen naam en accounts op gekoppelde systemen worden met deze naam aangemaakt. Het is niet mogelijk deze naam later nog aan te passen.

Indien de gegevens succesvol zijn gevalideerd, kan er een keuze gemaakt worden omtrent het wachtwoordgebruik.

Wachtwoordgebruik instellen
Afbeelding 4. Wachtwoordgebruik instellen

Bij LDAP-directories biedt KeyHub de mogelijkheid om een apart wachtwoord te gebruiken voor KeyHub. Dit wachtwoord zal daarmee een ander wachtwoord kunnen/mogen zijn dan het eerder ingevoerde wachtwoord. In de meeste gevallen zal het niet wenselijk zijn om een apart wachtwoord in te stellen voor KeyHub en zal de standaardinstelling volstaan.

Bij externe directories is het verplicht een wachtwoord voor KeyHub te kiezen. KeyHub zal dit wachtwoord gebruiken voor het beveiligen van de kluis en voor het aanmaken van accounts in gekoppelde systemen.

Raadpleeg hoofdstuk hoofdstuk 6 voor meer uitleg over de mogelijkheden omtrent wachtwoordgebruik.

Met de keuze voor het wachtwoordgebruik is de eerste stap voltooid.

1.1.2. Stap 2: Two-factor authentication instellen

De tweede stap in het registratieproces is het instellen van two-factor-authentication (2FA). Voor het instellen van 2FA kan een security key gebruikt worden, of een telefoon met daarop een authenticatie-app met ondersteuning voor het TOTP-protocol. Elke FIDO2-compatibele security key zou moeten werken. Voor TOTP geniet de Topicus KeyHub-app sterk de voorkeur, aangezien deze app zogenaamde push-notificaties ondersteunt. Hiermee hoeft de gebruiker enkel Ja of Nee te kiezen bij het inloggen, in plaats van een 6-cijferige code overtypen. Alternatieve apps zijn Google Authenticator, Duo Mobile en Microsoft Authenticator.

Bij een account uit een externe directory kan het zijn dat 2FA binnen de directory verplicht gesteld is. In dat geval zal deze stap ontbreken in het aanmeldproces.

Het volgende scherm wordt getoond:

Instellen 2FA
Afbeelding 5. Instellen 2FA

Er kan voor de optie Gebruik een 2FA app of voor de optie Gebruik een security key gekozen worden.

Security key

Als er voor een security key gekozen wordt, zal Topicus KeyHub automatisch proberen te koppelen met een beschikbare security key. Dit zal de browser middels een notificatie ook aangeven. Het activeren van de security key zal gaan volgens de procedure van de desbetreffende security key hiermee wordt de link met Topicus KeyHub bevestigd.

Instellen WebAuthn
Afbeelding 6. Instellen WebAuthn

Bij fysieke security keys zal er meestal een handeling moeten worden verricht zoals het indrukken van een knop of het scannen van een vingerafdruk. Als het besturingssysteem als security key dienst doet, zal deze laten weten hoe dit bevestigd kan worden.

2FA app

Als er voor een 2FA app is gekozen, zal het volgende scherm getoond worden.

Instellen TOTP
Afbeelding 7. Instellen TOTP

Na het scannen van deze code met de Topicus KeyHub-app, zal het venster het type van de mobiel tonen. Indien dit overeenkomt, kan 2FA ingeschakeld worden. Bij het inloggen ontvangt de gebruiker een push-notificatie op de mobiel waarmee direct ingelogd kan worden.

De Topicus KeyHub-app heeft een internetverbinding nodig voor het koppelen en het ontvangen van push-notificaties. De app biedt, na activatie, ook de mogelijkheid om de 6-cijferige code in te voeren, indien er geen internetverbinding is.

Indien een andere app gebruikt wordt, zal deze app na het scannen van de QR-code, het account in de app toevoegen. Om de koppeling definitief te maken dient de 6-cijferige verificatiecode ingevoerd te worden in bovenstaand scherm. Hiermee zal de 2FA actief zijn en wordt er na het inloggen in KeyHub om de 2FA-code gevraagd die via de app gegenereerd kan worden.

Hiermee is stap 2 voltooid.

1.1.3. Stap 3: Groepen aanvragen

De laatste stap in het registratieproces is het aanvragen van groepen. Een groep geeft toegang tot specifieke wachtwoorden, servers, applicaties, etc. die binnen die groep zijn vastgelegd.

Groepen aanvragen
Afbeelding 8. Groepen aanvragen

Via het zoekveld kan er gezocht worden naar aanwezige groepen. Zoek hier de betreffende groepen voor het te registreren account, hierbij zal de naam van de groep waarschijnlijk overeenkomen met het project, product of soort taken behorende bij het account.

Om toegang tot een groep aan te vragen, kan de groep via het icoontje rechts van ieder zoekresultaat toegevoegd worden. Kies hier alle groepen die van toepassing zijn bij het te registreren account en kies Volgende.

Vervolgens dient er een reden opgegeven te worden bij de aanvraag zodat de managers van de groepen weten waarom er toegang aangevraagd wordt. Geef hier een korte, duidelijke beschrijving waarom het account toegang dient te krijgen tot de groepen.

Reden van aanvraag opvoeren
Afbeelding 9. Reden van aanvraag opvoeren
Voordat over de groepen beschikt kan worden, zal de groepsmanagers de aanvragen expliciet moeten goedkeuren. Het kan derhalve zijn dat het account niet direct toegang heeft tot de verschillende groepen.

Tot slot worden via Verstuur en login de gegevens verstuurd en ingelogd op KeyHub.

1.2. Activatiecode

Indien er een activatiecode verstuurd is, kan hiermee ook een nieuw account worden geregistreerd. Kies hiervoor op het loginscherm voor de optie ik heb een activatiecode (of volg de link in de e-mail). Vervolgens kan de activatiecode ingevoerd worden.

Activatiecode invoeren
Afbeelding 10. Activatiecode

Na het invoeren van de activatiecode worden de gegevens van het account getoond.

Activeren
Afbeelding 11. Activeren

Indien de gegevens correct zijn, kan er een wachtwoord gekozen worden. Het wachtwoord dient een minimale lengte te hebben die is ingesteld door de organisatie. Indien het gekozen wachtwoord hier niet aan voldoet, wordt hiervan een melding getoond na Volgende.

Vervolgens dient de two-factor-authenticatie ingesteld te worden. Zie hiervoor de betreffende paragraaf two-factor-authenticatie instellen.

1.3. Two-factor authentication resetten

Het kan voorkomen dat de two-factor authentication (2FA) opnieuw ingesteld moet worden, bijvoorbeeld indien de security key of de mobiel defect geraakt, gestolen of op een andere manier onbruikbaar geworden is. In dat geval kan op het loginscherm gekozen worden voor de optie Ik kan niet inloggen met two-factor authentication om de 2FA te resetten.

Het volgende scherm wordt dan getoond:

2FA resetten
Afbeelding 12. 2FA Resetten

Om de 2FA te resetten kan daarvoor een reden ingevoerd te worden. De aanvraag wordt vervolgens beoordeeld door een andere gebruiker en indien deze goedgekeurd wordt, zal daarvan een email verstuurd worden.

Een gebruiker kan zelf 2FA opnieuw instellen via de beschikbare opties op de Profiel-pagina in Topicus KeyHub. Gebruikers die meerdere 2FA-methoden hebben gekoppeld kunnen simpelweg inloggen met een van de methoden die ze nog kunnen gebruiken. In andere gevallen dient de gebruiker er zorg voor te dragen dat ze nog met hun huidige 2FA-methode kunnen inloggen, danwel door een geldige code te genereren, danwel met gebruik van de security key. Bij aanschaf van een nieuwe mobiel kan bijvoorbeeld de oude gebruikt worden om in te loggen. Na het succesvol koppelen van de app op de nieuwe mobiel, kan het account uit de app van de oude mobiel verwijderd worden en is de nieuwe mobiel klaar voor gebruik.

1.4. Wachtwoord vergeten

Indien de gebruiker zijn of haar wachtwoord vergeten is, kan via Ik ben mijn wachtwoord vergeten een aanvraag tot herstellen van het wachtwoord ingediend worden. De procedure tot het herstellen van een wachtwoord verschilt per type account en is afhankelijk van de gekozen opties voor het wachtwoord. De verschillende procedures worden hieronder besproken.

1.4.1. Account uit een LDAP-directory

Gebruikers uit een LDAP-directory gebruiken het Topicus KeyHub-wachtwoord voor het openen van de kluis. Dit wachtwoord is mogelijk gesynchroniseerd met het wachtwoord uit de directory. Indien synchronisatie geactiveerd is en het wachtwoord in de directory buiten Topicus KeyHub om gewijzigd wordt, zal een wachtwoordsynchronisatie gestart worden. Als de gebruiker hier het oude wachtwoord kwijt is, kan een wachtwoordherstel gestart worden. Bij wachtwoordherstel met wachtwoordsynchronisatie zal om het wachtwoord van de directory en een reden voor het herstel gevraagd worden. Dit wachtwoord wordt ook gebruikt als nieuw Topicus KeyHub-wachtwoord.

Wachtwoord herstellen - Gesynchroniseerd wachtwoord
Afbeelding 13. Wachtwoord herstellen - Gesynchroniseerd wachtwoord

Indien wachtwoordsynchronisatie niet ingeschakeld is, wordt het Topicus KeyHub-wachtwoord gevraagd als de kluis geopend wordt. Als de gebruiker hier het wachtwoord kwijt is, kan een wachtwoordherstel gestart worden. De gebruiker voert tweemaal het nieuwe wachtwoord in, samen met een reden voor het herstel.

Wachtwoord herstellen - Nieuw wachtwoord
Afbeelding 14. Wachtwoord herstellen - Nieuw wachtwoord

Na het indienen van het verzoek wordt het account geblokkeerd. De aanvrager van het verzoek wordt hier geïnformeerd welke gebruikers het verzoek zullen verwerken. Zodra het verzoek door 2 gebruikers is goedgekeurd, kan het verzoek afgerond worden.

Account geblokkeerd - Wachten op goedkeuring
Afbeelding 15. Account geblokkeerd - Wachten op goedkeuring

Na het afronden van het verzoek is het Topicus KeyHub-wachtwoord van de gebruiker aangepast naar het nieuwe wachtwoord. Het verzoek kan op elk moment door de gebruiker afgebroken worden. Hierbij moet het oude of het nieuwe wachtwoord opgegeven worden.

Account geblokkeerd - Verzoek afronden
Afbeelding 16. Account geblokkeerd - Verzoek afronden

1.4.2. Account uit een OIDC-directory

Gebruikers uit een OIDC-directory gebruiken het Topicus KeyHub-wachtwoord voor het openen van de kluis. Na het klikken op de link Ik ben mijn wachtwoord vergeten zal de gebruiker uitkomen op ide pagina waar een nieuw wachtwoord voor Topicus KeyHub gekozen kan worden. De gebruiker moet het nieuwe wachtwoord tweemaal invoeren, een reden opgeven voor het herstel en het verzoek indienen. Hierna wordt het account geblokkeerd tot het verzoek is afgehandeld. Zodra het verzoek door 2 gebruikers is goedgekeurd, kan het verzoek afgerond worden. Na het afronden van het verzoek is het Topicus KeyHub-wachtwoord van de gebruiker aangepast naar het nieuwe wachtwoord.

1.4.3. Account uit een interne directory

Gebruikers uit een interne directory gebruiken het Topicus KeyHub-wachtwoord voor het inloggen op Topicus KeyHub en het openen van de kluis. Het klikken op de link Ik ben mijn wachtwoord vergeten zal de gebruiker uitkomen op de onderstaande pagina voor wachtwoord vergeten. Na het opgeven van de gebruikersnaam, zal de gebruiker een e-mail ontvangen met een activatiecode. Met deze code kan de gebruiker de herstelprocedure starten.

Wachtwoord vergeten
Afbeelding 17. Wachtwoord vergeten

Na het invoeren van de code wordt het scherm getoond waar de gebruiker een nieuw wachtwoord voor Topicus KeyHub kan kiezen. De gebruiker moet het nieuwe wachtwoord tweemaal invoeren, een reden opgeven voor het herstel en het verzoek indienen. Hierna wordt het account geblokkeerd tot het verzoek is afgehandeld. Zodra het verzoek door 2 gebruikers is goedgekeurd, gaat een cooldownperiode van 30 minuten van start. Het verzoek kan afgerond worden zodra deze 30 minuten is verstreken, of zodra een 3e gebruiker het verzoek goedkeurt. Na het afronden van het verzoek is het wachtwoord van de gebruiker aangepast naar het nieuwe wachtwoord.

Account geblokkeerd - Cooldown
Afbeelding 18. Account geblokkeerd - Cooldown

1.4.4. Wachtwoord resetten en bijbehorende gegevens wissen

Kies alleen voor een wachtwoord-reset als de herstelprocedure niet mogelijk is. Dit kan bijvoorbeeld het geval zijn indien er niemand is die het verzoek tot herstel kan goedkeuren.

In plaats van een wachtwoord-herstel kan een gebruiker ook kiezen voor een wachtwoord-reset als het wachtwoord vergeten is. Om een wachtwoord-reset uit te voeren, moet de gebruiker authenticeren tegen de directory en met 2FA. Een wachtwoord-reset kan dus alleen uitgevoerd worden als de gebruiker het Topicus KeyHub-wachtwoord kwijt is, maar wel het wachtwoord voor authenticatie tegen de directory weet. Bij een wachtwoord-reset worden alle sleutels van de gebruiker gewist, waarmee de volgende toegang verloren gaat:

  • Toegang tot de persoonlijke kluis en groepskluizen.

  • Managerrechten van groepen.

  • Lidmaatschap van de KeyHub administrators-groep.

Het door de gebruiker opgegeven wachtwoord zal worden ingesteld als het nieuwe Topicus KeyHub-wachtwoord.

Het verschil tussen wachtwoord-herstel en -reset

Het Topicus KeyHub-wachtwoord wordt gebruikt voor de versleuteling van sleuteldata van de gebruiker. Gegevens in de kluizen zijn rechtstreeks afhankelijk van deze sleutels. Ook worden deze sleutels gebruikt om groepslidmaatschap te ondertekenen en controlleren. Bij een wachtwoord-herstel blijven de belangrijkste sleutels intact. Na het herstel heeft de gebruiker nog steeds toegang tot de gegevens in de kluizen en kan de gebruiker groepslidmaatschappen ondertekenen. Bij een wachtwoord-reset daarentegen gaan alle sleutels verloren. De gebruiker verliest toegang tot alle kluizen. Voor groepskluizen zal opnieuw toegang gevraagd moeten worden. De inhoud van de persoonlijke kluis gaat definitief verloren. Ook verliest de gebruiker de mogelijkheid tot het ondertekenen van groepslidmaatschappen en daarmee de managerrechten op groepen.

Wachtwoord-reset
Afbeelding 19. Wachtwoord-reset

1.5. Verplicht wachtwoord wijzigen

Bij het aanmelden op KeyHub kan het voorkomen dat het onderstaande scherm getoond wordt als het wachtwoord van de gebruiker niet (langer) aan de gestelde eisen voldoet. Is het wachtwoord te kort of heeft de gebruiker geen kluis (bijvoorbeeld na het afbreken van de aanmeldwizard) dan zal de gebruiker door een proces van drie stappen geleid worden om een nieuw wachtwoord te kiezen. Dit stappenplan komt grotendeels overeen met de wizard voor wachtwoordgebruik onder het profiel. Raadpleeg daarom hoofdstuk hoofdstuk 8 voor meer uitleg over de mogelijkheden omtrent wachtwoordgebruik en deze wizard.

Probleem met wachtwoord
Afbeelding 20. Probleem met wachtwoord

1.6. Wachtwoordsynchronisatie

Een gebruiker kan kiezen voor wachtwoordsynchronisatie tussen Topicus KeyHub en de gebruikersdirectory. Wanneer het wachtwoord in de directory wordt gewijzigd, detecteert Topicus KeyHub dit bij het aanmelden en vraagt de gebruiker om opnieuw te synchroniseren. Topicus KeyHub heeft het oude en het nieuwe wachtwoord nodig om de sleutels voor kluis bij te werken. Wanneer het nieuwe wachtwoord niet voldoet aan de wachtwoordvereisten voor Topicus KeyHub, wordt de gebruiker gevraagd een nieuw wachtwoord te kiezen.

Wachtwoordsynchronisatie
Afbeelding 21. Wachtwoordsynchronisatie

1.7. Inloggen op andere applicaties met SSO

KeyHub kan ook gebruikt worden als Single Sign-on provider. Indien de gebruiker op een andere applicatie inlogt, zal het inlogscherm de naam van deze applicatie in de aanhef tonen. Bij de eerste keer inloggen op een andere applicatie dient de gebruiker toestemming te geven voor het delen van informatie met deze applicatie. Hiervoor wordt het volgende scherm getoond:

Toestemming geven
Afbeelding 22. Toestemming geven
Meestal zal een applicatie alleen om toegang tot het profiel van de gebruiker vragen. Deze toegang betreft enkel leesrechten tot de basisgegevens van het account. Met deze gegevens kan de applicatie de identiteit van de gebruiker vaststellen.

Het kan voorkomen dat de gebruiker geen toegang heeft tot de gevraagde applicatie. Indien dit het geval is, zal onderstaande scherm getoond worden waarin dit aan de gebruiker uitgelegd wordt. Single Sign-on is binnen KeyHub geregeld via de groepen van de gebruiker. Het scherm zal de gebruiker informeren over de groep (of groepen) die vereist zijn om in te loggen op de applicatie.

Inloggen niet toegestaan
Afbeelding 23. Inloggen niet toegestaan

1.8. TOTP tijdverschuiving synchroniseren

Indien de gebruiker een los apparaat gebruikt om verificatiecodes te genereren, kan het voorkomen dat de interne klok van dit apparaat gaat achterlopen op de systeemklok van KeyHub. KeyHub detecteert deze tijdverschuiving en past automatisch een compensatie toe. In uitzonderlijke gevallen kan het voorkomen dat de verschuiving te groot is om automatisch te compenseren. KeyHub vraagt de gebruiker dan om twee opéénvolgende codes in te voeren, als verificatie van de tijdverschuiving.

Tijdverschuiving bevestigen
Afbeelding 24. Tijdverschuiving bevestigen

2. Het dashboard

Het dashboard toont in één oogopslag alle informatie die benodigd is bij het dagelijks gebruik van KeyHub. Links van het scherm worden alle groepen getoond waarover beschikt kan worden. Aan de rechterkant van het scherm staan de tien meest recente gebeurtenissen. Dit betreft alleen meldingen die van belang zijn voor de betreffende gebruiker, bijvoorbeeld meldingen voor groepen waar de gebruiker manager van is of meldingen die betrekking hebben op het account van de gebruiker. Eventuele uitstaande verzoeken van of aan de gebruiker worden ook hier getoond.

Dashboard
Afbeelding 25. Dashboard

2.1. Groepen activeren

Om toegang te verkrijgen tot een groep, dient een groep geactiveerd te worden. Na het klikken op de gewenste groep wordt deze standaard voor het komende uur geactiveerd.

Activeren
Afbeelding 26. Groep activeren

Om de groep langer of korter te activeren, kan met de schuifbalk de gewenste eindtijd worden ingesteld. De ingestelde activatieduur zal bij de volgende activatie automatisch ingesteld worden. Na het verlopen van de tijdsperiode zal de toegang tot de groep automatisch gedeactiveerd worden. De toegang tot een groep kan ook direct gedeactiveerd worden door nogmaals op de groep te klikken. Bij handmatige deactivatie van een groep wordt de onthouden activatieduur teruggezet op de standaardtijd van één uur.

Indien voor een groep verlengde toegang aangevraagd kan worden, zal na het activeren van de groep een link Verleng toegang zichtbaar zijn. Het klikken op deze link toont het volgende venster:

Verlengde toegang aanvragen
Afbeelding 27. Verlengde toegang aanvragen

Hier kan worden aangegeven hoe lang toegang nodig is en waarom. Dit verzoek zal worden voorgelegd aan een manager van de groep. Zodra het verzoek goedgekeurd is, zal de groep als volgt worden weergegeven op het dashboard:

Verlengde toegang
Afbeelding 28. Verlengde toegang

Voor sommige groepen is het verplicht een reden op te geven bij activatie. Deze reden wordt opgenomen in de audit-trail en kan gebruikt worden voor rapportagedoeleinden. Indien deze optie ingeschakeld is voor de groep, zal het onderstaande scherm getoond worden:

Reden voor activatie
Afbeelding 29. Reden voor activatie

Bij een groep kan ingesteld zijn dat autorisatie vereist is bij activatie. In dat geval zal bij activatie het onderstaande scherm getoond worden. Na versturen van het verzoek zal een lid van de autoriserende groep dit verzoek beoordelen. Indien het geaccepteerd wordt, zal de groep geactiveerd worden met een eindtijd van één uur in de toekomst. De gebruiker kan de activatie hierna zelf verlengen gedurende de gegeven periode. Het eind van de periode wordt getoond met een rode driehoek op de tijdbalk. Zodra de groep inactief wordt, kan hij opnieuw geactiveerd worden, zolang dit binnen de toegestane periode valt. Als autorisatie gecombineerd wordt met een reden, zal de reden bij het verzoek verplicht zijn en vastgelegd worden in de audit-trail.

Toestemming voor activatie
Afbeelding 30. Toestemming voor activatie

2.2. Dashboardindeling

De groepen op het dashboard kunnen gegroepeerd worden in mappen zodat meerdere groepen in één keer geactiveerd kunnen worden. Ook is het mogelijk om groepen die zelden gebruikt worden te verbergen. Klik op Indeling beheren…​ om de dashboard-indeling aan te passen en mappen aan te maken.

Indeling
Afbeelding 31. Dashboardindeling

Het scherm voor de dashboardindeling toont een overzicht van alle mappen die zijn aangemaakt en welke groepen er binnen die map aanwezig zijn. Elke map wordt apart op het dashboard getoond. Iedere map kan op het dashboard geactiveerd worden waarmee in één keer alle groepen binnen die map geactiveerd worden.

Om groepen toe te voegen aan een map kan de groep naar de gewenste map gesleept worden. Groepen in de onderste map verborgen groepen worden standaard verborgen op het dashboard en kunnen daar tevoorschijn worden gehaald door op het dashboard op Toon alle groepen te klikken.

Klik op de knop Map toevoegen rechtsboven in het scherm om een nieuwe map toe te voegen.

Map toevoegen
Afbeelding 32. Map toevoegen

Een map bestaat uit een vrij te kiezen naam. Let er hierbij op dat er voor een beschrijvende naam gekozen wordt zodat duidelijk blijft welke groepen tot deze map behoren. Na Opslaan wordt de map getoond op de pagina Dashboardindeling en kunnen groepen naar deze map gesleept worden. Klik op het icoontje van een pen naast de naam van een map om de naam van de map aan te passen.

3. Het launchpad

Op het launchpad worden tegels getoond waarmee gebruikers snel naar bepaalde applicaties kunnen navigeren. Deze tegels worden gedeeld via de groepen waar de gebruiker lid van is. De verschillende soorten tegels worden hieronder beschreven.

Launchpad
Afbeelding 33. Launchpad

3.1. Handmatig aangemaakte launchpad-tegels

Een groepsmanager kan handmatig een tegel toevoegen bij een groep. Bij een handmatig toegevoegde tegel worden de volgende gegevens opgegeven:

Groep

De groep waarbij de tegel getoond moet worden.

Logo

Het logo dat getoond moet worden bij de tegel. Standaard wordt een plaatje gegenereerd. Door hier op te klikken kan een eigen plaatje opgegeven worden.

Titel

De titel die bij de tegel getoond moet worden.

Link

De link die geopend wordt als de gebruiker op de tegel klikt.

Handmatig aangemaakte launchpad-tegels
Afbeelding 34. Handmatig aangemaakte launchpad-tegels

3.2. Launchpad-tegels voor SSO-applicaties

Een tegel voor een SSO-applicatie wordt aangemaakt bij de applicatie zelf door de technisch beheerder van de betreffende applicatie. De tegel wordt getoond bij alle groepen die toegang hebben tot de applicatie. Als titel van de tegel wordt de naam van de applicatie gebruikt. Bij een tegel voor een SSO-applicatie worden de volgende gegevens opgegeven:

Logo

Het logo dat getoond moet worden bij de tegel. Standaard wordt een plaatje gegenereerd. Door hier op te klikken kan een eigen plaatje opgegeven worden.

Gebruik een IdP-initiated login

Voor applicaties die dit ondersteunen kan een IdP-initiated login gebruikt worden. Dit is mogelijk bij OAuth 2.0-applicaties waarbij de URI voor starten login ingevuld is of bij een SAML v2.0-applicatie. De applicatie zelft dient uiteraard wel een IdP-initiated login te ondersteunen.

Link

Indien de applicatie geen IdP-initiated login ondersteunt, dient de link die geopend wordt als de gebruiker op de tegel klikt handmatig ingevoerd worden.

Launchpad-tegels voor SSO-applicaties
Afbeelding 35. Launchpad-tegels voor SSO-applicaties

3.3. Launchpad-tegels voor kluisregels

Een tegel voor een kluisregel wordt aangemaakt bij de kluisregel zelf. Alleen managers van een groep kunnen een kluisregel beschikbaar maken als tegel op het launchpad. Als titel en link van de tegel worden de naam en link van de kluisregel gebruik. Bij een tegel voor een kluisregel kan dan ook alleen het logo opgegeven worden:

Logo

Het logo dat getoond moet worden bij de tegel. Standaard wordt een plaatje gegenereerd. Door hier op te klikken kan een eigen plaatje opgegeven worden.

Launchpad-tegels voor kluisregels
Afbeelding 36. Launchpad-tegels voor kluisregels

4. Mijn groepen

Op Mijn groepen worden alle groepen getoond waar de gebruiker toegang tot heeft, inclusief een eventuele beschrijving van de groep. Groepen waar de gebruiker manager van is, worden aangeven met een sterretje. Voor managers is er via het menu een dashboard beschikbaar met inzicht in alle groepen waar de gebruiker manager van is.

Mijn groepen
Afbeelding 37. Mijn groepen

4.1. Toegang aanvragen

Om toegang te verkrijgen tot een groep zal deze toegang aangevraagd dienen te worden. Klik hiertoe op de knop Aanvragen rechtsboven in het scherm.

Groepen aanvragen
Afbeelding 38. Groepen aanvragen

Iedere gebruiker kan een aanvraag doen om toegang te krijgen tot een willekeurige groep. Een aanvraag zal goedgekeurd moeten worden door tenminste één groepsmanager. Om dit proces te versnellen, kan er een reden toegevoegd worden bij de aanvraag. Deze reden wordt getoond aan de managers van de groep, die deze reden kunnen gebruiken als basis voor hun beslissing om het verzoek goed of af te keuren. Na het aanvragen van toegang tot een groep wordt deze aanvraag getoond op het Dashboard.

4.2. Nieuwe groep aanvragen

Indien de gewenste groep nog niet bestaat, kan een aanvraag voor een nieuwe groep ingediend worden. Klik hiertoe op de knop Nieuwe groep aanvragen rechtsboven in het scherm.

Nieuwe groepen aanvragen
Afbeelding 39. Nieuwe groep aanvragen

Iedere gebruiker kan een aanvraag doen om een nieuwe groep aan te maken. Er dient een duidelijke naam gekozen te worden voor de groep die voldoet aan eventuele eisen die getoond worden in het veld. In de selectiebox kan gekozen worden uit voorvoegsels die al gebruikt worden binnen de Topicus KeyHub-installatie. De gebruiker die de aanvraag doet wordt de eerste manager van de nieuwe groep.

Een aanvraag zal goedgekeurd moeten worden door tenminste één centrale beoordelaar. Om dit proces te versnellen, kan er een reden toegevoegd worden bij de aanvraag. Deze reden wordt getoond aan de beoordelaars, die deze reden kunnen gebruiken als basis voor hun beslissing om het verzoek goed of af te keuren. Na het aanvragen van een groep wordt deze aanvraag getoond op het Dashboard.

4.3. Groepsinformatie

Na het openen van een groep wordt een detailscherm getoond met daarop de volgende informatie:

Groepdetails

Van elke groep wordt de naam en omschrijving getoond. Afhankelijke van de gekozen opties bij de groep kunnen hier meer velden bij komen. Voor een compleet overzicht van de opties van een groep, zie groepsdetails.

Audits

De laatste 5 audits van een groep worden getoond. Zijn er meer audits, dan wordt een linkje getoond om ze allemaal in te zien. Zie groepen auditen voor meer informatie over audits

Leden

Alle leden van de groep worden getoond. Managers worden aangegeven met een sterretje. Indien in lidmaatschap een einddatum heeft, wordt deze ook getoond.

Voert autorisatie uit voor

Als de groep autorisatie uitvoert over andere groepen, dan worden die hier getoont. Details over de groep kunnen worden verkregen door op de groep te klikken. Er is ook een dashboard beschikbaar met inzicht in alle groepen waarover autorisatie wordt uitgevoerd.

Geneste groepen

Alle groepen die onder deze groep zijn genest, worden hier weergegeven. Details over de groep kunnen worden verkregen door op de groep te klikken. Zie geneste groepen voor meer informatie over nesten.

Auditlog

De auditlog van de groep wordt getoond. Bij het doorklikken kan in de auditlog gezocht worden op specifieke records.

Van iedere groep kan er contact opgenomen worden met de managers van de groep via mail manager. Ook kan een groep verlaten worden via Verlaat deze groep. Let er hierbij op na het verlaten opnieuw toegang aangevraagd en goedgekeurd zal moeten worden om weer toegang tot de groep te krijgen.

Mijn groep

Mijn groep

4.4. Groepen beheren

Voor managers van groepen zijn er een aantal extra opties beschikbaar bij een groep. Voor een manager van een groep is het mogelijk om de eigenschappen van een groep te bewerken. Hier zijn de volgende eigenschappen te vinden:

UUID

Een unieke identifier voor de groep binnen KeyHub.

Organisatie-eenheid

De organisatie-eenheid waar de groep bij hoort. Alleen gebruikers die lid zijn van deze organisatie-eenheid kunnen lid worden van de groep.

Naam

De primaire naam van de groep. Door ervoor te zorgen dat meerdere groepsnamen beginnen met hetzelfde woord worden deze door de hele applicatie samengevoegd in een categorie. De naam van een groep moet uniek zijn.

Classificatie

Groepen kunnen ingedeeld worden in classificaties. Deze classificatie stelt beleid op voor instellingen van de groep, zodat de beoogde beveiliging afgedwongen kan worden. De classificatie kan niet door de manager van de groep aangepast worden. Dit wordt gedaan door iemand die toegang heeft tot het auditor-dashboard voor groepen.

Verlengde toegangsperiode

Normaal kan een groep slechts voor maximaal 12 uur ingeschakeld worden op het dashboard. Via deze optie kan gekozen worden voor het toestaan van verlengde toegang tot een groep met een maximum van 1 of 2 weken. Voor het inschakelen van deze verlengde toegang op het dashboard moet de betreffende gebruiker eerst toestemming vragen (met uitzondering van de optie Tot 2 weken, zonder goedkeuring). Verlengde toegang kan nodig zijn voor het kunnen uitvoeren van langdurige operaties op systemen zoals grote kopiëeracties.

Leg audit-trail vast

Voor toegang tot gevoelige informatie kan het verplicht gesteld worden dat er altijd een reden opgegeven moet worden voor het verkrijgen van deze toegang. Deze reden wordt vastgelegd in de auditlog en kan gebruikt worden voor rapportages benodigd voor certificeringen zoals ISO 27001.

Roterend wachtwoord verplicht

Indien aangevinkt, zal de gebruiker deze groep enkel kunnen activeren als de gebruiker een roterend wachtwoord gebruikt (zie wachtwoordgebruik). Het verplichten van een roterend wachtwoord biedt een significante verbetering van de beveiliging doordat mogelijk uitgelekte wachtwoorden slechts 24 uur actief blijven.

Privé groep

Een privé groep is alleen zichtbaar voor groepsleden, KeyHub administrators en auditors. Voor alle andere gebruikers is de group niet zichtbaar of toegankelijk. Dit betekent ook dat ze geen toegang tot deze groep kunnen aanvragen via de normale weg. Alleen een groepsmanager kan nieuwe leden toevoegen.

Audit-trail verbergen

De auditlog-regels voor deze groep worden niet getoond aan gewone leden op het dashboard en zijn in de auditlog alleen zichtbaar onder 'dagelijks gebruik'. Bij grote groepen met veel mutaties zijn deze regels minder relevant en verdringen mogelijk andere regels die belangrijker zijn. De auditlog van de groep is wel in te zien voor gewone leden bij de details van de groep.

Beschikbaarheid kluisherstel

Beperk de mogelijkheden voor kluisherstel voor kluizen met zeer gevoelige informatie. Bij Volledig beschikbaar blijft de toegang tot de kluis beschikbaar na een wachtwoordherstel en kan de herstelsleutel gebruikt worden als noodprocedure om toegang te herstellen. Als Enkel met de herstelsleutel gekozen wordt, zullen gebruikers de toegang tot de kluis kwijtraken na wachtwoordherstel, maar kan de herstelsleutel wel gebruikt worden. Met Niet beschikbaar wordt kluisherstel volledig uitgeschakeld en kunnen alleen leden van de groep gebruikers opnieuw toegang geven. In dit geval zal na het verwijderen van een groep het ook niet mogelijk zijn om de inhoud van de kluis te herstellen.

Activatie verplicht voor kluistoegang

Indien ingeschakeld, is het activeren van deze groep verplicht voordat wachtwoorden kunnen worden uitgelezen.

Autoriserende groep voor activatie

Wanneer ingesteld, zal de gekozen groep toestemming moeten geven voordat deze groep geactiveerd kan worden.

Autoriserende groep voor lidmaatschap

Wanneer ingesteld, zal de gekozen groep toestemming moeten geven voor het toevoegen van nieuwe leden en het aanpassen van managerrechten van leden voor deze groep.

Groep met gedelegeerde rechten

Wanneer ingesteld, zal de gekozen groep gedelegeerde managerrechten krijgen voor deze groep.

Autoriserende groep voor audits

Wanneer ingesteld, zal de gekozen groep een audit moeten goedkeuren voordat deze definitief gemaakt wordt. Eventuele wijzigingen zullen pas worden doorgevoerd na de goedkeuring.

Technisch beheer

Groepen waarbij deze optie ingeschakeld is, kunnen applicaties en gekoppelde systemen aanmaken en beheren. Voor het inschakelen is toestemming vereist. Voor meer informatie zie het hoofdstuk over applicaties en het hoofdstuk over koppelingen.

Toegangsprofielenbeheer

Groepen waarbij deze optie ingeschakeld is, kunnen toegangsprofielen aanmaken en beheren. Voor het inschakelen is toestemming vereist.

Periodieke auditmaanden

De selectie van maanden waarop een periodieke groepsaudit moet worden uitgevoerd door de managers van de groep. Bij het begin van de maand zal de manager een notificatie krijgen op zijn dashboard. Er is dan tot de tweede dinsdag van de maand tijd om de audit uit te voeren. Na deze vervaldatum zal de notificatie veranderen in een achterstallig audit.

Omschrijving

Een uitgebreidere omschrijving van de groep. Hierin kan bijvoorbeeld aangegeven worden tot welke systemen deze groep toegang geeft. Deze informatie wordt getoond aan gebruikers die lid zijn van, of toegang willen vragen tot de groep.

Groep bewerken
Afbeelding 40. Groep bewerken

Een manager kan ook een audit uitvoeren op de groep, zie hiervoor groepen auditen. Het beheer van de leden van de groep valt ook onder de verantwoordelijkheid van een groepsmanager. Bestaande leden zijn te bewerken of verwijderen door er op te klikken. Klik op toevoegen om een nieuwe gebruiker direct aan de groep toe te voegen. In de popup dient naast de gebruiker ook gekozen te worden of deze nieuwe gebruiker manager wordt of een standaardgebruiker. Wanneer aan een groepslidmaatschap een einddatum wordt toegekend, wordt de gebruiker automatisch uit de groep verwijderd wanneer deze datum verloopt.

Groepslid bewerken
Afbeelding 41. Groepslid bewerken

4.5. Groepen auditen

Groepen kunnen geaudit worden. Dit betekent dat een groepsmanager de groepsleden controleert en deze controle vastlegt in Topicus KeyHub. Het auditen van een groep kan op ieder moment plaatsvinden en iedere audit wordt ook in de audit trail opgeslagen.

Audits kunnen worden bekeken bij de details van een groep. Voor managers biedt deze pagina ook de mogelijkheid om een nieuwe audit te start met de knop toevoegen.

Bij een audit kan een algemene opmerking vastgelegd worden in het veld bovenaan het scherm. Daarnaast kan van ieder groepslid vastgelegd worden of deze inderdaad in de groep behoort en over de juiste rol beschikt.

Het vinkje links geeft aan dat het groepslid correct is. Indien het groepslid niet (meer) in de groep behoort, kan deze middels het kruisje rechts verwijderd worden. In het geval dat een groepslid nu de rol groepsmanager heeft, kan deze rol aangepast worden naar een normaal groepslid middels het middelste icoon.

Per groepslid kan er tevens een opmerking geplaatst worden door de regel van het groepslid open te klappen.

Alle ingevoerde opties worden pas doorgevoerd op het moment dat een audit wordt opgeslagen via de knop onderaan het scherm. Als een audit als concept opgeslagen wordt, kan deze later verder bewerkt en opgeslagen worden. Er kan slechts één conceptaudit bestaan per groep. Een concept is alleen zichtbaar voor managers van de groep en telt niet mee voor het auditschema.

Audit een group
Afbeelding 42. Audit een groep

Bij een groep kan ingesteld worden dat audits reviewed moeten worden. Indien dit ingesteld staat, zal een audit bij opslaan in review komen te staan. Er wordt automatisch een bericht uitgestuurd aan de leden van de reviewende groep. De audit in review zal terug in concept gezet worden als er een wijziging plaatsvindt in het lidmaatschap van de groep. Een manager van de groep zal de audit moeten herzien en opnieuw indienen ter review.

Audit in review
Afbeelding 43. Audit in review

Bij het uitvoeren van een review van een audit worden alle gekozen acties en notities getoond. Deze acties dienen gecontroleerd te worden en vervolgens kan worden gekozen om de audit goed of af te keuren. Bij het reviewen van de audit kan een reactie gegeven worden aan de manager van de groep.

Review een audit
Afbeelding 44. Review een audit

4.6. Geneste groepen

Een groep kan genest worden binnen een andere groep. De geneste groep zal automatisch de groepslidmaatschappen van de bovenliggende groep overnemen. Wijzigingen aan lidmaatschappen bij de bovenliggende groep werken direct door op de geneste groep. Bij een geneste groep blijft het mogelijk dat een gebruiker direct lid is van de groep. In het geval dat de gebruiker direct lid is van zowel de geneste als de bovenliggende groep, zullen de eigenschappen van het directe lidmaatschap van de geneste groep voorrang hebben boven die van de bovenliggende groep. Op deze manier kan een gebruiker bijvoorbeeld manager gemaakt worden van de geneste groep, terwijl deze normaal lid is van de bovenliggende groep. Indien een einddatum wordt ingesteld op het directe lidmaatschap van een geneste, zal het lidmaatschap worden omgezet in een geneste lidmaatschap bij het bereiken van die datum.

Bij aanvragen van het nesten van een groep kan gekozen worden hoe omgegaan moet worden met bestaande lidmaatschappen:

Behouden

Bestaande lidmaatschappen blijven bestaan en enkel nieuwe, geneste lidmaatschappen worden toegevoegd.

Omzetten

Bestaande lidmaatschappen worden omgezet in geneste lidmaatschappen als ze bestaan in de bovenliggende groep. Overige lidmaatschappen blijven bestaan.

Verwijderen

Alle huidige lidmaatschappen worden verwijderd en vervangen door de geneste lidmaatschappen.

Geneste groepen kunnen geen autorisatie op groeplidmaatschap hebben. Als dit op de bovenste groep ingesteld wordt, kunnen gebruikers dus nog steeds direct toegevoegd worden aan de geneste groep.
Geneste groep toevoegen
Afbeelding 45. Geneste groep toevoegen

4.7. Audits en geneste groepen

Als een groep genest is onder een andere groep, zullen de accounts die overgenomen zijn uit de bovenliggende groep standaard verborgen worden. Het is mogelijk om deze accounts open te klikken en als onderdeel van de audit om te zetten naar een direct lidmaatschap.

Als een groep één of meer geneste groepen onder zich heeft (direct of genest onder een geneste groep), kunnen deze geneste groepen onder voorwaarden direct mee-geaudit worden. Alle leden van de geneste groep dienen voort te komen uit de nesting, en dus niet direct te zijn. Als de geneste groep een authoriserende groep voor audits ingesteld heeft staan, dient deze gelijk te zijn aan wat is ingesteld op de groep die geaudit wordt. Alle geneste groepen worden getoond, en per groep kan gekozen worden of deze direct meegenomen wordt in de audit of niet.

Geneste groepen en audits
Afbeelding 46. Geneste groepen en audits

4.8. Gedelegeerde managerrechten

Bij een groep kan een andere groep aangewezen worden voor delegatie van managerrechten. Alle leden van de aangewezen groep krijgen deze gedelegeerde rechten. De leden van deze groep kunnen hiermee management uitvoeren voor de groep zonder zelf lid te zijn van de groep. Hiermee kunnen ze de volgende bewerkingen uitvoeren:

  • Groepsleden toevoegen, verwijderen of aanpassen.

  • Eigenschappen van de groep bewerken.

  • Audits uitvoeren over de leden van de groep.

Aangezien ze niet lid zijn van de groep zelf, hebben ze geen toegang tot o.a.:

  • De kluis van de groep.

  • Gekoppelde applicaties via SSO.

  • Gekoppelde systemen.

  • Verzoeken die afgehandeld worden door managers of leden van de groep, zoals verzoeken voor het toetreden van nieuwe leden tot een groep en verzoeken die voortvloeien uit de verantwoordelijkheden van de groep.

Om te voorkomen dat de groep met gedelegeerde rechten een te grote concentratie van rechten wordt, is het verplicht om een autoriserende groep voor lidmaatschap in te stellen voordat gedelegeerde managerrechten uitgegeven kunnen worden. Elke toevoeging of wijziging aan de leden van de groep moet daarbij extra goedgekeurd worden. Het is ook niet mogelijk voor gebruikers om zichzelf toe te voegen aan de groep.

Een groep die de managerrechten delegeert naar een andere groep, kan niet genest worden of zelf geneste groepen bevatten.

Voor gedelegeerde managerrechten wordt de sleutel van de kluis van de groep opgeknipt in twee delen. Het eerste deel leeft bij de groep met gedelegeerde managerrechten. Het tweede deel leeft bij de autoriserende groep voor lidmaatschap. Hoewel het mogelijk is om voor beide rollen dezelfde groep aan te wijzen, wordt dit sterk afgeraden. Bij een dergelijke situatie zal namelijk de volledige sleutel bij een enkele groep komen te liggen. Dit vermindert de weerstand van de database tegen een offline aanval aanzienlijk. Hetzelfde probleem speelt als een gebruiker lid is van beide groepen. Ook dan is de sleutel nog slechts met een enkele factor beschermt.

4.9. Groepen verwijderen

Het verwijderen van een groep vereist accordering van een KeyHub-administrator. Na het herhalen van de naam en het optioneel opgeven van een reden wordt dit verzoek uitgezet naar een KeyHub-administrators. Tot dit verzoek geaccordeerd is, blijft de groep gewoon bruikbaar.

Het verwijderen van een groep kan niet ongedaan gemaakt worden.

Als een groep verwijderd wordt, worden alle onderdelen die aan de groep hangen ook verwijderd. Onderdelen die verwijderd worden, zijn:

  • Alle kluisregels van de groep.

  • Alle applicaties die beheerd worden door de groep of waar de groep verantwoordelijk voor is.

  • Alle groepen op gekoppelde systemen waar de groep verantwoordelijk voor is.

In sommige gevallen kan een groep niet verwijderd worden omdat er onderdelen aan hangen die niet (direct) verwijderbaar zijn. De niet verwijderbare onderdelen worden rood getoond op de pagina. Onderdelen die niet verwijderd kunnen worden, zijn:

  • Gekoppelde systemen waar de groep technisch beheer voor doet. Voor dergelijke systemen moet het beheer overgedragen worden of ze moeten handmatig verwijderd worden.

  • Ingebouwde applicaties van Topicus KeyHub waar de groep verantwoordelijk voor is of beheer voor doet. De verantwoordelijkheid en/of beheer zal overgedragen moeten worden aan een andere groep.

  • Een interne LDAP-applicatie die gebruikt wordt door een gekoppelde systeem. Het bijbehorende gekoppelde systeem zal eerst verwijderd moeten worden.

  • Geneste groepen. De groepsnesting zal eerst ongedaan gemaakt moeten worden.

Groepen verwijderen
Afbeelding 47. Groepen verwijderen

5. Kluizen

Deze pagina toont een overzicht van de kluizen waar de gebruiker toegang tot heeft. Iedere groep heeft zijn eigen kluis en binnen iedere kluis staan alle regels met de opgeslagen informatie zoals opgeslagen wachtwoorden. Tevens beschikt elke gebruiker over een eigen, persoonlijke kluis.

Kluizen
Afbeelding 48. Kluizen

Alle wachtwoorden, bestanden en TOTP-codes zijn versleuteld met het wachtwoord van de gebruiker. Afhankelijk van de inlogmethode van de gebruiker zal de kluis direct na het inloggen toegankelijk zijn of dient de gebruiker de kluis eerst te ontsluiten door zijn of haar wachtwoord in te voeren.

5.1. Kluisregels

Een kluis kan vele verschillende regels bevatten. Het toevoegen van een regel aan een kluis gaat via de Regel toevoegen-knop die rechtsboven getoond wordt.

Regel toevoegen
Afbeelding 49. Regel toevoegen

Een regel uit de kluis bestaat uit verschillende gegevens.

Kluis

De kluis waar deze regel zich in bevindt. Hier wordt ook aangegeven of de regel gedeeld is met of vanuit een andere kluis.

UUID

Een unieke identifier voor de kluisregel binnen Topicus KeyHub.

Naam

De naam van de kluisregel. Dit kan gewijzigd worden op een gedeelde kopie, dit wijzigt niet de originele kluisregel en is alleen zichtbaar binnen de kluis waarin deze kopie zich bevindt.

Kleur

Deze kleur wordt getoond in de kluis en kan gebruikt worden voor het visueel groeperen van meerdere regels.

Launchpad-tegel

Een regel met een link kan ook opgenomen als tegel op het launchpad. Zie het hoofdstuk over het launchpad voor meer informatie.

Link

Voor regels die bij een website horen, kan deze website opgegeven worden. Deze link wordt tevens gebruikt door de browser-extensie om direct de juiste regels voor een site te zoeken. Als de volledige domeinnaam, inclusief subdomein, overeenkomt, zal de regel bovenaan staan. Regels met een ander subdomein staan hier onder.

Gebruikersnaam

De gebruikersnaam die hoort bij deze kluisregel. Deze gebruikersnaam kan automatisch ingevuld worden door de browser-extensie.

Einddatum

Een optionele einddatum waarop de geldigheid van de regel verloopt. Zie hieronder voor meer informatie.

De volgende gegevens van een regel worden versleuteld opgeslagen en zijn dus beveiligd tegen misbruik:

Wachtwoord/secret

Het wachtwoord waarmee ingelogd kan worden bij een dienst. Via de 'Wachtwoord genereren-link' kan eenvoudig een veilig wachtwoord gegenereerd worden. Uiteraard is het ook mogelijk zelf een wachtwoord op te geven.

TOTP/2FA-sleutel

Het secret van een 'Time-based One-time Password', veelal gebruikt voor tweefactorautenticatie. Dit secret wordt gebruikt om bij het opvragen een 6-cijferige code te genereren die 30 seconden geldig is. Bij het instellen van tweefactorauthenticatie voor een applicatie wordt vaak een QR-code getoond. Meestal wordt bij deze QR-code ook de sleutel getoond. Het oorspronkelijke secret is na het opslaan niet meer uit te lezen.

Bestand

Een bestand zoals bijvoorbeeld een SSL-certificaat of private key. Dit bestand heeft een maximale grootte van 2 MB.

Opmerking

Hier kunnen algemene opmerkingen geplaatst worden. De inhoud van dit veld wordt ook versleuteld opgeslagen.

Een regel kan op een later moment aangepast of ingezien worden door op de regel te klikken in de kluis.

5.2. Kluisregels met einddatum

Een kluisregel kan worden voorzien van een einddatum waarop de inhoud van de regel verloopt. Dit kan bijvoorbeeld de einddatum van een certificaat zijn of de datum waarop een wachtwoord moet worden vernieuwd. Op de overzichtspagina van de kluizen wordt een waarschuwing getoond bij elke verlopen kluisregel.

Waarschuwing verlopen kluisregel
Afbeelding 50. Waarschuwing verlopen kluisregel

Ook op de detail pagina van de kluisregel wordt een waarschuwing getoond. Op het dashboard worden notificaties getoond van alle verlopen kluisregels voor de ingelogde gebruiker.

Verlopen kluisregel op het dashboard
Afbeelding 51. Verlopen kluisregel op het dashboard

Bij de kluisregel kan naast de einddatum ook worden opgegeven hoe lang van te voren KeyHub moet beginnen met waarschuwen over het bijna verlopen van de kluisregel.

Einddatum en waarschuwingsperiode
Afbeelding 52. Einddatum en waarschuwingsperiode

5.3. Wachtwoordsterkte

Van elke wachtwoord in de kluis wordt een schatting gemaakt van de sterkte. Indien het wachtwoord niet als zeer sterk wordt beoordeeld, wordt deze sterkte achter de naam van de kluisregel weergeven. Afhankelijk van de sterkte wordt de gebruiker in meer of mindere mate aangespoord om het wachtwoord te wijzigen:

Rood

Het wachtwoord is zeer zwak en dient zo spoedig mogelijk vervangen te worden door een sterker wachtwoord.

Oranje

Het wachtwoord heeft een matige sterkte. Indien de applicatie waar het wachtwoord bij hoort dit accepteert, wordt aangeraden een sterker wachtwoord te kiezen.

Lichtgroen

Het wachtwoord is sterk maar minder sterk dan een door Topicus KeyHub gegenereerd wachtwoord. Voor de zekerheid kan het wachtwoord vervangen worden.

Geen indicator

Het wachtwoord zeer sterk en waarschijnlijk gegenereerd.

Bij een wachtwoord kan ook een indicatie staan voor een duplicaat-wachtwoord. Hergebruik van hetzelfde wachtwoord voor verschillende diensten is onverstandig. Indien de wachtwoorden bij verschillende diensten horen, dienen deze beiden veranderd te worden.

Topicus KeyHub kan automatisch wachtwoorden genereren. Deze wachtwoorden zijn zeer sterk, uniek en bestaan uit hoofdletters, kleine letters, cijfers en speciale tekens. Gebruik bij voorkeur deze gegenereerde wachtwoorden. Indien een door KeyHub gegenereerd wachtwoord te lang is voor een website, kort het dan handmatig in tot de gewenste lengte.
Wachtwoordsterkte-indicatie
Afbeelding 53. Wachtwoordsterkte-indicatie

5.4. Kluisregels verplaatsen, kopiëren of delen

De knop achter de naam van de kluis dient om de regel naar een andere kluis te verplaatsen, kopiëren of delen. Deze acties zijn alleen uit te voeren door de manager van de groep of de eigenaar van de persoonlijke kluis. Als een regel gedeeld wordt met één of meer andere kluizen, zal elke wijziging op het origineel direct doorgevoerd worden in alle andere kluizen. Indien de naam van een gedeelde kopie is gewijzigd in de kluis waarin deze zich bevind, wordt deze niet overschreven. De gedeelde kopieën kunnen wel verwijderd worden, waarbij het origineel zal blijven bestaan. Als het origineel verwijderd wordt, zullen alle gedeelde kopieën ook verwijderd worden. Ook is het mogelijk een tijdsduur op te geven voor het delen, zodat de gedeelde kopie automatisch verwijderd wordt na het verstrijken van deze tijdsduur.

Kluisregels verplaatsen
Afbeelding 54. Kluisregels verplaatsen, kopiëren of delen
Het is mogelijk om kluisregels te verplaatsen of kopiëren naar kluizen waar de gebruiker zelf niet bij kan. In dit geval zal de operatie niet ongedaan gemaakt kunnen worden door de gebruiker zelf. Topicus KeyHub zal middels de onderstaande waarschuwing om een extra bevestiging vragen.
Bevestig verplaatsen of kopiëren van een kluisregel
Afbeelding 55. Bevestig verplaatsen of kopiëren van een kluisregel

5.5. Toegang tot kluizen

Het beheer van een groepskluis valt onder de verantwoordelijkheid van de managers van de groep. Bij het toevoegen van een lid aan een groep krijgt dit lid automatisch toegang tot een eventueel aanwezige kluis. Echter, bijvoorbeeld bij een wachtwoordreset zal toegang tot kluizen verloren gaan. Indien een lid van de groep geen toegang meer heeft tot de kluis, zal deze gebruiker de volgende melding getoond krijgen bij het openen van een regel:

Geen toegang tot een kluis
Afbeelding 56. Geen toegang tot een kluis

Hier kan de gebruiker een verzoek indienen bij de managers van de groep om weer toegang te krijgen tot de kluis.

5.6. Persoonlijke kluis

Elke gebruiker kan wachtwoorden en bestanden opslaan in een persoonlijke kluis. Deze kluis is enkel benaderbaar voor deze gebruiker. Het is niet mogelijk om andere gebruikers toegang te geven tot een persoonlijke kluis. Wel is het mogelijk om regels te verplaatsen van de persoonlijke kluis naar een groepskluis.

Regels in een persoonlijke kluis zijn niet meer benaderbaar als het KeyHub-account gedeactiveerd wordt. Bij verwijdering van het account worden alle regels in de kluis ook verwijderd. Het is daarom niet verstandig privé-wachtwoorden in de persoonlijke kluis op te slaan. De kluis is enkel bedoeld voor werkgerelateerde accounts.

5.7. Wachtwoorden exporteren

Met de knop 'Exporteren' kan de inhoud van een kluis geëxporteerd worden als CSV-bestand. Enkel de persoonlijke kluis of een kluis van een groep waar de gebruiker manager van is kan geëxporteerd worden.

TOTP-geheimen en bestanden worden niet geëxporteerd, evenals kluisregels die gedeeld zijn vanuit andere kluizen. Omdat het export-formaat gelijk is aan het import-formaat, bevat deze een lege kolom voor de TOTP-geheimen.
Wachtwoorden exporteren
Afbeelding 57. Wachtwoorden exporteren

6. Beheer toegang

Bij Beheer toegang wordt een lijst met alle groepen getoond waar de gebruiker toegangsbeheer voor kan uitvoeren. Leden van groepen met technisch beheer en managers van groepen met toegang tot systemen kunnen hier deze toegang beheren. Bij elke groep wordt onder de naam getoond welke rechten de gebruiker heeft binnen de groep: technisch beheer en/of management-rechten. Ook wordt bij elke groep een lijst getoond met applicaties, gekoppelde systemen, groepen binnen deze systemen, interne directories en webhooks.

Beheer toegang
Afbeelding 58. Beheer toegang

Voor elke regel binnen de groep zijn de volgende eigenschappen zichtbaar:

Naam

De volledige naam van de applicatie, het systeem, de groep, de interne directory of de webhook.

Type

Het type van de applicatie, interne directory of het gekoppelde systeem.

Technisch beheer

De groep met technisch beheer van de applicatie of het gekoppelde systeem. Deze kolom is niet beschikbaar bij een groep op een gekoppeld systeem, een interne directory of een webhook.

Verantwoordelijke

De groep die verantwoordelijk is voor de applicatie, de groep op een gekoppeld systeem of de interne directory. Deze kolom is niet beschikbaar bij een gekoppeld systeem of een webhook.

Toegang

Indien de groep toegang heeft tot de applicatie of de koppelgroep kan deze toegang hier geconfigureerd of verwijderd worden. Deze kolom is niet beschikbaar bij een gekoppeld systeem, een interne directory, een webhook of als de groep geen toegang heeft tot de applicatie of koppelgroep.

6.1. Beheer van applicaties en/of koppelingen

Bij groepen waarbij Applicatiebeheer is ingeschakeld kunnen applicaties en gekoppelde systemen aangemaakt en bewerkt worden. Het beheer van een applicatie en koppelingen omvat de technische configuratie van de applicatie of koppeling inclusief eventuele webhooks. De technisch beheerder kan groepen toevoegen aan een gekoppeld systeem of applicatie, waarbij die groep toegang krijgt. Dit verzoek moet geaccordeerd worden door een verantwoordelijke voor de applicatie of koppelgroep (zie hieronder). Voor meer uitleg over deze onderwerpen zie het hoofdstuk over applicaties of het hoofdstuk over gekoppelde systemen.

6.2. Verantwoordelijkheid dragen over applicaties en/of koppelgroepen

Verantwoordelijkheid over applicaties en groepen op een gekoppeld systeem wordt gedragen door managers van een aangewezen groep. De beslissing over het verlenen van toegang tot een applicatie of koppelgroep valt onder deze verantwoordelijkheid. Ook kan de verantwoordelijke het technischbeheer en/of de verantwoordelijkheid overdragen aan een andere groep. Dit verzoek moet geaccordeerd worden door een manager uit de andere groep.

6.3. Toegang tot een applicatie

Toegang tot een applicatie kan twee betekenissen hebben, afhankelijk van het type applicatie en de configuratie. De meest voorkomende relatie is SSO: de gebruikers van de groep kunnen d.m.v. SSO inloggen op de applicatie. De uitzondering is de OAuth2-client, waarbij de applicatie zelf toegang heeft tot de gegevens van de groep in Topicus KeyHub, zoals de kluis. Ook is het mogelijk dat een OAuth2-client rechten krijgt toegewezen die normaal bij de leden van de groep liggen.

De volgende eigenschap kan worden ingesteld bij een SSO-applicatie:

Activatie vereist

Om toegang te krijgen tot deze applicatie dient de gebruiker eerst de groep te activeren op het dashboard.

Toegang tot een applicatie
Afbeelding 59. Toegang tot een applicatie

Bij een OAuth2-client worden de toegekende rechten getoond. Deze rechten kunnen desgewenst ingetrokken worden. Zie het hoofdstuk over rechten voor OAuth 2.0 clients voor meer details over deze rechten.

Rechten voor een OAuth2-Client binnen een groep
Afbeelding 60. Rechten voor een OAuth2-Client binnen een groep

6.4. Toegang tot een groep op een gekoppeld systeem

De volgende eigenschap kan worden gekozen bij een groep op een gekoppeld systeem:

Statische accountprovisioning

Indien aangevinkt, is deze groep niet meer door een gebruiker te activeren. In plaats daarvan zal de groep altijd actief zijn. Voor alle leden van deze groep zal het account met deze groep ingeschakeld blijven zolang de gebruikers lid blijven van de groep.

Toegang tot een groep op een gekoppeld systeem
Afbeelding 61. Toegang tot een groep op een gekoppeld systeem

6.5. Beheren van accounts in een interne directory

Managers van de verantwoordelijk groep van een interne directory kunnen via Beheer toegang de accounts van de directory inzien en beheren. Dit kunnen ze doen door de interne directory te openen en te navigeren naar accounts.

7. Beheer toegangsprofielen

Toegangsprofielen zijn onderdeel van de identity and lifecycle management-module van Topicus KeyHub. Deze module is op dit moment nog in ontwikkeling.

8. Auditlog

Het auditlog biedt een overzicht van alle events waar de ingelogde account rechten op heeft. Voor alle gebruikers geldt dat de events met betrekking tot het eigen account inzichtelijk zijn. Voor alle gebruikers geldt dat de events met betrekking tot de groepen waarvan ze lid zijn inzichtelijk zijn. Voor leden van de "Keyhub administrators" en "Auditor" groepen zijn alle events inzichtelijk.

Auditlog
Afbeelding 62. Auditlog

Elke regel in het auditlog bevat drie kolommen: datum, tijd en het daadwerkelijke event. Door te scrollen verschijnen er automatisch meer regels. Er worden initieel regels getoond tot twee weken terug. Voor oudere events kan op ZOEK VERDER TERUG geklikt. Deze optie verschijnt onderaan de getoonde events.

8.1. Filteren van events

Er kan gefilterd worden op verschillende criteria. Na het selecteren van de criteria kan op ZOEKEN worden gedrukt om de events die voldoen aan de opgegeven criteria te tonen.

Toon alleen eigen records

Deze optie is alleen beschikbaar voor leden van de "Keyhub administrators" en "Auditor" groepen. Door deze optie aan te vinken worden gefilterd op events met betrekking tot het eigen account en groepen waarvan de gebruiker lid is.

Toon dagelijks gebruik

Door deze optie aan te vinken komen er bij (ALLE RECORDTYPES) een aantal record types extra beschikbaar die standaard voor het behoud van overzicht niet getoond worden. Deze extra opties komen vervolgens beschikbaar voor selectie.

Alle recordtypes

Hier kan gekozen worden welkt recordtypes getoond moeten worden.

Door Toon dagelijks gebruik aan te vinken verschijnen hier extra opties.
Zoek op keywords…​

Hier ingevulde waarden worden als filter voor de te tonen events gebruikt.

Ouder dan…​

Alleen events ouder dan de geselecteerde datum worden getoond.

Exporteren

Genereert een csv bestand met de gefilterde events. Voordat de export gemaakt wordt verschijnt een popup waarin het datum bereik aangepast kan worden. Zodra op EXPORTEREN wordt gedrukt wordt het csv bestand gegenereerd en gedownload.

Auditlog export
Afbeelding 63. Exporteren events

Het csv bestand bevat de volgende waarden:

seq,"timestamp","type","by party (UUID)","by party (name)","account (UUID)","account (name)","group (UUID)","group (name)","group2 (UUID)","group2 (name)","groupClassification (UUID)","groupClassification (name)","directory (UUID)","directory (name)","client (UUID)","client (name)","system (UUID)","system (name)","service account (UUID)","service account (name)","certificate (UUID)","certificate (name)","vault record (UUID)","vault record (name)","webhook (UUID)","webhook (name)","request (UUID)","organizational unit (UUID)","organizational unit (name)","access profile (UUID)","access profile (name)","security level","parameter 1","parameter 2","parameter 3"

9. Profiel

De Profiel-pagina bevat de mogelijkheid om verschillende voorkeuren te wijzigen en de eigen activiteit te monitoren.

9.1. Account

In eerste instantie wordt het Account-tabblad getoond. Op dit scherm worden de meest relevante eigenschappen van het account weergegeven. Ook kan de gebruiker hier wijzigingen maken in de beveiliging van zijn of haar account.

Account
Afbeelding 64. Account

9.1.1. Wachtwoordgebruik

Binnen Topicus KeyHub worden wachtwoorden voor verschillende doeleinden gebruikt. Om de verschillende opties die KeyHub biedt op gebied van wachtwoordbeheer te kunnen begrijpen, is het belangrijk deze doeleinden te kennen. Daarnaast maakt KeyHub onderscheid tussen drie wachtwoorden: het directory-wachtwoord, het KeyHub-wachtwoord en het tijdelijke wachtwoord. Deze wachtwoorden worden voor de volgende doelen gebruikt:

Authenticatie

Het directory-wachtwoord dient als de primaire factor voor authenticatie. De gebruiker wordt bij het aanmelden om dit wachtwoord gevraagd, en deze vraag wordt elke 4 uur herhaald.

Versleuteling kluizen

De kluizen van een gebruiker zijn cryptografisch versleuteld met het KeyHub-wachtwoord. Dit wachtwoord wordt daarom gevraagd bij het openen van de kluizen.

Gekoppelde systemen

Accounts van gebruikers binnen gekoppelde systemen worden voorzien van het KeyHub-wachtwoord. Bij het inloggen op diensten die authenticeren tegen een gekoppeld systeem zal dit wachtwoord opgegeven moeten worden. Bij gebruik van een roterend wachtwoord wordt hier het tijdelijke wachtwoord gebruikt in plaats van het KeyHub-wachtwoord.

Met de link Wachtwoorden instellen kunnen deze wachtwoorden, en de manier waarop ze gebruikt worden, ingesteld worden. In drie stappen wordt de gebruiker geholpen met het kiezen van een veilig wachtwoord en de juiste opties voor synchronisatie. Bij de eerste stap wordt gevraagd om het huidige wachtwoord ter authenticatie van de gebruiker. Hier dient het directory-wachtwoord ingevuld te worden.

Afhankelijk van het type directory van het account kunnen de vragen in deze schermen afwijken. Zo zal bij een account uit een externe directory niet opnieuw om het wachtwoord gevraagd worden en is het ook niet mogelijk om de wachtwoorden te synchroniseren.
Wachtwoordgebruik stap 1
Afbeelding 65. Wachtwoordgebruik stap 1

Bij de tweede stap wordt de kluis van de gebruiker geopend. Indien de gebruiker nog geen kluis heeft, of het wachtwoord van de kluis gelijk is aan het directory-wachtwoord hoeft de gebruiker hier niets te doen. Wordt er wel om een wachtwoord gevraagd dan dient het KeyHub-wachtwoord ingevoerd te worden.

Wachtwoordgebruik stap 2
Afbeelding 66. Wachtwoordgebruik stap 2

Bij de laatste stap worden daadwerkelijk de wijzigingen opgegeven.

Bij onduidelijkheid over de opties m.b.t. de wachtwoorden is het raadzaam contact op te nemen met een beheerder binnen de organisatie.
Wachtwoordgebruik stap 3
Afbeelding 67. Wachtwoordgebruik stap 3
Synchroniseer met directory

Het wachtwoord van de gebruiker binnen zijn directory wordt gelijkgetrokken met het wachtwoord van KeyHub. Hiermee kan nooit onduidelijkheid ontstaan over welk wachtwoord benodigd is. Het nadeel is dat mogelijk het wachtwoord in de directory van de gebruiker aangepast dient te worden. Hierdoor kan het wachtwoord dat de gebruiker hanteert voor andere diensten zoals e-mail ook veranderen.

Kies een nieuw wachtwoord

Afhankelijk van de lengte van het huidige KeyHub- of directory-wachtwoord kan deze optie verplicht zijn. Het wachtwoord dat hiermee gekozen kan worden, is het KeyHub-wachtwoord. Indien gekozen is voor synchronisatie van het wachtwoord zal het nieuwe KeyHub-wachtwoord ook teruggeschreven worden in de directory. Na opslaan wordt de kluis van de gebruiker beveiligd met dit wachtwoord. Indien niet gebruik gemaakt wordt van een roterend wachtwoord zal dit wachtwoord ook gebruikt worden voor de gekoppelde systemen.

Gebruik roterend wachtwoord

Normaal gesproken zal het wachtwoord op de gekoppelde systemen altijd gelijk zijn aan het KeyHub-wachtwoord. Het gevaar bestaat, dat als dit wachtwoord uitlekt, er misbruik gemaakt kan worden van het account van de gebruiker op alle gekoppelde systemen voor een langere tijd. Door te kiezen voor een roterend wachtwoord zal KeyHub dit wachtwoord iedere dag aanpassen. Het "wachtwoord van de dag" kan eenvoudig opgevraagd worden op het dashboard of via het oogje onderin het hoofdmenu. Dit wachtwoord geldt voor alle gekoppelde systemen; het KeyHub-wachtwoord wordt enkel nog voor de kluis gebruikt.

Alles uitloggen

Deze optie is alleen zichtbaar als een nieuw wachtwoord wordt gekozen en zorgt ervoor dat alle andere sessies voor dit account worden uitgelogd na het aanpassen van het wachtwoord. De huidige sessie zal ingelogd blijven, maar op alle andere apparaten of in andere browsers zal de gebruiker worden uitgelogd, waarna deze opnieuw zal moeten inloggen met het nieuwe wachtwoord. Dit is meestal een goed idee omwille van de veiligheid en deze optie staat daarom ook standaard aan.

9.1.2. 2FA

Naast een regulier wachtwoord dient iedere gebruiker van KeyHub zogenaamde two-factor-authentication (2FA) in te stellen. Hiervoor kan men een security key gebruiken, of een mobiele telefoon inclusief een app met ondersteuning voor het TOTP-protocol. Elke FIDO2-compatibele security key zou moeten werken. Voor TOTP wordt de Topicus KeyHub-app aangeraden, aangezien deze app zogenaamde push-notificaties ondersteunt. Hiermee hoeft de gebruiker enkel Ja of Nee te kiezen bij het inloggen in plaats van een 6-cijferige code overtypen. Alternatieve apps zijn Google Authenticator, Duo Mobile en Microsoft Authenticator.

Security key

Als de gebruiker op de link om een nieuwe security key toe te voegen klikt, toont KeyHub een popup en probeert automatisch te koppelen met een beschikbare security key. Dit zal de browser middels een notificatie ook aangeven. Activeer de security key simpelweg op de normale manier om te bevestigen dat men deze wilt koppelen aan KeyHub. KeyHub slaat de gekoppelde security key automatisch op.

Gebruikers kunnen meer dan één security key koppelen, bijvoorbeeld een voor op kantoor en een voor thuis. Het is ook mogelijk om een TOTP-app te combineren met één of meer security keys.

Overzicht security keys
Afbeelding 68. Overzicht security keys

Op dit scherm is het ook mogelijk om een security key te verwijderen van een account.

Standaard genereert KeyHub een naam voor de security key. Gebruikers kunnen deze naam bewerken zodat de security key beter herkenbaar is.

Bewerk security key
Afbeelding 69. Bewerk security key
2FA app

Het (opnieuw) instellen van 2FA gaat via de betreffende knop waarna er een zogenaamde QR-code verschijnt.

2FA instellen
Afbeelding 70. 2FA instellen
Topicus KeyHub-app

Na het scannen van deze code met de Topicus KeyHub-app, zal het venster het type van de mobiel tonen. Indien dit overeenkomt, kan 2FA ingeschakeld worden met Activeer. Bij het inloggen ontvangt de gebruiker een push-notificatie op de mobiel waarmee direct ingelogd kan worden.

De Topicus KeyHub-app heeft een internetverbinding nodig voor het koppelen en het ontvangen van push-notificaties. De app biedt, na activatie, ook de mogelijkheid om de 6-cijferige code in te voeren, indien er geen internetverbinding is.
Alternatieve apps

Indien een alternatieve app gebruikt wordt, zal deze app na het scannen van de QR-code het account in de app toevoegen. Om de koppeling definitief te maken, dient de 6-cijferige verificatiecode ingevoerd te worden in bovenstaand scherm. Na Activeer zal de 2FA actief zijn en wordt er na het inloggen in KeyHub om de 2FA-code gevraagd die via de app gegenereerd kan worden.

Apparaat verloren of onbruikbaar

Het kan natuurlijk altijd gebeuren dat een security key of mobiele telefoon defect raakt, gestolen wordt of op een andere manier onbruikbaar raakt. In dit geval kan de gebruiker mogelijk niet meer inloggen.

Als de gebruiker meer dan één 2FA-methode gekoppeld heeft (dus meerdere security keys of minstens één security key en een TOTP-app), kan deze de onbruikbare methode simpelweg verwijderen. Een gebruiker kan echter de laatste 2FA methode nooit zelf verwijderen.

In het geval dat de gebruiker geen enkele bruikbare 2FA-methode meer over heeft, kan deze een volledige reset van alle beschikbare 2FA-methoden aanvragen. Indien de gebruiker nog ingelogd is, kan deze via de link op de Profielpagina een dergelijke reset aanvragen.

2FA resetten
Afbeelding 71. 2FA Resetten

Om de 2FA te resetten kan daarvoor een reden ingevoerd te worden. De aanvraag wordt beoordeeld door een KeyHub-administrator en indien deze goedgekeurd wordt, zal daarvan een email verstuurd worden.

Bij aanschaf van een nieuwe mobiel dient de link 2FA opnieuw instellen gebruikt te worden om de nieuwe mobiel te koppelen. KeyHub zal hierbij mogelijk nog vragen om de 2FA-code die uit de oude mobiel gehaald kan worden. Na het koppelen, kan het account uit de app van de oude mobiel verwijderd worden en is de nieuwe mobiel klaar voor gebruik.

9.1.3. Gekoppelde systemen

Aan de rechterkant van het Account-tabblad is een overzicht zichtbaar van de accounts op de verschillende gekoppelde systemen. Deze informatie kan verschillen met het type van het gekoppelde systeem.

9.1.4. Taal wijzigen

KeyHub is beschikbaar in de talen Engels, Nederlands en Duits. Via de link Taal wijzigen kan de de gewenste taal gekozen worden.

Taal wijzigen
Afbeelding 72. Taal wijzigen

9.1.5. Public key voor SSH

Indien veel gebruik gemaakt wordt van SSH, bijvoorbeeld om op Linux-systemen in te loggen, is het aan te raden om een SSH-key in te stellen. Deze SSH-key zal door KeyHub automatisch verspreid worden over de gekoppelde systemen, waardoor de gebruiker zich veilig en zonder wachtwoord kan aanmelden. Plak de inhoud van het public key-bestand in het invoerveld. Deze waarde begint met ssh-rsa en eindigt met het e-mailadres.

Public key voor SSH
Afbeelding 73. Public key voor SSH
SSH-key genereren op Windows

Onder Windows kan PuTTYgen gebruikt worden om een SSH-key te genereren. Vul bij Key comment het e-mailadres in en een sterke passphrase. Selecteer SSH-2 RSA en kies een lengte van 4096 bits. Na het genereren kan de private-key opgeslagen worden en de public-key kan gekopieerd worden uit het bovenste vak. Plak de public-key in het invoerveld in KeyHub en sla op. Om de SSH-key te gebruiken binnen PuTTY kan deze bij een SSH session geselecteerd worden of er kan gebruik gemaakt worden van Pageant.

SSH-key genereren op Linux en MacOS

Een SSH-key kan onder Linux of MacOS gegenereerd worden met het volgende commando:

ssh-keygen -t rsa -b 4096 -C "your_email@example.com"

Na het volgen van de instructies van ssh-keygen zal een private- en public-key weggeschreven worden op de opgegeven locatie. De inhoud van het bestand eindigend op .pub dient in het veld geplakt te worden.

9.1.6. Browser-extensie

De browser-extensie voor Topicus KeyHub kan gebruikt worden om direct vanuit de browser de kluizen te benaderen. De extensie is beschikbaar voor Mozilla Firefox, Google Chrome en Microsoft Edge. Ga voor installatie van de extensie naar de webstore voor Google Chrome, Mozilla Firefox of Microsoft Edge. Na installatie dient de extensie gekoppeld te worden op de profiel-pagina binnen Topicus KeyHub.

9.2. Actieve sessies

Sessies blijven binnen KeyHub twee weken geldig, onafhankelijk van het wel of niet gebruiken van KeyHub. Gedurende de geldigheid van de sessie zal KeyHub elke vier uur opnieuw om het wachtwoord vragen en iedere week om 2FA. Een uitzondering hierop is bij een verandering van het IP-adres vanaf waar de gebruiker inlogt: KeyHub zal dan opnieuw om zowel het wachtwoord als 2FA vragen.

Onder het tabje sessies kan een overzicht opgevraagd worden van alle actieve sessies. Van alle sessies wordt de gebruikte browser, de datum van gebruik en de IP-adressen (indien beschikbaar met locatie) getoond. Indien het apparaat waarop een sessie loopt in verkeerde handen gekomen is, kan de sessie op afstand beëindigd worden om misbruik te voorkomen. Met de Alles uitloggen knop kunnen alle sessies behalve de huidige in één keer uitgelogd worden.

Sessies
Afbeelding 74. Sessies

9.3. Applicaties met toestemming

Bij gebruik van Single Sign-on zal KeyHub bij het inloggen toestemming vragen aan de gebruiker voor het delen van informatie en/of toegang.

De applicaties waarvoor de gebruiker deze toestemming gegeven heeft, worden onder applicaties getoond. Hier is voor iedere applicatie zichtbaar welke toegang deze applicatie heeft en kan deze toegang ook ingetrokken worden. Na het intrekken van de toegang van een applicatie zal voor die applicatie opnieuw om toestemming gevraagd worden bij aanmelden op de betreffende applicatie.

Applicaties
Afbeelding 75. Applicaties

10. Vierogenprincipe

KeyHub voorkomt dat één enkele persoon volledige toegang kan krijgen tot alle systemen en informatie binnen een organisatie. Het principe van decentrale autorisatie is hierin bepalend: rechten worden decentraal, door managers van een groep, uitgedeeld. Echter, ook met KeyHub zijn er een aantal punten van centraal beheer nodig. Het gevaar bestaat dat deze centrale beheerders (binnen KeyHub zijn dit de leden van de groep KeyHub-Administrators) zichzelf volledige toegang kunnen verschaffen. Om dit te voorkomen, wordt binnen KeyHub veelvuldig het vierogenprincipe toegepast. Het vierogenprincipe binnen KeyHub houdt in dat een gebruiker een voorstel indient dat door een andere gebruiker goedgekeurd moet worden.

Openstaand verzoek als indiener
Afbeelding 76. Openstaand verzoek als indiener

Een ingediende aanvraag wordt bij de gebruiker op het dashboard getoond. Hier is inzichtelijk wat het onderwerp van het verzoek is, de opgegeven reden en de gebruikers bij wie het verzoek open staat. De indiener van het verzoek kan het verzoek intrekken als het niet meer van toepassing is. Zodra een verzoek goedgekeurd is, zal het verdwijnen van het dashboard. Een verzoek dat afgekeurd is, blijft nog een paar dagen zichtbaar, inclusief een mogelijke reden tot afkeur.

Openstaand verzoek als verwerker
Afbeelding 77. Openstaand verzoek als verwerker

Voor een administrator of manager wordt een verzoek ook op het dashboard getoond. Via de knoppen Toestaan of Weigeren kan het verzoek afgehandeld worden. Na het kiezen van toestaan of weigeren kan een reden opgegeven worden, waarna opgeslagen kan worden.

10.1. Soorten verzoeken

Binnen Topicus KeyHub bestaan verschillende soorten verzoeken. Deze verschillende verzoeken zullen hieronder behandeld worden.

10.1.1. Groep betreden

Een gebruiker wil toegang tot de groep en mogelijk bijbehorende kluis.

Ingediend door

Elke gebruiker binnen KeyHub met een actief account dat nog niet lid is van de groep.

Behandeld door

Een manager van de betreffende groep.

Na accepteren

De gebruiker is toegevoegd aan de groep en heeft direct toegang tot alle applicaties van de groep en de kluis.

Opties bij accepteren

De gebruiker kan direct manager gemaakt worden van de groep en/of er kan een einddatum ingesteld worden voor het lidmaatschap.

10.1.2. Kluis betreden

Een lid van de groep wil (opnieuw) toegang tot de kluis van de groep krijgen. Leden van een groep kunnen de toegang tot de kluis kwijtraken bij het resetten van hun wachtwoord.

Ingediend door

Een lid van de groep.

Behandeld door

Een manager van de groep.

Na accepteren

De gebruiker krijgt direct toegang tot de kluis van de groep.

10.1.3. Verlengde toegang

Een lid van de groep wil voor langere tijd de groep activeren.

Ingediend door

Een lid van de groep.

Behandeld door

Een manager van de groep.

Na accepteren

De eindtijd van activatie van de groep wordt op de gekozen dag gezet.

Opties bij indienen

De einddatum voor de activatie.

10.1.4. Activatieverzoek

Een lid van groep A wil deze groep activeren en activatie wordt geautoriseerd wordt door groep B.

Ingediend door

Een lid van groep A.

Behandeld door

Een lid, dus niet alleen managers, van groep B.

Na accepteren

Het lid van groep A kan de groep activeren met als uiterlijke eindtijd de ingestelde termijn.

Opties bij accepteren

Een uiterlijke termijn waarbinnen de groep geactiveerd kan worden. Instelbaar tussen 1 uur en 2 weken.

10.1.5. Groepslidmaatschap aanpassen

Een manager van groep A wil een gebruiker toevoegen of het groepslidmaatschap aanpassen en het beheer van groepslidmaatschap wordt geautoriseerd door groep B.

Ingediend door

Een manager van groep A.

Behandeld door

Een lid, dus niet alleen managers, van groep B.

Na accepteren

De gebruiker wordt toegevoegd aan groep A of de eigenschappen van het lidmaatschap worden aangepast.

Opties bij indienen

De gebruiker kan manager gemaakt worden van de groep en/of er kan een einddatum voor het lidmaatschap opgegeven worden.

10.1.6. Groepsaudit reviewen

Een manager van groep A wil een audit laten reviewen door groep B.

Ingediend door

Een manager van groep A.

Behandeld door

Een lid, dus niet alleen managers, van groep B.

Na accepteren

De audit wordt definitief gemaakt en de voorgestelde wijzigingen worden doorgevoerd.

10.1.7. Authorisatie instellen

Een manager van groep A wil extra autorisatie op groep B instellen of stopzetten. Extra autorisatie kan aangevraagd worden voor activatie van de groep, voor het beheer van lidmaatschap of het uitvoeren van audits.

Ingediend door

Een manager van groep A.

Behandeld door

Een manager van groep B.

Na accepteren

De extra autorisatie door groep A is ingesteld of stopgezet voor groep B.

10.1.8. Geneste groep instellen

Een manager van groep A wil groep B nesten binnen groep A, of deze genestheid verwijderen.

Ingediend door

Een manager van groep A.

Behandeld door

Een manager van groep B.

Na accepteren

Groep B is genest binnen groep A, of de genestheid is verwijderd.

Opties bij indienen

Bestaande groepslidmaatschappen kunnen behouden, omgezet of verwijderd worden.

10.1.9. Recht toekennen

Een beheerder van een OAuth2 client wil een recht toekennen aan de applicatie.

Ingediend door

Een lid van de groep met technisch beheer van de OAuth2 client.

Behandeld door
  • Een manager van de gekozen groep, indien een selectie voor een groep vereist is tijdens het aanmaken van het verzoek.

  • Een manager van de verantwoordelijke groep van het gekozen gekoppelde systeem, indien een selectie voor een gekoppeld systeem vereist is tijdens het aanmaken van het verzoek.

  • Een lid van de KeyHub administrators, indien geen selectie voor een groep of een gekoppeld systeem vereist is bij het aanmaken van het verzoek.

Na accepteren

De OAuth2 client krijgt direct de extra rechten.

Opties bij indienen

Het type van het recht. Afhankelijk van het recht, een groep of een gekoppeld systeem.

10.1.10. Toegang tot een applicatie

Toegang voor groep A tot een applicatie onder de verantwoordelijkheid van groep B wordt aangevraagd.

Ingediend door

Een lid van de groep met technisch beheer van de applicatie.

Behandeld door

Een manager van groep B.

Na accepteren

De leden van groep A krijgen direct toegang tot de applicatie.

Bijzonderheid

Het verzoek wordt automatisch geaccepteerd als de gebruiker die de aanvraag indient manager is van groep B.

10.1.11. Koppelgroep aanmaken

Een lid van een groep met technisch beheer wil een koppelgroep aanmaken.

Ingediend door

Een lid van een groep met technisch beheer.

Behandeld door

Een lid van de inhoudsbeheerdersgroep van het gekozen gekoppeld systeem.

Na accepteren

De koppelgroep is aangemaakt met de aanvragende groep als verantwoordelijke.

Bijzonderheid

Het verzoek wordt automatisch geaccepteerd als de gebruiker die de aanvraag indient ook lid is van de inhoudsbeheerdersgroep van de koppeling.

10.1.12. Verzoek toegang tot een koppelgroep

Toegang voor groep A tot een koppelgroep onder de verantwoordelijkheid van groep B wordt aangevraagd.

Ingediend door

Een manager van groep A.

Behandeld door

Een lid van de inhoudsbeheerdersgroep van het gekoppeld systeem.

Na accepteren

Een nieuw verzoek wordt gestuurd aan de managers van groep B om groep A toegang te geven tot de koppelgroep.

Bijzonderheid

Het verzoek wordt automatisch geaccepteerd als de gebruiker die de aanvraag indient ook lid is van de inhoudsbeheerdersgroep van de koppeling.

10.1.13. Toegang tot een koppelgroep

Toegang voor groep A tot een koppelgroep onder de verantwoordelijkheid van groep B wordt aangevraagd.

Ingediend door

Een lid van de inhoudsbeheerdersgroep van het gekoppeld systeem.

Behandeld door

Een manager van groep B.

Na accepteren

De leden van groep A krijgen direct toegang tot de koppelgroep.

Bijzonderheid

Dit verzoek wordt automatisch aangemaakt zodra het bovenstaande verzoek wordt geaccepteerd. Het verzoek wordt automatisch geaccepteerd als de gebruiker die de aanvraag indient ook manager is van groep B.

10.1.14. Verantwoordelijkheid of (inhouds-)beheer overdragen

De verantwoordelijkheid of het technisch beheer van een applicatie, gekoppeld systeem, koppelgroep, serviceaccount, toegangsprofiel of organisatie-eenheid, of het inhoudsbeheer van een gekoppeld systeem, wordt aan de groep overgedragen.

Ingediend door

Een manager van de groep met verantwoordelijkheid.

Behandeld door

Een manager van de gekozen groep.

Na accepteren

De verantwoordelijkheid of het beheer wordt direct overgedragen aan de gekozen groep.

10.1.15. Serviceaccount aanmaken

Een lid van een groep met technisch beheer wil een serviceaccount aanmaken.

Ingediend door

Een lid van een groep met technisch beheer.

Behandeld door

Een lid van de inhoudsbeheerdersgroep van het gekozen gekoppeld systeem.

Na accepteren

Het serviceaccount is inactief aangemaakt.

Opties bij indienen

De gebruikersnaam van het serviceaccount en het gekoppeld systeem waarop deze aangemaakt moet worden.

10.1.16. Serviceaccount toegang geven tot een koppelgroep

Een lid van een groep met technisch beheer van een serviceaccount wil deze toegang geven tot een groep op het gekoppelde systeem.

Ingediend door

Een lid van de groep met technisch beheer over het serviceaccount.

Behandeld door

Een lid van de inhoudsbeheerdersgroep van het gekozen gekoppeld systeem.

Na accepteren

Een nieuw verzoek wordt gestuurd aan de managers van groep B om het serviceaccount te koppelen aan de koppelgroep.

Opties bij indienen

De groep op het gekoppelde systeem waar het serviceaccount toegang tot moet krijgen.

Bijzonderheid

Het verzoek wordt automatisch geaccepteerd als de gebruiker die de aanvraag indient ook lid is van de inhoudsbeheerdersgroep van het gekoppelde systeem.

10.1.17. Koppel een koppelgroep aan een serviceaccount

Geef een serviceaccount toegang tot een groep op het gekoppelde systeem.

Ingediend door

Een lid van de inhoudsbeheerdersgroep van het gekozen gekoppeld systeem.

Behandeld door

Een manager van groep met verantwoordelijkheid over de gekozen groep op het gekoppelde systeem.

Na accepteren

Het serviceaccount wordt op het gekoppelde systeem toegevoegd aan de groep.

Opties bij indienen

De groep op het gekoppelde systeem waar het serviceaccount toegang tot moet krijgen.

Bijzonderheid

Het verzoek wordt automatisch geaccepteerd als de gebruiker die de aanvraag indient ook manager is van de groep met verantwoordelijkheid over de groep op het gekoppelde systeem.

10.1.18. Namespace aanmaken

Een lid van een groep met technisch beheer wil een namespace aanmaken.

Ingediend door

Een lid van een groep met technisch beheer.

Behandeld door

Een lid van de technisch beheergroep van het gekozen basissysteem.

Na accepteren

De namespace is aangemaakt met de aanvragende groep als inhoudsbeheerder en verantwoordelijke.

Opties bij indienen

De naam van de namespace.

Opties bij accepteren

De RDN voor groups en serviceaccounts van de nieuwe namespace.

10.1.19. Verwijder een gekoppeld systeem

Een andere gebruiker wil een gekoppeld systeem verwijderen.

Ingediend door

Een lid van de groep met het technisch beheer over het gekoppelde systeem.

Behandeld door

Een manager van de verantwoordelijke groep voor het gekoppelde systeem.

Na accepteren

Het gekoppeld systeem en alle aanverwante gegevens zijn verwijderd.

10.1.20. Maak een nieuwe groep

Een gebruiker wil een nieuwe groep aanmaken.

Ingediend door

Elke gebruiker binnen KeyHub met een actief account.

Behandeld door

Een lid van de groep die is geconfigureerd onder instellingen of een KeyHub-administrator als dit niet is ingesteld.

Na accepteren

De groep is aangemaakt en de gebruiker die de aanvraag indiende is manager van de groep.

Bijzonderheid

Het verzoek wordt automatisch geaccepteerd als de gebruiker die de aanvraag indient KeyHub-administrator is.

10.1.21. Technisch beheer of toegangsprofielbeheer inschakelen

Een groepsmanager wil technisch beheer of toegangsprofielbeheer ingeschakeld hebben op de groep.

Ingediend door

Een manager van de groep.

Behandeld door

Een lid van de groep die is geconfigureerd onder instellingen of een KeyHub-adminstrator als dit niet is ingesteld.

Na accepteren

Technisch beheer of toegangsprofielbeheer is ingeschakeld op de groep.

10.1.22. Verwijder een groep

Een manager van een groep wil de groep verwijderen.

Ingediend door

Een manager van de groep.

Behandeld door

Een lid van de groep die is geconfigureerd onder instellingen of een KeyHub-adminstrator als dit niet is ingesteld.

Na accepteren

De groep en alle aanverwante gegevens zijn verwijderd.

10.1.23. Voeg manager toe aan groep

Een andere KeyHub-administrator wil een gebruiker manager maken van een groep zonder toestemming van een manager binnen deze groep.

Ingediend door

Een KeyHub-administrator.

Behandeld door

Een andere KeyHub-administrator.

Na accepteren

De gebruiker is manager van de groep. Indien de gebruiker nog geen lid was, wordt deze toegevoegd. De gebruiker krijgt geen toegang tot de kluis als hij deze nog niet had.

Bijzonderheid

Het verzoek wordt automatisch geaccepteerd als de indienende gebruiker naast de maintenance-gebruiker keyhub de enige KeyHub-administrator is.

10.1.24. Accordeer intern account

Een andere KeyHub-administrator wil een nieuwe gebruiker toevoegen aan een interne directory.

Ingediend door

Een KeyHub-administrator.

Behandeld door

Een andere KeyHub-administrator.

Na accepteren

De gebruiker is aangemaakt in de interne directory. De gebruiker moet het account nog wel activeren d.m.v. de activatielink in de e-mail.

Bijzonderheid

Het verzoek wordt automatisch geaccepteerd als de indienende gebruiker naast de maintenance-gebruiker keyhub de enige KeyHub-administrator is.

10.1.25. Herstel wachtwoord

Een gebruiker is het Topicus KeyHub-wachtwoord kwijt en wil toegang hersteld krijgen met een nieuw wachtwoord.

Ingediend door

Elke gebruiker binnen KeyHub met een actief account.

Behandeld door

Gebruikers uit de door KeyHub bepaalde herstelgroep:

  1. De leden van de helpdesk-groep indien dit ingesteld is.

  2. De eerste 10 managers van groepen die veel gebruikt worden door de gebruiker.

  3. Indien er bij stap 2 niet tenminste 5 managers gevonden worden, leden van de groep die is geconfigureerd onder instellingen, of KeyHub-adminstrators als dit niet is ingesteld.

Na accepteren

De gebruiker kan de toegang tot het account herstellen door het nieuwe wachtwoord in te voeren.

Bijzonderheid

Dit verzoek moet tenminste door 2 gebruikers geaccordeerd worden.

10.1.26. Schakel 2FA uit

Een gebruiker kan niet meer inloggen met 2FA en wil dit uitgeschakeld hebben.

Ingediend door

Elke gebruiker binnen KeyHub met een actief account.

Behandeld door

Gebruikers uit de door KeyHub bepaalde herstelgroep:

  1. De leden van de helpdesk-groep indien dit ingesteld is.

  2. De eerste 10 managers van groepen die veel gebruikt worden door de gebruiker.

  3. Indien er bij stap 2 niet tenminste 5 managers gevonden worden, leden van de groep die is geconfigureerd onder instellingen, of KeyHub-adminstrators als dit niet is ingesteld.

Na accepteren

2FA voor de gebruiker is uitgeschakeld. De gebruiker moet zelf 2FA opnieuw instellen om gebruik te kunnen blijven maken van alle onderdelen van Topicus KeyHub waar 2FA voor vereist is.

10.1.27. Verwijder admin

Een KeyHub-administrator wil iemand verwijderen uit de KeyHub Administrators-groep.

Ingediend door

Een KeyHub-administrator.

Behandeld door

Een andere KeyHub-administrator.

Na accepteren

De gekozen gebruiker is verwijderd uit de KeyHub administrators-groep.

10.1.28. Verwijder een organisatie-eenheid

Een KeyHub-administrator wil een organisatie-eenheid verwijderen.

Ingediend door

Een KeyHub-administrator.

Behandeld door

Een manager van de verantwoordelijke groep voor de organisatie-eenheid.

Na accepteren

De organisatie-eenheid is verwijderd en alle gekoppelde elementen zijn verplaatst naar de bovenliggende organisatie-eenheid.

11. Auditor-rol

De auditor-rol is instelbaar per organisatie-eenheid, waarbij dit standaard is toegewezen aan de KeyHub Administrators-groep. Als deze rol aan een groep is toegewezen, krijgt deze groep inzage in de groepen en gebruikers van de organisatie-eenheid en alle organisatie-eenheden die daar onder vallen. De auditor-rol wordt gekozen via de instellingen van de organisatie-eenheid. Indien er slechts één organisatie-eenheid is, en de KeyHub Administrators zijn eigenaar van deze organisatie-eenheid, is het ook mogelijk om de rol in te stellen bij de centrale instellingen.

Wanneer de auditor-rol is overgedragen aan een andere groep en deze groep wordt verwijderd, zal de auditor-rol opnieuw worden toegewezen aan de KeyHub Administrators-groep.

Leden van de groep met de auditor-rol krijgen toegang tot twee dashboards, het groepen-dashboard en het accounts-dashboard.

11.1. Auditor-groepen-dashboard

Op dit dashboard is een overzicht te zien van alle groepen in Topicus KeyHub binnen de organisatie-eenheid en alle onderliggende organisatie-eenheden. Voor elke groep wordt getoond hoeveel managers en leden deze heeft, alsmede informatie over uitgevoerde audits, auditdeadlines en kluisregels. Door op de classificatie te klikken kan de classificatie van de groep aangepast worden.

Ook is het mogelijk een uitgebreide export in CSV-formaat te genereren van alle groepen, gefilterd op de huidige selectiecriteria.

Auditor-groepen-dashboard
Afbeelding 78. Auditor-groepen-dashboard

11.2. Details van een groep

Door op een groep te klikken, kan meer informatie over de groep opgevraagd worden. Alle audits en de volledige auditlog van de groep is inzichtelijk. Ook is het mogelijk om direct een audit te verzoeken voor de groep. Managers van de groep zullen dit verzoek in de e-mail en als notificatie op het dashboard krijgen. Raadpleeg de sectie over groepen auditen voor meer informatie over audits.

Auditor-groepdetails
Afbeelding 79. Auditor-groepdetails

11.3. Classificaties

Groepen kunnen via het auditor-dashboard ingedeeld worden in classificaties. Door in het dashboard op de classificatie te klikken kan de classificatie van de groep aangepast worden. Via de menu-optie Classificaties kunnen deze classificaties beheerd worden.

Bij een groepsclassificatie kunnen de volgende velden ingesteld worden:

UUID

Een unieke identifier voor de groepsclassificatie binnen Topicus KeyHub.

Naam

De naam van de groepsclassificatie zoals deze door de gehele applicatie getoond wordt aan gebruikers.

Maximum auditinterval

Geef aan hoeveel tijd er maximaal mag zitten tussen de audits bij de periodieke audit van de groepen met deze classificatie. Wanneer er volgens het auditschema geen audit gepland staat binnen dit auditinterval, worden de groepsmanagers genotificeerd. Via deze notificatie kan het auditschema automatisch bijgesteld worden of naar het bewerken van de groep worden genavigeerd.

Verplichte auditmaanden

Geef aan dat groepen met deze classificatie altijd een audit moeten uitvoeren in de geselecteerde maanden. Wanneer er volgens het auditschema geen audit gepland staat in de geselecteerde maanden, worden de groepsmanagers genotificeerd. Via deze notificatie kan het auditschema automatisch bijgesteld worden of naar het bewerken van de groep worden genavigeerd.

"Leg audit-trail vast" vereisen

Geef aan dat de optie "Leg audit-trail vast" geactiveerd dient te worden bij groepen met deze classificatie. Wanneer deze optie niet geactiveerd is, worden de groepsmanagers genotificeerd. Via deze notificatie kan de optie direct geactiveerd worden of naar het bewerken van de groep worden genavigeerd.

"Roterend wachtwoord verplicht" vereisen

Geef aan dat de optie "Roterend wachtwoord verplicht" geactiveerd dient te worden bij groepen met deze classificatie. Wanneer deze optie niet geactiveerd is, worden de groepsmanagers genotificeerd. Via deze notificatie kan de optie direct geactiveerd worden of naar het bewerken van de groep worden genavigeerd.

"Activatie verplicht voor kluistoegang" vereisen

Geef aan dat de optie "Activatie verplicht voor kluistoegang" geactiveerd dient te worden bij groepen met deze classificatie. Wanneer deze optie niet geactiveerd is, worden de groepsmanagers genotificeerd. Via deze notificatie kan de optie direct geactiveerd worden of naar het bewerken van de groep worden genavigeerd.

"Autoriserende groep voor activatie" vereisen

Geef aan dat er een groep ingesteld dient te worden bij "Autoriserende groep voor activatie" bij groepen met deze classificatie.

"Autoriserende groep voor lidmaatschap" vereisen

Geef aan dat er een groep ingesteld dient te worden bij "Autoriserende groep voor lidmaatschap" bij groepen met deze classificatie.

"Groep met gedelegeerde rechten" vereisen

Geef aan dat er een groep ingesteld dient te worden bij "Groep met gedelegeerde rechten" bij groepen met deze classificatie.

"Autoriserende groep voor audits" vereisen

Geef aan dat er een groep ingesteld dient te worden bij "Autoriserende groep voor audits" bij groepen met deze classificatie.

Minimum aantal managers

Geef een minimum aantal managers, tenminste 1, aan dat een groep met deze classificatie moet hebben. Wanneer een groep minder managers heeft dan hier ingesteld, worden de groepsmanagers genotificeerd. Via deze notificatie kan naar het bewerken van de groep worden genavigeerd om nieuwe managers te selecteren.

Omschrijving

Een uitgebreidere omschrijving van de groepsclassificatie.

Een groepsclassificatie
Afbeelding 80. Een groepsclassificatie

11.4. Auditor-accounts-dashboard

Op dit dashboard is een overzicht te zien van alle accounts in Topicus KeyHub binnen de organisatie-eenheid en alle onderliggende organisatie-eenheden. Voor elke account wordt o.a. getoond uit welke directory deze komt, wanneer het voor het laatst actief was en wat voor 2FA er is ingesteld.

Ook is het mogelijk een uitgebreide export in CSV-formaat te genereren van alle accounts, gefilterd op de huidige selectiecriteria.

Auditor-accounts-dashboard
Afbeelding 81. Auditor-accounts-dashboard

11.5. Details van een account

Door op een account te klikken, kan meer informatie over de account opgevraagd worden. Alle groepen waar dit account lid van is worden getoond, inclusief de rol binnen de groep en wanneer het account voor het laatst via deze groep binnen KeyHub toegang heeft verkregen tot iets anders.

Auditor-accountdetails
Afbeelding 82. Auditor-accountdetails

11.6. Auditor-serviceaccounts-dashboard

Op dit dashboard is een overzicht te zien van alle serviceaccounts in Topicus KeyHub binnen de organisatie-eenheid en alle onderliggende organisatie-eenheden. Voor elke account wordt getoond of het ingeschakeld is, de wachtwoordrotatiemodus en door welke groep het wordt beheerd.

Ook is het mogelijk een uitgebreide export in CSV-formaat te genereren van alle serviceaccounts, gefilterd op de huidige selectiecriteria.

Auditor-serviceaccounts-dashboard
Afbeelding 83. Auditor-serviceaccounts-dashboard

11.7. Details van een serviceaccount

Door op een account te klikken, kan meer informatie over de account opgevraagd worden. De koppelgroepen waar dit serviceaccount toegang toe heeft worden getoond, tesamen met de laatste relevante audit records.

Auditor-serviceaccount-details
Afbeelding 84. Auditor-serviceaccount-details

Beheer

12. Gebruikersaccounts

Voor het gebruik van KeyHub is altijd een account vereist. Via het gebruikersaccounts-overzicht kan een beheerder inzien welke accounts er geregistreerd zijn. Naast enkele algemene gegevens van het account is hier ook inzichtelijk wanneer een account voor het laatst gebruikt is, of two-factor authentication ingeschakeld is en of het account geldig is. Door te klikken op een account kan het account in detail bekeken worden.

Gebruikersaccounts-overzicht
Afbeelding 85. Gebruikersaccounts-overzicht

12.1. Details

De gegevens van een account zijn niet direct aanpasbaar in Topicus KeyHub aangezien deze worden overgenomen uit de directories. Een uitzondering hierop zijn accounts uit interne directories. Bij de accountdetails kunnen deze gegevens ingezien worden. Wel is het mogelijk om enkele statusvelden van het account aan te passen:

Gebruikersnaam

De gebruikersnaam bij welke het account bekend is in Topicus KeyHub.

Actief

Schakel een account centraal volledig aan of uit. Een inactief account kan niet gebruikt worden.

Licentie rol

Wisselt de licentierol van de account. Business accounts hebben minder mogelijkheden dan Pro accounts. KeyHub administrators kunnen geen Business account zijn.

Directory

De directory waarin het account zich bevindt.

Identifier binnen directory

De primaire identificatie van het account binnen de directory. Wanneer deze identifier verandert of het account verplaatst wordt naar een andere directory kan hier een herregistratie gestart worden. Voor meer informatie, zie hieronder.

Geldig in directory

Geeft aan of het account nog geldig is in de bijbehorende directory. Deze status wordt elke 24 uur bijgewerkt of door het klikken op de link. Een account dat niet meer geldig is in de directory kan niet gebruikt worden ongeacht of de status al bijgewerkt is.

Two factor status

Geeft aan of 2FA ingeschakeld is voor het account. Via de link kan 2FA uitgeschakeld worden waarna de gebruiker het opnieuw moet inschakelen.

Wachtwoord- en 2FA-herstelstatus

Toont of er voor het account een verzoek open staat voor herstel van het wachtwoord of de 2FA. Als dit het geval is, kan dit verzoek afgewezen worden.

Mag groepen aanvragen

Normaliter kunnen gebruikers zelf lidmaatschappen van groepen aanvragen. Voor accounts die zeer beperkte rechten moeten hebben, kan dit uitgeschakeld worden. Deze accounts moeten dan door de groepsmanagers zelf aan de groepen toegevoegd worden.

E-mail

Het e-mailadres voor de gebruiker, overgenomen uit de directory.

Accountdetails
Afbeelding 86. Accountdetails

12.2. Een account hernoemen of verplaatsen

Als de identifier van een account aangepast wordt in de directory kan de gebruiker niet meer inloggen. Hetzelfde zal optreden als een account verplaatst wordt naar een andere directory. Om een account binnen een directory te hernoemen, of zelfs geheel naar een andere directory te verhuizen, wordt de link 'Hernoemen/verhuizen' gebruikt. Na het markeren van het account voor hernoemen, moet de gebruiker bij inloggen het account heractiveren. Hierbij wordt de gebruiker gevraagd om zijn of haar Topicus KeyHub-wachtwoord en 2FA (indien ingeschakeld). Hierna moet de gebruiker opnieuw een directory kiezen en authenticeren tegen deze directory. Indien toegestaan bij de directory, kan de gebruiker een andere gebruikersnaam kiezen, anders wordt de gebruikersnaam overgenomen uit de directory. Na herregistratie kan de gebruiker opnieuw inloggen met de nieuwe authenticatie.

Het is mogelijk dat de gebruiker een nieuwe gebruikersnaam krijgt. Deze nieuwe gebruikersnaam zal ook gebruikt worden op gekoppelde systemen.

12.3. Attributen

Via het menu-item Attributen kunnen eventuele opgeslagen attributen ingezien worden. Bij de directory kan ingesteld worden welke attributen opgeslagen worden.

Accountattributen
Afbeelding 87. Accountattributen

12.4. Auditlog

Via het menu-item Auditlog kan de auditlog over het geselecteerde account getoond worden. De auditlog die hier getoond wordt, bevat dezelfde regels als wat de gebruiker in kwestie zou zien. Dit betekent dat naast alle persoonlijke regels, ook regels getoond worden die gericht zijn aan het geselecteerde account. Via de filterbalk kan de log gefilterd worden op specifieke regels.

Auditlog voor een account
Afbeelding 88. Auditlog voor een account

12.5. Accounts opruimen

Bij verloop binnen een organisatie zullen ongebruikte accounts achterblijven in Topicus KeyHub. Deze accounts kunnen niet meer gebruikt worden zodra het account in de directory ongeldig wordt, maar zullen wel blijven bestaan in Topicus KeyHub. KeyHub administrators kunnen deze accounts in bulk opruimen. Er kan gezocht worden op accounts met verschillende statussen, uit verschillende directories of die al een bepaalde tijd ongebruikt zijn. Ook is het mogelijk om handmatig de gebruikersnamen van de accounts op te voeren, of dit als CVS-export uit een ander programma over te nemen. De gezocht of opgevoerde accounts kunnen vervolgens met een enkele klik verwijderd worden. Mocht niet mogelijk of toegestaan zijn om bepaalde accounts te verwijderen, dan wordt dit bij de specifieke accounts vermeld.

Topicus KeyHub controleert éénmaal per dag de status van de accounts binnen directories die dit ondersteunen (Active Directory en LDAP). Dit proces loopt rond 6 uur in de ochtend. Het is ook mogelijk handmatig bij een account de status te verversen.
Met deze functionaliteit is het mogelijk om zeer snel, veel accounts te verwijderen. Review altijd de lijst met te verwijderen accounts voor deze daadwerkelijk te verwijderen. Het verwijderen van accounts kan niet ongedaan gemaakt worden.
Accounts opruimen
Afbeelding 89. Accounts opruimen

12.6. Accounts bulk wijzigen

Op de bulk wijzigen pagina kunnen accounts in bulk worden overgezet naar een andere licentierol of worden hernoemd. Het is bijvoorbeeld mogelijk om alle accounts die in een bepaalde groep zitten, in één keer over te zetten naar 'Pro' accounts.

Accounts in de KeyHub administrator groep worden niet getoond.

Accounts bulk wijzigen
Afbeelding 90. Accounts bulk wijzigen

13. Serviceaccounts

Serviceaccounts zijn non-personal-accounts die gebruikt kunnen worden voor systeemprocessen. Deze accounts worden beheerd door een groep en aangemaakt op een gekoppeld systeem. Via het serviceaccounts-overzicht kan een beheerder inzien welke serviceaccounts er geregistreerd zijn.

Serviceaccounts-overzicht
Afbeelding 91. Serviceaccounts-overzicht

13.1. Details

De volgende eigenschappen kunnen ingesteld worden op een serviceaccount:

Actief

Het serviceaccount zal alleen aangemaakt worden op het gekoppelde systeem als deze actief is.

UUID

Een unieke identifier voor het serviceaccount binnen KeyHub.

Naam

De naam van het serviceaccount zoals deze aan gebruikers getoond wordt.

Technisch beheerdersgroep

Leden van deze groep voeren het technisch beheer van dit serviceaccount uit. Alle leden mogen het serviceaccount bewerken of verwijderen.

Koppeling

Het gekoppelde systeem waarop het serviceaccount wordt aangemaakt.

Gebruikersnaam

De gebruikersnaam van het serviceaccount op het gekoppelde systeem. Een eventuele prefix wordt hier nog aan toegevoegd.

Wachtwoordrotatie

Geeft aan hoe het wachtwoord van het serviceaccount beheerd moet worden. Wachtwoorden voor serviceaccounts worden gegenereerd. Het is mogelijk om dit automatisch dagelijks te roteren, waarbij het wachtwoord in de kluis van groep wordt geplaatst. Bij handmatige rotatie kan gekozen worden om het wachtwoord wel of niet te plaatsen in de kluis van de groep.

Wachtwoord

Het wachtwoord van het serviceaccount. Dit wachtwoord zal alleen getoond worden na een handmatige rotatie.

SSH public key

Een optionele SSH public key die bij het serviceaccount geplaatst wordt, indien het gekoppelde systeem dit ondersteunt.

Omschrijving

Een omschrijving van het serviceaccount. Deze omschrijving wordt ook toegevoegd op het gekoppelde systeem.

Serviceaccount
Afbeelding 92. Serviceaccount

13.2. Groepen op systeem

Een serviceaccount kan toegevoegd worden aan één of meer groepen op het gekoppelde systeem waar het serviceaccount bestaat. Via deze groepen kan het serviceaccount rechten toegekend krijgen op het systeem zelf of op achterliggende applicaties. Toegang tot een groep moet worden aangevraagd en wordt behandeld door de groep met verantwoordelijkheid over de groep op het gekoppelde systeem.

Groepen voor een serviceaccount
Afbeelding 93. Groepen voor een serviceaccount

14. Groepen

Rechten worden in KeyHub uitgedeeld via groepen. De aanwezige groepen kunnen bij het groepenoverzicht ingezien worden.

De tabel toont naast de naam en omschrijving ook een samenvatting van de groep. De verschillende elementen in deze tabel zijn klikbaar en gaan direct naar de bijbehorende subpagina van de groep. Groepen worden automatisch ingedeeld in categorieën aan de hand van het eerste woord in de naam van de groep.

Groepenoverzicht
Afbeelding 94. Groepenoverzicht

14.1. Details

De directe eigenschappen van een groep worden beheerd onder details. Enkel managers van de groep kunnen deze details bewerken. Zie groepen beheren voor een uitleg van de getoonde velden.

Groepsdetails
Afbeelding 95. Groepdetails

14.2. Accounts

Onder het menu-item Accounts wordt getoond welke gebruikers lid zijn van de groep. Als KeyHub-administrator valt het beheer van groepslidmaatschappen buiten de eigen verantwoordelijkheden; dit wordt door de groepsmanager gedaan (zie Vierogenprincipe). Wel is het mogelijk om met twee administrators een nieuwe manager van de groep aan te wijzen. Dit kan gebruikt worden in de situatie dat de bestaande managers van de groep niet beschikbaar zijn.

Accounts in een groep
Afbeelding 96. Accounts in een groep

14.3. Applicaties

Een groep kan rechten geven tot Single Sign-on op bepaalde applicaties. Het koppelen van een applicatie aan een groep wordt gedaan door de technisch beheerder voor de applicatie en moet geaccordeerd worden door de verantwoordelijke voor de betreffende applicatie.

Applicaties in een groep
Afbeelding 97. Applicaties in een groep

14.4. Koppelingen

Een groep kan rechten geven op toegang tot bepaalde groepen in gekoppelde systemen. Deze groepen zijn dan in te schakelen op het dashboard. Het koppelen van een groep op een gekoppeld systeem aan een groep in KeyHub wordt gedaan door de technisch beheerder van het gekoppelde systeem. Dit verzoek moet goedgekeurd worden door de verantwoordelijke voor de betreffende koppelgroep.

Koppelingen in een groep
Afbeelding 98. Koppelingen in een groep

15. Directories

Een account in KeyHub komt altijd uit een directory. Er zijn verschillende type directories:

Maintenance

Elke KeyHub-installatie heeft een maintenance directory. Deze directory bevat exact één account: het keyhub-account. Dit speciale account kan alleen ingeschakeld worden door KeyHub te herstarten in maintenance mode.

LDAP

De LDAP-directory wordt gebruikt om gebruikers te authenticeren tegen Microsoft Active Directory, OpenLDAP of een andere LDAP v3 compliant directory. Met een LDAP-directory kunnen gebruikers zelf hun KeyHub-account registreren via de loginpagina, mits deze voldoet aan de ingestelde eisen. Door KeyHub op deze manier aan een corporate directory te koppelen, kan het accountbeheer volledig centraal binnen het bedrijf of een divisie uitgevoerd worden.

OIDC

De OpenID Connect (kortweg OIDC) directory wordt gebruikt om gebruiker te authenticeren tegen een OpenID Provider (OP). KeyHub wordt via Single Sign-on verbonden met de OP. Gebruikers kunnen zelf via de loginpagina hun KeyHub-account registreren. Het accountbeheer vindt, net als bij een LDAP-directory, centraal plaats binnen de OP.

Intern

Bij een interne directory worden de accounts volledig binnen KeyHub beheerd. Deze vorm van accountbeheer is vooral geschikt voor het uitdelen van accounts aan gebruikers die niet in de corporate directory staan. Gebruikers worden door twee KeyHub-administrators geregistreerd en kunnen hun account activeren door middel van een registratie-e-mail.

Directory-overzicht
Afbeelding 99. Directory-overzicht

15.1. LDAP-directory

Met een LDAP-directory kan KeyHub authenticeren tegen een LDAP v3 compliant directory zoals Microsoft Active Directory of OpenLDAP. Gebruikers registreren zelf hun KeyHub-account waarbij de relevante gegevens overgenomen worden uit de directory. Accountgegevens worden bij elke inlogpoging gevalideerd tegen de LDAP-directory waardoor een account direct onbruikbaar wordt zodra deze in de LDAP-directory uitgeschakeld of verwijderd wordt.

De volgende velden kunnen ingesteld worden:

Actief

Gebruikers kunnen zich alleen authenticeren als de directory actief is. Door een directory te deactiveren worden alle gebruikers uit deze directory dus per direct buitengesloten.

UUID

Een unieke identifier voor de directory binnen KeyHub.

Basisorganisatie-eenheid

Gebruikers uit de directory zijn altijd lid van deze organisatie-eenheid en kunnen alleen lid worden van organisatie-eenheden onder deze eenheid. Deze waarde kan alleen aangepast worden bij directories die geen gebruikers bevatten.

Naam

De naam van de directory zoals deze door de gehele applicatie getoond wordt aan gebruikers. Kies een herkenbare naam, want ook nieuwe gebruikers moeten de juiste directory kunnen kiezen tijdens de registratie.

Dialect

Hoewel LDAP v3 gestandaardiseerd is, zitten er subtiele verschillen in het dialect dat verschillende systemen gebruiken. Indien het gebruikte systeem niet in de lijst staat, kies dan OpenLDAP.

Primaire host

De hostname van de primaire LDAP server. Bij het gebruik van een beveiligde verbinding (sterk aanbevolen) kan hier het IP-adres niet gebruikt worden.

Failover host

De hostname van de secundaire LDAP server. Dit veld is optioneel. Indien het leeg gelaten wordt, kan KeyHub bij een communicatiefout met de primaire server niet terugvallen op een andere server. De failover host wordt alleen gebruikt als er een communicatiefout optreedt met de primaire server.

Port

Het poortnummer waarop de LDAP server luistert. De standaard poort is 389. Bij het gebruik van LDAPS kan gekozen worden voor 636. Voor alle poorten anders dan 636 zal KeyHub bij gebruik van een beveiligde verbinding StartTLS gebruiken.

TLS

Over de verbinding met de LDAP server worden ook wachtwoorden van gebruikers verstuurd. Het is daarom sterk aan te bevelen een beveiligde verbinding te gebruiken. Raadpleeg het hoofdstuk over certificaten voor meer details.

Vertrouwd certificaat

Via dit certificaat kan aangegeven worden welk certificaat vertrouwd moet worden bij het opzetten van een beveiligde verbinding. Indien dit veld leeg gelaten wordt, zal gebruik gemaakt worden van de standaard Java-truststore. Raadpleeg het hoofdstuk over certificaten voor meer details.

Vertrouwd certificaat voor failover

Hetzelfde als bovenstaande, maar dan voor de failover host.

Bind DN

De volledige DN waarop gebind moet worden voor het uitvoeren van zoekopdrachten naar accounts binnen de directory. Het is aan te bevelen hiervoor een read-only account te gebruiken in de LDAP server.

Bind wachtwoord

Het wachtwoord waarmee gebind moet worden.

Clientcertificaat

Bij gebruik van clientauthenticatie worden Bind DN en Bind wachtwoord vervangen door een certificaat waarmee KeyHub zichzelf authenticeert bij de directory. Dit is de veiligste manier voor het opzetten van een verbinding met een directory.

Base DN

De DN in de directory waar binnen gezocht moet worden naar gebruikers.

Zoekfilter

Het LDAP filter waar gebruikers aan moeten voldoen om gebruikt te kunnen worden. Dit filter dient tenminste één term te bevatten met {}, waar de gebruikersnaam ingevuld wordt. Het filter mag enkel actieve accounts retourneren. Voor Microsoft Active Directory ziet dit er bijvoorbeeld als volgt uit (met extra enters voor de leesbaarheid):

(&(sAMAccountName={})
  (objectClass=user)
  (!(useraccountcontrol:1.2.840.113556.1.4.803:=2)))
Wachtwoordherstel in de directory

Schrijf bij wachtwoordherstel het wachtwoord terug in de directory. De gebruiker met het bind DN moet hiervoor voldoende rechten hebben. Let bij het gebruik van e-mail op dat een gebruiker die zijn wachtwoord vergeten is, mogelijk ook geen toegang meer heeft tot de e-mail. Indien 2FA gebruikt wordt voor herauthenticatie zal een gebruiker geen wachtwoord herstel kunnen uitvoeren als 2FA niet ingeschakeld staat op het account (of wanneer de 2FA-codes verloren zijn).

Helpdesk-groep

Leden van deze groep behandelen verzoeken voor wachtwoordherstel of tot het resetten van 2FA. Indien er geen groep ingesteld wordt, zullen de verzoeken behandeld worden door managers van groepen waar de gebruiker lid van is of de KeyHub Administrators.

Wijzigingen aan dit veld worden doorgevoerd zodra gebruikers opnieuw aanmelden. Voor gebruikers die nog niet opnieuw aangemeld hebben na een wijziging zullen de oude instellingen van kracht blijven.
Beperk instelbaarheid 2FA

Als deze optie ingeschakeld wordt, is het voor een gebruiker niet mogelijk om de 2FA-instellingen aan te passen. 2FA kan alleen ingesteld worden bij het aanmelden of nadat het gereset is door een KeyHub Administrator of lid van de helpdesk-groep.

Gebruikersnaam aanpasbaar

Gebruikers mogen zelf hun gebruikersnaam kiezen tijdens de registratie.

Standaarddirectory

De standaarddirectory wordt doorzocht bij authenticatie van een niet bestaand account. Als de inloggegevens van het account bestaan in de directory en correct zijn, wordt automatisch een registratie gestart.

Roterend wachtwoord

Geeft aan of nieuwe gebruikers standaard wel of niet een roterend wachtwoord krijgen bij registratie. Bij Altijd aan kan de gebruiker niet meer kiezen en zal de optie altijd ingeschakeld worden bij registratie. Bestaande gebruikers moeten de optie eerst inschakelen voordat een groep geactiveerd kan worden.

Attributen

Een lijst met attributen die uit de directory worden gelezen en bij het account worden opgeslagen. Deze attributen kunnen vervolgens worden gebruikt in scripts voor custom attributen. De namen van de attributen worden gescheiden door spaties.

LDAP-directory
Afbeelding 100. LDAP-directory

15.2. OIDC-directory

Met een OIDC-directory kan KeyHub authenticeren tegen een OpenID Connect Provider (OP). Gebruikers registreren zelf hun KeyHub-account waarbij de relevante gegevens overgenomen worden uit de directory. Inloggen op KeyHub vindt plaats via een Single sign-on met de OP waardoor een account direct onbruikbaar wordt zodra deze in de OP uitgeschakeld of verwijderd wordt.

De volgende velden kunnen ingesteld worden:

Actief

Gebruikers kunnen zich alleen authenticeren als de directory actief is. Door een directory te deactiveren worden alle gebruikers uit deze directory dus per direct buitengesloten.

UUID

Een unieke identifier voor de directory binnen KeyHub.

Basisorganisatie-eenheid

Gebruikers uit de directory zijn altijd lid van deze organisatie-eenheid en kunnen alleen lid worden van organisatie-eenheden onder deze eenheid. Deze waarde kan alleen aangepast worden bij directories die geen gebruikers bevatten.

Naam

De naam van de directory zoals deze door de gehele applicatie getoond wordt aan gebruikers. Kies een herkenbare naam, want ook nieuwe gebruikers moeten de juiste directory kunnen kiezen tijdens de registratie.

Aanbieder

Indien gebruik gemaakt wordt van Google of Microsoft Azure Active Directory kan dat hier aangegeven worden. Deze keuze verbetert de compatibiliteit met deze aanbieders, biedt extra mogelijkheden en vergemakkelijkt de configuratie.

OIDC Issuer identifier

Een OIDC Issuer identifier is een hoofdlettergevoelige https-URL. Deze bevat tenminste een schema en host en mogelijk een poortnummer en/of pad. De URL mag geen query of fragment bevatten. KeyHub maakt gebruik van OpenID Connect Discovery voor de configuratie van een OIDC-directory. De OpenID Provider dient dit te ondersteunen. De discovery-informatie is te vinden door achter de Issuer /.well-known/openid-configuration te plaatsen.

Client identifier

De identifier uitgegeven door de OpenID Provider waaronder KeyHub bekend is bij de OP.

Client secret

De secret behorende bij de bovenstaande identifier.

Domeinbeperking

Beschikbaar bij de keuze voor Google of Microsoft Azure Active Directory. Hiermee kan worden afgedwongen dat enkel accounts binnen een bepaald domein kunnen registreren.

Logout-URL

Indien de gekozen OpenID Connect Provider geen end_session_endpoint adverteert via het discovery endpoint, kan hier een eigen URL opgegeven worden voor uitloggen. Het is ook mogelijk om de geadverteerde URL te overschrijven middels dit veld.

Dwingt 2FA af

Indien de OpenID Provider zelf two-factor authentication afdwingt dient deze optie ingeschakeld te worden. Hiermee wordt voorkomen dat KeyHub nogmaals om 2FA gaat vragen. Gebruik deze optie enkel als 2FA verplicht is bij de OP, anders bestaat het risico dat gebruikers zonder 2FA gebruikmaken van KeyHub.

ACR-waarden

Een door spaties gescheiden lijst met ACR-waarden. Dit wordt doorgegeven als acr_values aan de IDP. Hiermee kan de IDP opgedragen worden om bepaalde vormen van authenticatie af te dwingen bij de gebruiker. Wanneer de IDP een acr-claim retourneert in het id_token, moet deze overeenkomen met één van de opgegeven waarden.

Stuur login_hint

Wanneer deze optie is ingeschakeld zal Topicus KeyHub een login_hint parameter meesturen naar de IDP. Deze hint kan de IDP helpen met het automatisch selecteren van het juiste account. Schakel deze optie uit als de IDP de opgegeven waarden niet begrijpt en daardoor verkeerde accounts selecteert.

Helpdesk-groep

Leden van deze groep behandelen verzoeken voor wachtwoordherstel of tot het resetten van 2FA. Indien er geen groep ingesteld wordt, zullen de verzoeken behandeld worden door managers van groepen waar de gebruiker lid van is of de KeyHub Administrators.

Wijzigingen aan dit veld worden doorgevoerd zodra gebruikers opnieuw aanmelden. Voor gebruikers die nog niet opnieuw aangemeld hebben na een wijziging zullen de oude instellingen van kracht blijven.
Beperk instelbaarheid 2FA

Als deze optie ingeschakeld wordt, is het voor een gebruiker niet mogelijk om de 2FA-instellingen aan te passen. 2FA kan alleen ingesteld worden bij het aanmelden of nadat het gereset is door een KeyHub Administrator of lid van de helpdesk-groep.

Gebruikersnaam aanpasbaar

Gebruikers mogen zelf hun gebruikersnaam kiezen tijdens de registratie.

Standaarddirectory

Bij authenticatie met een onbekende gebruikersnaam zal de gebruiker doorgestuurd worden naar deze directory. Indien de gebruiker een geldige authenticatie kan uitvoeren binnen de directory zal automatisch een registratie gestart worden.

Roterend wachtwoord

Geeft aan of nieuwe gebruikers standaard wel of niet een roterend wachtwoord krijgen bij registratie. Bij Altijd aan kan de gebruiker niet meer kiezen en zal de optie altijd ingeschakeld worden bij registratie. Bestaande gebruikers moeten de optie eerst inschakelen voordat een groep geactiveerd kan worden.

Attributen

Een lijst met attributen die uit de directory worden gelezen en bij het account worden opgeslagen. Deze attributen kunnen vervolgens worden gebruikt in scripts voor custom attributen. De namen van de attributen worden gescheiden door spaties.

OIDC-directory
Afbeelding 101. OIDC-directory

Aan de kant van de OpenID Provider dient zeer waarschijnlijk een 'callback-' of 'redirection-URI' opgegeven te worden. Hiervoor dient HOSTNAME/login/oidc ingevuld te worden. Indien gekozen kan worden voor meerdere profielen dient gekozen te worden voor 'webapplicatie' of een 'confidential client'.

15.3. Interne directory

Bij een interne directory vindt het gebruikersbeheer plaats binnen KeyHub. Het voornaamste doel van een interne directory is om het mogelijk te maken gebruikers te registreren die niet voorkomen in de gebruikte LDAP-directories. Een interne directory heeft slechts een paar eigenschappen:

Actief

Gebruikers kunnen zich alleen authenticeren als de directory actief is. Door een directory te deactiveren, worden alle gebruikers uit deze directory per direct buitengesloten.

UUID

Een unieke identifier voor de directory binnen KeyHub.

Basisorganisatie-eenheid

Gebruikers uit de directory zijn altijd lid van deze organisatie-eenheid en kunnen alleen lid worden van organisatie-eenheden onder deze eenheid. Deze waarde kan alleen aangepast worden bij directories die geen gebruikers bevatten.

Naam

De naam van de directory zoals deze door de gehele applicatie getoond wordt aan gebruikers.

Verantwoordelijke groep

Managers uit de gekozen groep zijn verantwoordelijk voor het beheer van gebruikers in deze directory. Zij kunnen gebruikers aanmaken, goedkeuren, bewerken en verwijderen. Deze verantwoordelijkheid wordt gedeeld met de KeyHub-administrators.

Helpdesk-groep

Leden van deze groep behandelen verzoeken voor wachtwoordherstel of tot het resetten van 2FA. Indien er geen groep ingesteld wordt, zullen de verzoeken behandeld worden door managers van groepen waar de gebruiker lid van is of de KeyHub Administrators.

Wijzigingen aan dit veld worden doorgevoerd zodra gebruikers opnieuw aanmelden. Voor gebruikers die nog niet opnieuw aangemeld hebben na een wijziging zullen de oude instellingen van kracht blijven.
Beperk instelbaarheid 2FA

Als deze optie ingeschakeld wordt, is het voor een gebruiker niet mogelijk om de 2FA-instellingen aan te passen. 2FA kan alleen ingesteld worden bij het aanmelden of nadat het gereset is door een KeyHub Administrator of lid van de helpdesk-groep.

Roterend wachtwoord

Geeft aan of nieuwe gebruikers standaard wel of niet een roterend wachtwoord krijgen bij registratie. Bij Altijd aan kan de gebruiker niet meer kiezen en zal de optie altijd ingeschakeld worden bij registratie. Bestaande gebruikers moeten de optie eerst inschakelen voordat een groep geactiveerd kan worden.

Interne directory
Afbeelding 102. Interne directory

15.4. Accounts in een directory

Bij het accountoverzicht binnen een directory kan ingezien worden welke accounts binnen een directory geregistreerd zijn. Bij een LDAP-directory is dit slechts een overzicht. Echter, bij een interne directory kunnen hier de accounts beheerd worden.

Accounts in een directory
Afbeelding 103. Accounts in een directory

15.5. Intern account

Een intern account is een account in een interne directory. De eigenschappen van een intern account spreken voor zich en zijn allemaal verplicht. Voor het aanmaken van een intern account is akkoord van een andere manager van de verantwoordelijke groep vereist.

Na goedkeuring van het aanmaakverzoek, moet er handmatig een e-mail gestuurd worden via het beheerscherm van het account. In deze e-mail, welke wordt gestuurd naar het gekoppelde e-mailadres, staan instructies voor activatie inclusief een activatiecode die één uur geldig is. Als de code verlopen is of de e-mail niet goed overgekomen, kan via het beheerscherm van het account een nieuwe code toegestuurd worden.

Intern account
Afbeelding 104. Intern account

16. Organisatie-eenheden

Organisatie-eenheden vormen een boom van verschillende onderdelen van de organisatie. De takken binnen de boom vormen afgeschermde delen binnen de inrichting van Topicus KeyHub. Gebruikers worden gekoppeld aan één of meer organisatie-eenheden. Enkel de inrichting binnen die organisatie-eenheden of de bovenliggenden eenheden is toegankelijk. Er kunnen maximaal 5 lagen van organisatie-eenheden aangemaakt worden. Nieuwe organisatie-eenheden worden altijd aangemaakt onder een reeds bestaande eenheid.

Organisatie-eenheden
Afbeelding 105. Organisatie-eenheden

16.1. Organisatie-eenheden beheren

Een organisatie-eenheid heeft een aantal eigenschappen:

Bovenliggende organisatie-eenheid

De organisatie-eenheid die direct boven deze organisatie-eenheid ligt. Elke organisatie-eenheid heeft een bovenliggende organisatie-eenheid, behalve het hoogste element van de boom. Het is niet mogelijk de bovenliggende organisatie-eenheid aan te passen.

UUID

Een unieke identifier voor de organisatie-eenheid binnen KeyHub.

Naam

De naam van de organisatie-eenheid zoals deze door de gehele applicatie getoond wordt aan gebruikers.

Voeg in boven

Deze optie is enkel beschikbaar bij het aanmaken van een nieuwe organisatie-eenheid. De nieuwe organisatie-eenheid zal aangemaakt worden met de aangevinkte organisatie-eenheden als onderliggende eenheden. Deze organisatie-eenheden krijgen dan de nieuwe organisatie-eenheid als bovenliggende organisatie-eenheid.

Verantwoordelijke groep

Managers van deze groep zijn verantwoordelijk voor het regelen van toegang tot de organisatie-eenheid. Dit betekent dat managers uit deze groep gebruikers kunnen toekennen aan de organisatie-eenheid, instellingen kunnen aanpassen en verzoeken over de organisatie-eenheid behandelen. Ook kunnen ze de verantwoordelijkheid overdragen aan een andere groep.

Omschrijving

Een uitgebreidere omschrijving van de organisatie-eenheid.

Organisatie-eenheid
Afbeelding 106. Organisatie-eenheid

16.2. Accounts binnen een organisatie-eenheid

Accounts worden altijd gekoppeld aan de basisorganisatie-eenheid van de directory waar ze bij horen. Dit geeft de gebruiker toegang tot alles dat tot die organisatie-eenheid of een bovenliggende eenheid behoort. Een lid van de verantwoordelijke groep van een organisatie-eenheid kan een account ook aan aanvullende organisatie-eenheden koppelen. Dit moet dan wel een organisatie-eenheid zijn die onder de basisorganisatie-eenheid van de directory valt. In het accounts-overzicht is te zien welke accounts gekoppeld zijn aan een organisatie-eenheid.

Accounts binnen een organisatie-eenheid
Afbeelding 107. Accounts binnen een organisatie-eenheid

16.3. Instellingen voor een organisatie-eenheid

Hier kunnen de instellingen worden opgegeven voor de organisatie-eenheid en de eenheden eronder als zij dit zelf niet specificeren.

Hint voor nieuwe groepsnamen

Toon een hint aan gebruikers bij het aanvragen van nieuwe groepen. Deze hint wordt als placeholder getoond in het veld voor de naam van de nieuwe groep. Vul hier bijvoorbeeld het verwachte formaat van een groepsnaam in.

'Groep aanmaken' goedkeuren

Verzoeken voor het aanmaken van nieuwe groepen worden behandeld door de gekozen groep in plaats van de KeyHub administrators.

'Technisch beheer inschakelen' goedkeuren

Verzoeken voor het inschakelen van technisch beheer op groepen worden behandeld door de gekozen groep in plaats van de KeyHub administrators.

'Groep verwijderen' goedkeuren

Verzoeken voor het verwijderen van groepen worden behandeld door de gekozen groep in plaats van de KeyHub administrators.

Wachtwoordherstel-reservegroep

Wachtwoordherstelverzoeken voor gebruikers met onvoldoende groepsmanagers worden ook gestuurd naar gebruikers in de gekozen groep in plaats van de KeyHub administrators.

Settings voor een organisatie-eenheid
Afbeelding 108. Settings voor een organisatie-eenheid

16.4. Groepen verplaatsen naar een andere organisatie-eenheid

Groepen kunnen worden veprlaatst tussen organisatie-eenheden. Dit is een verzoek van een manager van de verantwoordelijke groep van de 'latende' organisatie-eenheid, aan een manager van de verantwoordelijke groep van de 'ontvangende' organisatie-eenheid. Beide managers moeten tevens gekoppeld zijn aan beide organisatie-eenheden.

16.4.1. Groepen selecteren om the verplaatsen

Vanaf de detail pagina van de latende organisatie-eenheid, wordt de 'Groepen verplaatsen'-knop gebruikt om een request aan te maken om een of meer groepen te verplaatsen. Op de volgende pagina worden de te verplaatsen groepen en de ontvangende organisatie-eenheid gekozen.

.Selecteer groepen om naar een andere organisatie-eenheid te verplaatsen
Afbeelding 109. Selecteer groepen om naar een andere organisatie-eenheid te verplaatsen

16.4.2. Andere wijzigingen tijdens de verplaatsing

Klik op de 'Volgende' knop om op de bevestigingspagina uit te komen. Hier wordt een rapport getoond, met daarin de details van het verzoek en of het al dan niet kan worden uitgevoerd. Ook worden eventuele andere wijzigingen voor de te verplaatsen groepen getoond.

Na de verplaatsing moeten alle verbindingen tussen de verplaatste groepen en andere groepen nog steeds valide zijn. Dit betreft ook verbindingen zoals een service account die door de ene groep wordt beheerd, en die toegang heeft tot een koppelgroep van de andere groep. Als de eindsituatie niet meer valide zou zijn, zullen dergelijke verbindingen worden verwijderd.

Leden van een groep kunnen alleen lid blijven als ze al verbonden zijn met de ontvangende organisatie-eenheid. Zo niet, zal hun lidmaatschap worden ingetrokken.

Alle openstaande verzoeken van of voor de verplaatste groepen, en voor enig object onder hun beheer of verantwoordelijkheid, zullen worden ingetrokken.

Klik op de 'Verzoek' knop om het verzoek definitief in te sturen.

Andere wijzigingen tijdens het verplaatsen van groepen naar een andere organisatie-eenheid
Afbeelding 110. Andere wijzigingen tijdens het verplaatsen van groepen naar een andere organisatie-eenheid

16.4.3. Problemen die de verplaatsing verhinderen

Als er problemen zijn die verhinderen dat het verzoek kan worden uitgevoerd, worden deze getoond in plaats van eventuele wijzigingen.

Groepen die bepaalde rollen vervullen binnen KeyHub kunnen niet worden verplaatst.

Alle managers van een groep dienen meeverhuisd te kunnen worden, en na de verhuizing zal de groep nog steeds genoeg leden met kluistoegang moeten hebben.

Een geneste groepen-structuur zal in zijn geheel verplaatst moeten worden. Het is niet mogelijk een geneste groep te verplaatsen zonder de groep waaronder deze genest is, of vice versa.

Problemen bij het verplaatsen van groepen naar een andere organisatie-eenheid
Afbeelding 111. Problemen bij het verplaatsen van groepen naar een andere organisatie-eenheid

16.4.4. Het verplaatsverzoek accepteren

De 'Goedkeuren' knop voor het verplaatsverzoek op het dashboard stuurt de gebruiker naar de bevestiginspagina. Dit stelt de gebruiker in staat de wijzigingen of eventuele problemen te beoordelen.

De 'Goedkeuren' knop op deze pagina opent een popup waar de gebruiker eventueel feedback voor het verzoek kan achterlaten, en het verzoek uiteindelijk definitief kan accepteren.

Na het accepteren en uitvoeren van het verplaatsverzoek, wordt de provisioning via een achtergrondtaak gesynchroniseerd. Het kan dus even duren voor eventuele wijzigingen helemaal doorgewerkt zijn in alle gekoppelde systemen.

Het verplaatsverzoek accepteren
Afbeelding 112. Het verplaatsverzoek accepteren

17. Applicaties

Applicaties worden gebruikt voor Single Sign-on en/of server-to-server communicatie met Topicus KeyHub. In tegenstelling tot veel andere Single Sign-on oplossingen is de Single Sign-on met KeyHub groepsgebaseerd. Dit betekent dat gebruikers enkel kunnen inloggen op een applicatie als ze in de juiste groep zitten. Er worden 3 verschillende protocollen ondersteund: OAuth2/OIDC, SAML v2.0 en LDAP v3.

Applicaties
Afbeelding 113. Applicaties

17.1. OAuth 2.0/OpenID Connect applicatie

OAuth 2.0 is sinds eind 2012 gestandaardiseerd en is, in combinatie met OpenID Connect, uitgegroeid tot de standaard voor autorisatie en authenticatie. OAuth 2.0 is opgesplitst in een aantal RFCs, waarbij RFC 6749 en RFC 6750 de belangrijkste zijn. OpenID Connect is ontwikkeld door de OpenID working groups en de specificaties zijn te vinden op https://openid.net/developers/specs/. KeyHub ondersteunt de volledige core specificatie en discovery.

Voor het koppelen van een OAuth 2.0 applicatie geniet het sterk de voorkeur om gebruik te maken van de OpenID Connect discovery. Alle relevante informatie voor het opzetten van een SSO-koppeling is te vinden onder HOSTNAME/.well-known/openid-configuration.

De volgende eigenschappen kunnen ingesteld worden op een OAuth2 applicatie:

UUID

Een unieke identifier voor de applicatie binnen KeyHub.

Naam

De naam van de applicatie zoals deze aan gebruikers getoond wordt.

Launchpad-tegel

Toon de applicatie als een tegel op het launchpad. Zie het hoofdstuk over het launchpad voor meer informatie.

Technisch beheerdersgroep

Leden van deze groep voeren het technisch beheer van deze applicatie uit. Alle leden mogen de applicatie bewerken of verwijderen. Ook webhooks voor de applicatie worden door deze groep beheerd.

Verantwoordelijke groep

Managers van deze groep zijn verantwoordelijk voor het regelen van toegang tot de applicatie. Dit betekent dat managers uit deze groep de applicatie aan kunnen bieden aan andere groepen voor autorisatie (in andere woorden: leden van de andere groep krijgen toegang). Ook kunnen ze het technisch beheer of de verantwoordelijkheid overdragen aan een andere groep.

Ondersteunde grant types

De OAuth 2.0-specificatie maakt onderscheid tussen een aantal grant_types. KeyHub ondersteunt code en implicit voor SSO-doeleinden. Indien gebruikers via KeyHub op de applicatie aanmelden, dient deze optie gekozen te worden. Voor directe server-to-server-communicatie ondersteunt KeyHub client_credentials. Hierbij vraagt de applicatie zelf een access token aan en is geen interactie van een gebruiker vereist. De client kan uit eigen naam verdere requests bij KeyHub indienen. De command line interface is een voorbeeld van een dergelijke applicatie.

Deze optie kan niet meer veranderd worden na het opslaan van een nieuwe applicatie.
Profiel

OAuth 2.0 definieert een aantal profielen voor applicaties. Kies hier het profiel dat het beste aansluit bij de applicatie. De profielen staan hieronder uitgebreid beschreven. Deze optie is enkel beschikbaar bij code en implicit grants.

Toon landingspagina

Toont een landingspagina direct na het inloggen en vóór het doorverwijzen naar de SSO-applicatie. Bij native desktopapplicaties is het niet altijd mogelijk om het loginproces op een nette manier af te sluiten. Als de gebruiker bij het inloggen blijft steken op de laatst getoonde pagina in Topicus KeyHub, dan kan deze optie ingeschakeld worden. De gebruiker krijgt dan een nette melding dat het inlogproces is afgerond en dat het venster gesloten kan worden.

Debug-modus

Als deze optie ingeschakeld wordt, geeft de REST API van Topicus KeyHub eventuele fouten in zijn volledigheid terug. Deze informatie kan nuttig zijn met het troubleshooten van problemen met het aanroepen van de API. Echter, deze informatie kan door een eventuele aanvaller ook gebruikt worden om in-depth informatie over de interne werking van het systeem te verkrijgen. Laat deze optie daarom nooit aan staan op een productieomgeving.

Applicatie URIs

De URLs waaronder de applicatie draait, gescheiden door enters. Deze optie is enkel beschikbaar bij code en implicit grants. In de hostname en path kan één wildcard opgegeven worden als een range van alfanumerieke [a-zA-Z0-9] tekens of een kopppelteken. Bijvoorbeeld, {4-10} betekent dat elke URL wordt geaccepteerd die overeenkomt met de callback waarbij in plaats van deze range 4 t/m 10 alfanumerieke tekens staan. Het is daarnaast ook mogelijk om een bereik in poortnummers op te geven als [8080-8180]. De waarde van de OAuth redirect_uri parameter wordt geverifiëerd tegen deze waarden.

URI voor starten login

Een URI binnen de applicatie waarmee een third party login gestart kan worden. In de OpenID Connect-specificatie wordt dit de initiate_login_uri genoemd. Deze URI wordt gebruikt om vanuit KeyHub een IDP initiated login te kunnen starten. Deze optie is enkel beschikbaar bij code en implicit grants.

Toegestane scopes

Deze eigenschap geeft aan welke scopes deze applicatie mag aanvragen en beperkt zo de rechten die een applicatie kan krijgen op de REST-API. Voor SSO-oplossingen is het aanbevolen om hier alleen Profiel te kiezen. Deze optie is enkel beschikbaar bij code en implicit grants.

Custom attributen

Hier kunnen extra attributen gedefinieerd worden die op het userinfo uitgelezen kunnen worden. De mogelijkheden van deze attributen worden beschreven in Custom attributen. Deze optie is enkel beschikbaar bij code en implicit grants.

Claims voor het id_token

Een door spaties gescheiden lijst met claims. Deze claims worden toegevoegd aan het 'id_token', ook als de client hier niet expliciet om vraagt. Sommige clients verwachten extra claims in het 'id_token' zonder dat de specificatie dit voorschrijft. Via deze optie kunnen deze claims aangeboden worden. Het is ook mogelijk om custom attributen aan te bieden als claims in het 'id_token'.

Toegestane resource-URIs

Toegestane URIs voor resource indicators. Topicus KeyHub kan gebruikt worden als authorization server voor deze resource servers. Om een token aan te vragen voor een andere resource server, moet de URL van deze server meegegeven worden als resource parameter in the authorization request. Het hieruit verkregen OAuth 2.0 access token zal het formaat hebben dat beschreven staat in RFC 9068. In een resource URI kan één wildcard opgegeven worden als een range van alfanumerieke [a-zA-Z0-9] tekens of een kopppelteken. Bijvoorbeeld, {4-10} betekent dat elke URL wordt geaccepteerd die overeenkomt met de callback waarbij in plaats van deze range 4 t/m 10 alfanumerieke tekens staan. Het is daarnaast ook mogelijk om een bereik in poortnummers op te geven als [8080-8180]. Access tokens voor andere resource servers kunnen niet gebruikt worden op de backend van Topicus KeyHub zelf.

Toegang geven tot accounts en inrichting van groepen

Hiermee krijgt de client lees-toegang tot informatie over de accounts, gekoppelde systemen en andere clients bij de groepen waar de client aan gekoppeld is. Deze optie is enkel beschikbaar bij de client_credentials grant.

Client identifier

Dit unieke nummer wordt automatisch door KeyHub gegenereerd. De waarde van dit veld hoeft niet geheim gehouden te worden.

Secret

Deze waarde wordt door confidential clients gebruikt ter authenticatie. Deze waarde dient te allen tijde geheim gehouden te worden en wordt daarom ook alleen gegenereerd bij confidential clients. Mocht de waarde van dit veld toch uitlekken, kan een nieuwe waarde gegenereerd worden.

Het opnieuw genereren van de client secret invalideert de oude secret per direct waardoor gebruikers geen gebruik meer kunnen maken van de SSO-oplossing.
Secret in kluis opslaan

Indien ingeschakeld, wordt de secret van de client automatisch in de kluis geplaatst. Bij inschakelen op een bestaande client moet de secret geroteerd worden om deze optie te activeren.

17.1.1. OAuth 2.0-applicatieprofielen

De OAuth 2.0-specificatie beschrijft een drietal profielen: web application, user-agent-based application (hernoemd naar browser-based application in OAuth 2.1) en native application. Binnen Topicus KeyHub worden deze profielen ook gebruikt, met enkele uitbreidingen. De keuze voor een profiel bepaalt of een applicatie een client secret krijgt toegewezen en hoe er wordt omgegaan met refresh tokens.

Server-side webapplicatie

Een server-side webapplicatie is een applicatie die draait op een webserver. De applicatie houdt de tokens en secrets op de server, gescheiden van de eindgebruiker. Applicaties van dit type krijgen een client secret toegekend en kunnen onbeperkt gebruik maken van refresh tokens. Elk refresh token is 60 dagen geldig en deze termijn gaat opnieuw in bij gebruik.

Client-side browserapplicatie

Een client-side browserapplicatie is een applicatie die draait in de browser van de eindgebruiker, meestal in JavaScript. De eindgebruiker is in staat om alle informatie die door deze applicatie gaat te onderscheppen. Dit type applicaties is niet in staat om een client secret geheim te houden en krijgt deze dus ook niet toegekend. Vanwege de beperkte mogelijkheden om een refresh token veilig op te slaan, krijgen browserapplicaties ook geen refresh token. Access tokens zijn slechts één uur geldig. Na dit uur moet de gebruiker opnieuw de OAuth 2-authenticatieflow doorlopen om de applicatie van een nieuw access token te verstrekken.

Client-side browserapplicatie (met refresh tokens)

Dit type applicatie is gelijk aan het profiel dat hierboven beschreven staat, alleen wordt er nu wel een (beperkt) refresh token verstrekt. Voor sommige applicaties kan de uurlijkse herauthenticatie problematisch zijn en de gebruikerservaring teveel verslechteren. In deze gevallen kan gekozen worden voor dit profiel. De refresh tokens die aan de applicatie verstrekt worden, zijn 4 uur geldig en kunnen tot maximaal 12 uur na de uitgave van het eerste token ververst worden. Na deze 12 uur dient de gebruiker opnieuw de OAuth 2-authenticatieflow te doorlopen.

Publieke native applicatie

Een native applicatie wordt direct op het apparaat van de eindgebruiker geïnstalleerd. Dit kan een PC of mobiele telefoon zijn, maar bijvoorbeeld ook een smart TV. De applicatie wordt gedistribueerd via een publiek kanaal, zoals een store of een website. Er wordt aangenomen dat elke vorm van clientauthenticatie die in de applicatie is opgenomen, kan worden geëxtraheerd. Dit type applicaties krijgt daarom geen client secret toegekend. Omdat we geen aannames kunnen doen over de mate waarin een dergelijke applicatie tokens veilig kan opslaan, worden er ook geen refresh tokens verstrekt.

Publieke native applicatie met beveiligde opslag

Dit type applicatie is gelijk aan het profiel dat hierboven beschreven staat, met als toevoeging dat er met redelijke zekerheid gezegd kan worden dat tokens veilig opgeslagen kunnen worden. Mobiele telefoons bieden bijvoorbeeld de mogelijkheid om een beveiligd deel van de storage te gebruiken voor opslag van credentials. Doordat de tokens bij dit type applicatie veilig zijn, worden er wel refresh tokens verstrekt. Elk refresh token is 60 dagen geldig en deze termijn gaat opnieuw in bij gebruik.

Native applicatie met secret

Dit type applicatie is wederom een uitbreiding op het profiel dat hierboven beschreven staat, maar nu wordt het client secret via een apart kanaal gedeeld. De applicatie kan de tokens en het secret beiden veilig opslaan. Net als bij het bovenstaande profiel is elk refresh token 60 dagen geldig en gaat deze termijn opnieuw in bij gebruik.

OAuth 2.0/OIDC applicatie
Afbeelding 114. OAuth 2.0/OIDC applicatie

17.2. SAML v2.0 applicatie

SAML v2.0 is een oudere standaard uit 2005, gestandaardiseerd door OASIS. Vooral voor enterprise applicaties is SAML v2.0 een veelgebruikte oplossing. KeyHub neemt de rol van Identity Provider (IDP), de applicatie is een Service Provider (SP). Voor automatische configuratie van de Service Provider biedt KeyHub metadata onder HOSTNAME/login/saml2/metadata.

De volgende eigenschappen kunnen ingesteld worden op een SAML v2.0 applicatie:

UUID

Een unieke identifier voor de applicatie binnen KeyHub.

Naam

De naam van de applicatie zoals deze aan gebruikers getoond wordt.

Launchpad-tegel

Toon de applicatie als een tegel op het launchpad. Zie het hoofdstuk over het launchpad voor meer informatie.

Technisch beheerdersgroep

Leden van deze groep voeren het technisch beheer van deze applicatie uit. Alle leden mogen de applicatie bewerken of verwijderen. Ook webhooks voor de applicatie worden door deze groep beheerd.

Verantwoordelijke groep

Managers van deze groep zijn verantwoordelijk voor het regelen van toegang tot de applicatie. Dit betekent dat managers uit deze groep de applicatie aan kunnen bieden aan andere groepen voor autorisatie. In andere woorden: leden van de andere groep krijgen toegang. Ook kunnen ze het technisch beheer of de verantwoordelijkheid overdragen aan een andere groep.

Client identifier

De identifier van de Service Provider, ook wel Entity Identifier genoemd. Dit moet een URI zijn.

Formaat van het subject

KeyHub kan het subject in drie formaten aanleveren: Primaire identifier, UPN en gebruikersnaam. Bij Primaire identifier is het subject een uniek nummer dat nooit kan veranderen. Bij UPN is het subject een samenvoeging van de gebruikersnaam en het domein in de vorm user@domain. Bij Gebruikersnaam is het subject de KeyHub-gebruikersnaam. Het verschilt per Service Provider welk formaat het meest handig is in gebruik.

Custom attributen

Hier kunnen extra attributen gedefinieerd worden die in de SAML Response meegegeven worden. De mogelijkheden van deze attributen worden beschreven in Custom attributen.

IdP signing-certificaat

Dit certificaat wordt door Topicus KeyHub gebruikt voor ondertekening van de SAML2-berichten.

Metadata (URL of handmatig)

Voor de configuratie van een SAML-SSO-koppeling is SAML Metadata vereist. Sommige Service Providers bieden dit via een publiek benaderbare URL, bij anderen is dit enkel in de documentatie vastgelegd. Indien er een bruikbare URL is, geniet het sterk de voorkeur om deze te gebruiken. Indien de metadata enkel in de documentatie staat (of zelfs helemaal niet beschikbaar is), dient deze handmatig ingevoerd te worden.

SAML v2.0 applicatie
Afbeelding 115. SAML v2.0 applicatie

17.3. LDAP v3 applicatie

LDAP v3 is een standaard uit 2006 en is de defacto manier voor het uitlezen van directoryservices. Topicus KeyHub bevat een implementatie van een LDAP v3 service waarmee informatie over groepen en accounts uitgelezen kan worden. Voor het verbinden met de LDAP server van Topicus KeyHub kan elke LDAP v3 client gebruikt worden, mits deze StartTLS ondersteunt.

Voor het gebruik van de LDAP server dient een certificaat ingericht te zijn bij de algemene instellingen.

De volgende eigenschappen kunnen ingesteld worden op een LDAP v3 applicatie:

UUID

Een unieke identifier voor de applicatie binnen KeyHub.

Naam

De naam van de applicatie zoals deze aan gebruikers getoond wordt.

Technisch beheerdersgroep

Leden van deze groep voeren het technisch beheer van deze applicatie uit. Alle leden mogen de applicatie bewerken of verwijderen. Ook webhooks voor de applicatie worden door deze groep beheerd. Ook kunnen ze het technisch beheer overdragen aan een andere groep.

Bind DN

De identifier van de applicatie voor gebruik bij een simple bind. Deze waarde wordt getoond na opslaan.

Secret

Deze waarde wordt door clients gebruikt ter authenticatie bij een simple bind. Deze waarde dient te allen tijde geheim gehouden te worden. Mocht de waarde van dit veld toch uitlekken, kan een nieuwe waarde gegenereerd worden.

Het opnieuw genereren van de secret invalideert de oude secret per direct.
Secret in kluis opslaan

Indien ingeschakeld, wordt de secret van de client automatisch in de kluis geplaatst. Bij inschakelen op een bestaande client moet de secret geroteerd worden om deze optie te activeren.

Clientcertificaat

Indien de client dit ondersteunt, kan gebruik gemaakt worden van een SASL external bind met een X509 clientcertificaat. Hierbij authenticeert de client zich met de private key van een vooraf gekozen certificaat. Het publieke deel van het certificaat dient hier opgegeven te worden.

LDAP v3 applicatie
Afbeelding 116. LDAP v3 applicatie

17.4. Groepen voor een applicatie

Single Sign-on met een applicatie is alleen toegestaan voor gebruikers die in een groep zitten die gekoppeld is aan de applicatie. Op deze manier is SSO in KeyHub naast authenticatie ook autorisatie.

Groepen voor een applicatie
Afbeelding 117. Groepen voor een applicatie

17.4.1. Een groep aan een applicatie toevoegen

Het toevoegen van een groep aan een applicatie geeft de gebruikers uit die groep toegang tot de applicatie. Leden van de groep die het technisch beheer van de applicatie uitvoeren, kunnen een verzoek indienen om de applicatie beschikbaar te maken voor een andere groep. Managers uit de groep die verantwoordelijk is voor de applicatie kunnen dit verzoek accepteren.

Groep toevoegen aan een applicatie
Afbeelding 118. Groep toevoegen aan een applicatie

17.5. Rechten voor OAuth 2.0 clients

Aan OAuth 2.0 applicaties die gebruik maken van de client_credentials grant moeten nog rechten toegekend worden voor ze gebruikt kunnen worden. Dit kunnen globale rechten zijn over de gehele applicatie, maar ook rechten specifiek voor een enkele groep of gekoppeld systeem. Open het tabje Rechten om de toegekende rechten in te zien.

Toegekende rechten aan een OAuth 2.0 client
Afbeelding 119. Toegekende rechten aan een OAuth 2.0 client

Klik op Toevoegen om een recht aan te vragen. Dit verzoek zal gaan naar een manager van de groep die gaat over het betreffende recht. Voor globale rechten zijn dit de leden van de KeyHub Administrators-groep. Voor rechten over een gekoppeld systeem moet een manager van de groep met technisch beheer akkoord geven.

Rechten aanvragen voor een OAuth 2.0 client
Afbeelding 120. Rechten aanvragen voor een OAuth 2.0 client

Voor een OAuth 2.0 client kunnen de volgende rechten worden aangevraagd:

Accounts - Accounts uitlezen en zoeken

De client mag zoeken naar accounts en algemene informatie uitlezen van accounts. Dit recht moet worden goedgekeurd door een KeyHub Administrator.

Accounts - Nieuwe accounts aanmaken

De client mag nieuwe accounts aanmaken binnen Topicus KeyHub. Dit is alleen mogelijk via het SCIM-endpoint. Dit recht moet worden goedgekeurd door een KeyHub Administrator.

Accounts - Accounts verwijderen

De client mag accounts verwijderen. Dit recht moet worden goedgekeurd door een KeyHub Administrator.

Applicaties - Nieuwe applicaties aanmaken

De client mag nieuwe applicaties aanmaken binnen Topicus KeyHub. Deze nieuwe applicaties zullen altijd worden beheerd door de groep die ook technisch beheer heeft over de aanmakende client. Dit recht moet worden goedgekeurd door een manager van de groep met technisch beheer over de client.

Applicaties - Applicaties uitlezen en zoeken

De client mag zoeken naar en algemene informatie uitlezen van andere applicaties. Dit recht moet worden goedgekeurd door een KeyHub Administrator.

Koppelgroepen - Nieuwe koppelgroepen aanmaken

De client mag nieuwe kopppelgroepen aanmaken op het aangewezen gekoppelde systeem. Deze koppelgroepen worden direct aangemaakt binnen het gekoppelde systeem en kunnen ook verbonden worden met groepen of serviceaccounts binnen Topicus KeyHub. Dit recht moet worden goedgekeurd door een manager van de groep met verantwoordelijkheid over het gekoppelde systeem.

Groepen - Nieuwe groepen aanmaken

De client mag nieuwe groepen aanmaken binnen Topicus KeyHub. Dit recht moet worden goedgekeurd door een KeyHub Administrator.

Groepen - Verleen applicaties rechten na aanmaken

De client kan clients, inclusief zichzelf direct rechten geven voor groepen die het aanmaakt. Dit recht moet worden goedgekeurd door een KeyHub Administrator.

Groepen - Groepen uitlezen en zoeken

De client mag zoeken naar groepen en algemene informatie uitlezen van groepen. Dit recht moet worden goedgekeurd door een KeyHub Administrator. Als dit recht gecombineerd wordt met het recht op het zoeken van accounts, applicaties of gekoppelde systemen, dan krijgt de client ook rechten om de koppelingen tussen deze resources te lezen: lidmaatschappen, sso-koppelingen en koppelingen voor provisioning. Clients krijgen met dit recht ook het recht om privé groepen lezen.

Groepen - Groepsclassificaties toewijzen

De client mag groepsclassificaties toewijzen op bestaande groepen. Als de client ook het recht heeft om groepen aan te maken, kan de classificatie direct bij het aanmaken van de groep meegegeven worden. Dit recht moet worden goedgekeurd door een manager van de auditorgroep.

Groepen - Kluistoegang voor een groep

De client mag kluisregels aanmaken, lezen, aanpassen en verwijderen voor een aangewezen groep. Dit recht moet worden goedgekeurd door een manager van de aangewezen groep.

Groepen - Beheer van de launchpad-tegels van een groep

De client mag launchpad-tegels aanmaken, lezen, aanpassen en verwijderen voor een aangewezen groep. Dit recht moet worden goedgekeurd door een manager van de aangewezen groep.

Groepen - Groepdetails uitlezen

De client mag details uitlezen voor een aangewezen groep. Deze details bestaan uit de leden van de groep, gekoppelde applicaties en koppelgroepen voor die groep. Dit recht moet worden goedgekeurd door een manager van de aangewezen groep.

Groepen - Een groep instellen voor extra autorisatie

De client mag bij het aanmaken van nieuwe groepen de aangewezen groep koppelen voor het uitvoeren van extra autorisatie. De aangewezen groep kan opgegeven worden als autoriserende groep voor activatie, lidmaatschap en audits, of als groep waar de nieuwe groep onder genest moet worden. Dit recht moet worden goedgekeurd door een manager van de aangewezen groep.

Gekoppelde systemen - Gekoppelde systemen uitlezen en zoeken

De client mag zoeken naar gekoppelde system en algemene informatie uitlezen van deze systemen, inclusief de koppelgroepen. Dit recht moet worden goedgekeurd door een KeyHub Administrator.

Serviceaccounts - Nieuwe serviceaccounts aanmaken

De client mag nieuwe serviceaccounts aanmaken binnen Topicus KeyHub. Dit recht moet worden goedgekeurd door een manager van de groep met verantwoordelijkheid over het gekoppelde systeem.

Serviceaccounts - Serviceaccounts uitlezen en zoeken

De client mag zoeken naar en algemene informatie uitlezen van serviceaccounts. Dit recht moet worden goedgekeurd door een KeyHub Administrator.

Serviceaccounts - Serviceaccounts bewerken

De client mag serviceaccounts die beheerd worden door de gekozen groep bewerken. Dit recht moet worden goedgekeurd door een manager van de aangewezen groep.

17.6. Auditlog

Via het menu-item Auditlog kan de auditlog over de geselecteerde applicatie getoond worden. De auditlog die hier getoond wordt, bevat regels omtrent authenticatie en autorisatie van de applicatie. Via de filterbalk kan de log gefilterd worden op specifieke regels.

Auditlog voor een applicatie
Afbeelding 121. Auditlog voor een applicatie

17.7. Custom attributen

Custom attributen voor OpenID Connect en/of SAML worden beschreven in JavaScript volgens de ECMAScript 5 standaard. Het script definieert de body van een function die de volgende vorm heeft:

function (account, groups) {
   {SCRIPT}
}

Hierbij beschrijft account het account van de ingelogde gebruiker en groups de groepen waar deze gebruiker lid van is. account en de elementen van de groups-array hebben de volgende eigenschappen:

account
  - boolean active              : true wanneer het account actief is
  - String uuid                 : de unieke identifier van het account
  - boolean validInDirectory    : true wanneer het account geldig is de directory
  - String username             : de gebruikersnaam van het account
  - String displayName          : de naam van de gebruiker
  - String email                : het e-mailadres van de gebruiker
  - String idInDirectory        : de identifier van het account binnen de directory
  - directory
    - boolean active            : true wanneer de directory actief is
    - String uuid               : de unieke identifier van de directory
    - String name               : de naam van de directory
    - String type               : het type van de directory
  - Instant lastActive          : het moment van de laatste inlog
  - boolean canRequestGroups    : true wanneer de gebruiker groepen mag aanvragen
  - String locale               : de ingestelde locale van de gebruiker
  - Object attributes           : de opgeslagen attributen van de gebruiker,
                                  als mapping van naam naar lijst van waarden
  - Object attributesFirstValue : de opgeslagen attributen van de gebruiker,
                                  voor elke naam de eerste waarde

groups[]
  - boolean admin               : alleen true bij de KeyHub Administrator groep
  - String uuid                 : de unieke identifier van de groep
  - String name                 : de naam van de groep
  - String description          : de omschrijving van de groep
  - String rights               : MANAGER of NORMAL
  - Instant provisioningEndTime : de ingestelde eindtijd voor de groep
  - boolean active              : true wanneer de groep ingeschakeld is

Enkele voorbeelden van scripts zijn:

// het e-mailadres van de gebruiker:
return account.email;
// de uuid's van alle groepen waar de gebruiker in zit:
return groups.map(function (group) {return group.uuid;});

18. Koppelingen

KeyHub kan on-demand accounts aanmaken in gekoppelde systemen. Accounts in deze koppelingen worden aangemaakt (of geactiveerd) als de gebruiker de bijbehorende groep activeert op het dashboard. De volgende typen koppelingen worden ondersteund:

LDAP

Een LDAP-koppeling wordt gebruikt om posix-accounts aan te maken in een LDAP-systeem zoals OpenLDAP. Dit type is primair voor autorisatie van Unix-systemen.

Active Directory

De Active Directory-koppeling wordt gebruikt om accounts in een Microsoft of Samba Active Directory te activeren. Dit type is primair voor autorisatie van Windows-systemen, maar kan ook gebruikt worden voor andere applicaties die tegen een Active Directory kunnen authenticeren.

Azure Tenant

De Azure Tenant-koppeling wordt gebruikt om accounts in een Microsoft Azure Active Directory tenant aan te maken. Hiermee kan toegang geregeld worden tot de Azure portaal of Office 365.

LDAP-brondirectory

Een LDAP-brondirectory-koppeling wordt gebruikt om accounts in de LDAP-directory van authenticatie dynamisch te voorzien van groepen. Het account dat gebruikt wordt om aan te melden bij Topicus KeyHub wordt hierbij toegevoegd aan en verwijderd uit groepen binnen die LDAP-directory. De accounts zelf worden niet aangemaakt en/of verwijderd.

Azure OIDC-brondirectory

Een Azure OIDC-brondirectory-koppeling wordt gebruikt om accounts in de Azure OIDC-directory van authenticatie dynamisch te voorzien van groepen. Het account dat gebruikt wordt om aan te melden bij Topicus KeyHub wordt hierbij toegevoegd aan en verwijderd uit groepen binnen die Azure-directory. De accounts zelf worden niet aangemaakt en/of verwijderd.

Azure tenant met AD Connect

Een Azure tenant met AD Connect-koppeling wordt gebruikt om accounts in een Microsoft Azure Active Directory tenant dynamisch te voorzien van groepen, waarbij deze tenant middels Azure AD Connect aan een on-premise Active Directory gekoppeld is. Het account uit de on-premise Active Directory dat gebruikt wordt om aan te melden bij Topicus KeyHub wordt door Azure AD Connect gesynchroniseerd naar Azure AD. Dit account binnen de Azure Active Dictory wordt door Topicus KeyHub toegevoegd aan en verwijderd uit groepen binnen die Azure-directory. De accounts zelf worden niet aangemaakt en/of verwijderd.

Interne LDAP

Een interne LDAP-koppeling emuleert dynamische provisioning op het LDAP-endpoint van Topicus KeyHub zelf.

Koppelingen
Afbeelding 122. Koppelingen

18.1. Koppelen met LDAP

LDAP-systemen worden veel gebruikt voor services om tegen te authenticeren. In combinatie met KeyHub kan een LDAP ook gebruikt worden voor dynamische autorisatie. KeyHub ondersteunt LDAP v3 compliant servers zoals OpenLDAP en 389 Directory Server.

Tijdens het inrichten van een LDAP-koppeling kan deze koppeling getest worden. KeyHub zal proberen een verbinding te maken met het systeem en enkele operaties uitvoeren. Het resultaat van de test wordt getoond in een venster rechtsboven.

Gekoppelde LDAP testen
Afbeelding 123. Gekoppelde LDAP testen

De volgende eigenschappen kunnen ingesteld worden op een gekoppelde LDAP:

Status

Toont de huidige status van de koppeling. Als een koppeling te vaak fouten geeft, wordt deze tijdelijk ontkoppeld om verdere storingen te voorkomen.

Actief

Gebruikers kunnen alleen gebruik maken van koppelingen die actief zijn. KeyHub zal geen accounts aanmaken op koppelingen die gedeactiveerd zijn.

UUID

Een unieke identifier voor de koppeling binnen KeyHub.

Naam

De naam van de koppeling zoals deze door de gehele applicatie getoond wordt aan gebruikers.

Organisatie-eenheid

De organisatie-eenheid waar de koppeling toe behoort.

Technisch beheerdersgroep

Leden van deze groep voeren het technisch beheer van deze koppeling uit. Leden mogen de koppeling bewerken of een verzoek indienen tot verwijderen van het gekoppelde systeem. Ook webhooks voor de koppeling worden door deze groep beheerd.

Verantwoordelijke groep

Leden van deze groep maken de beslissingen over het gekoppelde systeem. Verzoeken gericht aan het gekoppelde systeem worden behandeld door de managers van deze groep.

Inhoudsbeheerdersgroep

Leden van deze groep nemen beslissingen over de inhoud van het gekoppelde systeem. Verzoeken voor het aanmaken van een koppelgroep of serviceaccount worden gericht aan deze groep. Ook verzoeken voor het koppelen van een bestaande koppelgroep moeten eerst door deze groep worden goedgekeurd, alvorens ze doorgaan naar de verantwoordelijke groep van de koppelgroep.

Primaire host

De hostname van de primaire LDAP-server. Bij het gebruik van een beveiligde verbinding (sterk aanbevolen) kan hier het IP-adres niet gebruikt worden.

Failover host

De hostname van de secundaire LDAP-server. Dit veld is optioneel. Indien het leeg gelaten wordt, kan KeyHub bij een communicatiefout met de primaire server niet terugvallen op een andere server. De failover host wordt alleen gebruikt als er een communicatiefout optreedt met de primaire server.

Port

Het poortnummer waarop de LDAP-server luistert. De standaard poort is 389. Bij het gebruik van LDAPS kan gekozen worden voor 636. Voor alle poorten anders dan 636 zal KeyHub bij gebruik van een beveiligde verbinding StartTLS gebruiken.

TLS

Over de verbinding met de LDAP-server worden ook wachtwoorden van gebruikers verstuurd. Het is daarom sterk aan te bevelen een beveiligde verbinding te gebruiken. Raadpleeg het hoofdstuk over certificaten voor meer details.

Vertrouwd certificaat

Via dit certificaat kan aangegeven worden welk certificaat vertrouwd moet worden bij het opzetten van een beveiligde verbinding. Indien dit veld leeg gelaten wordt, zal gebruik gemaakt worden van de standaard Java-truststore. Raadpleeg het hoofdstuk over certificaten voor meer details.

Vertrouwd certificaat voor failover

Hetzelfde als bovenstaande, maar dan voor de failover host.

Bind DN

De volledige DN waarop gebind moet worden. Het gebruikte account moet rechten hebben om binnen de LDAP nieuwe entries aan te maken en bestaande entries te wijzigen.

Bind wachtwoord

Het wachtwoord waarmee gebind moet worden.

Clientcertificaat

Bij gebruik van clientauthenticatie worden Bind DN en Bind wachtwoord vervangen door een certificaat waarmee KeyHub zichzelf authenticeert bij de LDAP. Dit is de veiligste manier voor het opzetten van een verbinding met een LDAP. Raadpleeg het hoofdstuk over certificaten voor meer details.

Base-DN

De DN in de LDAP waar de accounts en groepen zich bevinden.

Group-RDN

De relatieve DN, ten opzichte van de Base-DN, waaronder groepen zich bevinden. Groepen in een LDAP worden aangemaakt als posixGroup, groupOfNames of groupOfUniqueNames.

User-RDN

De relatieve DN, ten opzichte van de Base-DN, waaronder accounts zich bevinden. Accounts in een LDAP worden aangemaakt als posixAccount.

Serviceaccount-RDN

De relatieve DN, ten opzichte van de Base-DN, waaronder serviceaccounts zich bevinden. Serviceaccounts in een LDAP worden aangemaakt als posixAccount.

Gebruikersnaamprefix

Een prefix die die vóór de KeyHub gebruikersnaam wordt geplaatst als het account wordt aangemaakt in de LDAP. Deze prefix wordt van de KeyHub gebruikersnaam gescheiden door een koppelteken.

Onbekende accounts verwijderen

Accounts die niet binnen Topicus KeyHub bekend zijn, worden verwijderd tijdens een synchronisatie.

Activeer deze optie alleen als Topicus KeyHub volledig verantwoordelijk is voor het beheren van de accounts binnen de gegeven DN.
SSH public key

Geeft aan of de gebruikte LDAP-server ondersteuning biedt voor de ldapPublicKey object class. Deze object class definieert het sshPublicKey attribuut waar de SSH public key van de gebruiker in opgeslagen kan worden. De meest gebruikte LDAP-servers (zoals OpenLDAP) bieden ondersteuning voor dit attribuut. Indien deze optie uitgeschakeld wordt, zal de SSH public key van de gebruiker niet via de LDAP-server verspreid kunnen worden.

Wachtwoordhashing

Bij een LDAP-koppeling worden de wachtwoorden gehashed opgeslagen. KeyHub is verantwoordelijk voor het kiezen van het algoritme voor deze hashing. Het meest gebruikte algoritme is SSHA. Hierbij wordt het wachtwoord met een salt één keer gehashed met SHA-1. Dit algoritme is daarmee zwak te noemen, maar wordt wel ondersteund door de meeste LDAP-servers. OpenLDAP ondersteunt sinds 2.4.41 ook PBKDF2-SHA512. Dit is een zeer sterk algoritme, waarbij 64k iteraties SHA-512 worden uitgevoerd over een salted wachtwoord. Indien de LDAP-server dit algoritme ondersteunt, geniet dit sterk de voorkeur.

Aanvullende object classes

Extra waarden voor het objectClass-attribuut van accounts. Bij het gebruik van custom attributen kan het nodig zijn om extra object classes toe te voegen. Waarden worden gescheiden door spaties.

Custom attributen

Hier kunnen extra attributen gedefinieerd worden die aan accounts worden toegevoegd. De mogelijkheden van deze attributen worden beschreven in Custom attributen. Let wel op dat deze waarden toegestaan moeten zijn binnen het gebruikte schema. Mogelijk moeten extra object classes worden toegevoegd voor ondersteuning van de gewenste attributen.

User ID (uid)

Topicus keyHub kent automatisch UIDs toe aan gebruikers uit een nummerreeks. Kies hier een bestaande reeks of start een nieuwe. Het nummer wordt steeds 1 opgehoogd bij elk account. Zorg er altijd voor dat accounts aangemaakt door KeyHub niet conflicteren met andere accounts op systemen. De reeks is enkel in te stellen bij initiële inrichting en moet beginnen binnen het bereik 2000 tot 60000. Raadpleeg het hoofdstuk over nummerreeksen voor meer details.

Group ID (gid)

Het Group ID van de primaire groep waar KeyHub-accounts onderdeel van zijn.

Self-service

De ingeschakelde opties voor self-service op gekoppelde systemen. Als self-service ingeschakeld is, kunnen managers van groepen zelfstandig nieuwe groepen aanvragen, aanvragen indienen om bestaande groepen opnieuw te koppelen of serviceaccounts aanvragen. Als self-service uitgeschakeld is, zal deze functionaliteit alleen beschikbaar zijn voor de leden van de inhoudsbeheerdersgroep.

Externe UUID

Deze unieke identifier wordt bij de LDAP uitgelezen. Het is niet mogelijk om dezelfde LDAP-server meerdere keren toe te voegen in Topicus KeyHub. Dit wordt afgedwongen door middel van deze UUID.

Gekoppelde LDAP
Afbeelding 124. Gekoppelde LDAP

18.2. Koppelen met Active Directory

Active Directory is de directory server van Microsoft. Deze oplossing ondersteunt zowel een LDAP-interface als een Windows domain. KeyHub koppelt met een Active Directory via de LDAP-interface, maar de aangemaakte accounts kunnen ook binnen het domain van de Active Directory gebruikt worden. Om te voorkomen dat het Object GUID van de accounts wijzigt en omdat Active Directory een plaintext wachtwoord vereist bij het maken van een account, deactiveert KeyHub accounts in plaats van ze te verwijderen. Accounts worden automatisch uit een Active Directory verwijderd zodra een gebruiker voor een periode van 2 weken via geen enkele groep meer toegang heeft tot het systeem of als het Topicus KeyHub-account verwijderd wordt.

Om problemen bij het aanmaken van accounts te voorkomen, is het sterk aan te raden de password policies van een gekoppelde Active Directory uit te schakelen. Het verwijderen van de policies is niet voldoende aangezien Active Directory dan terug valt op de standaard waarden. Het wachtwoordbeleid dient in KeyHub ingericht te worden. Een typische fout die verwacht kan worden bij een schending van de password policies is Server is unwilling to perform.
Status

Toont de huidige status van de koppeling. Als een koppeling te vaak fouten geeft, wordt deze tijdelijk ontkoppeld om verdere storingen te voorkomen.

Actief

Gebruikers kunnen alleen gebruik maken van koppelingen die actief zijn. KeyHub zal geen accounts aanmaken op koppelingen die gedeactiveerd zijn.

UUID

Een unieke identifier voor de koppeling binnen KeyHub.

Naam

De naam van de koppeling zoals deze door de gehele applicatie getoond wordt aan gebruikers.

Organisatie-eenheid

De organisatie-eenheid waar de koppeling toe behoort.

Technisch beheerdersgroep

Leden van deze groep voeren het technisch beheer van deze koppeling uit. Leden mogen de koppeling bewerken of een verzoek indienen tot verwijderen van het gekoppelde systeem. Ook webhooks voor de koppeling worden door deze groep beheerd.

Verantwoordelijke groep

Leden van deze groep maken de beslissingen over het gekoppelde systeem. Verzoeken gericht aan het gekoppelde systeem worden behandeld door de managers van deze groep.

Inhoudsbeheerdersgroep

Leden van deze groep nemen beslissingen over de inhoud van het gekoppelde systeem. Verzoeken voor het aanmaken van een koppelgroep of serviceaccount worden gericht aan deze groep. Ook verzoeken voor het koppelen van een bestaande koppelgroep moeten eerst door deze groep worden goedgekeurd, alvorens ze doorgaan naar de verantwoordelijke groep van de koppelgroep.

Primaire host

De hostname van de primaire Active Directory-server. Aangezien het gebruik van een beveiligde verbinding verplicht is, kan hier het IP-adres niet gebruikt worden.

Failover host

De hostname van de secundaire Active Directory-server. Dit veld is optioneel. Indien het leeg gelaten wordt, kan KeyHub bij een communicatiefout met de primaire server niet terugvallen op een andere server. De failover host wordt alleen gebruikt als er een communicatiefout optreedt met de primaire server.

Port

Het poortnummer waarop de Active Directory-server luistert. De standaard poort is 389. Bij het gebruik van LDAPS kan gekozen worden voor 636. Voor alle poorten anders dan 636 zal KeyHub StartTLS gebruiken.

TLS

Over de verbinding met de Active Directory-server worden ook wachtwoorden van gebruikers verstuurd. Active Directory verplicht daarom een beveiligde verbinding te gebruiken. Raadpleeg het hoofdstuk over certificaten voor meer details.

Vertrouwd certificaat

Via dit certificaat kan aangegeven worden welk certificaat vertrouwd moet worden bij het opzetten van een beveiligde verbinding. Indien dit veld leeg gelaten wordt, zal gebruik gemaakt worden van de standaard Java-truststore. Raadpleeg het hoofdstuk over certificaten voor meer details.

Vertrouwd certificaat voor failover

Hetzelfde als bovenstaande, maar dan voor de failover host.

Bind DN

De volledige DN waarop gebind moet worden. Het gebruikte account moet rechten hebben om binnen de Active Directory nieuwe entries aan te maken en bestaande entries te wijzigen.

Bind wachtwoord

Het wachtwoord waarmee gebind moet worden.

Clientcertificaat

Bij gebruik van clientauthenticatie worden Bind DN en Bind wachtwoord vervangen door een certificaat waarmee KeyHub zichzelf authenticeert bij de Active Directory. Dit is de veiligste manier voor het opzetten van een verbinding met een Active Directory. Raadpleeg het hoofdstuk over certificaten voor meer details.

Base-DN

De DN in de Active Directory waar de accounts en groepen zich bevinden.

Group-RDN

De relatieve DN, ten opzichte van de Base-DN, waaronder groepen zich bevinden. Groepen in een Active Directory worden aangemaakt als group, als local of global security group.

User-RDN

De relatieve DN, ten opzichte van de Base-DN, waaronder accounts zich bevinden. Accounts in een Active Directory worden aangemaakt als user.

Serviceaccount-RDN

De relatieve DN, ten opzichte van de Base-DN, waaronder serviceaccounts zich bevinden. Serviceaccounts in een Active Directory worden aangemaakt als user.

Gebruikersnaamprefix

Een prefix die die vóór de KeyHub gebruikersnaam wordt geplaatst als het account wordt aangemaakt in het AD. Deze prefix wordt van de KeyHub gebruikersnaam gescheiden door een koppelteken. De resulterende gebruikersnaam in het AD ziet er als volgt uit: '<prefix>-<gebruikersnaam>'.

Accounts verwijderen na

Een account wordt automatisch verwijderd zodra deze alle toegang tot het systeem heeft verloren. Hier kan ingesteld worden hoeveel tijd er moet verstrijken voordat het account verwijderd moet worden. Gebruik 'd' voor dagen, 'w' voor weken', 'm' voor maanden en 'y' voor jaren, bijvoorbeeld '2w' voor een periode van 2 weken.

Accounts op gekoppelde systemen worden altijd verwijderd zodra het account in Topicus KeyHub verwijderd wordt, ook als deze periode nog niet verstreken is.
Onbekende accounts verwijderen

Accounts die niet binnen Topicus KeyHub bekend zijn, worden verwijderd tijdens een synchronisatie.

Activeer deze optie alleen als Topicus KeyHub volledig verantwoordelijk is voor het beheren van de accounts binnen de gegeven DN.
SAM-Account-Name

Het SAM-Account-Name-attribuut in het AD wordt gebruikt door sommige legacy-systemen voor authenticatie. Dit attribuut heeft een maximum lengte van 20 tekens. Indien de combinatie van de gebruikersnaamprefix en de gebruikersnaam in Topicus KeyHub langer wordt dan deze 20 tekens, zal normaal gesproken geen SAM-Account-Name ingesteld worden. In dat geval genereert het AD een willekeurige, unieke waarde voor dit attribuut. Via deze optie kan gekozen worden om het SAM-Account-Name-attribuut in te korten, zodat deze niet langer wordt dan 20 tekens. Let op dat deze ingekorte waarde mogelijk niet meer uniek is. Ook is het mogelijk om de waarde over te nemen uit een gelijknaming account-attribuut, met toevoeging van een eventuele prefix. Indien er geen systemen gebruikt worden die van dit attribuut afhankelijk zijn, kan gekozen worden het volledig weg te laten.

Aanvullende object classes

Extra waarden voor het objectClass-attribuut van accounts. Bij het gebruik van custom attributen kan het nodig zijn om extra object classes toe te voegen. Waarden worden gescheiden door spaties.

Custom attributen

Hier kunnen extra attributen gedefinieerd worden die aan accounts worden toegevoegd. De mogelijkheden van deze attributen worden beschreven in Custom attributen. Let wel op dat deze waarden toegestaan moeten zijn binnen het gebruikte schema. Mogelijk moeten extra object classes worden toegevoegd voor ondersteuning van de gewenste attributen.

Ondersteunt SSH public key

Geeft aan of de gebruikte AD-server ondersteuning biedt voor de ldapPublicKey object class. Deze object class definieert het sshPublicKey attribuut waar de SSH public key van de gebruiker in opgeslagen kan worden. Active Directory ondersteunt standaard deze object class en dit attribuut niet. Een alternatief is het gebruik van het altSecurityIdentities-attribuut om de SSH public key in op te slaan. Voor dit attribuut is geen aangepaste objectclass vereist, maar het is niet officieel bedoeld om een SSH public key op te slaan. Voor ondersteuning moeten deze handmatig worden toegevoegd. Indien deze optie uitgeschakeld wordt, zal de SSH public key van de gebruiker niet via de LDAP-server verspreid kunnen worden.

Self-service

De ingeschakelde opties voor self-service op gekoppelde systemen. Als self-service ingeschakeld is, kunnen managers van groepen zelfstandig nieuwe groepen aanvragen, aanvragen indienen om bestaande groepen opnieuw te koppelen of serviceaccounts aanvragen. Als self-service uitgeschakeld is, zal deze functionaliteit alleen beschikbaar zijn voor de leden van de inhoudsbeheerdersgroep.

Externe UUID

Deze unieke identifier wordt bij de Active Directory uitgelezen. Het is niet mogelijk om dezelfde AD-server meerdere keren toe te voegen in Topicus KeyHub. Dit wordt afgedwongen door middel van deze UUID.

Gekoppelde Active Directory
Afbeelding 125. Gekoppelde Active Directory

18.3. Koppelen met Microsoft Azure Active Directory

Azure Active Directory is de cloudomgeving voor het regelen van toegang tot veel online diensten van Microsoft, waaronder Office 365 en het Azure portaal. KeyHub koppelt met Azure Active Directory via de graph API. Hiervoor dient een applicatie registratie aangemaakt worden binnen het Azure portaal met de volgende applicatie-rechten: RoleManagement.ReadWrite.Directory,User.ReadWrite.All, Directory.ReadWrite.All en User.ManageIdentities.All. Ook dient de applicatie toegevoegd te worden aan de Global administrators rol. Via Topicus KeyHub kunnen gebruikers aangemaakt worden en toegekend worden aan directory rollen en groepen binnen Azure. Om te voorkomen dat het UUID van de accounts wijzigt en omdat Azure Active Directory een plaintext wachtwoord vereist bij het maken van een account, deactiveert KeyHub accounts in plaats van ze te verwijderen. Accounts worden automatisch uit een Azure Active Directory verwijderd zodra een gebruiker voor een periode van 2 weken via geen enkele groep meer toegang heeft tot het systeem of als het Topicus KeyHub-account verwijderd wordt.

Status

Toont de huidige status van de koppeling. Als een koppeling te vaak fouten geeft, wordt deze tijdelijk ontkoppeld om verdere storingen te voorkomen.

Actief

Gebruikers kunnen alleen gebruik maken van koppelingen die actief zijn. KeyHub zal geen accounts aanmaken op koppelingen die gedeactiveerd zijn.

UUID

Een unieke identifier voor de koppeling binnen KeyHub.

Naam

De naam van de koppeling zoals deze door de gehele applicatie getoond wordt aan gebruikers.

Organisatie-eenheid

De organisatie-eenheid waar de koppeling toe behoort.

Technisch beheerdersgroep

Leden van deze groep voeren het technisch beheer van deze koppeling uit. Leden mogen de koppeling bewerken of een verzoek indienen tot verwijderen van het gekoppelde systeem. Ook webhooks voor de koppeling worden door deze groep beheerd.

Verantwoordelijke groep

Leden van deze groep maken de beslissingen over het gekoppelde systeem. Verzoeken gericht aan het gekoppelde systeem worden behandeld door de managers van deze groep.

Inhoudsbeheerdersgroep

Leden van deze groep nemen beslissingen over de inhoud van het gekoppelde systeem. Verzoeken voor het aanmaken van een koppelgroep of serviceaccount worden gericht aan deze groep. Ook verzoeken voor het koppelen van een bestaande koppelgroep moeten eerst door deze groep worden goedgekeurd, alvorens ze doorgaan naar de verantwoordelijke groep van de koppelgroep.

Client identifier

De application ID voor de app registratie in Azure.

Client secret

De secret behorende bij de bovenstaande identifier.

Azure tenant

De naam van de tenant binnen Azure.

Identity-provider-domein

Bij een ingesteld identity-provider-domein zullen gebruikers via dat domein uitgenodigd worden en inloggen via SSO. Indien dit veld leeggelaten wordt, worden gebruikers direct aangemaakt binnen de tenant met het wachtwoord vanuit Topicus KeyHub. Door hier het domein van de Topicus KeyHub-installatie in te vullen, kunnen gebruikers op Azure inloggen met SSO via Topicus KeyHub.

Gebruikersnaamprefix

Een prefix die die vóór de KeyHub gebruikersnaam wordt geplaatst als het account wordt aangemaakt binnen Azure. Deze prefix wordt van de KeyHub gebruikersnaam gescheiden door een koppelteken. De resulterende gebruikersnaam in Azure ziet er als volgt uit: '<prefix>-<gebruikersnaam>'.

Accounts verwijderen na

Een account wordt automatisch verwijderd zodra deze alle toegang tot het systeem heeft verloren. Hier kan ingesteld worden hoeveel tijd er moet verstrijken voordat het account verwijderd moet worden. Gebruik 'd' voor dagen, 'w' voor weken', 'm' voor maanden en 'y' voor jaren, bijvoorbeeld '2w' voor een periode van 2 weken.

Accounts op gekoppelde systemen worden altijd verwijderd zodra het account in Topicus KeyHub verwijderd wordt, ook als deze periode nog niet verstreken is.
Onbekende accounts verwijderen

Accounts die niet binnen Topicus KeyHub bekend zijn, worden verwijderd tijdens een synchronisatie.

Activeer deze optie alleen als Topicus KeyHub volledig verantwoordelijk is voor het beheren van de accounts binnen de gegeven DN.
Self-service

De ingeschakelde opties voor self-service op gekoppelde systemen. Als self-service ingeschakeld is, kunnen managers van groepen zelfstandig nieuwe groepen aanvragen, aanvragen indienen om bestaande groepen opnieuw te koppelen of serviceaccounts aanvragen. Als self-service uitgeschakeld is, zal deze functionaliteit alleen beschikbaar zijn voor de leden van de inhoudsbeheerdersgroep.

Externe UUID

De UUID die hoort bij de gekoppelde Azure tenant. Het is niet mogelijk om dezelfde Azure tenant meerdere keren toe te voegen in Topicus KeyHub. Dit wordt afgedwongen door middel van deze UUID.

Gekoppelde Azure Active Directory
Afbeelding 126. Gekoppelde Azure Active Directory

18.4. Koppelen met een LDAP-brondirectory

De brondirectory is de LDAP-directory die een gebruiker gebruikt om zichzelf aan te melden bij Topicus KeyHub. Bij een koppeling met een LDAP-brondirectory wordt de gebruiker binnen deze directory dynamisch toegevoegd aan en verwijderd uit groepen.

Status

Toont de huidige status van de koppeling. Als een koppeling te vaak fouten geeft, wordt deze tijdelijk ontkoppeld om verdere storingen te voorkomen.

Actief

Gebruikers kunnen alleen gebruik maken van koppelingen die actief zijn. KeyHub zal geen groepen aan accounts toevoegen op koppelingen die gedeactiveerd zijn.

UUID

Een unieke identifier voor de koppeling binnen KeyHub.

Naam

De naam van de koppeling zoals deze door de gehele applicatie getoond wordt aan gebruikers.

Organisatie-eenheid

De organisatie-eenheid waar de koppeling toe behoort.

Technisch beheerdersgroep

Leden van deze groep voeren het technisch beheer van deze koppeling uit. Leden mogen de koppeling bewerken of een verzoek indienen tot verwijderen van het gekoppelde systeem. Ook webhooks voor de koppeling worden door deze groep beheerd.

Verantwoordelijke groep

Leden van deze groep maken de beslissingen over het gekoppelde systeem. Verzoeken gericht aan het gekoppelde systeem worden behandeld door de managers van deze groep.

Inhoudsbeheerdersgroep

Leden van deze groep nemen beslissingen over de inhoud van het gekoppelde systeem. Verzoeken voor het aanmaken van een koppelgroep of serviceaccount worden gericht aan deze groep. Ook verzoeken voor het koppelen van een bestaande koppelgroep moeten eerst door deze groep worden goedgekeurd, alvorens ze doorgaan naar de verantwoordelijke groep van de koppelgroep.

LDAP-directory

De directory waarvoor de koppeling dient. Indien er meerdere directories gebruikt worden binnen Topicus KeyHub, zullen enkel gebruikers uit de gekozen directory gebruik kunnen maken van deze koppeling.

De LDAP-directory dient geconfigureerd te zijn met schrijfrechten.
Group-DN

De DN binnen de gekozen directory, waaronder groepen zich bevinden.

Self-service

De ingeschakelde opties voor self-service op gekoppelde systemen. Als self-service ingeschakeld is, kunnen managers van groepen zelfstandig nieuwe groepen aanvragen of aanvragen indienen om bestaande groepen opnieuw te koppelen. Als self-service uitgeschakeld is, zal deze functionaliteit alleen beschikbaar zijn voor de leden van de inhoudsbeheerdersgroep.

Externe UUID

Deze unieke identifier wordt bij de directory uitgelezen. Het is niet mogelijk om dezelfde server meerdere keren toe te voegen in Topicus KeyHub. Dit wordt afgedwongen door middel van deze UUID.

Gekoppelde LDAP-brondirectory
Afbeelding 127. Gekoppelde LDAP-brondirectory

18.5. Koppelen met een Azure OIDC-brondirectory

De brondirectory is de Azure OIDC-directory die een gebruiker gebruikt om zichzelf aan te melden bij Topicus KeyHub. Bij een koppeling met een Azure OIDC-brondirectory wordt de gebruiker binnen deze directory dynamisch toegevoegd aan en verwijderd uit groepen.

Status

Toont de huidige status van de koppeling. Als een koppeling te vaak fouten geeft, wordt deze tijdelijk ontkoppeld om verdere storingen te voorkomen.

Actief

Gebruikers kunnen alleen gebruik maken van koppelingen die actief zijn. KeyHub zal geen groepen aan accounts toevoegen op koppelingen die gedeactiveerd zijn.

UUID

Een unieke identifier voor de koppeling binnen KeyHub.

Naam

De naam van de koppeling zoals deze door de gehele applicatie getoond wordt aan gebruikers.

Organisatie-eenheid

De organisatie-eenheid waar de koppeling toe behoort. Deze is gelijk aan die van de brondirectory.

Technisch beheerdersgroep

Leden van deze groep voeren het technisch beheer van deze koppeling uit. Leden mogen de koppeling bewerken of een verzoek indienen tot verwijderen van het gekoppelde systeem. Ook webhooks voor de koppeling worden door deze groep beheerd.

Verantwoordelijke groep

Leden van deze groep maken de beslissingen over het gekoppelde systeem. Verzoeken gericht aan het gekoppelde systeem worden behandeld door de managers van deze groep.

Inhoudsbeheerdersgroep

Leden van deze groep nemen beslissingen over de inhoud van het gekoppelde systeem. Verzoeken voor het aanmaken van een koppelgroep of serviceaccount worden gericht aan deze groep. Ook verzoeken voor het koppelen van een bestaande koppelgroep moeten eerst door deze groep worden goedgekeurd, alvorens ze doorgaan naar de verantwoordelijke groep van de koppelgroep.

Azure OIDC-directory

De directory waarvoor de koppeling dient. Indien er meerdere directories gebruikt worden binnen Topicus KeyHub, zullen enkel gebruikers uit de gekozen directory gebruik kunnen maken van deze koppeling.

De client voor de Azure OIDC-directory dient geconfigureerd te zijn met schrijfrechten.
Tenant

De Azure tenant waarbinnen de accounts zich bevinden.

Self-service

De ingeschakelde opties voor self-service op gekoppelde systemen. Als self-service ingeschakeld is, kunnen managers van groepen zelfstandig nieuwe groepen aanvragen of aanvragen indienen om bestaande groepen opnieuw te koppelen. Als self-service uitgeschakeld is, zal deze functionaliteit alleen beschikbaar zijn voor de leden van de inhoudsbeheerdersgroep.

Externe UUID

Deze unieke identifier wordt bij de directory uitgelezen. Het is niet mogelijk om dezelfde tenant meerdere keren toe te voegen in Topicus KeyHub. Dit wordt afgedwongen door middel van deze UUID.

Gekoppelde Azure OIDC-brondirectory
Afbeelding 128. Gekoppelde Azure OIDC-brondirectory

18.6. Koppelen met een Azure tenant met AD Connect

Bij een koppeling met een Azure tenant met AD Connect wordt de gebruiker binnen Azure Active Directory dynamisch toegevoegd aan en verwijderd uit groepen. Dit wordt gebruikt als gebruikers aanmelden bij Topicus KeyHub vanuit een on-premise Active Directory en deze directory wordt met Azure AD Connect gesynchroniseerd met een Azure AD tenant. De brondirectory is de Active Directory LDAP-directory die een gebruiker gebruikt om zichzelf aan te melden bij Topicus KeyHub.

Status

Toont de huidige status van de koppeling. Als een koppeling te vaak fouten geeft, wordt deze tijdelijk ontkoppeld om verdere storingen te voorkomen.

Actief

Gebruikers kunnen alleen gebruik maken van koppelingen die actief zijn. KeyHub zal geen groepen aan accounts toevoegen op koppelingen die gedeactiveerd zijn.

UUID

Een unieke identifier voor de koppeling binnen KeyHub.

Naam

De naam van de koppeling zoals deze door de gehele applicatie getoond wordt aan gebruikers.

Organisatie-eenheid

De organisatie-eenheid waar de koppeling toe behoort. Deze is gelijk aan die van de brondirectory.

Technisch beheerdersgroep

Leden van deze groep voeren het technisch beheer van deze koppeling uit. Leden mogen de koppeling bewerken of een verzoek indienen tot verwijderen van het gekoppelde systeem. Ook webhooks voor de koppeling worden door deze groep beheerd.

Verantwoordelijke groep

Leden van deze groep maken de beslissingen over het gekoppelde systeem. Verzoeken gericht aan het gekoppelde systeem worden behandeld door de managers van deze groep.

Inhoudsbeheerdersgroep

Leden van deze groep nemen beslissingen over de inhoud van het gekoppelde systeem. Verzoeken voor het aanmaken van een koppelgroep of serviceaccount worden gericht aan deze groep. Ook verzoeken voor het koppelen van een bestaande koppelgroep moeten eerst door deze groep worden goedgekeurd, alvorens ze doorgaan naar de verantwoordelijke groep van de koppelgroep.

LDAP-directory

De directory waarvoor de koppeling dient. Indien er meerdere directories gebruikt worden binnen Topicus KeyHub, zullen enkel gebruikers uit de gekozen directory gebruik kunnen maken van deze koppeling.

Deze directory dient middels Azure AD Connect gesynchroniseerd te worden met de gekozen Azure tenant.
Client identifier

De application ID voor de app registratie in Azure.

Client secret

De secret behorende bij de bovenstaande identifier.

Tenant

De Azure tenant waarbinnen de accounts zich bevinden.

Self-service

De ingeschakelde opties voor self-service op gekoppelde systemen. Als self-service ingeschakeld is, kunnen managers van groepen zelfstandig nieuwe groepen aanvragen of aanvragen indienen om bestaande groepen opnieuw te koppelen. Als self-service uitgeschakeld is, zal deze functionaliteit alleen beschikbaar zijn voor de leden van de inhoudsbeheerdersgroep.

Externe UUID

Deze unieke identifier wordt bij de directory uitgelezen. Het is niet mogelijk om dezelfde tenant meerdere keren toe te voegen in Topicus KeyHub. Dit wordt afgedwongen door middel van deze UUID.

Gekoppelde Azure tenant met AD Connect
Afbeelding 129. Gekoppelde Azure tenant met AD Connect

18.7. Koppelen met de interne LDAP

Topicus KeyHub heeft een eigen LDAP-endpoint. Via dit endpoint kan de statische inrichting van Topicus KeyHub uitgelezen worden. Door gebruik te maken van een koppeling met de interne LDAP komt hier ook een dynamische context beschikbaar. Deze dynamische context onderscheidt zich met DC=dynamic van de statische context. Net als bij een koppeling met een LDAP-server zullen alleen accounts bestaan die actief zijn en worden de accounts enkel in groepen geplaatst als deze geactiveerd worden op het dashboard.

Actief

Gebruikers kunnen alleen gebruik maken van koppelingen die actief zijn. KeyHub zal geen accounts aanmaken op koppelingen die gedeactiveerd zijn.

UUID

Een unieke identifier voor de koppeling binnen KeyHub.

Naam

De naam van de koppeling zoals deze door de gehele applicatie getoond wordt aan gebruikers.

Organisatie-eenheid

De organisatie-eenheid waar de koppeling toe behoort.

Technisch beheerdersgroep

Leden van deze groep voeren het technisch beheer van deze koppeling uit. Leden mogen de koppeling bewerken of een verzoek indienen tot verwijderen van het gekoppelde systeem. Ook webhooks voor de koppeling worden door deze groep beheerd.

Verantwoordelijke groep

Leden van deze groep maken de beslissingen over het gekoppelde systeem. Verzoeken gericht aan het gekoppelde systeem worden behandeld door de managers van deze groep.

LDAP Client

De LDAP client-definitie die onder andere de credentials bepaalt. Zie LDAP v3 applicatie voor informatie over het registreren van een LDAP client.

Self-service

De ingeschakelde opties voor self-service op gekoppelde systemen. Als self-service ingeschakeld is, kunnen managers van groepen zelfstandig nieuwe groepen aanvragen of aanvragen indienen om bestaande groepen opnieuw te koppelen. Als self-service uitgeschakeld is, zal deze functionaliteit alleen beschikbaar zijn voor de leden van de groep met technisch beheer.

Gekoppelde interne LDAP
Afbeelding 130. Gekoppelde interne LDAP

18.8. Koppelen met een SCIM-systeem

KeyHub ondersteunt provisioning via het System for Cross-domain Identity Management, oftewel SCIM. SCIM is een open standaard, waarmee door middel van een REST API automatisch gebruikers en groepen kunnen worden geprovisioned.

Status

Toont de huidige status van de koppeling. Als een koppeling te vaak fouten geeft, wordt deze tijdelijk ontkoppeld om verdere storingen te voorkomen.

Actief

Gebruikers kunnen alleen gebruik maken van koppelingen die actief zijn. KeyHub zal geen groepen aan accounts toevoegen op koppelingen die gedeactiveerd zijn.

UUID

Een unieke identifier voor de koppeling binnen KeyHub.

Naam

De naam van de koppeling zoals deze door de gehele applicatie getoond wordt aan gebruikers.

Organisatie-eenheid

De organisatie-eenheid waar de koppeling toe behoort.

Technisch beheerdersgroep

Leden van deze groep voeren het technisch beheer van deze koppeling uit. Leden mogen de koppeling bewerken of een verzoek indienen tot verwijderen van het gekoppelde systeem. Ook webhooks voor de koppeling worden door deze groep beheerd.

Verantwoordelijke groep

Leden van deze groep maken de beslissingen over het gekoppelde systeem. Verzoeken gericht aan het gekoppelde systeem worden behandeld door de managers van deze groep.

Inhoudsbeheerdersgroep

Leden van deze groep nemen beslissingen over de inhoud van het gekoppelde systeem. Verzoeken voor het aanmaken van een koppelgroep of serviceaccount worden gericht aan deze groep. Ook verzoeken voor het koppelen van een bestaande koppelgroep moeten eerst door deze groep worden goedgekeurd, alvorens ze doorgaan naar de verantwoordelijke groep van de koppelgroep.

Leverancier

Veel leveranciers hanteren een eigen SCIM dialect. Hier kan de leverancier worden gekozen voor een optimale werking van de SCIM koppeling.

URL

De volledige URL waarop de SCIM REST API te vinden is. Hier kan enkel http en https gebruikt worden.

Authenticatieschema

Als Topicus KeyHub moet authenticeren bij het provisionen via SCIM, kan hier een authenticatiemethode gekozen worden. De beschikbare opties zullen verschillende velden tonen voor het invoeren van de authenticatiegegevens.

Gebruikersnaam

Beschikbaar bij het authenticatieschema 'Basic authentication'. Deze zal samen met het wachtwoord in de Authorization header worden meegestuurd.

Wachtwoord

Beschikbaar bij het authenticatieschema 'Basic authentication'. Deze zal samen met de gebruikersnaam in de Authorization header worden meegestuurd.

Bearer Token

Beschikbaar bij het authenticatieschema 'Bearer token'. Dit token zal in de Authorization header worden meegestuurd, voorafgegaan door het woord Bearer.

Header-naam

Beschikbaar bij het authenticatieschema 'Aangepast'. De hieronder ingevulde waarde zal in een header met de hier ingevulde naam worden meegestuurd.

Header-waarde

Beschikbaar bij het authenticatieschema 'Aangepast'. De hier ingevulde waarde zal in een header met de hierboven ingevulde naam worden meegestuurd.

Accounts verwijderen na

Een account wordt automatisch verwijderd zodra deze alle toegang tot het systeem heeft verloren. Hier kan ingesteld worden hoeveel tijd er moet verstrijken voordat het account verwijderd moet worden. Gebruik 'd' voor dagen, 'w' voor weken', 'm' voor maanden en 'y' voor jaren, bijvoorbeeld '2w' voor een periode van 2 weken.

Accounts op gekoppelde systemen worden altijd verwijderd zodra het account in Topicus KeyHub verwijderd wordt, ook als deze periode nog niet verstreken is.
Onbekende accounts verwijderen

Accounts die niet binnen Topicus KeyHub bekend zijn, worden verwijderd tijdens een synchronisatie.

Activeer deze optie alleen als Topicus KeyHub volledig verantwoordelijk is voor het beheren van de accounts binnen de gegeven DN.
Self-service

De ingeschakelde opties voor self-service op gekoppelde systemen. Als self-service ingeschakeld is, kunnen managers van groepen zelfstandig nieuwe groepen aanvragen of aanvragen indienen om bestaande groepen opnieuw te koppelen. Als self-service uitgeschakeld is, zal deze functionaliteit alleen beschikbaar zijn voor de leden van de inhoudsbeheerdersgroep.

Gekoppelde SCIM-systeem
Afbeelding 131. Gekoppelde SCIM-systeem

18.9. Namespaces

Een namespace is een variant, of afgeleide, van een bestaande koppeling met eigen provisioning. Functioneel werkt het als een losstaande koppeling op hetzelfde systeem als een bestaand basissysteem. De technische inrichting en configuratie wordt overgenomen van dit basissysteem, maar een namespace heeft zijn eigen DNs voor groepen en serviceaccounts.

De namespace heeft eigen koppelgroepen en serviceaccounts, die verder ook losstaan van het gekozen basissysteem, maar gebruikt wel de accounts van het basissysteem. Dit betekent dat gebruikers via hun groepslidmaatschappen toegang kunnen hebben tot een willekeurige cobinatie van groepen in het basissysteem en de namespace. Er is geen functioneel verschil in gebruik tussen een namespace en zijn basissysteem.

Het technisch beheer van de namespace wordt verricht door de technisch beheergroep van het basissysteem. Dit gaat dan voornamelijk over het instellen van de juiste groep en serviceaccount RDNs. De overige configuratie wordt automatisch overgenomen van het basissysteem.

Een namespace heeft zijn eigen inhoudsbeheerdersgroep. Deze groep is ook de verantwoordelijke groep voor de namespace.

Een namespace kan op een andere organisatie-eenheid zitten dan het basissysteem. Dit moet dan wel een organisatie-eenheid zijn die onder de organisatie-eenheid van het basissysteem ligt.

De volgende eigenschappen kunnen ingesteld worden op een namespace:

Status

Toont de huidige status van de namespace. Dit is de status van het basissysteem.

Actief

Een namespace kan niet los gedeactiveerd worden. Dit representeert dus ook de status van het basissysteem.

UUID

Een unieke identifier voor de koppeling binnen KeyHub.

Naam

De naam van de koppeling zoals deze door de gehele applicatie getoond wordt aan gebruikers.

Organisatie-eenheid

De organisatie-eenheid waar de koppeling toe behoort.

Verantwoordelijke groep

Leden van deze groep maken de beslissingen over het gekoppelde systeem. Verzoeken gericht aan het gekoppelde systeem worden behandeld door de managers van deze groep. Dit is altijd dezelfde groep als de inhoudsbeheerdersgroep.

Inhoudsbeheerdersgroep

Leden van deze groep nemen beslissingen over de inhoud van het gekoppelde systeem. Verzoeken voor het aanmaken van een koppelgroep of serviceaccount worden gericht aan deze groep. Ook verzoeken voor het koppelen van een bestaande koppelgroep moeten eerst door deze groep worden goedgekeurd, alvorens ze doorgaan naar de verantwoordelijke groep van de koppelgroep.

Group-RDN

De relatieve DN, ten opzichte van de Base-DN, waaronder groepen zich bevinden. Groepen in een namespace kunnen elk type zijn dat ondersteund wordt door het basissysteem.

Serviceaccount-RDN

De relatieve DN, ten opzichte van de Base-DN, waaronder serviceaccounts zich bevinden.

Self-service

De ingeschakelde opties voor self-service op gekoppelde systemen. Als self-service ingeschakeld is, kunnen managers van groepen zelfstandig nieuwe groepen aanvragen, aanvragen indienen om bestaande groepen opnieuw te koppelen of serviceaccounts aanvragen. Als self-service uitgeschakeld is, zal deze functionaliteit alleen beschikbaar zijn voor de leden van de inhoudsbeheerdersgroep.

Namespace
Afbeelding 132. Namespace

18.10. Groepen voor een koppeling

Een koppeling geeft alleen autorisatie als de groepen binnen de koppeling verbonden worden met groepen in KeyHub. Gebruikers in deze groepen krijgen op het dashboard de mogelijkheid om deze groep aan en uit te zetten. Als een gebruiker een groep activeert op het dashboard, zal het account binnen de koppeling aangemaakt of geactiveerd worden en toegevoegd worden aan de ingestelde groep. Hiermee krijgt de gebruiker direct toegang tot services die authenticeren tegen de koppeling.

Groepen voor een koppeling
Afbeelding 133. Groepen voor een koppeling

18.10.1. Een groep aan een koppeling toevoegen

Het toevoegen van een groep aan een koppeling geeft de gebruikers uit die groep autorisatie via die koppeling. De volgende eigenschappen kunnen worden gekozen bij het toevoegen van een groep aan een koppeling:

Koppeling

De koppeling waarbinnen een groep toegevoegd gaat worden.

Groep

De KeyHub-groep die gekoppeld moet worden.

Nieuw of bestaand

Voor de groep binnen het systeem kan gekozen worden uit één van de bestaande groepen of er kan eenvoudig een nieuwe groep aangemaakt worden. Als gekozen wordt voor een bestaande groep zal een verzoek gestuurd worden naar de verantwoordelijke groep voor de gekozen groep. Wordt er gekozen voor een nieuwe groep, dan zal er een verzoek gestuurd worden naar de inhoudsbeheerdersgroep van het systeem.

Koppelgroep

De bestaande groep op het gekoppelde systeem waar toegang tot gegeven moet worden.

Nieuwe koppelgroep

Hier kan de naam van de nieuwe groep aangepast worden. Standaard zal Topicus KeyHub hier de naam van de groep in KeyHub invullen, waarbij spaties verwijderd worden.

Type van de nieuwe koppelgroep

Sommige gekoppelde systemen ondersteunen meerdere groepstypen, zoals posixGroup, groupOfNames en groupOfUniqueNames bij een LDAP-koppeling. Kies hier het gewenste type.

Verantwoordelijke groep

Leden van deze groep maken de beslissingen over de toegang tot de groep op het gekoppelde systeem.

Activatie vereist

Gebruik dynamische accountprovisioning voor deze groep. Bij dynamische accountprovisioning moet de groep op het dashboard worden ingeschakeld door de gebruiker voordat deze wordt uitgerold.

Reden

De reden die gebruikt wordt bij het beoordelen van het verzoek.

Groep toevoegen aan een koppeling
Afbeelding 134. Groep toevoegen aan een koppeling

18.11. Groepen binnen een koppeling

Een overzicht van de groepen binnen een koppeling is te vinden onder Groepen in systeem. Hier wordt een lijst getoond met alle groepen zoals deze zich in de koppeling bevinden, inclusief de groep(en) in KeyHub waar ze bijhoren.

Groepen op een systeem
Afbeelding 135. Groepen op een systeem
De speciale groep Enkel-account-provisioning staat het toe om een account te activeren op de koppeling zonder een groep op de koppeling hieraan te verbinden. Deze groep bestaat niet daadwerkelijk op de koppeling, maar dient enkel om te kunnen koppelen aan een groep binnen Topicus KeyHub.

18.11.1. Details van een groep op een gekoppeld systeem

Na het klikken op een groep wordt het onderstaande scherm getoond waar de details van de groep op het gekoppeld systeem getoond worden. Deze zelfde pagina is ook te bereiken via de Beheer toegang pagina.

Een groep op een gekoppeld systeem kan niet bewerkt worden. Het is wel mogelijk om de verantwoordelijkheid over te dragen aan een andere groep binnen Topicus KeyHub of om de gehele koppelgroep te verwijderen.

Het is mogelijk om een groep op een gekoppeld systeem uit Topicus KeyHub te verwijderen, maar hierbij de eigenlijke groep op het systeem zelf te behouden. Dit werkt alleen als de groep zich buiten de zoekcontext op het gekoppelde systeem bevindt, anders zal Topicus KeyHub de groep opnieuw detecteren en het record opnieuw aanmaken.
KeyHub kan niet zien of de groep buiten KeyHub om gebruikt wordt. Verwijder daarom nooit een groep uit een koppeling zonder te controleren of deze echt ongebruikt is.
Details van een groep op een gekoppeld systeem
Afbeelding 136. Details van een groep op een gekoppeld systeem

18.11.2. Groepen gekoppeld aan een groep op een gekoppeld systeem

KeyHub groepen gekoppeld aan een groep op een gekoppeld systeem
Afbeelding 137. KeyHub groepen gekoppeld aan een groep op een gekoppeld systeem

18.11.3. Serviceaccounts gekoppeld aan een groep op een gekoppeld systeem

Serviceaccounts gekoppeld aan een groep op een gekoppeld systeem
Afbeelding 138. Serviceaccounts gekoppeld aan een groep op een gekoppeld systeem

18.12. Serviceaccounts binnen een koppeling

Een overzicht van alle serviceaccounts binnen een koppeling is te vinden onder Serviceaccounts. Dit overzicht toont de configuratie van de serviceaccounts en welke groep technisch beheer uitvoert voor het serviceaccount. Het openen van een serviceaccount brengt je naar de pagina waar alle details van het serviceaccount worden getoond.

Serviceaccounts binnen een koppeling
Afbeelding 139. Serviceaccounts binnen een koppeling

18.13. Namespaces van een koppeling

Een overzicht van de namespaces van een koppeling is te vinden onder Namespaces. Hier wordt een lijst getoond met alle overzicht van de namespaces die de koppeling als basissysteem hebben. Via de knop Toevoegen kan een technisch beheerder van de koppeling direct een namespace aanmaken.

Namespaces van een koppeling
Afbeelding 140. Namespaces van een koppeling

18.14. Verleende rechten

OAuth 2.0 applicaties die gebruik maken van de client_credentials grant kunnen rechten toegekend krijgen voor operaties op een gekoppeld systeem. Zie het hoofdstuk over rechten voor OAuth 2.0 clients voor meer details over deze rechten. Onder het tabje Verleende rechten kunnen de rechten die zijn uitgegeven voor het gekoppelde systeem ingezien en desgewenst ingetrokken worden.

Alleen de groep met verantwoordelijkheid over het gekoppelde systeem kan een uitgegeven recht intrekken.
Verleende rechten aan OAuth 2.0 clients
Afbeelding 141. Verleende rechten aan OAuth 2.0 clients

18.15. Synchronisaties

Gekoppelde systemen worden éénmaal per uur volledig gesynchroniseerd. De logs hiervan kunnen ingezien worden onder Synchronisaties. Van elke synchronisatie wordt ook bijgehouden hoeveel wijzigingen zijn doorgevoerd. Onder normale omstandigheden zou een volledige synchronisatie geen wijzigingen moeten opleveren. Als er echter fouten zijn opgetreden tijdens gedeeltelijke synchronisaties of als er handmatig wijzigingen zijn doorgevoerd op het gekoppelde systeem, zullen deze afwijkingen gecorrigeerd en gerapporteerd worden.

Alleen een technisch beheerder van het systeem kan handmatig een synchronisatie starten.
Synchronisaties
Afbeelding 142. Synchronisaties

18.16. Koppelingen en organisatie-eenheden

Een koppeling is ook gebonden aan een organisatie-eenheid. Alleen groepen die gekoppeld zijn aan dezelfde organisatie-eenheid, of een organisatie-eenheid onder de eenheid van de koppeling, kunnen deze koppeling zien en gebruiken. Dit betekent dat een groep alleen gebruik kan maken van een koppelgroep als de organisatie-eenheid van de groep gelijk is aan of gelegen is onder de organisatie-eenheid van de koppeling.

De verantwoordelijke, beheerder- en inhoudsbeheerdergroepen moeten gekoppeld zijn aan dezelfde organisatie-eenheid als de koppeling.

Bij een brondirectory-koppeling is de organisatie-eenheid van de koppeling hetzelfde als die van de directory.

Het organisatie-eenheid veld van de koppeling is waarschijnlijk niet zichtbaar, tenzij deze functionaliteit actief wordt gebruikt. Bijvoorbeeld, als enkel de standaard organisatie-eenheid aanwezig is in de KeyHub installatie, zal dit veld verborgen worden.

19. Algemene instellingen

Topicus KeyHub heeft een aantal algemene instellingen die ingesteld moeten worden voordat KeyHub in gebruik genomen kan worden.

Het kan tot één minuut duren voordat gewijzigde instellingen door heel KeyHub van kracht zijn.

Deze instellingen zijn:

Domein

Vul hier het domein in dat door deze KeyHub installatie bediend wordt. Dit domein wordt gebruikt als qualifier voor de SAML v2.0 UPN en als naming context voor de interne LDAP server.

Onderhoudsbericht

Het hier ingevulde onderhoudsbericht wordt op alle pagina’s van Topicus KeyHub aan alle gebruikers getoond. Het bericht blijft staan tot het veld weer leeg gemaakt wordt.

Minimum wachtwoordlengte

Korte wachtwoorden vormen een beveiligingsrisico. Via deze optie kan een minimum wachtwoordlengte afgedwongen worden die voldoet aan de richtlijnen binnen het bedrijf. Het is aan te raden om hier een waarde van 12 of hoger te kiezen.

Standaard licentierol

De licentierol die nieuwe accounts standaard krijgen. Als dit op Pro staat, maar er geen Pro licenties meer beschikbaar zijn, worden nieuwe accounts aangemaakt als Business.

Websessie-timeout

Met deze optie kan de maximale duur van inactiviteit voor een websessie ingesteld worden voordat deze verloopt. De waarde moet liggen tussen 30m en 12h. Gebruik m voor minuten en h voor uren. Standaard staat deze op 4 uur.

Wachtwoordauthenticatie-timeout

Via deze optie kan de interval voor herauthenticatie d.m.v. het wachtwoord ingesteld worden. De waarde moet liggen tussen 30m en 7d. Gebruik m voor minuten, h voor uren en d voor dagen. Standaard staat deze op 4 uur.

2FA-authenticatie-timeout

Via deze optie kan de interval voor herauthenticatie d.m.v. een 2e factor ingesteld worden. De waarde moet liggen tussen 30m en 7d. Gebruik m voor minuten, h voor uren en d voor dagen. Standaard staat deze op 7 dagen.

De door Topicus KeyHub gebruikte waarden voor de herauthenticatie-intervals zijn zorgvuldig gekozen. Hierbij zijn beveiliging en gebruikersgemak nauwgezet tegen elkaar afgewogen. Het verkorten van deze intervallen verkleint weliswaar de tijd waarin een aanvaller misbruik zou kunnen maken van een gestolen sessie, maar heeft ook nadelige gevolgen voor het gebruikersgemak. Te strakke waarden kunnen ervoor zorgen dat gebruikers andere, minder veilige manieren gaan zoeken om toegang te krijgen tot systemen, zoals het lokaal opslaan van wachtwoorden. Te losse waarden vergroten de tijdspanne waarin een gestolen sessie misbruikt kan worden.
Branding logo

Met deze instelling kan Topicus KeyHub voorzien worden van een branding logo. Dit logo neemt de plek over van het KeyHub logo behalve op de inlogpagina waar een combinatie van de 2 logo’s wordt gemaakt. Het is alleen toegestaan een png bestand te uploaden van 540x280 pixels groot. Voor het beste resultaat is aan te raden een transparante achtergrond te gebruiken en de volledige ruimte te benutten.

Wachtwoordgeneratie

Topicus KeyHub beschikt over een instelbare wachtwoordgenerator voor wachtwoorden in de kluis. De standaard generator wordt gekozen met de waarde KEYHUB. Deze generator genereert zeer sterke wachtwoorden die voldoen aan de laatste aanbevelingen op het gebied van wachtwoordsterkte. Het is ook mogelijk om een eigen instelling te bepalen door een waarden op te geven in het formaat CL32LUDS. Deze waarde is opgebouwd uit de volgende elementen:

  1. De vaste waarde CL.

  2. Een cijfer met de lengte van het genereerde wachtwoord, tussen 8 en 250.

  3. Een keuze uit de letters LUDS in hoofd- of kleine letters. De L staat voor kleine letters, U voor hoofdletters, D voor cijfers en S voor speciale tekens. Als de letter als hoofdletter geschreven wordt, zal het wachtwoord altijd tenminste 1 teken uit die reeks bevatten. Wordt een letter uit de reeks LUDS weggelaten, dan zullen wachtwoorden gegenereerd worden zonder tekens uit de ontbrekende reeks(en).

Enkele voorbeelden:

CL8LUDS

zLPI:h8f, lengte van 8, bevat tenminste 1 kleine letter, 1 hoofdletter, 1 cijfer en 1 symbool.

CL8LUds

-YpJdLgE, lengte van 8, bevat tenminste 1 kleine letter en 1 hoofdletter, cijfers en symbolen zijn optioneel.

CL10ld

5quqdbgzz6, lengte van 10, bevat enkel kleine letters en cijfers.

CL32LUDS

C6B!*BPh1lU3cQd#*QXJTe-&a7rHCuHp, een zeer sterk wachtwoord met lengte 32 en tenminste 1 kleine letter, 1 hoofdletter, 1 cijfer en 1 symbool.

De standaard wachtwoordgenerator KEYHUB genereert zeer sterke wachtwoorden. Deze generator wordt bijgewerkt wanneer er nieuwe wachtwoordaanbevelingen zijn. Indien er voor een andere generator wordt gekozen, is de organisatie zelf verantwoordelijk voor het aanpassen van de generator. Indien verkeerd ingesteld, is het mogelijk om wachtwoorden te genereren die niet sterk genoeg zijn. Kies alleen voor een andere wachtwoordgenerator als daar zwaarwegende redenen voor zijn.
Public key voor herstel

Voordat kluizen gebruikt kunnen worden, moet een public key geüpload worden. Deze key is nodig om recovery van verloren kluizen mogelijk te maken. Bij het aanpassen van de recovery key dient altijd de oude private key meegegeven te worden. Wordt dit niet gedaan, bijvoorbeeld omdat deze niet meer beschikbaar is, zal recovery van de bestaande kluizen niet meer mogelijk zijn tot deze tenminste éénmaal geopend zijn.

Licentiesleutel

Het bestand met de licentiesleutel voor uw Topicus KeyHub installatie. Deze licentiesleutel is verstrekt door Topicus of een van haar partners bij afname van een (proef-)licentie.

LDAP-servercertificaat

Het certificaat, met bijbehorende private key, voor beveiliging van de verbindingen met de LDAP server. Zonder certificaat kan deze LDAP server niet gebruikt worden.

IdP signing-certificaat

Dit certificaat wordt door Topicus KeyHub gebruikt voor het ondertekenen van access tokens, OpenID Connect ID tokens en SAML assertions. Topicus KeyHub genereert automatisch een certificaat dat 5 jaar geldig is. Het certificaat kan vervangen worden via de appliance manager.

Uitgebreide provisioning-logging

Schakelt uitgebreide logging voor account-provisioning in. Deze optie kan zeer nuttig zijn om problemen met provisioning te onderzoeken.

Hint voor nieuwe groepsnamen

Toon een hint aan gebruikers bij het aanvragen van nieuwe groepen. Deze hint wordt als placeholder getoond in het veld voor de naam van de nieuwe groep. Vul hier bijvoorbeeld het verwachte formaat van een groepsnaam in. Het configureren van de eigenschap hier is hetzelfde als onder de hoogste organisatie-eenheid.

'Groep aanmaken' goedkeuren

Verzoeken voor het aanmaken van nieuwe groepen worden behandeld door de gekozen groep in plaats van de KeyHub administrators. Het configureren van de eigenschap hier is hetzelfde als onder de hoogste organisatie-eenheid.

'Technisch beheer inschakelen' goedkeuren

Verzoeken voor het inschakelen van technisch beheer op groepen worden behandeld door de gekozen groep in plaats van de KeyHub administrators. Het configureren van de eigenschap hier is hetzelfde als onder de hoogste organisatie-eenheid.

'Groep verwijderen' goedkeuren

Verzoeken voor het verwijderen van groepen worden behandeld door de gekozen groep in plaats van de KeyHub administrators. Het configureren van de eigenschap hier is hetzelfde als onder de hoogste organisatie-eenheid.

Wachtwoordherstel-reservegroep

Wachtwoordherstelverzoeken voor gebruikers met onvoldoende groepsmanagers worden ook gestuurd naar gebruikers in de gekozen groep in plaats van de KeyHub administrators. Het configureren van de eigenschap hier is hetzelfde als onder de hoogste organisatie-eenheid.

Auditorgroep

De groep die toegang heeft tot het auditor-dashboard. Het configureren van deze eigenschap hier zet het op de hoogste organisatie-eenheid. Als de KeyHub-administrators groep niet de verantwoordelijke groep is van de hoogste organisatie-eenheid, kan deze eigenschap hier niet aangepast worden.

Auditlogretentie

Auditlogregels worden automatisch verwijderd na de ingestelde periode. Deze periode moet minimaal 3 maanden zijn. Laat dit veld leeg om de regels nooit te verwijderen. Gebruik m voor maanden en y voor jaren, bijvoorbeeld 5y voor een periode van 5 jaar.

Auditlogpseudonimisatie

Auditlogregels worden automatisch gepseudonimiseerd na de ingestelde periode. Bij pseudonimisatie worden de velden waar gebruikersnamen in staan gewist. De regels zijn dan alleen nog te herleiden naar de gebruiker door middel van de UUID. Deze periode moet minimaal 3 maanden zijn. Laat dit veld leeg om de regels nooit te pseudonimiseren. Gebruik m voor maanden en y voor jaren, bijvoorbeeld 5y voor een periode van 5 jaar.

Responsible disclosure

Indien binnen het bedrijf een responsible disclosure policy geldt, kan deze hier opgegeven worden. Het is toegestaan om beperkt HTML te gebruiken voor de opmaak van de responsible disclosure. De volgende HTML-tags zijn toegestaan: a, b, br, div, i, li, ol, p, u en ul. De responsible disclosure zal via een link op de login-pagina getoond worden.

Algemene instellingen
Afbeelding 143. Algemene instellingen

20. Notificatie instellingen

Topicus KeyHub heeft een aantal notificatie instellingen waarmee je Topicus KeyHub’s communicatie kan aanpassen aan je eigen voorkeuren.

Het kan tot één minuut duren voordat gewijzigde instellingen door heel KeyHub van kracht zijn.

Deze instellingen zijn:

E-mail handtekening

Met deze instelling kun je een eigen e-mailhandtekening toevoegen, onderaan elke e-mail die Topicus KeyHub verstuurt. Topicus KeyHub voegt ook zijn eigen standaard handtekening toe.

Afzenderadres voor e-mail

Voer het e-mailadres in waarvandaan Topicus KeyHub e-mail zal sturen. Als dit leeg wordt gelaten, wordt het e-mailadres van de gebruiker als afzender gebruikt.

Geen links in e-mails

Als deze optie is aangevinkt voegt Topicus KeyHub geen links of URLs meer toe in e-mails. Dit omvat de accepteren/weigeren linkjes voor verzoeken, de links naar de console onderaan de e-mails en de registratie links voor interne accounts.

Gebruikersreserve

Het aantal gebruikers dat reserve gehouden wordt. Een waarschuwing zal gestuurd worden zodra er minder dan dit aantal gebruikers beschikbaar is binnen de licentie.

Notificatie instellingen
Afbeelding 144. Notificatie instellingen

21. Certificaten

X.509-certificaten spelen een zeer belangrijke rol in de beveiliging van de communicatie tussen KeyHub en de omliggende systemen. Voor een betrouwbare en veilige configuratie van KeyHub is het daarom belangrijk om goed gebruik te maken van certificaten en dienen vertrouwde certificaten bekend te zijn binnen Topicus KeyHub. Deze certificaten kunnen onder Instellingen beheerd worden.

21.1. Vertrouwde certificaten

Voor het opzetten van een beveiligde verbinding met een server moet deze server een certificaat aan kunnen bieden. De public key uit dit certificaat wordt gebruikt voor het uitwisselen van encryptiesleutels. Echter, enkel het versleutelen van de communicatie is niet voldoende. KeyHub moet er ook op kunnen vertrouwen dat de server daadwerkelijk de juiste server is. Hiervoor dient het certificaat in KeyHub ingericht te worden als vertrouwd certificaat. De meest eenvoudige manier om dit te realiseren, is door de server-certificaten te ondertekenen met één of meerdere centrale certificaten en deze certificaten te uploaden in KeyHub.

Certificaten
Afbeelding 145. Certificaten

Om een vertrouwd certificaat toe te voegen aan KeyHub dient het PEM-bestand geüpload te worden en voorzien te worden van een alias. Dit certificaat kan vervolgens op alle plekken gekozen worden waar een beveiligde verbinding geconfigureerd wordt. Het is ook mogelijk om tijdens het configureren van bijvoorbeeld een LDAP, het certificaat ter plekke te uploaden. Dit certificaat zal niet centraal beschikbaar worden gesteld.

Vertrouwd certificaat
Afbeelding 146. Vertrouwd certificaat

21.2. Certificaten met een private key

Op verschillende plekken binnen Topicus KeyHub worden certificaten in combinatie met een private key gebruikt. Dergelijke certificaten kunnen dienen voor client-authenticatie (ook wel mutual TLS genoemd) of voor de authenticatie van een server endpoint. Topicus KeyHub ondersteunt verschillende formaten voor het uploaden van deze certificaten:

PEM

Een PEM-bestand bevat de Base64-encoded DER-representatie van het certificaat of de key tussen markers in de volgende vorm: -----BEGIN CERTIFICATE----- en -----END CERTIFICATE-----. Upload het certificaat en de private key als 2 losse PEM-bestanden. Indien de private key versleuteld is met een wachtwoord, dan dient deze ook opgegeven te worden. Uiteraard dienen het certificaat en de private key bij elkaar te horen.

PKCS#12

Public-Key Cryptography Standard 12 (PKCS#12) is een complex formaat dat verschillende soorten van cryptografische informatie kan opslaan. Voor certificaten wordt PKCS#12 vaak gebruikt om een certificaat met chain en private key op te slaan in een enkel bestand. Onder Windows is de bestandsextensie .pfx veelgebruikt voor PKCS#12-bestanden. Topicus KeyHub kan een certificaat en de bijbehorende private key uit een PKCS#12-bestand lezen. De certificaatketen wordt niet uitgelezen. Het bestand en de private key dienen versleuteld te zijn met hetzelfde wachtword.

22. Nummerreeksen

Topicus keyHub kent automatisch UIDs toe aan gebruikers uit een nummerreeks. Het nummer wordt steeds 1 opgehoogd bij elk account. Door bij meerdere gekoppelde systemen dezelfde nummerreeks te gebruiken krijgen de gebruikers op al deze systemen hetzelfde UID toegewezen. Bij vervanging of herinrichting van een gekoppeld systeem kan zo ook gezorgd worden dat gebruikers hetzelfde UID blijven behouden. Een nummerreeks kan niet verwijderd worden als deze nog gebruikt wordt door een gekoppeld systeem.

Nummerreeksen
Afbeelding 147. Nummerreeksen

23. Webhooks

Met webhooks kunnen andere systemen op de hoogte gebracht worden van gebeurtenissen in KeyHub. Voor elke type gebeurtenis die in de auditlog komt, kan een webhook geconfigureerd worden. Ook is het mogelijk om een webhook te beperken tot één groep, directory, applicatie of koppeling.

Met webhooks wordt informatie over belangrijke gebeurtenissen gedeeld met andere systemen. Hoewel de informatie die standaard verstuurd wordt beknopt is, zou dit een kwaadwillende partij wel informatie kunnen geven over het gebruik van KeyHub. Bij het gebruik van 'Uitgebreide inhoud' wordt zeer gedetailleerde informatie gestuurd. Leg daarom alleen webhook-koppelingen aan met vertrouwde systemen.

23.1. Webhook aanmaken

De volgende eigenschappen kunnen ingesteld worden op een webhook:

Actief

Webhookafleveringen worden alleen uitgevoerd als de webhook actief is.

Naam

De naam van de webhook.

URL

De volledige URL waarop de aflevering van de webhook plaats moet vinden. Hier kan enkel http en https gebruikt worden.

TLS

Webhookafleveringen kunnen gevoelige informatie zoals gebruikersnamen bevatten. Het is daarom sterk aan te bevelen een beveiligde verbinding te gebruiken. Raadpleeg het hoofdstuk over certificaten voor meer details.

Vertrouwd certificaat

Via dit certificaat kan aangegeven worden welk certificaat vertrouwd moet worden bij het opzetten van een beveiligde verbinding. Indien dit veld leeg gelaten wordt, zal gebruik gemaakt worden van de standaard Java-truststore. Raadpleeg het hoofdstuk over certificaten voor meer details.

Clientcertificaat

Bij gebruik van clientauthenticatie zal KeyHub zichzelf autenticeren met een certificaat bij de ontvanger van de webhook. Raadpleeg het hoofdstuk over certificaten voor meer details.

Authenticatieschema

Als Topicus KeyHub moet authenticeren bij het afleveren van de webhook, kan hier een authenticatiemethode gekozen worden. De beschikbare opties zullen verschillende velden tonen voor het invoeren van de authenticatiegegevens.

Gebruikersnaam

Beschikbaar bij het authenticatieschema 'Basic authentication'. Deze zal samen met het wachtwoord in de Authorization header worden meegestuurd.

Wachtwoord

Beschikbaar bij het authenticatieschema 'Basic authentication'. Deze zal samen met de gebruikersnaam in de Authorization header worden meegestuurd.

Bearer Token

Beschikbaar bij het authenticatieschema 'Bearer token'. Dit token zal in de Authorization header worden meegestuurd, voorafgegaan door het woord Bearer.

Header-naam

Beschikbaar bij het authenticatieschema 'Aangepast'. Die hieronder ingevulde waarde zal in een header met deze naam worden meegestuurd.

Header-waarde

Beschikbaar bij het authenticatieschema 'Aangepast'. Die hier ingevulde waarde zal in een header met de hierboven ingevulde naam worden meegestuurd.

Uitgebreide inhoud

Stuur de volledige objecten mee bij de aflevering van een webhook. Deze optie vereist het gebruik van een beveiligde verbinding.

Webhook
Afbeelding 148. Webhook

23.1.1. Gebeurtenissen

Bij een webhook moet worden aangegeven voor welke gebeurtenissen een aflevering plaats moet vinden. De optie 'Alle gebeurtenissen' kan gebruikt worden alle bestaande en toekomstige (in latere versies van KeyHub) gebeurtenissen te selecteren. Bij de keuze voor specifieke gebeurtenissen worden deze onderverdeeld in de volgende categorieën:

Autenticatie

Gebeurtenissen omtrent geslaagde en mislukte autenticatiepogingen. Hier valt ook het openen van de kluis en het uitgeven van SSO-tokens onder.

Provisioning

Het (de)activeren van accounts en groepen op gekoppelde systemen.

Profiel

Wijzigingen omtrent accounts en de autenticatie van accounts en/of de kluis van een account.

Authorisatie

Het geven of het ontnemen van toegang tot groepen en/of kluizen.

Standaard operaties

Alle bewerkeningen die uitgevoerd worden op elementen binnen KeyHub. De operaties bestaan voornamelijk uit: aanmaken, wijzigen en verwijderen. Voor kluisregels is er een extra gebeurtenis: het lezen van het wachtwoord of bestand.

Aanvragen

Alle aanvragen die ingediend kunnen worden binnen KeyHub. Voor elk type aanvraag kan gekozen worden uit: aangevraagd, geaccepteerd en geweigerd.

23.1.2. Afleveringen

De laatste afleveringen van een webhook zijn in te zien bij het openen van de webhook. Hier is basisinformatie, zoals tijd en duur, evenals gedetailleerde informatie over de inhoud en het antwoord te vinden. Deze informatie kan gebruikt worden voor het oplossen van problemen met de aflevering. De aflevering kan opnieuw geprobeerd worden met de knop 'Opnieuw afleveren'.

Webhookaflevering
Afbeelding 149. Webhookaflevering

23.1.3. Inhoud

De inhoud van een webhookaflevering bestaat uit de volgende velden:

seq

Een oplopend nummer voor de bepaling van volgorde van aflevering. Webhooks worden asynchroon afgeleverd. Bij gebeurtenissen die snel achter elkaar plaatsvinden kan geen garantie gegeven worden over de volgorde van aflevering. Dit veld biedt uitsluitsel over de volgorde waarin de gebeurtenissen plaatsgevonden hebben. Dit veld is altijd aanwezig.

timestamp

Het exacte tijdstip waarop de gebeurtenis plaatsvond. Dit veld is altijd aanwezig.

type

Het type van de gebeurtenis. Dit veld is altijd aanwezig.

byParty

De gebruiker of applicatie die de gebeurtenis veroorzaakte. Dit veld bestaat uit een name, uuid en optioneel een object.

account

De gebruiker waarop de gebeurtenis van toepassing was. Dit veld bestaat uit een name, uuid en optioneel een object.

group

De groep waarop de gebeurtenis van toepassing was. Dit veld bestaat uit een name, uuid en optioneel een object.

group2

Een eventuele tweede groep waarop de gebeurtenis van toepassing was. Dit veld bestaat uit een name, uuid en optioneel een object.

groupClassification

De groepsclassificatie waarop de gebeurtenis van toepassing was. Dit veld bestaat uit een name, uuid en optioneel een object.

directory

De directory waarop de gebeurtenis van toepassing was. Dit veld bestaat uit een name, uuid en optioneel een object.

client

De applicatie waarop de gebeurtenis van toepassing was. Dit veld bestaat uit een name, uuid en optioneel een object.

system

Het gekoppelde systeem waarop de gebeurtenis van toepassing was. Dit veld bestaat uit een name, uuid en optioneel een object.

serviceAccount

Het serviceaccount waarop de gebeurtenis van toepassing was. Dit veld bestaat uit een name, uuid en optioneel een object.

certificate

Het certificaat waarop de gebeurtenis van toepassing was. Dit veld bestaat uit een name, uuid en optioneel een object.

vaultRecord

De kluisregel waarop de gebeuertenis van toepassing was. Dit veld bestaat uit een name, uuid en optioneel een object.

webhook

De webhook waarop de gebeurtenis van toepassing was. Dit veld bestaat uit een name, uuid en optioneel een object.

modificationRequest

Een referentie naar het verzoek waarop de gebeurtenis van toepassing was. Dit veld bestaat uit een uuid en optioneel een object.

organizationalUnit

De organisatie-eenheid waarop de gebeurtenis van toepassing was. Dit veld bestaat uit een name, uuid en optioneel een object.

accessProfile

Het toegangsprofiel waarop de gebeurtenis van toepassing was. Dit veld bestaat uit een name, uuid en optioneel een object.

securityLevel

Het beveiligingsniveau dat vereist was voor de gebeurtenis of dat betrekking had op onderwerp van de gebeurtenis.

parameter1

Een extra, vrije parameter, voor communicatie van belangrijke informatie die niet in één van de bovengenoemde velden valt.

parameter2

Een extra, vrije parameter, voor communicatie van belangrijke informatie die niet in één van de bovengenoemde velden valt.

parameter3

Een extra, vrije parameter, voor communicatie van belangrijke informatie die niet in één van de bovengenoemde velden valt.

24. Kluisherstel

Topicus KeyHub voorziet in de mogelijkheid om kluizen die ontoegankelijk geworden zijn of per abuis verwijderd zijn te herstellen. Bij de ingebruikname van KeyHub is een sleutelpaar gegenereerd. De public-key is geüpload bij de instellingen van KeyHub. De private-key is veilig opgeslagen in een fysieke kluis. Voor de herstelprocedures is deze private-key benodigd.

Kluisherstel
Afbeelding 150. Kluisherstel

24.1. Verwijderde kluizen

Als een groep, account of applicatie verwijderd wordt, zal een eventuele bijbehorende kluis ontoegankelijk worden. Topicus KeyHub bewaart dergelijke kluizen tot 100 dagen na het verwijderen. Klik op een kluis om een verwijderde kluis te herstellen.

In het getoonde venster is zichtbaar wat de naam en type van de kluis is en welke regels in de kluis zitten. Na het uploaden van de private key en het kiezen van de groep waarin de regels hersteld moeten worden, zal de inhoud van de kluis weer beschikbaar zijn. Bij alle regels wordt een eventuele prefix toegevoegd aan de naam zodat deze herkenbaar zijn na het herstel.

Een persoonlijke kluis kan alleen hersteld worden op een gelijknamig account.
Herstel verwijderde kluis
Afbeelding 151. Herstel verwijderde kluis

24.2. Onbenaderbare kluizen

In bepaalde situaties kan het gebeuren dat een kluis door niemand meer geopend kan worden. Het kan zijn dat de enige gebruiker met toegang tot een kluis zijn of haar wachtwoord vergeten is, of dat het laatste account niet meer gebruikt kan worden. In een dergelijke situatie kan door een KeyHub-administrator toegang tot de kluis hersteld worden met de recovery-sleutel.

De KeyHub-administrator klikt op de knop Toegang herstellen, selecteert de kluis en de gebruiker die toegang krijgt en upload de private-key. Hierna heeft deze gebruiker toegang gekregen tot de kluis. Deze procedure is bruikbaar bij groeps- en persoonlijke kluizen.

Herstel toegang
Afbeelding 152. Herstel toegang

24.3. Een nieuwe herstelsleutel genereren

Als de recovery-sleutel uitgelekt is of kwijtgeraakt, moet een nieuw sleutelpaar gegeneerd worden. Dit dient een RSA-sleutelpaar te zijn met een lengte van 4096 bit in DER-formaat. Dit sleutelpaar kan gegeneerd worden met de volgende openssl-commando’s:

openssl genpkey -algorithm RSA -outform der -pkeyopt rsa_keygen_bits:4096 \
      -out privatekey.der
openssl rsa -pubout -inform der -in privatekey.der -outform der \
      -out publickey.der

Upload de nieuwe publickey onder instellingen, samen met de oude privatekey, indien deze nog beschikbaar is.

25. Over Topicus KeyHub

Op de 'over'-pagina wordt algemene informatie over de Topicus KeyHub-installatie en de licentie getoond.

25.1. Op dit moment

Actieve accounts

Toont het aantal accounts dat op dit moment actief is.

Actieve sessies

Toont het aantal sessies dat op dit moment actief is.

25.2. Gebruik over tijd

Deze grafiek toont het verloop van het aantal actieve gebruikers per dag over de afgelopen twee maanden.

25.3. Licentievoorwaarden

Hier worden de relevante gegevens van de huidige licentie getoond. Als de voorwaarden overschreden worden, kan dit invloed hebben op het gebruik van Topicus KeyHub.

Afgiftedatum

De datum waarop de licentie is afgegeven.

Ingangsdatum

Voor deze datum is de licentie niet geldig.

Einddatum

Na deze datum is de licentie niet geldig.

Aantal licenties

Het totale aantal gebruikerslicenties. Dit is de som van de Business- en Pro-licenties.

Aantal Pro-licenties

Het aantal Pro-gebruikerslicenties

25.3.1. Afgenomen functies

Workflows

Met deze functie kan er gebruik gemaakt van workflows zoals extra autorisatie door andere groepen, delegatie van beheerdersrechten en privé groepen.

Geneste groepen

Met deze functie kunnen groepen genest worden binnen een andere groep.

Enterprise-organisaties

Met de enterprise-organisatiefunctie kunnen organisaties met meerdere organisatie-eenheden de verschillende eenheden scheiden.

Compliance-plus

Met deze functie komt er extra functionaliteit op het auditor-dashboard beschikbaar.

Serviceaccounts

Met deze functie komt het provisionen van serviceaccounts beschikbaar.

Identity Lifecycle Management

Met deze functie is het mogelijk om de volledige lifecycle van gebruikers automatisch te beheren.

Clusters

Met deze functie kan Topicus KeyHub in een cluster met 3 nodes uitgevoerd voor hoge beschikbaarheid.

Enterprise-clusters

Met deze functie kan Topicus KeyHub worden uitgevoerd met 5 nodes.

Isolatiemodus

Met deze functie kan Topicus KeyHub worden uitgevoerd in netwerkomgevingen die volledig zijn losgekoppeld van internet.

25.4. Licentie-eigenschappen

Hier worden de overige eigenschappen van de licentie getoond. Onder andere de afnemer (de eigenaar van de licentie) en de contactpersoon zoals die bij Topicus KeyHub bekend is.

Over Topicus KeyHub
Afbeelding 153. Over Topicus KeyHub

26. Command line interface

Topicus KeyHub kan ook aangestuurd worden via een command line interface (CLI). Voor het gebruik van de CLI dient de KeyHub CLI bundel gedownload te worden en uitgepakt op het systeem. De CLI vereist een werkende Java 17-installatie.

Voor instructies over het gebruik van de KeyHub CLI gebruik het volgende commando:

> keyhub help
usage: keyhub <command> [ <args> ]

Commands are:
    help           Display help information.
    login          Connect to a KeyHub server either as a user or as a client.
    logout         Disconnect from a KeyHub server, discarding the credentials.
    status         Shows the status of the current connection and authentication.
    switch         Switch between authentication sessions.
    version        Displays the version of the Topicus KeyHub CLI.
    provisioning   Control account provisioning in Topicus KeyHub
    query          Query for different types of objects in Topicus KeyHub
    vault          Access vaults in Topicus KeyHub

See 'keyhub help <command>' for more information on a specific command.

26.1. Inloggen met de Command line interface

Het is altijd eerst nodig om in te loggen bij KeyHub middels de CLI. Het inloggen gebeurt met het login-commando. Er zijn verschillende manier om in te loggen met de CLI van Topicus KeyHub die hieronder uitgelegd worden.

> keyhub help login
NAME
        keyhub login - Connect to a KeyHub server either as a user or as a
        client.

SYNOPSIS
        keyhub login [ --client-credentials-grant ] [ --client-id <clientId> ]
                [ --client-secret <clientSecret> ] [ --store-secret ]
                [ --target-client-id <targetClientId> ] [ --uri <uri> ]

OPTIONS
        --client-credentials-grant
            Authenticate as a client, rather than as a user.


        --client-id <clientId>
            The client identifier as issued by KeyHub. When the client-id and
            secret are ommitted, the internal KeyHub Command Line Interface
            application is used.


        --client-secret <clientSecret>
            The client secret as issued by KeyHub, use '-' for a prompt.


        --store-secret
            Store the client-secret on disk for subsequent calls.


        --target-client-id <targetClientId>
            Produce a login token or assertion for the specified client
            identifier.


        --uri <uri>
            The root URI of the KeyHub instance including protocol (i.e.
            https://keyhub.mycompany.com).

26.1.1. Inloggen als een gebruiker

De meest eenvoudige manier om in te loggen is als gewone gebruiker door gebruik te maken van de voorgedefinieerde KeyHub Command Line Interface-client.

Gebruik login met een --uri-parameter om in te loggen op Topicus KeyHub en volg de instructies:

> keyhub login --uri https://keyhub.example.org/
Authentication is required

Using a browser visit                          And enter the code
https://keyhub.example.org/login/code                    WMRJ-HRWW

Or directly visit
https://keyhub.example.org/login/code?usercode=WMRJ-HRWW
> keyhub status
Session #1 (active)
Status: connected to https://keyhub.example.org/
  Type: user authenticated on default CLI
  Client ID: 77ef8551-b8f2-46da-9932-1241e7997b0b
  User logged in: keyhubuser
  Access token: valid until 2024-06-20T16:26:46.757775068Z
  Vault: valid until 2024-06-20T16:26:46.757775068Z

Controleer de informatie en rond het inlogproces af.

Controleer de code
Afbeelding 154. Controleer de code

26.1.2. Een beveiligde client gebruiken

Het nadeel van de methode die hierboven beschreven is, is dat de standaard KeyHub Command Line Interface-client geen langdurige inlogsessie ondersteunt. KeyHub Command Line Interface heeft het profiel Publieke native applicatie, waardoor het geen refresh tokens krijgt. Het gevolg is dat de sessie na een uur verlopen is, en de gebruiker opnieuw moet inloggen. Dit kan opgelost worden door een eigen client te maken met het profiel Native applicatie met secret en hierop in te loggen. Doordat bij dit type client wel refresh tokens gebruikt kunnen worden, zal de sessie zeer lang actief blijven. Log in op de volgende manier:

> keyhub login --uri https://keyhub.example.org/ \
    --client-id d5bee030-89a1-47f7-a114-e523ccfdc0c1 \
    --client-secret UHjn8ldBkvlsjfYSvXGLzLndq_30FNvMfLk1J0yq \
    --store-secret
Authentication is required

Using a browser visit                          And enter the code
https://keyhub.example.org/login/code                    ZZMZ-LBCB

Or directly visit
https://keyhub.example.org/login/code?usercode=ZZMZ-LBCB

26.1.3. Inloggen op een SAML v2.0-applicatie

Het is ook mogelijk om via de CLI in te loggen op een SAML v2.0-applicatie. Het inloggen zal in deze situatie een SAML Response opleveren, welke gebruikt kan worden om te authenticeren op de applicatie. Ook hier geldt dat gebruik gemaakt kan worden van een eigen client om een langere sessieduur te krijgen:

> keyhub login --uri https://keyhub.example.org/ \
    --target-client-id https://saml2-client.example.org \
    --client-id f3352687-fe5e-4ca1-a17b-3c61c5da062e \
    --client-secret eeunpl6UVgrypAyFEodBIvOeRD_SadcSbrOHCWOR \
    --store-secret
Authentication is required

Using a browser visit                          And enter the code
https://keyhub.example.org/login/code                    RNXF-RMCT

Or directly visit
https://keyhub.example.org/login/code?usercode=RNXF-RMCT

<?xml version="1.0" encoding="UTF-8"?><saml2p:Response> ... </saml2p:Response>

26.1.4. Inloggen met de client credentials grant

Voor geautomatiseerde koppelingen kan het soms handig zijn om in te loggen met de client credentials grant. In deze gevallen authenticeert de CLI zelf in plaats van een gebruiker. Maak hiervoor een OAuth 2.0-client en login op de volgende manier:

> keyhub login --uri https://keyhub.example.org/ \
    --client-id 31d40750-eb6c-40b6-91d7-cf2b79984a5d \
    --client-secret MPn6sfm9jzQq8weYNtCYbENxLo3Ms2IR7SlO-mpZ \
    --client-credentials-grant

> keyhub status
Session #1 (active)
Status: connected to https://keyhub.example.org/
  Type: client credentials grant
  Client ID: 31d40750-eb6c-40b6-91d7-cf2b79984a5d
  Client Secret: not stored
  Access token: valid until 2024-06-20T16:25:13.983398721Z
  Vault: valid until 2024-06-20T16:25:13.983398721Z

26.2. Ingelogde sessies beheren en uitloggen

In de bovenstaande voorbeelden is al een aantal keer het status-commando gebruikt:

> keyhub help status
NAME
        keyhub status - Shows the status of the current connection and
        authentication.

SYNOPSIS
        keyhub status

Als er meerdere ingelogde sessies zijn, ziet dat er als volgt uit:

> keyhub status
Session #1
Status: connected to https://keyhub.example.org/
  Type: client credentials grant
  Client ID: 31d40750-eb6c-40b6-91d7-cf2b79984a5d
  Client Secret: not stored
  Access token: valid until 2024-06-20T16:25:13.983398721Z
  Vault: valid until 2024-06-20T16:25:13.983398721Z

Session #2
Status: connected to https://keyhub.example.org/
  Type: user authenticated on default CLI
  Client ID: 77ef8551-b8f2-46da-9932-1241e7997b0b
  User logged in: keyhubuser
  Access token: valid until 2024-06-20T16:25:19.198226750Z
  Vault: valid until 2024-06-20T16:25:19.198226750Z

Session #3
Status: connected to https://keyhub.example.org/
  Type: user authenticated on custom CLI client
  Client ID: d5bee030-89a1-47f7-a114-e523ccfdc0c1
  Client Secret: stored
  User logged in: keyhubuser
  Access token: valid until 2024-06-20T16:25:24.550471831Z
  Vault: valid until 2024-06-20T16:25:24.550471831Z, extended on demand

Session #4 (active)
Status: connected to https://keyhub.example.org/
  Type: user authenticated on target client, custom CLI client
  Client ID: d5bee030-89a1-47f7-a114-e523ccfdc0c1
  Client Secret: stored
  Authenticated for: https://saml2-client.example.org
  Access token: valid until 2024-06-20T16:25:29.869966951Z

Met het switch-commando kan de active sessie gewisseld worden:

> keyhub help switch
NAME
        keyhub switch - Switch between authentication sessions.

SYNOPSIS
        keyhub switch --index <index>

OPTIONS
        --index <index>
            The index of the session to active. Use 'status' to list the
            available sessions.

Een sessie kan uitgelogd worden met behulp van het logout-commando:

> keyhub help logout
NAME
        keyhub logout - Disconnect from a KeyHub server, discarding the
        credentials.

SYNOPSIS
        keyhub logout [ --all ] [ --index <index> ]

OPTIONS
        --all
            Logout all active sessions.

        --index <index>
            The index of the session to logout. When not specified, the last
            used session will be logged out.

26.3. Zoeken

Via de CLI kan gezocht worden naar elementen in Topicus KeyHub. Gebruik hiervoor een commando uit de query-commandogroep:

> keyhub help query
NAME
        keyhub query - Query for different types of objects in Topicus KeyHub

SYNOPSIS
        keyhub query { accounts | groups | records } [--] [ --uuid <uuid> ]
                [ --matches <matches> ] [ --query <query> ] [ --name <name> ]
                [ --output <output> ] [cmd-options]

        Where command-specific options [cmd-options] are:
            accounts:
            groups: [ --own ]
            records: [ --type <type> ]

        See 'keyhub help query <command>' for more information on a specific command.

Alle commando’s accepteren tenminste de hieronder genoemde opties. Als meerdere zoekopties opgegeven worden, worden slechts die regels teruggeven die overeenkomen met alle opgegeven zoekopties.

--name

Zoekt op een exacte overeenkomst met de naam van het element.

--uuid

Zoekt op een exacte overeenkomst met het UUID van het element.

--matches

Hiermee wordt gefilterd op een tekstuele overeenkomst binnen het element. Dit omvat de UUID, naam, en mogelijk andere onderdelen.

--query

Hiermee kan gezocht worden op verschillende eigenschappen van het element. De syntax van deze query wordt hieronder beschreven.

Om te kunnen zoeken op regels uit meerdere kluizen tegelijkertijd kan het query records-commando gebruikt worden. De volgende extra zoek-optie is hierbij beschikbaar:

--type

Hiermee wordt gefilterd op het type van een kluisregel. De mogelijke waarden zijn PASSWORD, FILE, TOTP en COMMENT.

De laatste kolom toont de aanwezige type waarden binnen de regel: P voor wachtwoord, F voor een bestand, T voor TOTP en C voor een opmerking. De uitkomst van een vault query-commando kan gecombineerd worden met een vault read-commando om een specifiek record uit te lezen.

> keyhub query records --matches foo
VAULT                                  VAULT NAME       RECORD                                 NAME                  URL                  USERNAME   SECRETS
25bbf8c4-499c-4940-b16f-dfb0f54c749c   personal vault   53e81d9a-08b7-4efc-aadf-dc599ed0be8c   passwordforfoo        http://example.com   usn        P  C
25bbf8c4-499c-4940-b16f-dfb0f54c749c   personal vault   9cd0669c-a2d9-40dd-9748-42035d3ff371   file                                                   F
d590b067-74f9-48a7-8e38-7391f8a3518c   Product-X Test   385706a1-ceb5-4326-97ef-2fb22dadd986   grouppasswordforfoo                                   P  C
> keyhub query records --matches foo --type PASSWORD
VAULT                                  VAULT NAME       RECORD                                 NAME                  URL                  USERNAME   SECRETS
25bbf8c4-499c-4940-b16f-dfb0f54c749c   personal vault   53e81d9a-08b7-4efc-aadf-dc599ed0be8c   passwordforfoo        http://example.com   usn        P  C
d590b067-74f9-48a7-8e38-7391f8a3518c   Product-X Test   385706a1-ceb5-4326-97ef-2fb22dadd986   grouppasswordforfoo                                   P  C
> keyhub vault read --group d590b067-74f9-48a7-8e38-7391f8a3518c \
    --record 385706a1-ceb5-4326-97ef-2fb22dadd986 --type PASSWORD
groupsecret

26.3.1. Queries voor zoeken

De syntax van een query is:

expression
  : expression 'and' expression
  | expression 'or' expression
  | 'not' expression
  | ( path '.' )? '(' expression ')'
  | path '=' value
  ;

path : IDENTIFIER ( '.' IDENTIFIER )*   ;

value : LITERAL ( ',' LITERAL )* ;

LITERAL : '\'' ( ~'\'' )* '\'' ;
IDENTIFIER : [a-zA-Z0-9_]+ ;

Een voorbeeld van een query is (let op de quotes):

--query "color='GREEN' and not name='exclude this' or secret.type='FILE'"

De beschikbare filtereigenschappen kunnen gevonden in de OpenAPI-definitie onder het /keyhub/rest/v1/vaultrecord pad.

26.4. Kluizen gebruiken

Toegang tot de kluizen wordt geregeld door de commando’s in de vault-commandogroep:

> keyhub help vault
NAME
        keyhub vault - Access vaults in Topicus KeyHub

SYNOPSIS
        keyhub vault { cp | export | import | list | lock | mv | read | rm |
                share | unlock | write } [--] [cmd-options]

        Where command-specific options [cmd-options] are:
            cp: --record <recordUuid> [ --personal ] [ --client ] [ --group <group> ]
                    [ --target-account <targetAccount> ] [ --target-group <targetGroup> ]
                    [ --output <output> ]
            export: [ --file <file> ] [ --personal ] [ --client ] [ --group <group> ]
                    [ --output <output> ]
            import: --file <file> [ --personal ] [ --verbose ] [ --client ] [ --group <group> ]
                    [ --output <output> ]
            list: [ --personal ] [ --client ] [ --group <group> ] [ --output <output> ]
            lock:
            mv: --record <recordUuid> [ --personal ] [ --client ] [ --group <group> ]
                    [ --target-account <targetAccount> ] [ --target-group <targetGroup> ]
                    [ --output <output> ]
            read: [ --type <type> ] [ --record <recordUuid> ] [ --query <query> ]
                    [ --personal ] [ --client ] [ --group <group> ] [ --output <output> ]
            rm: --record <recordUuid> [ --personal ] [ --client ] [ --group <group> ]
                    [ --output <output> ]
            share: --record <recordUuid> [ --personal ] [ --client ] [ --group <group> ]
                    [ --target-account <targetAccount> ] [ --target-group <targetGroup> ]
                    [ --output <output> ]
            unlock: [ --client-secret <clientSecret> ]
            write: [ --password <password> ] [ --record <recordUuid> ] [ --filename <filename> ]
                    [ --file <file> ] [ --color <color> ] [ --client ] [ --totp <totp> ]
                    [ --username <username> ] [ --warningperiod <warningPeriod> ]
                    [ --personal ] [ --name <name> ] [ --group <group> ] [ --comment <comment> ]
                    [ --url <url> ] [ --enddate <endDate> ] [ --output <output> ]

        See 'keyhub help vault <command>' for more information on a specific command.

Indien bij het inloggen niet de optie --store-secret is meegegeven moet de kluis expliciet geopend worden met het unlock-commando:

> keyhub help vault unlock
NAME
        keyhub vault unlock - Unlock the vaults.

SYNOPSIS
        keyhub vault unlock [ --client-secret <clientSecret> ]

OPTIONS
        --client-secret <clientSecret>
            The client secret as issued by KeyHub, use '-' for a prompt.

Om de kluis naderhand weer te sluiten wordt het lock-commando gebruikt:

> keyhub help vault lock
NAME
        keyhub vault lock - Lock the vaults.

SYNOPSIS
        keyhub vault lock

26.4.1. Wachtwoorden uitlezen en wegschrijven

Via de CLI kunnen alle kluizen benaderd worden die via de browser ook beschikbaar zijn. De CLI kan toegang hebben tot meerdere groepskluizen en heeft altijd toegang tot de persoonlijke kluis of een client-gebonden kluis. Deze laatste is de equivalent van de persoonlijke kluis van een gebruiker. De client-gebonden kluis kan niet uitgelezen worden door gebruikers en/of andere CLI-clients. De commando’s voor het benaderen van wachtwoorden in kluizen verwachten allemaal één van de volgende opties: --personal, --client of --group <UUID>. Deze opties selecteren respectievelijk de persoonlijke kluis van de gebruiker, de client-gebonden kluis en de kluis van de groep met het geven UUID.

Om uit te lezen welke wachtwoorden er in een kluis zitten, wordt het vault list-commando gebruikt:

> keyhub help vault list
NAME
        keyhub vault list - Lists the records in a vault.

SYNOPSIS
        keyhub vault list [ --client ] [ --group <group> ]
                [ --output <output> ] [ --personal ]

OPTIONS
        --client
            Use the client's vault. Can only be used when a client is
            authenticated.

            This option is part of the group 'vault' from which only one option
            may be specified



        --group <group>
            Use the vault for the given group (UUID).

            This options value must have a length of 36 characters


            This option is part of the group 'vault' from which only one option
            may be specified



        --output <output>
            Select the output format.

            This options value is restricted to the following set of values:
                json
                plain
                detail
                csv


        --personal
            Use your personal vault. Can only be used when a user is
            authenticated.

            This option is part of the group 'vault' from which only one option
            may be specified

Dit commando zal niet het wachtwoord, bestand of code teruggeven, enkel de metadata. Om het daadwerkelijke wachtwoord, bestand of code te ontsleutelen en uit te lezen, dient het vault read-commando:

> keyhub help vault read
NAME
        keyhub vault read - Reads a record in a vault.

SYNOPSIS
        keyhub vault read [ --client ] [ --group <group> ]
                [ --output <output> ] [ --personal ] [ --query <query> ]
                [ --record <recordUuid> ] [ --type <type> ]

OPTIONS
        --client
            Use the client's vault. Can only be used when a client is
            authenticated.

            This option is part of the group 'vault' from which only one option
            may be specified



        --group <group>
            Use the vault for the given group (UUID).

            This options value must have a length of 36 characters


            This option is part of the group 'vault' from which only one option
            may be specified



        --output <output>
            Select the output format.

            This options value is restricted to the following set of values:
                json
                plain
                detail
                csv


        --personal
            Use your personal vault. Can only be used when a user is
            authenticated.

            This option is part of the group 'vault' from which only one option
            may be specified



        --query <query>
            A query for the record to read.

            This option is part of the group 'query' from which only one option
            may be specified



        --record <recordUuid>
            The record to read (UUID).

            This options value must have a length of 36 characters


            This option is part of the group 'query' from which only one option
            may be specified



        --type <type>
            The type of secret to display.

Met vault write kunnen nieuwe wachtwoorden worden weggeschreven of worden bijgewerkt:

> keyhub help vault write
NAME
        keyhub vault write - Creates or updates a record in a vault.

SYNOPSIS
        keyhub vault write [ --client ] [ --color <color> ]
                [ --comment <comment> ] [ --enddate <endDate> ]
                [ --file <file> ] [ --filename <filename> ] [ --group <group> ]
                [ --name <name> ] [ --output <output> ]
                [ --password <password> ] [ --personal ]
                [ --record <recordUuid> ] [ --totp <totp> ] [ --url <url> ]
                [ --username <username> ] [ --warningperiod <warningPeriod> ]

OPTIONS
        --client
            Use the client's vault. Can only be used when a client is
            authenticated.

            This option is part of the group 'vault' from which only one option
            may be specified



        --color <color>
            The color of the record.

            This options value is restricted to the following set of values:
                NONE
                GREEN
                RED
                BLUE
                DARK
                PINK_LAVENDER
                CRIMSON_RED
                MIDDLE_YELLOW
                ANDROID_GREEN
                SAGE
                ARTICHOKE


        --comment <comment>
            A comment on the record, use '-' for stdin.


        --enddate <endDate>
            The end date for the record, formatted as yyyy-mm-dd.


        --file <file>
            The file to store with the record, use '-' for stdin.


        --filename <filename>
            The filename to be set on a record of type FILE.


        --group <group>
            Use the vault for the given group (UUID).

            This options value must have a length of 36 characters


            This option is part of the group 'vault' from which only one option
            may be specified



        --name <name>
            The name of the record.


        --output <output>
            Select the output format.

            This options value is restricted to the following set of values:
                json
                plain
                detail
                csv


        --password <password>
            The password to store with the record, use '-' for stdin.


        --personal
            Use your personal vault. Can only be used when a user is
            authenticated.

            This option is part of the group 'vault' from which only one option
            may be specified



        --record <recordUuid>
            The record to update (UUID).

            This options value must have a length of 36 characters



        --totp <totp>
            The TOTP secret to store with the record, use '-' for stdin.


        --url <url>
            The URL to be set on the record.


        --username <username>
            The username to be set on the record.


        --warningperiod <warningPeriod>
            How far in advance Topicus KeyHub should start displaying expiry
            warnings.

            This options value is restricted to the following set of values:
                AT_EXPIRATION
                TWO_WEEKS
                ONE_MONTH
                TWO_MONTHS
                THREE_MONTHS
                SIX_MONTHS
                NEVER

Om een lijst met wachtwoorden op te vragen en vervolgens één van deze wachtwoorden uit te lezen, kunnen de volgende commando’s gebruikt worden:

> keyhub vault list --client
Vault for https://keyhub.example.org/keyhub/rest/v1/client/1024108
RECORD                                 NAME       URL                  USERNAME   SECRETS
3cb167c0-718a-4bee-908e-e35154478893   password   http://example.com   usn        P  C
> keyhub vault read --client --type PASSWORD \
    --record 3cb167c0-718a-4bee-908e-e35154478893
secretreadfromstdin

26.4.2. Wachtwoorden kopiëren, verplaatsen en delen

Met de commando’s vault cp, vault mv en vault share kunnen wachtwoorden respectievelijk gekopieerd, verplaatst en gedeeld worden. De opties voor deze commando’s zijn gelijk.

> keyhub help vault cp
NAME
        keyhub vault cp - Copies a record from one vault to another.

SYNOPSIS
        keyhub vault cp [ --client ] [ --group <group> ] [ --output <output> ]
                [ --personal ] --record <recordUuid>
                [ --target-account <targetAccount> ]
                [ --target-group <targetGroup> ]

OPTIONS
        --client
            Use the client's vault. Can only be used when a client is
            authenticated.

            This option is part of the group 'vault' from which only one option
            may be specified



        --group <group>
            Use the vault for the given group (UUID).

            This options value must have a length of 36 characters


            This option is part of the group 'vault' from which only one option
            may be specified



        --output <output>
            Select the output format.

            This options value is restricted to the following set of values:
                json
                plain
                detail
                csv


        --personal
            Use your personal vault. Can only be used when a user is
            authenticated.

            This option is part of the group 'vault' from which only one option
            may be specified



        --record <recordUuid>
            The record to copy (UUID).

            This options value must have a length of 36 characters



        --target-account <targetAccount>
            Copy the selected record to the targeted personal vault (UUID).

            This options value must have a length of 36 characters


            This option is part of the group 'target' from which only one
            option may be specified



        --target-group <targetGroup>
            Copy the selected record to the targeted group vault (UUID).

            This options value must have a length of 36 characters


            This option is part of the group 'target' from which only one
            option may be specified

Met --personal, --client of --group <UUID>, in combinatie met --record <UUID>, wordt het wachtwoord geselecteerd. Vervolgens wordt met --target-account <UUID> of --target-group <UUID> de doelkluis gekozen.

26.4.3. Wachtwoorden importeren en exporteren

Met het vault import-commando kunnen kluisregels in bulk geïmporteerd worden uit een CSV-bestand. Het CSV-bestand dient één kluisregel per regel te bevatten in het hieronder getoonde formaat en dient UTF-8 zonder BOM als encoding te gebruiken. Een veld kan gequote worden met behulp van dubbele aanhalingstekens om parse-fouten te voorkomen indien het een komma bevat. Gebruik geen header-regel of zorg dat deze begint met exact de waarden name, color en url. De naam en tenminste één geheim (wachtwoord, totp of opmerking) is verplicht. De opties komen overeen met die van het vault write-commando.

naam, kleur, url, gebruikersnaam, wachtword, totp-geheim, einddatum, waarschuwingsperiode, opmerking

Enkele voorbeeldregels zijn:

Repo,RED,https://nu.nl,username1,password1,4334654345,2021-01-01,SIX_MONTHS,
Test account,BLUE,,,password1,,,,"long comment, with quotes"
Drive,,,,,,,,"this has a comment only, defaults to NONE"
Webshop,NONE,,user,pwd,,,,"Use double double quotes like this:"" to get a quote"
> keyhub help vault import
NAME
        keyhub vault import - Imports all records from a CSV file into a vault.
        The CSV file must contain the following fields:
        name,color,url,username,password,totp,enddate,warningperiod,comment.
        See the manual for more information on the expected format.

SYNOPSIS
        keyhub vault import [ --client ] --file <file> [ --group <group> ]
                [ --output <output> ] [ --personal ] [ --verbose ]

OPTIONS
        --client
            Use the client's vault. Can only be used when a client is
            authenticated.

            This option is part of the group 'vault' from which only one option
            may be specified



        --file <file>
            The CSV file to import.

            This options value must be a path to a file. The provided path must
            exist on the file system. The provided path must be readable and
            writable.



        --group <group>
            Use the vault for the given group (UUID).

            This options value must have a length of 36 characters


            This option is part of the group 'vault' from which only one option
            may be specified



        --output <output>
            Select the output format.

            This options value is restricted to the following set of values:
                json
                plain
                detail
                csv


        --personal
            Use your personal vault. Can only be used when a user is
            authenticated.

            This option is part of the group 'vault' from which only one option
            may be specified



        --verbose
            Log every record imported.

Met vault export kan een kluis geëxporteerd worden. Het formaat van de export is gelijk aan dat van de import.

TOTP-geheimen, bestanden en kluisregels die gedeeld zijn vanuit andere kluizen worden niet geëxporteerd.
> keyhub help vault export
NAME
        keyhub vault export - Exports all records from a vault into a CSV file.
        The CSV file will contain the following fields:
        name,color,url,username,password,totp,enddate,warningperiod,comment.

SYNOPSIS
        keyhub vault export [ --client ] [ --file <file> ] [ --group <group> ]
                [ --output <output> ] [ --personal ]

OPTIONS
        --client
            Use the client's vault. Can only be used when a client is
            authenticated.

            This option is part of the group 'vault' from which only one option
            may be specified



        --file <file>
            Write the contents to the given file.

            This options value must be a path to a file. The provided path must
            be readable and writable.



        --group <group>
            Use the vault for the given group (UUID).

            This options value must have a length of 36 characters


            This option is part of the group 'vault' from which only one option
            may be specified



        --output <output>
            Select the output format.

            This options value is restricted to the following set of values:
                json
                plain
                detail
                csv


        --personal
            Use your personal vault. Can only be used when a user is
            authenticated.

            This option is part of the group 'vault' from which only one option
            may be specified

26.5. Account provisioning

Via de CLI kan de dynamische provisioning van accounts binnen Topicus KeyHub aangesproken worden. Dit wordt gedaan met de commando-groep provisioning:

> keyhub help provisioning
NAME
        keyhub provisioning - Control account provisioning in Topicus KeyHub

SYNOPSIS
        keyhub provisioning { activate | deactivate | password | rotatepassword
                | status } [--] [ --output <output> ] [cmd-options]

        Where command-specific options [cmd-options] are:
            activate: [ --reason <reason> ] [ --minutes <durationInMinutes> ]
                    --group <groupUuid>
            deactivate: [ --all ] [ --group <groupUuid> ]
            password:
            rotatepassword:
            status: [ --filter <filter> ]

        See 'keyhub help provisioning <command>' for more information on a specific command.

26.5.1. Roterende wachtwoorden

Met het commando provisioning password wordt het roterende wachtwoord teruggegeven. Dit wachtwoord kan geroteerd worden met provisioning rotatepassword. Voor beide commando’s dient de gebruiker het roterende wachtwoord ingeschakeld te hebben staan op het account.

26.5.2. Activatie and deactivatie van accounts via provisioning

Met het commando provisioning activate kan provisioning van accounts worden gedaan. Dit command vereist een argument --group <UUID>. Hiermee wordt de gewenste groep aangegeven. Een optioneel --reason <tekst> argument kan gebruikt worden wanneer activatie van een groep een wachtwoord vereist. Een groep wordt standaard aangezet voor 1 uur. Dit kan worden aangepast met het --minutes argument.

Deactivatie van een groep kan middels het provisioning deactivate commando. Het argument --group <UUID> kan worden gebruikt om één specifieke groep te selecteren die wordt gedeactiveerd. Om alle groepen te deactiveren kan het argument --all worden gebruikt.

Om de huidige provisioning status van alle groepen te bekijken kan het commando provisioning status worden gebruikt. Dit commando geeft een dergelijke uitkomst:

> keyhub provisioning status
UUID                                   NAME             STATUS                          REASON         AUTHORIZATION   FOLDER
b82c9778-bec7-4d11-ba99-9cfd9a40c3f1   Product-X Test   active until 2024-06-20 16:30   not required   not required
ca6ed054-8bf5-4596-8f5d-32dac25bb35f   Product-X Dev    inactive                        not required   not required

26.6. Configuratie voor client credentials

Voor het gebruik van de CLI zonder gebruikerslogin dient een OAuth2-applicatie aangemaakt te worden in KeyHub. Bij deze applicatie dient gekozen te worden voor Client credentials grant. Zonder verdere configuratie kan deze applicatie gebruikt worden voor het opslaan van kluisregels in de applicatie-gebonden kluis. Voor toegang tot kluizen van groepen moet de applicatie eerst rechten krijgen om de kluizen van de betreffende groepen te benaderen. Voor meer informatie hierover zie de sectie over rechten voor OAuth 2.0 clients.

Virtual appliance

27. Installatie - configuratie

Welkom bij de Topicus KeyHub-installatie. Log in met het 6-cijferige wachtwoord dat wordt weergegeven op de terminal of seriële console van de appliance. Als de appliance nog niet deployed is is een guide te vinden in de Best practice guide. De installatie-wizard zal Topicus KeyHub stap voor stap klaarmaken voor gebruik.

Indien een back-up teruggezet gaat worden van een eerdere installatie, kan gekozen worden voor de optie 'Back-up terugzetten'. Er zal de optie geboden worden om alle configuratie uit de back-up in te lezen of enkel de gegevens te importeren.

Welkom bij de Topicus KeyHub-installatie
Afbeelding 155. Welkom bij de Topicus KeyHub-installatie

27.1. Stap 1 - Onderhoudswachtwoord veranderen

De eerste stap is het aanpassen van het onderhoudswachtwoord. Het huidige wachtwoord is het wachtwoord dat vanaf de console gekopieerd is. Topicus KeyHub geeft een suggestie voor een voldoende sterk wachtwoord, maar handmatig invullen is ook mogelijk.

Sla het nieuwe wachtwoord op een veilige locatie op.
Stap 1 - Onderhoudswachtwoord veranderen
Afbeelding 156. Stap 1 - Onderhoudswachtwoord veranderen

27.2. Stap 2.1 - Configureer tijd

Geef de tijdzone op voor Topicus KeyHub en configureer NTP.

Stap 2.1 - Configureer tijd
Afbeelding 157. Stap 2.1 - Configureer tijd
Tijdzone

Kies hierbij de tijdzone waarin de meeste gebruikers van Topicus KeyHub werken.

NTP-servers

Voor het functioneren van Topicus KeyHub is het belangrijk dat de klok van de machine goed staat. Standaard wordt gebruik gemaakt van NTP-servers uit de NTP-pool. Indien deze niet benaderbaar zijn, of er dient gebruik gemaakt te worden van andere servers, dan kunnen deze hier ingesteld worden.

27.3. Stap 2.2 - Configureer netwerkparameters

Het juist configureren van de netwerkparameters is van groot belang, aangezien een foute configuratie ertoe kan leiden dat Topicus KeyHub onbereikbaar wordt.

Stap 2.2 - Configureer netwerkparameters
Afbeelding 158. Stap 2.2 - Configureer netwerkparameters
DHCP

Draait Topicus KeyHub met een statische IP-configuratie of is deze dynamisch (DHCP).

IP-adres

Het statische ip-adres waarop Topicus KeyHub draait.

Netmask

De netmask voor de statische IP-configuratie.

Gateway

De gateway voor de statisch IP-configuratie.

DNS-servers

Een lijst van te gebruiken DNS-servers. Voeg hier eventuele intern gebruikte DNS-servers toe.

Externe URL

De URl waarop Topicus KeyHub bereikbaar is voor gebruikers.

Offline

Draai de Topicus KeyHub-appliance zonder actieve internetverbinding. Voor meer informatie, zie 'Offline installatie'.

Geproxyde opstelling

Indien Topicus KeyHub achter een reverse proxy draait, dient dit aangevinkt te worden. Voor meer informatie, zie 'Geproxyde opstelling'.

Hostnaam

De hostnaam van de server van Topicus KeyHub.

Domein

Het domein waarbinnen Topicus KeyHub draait.

FQDN

De fully qualified domain name die volgt uit bovenstaande instellingen.

27.3.1. Offline installatie

Het is mogelijk de Topicus KeyHub-appliance te installeren en draaien zonder internetverbinding. Hiervoor dient de image gebruikt te worden dat geschikt is voor offline installatie. Het is zeer belangrijk dat de klok van de Topicus KeyHub-appliance gesynchroniseerd wordt voor correct werking van 2FA. Bij een offline installatie dient daarom een bereikbare NTP-server ingesteld worden. Omdat de Topicus KeyHub geen updates kan binnenhalen via internet dient de appliance handmatig geüpdatet te worden door middel van de update-bestanden van de Topicus KeyHub website. Deze update-bestanden bevatten updates voor de Topicus KeyHub-applicatie en het onderliggende OS. Aanvullende updates voor het OS kunnen ook binnengehaald worden via een bedrijfsrepository.

27.3.2. Geproxyde opstelling

Bij gebruik in een geproxyde opsteling zal Topicus KeyHub luisteren naar de volgende HTTP-headers van de proxy: X-Forwarded-For, X-Forwarded-Proto en X-Forwarded-Port. De reverse proxy moet worden geconfigureerd om deze headers correct in te stellen. De beheerinterface is toegankelijk op de FQDN (combinatie van hostnaam en domein), terwijl Topicus KeyHub zelf toegankelijk is op de gegeven externe URL. Het certificaat dat gegeven wordt bij stap 2.3 moet geldig zijn voor de FQDN, niet de externe URL. Dit certificaat wordt gebruikt om de communicatie tussen de reverse omgekeerde proxy en Topicus KeyHub te beveiligen. Het certificaat voor de externe URL moet worden geconfigureerd op de reverse proxy. Een voorbeeldconfiguratie voor NGINX kan hieronder gevonden worden.

NGINX voorbeeldconfiguratie
server {
   listen 80;
   server_name external-url.example.com;
   return 301 https://external-url.example.com/;
}
server {
   include tls-configuration.inc;

   listen 443 ssl http2;
   server_name external-url.example.com;

   access_log /var/log/nginx/external-url.example.com.access.log;
   error_log /var/log/nginx/external-url.example.com.error.log error;

   location / {
      proxy_pass          https://hostname.domain:443;
      proxy_redirect      off;

      proxy_set_header    Host               $host;
      proxy_set_header    X-Real-IP          $remote_addr;
      proxy_set_header    X-Forwarded-For    $remote_addr;
      proxy_set_header    X-Forwarded-Port   $server_port;
	  proxy_set_header    X-Forwarded-Proto  https;
   }
}

27.4. Stap 2.3 - Configureer servercertificaten

Topicus KeyHub kan alleen gebruikt worden over beveiligde verbindingen. Hiervoor is het noodzakelijk om de servercertificaten te configureren.

Stap 2.3 - Configureer servercertificaten
Afbeelding 159. Stap 2.3 - Configureer servercertificaten
Let’s Encrypt

Gebruik de gratis online dienst Let’s Encrypt voor het automatisch aanvragen van certificaten. Deze optie is niet beschikbaar indien een geproxyde opstelling gebruikt wordt.

Servercertificaat

Kies hier het publieke certificaat-bestand (PEM) en het private key-bestand (PEM) of een gecombineerd PKCS#12-bestand. Raadpleeg het hoofdstuk over certificaten voor meer details over de verschillende formaten.

Let er hierbij op dat het certificaat dat wordt ingevoerd ook door de huidige browser vertrouwd wordt, anders zal stap 2.4 falen.
Certificaatautoriteit(en)

Voor de configuratie van de web interface is een volledige certificaatketen nodig. Geef hier een PEM-bundel op met alle certificaten die nodig zijn om de volledige certificaatketen te construeren. In deze bundel dienen alle certificaten van root tot het certificaat dat gebruikt is om het bovenstaande certificaat te ondertekenen, opgenomen te zijn. Een PEM-bundel bestaat uit één of meerdere certificaten in PEM-formaat onder elkaar geplaatst.

27.5. Stap 2.4 - Configuratie doorvoeren

De ingevoerde configuratie wordt nu doorgevoerd en is stapsgewijs te volgen. Indien er ergens een probleem optreedt, wordt de oude configuratie hersteld.

Indien het overdragen van sessie faalt, is de kans groot dat er een fout zit in de netwerk- en/of certificaatconfiguratie. De console van de webbrowser kan soms nuttige informatie bevatten om de oorzaak van het probleem te vinden.
Stap 2.4 - Configuratie doorvoeren
Afbeelding 160. Stap 2.4 - Configuratie doorvoeren

27.6. Stap 3 - Start Topicus KeyHub

Na het succesvol doorvoeren van de configuratie wordt Topicus KeyHub gestart. Er worden een aantal stappen uitgevoerd waarna de installatie is afgerond en Topicus KeyHub gestart kan worden. Het kan tot ongeveer 5 minuten duren om Topicus KeyHub voor de eerste keer te starten.

Topicus KeyHub genereert een herstelsleutel voor het herstellen van kluizen. Dit is bijvoorbeeld van toepassing wanneer een gebruiker zijn of haar wachtwoord is kwijtgeraakt en daardoor niet meer in de persoonlijke kluis kan. Met behulp van deze herstelsleutels kan deze toegang hersteld worden. Het downloaden van deze sleutel is een verplichte stap.

Sla deze sleutel op een veilige plek op, bijvoorbeeld op een USB-stick in een fysieke kluis. Deze sleutel kan gebruikt worden om toegang te krijgen tot alle wachtwoorden in alle kluizen van Topicus KeyHub.
Het wordt aangeraden om de herstelsleutel op twee fysieke plekken op te slaan om het risico van kwijtraken zo klein mogelijk te maken. Na verlies van de herstelsleutel is het onmogelijk om toegang tot een kluis te herstellen.
Stap 3 - Start Topicus KeyHub
Afbeelding 161. Stap 3 - Start Topicus KeyHub

27.7. Stap 4.1 - Primaire directory instellen

In deze stap wordt de primaire directory ingesteld. Dit is de directory waartegen de gebruikers van Topicus KeyHub zich zullen authenticeren. De velden die geconfigureerd dienen te worden, zijn afhankelijk van het gekozen type directory. In het geval van een LDAP of Active Directory, zie dit hoofdstuk voor een uitvoerige beschrijving van de velden. In het geval van een OIDC directory, zie dit hoofdstuk voor een uitvoerige beschrijving van de velden.

Bij het terugzetten van een back-up worden stap 4.1 en 4.2 overgeslagen en wordt in plaats daarvan de back-up hersteld.
Stap 4.1 - Primaire directory instellen
Afbeelding 162. Stap 4.1 - Primaire directory instellen

27.8. Stap 4.2 - Registreer de eerste gebruiker

De eerste gebruiker moet nu worden aangemaakt. Deze gebruiker krijgt automatisch KeyHub Administrator-rechten toegewezen. Op de pagina wordt een link getoond die naar het login-scherm van Topicus KeyHub zal navigeren. Klik op deze link of open Topicus KeyHub in een nieuw browser-venster en registreer het eerste account via de knop Registreer. Keer na het succesvol registreren van het eerste account terug naar deze Appliance Manager om naar de volgende stap door te gaan.

Stap 4.2 - Registreer de eerste gebruiker
Afbeelding 163. Stap 4.2 - Registreer de eerste gebruiker

27.9. Stap 5 - Installatie afgerond

Als alles succesvol is doorlopen en doorgevoerd, is de installatie afgerond. Er kan nu worden ingelogd op Topicus KeyHub om de applicatie verder in gebruik te nemen.

Na de installatie wordt geadviseerd om e-mail te configureren zodat Topicus KeyHub notificaties kan versturen. E-mail is ook vereist om gebruik te kunnen maken van interne directories.
Stap 5 - Installatie afgerond
Afbeelding 164. Stap 5 - Installatie afgerond

28. Configuratie

Alle instellingen die tijdens de installatie gekozen zijn, kunnen naderhand gewijzigd worden via het configuratie-menu. Gewijzigde instellingen worden niet direct doorgevoerd, maar worden klaargezet. Om deze instellingen door te voeren, dient op de knop met 'openstaande wijzigingen' (rechtsboven in het scherm) geklikt te worden. Er zal een scherm getoond worden met een overzicht van de gewijzigde instellingen.

Wijzigingen dienen te allen tijde expliciet doorgevoerd te worden.

De Configuratie-pagina toont een overzicht met alle wijzigingen die klaar staan om te worden doorgevoerd. Bepaalde wijzigingen vereisen een herstart van Topicus KeyHub. Dit wordt vermeld middels een notificatie.

Om alle wijzigingen terug te draaien en daarmee dus niet door te voeren, kan de knop Verwerpen gebruikt worden.

Voor het doorvoeren van wijzigingen is het verstandig een back-up te maken. Indien dit niet gewenst is, kan dit uitgeschakeld worden.

Wijzigingen doorvoeren
Afbeelding 165. Wijzigingen doorvoeren

28.1. Configureer de applicatie

Onder Applicatie staan mogelijkheden om wijzigingen te maken in de algemene configuratie van Topicus KeyHub.

Onderhoudsmodus

Om Topicus KeyHub in onderhoudsmodus te starten kan deze optie worden gebruikt. Indien Topicus KeyHub in onderhoudsmodus draait, kan alleen de keyhub-gebruiker inloggen in de applicatie. Hiervoor dient het onderhoudswachtwoord gebruikt te worden.

In Onderhoudsmodus kunnen normale gebruikers niet inloggen in Topicus KeyHub.
Geheugentoekenning

Verdeel het geheugen van de VM over de verschillende onderdelen. De eerste 6GB geheugen heeft een standaardverdeling die niet gewijzigd kan worden. Van al het beschikbare geheugen boven de 6GB kan 50% verdeeld worden tussen de Topicus KeyHub-applicatie en het OS en de database. Van de overgebleven 50% gaat de helft altijd naar de Topicus KeyHub-applicatie en de andere helft naar het OS en de database.

De geheugenverdeling is gelijk voor alle nodes in een cluster. Het is daarom belangrijk om alle nodes evenveel geheugen te geven. Deze verantwoordelijkheid ligt bij de beheerder.
Voorbeeld 1. Rekenvoorbeeld

De VM heeft 10.000 MB geheugen beschikbaar, dit is 10.000 - 6.000 = 4.000 MB boven de basislijn. Van deze 4.000 MB kan 2.000 MB handmatig verdeeld worden.

Als hiervan 1.500 MB wordt toegekend aan de Topicus KeyHub-applicatie en 500 MB aan het OS en de database, volgt:

  • De Topicus KeyHub-applicatie krijgt 2.048 + 4.000 * 25% + 1.500 = 4.548 MB.

  • De appliance manager krijgt altijd 512 MB.

  • Het overgebleven geheugen, 10.000 - 4.548 - 512 = 4.940 MB, gaat naar het OS en de database.

Overbelastingsbescherming

Stelt de gevoeligheid van de overbelastingsbescherming in. Hoe hoger de waarde, hoe langer het zal duren voordat de overbelastingsbescherming ingrijpt en een verzoek afbreekt. Hogere waarden vereisen meer geheugen en meer CPU-cores.

De overbelastingsbescherming beschermt de applicatie tegen verzoeken die excessief veel geheugen of CPU gebruiken. Het ophogen van de limiet zal er voor zorgen dat er bij dergelijke verzoeken later ingegrepen wordt. In het uiterste geval zouden meerdere, gelijktijdige verzoeken de applicatie uit zijn geheugen kunnen laten lopen. We bevelen aan deze waarde niet te verhogen tenzij strict noodzakelijk.
Distributiekanaal

Het distributiekanaal kan gewijzigd worden naar een andere waarde dan de laatste stabiele versie. Alternatieven voor het kanaal zijn acceptance en development. Let er hierbij op, dat andere waarden niet ondersteund worden door de leverancier en gebruik hiervan op eigen risico is.

Stop bij verlies van quorum

Stop de applicatie op nodes die geen deel zijn van het quorum binnen het cluster. Topicus KeyHub leest periodiek de status van Pgpool uit. Als Pgpool het quorum verliest en de node draait de primaire database, zullen alle services op de node gestopt worden. Hiermee wordt mogelijke datacorruptie voorkomen in het geval van een split-brain situatie. Echter, als de node de enige nog draaiende node was in het cluster, zal deze actie het cluster onbereikbaar maken.

Bedrijfsrepository

Indien er binnen het bedrijf een eigen RPM-repository gebruikt wordt, kan deze hier opgegeven worden. Deze repository kan gebruikt worden als mirror van upstream repositories voor het binnenhalen van systeemupdates in offline-modus of voor het aanbieden van eigen packages.

Configureer de applicatie
Afbeelding 166. Configureer de applicatie

28.2. Configureer de tijd

Deze stap is analoog aan de configuratie van de tijd zoals beschreven in het hoofdstuk tijd bij installatie.

Configureer de tijd
Afbeelding 167. Configureer de tijd

28.3. Configureer het netwerk

Deze stap is analoog aan de configuratie van de netwerkparameters tijdens installatie. Raadpleeg het betreffende hoofdstuk voor een beschrijving van de verschillende velden.

Configureer het network
Afbeelding 168. Configureer het netwerk

28.4. Configureer de firewall

Via de optie Firewall kan de firewall van de Topicus KeyHub-appliance geconfigureerd worden. De firewall omvat 3 zones: management, monitoring en backup. Elke zone kan bepaalde TCP- en UDP-poorten beschikbaar maken voor een lijst met IP-bereiken.

Een verkeerde configuratie voor de management-zone kan het onmogelijk maken om nog verbinding te maken met Management Console en SSH, waarmee het onmogelijk wordt de configuratie weer terug te draaien. Het is daarom aan te raden om altijd een snapshot te maken van de VM voor het doorvoeren van wijzigingen in deze zone.
IP whitelist voor firewall voor management

Geef eventuele ip-adressen op voor whitelisting in de firewall voor de management-zone. De Management Console van Topicus KeyHub (poort 50443) en SSH (poort 50022) zijn alleen toegankelijk vanaf IP-adressen in deze whitelist. Ook de interne LDAP (poort 389) valt onder de management-zone.

Beschikbare TCP-poorten voor management

Deze TCP-poorten zullen opengezet worden voor de hierboven gegeven IP-bereiken. Meerdere poorten dienen gescheiden te worden met komma’s. Poort 50443 (Management Console), poort 50022 (SSH) en poort 389 (interne LDAP) vallen onder de management-zone.

Beschikbare UDP-poorten voor management

Deze UDP-poorten zullen opengezet worden voor de hierboven gegeven IP-bereiken. Meerdere poorten dienen gescheiden te worden met komma’s.

IP whitelist voor firewall voor monitoring

De monitoring-poorten zijn alleen benaderbaar vanaf IP-adressen in de hier aangeven bereiken. De monitoring-zone bevat altijd poort 9443.

Beschikbare TCP-poorten voor monitoring

Deze TCP-poorten zullen opengezet worden voor de hierboven gegeven IP-bereiken. Meerdere poorten dienen gescheiden te worden met komma’s. Poort 9443, voor de metrics- en health-endpoints valt onder de monitoring-zone.

Beschikbare UDP-poorten voor monitoring

Deze UDP-poorten zullen opengezet worden voor de hierboven gegeven IP-bereiken. Meerdere poorten dienen gescheiden te worden met komma’s. Om SNMP beschikbaar te maken, dient poort 161 hier opgenomen te worden.

IP whitelist voor firewall voor back-up

De back-up-poorten zijn alleen benaderbaar vanaf IP-adressen in de hier aangegeven bereiken. Deze zone kan gebruikt worden om een lokale backup-agent toegankelijk te maken.

Beschikbare TCP-poorten voor back-up

Deze TCP-poorten zullen opengezet worden voor de hierboven gegeven IP-bereiken. Meerdere poorten dienen gescheiden te worden met komma’s.

Beschikbare UDP-poorten voor back-up

Deze UDP-poorten zullen opengezet worden voor de hierboven gegeven IP-bereiken. Meerdere poorten dienen gescheiden te worden met komma’s.

Configureer de firewall
Afbeelding 169. Configureer de firewall

28.5. Configureer de e-mailaflevering

Topicus KeyHub vereist een werkende e-mailconfiguratie voor het registreren van accounts en voor notificaties. Hiervoor dient de SMTP-server, inclusief eventuele credentials, ingevoerd te worden. Om de ingevoerde configuratie te testen, wordt een testbericht gestuurd op het moment dat de configuratie wordt doorgevoerd. Deze test-e-mail kan ook gestuurd worden door op de betreffende knop te klikken.

De knop voor het versturen van een test-e-mail gebruikt de actuele configuratie. Als er nog wijzigingen open staan, dienen deze eerst doorgevoerd te worden.
E-mailserver

Het adres van de e-mailserver die gebruikt gaat worden voor het versturen van e-mails vanuit Topicus KeyHub.

Versleuteling

Geeft aan of en op welke manier de verbinding met de SMTP-server versleuteld moet worden.

Gebruikersnaam

Indien er authenticatie noodzakelijk is voor het verbinden met de e-mailserver, kan hier de gebruikersnaam worden ingevoerd.

Wachtwoord

Indien er authenticatie noodzakelijk is voor het verbinden met de e-mailserver, kan hier het wachtwoord worden ingevoerd.

Administrator e-mailadres

Vul hier het e-mailadres van de administrator van Topicus KeyHub in. Dit e-mailadres wordt gebruikt als ingelogd wordt met het onderhoudsaccount.

Afzenderadres voor e-mail

Vul hier het e-mailadres in dat de appliance manager moet gebruiken om vanuit te mailen. Enkel de appliance manager maakt gebruik van dit e-mailadres. Het adres van e-mails van Topicus KeyHub zelf wordt ingesteld bij de algemen instellingen.

Aanvullende Postfix-configuratie

Geef extra configuratie op die letterlijk wordt doorgegeven aan Postfix. Deze parameters moeten de vorm key = value hebben, met één sleutel/waarde-paar per regel. De parameters worden als laatste toegepast en overschrijven andere ingestelde parameters. Raadpleeg de Postfix-configuratiedocumentatie voor informatie over de beschikbare parameters.

Configureer de e-mailaflevering
Afbeelding 170. Configureer de e-mailaflevering

28.6. Configureer de certificaten

Deze stap is grotendeels analoog aan de configuratie van het certificaat tijdens installatie. Raadpleeg het betreffende hoofdstuk voor een beschrijving van de verschillende velden.

IdP signing-certificaat

Dit certificaat wordt door Topicus KeyHub gebruikt voor het ondertekenen van OAuth2 access tokens, OpenID Connect ID tokens en SAML assertions. Topicus KeyHub genereert automatisch een certificaat dat 5 jaar geldig is. Het certificaat kan vervangen worden door op 'Opnieuw genereren' te klikken.

Bij het verversen van het Idp signing-certificaat zullen alle gebruikers uitgelogd worden. Ook verliezen alle access tokens hun geldigheid en kunnen single sign-on-koppelingen stoppen met werken. Bij sommige diensten zal het nodig zijn om het nieuwe certificaat handmatig opnieuw op te voeren.
Configureer het certificaat
Afbeelding 171. Configureer het certificaat

28.7. Configureer monitoring

Onder Monitoring staan opties voor het inschakelen en configureren van OTLP en SNMP. De Topicus KeyHub appliance ondersteunt het aanleveren van metrics via OTLP of deze kunnen uitgelezen worden op het OpenMetrics-endpoint. Daarnaast ondersteunt de appliance zowel SNMP v2c als SNMP v3 voor basale systeeminformatie van de VM. Het gebruik van OTLP of het OpenMetrics-endpoint heeft de voorkeur, aangezien deze meer informatie leveren.

De volgende opties zijn beschikbaar voor OTLP:

OTLP inschakelen

Stuur monitoringinformatie en statistieken via OTLP naar het onderstaande endpoint.

OTLP-endpoint

Het OTLP-endpoint waarnaar de statistieken moeten worden verzonden.

TLS

Beveilig de verbinding met TLS, optioneel met een clientcertificaat.

Certificaatautoriteit(en)

Geef een PEM-bundel met alle certificaten die nodig zijn om een volledige certificaatketen te construeren van root tot het uiteindelijke certificaat.

Clientcertificaat

Het certificaat dat KeyHub gebruikt om zich bij de OTLP-server te authenticeren.

De volgende opties zijn beschikbaar voor SNMP:

SNMP v2c inschakelen

Maak monitoring-informatie beschikbaar via SNMP v2c.

V2c is niet versleuteld en de community string biedt slechts zeer beperkte bescherming.
SNMP v2c community

De community string waaronder de informatie beschikbaar gemaakt wordt. Deze waarde zal in het monitoring-systeem ingevoerd moeten worden om de informatie uit te kunnen lezen.

SNMP v3 inschakelen

Maak monitoring-informatie beschikbaar via SNMP v3. Authenticatie is beveiligd met SHA en het verkeer is versleuteld met AES.

SNMP v3 gebruikersnaam

De gebruikersnaam waarmee ingelogd moet worden om de informatie uit te lezen.

SNMP v3-wachtwoord

Het wachtwoord bij de bovengenoemde gebruikersnaam waarmee ingelogd moet worden om de informatie uit te lezen.

SNMP v3-privacywachtwoord

Het wachtwoord waarmee de data versleuteld wordt. Als dit leeggelaten wordt, is dit gelijk aan het gebruikerswachtwoord.

Configureer monitoring
Afbeelding 172. Configureer monitoring

28.7.1. Metrics- en health-endpoints

De Topicus KeyHub-appliance biedt een aantal endpoints met informatie over de status van de applicatie:

https://keyhub-node-x.local:9443/metrics

Het OpenMetrics endpoint geeft metrics van onder andere CPU en geheugengebruik van KeyHub in het OpenMetrics formaat.

https://keyhub-node-x.local:9443/health/live

Geeft aan of de node correct draait.

https://keyhub-node-x.local:9443/health/ready

Geeft aan of de node in staat is om verkeer af te handelen.

Poort 9443 is alleen bereikbaar voor IP-adressen in de IP whitelist van de monitoring-zone.

28.8. Configureer back-ups

Via de optie Back-ups kan aangegeven worden hoe de Topicus KeyHub-appliance in combinatie met een back-up-oplossing moet werken. Hierbij gaat het puur om het toegankelijk maken van de back-ups. Het daadwerkelijk maken van back-ups kan handmatig of automatisch. Back-ups worden geplaatst in de directory /data/tkh/backup. Het is mogelijk om deze back-ups via scp, sftp of rsync te downloaden via de gebruiker keyhub-backup. Een andere mogelijkheid is het gebruiken van een specialistische back-up-agent die op het systeem geïnstalleerd dient te worden.

Het is mogelijk om wijzigingen aan het OS van de Topicus KeyHub-appliance aan te brengen die interfereren met de correcte werking en/of beveiliging van Topicus KeyHub. Het aanbrengen van dergelijke wijzigingen, zoals het installeren van extra packages, geschiedt geheel op eigen risico.
Back-up-retentie

Het aantal back-ups dat bewaard moet worden voordat de oudste back-up verwijderd wordt. Het vasthouden van teveel back-ups kan zorgen dat de schijf van de Topicus KeyHub-appliance volloopt.

Versleutelde back-ups

Versleutel de inhoud van de back-ups.

Zorg dat de back-up-decoderingssleutel op een veilige plek wordt opgeslagen. Zonder deze sleutel is het niet mogelijk om een back-up te herstellen.
Back-up-gebruiker aanmaken

Maak een gebruiker met de naam keyhub-backup.

Protocollen zoals scp, sftp en rsync lopen via ssh over poort 50022. De firewall-configuratie voor deze poort dient ingesteld te worden bij de netwerkconfiguratie.
Wachtwoord back-up-gebruiker

Het wachtwoord voor de gebruiker met de naam keyhub-backup. Er wordt een suggestie getoond voor een voldoende sterk wachtwoord. Het is ook mogelijk een ander wachtwoord te kiezen.

SSH-key voor Back-up-gebruiker

Een optionele SSH-public-key voor de back-up-gebruiker. Wanneer deze gegeven wordt, kan keyhub-backup inloggen met deze sleutel, zonder wachtwoord.

Configureer back-ups
Afbeelding 173. Configureer back-ups

28.9. Configureer log forwarding

Via de optie Logging kan aangegeven worden hoe de Topicus KeyHub-appliance de logs moet forwarden naar een externe logserver. Hierbij gaat het om de logs van het systeem, evenals de logs van de Wildfly-containers. Deze logs zullen worden gestreamd over TCP naar de server en poort zoals geconfigureerd. Het gebruikte formaat is RFC5424 met octet-counted framing. Het is mogelijk om deze TCP verbinding met TLS te beveiligen. Indien gebruik wordt gemaakt van mTLS dienen zowel server als client certificaat door dezelfde CA gesigned te zijn.

De logs zullen ook beschikbaar blijven op het log volume.

Stuur logs naar remote server

Indien ingeschakeld, worden de logs direct doorgestuurd naar een ander systeem.

Serveradres

Het adres van de server waar de logs afgeleverd moeten worden.

Server port

De TCP-poort waarop de logs afgeleverd moeten worden. Poort 1468 is een veelgebruikte poort voor syslog.

Template

Stel een alternatief template aan voor het formaat van de berichten van de syslog. Standaard wordt het template RSYSLOG_SyslogProtocol23Format gebruikt. Raadpleeg de handleiding van RSyslog voor beschikbare templates.

TLS

Beveilig de verbinding met TLS, optioneel met een clientcertificaat.

Certificaatautoriteit(en)

Geef een PEM-bundel met alle certificaten die nodig zijn om een volledige certificaatketen te construeren van root tot het uiteindelijke certificaat. Deze keten moet gebruikt worden voor zowel het certificaat van de log server als, indien van toepassing, het clientcertificaat.

Clientcertificaat

Het certificaat dat KeyHub gebruikt om zich bij de logserver te authenticeren.

Configureer log forwarding
Afbeelding 174. Configureer logging

28.10. Configureer authenticatie

28.10.1. De authenticatiegegevens voor onderhoud wijzigen

Hier kan het onderhoudswachtwoord gewijzigd worden. Dit wachtwoord wordt gebruikt om in te loggen op de onderhoudsapplicatie van Topicus KeyHub. Kies hiervoor een sterk wachtwoord en sla deze op een veilige locatie op, bijvoorbeeld op twee USB-sticks die in een fysieke kluis geplaatst worden. Voor inloggen via SSH kan een public key ingesteld worden.

Configureer het onderhoudswachtwoord
Afbeelding 175. Configureer het onderhoudswachtwoord

28.10.2. Configureer SSO met Topicus KeyHub

De appliancemanager ondersteunt authenticatie met Single Sign-on met Topicus KeyHub. Dit maakt aanmelden met een enkele klik mogelijk. Standaard is de Appliance manager-applicatie niet gekoppeld aan een groep in Topicus KeyHub, dit is wel vereist is voor SSO. Een gebruiker met lidmaatschap van de groep 'KeyHub Administrator' kan via het menu item 'Beheer toegang' deze applicatie koppelen. Open hier de 'KeyHub Appliance Manager', die is te vinden bij de groep 'KeyHub Administrator'. Voeg een groep toe onder het gedeelte 'Groepen' van deze applicatie. Alle gebruikers in deze groep hebben nu via Single Sign-on toegang tot de Topicus KeyHub Appliance Manager.

29. Uitrol

Bij Uitrol wordt inzicht gegeven over het gebruik van de virtuele machine(s) waar Topicus KeyHub op draait. Zo is het mogelijk om het schijfgebruik in te zien en indien nodig extra ruimte toe te kennen. Ook de inregeling van een cluster voor hoge beschikbaarheid behoort tot de mogelijkheden.

29.1. Schijfbeheer

Standaard wordt de Topicus KeyHub virtual appliance geleverd met een schijf van 80GiB. Deze schijf is ingedeeld in 6 delen:

/ (root)

Het root-bestandssysteem van 24GiB. Dit bevat het OS, de databestanden van Topicus KeyHub en de backups.

/var/log

Het log-bestandssysteem van 15GiB. Hierin wordt de logging weggeschreven van het OS en de verschillende onderdelen van Topicus KeyHub.

/var/lib/docker

Het docker-bestandssysteem van 24GiB. Hierin bevinden zich alle docker images, tijdelijke volumes en andere data die door docker gebruikt wordt.

swap

De swap-partitie van 2GiB.

/boot

De boot-partitie van 2GiB.

Gereserveerde ruimte

De overige ruimte, ongeveer 12GiB, is gereserveerd voor snapshots die gemaakt worden tijdens een update.

Schijfbeheer
Afbeelding 176. Schijfbeheer

Bij langdurig gebruik van Topicus KeyHub of bij grotere organisaties kan het zijn dat de standaard schijfgrootte niet toereikend is. Vooral de database en de backups kunnen flink toenemen in omvang, waardoor het root-bestandssysteem vol kan lopen. Via schijfbeheer is het mogelijk om extra ruimte toe te kennen aan Topicus KeyHub. Vergroot hiervoor eerst de schijf via de gebruikte virtualisatie-omgeving. In sommige omgevingen kan dit zonder de VM af te sluiten. Klik in dat geval op Schijf herscannen na het vergroten van de schijf om Topicus KeyHub op de hoogte te brengen van de gewijzigde grootte. De niet toegewezen ruimte zal getoond worden in de onderste rij van de tabel.

Om niet toegewezen ruimte toe te kennen aan een volume, klik op Schijfruimte toekennen. Ruimte kan toegekend worden aan /, /var/log, /var/lib/docker en de gereserveerde ruimte. In de meeste gevallen zal de ruimte toegekend worden aan / en in sommige vallen aan /var/log. Ruimte toekennen aan /var/lib/docker is onder normale condities niet nodig. Aangezien de gereserveerde ruimte tijdens updaten gebruikt wordt voor het bijhouden van een snapshot van / en /var/lib/docker is het aan te raden een deel van de ruimte hieraan toe te kennen. Standaard zal 80% van de beschikbare ruimte aan / toegekend worden en 20% aan de gereserveerde ruimte. Verdeel alle beschikbare ruimte naar wens over de volumes en klik op Toekennen.

Maak altijd een snapshot van de VM voor de schijfruimte toe te kennen. Het snapshotting-systeem van de Topicus KeyHub appliance is niet in staat te herstellen van een fout tijdens het toekennen van schijfruimte.
Alle beschikbare ruimte dient in één keer toegekend te worden. Hiet is niet mogelijk om een deel van de beschikbare ruimte onbenut te laten.
Schijfruimte toekennen
Afbeelding 177. Schijfruimte toekennen

29.2. Replicatie

Om KeyHub in een cluster te draaien moeten de netwerk instellingen op static staan. Nodes die van ip-adres veranderen breken het cluster. DHCP wordt daarom niet ondersteund voor een cluster-opstelling. Dit houdt ook in dat een cluster draaien op Azure op het moment niet ondersteund wordt.

Topicus KeyHub kan in een cluster draaien voor hoge beschikbaarheid. Voor de hoogste betrouwbaarheid dient dit cluster te bestaan uit een oneven aantal nodes met een minimum van 3. Alle nodes in het cluster zijn gelijkwaardig. Dat wil zeggen dat alle nodes requests van alle gebruikers af kunnen handelen en alle nodes verbinding moeten hebben met dezelfde services zoals Active Directories en LDAP-servers. De nodes communiceren onderling over 2 poorten. Beide poorten moeten voor alle nodes bereikbaar zijn vanaf alle andere nodes in het netwerk.

50022/tcp (ssh)

Voor het uitwisselen van configuratie en het uitvoeren van remote administration commando’s.

51871/udp (wireguard)

Voor een beveiligd overlay network waarover de cluster nodes onderling communiceren.

Om het verkeer te verdelen over de nodes in het cluster dient een load balancer opgezet te worden. Topicus KeyHub draait hiermee in een geproxyde opstelling. De load balancer kan het health endpoint van een node gebruiken om te bepalen of de node in staat is verkeer af te handelen.

Aangezien elke node op een eigen interne host draait, heeft elke node een eigen certificaat nodig. De certificaten voor de verschillende hosts dienen allemaal uitgegeven te zijn door de dezelfde CA. Het is niet mogelijk om een cluster te draaien met self-signed certificaten.

29.2.1. Een cluster opzetten

Om een cluster op te zetten dient eerst een nieuwe VM geïmporteerd te worden. Deze VM moet exact dezelfde versie draaien als de VM die momenteel de clustercoordinator is. Indien de huidige VM niet de laatste versie van Topicus KeyHub draait, is het verstandig om eerst te upgraden alvorens de clusterconfiguratie te starten. Voor de nieuwe VM is ook een certificaat nodig, dienen de netwerkinstelling bekend te zijn en dient de DNS ingeregeld te zijn.

Het toevoegen van een nieuwe node vereist dat alle huidige nodes in het cluster herstarten. Dit zal een onderbreking geven van de dienstverlening.

Kies op het clusteroverzicht Wijzigen en daarna Toevoegen.

Welkom bij de cluster-wizard
Afbeelding 178. Welkom bij de cluster-wizard

Bij het tot stand brengen van de link worden de sleutels uitgewisseld tussen de huidige en de nieuwe VM.

Stap 1 - Link tot stand brengen
Afbeelding 179. Stap 1 - Link tot stand brengen

Vul hiervoor de volgende gegevens in:

IP-adres

Dit is het huidige IP-adres van de VM. Dit mag een IP-adres zijn dat automatisch via DHCP is toegekend aan de machine. Het huidige IP-adres is te vinden op de console van de VM.

Wachtwoord

Het wachtwoord dat aan deze VM is toegekend. Dit wachtwoord is een 6-cijferige code die getoond wordt op de console van de VM.

Tijdens de setup wordt éénmalig via SSH inlogd met wachtwoordauthenticatie. Deze optie dient tijdelijk ingeschakeld te worden op de nieuwe node door op de terminal op 'P' te duwen. Uiteindelijk krijgt de nieuwe node dezelfde configuratie als de clustercoordinator.
Stap 2.1 - Configureer netwerkparameters

Stel de netwerkparameters in voor de nieuwe VM. Raadpleeg betreffende hoofdstuk uit de installatiehandleiding voor een beschrijving van de verschillende velden. Bij een cluster-opstelling is het niet mogelijk om te kiezen voor DHCP voor de netwerkconfiguratie.

Stap 2.1 - Configureer netwerkparameters
Afbeelding 180. Stap 2.1 - Configureer netwerkparameters
Stap 2.2 - Configureer servercertificaten

Geef het servercertificaat op voor de nieuwe VM. Raadpleeg betreffende hoofdstuk uit de installatiehandleiding voor een beschrijving van de verschillende velden.

Stap 2.2 - Configureer servercertificaten
Afbeelding 181. Stap 2.2 - Configureer servercertificaten
Stap 2.3 - Configuratie doorvoeren

Voer de configuratie voor de nieuwe VM door. Zodra de configuratie is doorgevoerd zullen een aantal tests uitgevoerd worden om de connectiviteit tussen de machines te testen.

Stap 2.3 - Configuratie doorvoeren
Afbeelding 182. Stap 2.3 - Configuratie doorvoeren
Step 3 - Replicatie starten

Configureer alle huidige nodes van het cluster om de nieuwe node op te nemen en start de replicatie. Bij deze stap zullen alle nodes in het huidige cluster herstart worden om de nieuwe configuratie te laden.

Stap 3 - Replicatie starten
Afbeelding 183. Stap 3 - Replicatie starten

29.2.2. Clusteroverzicht

In het clusteroverzicht worden alle nodes getoond en wordt algemene informatie over het cluster weergegeven. Indien er een probleem geconstateerd wordt met één van de nodes zal dat ook weergegeven worden. Er kan doorgeklikt worden op een node om meer details over die node in te zien.

Clusteroverzicht
Afbeelding 184. Clusteroverzicht

29.2.3. Cluster aanpassen

Wijzigingen in het cluster kunnen gemaakt worden door op het clusteroverzicht op Wijzigen te klikken. Naast het toevoegen en verwijderen van nodes is het ook mogelijk nodes tijdelijk uit te schakelen of onbeschikbaar te maken. Het uitschakelen van nodes kan gebruikt worden om een quorum te herstellen in een cluster waar een deel van de nodes is uitgevallen. Een node die niet beschikbaar is, zal blijven draaien maar aan de load balancer melden dat hij niet beschikbaar is.

De gebruiker dient zelf zorg te dragen dat de uitgeschakelde nodes niet meer actief zijn. Indien de uitgeschakelde nodes niet buiten gebruik worden genomen, bestaat de mogelijkheid dat er meerdere primaire databases actief zijn binnen het cluster. De gespleten tijdslijn die op deze manier ontstaat is later niet meer terug te brengen tot een enkele tijdslijn zonder verlies van data.

Nodes die tijdelijk buiten gebruik genomen zijn, kunnen later weer geactiveerd worden. Het kan zijn dat na heractivatie de database op sommige nodes niet de juiste status krijgt. Volg de instructies in de interface om het cluster weer in een gezonde toestand te krijgen.

Het (de)activeren van nodes vereist dat alle overige nodes in het cluster herstarten. Dit zal een onderbreking geven van de dienstverlening. Het aanpassen van de beschikbaarheid kan zonder onderbreking uitgevoerd worden.
Cluster aanpassen
Afbeelding 185. Cluster aanpassen

29.2.4. Nodedetails

Bij de nodedetails wordt gedetaileerde informatie over een node in het cluster weergegeven. De informatie is opgesplits in 3 secties: algemene informatie, informatie over Pgpool en informatie over de database.

Nodedetails
Afbeelding 186. Nodedetails

De algemene informatie bestaat uit de volgende velden:

Identifier

De code waarmee de node binnen het cluster bekend is. Deze code wordt automatisch gegenereerd bij het importeren van een VM en is niet aan te passen.

Extern IP-adres

Het externe IP-adres van de VM. Dit is het IP-adres waarmee de VMs onderling communiceren.

Clusterlink-adres

Het interne IP-adres van de VM binnen het beveiligde overlay netwerk. Tussen de nodes in een cluster wordt een beveiligd Wireguard overlay netwerk opgezet. Replicatie van de database en de clustering van Pgpool en WildFly loopt via dit netwerk. Elke node krijgt een eigen IP-adres binnen dit netwerk.

Clusterlink-adres bereikbaar

Geeft aan het of het clusterlink-adres van de node bereikbaar is vanaf de clustercoordinator. Indien dit adres niet bereikbaar is, zal de node niet deel kunnen nemen aan het cluster. Zie het hoofdstuk over problemen herstellen voor meer informatie.

Topicus KeyHub-versie

De versie van Topicus KeyHub op deze node.

Applicatiestatus

Geeft aan of de Topicus KeyHub-applicatie op deze node bereikbaar is. Beschikbaar betekent dat de applicatie draait en technisch in staat is om requests af te handelen.

Beschikbaarheid

Geeft aan of de Topicus KeyHub-applicatie beschikbaar is binnen de load balancer.

Voor Pgpool worden de volgende velden getoond:

Naam

De interne naam van de Pgpool instantie op deze node.

Status

De huidige status van de Pgpool watchdog op deze node. Normaal gesproken zal dit Leader of Standby zijn. Raadpleeg de documentatie van Pgpool voor een uitleg van alle statussen.

De informatie over de PostgreSQL database bestaat uit de volgende velden:

Status

De status van de database backend zoals gerapporteerd door de Pgpool watchdog leader. Normaal gesproken zal dit Up of Waiting zijn.

Rol

Primary of standby.

Primaire database

Indien deze node een standby database draait, wordt hier het clusterlink-adres getoond van de primary database.

Replicatievertraging

Indien deze node een standby database draait, het verschil in PostgreSQL’s log sequence number tussen de primary en deze standby node.

Replicatiestatus

Indien deze node een standby database draait, de status van de replicatie. Dit zou altijd streaming / async moeten zijn.

Laatste statuswijziging

Het moment van de laatste statuswijziging van deze PostgreSQL backend.

Eerste auditrecord op

De timestamp van het eerste auditrecord in de database op deze node.

Laaste auditrecord op

De timestamp van het laatste auditrecord in de database op deze node.

Databasegrootte

De grootte van de PostgreSQL-database op deze node.

29.2.5. Herstellen van problemen

De Topicus KeyHub appliance probeert het cluster in een consistente status te houden. Soms kan het echter gebeuren dat er een storing op of tussen de nodes optreedt. In veel gevallen kan het cluster automatisch herstellen van een dergelijke storing. Echter, in sommige gevallen is het vereist om handmatig herstelacties uit te voeren.

Clusterlink onbereikbaar

Het clusterlink-adres van de node is niet bereikbaar. Dit kan een breed scala aan oorzaken hebben. Het kan zijn dat de node zelf offline is, de netwerkverbinding met de node weggevallen is of dat netwerkverkeer geblokkeerd wordt. Het is niet mogelijk om deze conditie automatisch te herstellen. Controlleer de status van de VM en de netwerkverbindingen. Zodra de node weer bereikbaar is, zal dit getoond worden.

Geen primaire database

Er is geen primaire database in het cluster. Dit kan veroorzaakt worden door het wegvallen van de primaire database op een moment dat het Pgpool cluster geen quorum had. Probeer eerst om de oorzaak van de storing te verhelpen door de node die de primaire database draaide te herstellen. Lukt dit niet, dan kan gekozen worden om een standby node to promoveren tot primair. Let op dat als deze node achterliep in zijn replicatie, hierbij gegevens verloren kunnen gaan. Om promotie te forceren, open de betreffende node en klik op de knop Promotie forceren.

Meerdere primaire databases

Er zijn meerdere primaire databases in het cluster. Dit kan optreden als de node met de primaire database wegvalt, er een nieuwe primaire database gekozen wordt en de oorspronkelijke node opnieuw het cluster betreedt. Hoewel Pgpool deze situatie probeert te voorkomen, is dit niet altijd mogelijk. Voor herstel zal gekozen moeten worden welke database verwijderd wordt. Ga naar de node die onterecht primair is en klik op de knop Herstel database. De database op de node zal gewist en hersteld worden vanaf een andere primaire database. Indien er meer dan 2 primaire databases zijn, zal dit voor alle nodes behalve de echte primaire database uitgevoerd moeten worden. Zie Een database herstellen voor meer informatie over het oplossen van dit probleem.

Database offline

De database op de node is niet bereikbaar. Er is waarschijnlijk iets mis gegaan met de database op de betreffende node tijdens een failover of uitval. Klik op de knop Herstel database om de database te herinitialiseren. De database op de node zal gewist en hersteld worden vanaf de primaire database. Zie Een database herstellen voor meer informatie over het oplossen van dit probleem.

Database inconsistent

De replicatie op de node werkt niet. De replicatievertraging zal een getal groter dan 0 tonen. Mogelijk is er een netwerkstoring (geweest) tussen de node en de primaire database. Controlleer of er op het moment geen problemen zijn met de verbinding tussen de nodes. Bij een tijdelijke storing zal de replicatie automatisch herstellen en de replicatievertraging teruglopen naar 0. Indien de replicatie niet hervat en er geen storing (meer) is in het netwerk kan gekozen worden de database herstellen. Klik op de knop Herstel database om de database te herinitialiseren. De database op de node zal gewist en hersteld worden vanaf de primaire database. Zie Een database herstellen voor meer informatie over het oplossen van dit probleem.

Verkeerde primary

De database op de node is standby maar volgt niet de primaire database van het cluster. Dit kan optreden als er een failover plaatsgevonden heeft op het moment dat deze node offline was. Hierbij is het cluster overgestapt op een andere primaire database en is deze node niet op de hoogte van de wijziging. Klik op de knop Herstel database om de database te herinitialiseren. De database op de node zal gewist en hersteld worden vanaf de primaire database. Zie Een database herstellen voor meer informatie over het oplossen van dit probleem.

Pgpool offline

Pgpool draait niet op de node. Bij grotere netwerkproblemen binnen het cluster kan het soms gebeuren dat Pgpool niet wil starten. Klik op de knop Herstel Pgpool om Pgpool te herstarten. Om te zorgen dat Pgpool het cluster goed vormt, kan het zijn dat er meerdere Pgpool nodes herstart worden. Dit kan een korte onderbreking van de beschikbaarheid van Topicus KeyHub veroorzaken. Als Pgpool op de clustercoordinator offline is, zal het hele clusteroverzicht geen data tonen. Open in dat geval de node die clustercoodinator is en herstel daar Pgpool.

29.2.6. Een database herstellen

Als er een probleem is met de database op één van de nodes, kan deze hersteld worden. Bij het herstellen van een database zal deze gewist worden van de node en daarna opnieuw geïnitialiseerd vanaf de primaire database. In het geval van een (hardware) storing op de specifieke node of een communicatieprobleem met de node, zal deze actie veilig uitgevoerd kunnen worden. In deze situaties zal de database achter lopen op de rest van het cluster. Bij complexere problemen, zoals een splitsing in het netwerk, kan het zijn dat de node data bevat die niet in de primaire database staat. Herstel in een dergelijke situatie kan leiden tot onherstelbaar gegevensverlies.

Na het klikken op Herstel database zal het scherm getoond worden voor het herstellen van een database. Hier worden bovenaan gegevens getoond van de huidige primaire database en onderaan gegevens van de database die overschreven gaat worden. Indien een afwijking gevonden wordt tussen deze gegevens die niet logisch te verklaren valt uit het achterlopen van de database, wordt een waarschuwing getoond.

Controleer altijd goed of de getoonde gegevens logisch zijn voor de database te herstellen. Het herstellen van een database zal alle gegevens in overschreven database onherstelbaar verwijderen.

Voordat de database overschreven wordt, zal geprobeerd worden een backup te maken van de data in deze database. Deze backup wordt weggeschreven in /data/tkh/backup op de betreffende node.

Aangezien er een probleem is met de database die overschreven gaat worden, kunnen er geen garanties gegeven worden over de inhoud van de backup. Als de database server niet draait of de data-directory corrupt is, zal de backup leeg zijn.
Een database herstellen
Afbeelding 187. Een database herstellen

29.2.7. Een node verwijderen

Open de nodedetails en klik op verwijderen om een node te verwijderen uit het cluster. De node hoeft niet online te zijn om verwijderd te worden. Als de node nog wel actief is, zal deze eerst afgesloten worden. Het verwijderen van een node vereist dat alle services op de andere nodes herstarten.

Een node verwijderen
Afbeelding 188. Een node verwijderen

29.2.8. De clustercoordinator

De eerste node in het cluster krijgt de rol van clustercoordinator. Configuratiewijzigingen, beheer van het cluster en beheer van de cron-taken worden gedaan op de clustercoordinator. Deze node zal ook de instelde taken draaien. Back-ups zullen dus gemaakt worden op de clustercoordinator. Het is mogelijk om de rol van clustercoordinator over te dragen naar een andere node in het cluster. Log hiervoor in op de appliance manager op de specifieke node. De hieronder getoonde melding zal zichtbaar zijn. Klik op Opwaarderen tot clustercoordinator om de rol van clustercoordinator over te dragen naar deze node.

Clustercoordinator
Afbeelding 189. Clustercoordinator

30. Updates, Back-ups en Ondersteuning

30.1. Dashboard

Het dashboard toont in één oogopslag de status van de Topicus KeyHub appliance. Deze pagina toont de huidige versie van Topicus KeyHub, het aantal beschikbare systeemupdates en de instellingen voor updates en back-ups. Topicus KeyHub controleert niet automatisch of er nieuwe updates beschikbaar zijn als dit niet ingesteld is. Om handmatig te controleren of er beschikbare updates zijn, is de knop Controleer nu te gebruiken.

Als er updates beschikbaar zijn voor Topicus KeyHub, wordt dit getoond bij de huidige versie.

Voor het installeren van systeem- en/of Topicus KeyHub-updates wordt altijd eerst een back-up gemaakt. Ook wordt een tijdelijke snapshot van het systeem gemaakt, welke automatisch teruggezet wordt als een fout gedetecteerd wordt.
Appliance-dashboard
Afbeelding 190. Appliance-dashboard

30.2. Cron-taken

Topicus KeyHub kan automatisch back-ups maken en/of updates installeren. De schema’s voor deze taken worden opgegeven in het zogenaamde cron-formaat. Dit formaat bestaat uit 5 velden, gescheiden door spaties. Deze velden vertegenwoordigen, in volgorde: minuut (0-59) uur (0-23) dag-van-maand (1-31) maand (1-12) en dag-van-week (0-7, 0 en 7 staan voor zondag). Een bereik wordt opgegeven met n-m of voor het volledige bereik. Een bereik kan beperkt worden met een interval d.m.v. /x, bijv. /5 voor elke 5 minuten. Meerdere waarden en/of bereiken kunnen gecombineerd worden met komma’s.

Bij de automatische updates is het naast in- en uitschakelen mogelijk om enkele opties aan te geven:

Systeemupdates

Installeer systeemupdates van het onderliggende OS. Het wordt zeer aanbevolen om dit tenminste éénmaal per week te doen.

Topicus KeyHub-updates

Installeer automatisch Topicus KeyHub-updates uit het ingestelde distributiekanaal. Tijdens een update zal Topicus KeyHub enige tijd onbereikbaar zijn. Deze updates dienen daarvoor ingeplanned te worden tijdens een gepast service window.

Herstart

Bij sommige updates, zoals een nieuwe versie van de kernel, is het vereist om het systeem te herstarten om de update af te ronden. Door het aanvinken van deze optie zal het systeem automatisch herstarten na het installeren van updates indien vereist. Logischerwijs zal Topicus KeyHub tijdens een herstart tijdelijk onbereikbaar zijn.

Cron-taken
Afbeelding 191. Cron-taken

30.3. Back-ups

Deze pagina toont een overzicht van de gemaakte back-ups. Van iedere back-up wordt de naam en grootte getoond. Indien een back-up teruggezet dient te worden die niet in de lijst van back-ups getoond wordt, kan de back-up handmatig geüpload worden via de knop Upload. Ook is het mogelijk een nieuwe back-up te maken via de knop Aanmaken. Door op de naam van de back-up te klikken kan deze worden gedownload.

Back-ups
Afbeelding 192. Back-ups

Gedetaileerde informatie, waaronder de bijbehorende versie van Topicus KeyHub en de datum waarop de back-up gemaakt is, kan ingezien worden door de back-up te openen. Via de knop Terugzetten kan daarna de betreffende back-up teruggezet worden. Voordat de back-up teruggezet wordt, maakt Topicus KeyHub eerst een nieuwe back-up. Indien er problemen optreden tijdens het terugzetten van de geselecteerde back-up, wordt automatisch de huidige versie hersteld. Bij het terugzetten van een back-up kan gekozen worden om de database en de configuratie van de appliance terug te zetten of enkel de database.

Back-up terugzetten
Afbeelding 193. Back-up terugzetten

30.4. Ondersteuning

Als er problemen optreden bij het gebruik van Topicus KeyHub kan het nodig zijn om logbestanden in te zien of te downloaden. Via de optie Ondersteuning zijn deze bestanden beschikbaar en kunnen dumps gemaakt worden voor ondersteuning vanuit Topicus.

30.4.1. Logs

Topicus KeyHub houdt een breed scala aan informatie bij in verschillende logbestanden. Deze logbestanden kunnen worden ingezien en/of gedownload. Standaard worden alleen de logbestanden van Topicus KeyHub getoond, maar ook de systeemlogs zijn beschikbaar.

Logs
Afbeelding 194. Logs

30.4.2. Support-dumps

Een support-dump bevat alle logging voor een volledige dag en status-informatie van het huidige moment. Bij een clusteropstelling bevat de dump deze informatie voor alle nodes in het cluster. Standaard worden support-dumps versleuteld, zodat ze eenvoudig via een onbeveiligd kanaal verstuurd kunnen worden. Versleutelde dumps kunnen enkel door medewerkers van Topicus Security geopend worden.

Support-dumps
Afbeelding 195. Support-dumps

30.5. Acties

Om de VM te herstarten of te stoppen, kunnen de desbetreffende knoppen gebruikt worden. De knop om de configuratie bij te werken, voert een volledige synchronisatie uit van de configuratie van de VM. Bij deze synchronisatie worden alle onderdelen van de VM nagelopen en rechtgetrokken indien nodig.

Als er een hotfix beschikbaar gesteld wordt, kan deze via Hotfix toepassen op het systeem uitgerold worden. Rol een hotfix enkel uit na expliciete instructies van Topicus Security.

Actions
Afbeelding 196. Acties

Appendix A: Database-integriteit

De database van Topicus KeyHub is beschermd tegen ongeautoriseerde wijzigingen. Belangrijke onderdelen in de database zijn digitaal ondertekend. Deze ondertekening wordt op de achtergrond en bij gebruikersinteractie gecontroleerd. Als er bij deze controlle fouten gevonden worden, worden deze vastgelegd in de auditlog. Het is mogelijk om deze fouten ook direct te versturen naar een monitoringsysteem via een webhook. Topicus KeyHub zal fouten enkel raporteren en niet corrigeren. Gebruikers die deze fouten betreffen, krijgen een melding op het dashboard waarmee de ondertekening hersteld kan worden.

Het is belangrijk om te beseffen dat het voor Topicus KeyHub niet mogelijk is om te achterhalen wat de oorzaak van de fout was. Er is een mogelijkheid dat er ongeautoriseerde wijzigingen zijn gemaakt aan de database. Het is daarom belangrijk om regels in de auditlog te bekijken en te controlleren of de groepen in Topicus KeyHub nog kloppen. Bij een melding van ondertekeningsfouten is het ook verstandig om contact op te nemen met de leverancier.

Dit product bevat GeoLite2 data gelevered door MaxMind, zie https://www.maxmind.com.