> For the complete documentation index, see [llms.txt](https://overleaf-pro.ayaka.space/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://overleaf-pro.ayaka.space/on-premises/it/configurazione/overleaf-toolkit/authentication/oidc-authentication.md).

# Autenticazione OIDC

Questa funzionalità è sviluppata da [yu-i-i/overleaf-cep](https://github.com/yu-i-i/overleaf-cep). Qui offriamo alcuni documenti per la tua configurazione.

### Configurazione

Internamente, il modulo OIDC di Overleaf utilizza [passport-openidconnect](https://github.com/jaredhanson/passport-openidconnect) libreria. Se hai problemi a configurare OpenID Connect, vale la pena leggere il README per `passport-openidconnect` per farti un'idea della configurazione che si aspetta.

La variabile d'ambiente `EXTERNAL_AUTH` è richiesto per abilitare il modulo di autenticazione OIDC. Questa variabile d'ambiente specifica quali metodi di autenticazione esterni sono attivati. Il valore di questa variabile è una lista. Se la lista include `oidc` allora l'autenticazione OIDC sarà attivata.

Ad esempio: `EXTERNAL_AUTH=ldap oidc`

Quando si utilizza il metodo di autenticazione OIDC, l'utente viene reindirizzato al sito di autenticazione del Provider di identità (IdP). Se l'IdP autentica correttamente l'utente, nel database degli utenti di Overleaf viene cercato un record contenente un `thirdPartyIdentifiers` campo strutturato come segue:

```
thirdPartyIdentifiers: [
  {
    externalUserId: "...",
    externalData: null,
    providerId: "..."
  }
]
```

Il `externalUserId` deve corrispondere all'ID utente nel profilo restituito dal server IdP (vedi la `OVERLEAF_OIDC_USER_ID_FIELD` variabile d'ambiente), e `providerId` deve corrispondere all'ID del provider OIDC (vedi la `OVERLEAF_OIDC_PROVIDER_ID`).

Se non viene trovato alcun record corrispondente, nel database viene cercato un utente con l'indirizzo email principale corrispondente all'email nel profilo utente IdP:

* Se viene trovato un tale utente, il `thirdPartyIdentifiers` campo viene aggiornato.
* Se non viene trovato alcun utente corrispondente e la creazione account JIT non è disabilitata, viene creato un nuovo utente con l'indirizzo email e `thirdPartyIdentifiers` dal profilo IdP.

In entrambi i casi, si dice che l'utente sia 'collegato' all'utente OIDC esterno. L'utente può essere scollegato dal provider OIDC nella `/user/settings` .

#### Variabili d'ambiente

I valori delle seguenti cinque variabili richieste possono essere trovati usando `.well-known/openid-configuration` endpoint del tuo OpenID Provider (OP).

* `OVERLEAF_OIDC_ISSUER` **(obbligatorio)**
* `OVERLEAF_OIDC_AUTHORIZATION_URL` **(obbligatorio)**
* `OVERLEAF_OIDC_TOKEN_URL` **(obbligatorio)**
* `OVERLEAF_OIDC_USER_INFO_URL` **(obbligatorio)**
* `OVERLEAF_OIDC_LOGOUT_URL` **(obbligatorio)**

I valori delle due seguenti variabili richieste saranno forniti dall'amministratore del tuo OP

* `OVERLEAF_OIDC_CLIENT_ID` **(obbligatorio)**
* `OVERLEAF_OIDC_CLIENT_SECRET` **(obbligatorio)**
* `OVERLEAF_OIDC_SCOPE`
  * Predefinito: `openid profile email`
* `OVERLEAF_OIDC_PROVIDER_ID`
  * ID arbitrario dell'OP, predefinito a `oidc`.
* `OVERLEAF_OIDC_PROVIDER_NAME`
  * Il nome dell'OP, usato nella pagina `Account collegati` sezione del `/user/settings` di default `Provider OIDC`.
* `OVERLEAF_OIDC_IDENTITY_SERVICE_NAME`
  * Nome visualizzato per il servizio di identità, usato nella pagina di accesso (predefinito: `Accedi con $OVERLEAF_OIDC_PROVIDER_NAME`).
* `OVERLEAF_OIDC_PROVIDER_DESCRIPTION`
  * Descrizione dell'OP, usata nella `Account collegati` sezione (predefinito: `Accedi con $OVERLEAF_OIDC_PROVIDER_NAME`).
* `OVERLEAF_OIDC_PROVIDER_INFO_LINK`
  * `Scopri di più` URL nella descrizione dell'OP, predefinito: nessun `Scopri di più` link nella descrizione.
* `OVERLEAF_OIDC_PROVIDER_HIDE_NOT_LINKED`
  * Non mostrare l'OP nella `/user/settings` pagina, se l'account dell'utente non è collegato con l'OP, predefinito `false`.
* `OVERLEAF_OIDC_USER_ID_FIELD`
  * Il valore di questo attributo sarà usato da Overleaf come ID utente esterno, predefinito a `id`. Altri possibili valori ragionevoli sono `email` e `nome utente` (corrispondente a `preferred_username` claim OIDC).
* `OVERLEAF_OIDC_ALLOWED_EMAIL_DOMAINS`
  * Limita la creazione account Just-in-Time (JIT) per gli utenti che si autenticano tramite OIDC. Se impostato a un elenco separato da virgole di nomi di dominio, 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 usando l'indirizzo email dell'utente OIDC, con una password casuale forte o, preferibilmente, senza il `hashedPassword` campo affatto. I nomi di dominio possono includere un carattere jolly iniziale `*.` per corrispondere ai sottodomini.
    * Esempio: per consentire la creazione account JIT per utenti con indirizzo email come `name@example.com` e `name@math.example.com`:\
      `OVERLEAF_OIDC_ALLOWED_EMAIL_DOMAINS=example.com, *.example.com`
    * Esempio: per disabilitare completamente la creazione account JIT:\
      `OVERLEAF_OIDC_ALLOWED_EMAIL_DOMAINS=`
* `OVERLEAF_OIDC_UPDATE_USER_DETAILS_ON_LOGIN`
  * Se impostato su `true`, aggiorna il campo utente `first_name` e `last_name` campo al login e disabilita il modulo dei dettagli utente su `/user/settings` .
* `OVERLEAF_OIDC_IS_ADMIN_FIELD` e `OVERLEAF_OIDC_IS_ADMIN_FIELD_VALUE`
  * Quando entrambe le variabili d'ambiente sono impostate, il processo di accesso aggiorna `user.isAdmin = true` se il profilo restituito dall'OP contiene l'attributo specificato da `OVERLEAF_OIDC_IS_ADMIN_FIELD` e il suo valore corrisponde a `OVERLEAF_OIDC_IS_ADMIN_FIELD_VALUE`, altrimenti `user.isAdmin` viene impostato a `false`. Se `OVERLEAF_OIDC_IS_ADMIN_FIELD` è `email` allora il valore dell'attributo `emails[0].value` viene usato per il controllo della corrispondenza.

L'URL di reindirizzamento per il tuo OpenID Provider è `https://my-overleaf-instance.com/oidc/login/callback`.

<details>

<summary>Esempio di file variables.env</summary>

{% code title="variables.env" overflow="wrap" %}

```dotenv
OVERLEAF_APP_NAME="Our Overleaf Instance"

ENABLED_LINKED_FILE_TYPES=project_file,project_output_file,url

# Abilita la generazione delle miniature usando ImageMagick
ENABLE_CONVERSIONS=true

# Disabilita il requisito di conferma dell'email
EMAIL_CONFIRMATION_DISABLED=true

## Nginx
# NGINX_WORKER_PROCESSES=4
# NGINX_WORKER_CONNECTIONS=768

## Imposta per TLS tramite nginx-proxy
# OVERLEAF_BEHIND_PROXY=true
# OVERLEAF_SECURE_COOKIE=true

OVERLEAF_SITE_URL=http://my-overleaf-instance.com
OVERLEAF_NAV_TITLE=La nostra istanza Overleaf
# OVERLEAF_HEADER_IMAGE_URL=http://somewhere.com/mylogo.png
OVERLEAF_ADMIN_EMAIL=support@example.com

OVERLEAF_LEFT_FOOTER=[{"text": "Contatta il tuo team di supporto", "url": "mailto:support@example.com"}]
OVERLEAF_RIGHT_FOOTER=[{"text":"Ciao, sono sulla destra", "url":"https://github.com/yu-i-i/overleaf-cep"}]

OVERLEAF_EMAIL_FROM_ADDRESS=team@example.com
OVERLEAF_EMAIL_SMTP_HOST=smtp.example.com
OVERLEAF_EMAIL_SMTP_PORT=587
OVERLEAF_EMAIL_SMTP_SECURE=false
# OVERLEAF_EMAIL_SMTP_USER=
# OVERLEAF_EMAIL_SMTP_PASS=
# OVERLEAF_EMAIL_SMTP_NAME=
OVERLEAF_EMAIL_SMTP_LOGGER=false
OVERLEAF_EMAIL_SMTP_TLS_REJECT_UNAUTH=true
OVERLEAF_EMAIL_SMTP_IGNORE_TLS=false
OVERLEAF_CUSTOM_EMAIL_FOOTER=Questo sistema è gestito dal dipartimento x

OVERLEAF_PROXY_LEARN=true
NAV_HIDE_POWERED_BY=true

#################
## OIDC per CE ##
#################

EXTERNAL_AUTH=oidc

OVERLEAF_OIDC_PROVIDER_ID=oidc
OVERLEAF_OIDC_ISSUER=https://keycloak.provider.com/realms/example
OVERLEAF_OIDC_AUTHORIZATION_URL=https://keycloak.provider.com/realms/example/protocol/openid-connect/auth
OVERLEAF_OIDC_TOKEN_URL=https://keycloak.provider.com/realms/example/protocol/openid-connect/token
OVERLEAF_OIDC_USER_INFO_URL=https://keycloak.provider.com/realms/example/protocol/openid-connect/userinfo
OVERLEAF_OIDC_LOGOUT_URL=https://keycloak.provider.com/realms/example/protocol/openid-connect/logout
OVERLEAF_OIDC_CLIENT_ID=Overleaf-OIDC
OVERLEAF_OIDC_CLIENT_SECRET=DoNotUseThisATGgaAcTgCcATgGATTACAagGtTCaGcGTAG
OVERLEAF_OIDC_IDENTITY_SERVICE_NAME='Accedi con Keycloak OIDC Provider'
OVERLEAF_OIDC_PROVIDER_NAME=OIDC Keycloak Provider
OVERLEAF_OIDC_PROVIDER_INFO_LINK=https://openid.net
OVERLEAF_OIDC_IS_ADMIN_FIELD=email
OVERLEAF_OIDC_IS_ADMIN_FIELD_VALUE=overleaf.admin@example.com
OVERLEAF_OIDC_UPDATE_USER_DETAILS_ON_LOGIN=false
```

{% endcode %}

</details>


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://overleaf-pro.ayaka.space/on-premises/it/configurazione/overleaf-toolkit/authentication/oidc-authentication.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.