Configuração
Internamente, o módulo OIDC do Overleaf usa a biblioteca passport-openidconnect. Se você estiver tendo problemas para configurar o OpenID Connect, vale a pena ler o README dopassport-openidconnect para ter uma ideia da configuração que ele espera.
A variável de ambiente EXTERNAL_AUTH é necessária para ativar o módulo de autenticação OIDC. Esta variável de ambiente especifica quais métodos de autenticação externa estão ativados. O valor desta variável é uma lista. Se a lista incluir oidc, a autenticação OIDC será ativada.
Por exemplo: EXTERNAL_AUTH=ldap oidc
Ao usar o método de autenticação OIDC, o usuário é redirecionado para o site de autenticação do provedor de identidade (IdP). Se o IdP autenticar o usuário com sucesso, o banco de dados de usuários do Overleaf é verificado em busca de um registro que contenha um campo thirdPartyIdentifiers estruturado da seguinte forma:
externalUserId deve corresponder ao ID de usuário no perfil retornado pelo servidor do IdP (consulte a variável de ambiente OVERLEAF_OIDC_USER_ID_FIELD), e o providerId deve corresponder ao ID do provedor OIDC (consulte OVERLEAF_OIDC_PROVIDER_ID).
Se nenhum registro correspondente for encontrado, o banco de dados é pesquisado em busca de um usuário cujo endereço de e-mail principal corresponda ao e-mail no perfil de usuário do IdP:
- Se esse usuário for encontrado, o campo
thirdPartyIdentifiersé atualizado. - Se nenhum usuário correspondente for encontrado e a criação de contas JIT não estiver desativada, um novo usuário é criado com o endereço de e-mail e os
thirdPartyIdentifiersdo perfil do IdP.
/user/settings.
Encontrando os valores com o documento de descoberta
Todo provedor OpenID (OP) publica um documento de descoberta em<issuer>/.well-known/openid-configuration. Copie os valores dele em vez de digitá-los manualmente; um único caractere errado basta para quebrar o login.
Encontrar a URL de descoberta

Authentik: a URL de descoberta e o issuer de um provedor (instância de teste)
- Keycloak:
https://keycloak.example.com/realms/<realm>/.well-known/openid-configuration - Authentik:
https://authentik.example.com/application/o/<application-slug>/.well-known/openid-configuration
Ler os valores

