Konfigurasjon
Internt bruker OIDC-modulen i Overleaf biblioteket passport-openidconnect. Hvis du har problemer med å konfigurere OpenID Connect, er det lurt å lese README-filen forpassport-openidconnect for å få et inntrykk av hvilken konfigurasjon den forventer.
Miljøvariabelen EXTERNAL_AUTH er påkrevd for å aktivere OIDC-autentiseringsmodulen. Denne miljøvariabelen angir hvilke eksterne autentiseringsmetoder som er aktivert. Verdien av variabelen er en liste. Hvis listen inneholder oidc, aktiveres OIDC-autentisering.
For eksempel: EXTERNAL_AUTH=ldap oidc
Når OIDC-autentiseringsmetoden brukes, blir brukeren omdirigert til autentiseringssiden til identitetsleverandøren (IdP). Hvis IdP-en autentiserer brukeren, søkes det i Overleafs brukerdatabase etter en post som inneholder et thirdPartyIdentifiers-felt med følgende struktur:
externalUserId må samsvare med bruker-ID-en i profilen som returneres av IdP-serveren (se miljøvariabelen OVERLEAF_OIDC_USER_ID_FIELD), og providerId må samsvare med ID-en til OIDC-leverandøren (se OVERLEAF_OIDC_PROVIDER_ID).
Hvis ingen samsvarende post blir funnet, søkes det i databasen etter en bruker med en primær e-postadresse som samsvarer med e-postadressen i brukerprofilen fra IdP-en:
- Hvis en slik bruker blir funnet, oppdateres feltet
thirdPartyIdentifiers. - Hvis ingen samsvarende bruker blir funnet og JIT-opprettelse av kontoer ikke er deaktivert, opprettes en ny bruker med e-postadressen og
thirdPartyIdentifiersfra IdP-profilen.
/user/settings.
Finne verdiene med discovery-dokumentet
Hver OpenID-leverandør (OP) publiserer et discovery-dokument på<issuer>/.well-known/openid-configuration. Kopier verdiene derfra i stedet for å skrive dem inn for hånd; ett feil tegn er nok til at innloggingen slutter å fungere.
Finn discovery-URL-en

Authentik: discovery-URL-en og utstederen til en leverandør (testinstans)
- Keycloak:
https://keycloak.example.com/realms/<realm>/.well-known/openid-configuration - Authentik:
https://authentik.example.com/application/o/<application-slug>/.well-known/openid-configuration
Les av verdiene

