Configuratie
Intern gebruikt de OIDC-module van Overleaf de bibliotheek passport-openidconnect. Als je problemen hebt met het configureren van OpenID Connect, is het de moeite waard om de README vanpassport-openidconnect te lezen om een idee te krijgen van de configuratie die deze verwacht.
De omgevingsvariabele EXTERNAL_AUTH is vereist om de OIDC-authenticatiemodule in te schakelen. Deze omgevingsvariabele geeft aan welke externe authenticatiemethoden worden geactiveerd. De waarde van deze variabele is een lijst. Als de lijst oidc bevat, wordt OIDC-authenticatie geactiveerd.
Bijvoorbeeld: EXTERNAL_AUTH=ldap oidc
Bij gebruik van de OIDC-authenticatiemethode wordt een gebruiker doorgestuurd naar de authenticatiesite van de Identity Provider (IdP). Als de IdP de gebruiker succesvol authenticeert, wordt in de gebruikersdatabase van Overleaf gezocht naar een record met een veld thirdPartyIdentifiers met de volgende structuur:
externalUserId moet overeenkomen met het gebruikers-ID in het profiel dat door de IdP-server wordt geretourneerd (zie de omgevingsvariabele OVERLEAF_OIDC_USER_ID_FIELD), en providerId moet overeenkomen met het ID van de OIDC-provider (zie OVERLEAF_OIDC_PROVIDER_ID).
Als er geen overeenkomend record wordt gevonden, wordt in de database gezocht naar een gebruiker van wie het primaire e-mailadres overeenkomt met het e-mailadres in het gebruikersprofiel van de IdP:
- Als zo’n gebruiker wordt gevonden, wordt het veld
thirdPartyIdentifiersbijgewerkt. - Als er geen overeenkomende gebruiker wordt gevonden en het JIT-aanmaken van accounts niet is uitgeschakeld, wordt een nieuwe gebruiker aangemaakt met het e-mailadres en de
thirdPartyIdentifiersuit het IdP-profiel.
/user/settings worden ontkoppeld van de OIDC-provider.
De waarden vinden met het discovery-document
Elke OpenID Provider (OP) publiceert een discovery-document op<issuer>/.well-known/openid-configuration. Kopieer de waarden daaruit in plaats van ze met de hand over te typen; één verkeerd teken is genoeg om het inloggen te laten mislukken.
Zoek de discovery-URL

Authentik: de discovery-URL en de issuer van een provider (testinstantie)
- Keycloak:
https://keycloak.example.com/realms/<realm>/.well-known/openid-configuration - Authentik:
https://authentik.example.com/application/o/<application-slug>/.well-known/openid-configuration
Lees de waarden uit

