Konfiguracja
Wewnętrznie moduł OIDC Overleaf korzysta z biblioteki passport-openidconnect. Jeśli masz problemy z konfiguracją OpenID Connect, warto przeczytać README bibliotekipassport-openidconnect, aby zorientować się, jakiej konfiguracji oczekuje.
Do włączenia modułu uwierzytelniania OIDC wymagana jest zmienna środowiskowa EXTERNAL_AUTH. Określa ona, które zewnętrzne metody uwierzytelniania są aktywne. Wartością tej zmiennej jest lista. Jeśli lista zawiera oidc, uwierzytelnianie OIDC zostanie włączone.
Na przykład: EXTERNAL_AUTH=ldap oidc
Przy metodzie uwierzytelniania OIDC użytkownik jest przekierowywany na stronę uwierzytelniania dostawcy tożsamości (IdP). Jeśli IdP pomyślnie uwierzytelni użytkownika, w bazie użytkowników Overleaf wyszukiwany jest rekord zawierający pole thirdPartyIdentifiers o następującej strukturze:
externalUserId musi odpowiadać identyfikatorowi użytkownika w profilu zwróconym przez serwer IdP (patrz zmienna środowiskowa OVERLEAF_OIDC_USER_ID_FIELD), a providerId musi odpowiadać identyfikatorowi dostawcy OIDC (patrz OVERLEAF_OIDC_PROVIDER_ID).
Jeśli nie zostanie znaleziony pasujący rekord, w bazie danych wyszukiwany jest użytkownik, którego główny adres e-mail odpowiada adresowi e-mail w profilu użytkownika IdP:
- Jeśli taki użytkownik zostanie znaleziony, pole
thirdPartyIdentifierszostanie zaktualizowane. - Jeśli nie zostanie znaleziony pasujący użytkownik, a tworzenie kont JIT nie jest wyłączone, tworzony jest nowy użytkownik z adresem e-mail i
thirdPartyIdentifiersz profilu IdP.
/user/settings.
Znajdowanie wartości za pomocą dokumentu discovery
Każdy dostawca OpenID (OP) publikuje dokument discovery pod adresem<issuer>/.well-known/openid-configuration. Skopiuj wartości z niego, zamiast wpisywać je ręcznie; wystarczy jeden błędny znak, aby logowanie przestało działać.
Znajdź adres URL discovery

Authentik: adres URL discovery i wystawca dostawcy (instancja testowa)
- Keycloak:
https://keycloak.example.com/realms/<realm>/.well-known/openid-configuration - Authentik:
https://authentik.example.com/application/o/<application-slug>/.well-known/openid-configuration
Odczytaj wartości

