Configurazione
Internamente, il modulo OIDC di Overleaf utilizza la libreria passport-openidconnect. Se riscontri problemi nella configurazione di OpenID Connect, vale la pena leggere il README dipassport-openidconnect per farti un’idea della configurazione che si aspetta.
La variabile d’ambiente EXTERNAL_AUTH è necessaria per abilitare il modulo di autenticazione OIDC. Questa variabile d’ambiente specifica quali metodi di autenticazione esterna sono attivati. Il valore di questa variabile è un elenco. Se l’elenco include oidc, l’autenticazione OIDC verrà attivata.
Ad esempio: EXTERNAL_AUTH=ldap oidc
Quando si utilizza il metodo di autenticazione OIDC, l’utente viene reindirizzato al sito di autenticazione dell’Identity Provider (IdP). Se l’IdP autentica correttamente l’utente, nel database degli utenti di Overleaf viene cercato un record contenente un campo thirdPartyIdentifiers strutturato come segue:
externalUserId deve corrispondere all’ID utente nel profilo restituito dal server IdP (vedi la variabile d’ambiente OVERLEAF_OIDC_USER_ID_FIELD) e providerId deve corrispondere all’ID del provider OIDC (vedi OVERLEAF_OIDC_PROVIDER_ID).
Se non viene trovato alcun record corrispondente, nel database viene cercato un utente il cui indirizzo email principale corrisponda all’email presente nel profilo utente dell’IdP:
- Se viene trovato un utente di questo tipo, il campo
thirdPartyIdentifiersviene aggiornato. - Se non viene trovato alcun utente corrispondente e la creazione degli account JIT non è disabilitata, viene creato un nuovo utente con l’indirizzo email e i
thirdPartyIdentifiersdel profilo IdP.
/user/settings.
Trovare i valori con il documento di discovery
Ogni OpenID Provider (OP) pubblica un documento di discovery all’indirizzo<issuer>/.well-known/openid-configuration. Copia i valori da lì invece di digitarli a mano; basta un carattere sbagliato per compromettere l’accesso.
Trova l'URL di discovery