Authentik: os endpoints de um provedor (instância de teste)
Copiá-los para o variables.env
Verificar se o Overleaf consegue alcançar o OP
200.Variáveis de ambiente
Os valores das cinco variáveis obrigatórias a seguir podem ser encontrados usando o endpoint.well-known/openid-configuration do seu provedor OpenID (OP), veja acima.
OVERLEAF_OIDC_ISSUER(obrigatória)OVERLEAF_OIDC_AUTHORIZATION_URL(obrigatória)OVERLEAF_OIDC_TOKEN_URL(obrigatória)OVERLEAF_OIDC_USER_INFO_URL(obrigatória)OVERLEAF_OIDC_LOGOUT_URL(obrigatória)
OVERLEAF_OIDC_CLIENT_ID(obrigatória)OVERLEAF_OIDC_CLIENT_SECRET(obrigatória)OVERLEAF_OIDC_SCOPE- Padrão:
openid profile email
- Padrão:
OVERLEAF_OIDC_PROVIDER_ID- ID arbitrário do OP; o padrão é
oidc.
- ID arbitrário do OP; o padrão é
OVERLEAF_OIDC_PROVIDER_NAME- O nome do OP, usado na seção
Linked Accountsda página/user/settings; o padrão éOIDC Provider.
- O nome do OP, usado na seção
OVERLEAF_OIDC_IDENTITY_SERVICE_NAME- Nome de exibição do serviço de identidade, usado na página de login (padrão:
Log in with $OVERLEAF_OIDC_PROVIDER_NAME).
- Nome de exibição do serviço de identidade, usado na página de login (padrão:
OVERLEAF_OIDC_PROVIDER_DESCRIPTION- Descrição do OP, usada na seção
Linked Accounts(padrão:Log in with $OVERLEAF_OIDC_PROVIDER_NAME).
- Descrição do OP, usada na seção
OVERLEAF_OIDC_PROVIDER_INFO_LINK- URL de
Learn morena descrição do OP; padrão: nenhum linkLearn morena descrição.
- URL de
OVERLEAF_OIDC_PROVIDER_HIDE_NOT_LINKED- Não mostrar o OP na página
/user/settingsse a conta do usuário não estiver vinculada ao OP; padrãofalse.
- Não mostrar o OP na página
OVERLEAF_OIDC_USER_ID_FIELD- O valor deste atributo será usado pelo Overleaf como ID de usuário externo; o padrão é
id. Outros valores razoáveis possíveis sãoemaileusername(correspondente à claim OIDCpreferred_username).
- O valor deste atributo será usado pelo Overleaf como ID de usuário externo; o padrão é
OVERLEAF_OIDC_ALLOWED_EMAIL_DOMAINS- Restringe a criação de contas Just-in-Time (JIT) para usuários que se autenticam via OIDC. Se definida como uma lista de nomes de domínio separados por vírgulas, uma nova conta só será criada se o domínio do endereço de e-mail do usuário corresponder a um dos domínios listados. Se o domínio não corresponder, um administrador deverá criar manualmente a conta do usuário usando o endereço de e-mail do usuário OIDC, com uma senha aleatória forte ou, de preferência, sem o campo
hashedPassword. Os nomes de domínio podem incluir um curinga*.no início para corresponder a subdomínios.- Exemplo: para permitir a criação de contas JIT para usuários com endereços de e-mail como
name@example.comename@math.example.com:
OVERLEAF_OIDC_ALLOWED_EMAIL_DOMAINS=example.com, *.example.com - Exemplo: para desativar completamente a criação de contas JIT:
OVERLEAF_OIDC_ALLOWED_EMAIL_DOMAINS=
- Exemplo: para permitir a criação de contas JIT para usuários com endereços de e-mail como
- Restringe a criação de contas Just-in-Time (JIT) para usuários que se autenticam via OIDC. Se definida como uma lista de nomes de domínio separados por vírgulas, uma nova conta só será criada se o domínio do endereço de e-mail do usuário corresponder a um dos domínios listados. Se o domínio não corresponder, um administrador deverá criar manualmente a conta do usuário usando o endereço de e-mail do usuário OIDC, com uma senha aleatória forte ou, de preferência, sem o campo
OVERLEAF_OIDC_UPDATE_USER_DETAILS_ON_LOGIN- Se definida como
true, atualiza os camposfirst_nameelast_namedo usuário no login e desativa o formulário de dados do usuário na página/user/settings.
- Se definida como
OVERLEAF_OIDC_IS_ADMIN_FIELDeOVERLEAF_OIDC_IS_ADMIN_FIELD_VALUE- Quando ambas as variáveis de ambiente estão definidas, o processo de login atualiza
user.isAdmin = truese o perfil retornado pelo OP contiver o atributo especificado porOVERLEAF_OIDC_IS_ADMIN_FIELDe o seu valor corresponder aOVERLEAF_OIDC_IS_ADMIN_FIELD_VALUEou for um array que contenhaOVERLEAF_OIDC_IS_ADMIN_FIELD_VALUE(por exemplo, a claimgroups); caso contrário,user.isAdminé definido comofalse. SeOVERLEAF_OIDC_IS_ADMIN_FIELDforemail, o valor do atributoemails[0].valueé usado na verificação de correspondência.
- Quando ambas as variáveis de ambiente estão definidas, o processo de login atualiza
https://my-overleaf-instance.com/oidc/login/callback.
Exemplo de arquivo variables.env
Exemplo de arquivo variables.env
Passo a passo: goauthentik
Este guia percorre uma configuração testada com o goauthentik. Substituahttps://overleaf.example.com pela sua OVERLEAF_SITE_URL e https://authentik.example.com pelo endereço do seu Authentik.
Criar o provedor
- Client Type:
Confidential. - Redirect URIs (em Protocol settings): adicione
https://overleaf.example.com/oidc/login/callbackcom o modo de correspondênciaStrict. - Copie agora o Client ID e o Client Secret para
OVERLEAF_OIDC_CLIENT_IDeOVERLEAF_OIDC_CLIENT_SECRET.

Authentik: Client ID e Client Secret de um novo provedor
Criar a aplicação
overleaf, e selecione o provedor. O slug passa a fazer parte do issuer: https://authentik.example.com/application/o/overleaf/.Copiar as URLs
Mapear os administradores (opcional)
groups, um array. Para tornar os membros do grupo Admins do Authentik administradores do Overleaf:variables.env testado para o goauthentik
variables.env testado para o goauthentik
Q&A
A claim de administrador está definida, mas os usuários não se tornam administradores
A claim de administrador está definida, mas os usuários não se tornam administradores
- Versão. Antes da v6.3.0, o Overleaf não lia claims personalizadas como
groups, então sóOVERLEAF_OIDC_IS_ADMIN_FIELD=emailfuncionava. Atualize para a v6.3.0 ou posterior. - A claim precisa estar na resposta de UserInfo. O Overleaf lê a claim de
OVERLEAF_OIDC_USER_INFO_URL, não do ID token. Se o seu OP adiciona a claim apenas ao ID token, adicione-a também ao UserInfo, por exemplo com Add to userinfo em um mapper do Keycloak. - O valor precisa corresponder exatamente, incluindo maiúsculas e minúsculas, por exemplo
Admins.
Posso usar o GitHub como provedor OIDC?
Posso usar o GitHub como provedor OIDC?
ID token not present in token response.Para permitir que os usuários façam login com a conta do GitHub, use um provedor de identidade como o goauthentik ou o Keycloak, com o GitHub como origem de login, e conecte o Overleaf a esse provedor com OIDC.Posso usar o GitLab como provedor OIDC?
Posso usar o GitLab como provedor OIDC?
- Redirect URI:
https://my-overleaf-instance.com/oidc/login/callback - Scopes:
openid,profileeemail
https://gitlab.com/.well-known/openid-configuration, ou no mesmo caminho do seu GitLab, conforme descrito em Encontrando os valores com o documento de descoberta. Para gitlab.com, o issuer é https://gitlab.com, sem barra final.