Authentik: endepunktene til en leverandør (testinstans)
Kopier dem inn i variables.env
Kontroller at Overleaf kan nå OP-en
200.Miljøvariabler
Verdiene for de følgende fem påkrevde variablene finner du via endepunktet.well-known/openid-configuration hos OpenID-leverandøren (OP) din, se ovenfor.
OVERLEAF_OIDC_ISSUER(påkrevd)OVERLEAF_OIDC_AUTHORIZATION_URL(påkrevd)OVERLEAF_OIDC_TOKEN_URL(påkrevd)OVERLEAF_OIDC_USER_INFO_URL(påkrevd)OVERLEAF_OIDC_LOGOUT_URL(påkrevd)
OVERLEAF_OIDC_CLIENT_ID(påkrevd)OVERLEAF_OIDC_CLIENT_SECRET(påkrevd)OVERLEAF_OIDC_SCOPE- Standard:
openid profile email
- Standard:
OVERLEAF_OIDC_PROVIDER_ID- Vilkårlig ID for OP-en, standard er
oidc.
- Vilkårlig ID for OP-en, standard er
OVERLEAF_OIDC_PROVIDER_NAME- Navnet på OP-en, brukt i delen
Linked Accountspå siden/user/settings, standard erOIDC Provider.
- Navnet på OP-en, brukt i delen
OVERLEAF_OIDC_IDENTITY_SERVICE_NAME- Visningsnavn for identitetstjenesten, brukt på innloggingssiden (standard:
Log in with $OVERLEAF_OIDC_PROVIDER_NAME).
- Visningsnavn for identitetstjenesten, brukt på innloggingssiden (standard:
OVERLEAF_OIDC_PROVIDER_DESCRIPTION- Beskrivelse av OP-en, brukt i delen
Linked Accounts(standard:Log in with $OVERLEAF_OIDC_PROVIDER_NAME).
- Beskrivelse av OP-en, brukt i delen
OVERLEAF_OIDC_PROVIDER_INFO_LINKLearn more-URL i beskrivelsen av OP-en; standard: ingenLearn more-lenke i beskrivelsen.
OVERLEAF_OIDC_PROVIDER_HIDE_NOT_LINKED- Ikke vis OP-en på siden
/user/settingshvis brukerens konto ikke er koblet til OP-en; standardfalse.
- Ikke vis OP-en på siden
OVERLEAF_OIDC_USER_ID_FIELD- Verdien av dette attributtet brukes av Overleaf som ekstern bruker-ID; standard er
id. Andre mulige fornuftige verdier eremailogusername(tilsvarer OIDC-claimetpreferred_username).
- Verdien av dette attributtet brukes av Overleaf som ekstern bruker-ID; standard er
OVERLEAF_OIDC_ALLOWED_EMAIL_DOMAINS- Begrenser Just-in-Time-opprettelse (JIT) av kontoer for brukere som autentiserer seg via OIDC. Hvis den er satt til en kommaseparert liste med domenenavn, opprettes en ny konto bare hvis domenet i brukerens e-postadresse samsvarer med et av domenene i listen. Hvis domenet ikke samsvarer, må en administrator opprette brukerkontoen manuelt med OIDC-brukerens e-postadresse, enten med et sterkt tilfeldig passord eller helst helt uten feltet
hashedPassword. Domenenavn kan begynne med jokertegnet*.for å samsvare med underdomener.- Eksempel: For å tillate JIT-opprettelse av kontoer for brukere med e-postadresser som
name@example.comogname@math.example.com:
OVERLEAF_OIDC_ALLOWED_EMAIL_DOMAINS=example.com, *.example.com - Eksempel: For å deaktivere JIT-opprettelse av kontoer fullstendig:
OVERLEAF_OIDC_ALLOWED_EMAIL_DOMAINS=
- Eksempel: For å tillate JIT-opprettelse av kontoer for brukere med e-postadresser som
- Begrenser Just-in-Time-opprettelse (JIT) av kontoer for brukere som autentiserer seg via OIDC. Hvis den er satt til en kommaseparert liste med domenenavn, opprettes en ny konto bare hvis domenet i brukerens e-postadresse samsvarer med et av domenene i listen. Hvis domenet ikke samsvarer, må en administrator opprette brukerkontoen manuelt med OIDC-brukerens e-postadresse, enten med et sterkt tilfeldig passord eller helst helt uten feltet
OVERLEAF_OIDC_UPDATE_USER_DETAILS_ON_LOGIN- Hvis den er satt til
true, oppdateres brukerens feltfirst_nameoglast_nameved innlogging, og skjemaet for brukeropplysninger på siden/user/settingsdeaktiveres.
- Hvis den er satt til
OVERLEAF_OIDC_IS_ADMIN_FIELDogOVERLEAF_OIDC_IS_ADMIN_FIELD_VALUE- Når begge miljøvariablene er satt, oppdaterer innloggingsprosessen
user.isAdmin = truehvis profilen som returneres av OP-en, inneholder attributtet angitt avOVERLEAF_OIDC_IS_ADMIN_FIELDog verdien enten samsvarer medOVERLEAF_OIDC_IS_ADMIN_FIELD_VALUEeller er en matrise som inneholderOVERLEAF_OIDC_IS_ADMIN_FIELD_VALUE(for eksempelgroups-claimet); ellers settesuser.isAdmintilfalse. HvisOVERLEAF_OIDC_IS_ADMIN_FIELDeremail, brukes verdien av attributtetemails[0].valuetil samsvarskontrollen.
- Når begge miljøvariablene er satt, oppdaterer innloggingsprosessen
https://my-overleaf-instance.com/oidc/login/callback.
Eksempel på variables.env-fil
Eksempel på variables.env-fil
Trinn for trinn: goauthentik
Dette er en gjennomgang av et oppsett som er testet mot goauthentik. Erstatthttps://overleaf.example.com med din OVERLEAF_SITE_URL og https://authentik.example.com med adressen til din Authentik.
Opprett leverandøren
- Client Type:
Confidential. - Redirect URIs (under Protocol settings): legg til
https://overleaf.example.com/oidc/login/callbackmed samsvarsmodusenStrict. - Kopier Client ID og Client Secret nå, inn i
OVERLEAF_OIDC_CLIENT_IDogOVERLEAF_OIDC_CLIENT_SECRET.

Authentik: Client ID og Client Secret for en ny leverandør
Opprett applikasjonen
overleaf, og velg leverandøren. Slugen blir en del av utstederen: https://authentik.example.com/application/o/overleaf/.Kopier URL-ene
Tilordne administratorene (valgfritt)
groups-claimet, en matrise. Slik gjør du medlemmene av Authentik-gruppen Admins til administratorer i Overleaf:Testet variables.env for goauthentik
Testet variables.env for goauthentik
Spørsmål og svar
Admin-claimet er satt, men brukerne blir ikke administratorer
Admin-claimet er satt, men brukerne blir ikke administratorer
- Versjon. Før v6.3.0 leste ikke Overleaf egendefinerte claims som
groups, så bareOVERLEAF_OIDC_IS_ADMIN_FIELD=emailfungerte. Oppgrader til v6.3.0 eller nyere. - Claimet må være i UserInfo-svaret. Overleaf leser claimet fra
OVERLEAF_OIDC_USER_INFO_URL, ikke fra ID-tokenet. Hvis OP-en din bare legger claimet til i ID-tokenet, må du også legge det til i UserInfo, for eksempel med Add to userinfo på en Keycloak-mapper. - Verdien må samsvare nøyaktig, inkludert store og små bokstaver, for eksempel
Admins.
Kan jeg bruke GitHub som OIDC-leverandør?
Kan jeg bruke GitHub som OIDC-leverandør?
ID token not present in token response.For å la brukere logge inn med GitHub-kontoen sin bruker du en identitetsleverandør som goauthentik eller Keycloak, med GitHub som innloggingskilde, og kobler Overleaf til den leverandøren med OIDC.Kan jeg bruke GitLab som OIDC-leverandør?
Kan jeg bruke GitLab som OIDC-leverandør?
- Redirect URI:
https://my-overleaf-instance.com/oidc/login/callback - Scopes:
openid,profileogemail
https://gitlab.com/.well-known/openid-configuration, eller fra samme sti på din GitLab, som beskrevet i Finne verdiene med discovery-dokumentet. For gitlab.com er utstederen https://gitlab.com, uten avsluttende skråstrek.