Authentik: l'URL di discovery e l'issuer di un provider (istanza di 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
Leggi i valori

Authentik: gli endpoint di un provider (istanza di test)
Copiali in variables.env
Verifica che Overleaf possa raggiungere l'OP
200.Variabili d’ambiente
I valori delle seguenti cinque variabili obbligatorie si possono trovare tramite l’endpoint.well-known/openid-configuration del tuo OpenID Provider (OP), come descritto sopra.
OVERLEAF_OIDC_ISSUER(obbligatoria)OVERLEAF_OIDC_AUTHORIZATION_URL(obbligatoria)OVERLEAF_OIDC_TOKEN_URL(obbligatoria)OVERLEAF_OIDC_USER_INFO_URL(obbligatoria)OVERLEAF_OIDC_LOGOUT_URL(obbligatoria)
OVERLEAF_OIDC_CLIENT_ID(obbligatoria)OVERLEAF_OIDC_CLIENT_SECRET(obbligatoria)OVERLEAF_OIDC_SCOPE- Predefinito:
openid profile email
- Predefinito:
OVERLEAF_OIDC_PROVIDER_ID- ID arbitrario dell’OP, predefinito
oidc.
- ID arbitrario dell’OP, predefinito
OVERLEAF_OIDC_PROVIDER_NAME- Il nome dell’OP, utilizzato nella sezione
Linked Accountsdella pagina/user/settings, predefinitoOIDC Provider.
- Il nome dell’OP, utilizzato nella sezione
OVERLEAF_OIDC_IDENTITY_SERVICE_NAME- Nome visualizzato del servizio di identità, utilizzato nella pagina di accesso (predefinito:
Log in with $OVERLEAF_OIDC_PROVIDER_NAME).
- Nome visualizzato del servizio di identità, utilizzato nella pagina di accesso (predefinito:
OVERLEAF_OIDC_PROVIDER_DESCRIPTION- Descrizione dell’OP, utilizzata nella sezione
Linked Accounts(predefinito:Log in with $OVERLEAF_OIDC_PROVIDER_NAME).
- Descrizione dell’OP, utilizzata nella sezione
OVERLEAF_OIDC_PROVIDER_INFO_LINK- URL
Learn morenella descrizione dell’OP; predefinito: nessun linkLearn morenella descrizione.
- URL
OVERLEAF_OIDC_PROVIDER_HIDE_NOT_LINKED- Non mostra l’OP nella pagina
/user/settingsse l’account dell’utente non è collegato all’OP; predefinitofalse.
- Non mostra l’OP nella pagina
OVERLEAF_OIDC_USER_ID_FIELD- Il valore di questo attributo verrà utilizzato da Overleaf come ID utente esterno; predefinito
id. Altri valori ragionevoli possibili sonoemaileusername(corrispondente al claim OIDCpreferred_username).
- Il valore di questo attributo verrà utilizzato da Overleaf come ID utente esterno; predefinito
OVERLEAF_OIDC_ALLOWED_EMAIL_DOMAINS- Limita la creazione degli account Just-in-Time (JIT) per gli utenti che si autenticano tramite OIDC. Se impostata su un elenco di nomi di dominio separati da virgole, un nuovo account verrà creato solo se il dominio dell’indirizzo email dell’utente corrisponde a uno dei domini elencati. Se il dominio non corrisponde, un amministratore deve creare manualmente l’account utente utilizzando l’indirizzo email dell’utente OIDC, con una password casuale robusta oppure, preferibilmente, senza alcun campo
hashedPassword. I nomi di dominio possono includere un carattere jolly iniziale*.per corrispondere ai sottodomini.- Esempio: per consentire la creazione di account JIT per utenti con indirizzi email come
name@example.comename@math.example.com:
OVERLEAF_OIDC_ALLOWED_EMAIL_DOMAINS=example.com, *.example.com - Esempio: per disabilitare completamente la creazione di account JIT:
OVERLEAF_OIDC_ALLOWED_EMAIL_DOMAINS=
- Esempio: per consentire la creazione di account JIT per utenti con indirizzi email come
- Limita la creazione degli account Just-in-Time (JIT) per gli utenti che si autenticano tramite OIDC. Se impostata su un elenco di nomi di dominio separati da virgole, un nuovo account verrà creato solo se il dominio dell’indirizzo email dell’utente corrisponde a uno dei domini elencati. Se il dominio non corrisponde, un amministratore deve creare manualmente l’account utente utilizzando l’indirizzo email dell’utente OIDC, con una password casuale robusta oppure, preferibilmente, senza alcun campo
OVERLEAF_OIDC_UPDATE_USER_DETAILS_ON_LOGIN- Se impostata su
true, aggiorna i campifirst_nameelast_namedell’utente all’accesso e disabilita il modulo dei dati utente nella pagina/user/settings.
- Se impostata su
OVERLEAF_OIDC_IS_ADMIN_FIELDeOVERLEAF_OIDC_IS_ADMIN_FIELD_VALUE- Quando entrambe le variabili d’ambiente sono impostate, il processo di accesso imposta
user.isAdmin = truese il profilo restituito dall’OP contiene l’attributo specificato daOVERLEAF_OIDC_IS_ADMIN_FIELDe il suo valore corrisponde aOVERLEAF_OIDC_IS_ADMIN_FIELD_VALUEoppure è un array che contieneOVERLEAF_OIDC_IS_ADMIN_FIELD_VALUE(ad esempio il claimgroups); altrimentiuser.isAdminviene impostato sufalse. SeOVERLEAF_OIDC_IS_ADMIN_FIELDèemail, per la verifica della corrispondenza viene utilizzato il valore dell’attributoemails[0].value.
- Quando entrambe le variabili d’ambiente sono impostate, il processo di accesso imposta
https://my-overleaf-instance.com/oidc/login/callback.
File variables.env di esempio
File variables.env di esempio
Passo dopo passo: goauthentik
Questa guida illustra una configurazione testata con goauthentik. Sostituiscihttps://overleaf.example.com con il tuo OVERLEAF_SITE_URL e https://authentik.example.com con l’indirizzo della tua istanza Authentik.
Crea il provider
- Client Type:
Confidential. - Redirect URIs (sotto Protocol settings): aggiungi
https://overleaf.example.com/oidc/login/callbackcon la modalità di corrispondenzaStrict. - Copia subito Client ID e Client Secret in
OVERLEAF_OIDC_CLIENT_IDeOVERLEAF_OIDC_CLIENT_SECRET.

Authentik: Client ID e Client Secret di un nuovo provider
Crea l'applicazione
overleaf, e seleziona il provider. Lo slug diventa parte dell’issuer: https://authentik.example.com/application/o/overleaf/.Copia gli URL
Mappa gli amministratori (facoltativo)
groups, un array. Per rendere amministratori di Overleaf i membri del gruppo Authentik Admins:variables.env testato per goauthentik
variables.env testato per goauthentik
Domande e risposte
Il claim di amministratore è impostato, ma gli utenti non diventano amministratori
Il claim di amministratore è impostato, ma gli utenti non diventano amministratori
- Versione. Prima della v6.3.0, Overleaf non leggeva claim personalizzati come
groups, quindi funzionava soloOVERLEAF_OIDC_IS_ADMIN_FIELD=email. Aggiorna alla v6.3.0 o successiva. - Il claim deve essere presente nella risposta UserInfo. Overleaf legge il claim da
OVERLEAF_OIDC_USER_INFO_URL, non dall’ID token. Se il tuo OP aggiunge il claim solo all’ID token, aggiungilo anche a UserInfo, ad esempio con Add to userinfo in un mapper di Keycloak. - Il valore deve corrispondere esattamente, comprese maiuscole e minuscole, ad esempio
Admins.
Posso usare GitHub come provider OIDC?
Posso usare GitHub come provider OIDC?
ID token not present in token response.Per consentire agli utenti di accedere con il proprio account GitHub, usa un identity provider come goauthentik o Keycloak, con GitHub come sorgente di accesso, e collega Overleaf a quel provider tramite OIDC.Posso usare GitLab come provider OIDC?
Posso usare GitLab come provider OIDC?
- Redirect URI:
https://my-overleaf-instance.com/oidc/login/callback - Scopes:
openid,profileeemail
https://gitlab.com/.well-known/openid-configuration, o dallo stesso percorso sul tuo GitLab, come descritto in Trovare i valori con il documento di discovery. Per gitlab.com, l’issuer è https://gitlab.com, senza barra finale.
