Konfiguration
Intern verwendet das Overleaf-OIDC-Modul die Bibliothek passport-openidconnect. Wenn Sie Probleme bei der Konfiguration von OpenID Connect haben, lohnt es sich, die README vonpassport-openidconnect zu lesen, um ein Gefühl für die erwartete Konfiguration zu bekommen.
Die Umgebungsvariable EXTERNAL_AUTH ist erforderlich, um das OIDC-Authentifizierungsmodul zu aktivieren. Diese Umgebungsvariable legt fest, welche externen Authentifizierungsmethoden aktiviert sind. Der Wert dieser Variablen ist eine Liste. Enthält die Liste oidc, wird die OIDC-Authentifizierung aktiviert.
Beispiel: EXTERNAL_AUTH=ldap oidc
Bei Verwendung der OIDC-Authentifizierungsmethode wird ein Benutzer auf die Authentifizierungsseite des Identity Providers (IdP) weitergeleitet. Wenn der IdP den Benutzer erfolgreich authentifiziert, wird die Overleaf-Benutzerdatenbank nach einem Datensatz durchsucht, der ein Feld thirdPartyIdentifiers mit folgender Struktur enthält:
externalUserId muss mit der Benutzer-ID im vom IdP-Server zurückgegebenen Profil übereinstimmen (siehe Umgebungsvariable OVERLEAF_OIDC_USER_ID_FIELD), und providerId muss mit der ID des OIDC-Providers übereinstimmen (siehe OVERLEAF_OIDC_PROVIDER_ID).
Wird kein passender Datensatz gefunden, wird die Datenbank nach einem Benutzer durchsucht, dessen primäre E-Mail-Adresse mit der E-Mail-Adresse im IdP-Benutzerprofil übereinstimmt:
- Wird ein solcher Benutzer gefunden, wird das Feld
thirdPartyIdentifiersaktualisiert. - Wird kein passender Benutzer gefunden und ist die JIT-Kontoerstellung nicht deaktiviert, wird ein neuer Benutzer mit der E-Mail-Adresse und den
thirdPartyIdentifiersaus dem IdP-Profil angelegt.
/user/settings aufheben.
Werte über das Discovery-Dokument ermitteln
Jeder OpenID Provider (OP) veröffentlicht ein Discovery-Dokument unter<issuer>/.well-known/openid-configuration. Kopieren Sie die Werte daraus, statt sie von Hand einzutippen; ein einziges falsches Zeichen genügt, damit die Anmeldung fehlschlägt.
Discovery-URL finden

Authentik: Discovery-URL und Issuer eines Providers (Testinstanz)
- Keycloak:
https://keycloak.example.com/realms/<realm>/.well-known/openid-configuration - Authentik:
https://authentik.example.com/application/o/<application-slug>/.well-known/openid-configuration
Werte auslesen

