Määritys
Sisäisesti Overleafin OIDC-moduuli käyttää passport-openidconnect-kirjastoa. Jos OpenID Connectin määrittämisessä on ongelmia, kannattaa lukeapassport-openidconnect-kirjaston README, jotta saat käsityksen sen odottamasta määrityksestä.
OIDC-todennusmoduulin käyttöönotto edellyttää ympäristömuuttujaa EXTERNAL_AUTH. Tämä ympäristömuuttuja määrittää, mitkä ulkoiset todennusmenetelmät aktivoidaan. Muuttujan arvo on luettelo. Jos luettelo sisältää arvon oidc, OIDC-todennus aktivoidaan.
Esimerkiksi: EXTERNAL_AUTH=ldap oidc
OIDC-todennusmenetelmää käytettäessä käyttäjä ohjataan identiteetintarjoajan (IdP) todennussivustolle. Jos IdP todentaa käyttäjän onnistuneesti, Overleafin käyttäjätietokannasta etsitään tietue, joka sisältää seuraavanlaisen thirdPartyIdentifiers-kentän:
externalUserId on vastattava IdP-palvelimen palauttaman profiilin käyttäjätunnusta (katso ympäristömuuttuja OVERLEAF_OIDC_USER_ID_FIELD), ja kentän providerId on vastattava OIDC-tarjoajan tunnusta (katso OVERLEAF_OIDC_PROVIDER_ID).
Jos vastaavaa tietuetta ei löydy, tietokannasta etsitään käyttäjää, jonka ensisijainen sähköpostiosoite vastaa IdP:n käyttäjäprofiilin sähköpostiosoitetta:
- Jos tällainen käyttäjä löytyy,
thirdPartyIdentifiers-kenttä päivitetään. - Jos vastaavaa käyttäjää ei löydy eikä JIT-tilinluontia ole poistettu käytöstä, luodaan uusi käyttäjä IdP-profiilin sähköpostiosoitteella ja
thirdPartyIdentifiers-tiedoilla.
/user/settings.
Arvojen löytäminen discovery-dokumentin avulla
Jokainen OpenID-tarjoaja (OP) julkaisee discovery-dokumentin osoitteessa<issuer>/.well-known/openid-configuration. Kopioi arvot sieltä sen sijaan, että kirjoittaisit ne käsin; yksikin väärä merkki riittää rikkomaan kirjautumisen.
Etsi discovery-URL

Authentik: tarjoajan discovery-URL ja myöntäjä (testi-instanssi)
- Keycloak:
https://keycloak.example.com/realms/<realm>/.well-known/openid-configuration - Authentik:
https://authentik.example.com/application/o/<application-slug>/.well-known/openid-configuration
Lue arvot

