Configuration
En interne, le module OIDC d’Overleaf utilise la bibliothèque passport-openidconnect. Si vous rencontrez des difficultés pour configurer OpenID Connect, il est utile de lire le README depassport-openidconnect pour vous faire une idée de la configuration attendue.
La variable d’environnement EXTERNAL_AUTH est requise pour activer le module d’authentification OIDC. Cette variable d’environnement indique quelles méthodes d’authentification externes sont activées. Sa valeur est une liste. Si la liste contient oidc, l’authentification OIDC sera activée.
Par exemple : EXTERNAL_AUTH=ldap oidc
Avec la méthode d’authentification OIDC, l’utilisateur est redirigé vers le site d’authentification du fournisseur d’identité (IdP). Si l’IdP authentifie l’utilisateur avec succès, la base de données des utilisateurs Overleaf est consultée à la recherche d’un enregistrement contenant un champ thirdPartyIdentifiers structuré comme suit :
externalUserId doit correspondre à l’identifiant utilisateur présent dans le profil renvoyé par le serveur IdP (voir la variable d’environnement OVERLEAF_OIDC_USER_ID_FIELD), et providerId doit correspondre à l’identifiant du fournisseur OIDC (voir OVERLEAF_OIDC_PROVIDER_ID).
Si aucun enregistrement correspondant n’est trouvé, la base de données est parcourue à la recherche d’un utilisateur dont l’adresse e-mail principale correspond à l’e-mail du profil utilisateur de l’IdP :
- Si un tel utilisateur est trouvé, le champ
thirdPartyIdentifiersest mis à jour. - Si aucun utilisateur correspondant n’est trouvé et que la création de compte JIT n’est pas désactivée, un nouvel utilisateur est créé avec l’adresse e-mail et les
thirdPartyIdentifiersissus du profil de l’IdP.
/user/settings.
Trouver les valeurs à l’aide du document de découverte
Chaque fournisseur OpenID (OP) publie un document de découverte à l’adresse<issuer>/.well-known/openid-configuration. Copiez-en les valeurs au lieu de les saisir à la main ; un seul caractère erroné suffit à empêcher la connexion.
Trouver l'URL de découverte

Authentik : l'URL de découverte et l'émetteur d'un fournisseur (instance de test)
- Keycloak :
https://keycloak.example.com/realms/<realm>/.well-known/openid-configuration - Authentik :
https://authentik.example.com/application/o/<application-slug>/.well-known/openid-configuration
Lire les valeurs

