Yapılandırma
Overleaf OIDC modülü dahili olarak passport-openidconnect kütüphanesini kullanır. OpenID Connect’i yapılandırırken sorun yaşıyorsanız, beklediği yapılandırma hakkında fikir edinmek içinpassport-openidconnect README dosyasını okumaya değer.
OIDC kimlik doğrulama modülünü etkinleştirmek için EXTERNAL_AUTH ortam değişkeni gereklidir. Bu ortam değişkeni hangi harici kimlik doğrulama yöntemlerinin etkinleştirileceğini belirtir. Bu değişkenin değeri bir listedir. Liste oidc içeriyorsa OIDC kimlik doğrulaması etkinleştirilir.
Örneğin: EXTERNAL_AUTH=ldap oidc
OIDC kimlik doğrulama yöntemi kullanıldığında, kullanıcı Kimlik Sağlayıcının (IdP) kimlik doğrulama sitesine yönlendirilir. IdP kullanıcının kimliğini başarıyla doğrularsa, Overleaf kullanıcı veritabanında aşağıdaki yapıda bir thirdPartyIdentifiers alanı içeren bir kayıt aranır:
externalUserId, IdP sunucusu tarafından döndürülen profildeki kullanıcı kimliğiyle (OVERLEAF_OIDC_USER_ID_FIELD ortam değişkenine bakın), providerId ise OIDC sağlayıcısının kimliğiyle (OVERLEAF_OIDC_PROVIDER_ID değişkenine bakın) eşleşmelidir.
Eşleşen bir kayıt bulunamazsa, veritabanında birincil e-posta adresi IdP kullanıcı profilindeki e-postayla eşleşen bir kullanıcı aranır:
- Böyle bir kullanıcı bulunursa
thirdPartyIdentifiersalanı güncellenir. - Eşleşen bir kullanıcı bulunamazsa ve JIT hesap oluşturma devre dışı bırakılmamışsa, IdP profilindeki e-posta adresi ve
thirdPartyIdentifiersile yeni bir kullanıcı oluşturulur.
/user/settings sayfasından kaldırılabilir.
Değerleri keşif belgesiyle bulma
Her OpenID Sağlayıcısı (OP),<issuer>/.well-known/openid-configuration adresinde bir keşif (discovery) belgesi yayımlar. Değerleri elle yazmak yerine bu belgeden kopyalayın; tek bir yanlış karakter bile oturum açmayı bozmaya yeter.
Keşif URL'sini bulun

Authentik: bir sağlayıcının keşif URL'si ve yayıncısı (test örneği)
- Keycloak:
https://keycloak.example.com/realms/<realm>/.well-known/openid-configuration - Authentik:
https://authentik.example.com/application/o/<application-slug>/.well-known/openid-configuration
Değerleri okuyun

