Настройка
Внутри модуль OIDC в Overleaf использует библиотеку passport-openidconnect. Если у вас возникают проблемы с настройкой OpenID Connect, стоит прочитать README дляpassport-openidconnect, чтобы понять, какую конфигурацию она ожидает.
Для включения модуля аутентификации OIDC необходима переменная окружения EXTERNAL_AUTH. Она определяет, какие внешние методы аутентификации активированы. Значением этой переменной является список. Если список содержит oidc, будет активирована аутентификация OIDC.
Например: EXTERNAL_AUTH=ldap oidc
При использовании метода аутентификации OIDC пользователь перенаправляется на сайт аутентификации поставщика удостоверений (IdP). Если IdP успешно аутентифицирует пользователя, в базе данных пользователей Overleaf выполняется поиск записи, содержащей поле thirdPartyIdentifiers следующей структуры:
externalUserId должно совпадать с идентификатором пользователя в профиле, возвращаемом сервером IdP (см. переменную окружения OVERLEAF_OIDC_USER_ID_FIELD), а providerId должно совпадать с идентификатором провайдера OIDC (см. OVERLEAF_OIDC_PROVIDER_ID).
Если подходящая запись не найдена, в базе данных выполняется поиск пользователя, основной адрес электронной почты которого совпадает с адресом в профиле пользователя IdP:
- Если такой пользователь найден, поле
thirdPartyIdentifiersобновляется. - Если подходящий пользователь не найден и создание учётных записей JIT не отключено, создаётся новый пользователь с адресом электронной почты и
thirdPartyIdentifiersиз профиля IdP.
/user/settings.
Поиск значений с помощью документа обнаружения
Каждый провайдер OpenID (OP) публикует документ обнаружения (discovery document) по адресу<issuer>/.well-known/openid-configuration. Копируйте значения из него, а не вводите их вручную: одного неверного символа достаточно, чтобы вход перестал работать.
Найдите URL документа обнаружения

Authentik: URL документа обнаружения и issuer провайдера (тестовый экземпляр)
- Keycloak:
https://keycloak.example.com/realms/<realm>/.well-known/openid-configuration - Authentik:
https://authentik.example.com/application/o/<application-slug>/.well-known/openid-configuration
Прочитайте значения