Authentik: die Endpunkte eines Providers (Testinstanz)
In variables.env übernehmen
Prüfen, ob Overleaf den OP erreicht
200 lauten.Umgebungsvariablen
Die Werte der folgenden fünf erforderlichen Variablen finden Sie über den Endpunkt.well-known/openid-configuration Ihres OpenID Providers (OP), siehe oben.
OVERLEAF_OIDC_ISSUER(erforderlich)OVERLEAF_OIDC_AUTHORIZATION_URL(erforderlich)OVERLEAF_OIDC_TOKEN_URL(erforderlich)OVERLEAF_OIDC_USER_INFO_URL(erforderlich)OVERLEAF_OIDC_LOGOUT_URL(erforderlich)
OVERLEAF_OIDC_CLIENT_ID(erforderlich)OVERLEAF_OIDC_CLIENT_SECRET(erforderlich)OVERLEAF_OIDC_SCOPE- Standard:
openid profile email
- Standard:
OVERLEAF_OIDC_PROVIDER_ID- Beliebige ID des OP, Standard ist
oidc.
- Beliebige ID des OP, Standard ist
OVERLEAF_OIDC_PROVIDER_NAME- Der Name des OP, der im Abschnitt
Linked Accountsder Seite/user/settingsverwendet wird, Standard istOIDC Provider.
- Der Name des OP, der im Abschnitt
OVERLEAF_OIDC_IDENTITY_SERVICE_NAME- Anzeigename des Identitätsdienstes, der auf der Anmeldeseite verwendet wird (Standard:
Log in with $OVERLEAF_OIDC_PROVIDER_NAME).
- Anzeigename des Identitätsdienstes, der auf der Anmeldeseite verwendet wird (Standard:
OVERLEAF_OIDC_PROVIDER_DESCRIPTION- Beschreibung des OP, die im Abschnitt
Linked Accountsverwendet wird (Standard:Log in with $OVERLEAF_OIDC_PROVIDER_NAME).
- Beschreibung des OP, die im Abschnitt
OVERLEAF_OIDC_PROVIDER_INFO_LINKLearn more-URL in der OP-Beschreibung, Standard: keinLearn more-Link in der Beschreibung.
OVERLEAF_OIDC_PROVIDER_HIDE_NOT_LINKED- Den OP auf der Seite
/user/settingsnicht anzeigen, wenn das Benutzerkonto nicht mit dem OP verknüpft ist, Standardfalse.
- Den OP auf der Seite
OVERLEAF_OIDC_USER_ID_FIELD- Der Wert dieses Attributs wird von Overleaf als externe Benutzer-ID verwendet, Standard ist
id. Weitere sinnvolle Werte sindemailundusername(entspricht dem OIDC-Claimpreferred_username).
- Der Wert dieses Attributs wird von Overleaf als externe Benutzer-ID verwendet, Standard ist
OVERLEAF_OIDC_ALLOWED_EMAIL_DOMAINS- Schränkt die Just-in-Time-(JIT-)Kontoerstellung für Benutzer ein, die sich über OIDC authentifizieren. Ist hier eine kommagetrennte Liste von Domainnamen gesetzt, wird ein neues Konto nur erstellt, wenn die Domain der E-Mail-Adresse des Benutzers mit einer der aufgeführten Domains übereinstimmt. Stimmt die Domain nicht überein, muss ein Administrator das Benutzerkonto manuell mit der E-Mail-Adresse des OIDC-Benutzers anlegen – entweder mit einem starken zufälligen Passwort oder vorzugsweise ganz ohne das Feld
hashedPassword. Domainnamen können ein vorangestelltes*.als Platzhalter enthalten, um Subdomains abzudecken.- Beispiel: Um die JIT-Kontoerstellung für Benutzer mit E-Mail-Adressen wie
name@example.comundname@math.example.comzu erlauben:
OVERLEAF_OIDC_ALLOWED_EMAIL_DOMAINS=example.com, *.example.com - Beispiel: Um die JIT-Kontoerstellung vollständig zu deaktivieren:
OVERLEAF_OIDC_ALLOWED_EMAIL_DOMAINS=
- Beispiel: Um die JIT-Kontoerstellung für Benutzer mit E-Mail-Adressen wie
- Schränkt die Just-in-Time-(JIT-)Kontoerstellung für Benutzer ein, die sich über OIDC authentifizieren. Ist hier eine kommagetrennte Liste von Domainnamen gesetzt, wird ein neues Konto nur erstellt, wenn die Domain der E-Mail-Adresse des Benutzers mit einer der aufgeführten Domains übereinstimmt. Stimmt die Domain nicht überein, muss ein Administrator das Benutzerkonto manuell mit der E-Mail-Adresse des OIDC-Benutzers anlegen – entweder mit einem starken zufälligen Passwort oder vorzugsweise ganz ohne das Feld
OVERLEAF_OIDC_UPDATE_USER_DETAILS_ON_LOGIN- Wenn auf
truegesetzt, werden die Felderfirst_nameundlast_namedes Benutzers bei der Anmeldung aktualisiert, und das Formular für Benutzerdetails auf der Seite/user/settingswird deaktiviert.
- Wenn auf
OVERLEAF_OIDC_IS_ADMIN_FIELDundOVERLEAF_OIDC_IS_ADMIN_FIELD_VALUE- Wenn beide Umgebungsvariablen gesetzt sind, setzt der Anmeldevorgang
user.isAdmin = true, sofern das vom OP zurückgegebene Profil das durchOVERLEAF_OIDC_IS_ADMIN_FIELDangegebene Attribut enthält und dessen Wert entweder mitOVERLEAF_OIDC_IS_ADMIN_FIELD_VALUEübereinstimmt oder ein Array ist, dasOVERLEAF_OIDC_IS_ADMIN_FIELD_VALUEenthält (zum Beispiel dergroups-Claim); andernfalls wirduser.isAdminauffalsegesetzt. IstOVERLEAF_OIDC_IS_ADMIN_FIELDgleichemail, wird der Wert des Attributsemails[0].valuefür die Prüfung verwendet.
- Wenn beide Umgebungsvariablen gesetzt sind, setzt der Anmeldevorgang
https://my-overleaf-instance.com/oidc/login/callback.
Beispieldatei variables.env
Beispieldatei variables.env
Schritt für Schritt: goauthentik
Diese Anleitung beschreibt eine Einrichtung, die mit goauthentik getestet wurde. Ersetzen Siehttps://overleaf.example.com durch Ihre OVERLEAF_SITE_URL und https://authentik.example.com durch die Adresse Ihrer Authentik-Instanz.
Provider anlegen
- Client Type:
Confidential. - Redirect URIs (unter Protocol settings): Fügen Sie
https://overleaf.example.com/oidc/login/callbackmit dem AbgleichmodusStricthinzu. - Kopieren Sie Client ID und Client Secret jetzt in
OVERLEAF_OIDC_CLIENT_IDundOVERLEAF_OIDC_CLIENT_SECRET.

Authentik: Client ID und Client Secret eines neuen Providers
Anwendung anlegen
overleaf, und wählen Sie den Provider aus. Der Slug wird Teil des Issuers: https://authentik.example.com/application/o/overleaf/.URLs kopieren
Administratoren zuordnen (optional)
groups-Claim, ein Array. Um die Mitglieder der Authentik-Gruppe Admins zu Administratoren von Overleaf zu machen:Getestete variables.env für goauthentik
Getestete variables.env für goauthentik
Fragen & Antworten
Der Admin-Claim ist gesetzt, aber Benutzer werden keine Administratoren
Der Admin-Claim ist gesetzt, aber Benutzer werden keine Administratoren
- Version. Vor v6.3.0 hat Overleaf benutzerdefinierte Claims wie
groupsnicht ausgelesen, sodass nurOVERLEAF_OIDC_IS_ADMIN_FIELD=emailfunktionierte. Aktualisieren Sie auf v6.3.0 oder neuer. - Der Claim muss in der UserInfo-Antwort enthalten sein. Overleaf liest den Claim aus
OVERLEAF_OIDC_USER_INFO_URL, nicht aus dem ID-Token. Wenn Ihr OP den Claim nur zum ID-Token hinzufügt, fügen Sie ihn auch zu UserInfo hinzu, zum Beispiel mit Add to userinfo bei einem Keycloak-Mapper. - Der Wert muss exakt übereinstimmen, einschließlich Groß-/Kleinschreibung, zum Beispiel
Admins.
Kann ich GitHub als OIDC-Provider verwenden?
Kann ich GitHub als OIDC-Provider verwenden?
ID token not present in token response fehlschlägt.Damit sich Benutzer mit ihrem GitHub-Konto anmelden können, verwenden Sie einen Identity Provider wie goauthentik oder Keycloak mit GitHub als Anmeldequelle und verbinden Sie Overleaf per OIDC mit diesem Provider.Kann ich GitLab als OIDC-Provider verwenden?
Kann ich GitLab als OIDC-Provider verwenden?
- Redirect URI:
https://my-overleaf-instance.com/oidc/login/callback - Scopes:
openid,profileundemail
https://gitlab.com/.well-known/openid-configuration oder aus demselben Pfad auf Ihrem GitLab aus, wie unter Werte über das Discovery-Dokument ermitteln beschrieben. Für gitlab.com lautet der Issuer https://gitlab.com, ohne abschließenden Schrägstrich.
