> ## Documentation Index
> Fetch the complete documentation index at: https://ayakaleaf-pro.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# OIDC-godkendelse

<Info>
  Denne funktion er udviklet af [yu-i-i/overleaf-cep](https://github.com/yu-i-i/overleaf-cep). Her stiller vi noget dokumentation til rådighed for din konfiguration.
</Info>

### Konfiguration

Internt bruger Overleafs OIDC-modul biblioteket [passport-openidconnect](https://github.com/jaredhanson/passport-openidconnect). Hvis du har problemer med at konfigurere OpenID Connect, er det en god idé at læse README-filen for `passport-openidconnect` for at få en fornemmelse af den konfiguration, det forventer.

Miljøvariablen `EXTERNAL_AUTH` er påkrævet for at aktivere OIDC-godkendelsesmodulet. Denne miljøvariabel angiver, hvilke eksterne godkendelsesmetoder der er aktiveret. Variablens værdi er en liste. Hvis listen indeholder `oidc`, aktiveres OIDC-godkendelse.

For eksempel: `EXTERNAL_AUTH=ldap oidc`

Når OIDC-godkendelsesmetoden bruges, omdirigeres brugeren til identitetsudbyderens (IdP) godkendelsesside. Hvis IdP'en godkender brugeren, kontrolleres Overleafs brugerdatabase for en post, der indeholder et `thirdPartyIdentifiers`-felt med følgende struktur:

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

`externalUserId` skal matche bruger-ID'et i den profil, som IdP-serveren returnerer (se miljøvariablen `OVERLEAF_OIDC_USER_ID_FIELD`), og `providerId` skal matche ID'et for OIDC-udbyderen (se `OVERLEAF_OIDC_PROVIDER_ID`).

Hvis der ikke findes en matchende post, søges der i databasen efter en bruger, hvis primære e-mailadresse matcher e-mailadressen i IdP-brugerprofilen:

* Hvis en sådan bruger findes, opdateres feltet `thirdPartyIdentifiers`.
* Hvis der ikke findes en matchende bruger, og JIT-kontooprettelse ikke er deaktiveret, oprettes en ny bruger med e-mailadressen og `thirdPartyIdentifiers` fra IdP-profilen.

I begge tilfælde siges brugeren at være "linket" til den eksterne OIDC-bruger. Brugeren kan fjerne linket til OIDC-udbyderen på siden `/user/settings`.

#### Find værdierne med discovery-dokumentet

Alle OpenID-udbydere (OP) offentliggør et discovery-dokument på `<issuer>/.well-known/openid-configuration`. Kopiér værdierne derfra i stedet for at skrive dem i hånden; ét forkert tegn er nok til at ødelægge login.

<Steps>
  <Step title="Find discovery-URL'en">
    Din OP viser den på siden for den klient (udbyder), du har oprettet til Overleaf. I Authentik skal du åbne **Applications > Providers**, vælge udbyderen og kigge efter **OpenID Configuration URL** og **OpenID Configuration Issuer**:

    <Frame caption="Authentik: discovery-URL'en og issueren for en udbyder (testinstans)">
      <img src="https://mintcdn.com/ayakaleaf-pro/TjqwH4XzxYAkHStq/images/on-premises/oidc-authentik-provider.png?fit=max&auto=format&n=TjqwH4XzxYAkHStq&q=85&s=e3cb5603d959665472b53e39b58b2775" alt="" width="1280" height="633" data-path="images/on-premises/oidc-authentik-provider.png" />
    </Frame>

    URL'en ser typisk sådan ud:

    * Keycloak: `https://keycloak.example.com/realms/<realm>/.well-known/openid-configuration`
    * Authentik: `https://authentik.example.com/application/o/<application-slug>/.well-known/openid-configuration`
  </Step>

  <Step title="Aflæs værdierne">
    Åbn URL'en i en browser, eller kør følgende på Overleaf-serveren:

    ```shell theme={null}
    curl -s https://authentik.example.com/application/o/overleaf/.well-known/openid-configuration \
      | jq '{issuer, authorization_endpoint, token_endpoint, userinfo_endpoint, end_session_endpoint}'
    ```

    Svaret fra Authentik ser sådan ud:

    ```json theme={null}
    {
      "issuer": "https://authentik.example.com/application/o/overleaf/",
      "authorization_endpoint": "https://authentik.example.com/application/o/authorize/",
      "token_endpoint": "https://authentik.example.com/application/o/token/",
      "userinfo_endpoint": "https://authentik.example.com/application/o/userinfo/",
      "end_session_endpoint": "https://authentik.example.com/application/o/overleaf/end-session/"
    }
    ```

    Authentik viser også disse URL'er længere nede på udbydersiden:

    <Frame caption="Authentik: endpoints for en udbyder (testinstans)">
      <img src="https://mintcdn.com/ayakaleaf-pro/TjqwH4XzxYAkHStq/images/on-premises/oidc-authentik-endpoints.png?fit=max&auto=format&n=TjqwH4XzxYAkHStq&q=85&s=55d130cbbbf27fd11aebafa1ab3f090c" alt="" width="1280" height="633" data-path="images/on-premises/oidc-authentik-endpoints.png" />
    </Frame>
  </Step>

  <Step title="Kopiér dem ind i `variables.env`">
    | Felt i discovery-dokumentet | Miljøvariabel |
    | - | - |
    | `issuer` | `OVERLEAF_OIDC_ISSUER` |
    | `authorization_endpoint` | `OVERLEAF_OIDC_AUTHORIZATION_URL` |
    | `token_endpoint` | `OVERLEAF_OIDC_TOKEN_URL` |
    | `userinfo_endpoint` | `OVERLEAF_OIDC_USER_INFO_URL` |
    | `end_session_endpoint` | `OVERLEAF_OIDC_LOGOUT_URL` |

    ```dotenv theme={null}
    OVERLEAF_OIDC_ISSUER=https://authentik.example.com/application/o/overleaf/
    OVERLEAF_OIDC_AUTHORIZATION_URL=https://authentik.example.com/application/o/authorize/
    OVERLEAF_OIDC_TOKEN_URL=https://authentik.example.com/application/o/token/
    OVERLEAF_OIDC_USER_INFO_URL=https://authentik.example.com/application/o/userinfo/
    OVERLEAF_OIDC_LOGOUT_URL=https://authentik.example.com/application/o/overleaf/end-session/
    ```
  </Step>

  <Step title="Kontrollér, at Overleaf kan nå OP'en">
    Overleaf kalder token- og userinfo-endpointene inde fra sin container, så OP'en skal kunne nås derfra, ikke kun fra din browser:

    ```shell theme={null}
    docker exec sharelatex curl -sS -o /dev/null -w "%{http_code}\n" \
      https://authentik.example.com/application/o/overleaf/.well-known/openid-configuration
    ```

    Det bør udskrive `200`.
  </Step>
</Steps>

<Warning>
  Kopiér `issuer` nøjagtigt, inklusive den afsluttende skråstreg. Overleaf sammenligner den tegn for tegn med issueren i ID-tokenet; enhver forskel får alle OIDC-logins til at mislykkes med:

  `{"message":{"message":"ID token not issued by expected OpenID provider."}}`

  I Authentik hører issueren til applikationen (`.../application/o/<application-slug>/`). Den er ikke adressen på Authentik-serveren, selvom authorize-, token- og userinfo-URL'erne deles af alle applikationer.
</Warning>

#### Miljøvariabler

Værdierne for de følgende fem påkrævede variabler kan findes via endpointet `.well-known/openid-configuration` hos din OpenID-udbyder (OP), se ovenfor.

* `OVERLEAF_OIDC_ISSUER` <strong>(påkrævet)</strong>
* `OVERLEAF_OIDC_AUTHORIZATION_URL` <strong>(påkrævet)</strong>
* `OVERLEAF_OIDC_TOKEN_URL` <strong>(påkrævet)</strong>
* `OVERLEAF_OIDC_USER_INFO_URL` <strong>(påkrævet)</strong>
* `OVERLEAF_OIDC_LOGOUT_URL` <strong>(påkrævet)</strong>

Værdierne for de følgende to påkrævede variabler leveres af administratoren af din OP

* `OVERLEAF_OIDC_CLIENT_ID` <strong>(påkrævet)</strong>
* `OVERLEAF_OIDC_CLIENT_SECRET` <strong>(påkrævet)</strong>
* `OVERLEAF_OIDC_SCOPE`
  * Standard: `openid profile email`
* `OVERLEAF_OIDC_PROVIDER_ID`
  * Vilkårligt ID for OP'en, standard er `oidc`.
* `OVERLEAF_OIDC_PROVIDER_NAME`
  * Navnet på OP'en, der bruges i afsnittet `Linked Accounts` på siden `/user/settings`, standard er `OIDC Provider`.
* `OVERLEAF_OIDC_IDENTITY_SERVICE_NAME`
  * Visningsnavn for identitetstjenesten, der bruges på login-siden (standard: `Log in with $OVERLEAF_OIDC_PROVIDER_NAME`).
* `OVERLEAF_OIDC_PROVIDER_DESCRIPTION`
  * Beskrivelse af OP'en, der bruges i afsnittet `Linked Accounts` (standard: `Log in with $OVERLEAF_OIDC_PROVIDER_NAME`).
* `OVERLEAF_OIDC_PROVIDER_INFO_LINK`
  * `Learn more`-URL i beskrivelsen af OP'en, standard: intet `Learn more`-link i beskrivelsen.
* `OVERLEAF_OIDC_PROVIDER_HIDE_NOT_LINKED`
  * Vis ikke OP'en på siden `/user/settings`, hvis brugerens konto ikke er linket til OP'en, standard `false`.
* `OVERLEAF_OIDC_USER_ID_FIELD`
  * Værdien af denne attribut bruges af Overleaf som eksternt bruger-ID, standard er `id`. Andre mulige fornuftige værdier er `email` og `username` (svarende til OIDC-claimet `preferred_username`).
* `OVERLEAF_OIDC_ALLOWED_EMAIL_DOMAINS`
  * Begrænser Just-in-Time-kontooprettelse (JIT) for brugere, der godkendes via OIDC. Hvis variablen sættes til en kommasepareret liste over domænenavne, oprettes en ny konto kun, hvis domænet i brugerens e-mailadresse matcher et af de angivne domæner. Hvis domænet ikke matcher, skal en administrator manuelt oprette brugerkontoen med OIDC-brugerens e-mailadresse, enten med en stærk tilfældig adgangskode eller helst helt uden feltet `hashedPassword`. Domænenavne kan indeholde et foranstillet `*.`-jokertegn for at matche underdomæner.
    * Eksempel: For at tillade JIT-kontooprettelse for brugere med e-mailadresser som `name@example.com` og `name@math.example.com`:\
      `OVERLEAF_OIDC_ALLOWED_EMAIL_DOMAINS=example.com, *.example.com`
    * Eksempel: For helt at deaktivere JIT-kontooprettelse:\
      `OVERLEAF_OIDC_ALLOWED_EMAIL_DOMAINS=`
* `OVERLEAF_OIDC_UPDATE_USER_DETAILS_ON_LOGIN`
  * Hvis den er sat til `true`, opdateres brugerens felter `first_name` og `last_name` ved login, og formularen med brugeroplysninger på siden `/user/settings` deaktiveres.
* `OVERLEAF_OIDC_IS_ADMIN_FIELD` og `OVERLEAF_OIDC_IS_ADMIN_FIELD_VALUE`
  * Når begge miljøvariabler er sat, opdaterer login-processen `user.isAdmin = true`, hvis den profil, OP'en returnerer, indeholder den attribut, der er angivet med `OVERLEAF_OIDC_IS_ADMIN_FIELD`, og dens værdi enten matcher `OVERLEAF_OIDC_IS_ADMIN_FIELD_VALUE` eller er et array, der indeholder `OVERLEAF_OIDC_IS_ADMIN_FIELD_VALUE` (for eksempel claimet `groups`); ellers sættes `user.isAdmin` til `false`. Hvis `OVERLEAF_OIDC_IS_ADMIN_FIELD` er `email`, bruges værdien af attributten `emails[0].value` til matchkontrollen.

Omdirigerings-URL'en til din OpenID-udbyder er `https://my-overleaf-instance.com/oidc/login/callback`.

<Accordion title="Eksempel på variables.env-fil">
  ```dotenv title="variables.env" wrap theme={null}
  OVERLEAF_APP_NAME="Our Overleaf Instance"

  ENABLED_LINKED_FILE_TYPES=project_file,project_output_file,url

  # Enables Thumbnail generation using ImageMagick
  ENABLE_CONVERSIONS=true

  # Disables email confirmation requirement
  EMAIL_CONFIRMATION_DISABLED=true

  ## Nginx
  # NGINX_WORKER_PROCESSES=4
  # NGINX_WORKER_CONNECTIONS=768

  ## Set for TLS via nginx-proxy
  # OVERLEAF_BEHIND_PROXY=true
  # OVERLEAF_SECURE_COOKIE=true

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

  OVERLEAF_LEFT_FOOTER=[{"text": "Contact your support team", "url": "mailto:support@example.com"}]
  OVERLEAF_RIGHT_FOOTER=[{"text":"Hello, I am on the Right", "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=This system is run by department x

  OVERLEAF_PROXY_LEARN=true
  NAV_HIDE_POWERED_BY=true

  #################
  ## OIDC for 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='Log in with 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
  ```
</Accordion>

## Trin for trin: goauthentik

Denne vejledning gennemgår en opsætning, der er testet mod [goauthentik](https://goauthentik.io/). Erstat `https://overleaf.example.com` med din `OVERLEAF_SITE_URL` og `https://authentik.example.com` med adressen på din Authentik.

<Steps>
  <Step title="Opret udbyderen">
    I Authentik skal du åbne **Applications > Providers**, klikke på **New Provider**, vælge **OAuth2/OpenID Provider** og klikke på **Next**.

    * **Client Type**: `Confidential`.
    * **Redirect URIs** (under **Protocol settings**): tilføj `https://overleaf.example.com/oidc/login/callback` med matchtilstanden `Strict`.
    * Kopiér **Client ID** og **Client Secret** nu, ind i `OVERLEAF_OIDC_CLIENT_ID` og `OVERLEAF_OIDC_CLIENT_SECRET`.

    <Frame caption="Authentik: Client ID og Client Secret for en ny udbyder">
      <img src="https://mintcdn.com/ayakaleaf-pro/TjqwH4XzxYAkHStq/images/on-premises/oidc-authentik-create.png?fit=max&auto=format&n=TjqwH4XzxYAkHStq&q=85&s=f127a92eaf3063714e9af515fe97c263" alt="" width="1120" height="808" data-path="images/on-premises/oidc-authentik-create.png" />
    </Frame>

    <Warning>
      Authentik viser kun client secret, mens du opretter udbyderen. Senere tilbyder redigeringsformularen kun **Modify**, som erstatter secret med en ny.
    </Warning>
  </Step>

  <Step title="Opret applikationen">
    Åbn **Applications > Applications**, opret en ny applikation, giv den et navn og en slug, for eksempel `overleaf`, og vælg udbyderen. Sluggen bliver en del af issueren: `https://authentik.example.com/application/o/overleaf/`.
  </Step>

  <Step title="Kopiér URL'erne">
    Følg [Find værdierne med discovery-dokumentet](#find-værdierne-med-discovery-dokumentet) ovenfor for at udfylde de fem URL'er.
  </Step>

  <Step title="Tilknyt administratorerne (valgfrit)">
    Authentik sender brugerens grupper som claimet `groups`, et array. Sådan gør du medlemmerne af Authentik-gruppen `Admins` til administratorer i Overleaf:

    ```dotenv theme={null}
    OVERLEAF_OIDC_IS_ADMIN_FIELD=groups
    OVERLEAF_OIDC_IS_ADMIN_FIELD_VALUE=Admins
    ```

    <Warning>
      Administratorflaget opdateres ved hvert OIDC-login. Med et forkert felt eller en forkert værdi mister alle administratorer, der logger ind via OIDC, deres administratorrettigheder, inklusive den administrator, der blev oprettet i launchpad. Test tilknytningen med en anden administratorkonto først.
    </Warning>
  </Step>
</Steps>

<Accordion title="Testet variables.env til goauthentik">
  ```dotenv title="variables.env" wrap theme={null}
  EXTERNAL_AUTH=oidc
  OVERLEAF_OIDC_PROVIDER_ID=authentik
  OVERLEAF_OIDC_IDENTITY_SERVICE_NAME=Log in with Authentik
  OVERLEAF_OIDC_ISSUER=https://authentik.example.com/application/o/overleaf/
  OVERLEAF_OIDC_AUTHORIZATION_URL=https://authentik.example.com/application/o/authorize/
  OVERLEAF_OIDC_TOKEN_URL=https://authentik.example.com/application/o/token/
  OVERLEAF_OIDC_USER_INFO_URL=https://authentik.example.com/application/o/userinfo/
  OVERLEAF_OIDC_LOGOUT_URL=https://authentik.example.com/application/o/overleaf/end-session/
  OVERLEAF_OIDC_CLIENT_ID=<Client ID>
  OVERLEAF_OIDC_CLIENT_SECRET=<Client Secret>
  OVERLEAF_OIDC_USER_ID_FIELD=username
  OVERLEAF_OIDC_IS_ADMIN_FIELD=groups
  OVERLEAF_OIDC_IS_ADMIN_FIELD_VALUE=Admins
  OVERLEAF_OIDC_UPDATE_USER_DETAILS_ON_LOGIN=true
  ```
</Accordion>


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.