Authentik: bir sağlayıcının uç noktaları (test örneği)
Bunları variables.env dosyasına kopyalayın
Overleaf'in OP'ye erişebildiğini kontrol edin
200 olmalıdır.Ortam Değişkenleri
Aşağıdaki beş zorunlu değişkenin değerleri, OpenID Sağlayıcınızın (OP).well-known/openid-configuration uç noktası kullanılarak bulunabilir, yukarıya bakın.
OVERLEAF_OIDC_ISSUER(zorunlu)OVERLEAF_OIDC_AUTHORIZATION_URL(zorunlu)OVERLEAF_OIDC_TOKEN_URL(zorunlu)OVERLEAF_OIDC_USER_INFO_URL(zorunlu)OVERLEAF_OIDC_LOGOUT_URL(zorunlu)
OVERLEAF_OIDC_CLIENT_ID(zorunlu)OVERLEAF_OIDC_CLIENT_SECRET(zorunlu)OVERLEAF_OIDC_SCOPE- Varsayılan:
openid profile email
- Varsayılan:
OVERLEAF_OIDC_PROVIDER_ID- OP’nin isteğe bağlı kimliği, varsayılan olarak
oidc.
- OP’nin isteğe bağlı kimliği, varsayılan olarak
OVERLEAF_OIDC_PROVIDER_NAME/user/settingssayfasınınLinked Accountsbölümünde kullanılan OP adı, varsayılan olarakOIDC Provider.
OVERLEAF_OIDC_IDENTITY_SERVICE_NAME- Giriş sayfasında kullanılan kimlik hizmetinin görünen adı (varsayılan:
Log in with $OVERLEAF_OIDC_PROVIDER_NAME).
- Giriş sayfasında kullanılan kimlik hizmetinin görünen adı (varsayılan:
OVERLEAF_OIDC_PROVIDER_DESCRIPTIONLinked Accountsbölümünde kullanılan OP açıklaması (varsayılan:Log in with $OVERLEAF_OIDC_PROVIDER_NAME).
OVERLEAF_OIDC_PROVIDER_INFO_LINK- OP açıklamasındaki
Learn moreURL’si; varsayılan: açıklamadaLearn morebağlantısı yoktur.
- OP açıklamasındaki
OVERLEAF_OIDC_PROVIDER_HIDE_NOT_LINKED- Kullanıcının hesabı OP ile bağlı değilse OP’yi
/user/settingssayfasında gösterme; varsayılanfalse.
- Kullanıcının hesabı OP ile bağlı değilse OP’yi
OVERLEAF_OIDC_USER_ID_FIELD- Bu özniteliğin değeri Overleaf tarafından harici kullanıcı kimliği olarak kullanılır, varsayılan olarak
id. Diğer olası makul değerleremailveusername’dir (preferred_usernameOIDC talebine karşılık gelir).
- Bu özniteliğin değeri Overleaf tarafından harici kullanıcı kimliği olarak kullanılır, varsayılan olarak
OVERLEAF_OIDC_ALLOWED_EMAIL_DOMAINS- OIDC üzerinden kimlik doğrulayan kullanıcılar için Tam Zamanında (JIT) hesap oluşturmayı kısıtlar. Virgülle ayrılmış bir alan adları listesine ayarlanırsa, yeni bir hesap yalnızca kullanıcının e-posta adresinin alan adı listelenen alan adlarından biriyle eşleşirse oluşturulur. Alan adı eşleşmezse, bir yöneticinin kullanıcı hesabını OIDC kullanıcısının e-posta adresini kullanarak, güçlü ve rastgele bir parolayla ya da tercihen
hashedPasswordalanı hiç olmadan manuel olarak oluşturması gerekir. Alan adları, alt alan adlarını eşleştirmek için başta bir*.joker karakteri içerebilir.- Örnek:
name@example.comvename@math.example.comgibi e-posta adreslerine sahip kullanıcılar için JIT hesap oluşturmaya izin vermek için:
OVERLEAF_OIDC_ALLOWED_EMAIL_DOMAINS=example.com, *.example.com - Örnek: JIT hesap oluşturmayı tamamen devre dışı bırakmak için:
OVERLEAF_OIDC_ALLOWED_EMAIL_DOMAINS=
- Örnek:
- OIDC üzerinden kimlik doğrulayan kullanıcılar için Tam Zamanında (JIT) hesap oluşturmayı kısıtlar. Virgülle ayrılmış bir alan adları listesine ayarlanırsa, yeni bir hesap yalnızca kullanıcının e-posta adresinin alan adı listelenen alan adlarından biriyle eşleşirse oluşturulur. Alan adı eşleşmezse, bir yöneticinin kullanıcı hesabını OIDC kullanıcısının e-posta adresini kullanarak, güçlü ve rastgele bir parolayla ya da tercihen
OVERLEAF_OIDC_UPDATE_USER_DETAILS_ON_LOGINtrueolarak ayarlanırsa, oturum açıldığında kullanıcınınfirst_namevelast_namealanlarını günceller ve/user/settingssayfasındaki kullanıcı bilgileri formunu devre dışı bırakır.
OVERLEAF_OIDC_IS_ADMIN_FIELDveOVERLEAF_OIDC_IS_ADMIN_FIELD_VALUE- Her iki ortam değişkeni de ayarlandığında, OP tarafından döndürülen profil
OVERLEAF_OIDC_IS_ADMIN_FIELDile belirtilen özniteliği içeriyorsa ve değeriOVERLEAF_OIDC_IS_ADMIN_FIELD_VALUEile eşleşiyorsa ya daOVERLEAF_OIDC_IS_ADMIN_FIELD_VALUEdeğerini içeren bir diziyse (örneğingroupsclaim’i) oturum açma işlemiuser.isAdmin = trueolarak günceller; aksi takdirdeuser.isAdminfalseolarak ayarlanır.OVERLEAF_OIDC_IS_ADMIN_FIELDdeğeriemailise eşleşme kontrolü içinemails[0].valueözniteliğinin değeri kullanılır.
- Her iki ortam değişkeni de ayarlandığında, OP tarafından döndürülen profil
https://my-overleaf-instance.com/oidc/login/callback şeklindedir.
Örnek variables.env dosyası
Örnek variables.env dosyası
Adım adım: goauthentik
Bu bölüm, goauthentik ile test edilmiş bir kurulumu adım adım anlatır.https://overleaf.example.com adresini kendi OVERLEAF_SITE_URL değerinizle, https://authentik.example.com adresini ise Authentik’inizin adresiyle değiştirin.
Sağlayıcıyı oluşturun
- Client Type:
Confidential. - Redirect URIs (Protocol settings altında):
https://overleaf.example.com/oidc/login/callbackadresiniStricteşleşme moduyla ekleyin. - Client ID ve Client Secret değerlerini şimdi
OVERLEAF_OIDC_CLIENT_IDveOVERLEAF_OIDC_CLIENT_SECRETdeğişkenlerine kopyalayın.

Authentik: yeni bir sağlayıcının Client ID ve Client Secret değerleri
Uygulamayı oluşturun
overleaf, ve sağlayıcıyı seçin. Slug, yayıncının bir parçası olur: https://authentik.example.com/application/o/overleaf/.URL'leri kopyalayın
Yöneticileri eşleyin (isteğe bağlı)
groups claim’i olarak gönderir. Authentik grubu Admins üyelerini Overleaf yöneticisi yapmak için:goauthentik için test edilmiş variables.env
goauthentik için test edilmiş variables.env
Soru&Cevap
Yönetici claim'i ayarlı, ancak kullanıcılar yönetici olmuyor
Yönetici claim'i ayarlı, ancak kullanıcılar yönetici olmuyor
- Sürüm. v6.3.0’dan önce Overleaf,
groupsgibi özel claim’leri okumuyordu; bu nedenle yalnızcaOVERLEAF_OIDC_IS_ADMIN_FIELD=emailçalışıyordu. v6.3.0 veya sonraki bir sürüme yükseltin. - Claim, UserInfo yanıtında bulunmalıdır. Overleaf claim’i ID token’dan değil,
OVERLEAF_OIDC_USER_INFO_URLadresinden okur. OP’niz claim’i yalnızca ID token’a ekliyorsa, onu UserInfo’ya da ekleyin; örneğin bir Keycloak mapper’ında Add to userinfo ile. - Değer, büyük/küçük harf dahil tam olarak eşleşmelidir; örneğin
Admins.
GitHub'ı OIDC sağlayıcısı olarak kullanabilir miyim?
GitHub'ı OIDC sağlayıcısı olarak kullanabilir miyim?
ID token not present in token response hatasıyla başarısız olur.Kullanıcıların GitHub hesaplarıyla oturum açmasını sağlamak için, oturum açma kaynağı olarak GitHub’ı kullanan goauthentik veya Keycloak gibi bir kimlik sağlayıcı kullanın ve Overleaf’i OIDC ile bu sağlayıcıya bağlayın.GitLab'ı OIDC sağlayıcısı olarak kullanabilir miyim?
GitLab'ı OIDC sağlayıcısı olarak kullanabilir miyim?
- Redirect URI:
https://my-overleaf-instance.com/oidc/login/callback - Scopes:
openid,profileveemail
https://gitlab.com/.well-known/openid-configuration adresinden veya kendi GitLab’ınızdaki aynı yoldan okuyun. gitlab.com için issuer, sonunda eğik çizgi olmadan https://gitlab.com değeridir.