Authentik : les points de terminaison d'un fournisseur (instance de test)
Les copier dans variables.env
Vérifier qu'Overleaf peut joindre l'OP
200.Variables d’environnement
Les valeurs des cinq variables obligatoires suivantes se trouvent via le point de terminaison.well-known/openid-configuration de votre fournisseur OpenID (OP), voir ci-dessus.
OVERLEAF_OIDC_ISSUER(obligatoire)OVERLEAF_OIDC_AUTHORIZATION_URL(obligatoire)OVERLEAF_OIDC_TOKEN_URL(obligatoire)OVERLEAF_OIDC_USER_INFO_URL(obligatoire)OVERLEAF_OIDC_LOGOUT_URL(obligatoire)
OVERLEAF_OIDC_CLIENT_ID(obligatoire)OVERLEAF_OIDC_CLIENT_SECRET(obligatoire)OVERLEAF_OIDC_SCOPE- Par défaut :
openid profile email
- Par défaut :
OVERLEAF_OIDC_PROVIDER_ID- Identifiant arbitraire de l’OP, par défaut
oidc.
- Identifiant arbitraire de l’OP, par défaut
OVERLEAF_OIDC_PROVIDER_NAME- Nom de l’OP, utilisé dans la section
Linked Accountsde la page/user/settings, par défautOIDC Provider.
- Nom de l’OP, utilisé dans la section
OVERLEAF_OIDC_IDENTITY_SERVICE_NAME- Nom d’affichage du service d’identité, utilisé sur la page de connexion (par défaut :
Log in with $OVERLEAF_OIDC_PROVIDER_NAME).
- Nom d’affichage du service d’identité, utilisé sur la page de connexion (par défaut :
OVERLEAF_OIDC_PROVIDER_DESCRIPTION- Description de l’OP, utilisée dans la section
Linked Accounts(par défaut :Log in with $OVERLEAF_OIDC_PROVIDER_NAME).
- Description de l’OP, utilisée dans la section
OVERLEAF_OIDC_PROVIDER_INFO_LINK- URL
Learn moredans la description de l’OP ; par défaut, aucun lienLearn moredans la description.
- URL
OVERLEAF_OIDC_PROVIDER_HIDE_NOT_LINKED- Ne pas afficher l’OP sur la page
/user/settingssi le compte de l’utilisateur n’est pas lié à l’OP, par défautfalse.
- Ne pas afficher l’OP sur la page
OVERLEAF_OIDC_USER_ID_FIELD- La valeur de cet attribut sera utilisée par Overleaf comme identifiant utilisateur externe, par défaut
id. D’autres valeurs raisonnables possibles sontemailetusername(correspondant à la claim OIDCpreferred_username).
- La valeur de cet attribut sera utilisée par Overleaf comme identifiant utilisateur externe, par défaut
OVERLEAF_OIDC_ALLOWED_EMAIL_DOMAINS- Restreint la création de compte Just-in-Time (JIT) pour les utilisateurs s’authentifiant via OIDC. Si elle est définie comme une liste de noms de domaine séparés par des virgules, un nouveau compte ne sera créé que si le domaine de l’adresse e-mail de l’utilisateur correspond à l’un des domaines listés. Si le domaine ne correspond pas, un administrateur doit créer manuellement le compte utilisateur avec l’adresse e-mail de l’utilisateur OIDC, soit avec un mot de passe aléatoire robuste, soit, de préférence, sans aucun champ
hashedPassword. Les noms de domaine peuvent commencer par le joker*.pour inclure les sous-domaines.- Exemple : pour autoriser la création de compte JIT pour les utilisateurs ayant une adresse e-mail comme
name@example.cometname@math.example.com:
OVERLEAF_OIDC_ALLOWED_EMAIL_DOMAINS=example.com, *.example.com - Exemple : pour désactiver complètement la création de compte JIT :
OVERLEAF_OIDC_ALLOWED_EMAIL_DOMAINS=
- Exemple : pour autoriser la création de compte JIT pour les utilisateurs ayant une adresse e-mail comme
- Restreint la création de compte Just-in-Time (JIT) pour les utilisateurs s’authentifiant via OIDC. Si elle est définie comme une liste de noms de domaine séparés par des virgules, un nouveau compte ne sera créé que si le domaine de l’adresse e-mail de l’utilisateur correspond à l’un des domaines listés. Si le domaine ne correspond pas, un administrateur doit créer manuellement le compte utilisateur avec l’adresse e-mail de l’utilisateur OIDC, soit avec un mot de passe aléatoire robuste, soit, de préférence, sans aucun champ
OVERLEAF_OIDC_UPDATE_USER_DETAILS_ON_LOGIN- Si elle vaut
true, met à jour les champsfirst_nameetlast_namede l’utilisateur à la connexion, et désactive le formulaire des informations utilisateur sur la page/user/settings.
- Si elle vaut
OVERLEAF_OIDC_IS_ADMIN_FIELDetOVERLEAF_OIDC_IS_ADMIN_FIELD_VALUE- Lorsque ces deux variables d’environnement sont définies, le processus de connexion met à jour
user.isAdmin = truesi le profil renvoyé par l’OP contient l’attribut indiqué parOVERLEAF_OIDC_IS_ADMIN_FIELDet que sa valeur correspond àOVERLEAF_OIDC_IS_ADMIN_FIELD_VALUEou est un tableau contenantOVERLEAF_OIDC_IS_ADMIN_FIELD_VALUE(par exemple le claimgroups) ; sinon,user.isAdminest défini àfalse. SiOVERLEAF_OIDC_IS_ADMIN_FIELDvautemail, la valeur de l’attributemails[0].valueest utilisée pour la vérification.
- Lorsque ces deux variables d’environnement sont définies, le processus de connexion met à jour
https://my-overleaf-instance.com/oidc/login/callback.
Exemple de fichier variables.env
Exemple de fichier variables.env
Guide pas à pas avec goauthentik
Ce guide décrit une configuration testée avec goauthentik. Remplacezhttps://overleaf.example.com par votre OVERLEAF_SITE_URL et https://authentik.example.com par l’adresse de votre Authentik.
Créer le fournisseur
- Client Type :
Confidential. - Redirect URIs (sous Protocol settings) : ajoutez
https://overleaf.example.com/oidc/login/callbackavec le mode de correspondanceStrict. - Copiez dès maintenant Client ID et Client Secret dans
OVERLEAF_OIDC_CLIENT_IDetOVERLEAF_OIDC_CLIENT_SECRET.

Authentik : Client ID et Client Secret d'un nouveau fournisseur
Créer l'application
overleaf, puis sélectionnez le fournisseur. Le slug fait partie de l’émetteur : https://authentik.example.com/application/o/overleaf/.Copier les URL
Associer les administrateurs (facultatif)
groups, sous forme de tableau. Pour que les membres du groupe Authentik Admins deviennent administrateurs d’Overleaf :Fichier variables.env testé pour goauthentik
Fichier variables.env testé pour goauthentik
Questions/réponses
Le claim d'administrateur est défini, mais les utilisateurs ne deviennent pas administrateurs
Le claim d'administrateur est défini, mais les utilisateurs ne deviennent pas administrateurs
- Version. Avant la v6.3.0, Overleaf ne lisait pas les claims personnalisés tels que
groups; seulOVERLEAF_OIDC_IS_ADMIN_FIELD=emailfonctionnait. Passez à la v6.3.0 ou à une version ultérieure. - Le claim doit figurer dans la réponse UserInfo. Overleaf lit le claim depuis
OVERLEAF_OIDC_USER_INFO_URL, et non depuis l’ID token. Si votre OP ajoute le claim uniquement à l’ID token, ajoutez-le également à UserInfo, par exemple avec Add to userinfo sur un mapper Keycloak. - La valeur doit correspondre exactement, y compris la casse, par exemple
Admins.
Puis-je utiliser GitHub comme fournisseur OIDC ?
Puis-je utiliser GitHub comme fournisseur OIDC ?
ID token not present in token response.Pour permettre aux utilisateurs de se connecter avec leur compte GitHub, utilisez un fournisseur d’identité tel que goauthentik ou Keycloak, avec GitHub comme source de connexion, et connectez Overleaf à ce fournisseur via OIDC.Puis-je utiliser GitLab comme fournisseur OIDC ?
Puis-je utiliser GitLab comme fournisseur OIDC ?
- Redirect URI :
https://my-overleaf-instance.com/oidc/login/callback - Scopes :
openid,profileetemail
https://gitlab.com/.well-known/openid-configuration, ou depuis le même chemin sur votre GitLab, comme décrit dans Trouver les valeurs à l’aide du document de découverte. Pour gitlab.com, l’issuer est https://gitlab.com, sans barre oblique finale.