Authentik: эндпоинты провайдера (тестовый экземпляр)
Скопируйте их в variables.env
Проверьте, что Overleaf может связаться с OP
200.Переменные окружения
Значения следующих пяти обязательных переменных можно узнать через эндпоинт.well-known/openid-configuration вашего провайдера OpenID (OP), см. выше.
OVERLEAF_OIDC_ISSUER(обязательно)OVERLEAF_OIDC_AUTHORIZATION_URL(обязательно)OVERLEAF_OIDC_TOKEN_URL(обязательно)OVERLEAF_OIDC_USER_INFO_URL(обязательно)OVERLEAF_OIDC_LOGOUT_URL(обязательно)
OVERLEAF_OIDC_CLIENT_ID(обязательно)OVERLEAF_OIDC_CLIENT_SECRET(обязательно)OVERLEAF_OIDC_SCOPE- По умолчанию:
openid profile email
- По умолчанию:
OVERLEAF_OIDC_PROVIDER_ID- Произвольный идентификатор OP, по умолчанию
oidc.
- Произвольный идентификатор OP, по умолчанию
OVERLEAF_OIDC_PROVIDER_NAME- Название OP, используемое в разделе
Linked Accountsстраницы/user/settings, по умолчаниюOIDC Provider.
- Название OP, используемое в разделе
OVERLEAF_OIDC_IDENTITY_SERVICE_NAME- Отображаемое имя службы идентификации, используемое на странице входа (по умолчанию:
Log in with $OVERLEAF_OIDC_PROVIDER_NAME).
- Отображаемое имя службы идентификации, используемое на странице входа (по умолчанию:
OVERLEAF_OIDC_PROVIDER_DESCRIPTION- Описание OP, используемое в разделе
Linked Accounts(по умолчанию:Log in with $OVERLEAF_OIDC_PROVIDER_NAME).
- Описание OP, используемое в разделе
OVERLEAF_OIDC_PROVIDER_INFO_LINK- URL ссылки
Learn moreв описании OP; по умолчанию ссылкиLearn moreв описании нет.
- URL ссылки
OVERLEAF_OIDC_PROVIDER_HIDE_NOT_LINKED- Не показывать OP на странице
/user/settings, если учётная запись пользователя не связана с OP; по умолчаниюfalse.
- Не показывать OP на странице
OVERLEAF_OIDC_USER_ID_FIELD- Значение этого атрибута будет использоваться Overleaf как внешний идентификатор пользователя; по умолчанию
id. Другие разумные возможные значения —emailиusername(соответствует claim OIDCpreferred_username).
- Значение этого атрибута будет использоваться Overleaf как внешний идентификатор пользователя; по умолчанию
OVERLEAF_OIDC_ALLOWED_EMAIL_DOMAINS- Ограничивает создание учётных записей Just-in-Time (JIT) для пользователей, аутентифицирующихся через OIDC. Если задан список доменных имён через запятую, новая учётная запись будет создана, только если домен адреса электронной почты пользователя совпадает с одним из перечисленных доменов. Если домен не совпадает, администратор должен вручную создать учётную запись пользователя с адресом электронной почты пользователя OIDC, задав либо надёжный случайный пароль, либо, что предпочтительнее, вообще без поля
hashedPassword. Доменные имена могут начинаться с подстановочного знака*.для соответствия поддоменам.- Пример: чтобы разрешить создание учётных записей JIT для пользователей с адресами вида
name@example.comиname@math.example.com:
OVERLEAF_OIDC_ALLOWED_EMAIL_DOMAINS=example.com, *.example.com - Пример: чтобы полностью отключить создание учётных записей JIT:
OVERLEAF_OIDC_ALLOWED_EMAIL_DOMAINS=
- Пример: чтобы разрешить создание учётных записей JIT для пользователей с адресами вида
- Ограничивает создание учётных записей Just-in-Time (JIT) для пользователей, аутентифицирующихся через OIDC. Если задан список доменных имён через запятую, новая учётная запись будет создана, только если домен адреса электронной почты пользователя совпадает с одним из перечисленных доменов. Если домен не совпадает, администратор должен вручную создать учётную запись пользователя с адресом электронной почты пользователя OIDC, задав либо надёжный случайный пароль, либо, что предпочтительнее, вообще без поля
OVERLEAF_OIDC_UPDATE_USER_DETAILS_ON_LOGIN- Если установлено значение
true, при входе обновляются поля пользователяfirst_nameиlast_name, а форма сведений о пользователе на странице/user/settingsотключается.
- Если установлено значение
OVERLEAF_OIDC_IS_ADMIN_FIELDиOVERLEAF_OIDC_IS_ADMIN_FIELD_VALUE- Если заданы обе переменные окружения, в процессе входа устанавливается
user.isAdmin = true, если профиль, возвращённый OP, содержит атрибут, указанный вOVERLEAF_OIDC_IS_ADMIN_FIELD, и его значение либо совпадает сOVERLEAF_OIDC_IS_ADMIN_FIELD_VALUE, либо является массивом, содержащимOVERLEAF_OIDC_IS_ADMIN_FIELD_VALUE(например, claimgroups); в противном случаеuser.isAdminустанавливается вfalse. ЕслиOVERLEAF_OIDC_IS_ADMIN_FIELDравноemail, для проверки совпадения используется значение атрибутаemails[0].value.
- Если заданы обе переменные окружения, в процессе входа устанавливается
https://my-overleaf-instance.com/oidc/login/callback.
Пример файла variables.env
Пример файла variables.env
Пошаговая инструкция: goauthentik
Здесь описана настройка, проверенная с goauthentik. Заменитеhttps://overleaf.example.com на ваш OVERLEAF_SITE_URL, а https://authentik.example.com — на адрес вашего Authentik.
Создайте провайдер
- Client Type:
Confidential. - Redirect URIs (в разделе Protocol settings): добавьте
https://overleaf.example.com/oidc/login/callbackс режимом сопоставленияStrict. - Сразу скопируйте Client ID и Client Secret в
OVERLEAF_OIDC_CLIENT_IDиOVERLEAF_OIDC_CLIENT_SECRET.

Authentik: Client ID и Client Secret нового провайдера
Создайте приложение
overleaf, и выберите провайдер. Slug становится частью issuer: https://authentik.example.com/application/o/overleaf/.Скопируйте URL
Назначьте администраторов (необязательно)
groups в виде массива. Чтобы члены группы Authentik Admins стали администраторами Overleaf:Проверенный variables.env для goauthentik
Проверенный variables.env для goauthentik
Вопросы и ответы
Утверждение (claim) администратора задано, но пользователи не становятся администраторами
Утверждение (claim) администратора задано, но пользователи не становятся администраторами
- Версия. До v6.3.0 Overleaf не считывал пользовательские утверждения, такие как
groups, поэтому работало толькоOVERLEAF_OIDC_IS_ADMIN_FIELD=email. Обновитесь до v6.3.0 или более поздней версии. - Утверждение должно присутствовать в ответе UserInfo. Overleaf считывает утверждение из
OVERLEAF_OIDC_USER_INFO_URL, а не из ID-токена. Если ваш OP добавляет утверждение только в ID-токен, добавьте его также в UserInfo, например с помощью Add to userinfo в маппере Keycloak. - Значение должно совпадать в точности, включая регистр, например
Admins.
Можно ли использовать GitHub в качестве провайдера OIDC?
Можно ли использовать GitHub в качестве провайдера OIDC?
ID token not present in token response.Чтобы пользователи могли входить с помощью своей учётной записи GitHub, используйте провайдер удостоверений, например goauthentik или Keycloak, с GitHub в качестве источника входа, и подключите Overleaf к этому провайдеру через OIDC.Можно ли использовать GitLab в качестве провайдера OIDC?
Можно ли использовать GitLab в качестве провайдера OIDC?
- Redirect URI:
https://my-overleaf-instance.com/oidc/login/callback - Scopes:
openid,profileиemail
https://gitlab.com/.well-known/openid-configuration или по тому же пути на вашем GitLab, как описано в разделе Поиск значений с помощью документа обнаружения. Для gitlab.com issuer — https://gitlab.com, без завершающей косой черты.