Authentik: tarjoajan päätepisteet (testi-instanssi)
Kopioi ne tiedostoon variables.env
Tarkista, että Overleaf tavoittaa OP:n
200.Ympäristömuuttujat
Seuraavien viiden pakollisen muuttujan arvot löytyvät OpenID-tarjoajasi (OP).well-known/openid-configuration-päätepisteestä, katso yllä.
OVERLEAF_OIDC_ISSUER(pakollinen)OVERLEAF_OIDC_AUTHORIZATION_URL(pakollinen)OVERLEAF_OIDC_TOKEN_URL(pakollinen)OVERLEAF_OIDC_USER_INFO_URL(pakollinen)OVERLEAF_OIDC_LOGOUT_URL(pakollinen)
OVERLEAF_OIDC_CLIENT_ID(pakollinen)OVERLEAF_OIDC_CLIENT_SECRET(pakollinen)OVERLEAF_OIDC_SCOPE- Oletus:
openid profile email
- Oletus:
OVERLEAF_OIDC_PROVIDER_ID- OP:n vapaavalintainen tunnus, oletuksena
oidc.
- OP:n vapaavalintainen tunnus, oletuksena
OVERLEAF_OIDC_PROVIDER_NAME- OP:n nimi, jota käytetään sivun
/user/settingsLinked Accounts-osiossa, oletuksenaOIDC Provider.
- OP:n nimi, jota käytetään sivun
OVERLEAF_OIDC_IDENTITY_SERVICE_NAME- Identiteettipalvelun näyttönimi, jota käytetään kirjautumissivulla (oletus:
Log in with $OVERLEAF_OIDC_PROVIDER_NAME).
- Identiteettipalvelun näyttönimi, jota käytetään kirjautumissivulla (oletus:
OVERLEAF_OIDC_PROVIDER_DESCRIPTION- OP:n kuvaus, jota käytetään
Linked Accounts-osiossa (oletus:Log in with $OVERLEAF_OIDC_PROVIDER_NAME).
- OP:n kuvaus, jota käytetään
OVERLEAF_OIDC_PROVIDER_INFO_LINK- OP:n kuvauksen
Learn more-URL; oletuksena kuvauksessa ei oleLearn more-linkkiä.
- OP:n kuvauksen
OVERLEAF_OIDC_PROVIDER_HIDE_NOT_LINKED- Älä näytä OP:tä sivulla
/user/settings, jos käyttäjän tiliä ei ole linkitetty OP:hen, oletuksenafalse.
- Älä näytä OP:tä sivulla
OVERLEAF_OIDC_USER_ID_FIELD- Overleaf käyttää tämän attribuutin arvoa ulkoisena käyttäjätunnuksena, oletuksena
id. Muita mahdollisia järkeviä arvoja ovatemailjausername(vastaa OIDC-väitettäpreferred_username).
- Overleaf käyttää tämän attribuutin arvoa ulkoisena käyttäjätunnuksena, oletuksena
OVERLEAF_OIDC_ALLOWED_EMAIL_DOMAINS- Rajoittaa Just-in-Time (JIT) -tilinluontia OIDC:n kautta todentautuville käyttäjille. Jos arvoksi asetetaan pilkuin eroteltu luettelo verkkotunnuksista, uusi tili luodaan vain, jos käyttäjän sähköpostiosoitteen verkkotunnus vastaa jotakin luettelon verkkotunnuksista. Jos verkkotunnus ei vastaa, ylläpitäjän on luotava käyttäjätili manuaalisesti OIDC-käyttäjän sähköpostiosoitteella joko vahvalla satunnaisella salasanalla tai mieluiten kokonaan ilman
hashedPassword-kenttää. Verkkotunnusten alussa voi olla*.-jokerimerkki, joka vastaa aliverkkotunnuksia.- Esimerkki: JIT-tilinluonnin salliminen käyttäjille, joiden sähköpostiosoite on muotoa
name@example.comjaname@math.example.com:
OVERLEAF_OIDC_ALLOWED_EMAIL_DOMAINS=example.com, *.example.com - Esimerkki: JIT-tilinluonnin poistaminen kokonaan käytöstä:
OVERLEAF_OIDC_ALLOWED_EMAIL_DOMAINS=
- Esimerkki: JIT-tilinluonnin salliminen käyttäjille, joiden sähköpostiosoite on muotoa
- Rajoittaa Just-in-Time (JIT) -tilinluontia OIDC:n kautta todentautuville käyttäjille. Jos arvoksi asetetaan pilkuin eroteltu luettelo verkkotunnuksista, uusi tili luodaan vain, jos käyttäjän sähköpostiosoitteen verkkotunnus vastaa jotakin luettelon verkkotunnuksista. Jos verkkotunnus ei vastaa, ylläpitäjän on luotava käyttäjätili manuaalisesti OIDC-käyttäjän sähköpostiosoitteella joko vahvalla satunnaisella salasanalla tai mieluiten kokonaan ilman
OVERLEAF_OIDC_UPDATE_USER_DETAILS_ON_LOGIN- Jos arvoksi asetetaan
true, käyttäjän kentätfirst_namejalast_namepäivitetään kirjautumisen yhteydessä, ja sivun/user/settingskäyttäjätietolomake poistetaan käytöstä.
- Jos arvoksi asetetaan
OVERLEAF_OIDC_IS_ADMIN_FIELDjaOVERLEAF_OIDC_IS_ADMIN_FIELD_VALUE- Kun molemmat ympäristömuuttujat on asetettu, kirjautumisprosessi asettaa
user.isAdmin = true, jos OP:n palauttama profiili sisältää muuttujanOVERLEAF_OIDC_IS_ADMIN_FIELDmäärittämän attribuutin ja sen arvo joko vastaa muuttujaaOVERLEAF_OIDC_IS_ADMIN_FIELD_VALUEtai on taulukko, joka sisältää arvonOVERLEAF_OIDC_IS_ADMIN_FIELD_VALUE(esimerkiksigroups-claim); muussa tapauksessauser.isAdminasetetaan arvoonfalse. JosOVERLEAF_OIDC_IS_ADMIN_FIELDonemail, vastaavuuden tarkistuksessa käytetään attribuutinemails[0].valuearvoa.
- Kun molemmat ympäristömuuttujat on asetettu, kirjautumisprosessi asettaa
https://my-overleaf-instance.com/oidc/login/callback.
Esimerkki variables.env-tiedostosta
Esimerkki variables.env-tiedostosta
Vaihe vaiheelta: goauthentik
Tämä ohje käy läpi määrityksen, joka on testattu goauthentikin kanssa. Korvaahttps://overleaf.example.com omalla OVERLEAF_SITE_URL-arvollasi ja https://authentik.example.com Authentikisi osoitteella.
Luo tarjoaja
- Client Type:
Confidential. - Redirect URIs (kohdassa Protocol settings): lisää
https://overleaf.example.com/oidc/login/callbackvastaavuustilallaStrict. - Kopioi nyt Client ID ja Client Secret muuttujiin
OVERLEAF_OIDC_CLIENT_IDjaOVERLEAF_OIDC_CLIENT_SECRET.

Authentik: uuden tarjoajan Client ID ja Client Secret
Luo sovellus
overleaf, ja valitse tarjoaja. Slugista tulee osa myöntäjää: https://authentik.example.com/application/o/overleaf/.Kopioi URL-osoitteet
Määritä ylläpitäjät (valinnainen)
groups-claimissa, joka on taulukko. Jos haluat Authentik-ryhmän Admins jäsenistä Overleafin ylläpitäjiä:Testattu variables.env-tiedosto goauthentikille
Testattu variables.env-tiedosto goauthentikille
Q&A
Ylläpitäjäväite on asetettu, mutta käyttäjistä ei tule ylläpitäjiä
Ylläpitäjäväite on asetettu, mutta käyttäjistä ei tule ylläpitäjiä
- Versio. Ennen versiota v6.3.0 Overleaf ei lukenut mukautettuja väitteitä, kuten
groups, joten vainOVERLEAF_OIDC_IS_ADMIN_FIELD=emailtoimi. Päivitä versioon v6.3.0 tai uudempaan. - Väitteen on oltava UserInfo-vastauksessa. Overleaf lukee väitteen osoitteesta
OVERLEAF_OIDC_USER_INFO_URL, ei ID-tunnisteesta. Jos OP lisää väitteen vain ID-tunnisteeseen, lisää se myös UserInfoon, esimerkiksi Keycloak-mapperin Add to userinfo -asetuksella. - Arvon on vastattava täsmälleen, myös kirjainkoon osalta, esimerkiksi
Admins.
Voinko käyttää GitHubia OIDC-tarjoajana?
Voinko käyttää GitHubia OIDC-tarjoajana?
ID token not present in token response.Jotta käyttäjät voivat kirjautua GitHub-tilillään, käytä identiteetintarjoajaa, kuten goauthentikia tai Keycloakia, GitHub kirjautumislähteenään, ja yhdistä Overleaf kyseiseen tarjoajaan OIDC:llä.Voinko käyttää GitLabia OIDC-tarjoajana?
Voinko käyttää GitLabia OIDC-tarjoajana?
- Redirect URI:
https://my-overleaf-instance.com/oidc/login/callback - Scopes:
openid,profilejaemail
https://gitlab.com/.well-known/openid-configuration tai samasta polusta omassa GitLabissasi, kuten kohdassa Arvojen löytäminen discovery-dokumentin avulla kuvataan. Osoitteessa gitlab.com myöntäjä on https://gitlab.com ilman loppukauttaviivaa.