Authentik: de endpoints van een provider (testinstantie)
Kopieer ze naar variables.env
Controleer of Overleaf de OP kan bereiken
200 moeten tonen.Omgevingsvariabelen
De waarden van de volgende vijf verplichte variabelen kun je vinden via het endpoint.well-known/openid-configuration van je OpenID Provider (OP), zie hierboven.
OVERLEAF_OIDC_ISSUER(verplicht)OVERLEAF_OIDC_AUTHORIZATION_URL(verplicht)OVERLEAF_OIDC_TOKEN_URL(verplicht)OVERLEAF_OIDC_USER_INFO_URL(verplicht)OVERLEAF_OIDC_LOGOUT_URL(verplicht)
OVERLEAF_OIDC_CLIENT_ID(verplicht)OVERLEAF_OIDC_CLIENT_SECRET(verplicht)OVERLEAF_OIDC_SCOPE- Standaard:
openid profile email
- Standaard:
OVERLEAF_OIDC_PROVIDER_ID- Willekeurig ID van de OP, standaard
oidc.
- Willekeurig ID van de OP, standaard
OVERLEAF_OIDC_PROVIDER_NAME- De naam van de OP, gebruikt in de sectie
Linked Accountsvan de pagina/user/settings, standaardOIDC Provider.
- De naam van de OP, gebruikt in de sectie
OVERLEAF_OIDC_IDENTITY_SERVICE_NAME- Weergavenaam voor de identiteitsdienst, gebruikt op de inlogpagina (standaard:
Log in with $OVERLEAF_OIDC_PROVIDER_NAME).
- Weergavenaam voor de identiteitsdienst, gebruikt op de inlogpagina (standaard:
OVERLEAF_OIDC_PROVIDER_DESCRIPTION- Beschrijving van de OP, gebruikt in de sectie
Linked Accounts(standaard:Log in with $OVERLEAF_OIDC_PROVIDER_NAME).
- Beschrijving van de OP, gebruikt in de sectie
OVERLEAF_OIDC_PROVIDER_INFO_LINK- URL voor
Learn morein de beschrijving van de OP; standaard: geenLearn more-link in de beschrijving.
- URL voor
OVERLEAF_OIDC_PROVIDER_HIDE_NOT_LINKED- Toon de OP niet op de pagina
/user/settingsals het account van de gebruiker niet aan de OP is gekoppeld; standaardfalse.
- Toon de OP niet op de pagina
OVERLEAF_OIDC_USER_ID_FIELD- De waarde van dit attribuut wordt door Overleaf gebruikt als het externe gebruikers-ID, standaard
id. Andere mogelijke redelijke waarden zijnemailenusername(overeenkomend met de OIDC-claimpreferred_username).
- De waarde van dit attribuut wordt door Overleaf gebruikt als het externe gebruikers-ID, standaard
OVERLEAF_OIDC_ALLOWED_EMAIL_DOMAINS- Beperkt het Just-in-Time (JIT) aanmaken van accounts voor gebruikers die zich via OIDC authenticeren. Als deze is ingesteld op een door komma’s gescheiden lijst met domeinnamen, wordt alleen een nieuw account aangemaakt als het domein van het e-mailadres van de gebruiker overeenkomt met een van de vermelde domeinen. Als het domein niet overeenkomt, moet een beheerder het gebruikersaccount handmatig aanmaken met het e-mailadres van de OIDC-gebruiker, met een sterk willekeurig wachtwoord of bij voorkeur helemaal zonder het veld
hashedPassword. Domeinnamen mogen beginnen met een*.-jokerteken om subdomeinen te matchen.- Voorbeeld: om JIT-accountaanmaak toe te staan voor gebruikers met e-mailadressen zoals
name@example.comenname@math.example.com:
OVERLEAF_OIDC_ALLOWED_EMAIL_DOMAINS=example.com, *.example.com - Voorbeeld: om JIT-accountaanmaak volledig uit te schakelen:
OVERLEAF_OIDC_ALLOWED_EMAIL_DOMAINS=
- Voorbeeld: om JIT-accountaanmaak toe te staan voor gebruikers met e-mailadressen zoals
- Beperkt het Just-in-Time (JIT) aanmaken van accounts voor gebruikers die zich via OIDC authenticeren. Als deze is ingesteld op een door komma’s gescheiden lijst met domeinnamen, wordt alleen een nieuw account aangemaakt als het domein van het e-mailadres van de gebruiker overeenkomt met een van de vermelde domeinen. Als het domein niet overeenkomt, moet een beheerder het gebruikersaccount handmatig aanmaken met het e-mailadres van de OIDC-gebruiker, met een sterk willekeurig wachtwoord of bij voorkeur helemaal zonder het veld
OVERLEAF_OIDC_UPDATE_USER_DETAILS_ON_LOGIN- Als deze is ingesteld op
true, worden de veldenfirst_nameenlast_namevan de gebruiker bij het inloggen bijgewerkt en wordt het formulier met gebruikersgegevens op de pagina/user/settingsuitgeschakeld.
- Als deze is ingesteld op
OVERLEAF_OIDC_IS_ADMIN_FIELDenOVERLEAF_OIDC_IS_ADMIN_FIELD_VALUE- Wanneer beide omgevingsvariabelen zijn ingesteld, stelt het inlogproces
user.isAdmin = truein als het door de OP geretourneerde profiel het attribuut bevat dat is opgegeven doorOVERLEAF_OIDC_IS_ADMIN_FIELDen de waarde ervan overeenkomt metOVERLEAF_OIDC_IS_ADMIN_FIELD_VALUEof een array is dieOVERLEAF_OIDC_IS_ADMIN_FIELD_VALUEbevat (bijvoorbeeld de claimgroups); anders wordtuser.isAdminingesteld opfalse. AlsOVERLEAF_OIDC_IS_ADMIN_FIELDgelijk is aanemail, wordt de waarde van het attribuutemails[0].valuegebruikt voor de controle.
- Wanneer beide omgevingsvariabelen zijn ingesteld, stelt het inlogproces
https://my-overleaf-instance.com/oidc/login/callback.
Voorbeeld van een variables.env-bestand
Voorbeeld van een variables.env-bestand
Stap voor stap: goauthentik
Hieronder doorlopen we een setup die is getest met goauthentik. Vervanghttps://overleaf.example.com door je OVERLEAF_SITE_URL en https://authentik.example.com door het adres van je Authentik.
Maak de provider aan
- Client Type:
Confidential. - Redirect URIs (onder Protocol settings): voeg
https://overleaf.example.com/oidc/login/callbacktoe met de matching-modusStrict. - Kopieer nu Client ID en Client Secret naar
OVERLEAF_OIDC_CLIENT_IDenOVERLEAF_OIDC_CLIENT_SECRET.

Authentik: Client ID en Client Secret van een nieuwe provider
Maak de applicatie aan
overleaf, en selecteer de provider. De slug wordt onderdeel van de issuer: https://authentik.example.com/application/o/overleaf/.Kopieer de URL's
Koppel de beheerders (optioneel)
groups, een array. Om de leden van de Authentik-groep Admins beheerder van Overleaf te maken:Geteste variables.env voor goauthentik
Geteste variables.env voor goauthentik
Vragen en antwoorden
De admin-claim is ingesteld, maar gebruikers worden geen beheerder
De admin-claim is ingesteld, maar gebruikers worden geen beheerder
- Versie. Vóór v6.3.0 las Overleaf geen aangepaste claims zoals
groups, dus werkte alleenOVERLEAF_OIDC_IS_ADMIN_FIELD=email. Upgrade naar v6.3.0 of later. - De claim moet in het UserInfo-antwoord staan. Overleaf leest de claim uit
OVERLEAF_OIDC_USER_INFO_URL, niet uit het ID-token. Als je OP de claim alleen aan het ID-token toevoegt, voeg deze dan ook toe aan UserInfo, bijvoorbeeld met Add to userinfo bij een Keycloak-mapper. - De waarde moet exact overeenkomen, inclusief hoofdletters, bijvoorbeeld
Admins.
Kan ik GitHub als OIDC-provider gebruiken?
Kan ik GitHub als OIDC-provider gebruiken?
ID token not present in token response.Om gebruikers met hun GitHub-account te laten inloggen, gebruik je een identiteitsprovider zoals goauthentik of Keycloak, met GitHub als inlogbron, en koppel je Overleaf via OIDC aan die provider.Kan ik GitLab als OIDC-provider gebruiken?
Kan ik GitLab als OIDC-provider gebruiken?
- Redirect URI:
https://my-overleaf-instance.com/oidc/login/callback - Scopes:
openid,profileenemail
https://gitlab.com/.well-known/openid-configuration, of uit hetzelfde pad op je eigen GitLab, zoals beschreven in De waarden vinden met het discovery-document. Voor gitlab.com is de issuer https://gitlab.com, zonder afsluitende slash.