Authentik: punkty końcowe dostawcy (instancja testowa)
Skopiuj je do variables.env
Sprawdź, czy Overleaf może połączyć się z OP
200.Zmienne środowiskowe
Wartości poniższych pięciu wymaganych zmiennych można znaleźć za pomocą punktu końcowego.well-known/openid-configuration Twojego dostawcy OpenID (OP), patrz wyżej.
OVERLEAF_OIDC_ISSUER(wymagana)OVERLEAF_OIDC_AUTHORIZATION_URL(wymagana)OVERLEAF_OIDC_TOKEN_URL(wymagana)OVERLEAF_OIDC_USER_INFO_URL(wymagana)OVERLEAF_OIDC_LOGOUT_URL(wymagana)
OVERLEAF_OIDC_CLIENT_ID(wymagana)OVERLEAF_OIDC_CLIENT_SECRET(wymagana)OVERLEAF_OIDC_SCOPE- Domyślnie:
openid profile email
- Domyślnie:
OVERLEAF_OIDC_PROVIDER_ID- Dowolny identyfikator OP, domyślnie
oidc.
- Dowolny identyfikator OP, domyślnie
OVERLEAF_OIDC_PROVIDER_NAME- Nazwa OP używana w sekcji
Linked Accountsna stronie/user/settings, domyślnieOIDC Provider.
- Nazwa OP używana w sekcji
OVERLEAF_OIDC_IDENTITY_SERVICE_NAME- Wyświetlana nazwa usługi tożsamości, używana na stronie logowania (domyślnie:
Log in with $OVERLEAF_OIDC_PROVIDER_NAME).
- Wyświetlana nazwa usługi tożsamości, używana na stronie logowania (domyślnie:
OVERLEAF_OIDC_PROVIDER_DESCRIPTION- Opis OP używany w sekcji
Linked Accounts(domyślnie:Log in with $OVERLEAF_OIDC_PROVIDER_NAME).
- Opis OP używany w sekcji
OVERLEAF_OIDC_PROVIDER_INFO_LINK- Adres URL
Learn morew opisie OP; domyślnie opis nie zawiera linkuLearn more.
- Adres URL
OVERLEAF_OIDC_PROVIDER_HIDE_NOT_LINKED- Nie pokazuje OP na stronie
/user/settings, jeśli konto użytkownika nie jest z nim powiązane; domyślniefalse.
- Nie pokazuje OP na stronie
OVERLEAF_OIDC_USER_ID_FIELD- Wartość tego atrybutu będzie używana przez Overleaf jako zewnętrzny identyfikator użytkownika; domyślnie
id. Inne sensowne wartości toemailiusername(odpowiadająca oświadczeniu OIDCpreferred_username).
- Wartość tego atrybutu będzie używana przez Overleaf jako zewnętrzny identyfikator użytkownika; domyślnie
OVERLEAF_OIDC_ALLOWED_EMAIL_DOMAINS- Ogranicza tworzenie kont Just-in-Time (JIT) dla użytkowników uwierzytelniających się przez OIDC. Jeśli ustawiono ją na listę nazw domen rozdzielonych przecinkami, nowe konto zostanie utworzone tylko wtedy, gdy domena adresu e-mail użytkownika pasuje do jednej z wymienionych domen. Jeśli domena nie pasuje, administrator musi ręcznie utworzyć konto użytkownika z adresem e-mail użytkownika OIDC, z silnym losowym hasłem lub, najlepiej, całkowicie bez pola
hashedPassword. Nazwy domen mogą zawierać na początku symbol wieloznaczny*., aby obejmować subdomeny.- Przykład: aby zezwolić na tworzenie kont JIT dla użytkowników z adresami e-mail takimi jak
name@example.cominame@math.example.com:
OVERLEAF_OIDC_ALLOWED_EMAIL_DOMAINS=example.com, *.example.com - Przykład: aby całkowicie wyłączyć tworzenie kont JIT:
OVERLEAF_OIDC_ALLOWED_EMAIL_DOMAINS=
- Przykład: aby zezwolić na tworzenie kont JIT dla użytkowników z adresami e-mail takimi jak
- Ogranicza tworzenie kont Just-in-Time (JIT) dla użytkowników uwierzytelniających się przez OIDC. Jeśli ustawiono ją na listę nazw domen rozdzielonych przecinkami, nowe konto zostanie utworzone tylko wtedy, gdy domena adresu e-mail użytkownika pasuje do jednej z wymienionych domen. Jeśli domena nie pasuje, administrator musi ręcznie utworzyć konto użytkownika z adresem e-mail użytkownika OIDC, z silnym losowym hasłem lub, najlepiej, całkowicie bez pola
OVERLEAF_OIDC_UPDATE_USER_DETAILS_ON_LOGIN- Jeśli ustawiono na
true, przy logowaniu aktualizowane są polafirst_nameilast_nameużytkownika, a formularz danych użytkownika na stronie/user/settingszostaje wyłączony.
- Jeśli ustawiono na
OVERLEAF_OIDC_IS_ADMIN_FIELDiOVERLEAF_OIDC_IS_ADMIN_FIELD_VALUE- Gdy obie zmienne środowiskowe są ustawione, proces logowania ustawia
user.isAdmin = true, jeśli profil zwrócony przez OP zawiera atrybut określony przezOVERLEAF_OIDC_IS_ADMIN_FIELD, a jego wartość odpowiadaOVERLEAF_OIDC_IS_ADMIN_FIELD_VALUElub jest tablicą zawierającąOVERLEAF_OIDC_IS_ADMIN_FIELD_VALUE(na przykład oświadczeniegroups); w przeciwnym razieuser.isAdminjest ustawiane nafalse. JeśliOVERLEAF_OIDC_IS_ADMIN_FIELDma wartośćemail, do sprawdzenia dopasowania używana jest wartość atrybutuemails[0].value.
- Gdy obie zmienne środowiskowe są ustawione, proces logowania ustawia
https://my-overleaf-instance.com/oidc/login/callback.
Przykładowy plik variables.env
Przykładowy plik variables.env
Krok po kroku: goauthentik
Poniżej opisano konfigurację przetestowaną z goauthentik. Zastąphttps://overleaf.example.com swoim OVERLEAF_SITE_URL, a https://authentik.example.com adresem swojej instancji Authentik.
Utwórz dostawcę
- Client Type:
Confidential. - Redirect URIs (w sekcji Protocol settings): dodaj
https://overleaf.example.com/oidc/login/callbackz trybem dopasowaniaStrict. - Od razu skopiuj Client ID i Client Secret do
OVERLEAF_OIDC_CLIENT_IDiOVERLEAF_OIDC_CLIENT_SECRET.

Authentik: Client ID i Client Secret nowego dostawcy
Utwórz aplikację
overleaf, i wybierz dostawcę. Slug staje się częścią wystawcy: https://authentik.example.com/application/o/overleaf/.Skopiuj adresy URL
Zmapuj administratorów (opcjonalnie)
groups, które jest tablicą. Aby członkowie grupy Authentik Admins stali się administratorami Overleaf:Przetestowany plik variables.env dla goauthentik
Przetestowany plik variables.env dla goauthentik
Pytania i odpowiedzi
Claim administratora jest ustawiony, ale użytkownicy nie stają się administratorami
Claim administratora jest ustawiony, ale użytkownicy nie stają się administratorami
- Wersja. Przed wersją v6.3.0 Overleaf nie odczytywał niestandardowych claimów, takich jak
groups, więc działało tylkoOVERLEAF_OIDC_IS_ADMIN_FIELD=email. Zaktualizuj do wersji v6.3.0 lub nowszej. - Claim musi znajdować się w odpowiedzi UserInfo. Overleaf odczytuje claim z
OVERLEAF_OIDC_USER_INFO_URL, a nie z tokena ID. Jeśli Twój OP dodaje claim tylko do tokena ID, dodaj go również do UserInfo, na przykład za pomocą opcji Add to userinfo w mapperze Keycloak. - Wartość musi być dokładnie zgodna, łącznie z wielkością liter, na przykład
Admins.
Czy mogę używać GitHub jako dostawcy OIDC?
Czy mogę używać GitHub jako dostawcy OIDC?
ID token not present in token response.Aby umożliwić użytkownikom logowanie kontem GitHub, użyj dostawcy tożsamości, takiego jak goauthentik lub Keycloak, z GitHub jako źródłem logowania, i połącz Overleaf z tym dostawcą przez OIDC.Czy mogę używać GitLab jako dostawcy OIDC?
Czy mogę używać GitLab jako dostawcy OIDC?
- Redirect URI:
https://my-overleaf-instance.com/oidc/login/callback - Scopes:
openid,profileiemail
https://gitlab.com/.well-known/openid-configuration lub z tej samej ścieżki w Twoim GitLab, zgodnie z opisem w sekcji Znajdowanie wartości za pomocą dokumentu discovery. Dla gitlab.com wystawcą (issuer) jest https://gitlab.com, bez końcowego ukośnika.
