> 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/pt/configuracao/overleaf-toolkit/authentication/ldap-authentication.md). # Autenticação LDAP Esta funcionalidade foi desenvolvida por [yu-i-i/overleaf-cep](https://github.com/yu-i-i/overleaf-cep). Aqui oferecemos alguns documentos para a sua configuração. {% hint style="warning" %} O Overleaf usa a **passport-ldapauth** biblioteca, que está relativamente desatualizada, a compatibilidade com LDAP não pode ser totalmente garantida. Com alguns fornecedores de identidade LDAP (por exemplo, ), poderão ocorrer falhas de início de sessão. Por isso, se possível, recomenda-se usar primeiro o método OAuth/SAML. {% endhint %} ### O que é LDAP LDAP é um protocolo de autenticação usado para verificação de identidade externa. O Overleaf Server Pro disponibiliza um formulário de início de sessão LDAP dedicado na interface web, separado do método de autenticação padrão. Quando um utilizador submete o seu nome de utilizador e palavra-passe LDAP, o backend do Overleaf verifica as credenciais no servidor LDAP configurado, por exemplo `ldap://ldap:10389`.

Um exemplo do Server Pro para LDAP

### Configuração Internamente, o LDAP do Overleaf usa a [passport-ldapauth](https://github.com/vesse/passport-ldapauth) biblioteca. A maioria destas opções de configuração é passada para a `servidor` objeto de configuração que é usado para configurar `passport-ldapauth`. Se estiver a ter problemas a configurar o LDAP, vale a pena ler o README de `passport-ldapauth` 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 LDAP. Esta variável de ambiente especifica quais os métodos de autenticação externos que estão ativados. O valor desta variável é uma lista. Se a lista incluir `ldap` então a autenticação LDAP será ativada. Por exemplo: `EXTERNAL_AUTH=ldap saml` Ao contrário do Overleaf CEP, na nossa edição ayaka-notes, limitamos a autenticação LDAP a um método de autenticação puro, disponível em `http://your-overleaf.com/ldap/login`. Ao usar métodos de autenticação LDAP, o utilizador introduz um `nome de utilizador` e `palavra-passe` no formulário de início de sessão, é tentado: 1. Procura-se um utilizador LDAP no diretório LDAP usando o filtro definido por `OVERLEAF_LDAP_SEARCH_FILTER` e autentica-o. 2. Se a autenticação for bem-sucedida, a base de dados de utilizadores do Overleaf é verificada para encontrar um utilizador com o endereço de email principal que corresponda ao endereço de email do utilizador LDAP autenticado: * Se for encontrado um utilizador correspondente, o `hashedPassword` campo deste utilizador é eliminado (se existir). Isto garante que o utilizador só poderá iniciar sessão via autenticação LDAP no futuro. * Se não for encontrado nenhum utilizador correspondente, é criado um novo utilizador do Overleaf usando o email, o nome próprio e o apelido obtidos do servidor LDAP. {% hint style="danger" %} Para os utilizadores que iniciam sessão via LDAP, não armazenamos (nem removemos os já existentes) passwords com hash na base de dados Mongo do Overleaf. {% endhint %} #### Variáveis de ambiente * `OVERLEAF_LDAP_URL` **(obrigatório)** * URL do servidor LDAP. * Exemplo: `ldaps://ldap.example.com:636` (LDAP sobre SSL) * Exemplo: `ldap://ldap.example.com:389` (não encriptado ou STARTTLS, se configurado). * `OVERLEAF_LDAP_IDENTITY_SERVICE_NAME` * Nome apresentado do serviço de identidade LDAP, usado na página de início de sessão. * Por predefinição, `Iniciar sessão com o fornecedor LDAP`. * `OVERLEAF_LDAP_EMAIL_ATT` * O atributo de email devolvido pelo servidor LDAP, por predefinição `mail`. Cada utilizador LDAP deve ter pelo menos um endereço de email. Se forem fornecidos vários endereços, apenas o primeiro será usado. * `OVERLEAF_LDAP_FIRST_NAME_ATT` * O nome da propriedade que contém o nome próprio do utilizador e que é usado na aplicação, normalmente `givenName`. * `OVERLEAF_LDAP_LAST_NAME_ATT` * O nome da propriedade que contém o apelido do utilizador e que é usado na aplicação, normalmente `sn`. * `OVERLEAF_LDAP_NAME_ATT` * O nome da propriedade que contém o nome completo do utilizador, normalmente `cn`. Se qualquer uma das duas variáveis anteriores não estiver definida, o nome próprio e/ou o apelido do utilizador é extraído desta variável. Caso contrário, não é usada. * `OVERLEAF_LDAP_PLACEHOLDER` * O placeholder para o formulário de início de sessão, por predefinição `Nome de utilizador`. * `atualiza o utilizador LDAP` * Se definido como `true`first\_name `first_name` e `last_name` campo no início de sessão e desativa o formulário de detalhes do utilizador na `/user/settings` página para utilizadores LDAP. Caso contrário, os detalhes serão obtidos apenas no primeiro início de sessão. * `OVERLEAF_LDAP_BIND_DN` * O nome distinto do utilizador LDAP que deve ser usado para a ligação LDAP (este utilizador deve conseguir procurar/listar contas no servidor LDAP), por exemplo, `cn=ldap_reader,dc=example,dc=com`. Se não estiver definido, é usada a ligação anónima. * `OVERLEAF_LDAP_BIND_CREDENTIALS` * Palavra-passe para `OVERLEAF_LDAP_BIND_DN`. * `OVERLEAF_LDAP_BIND_PROPERTY` * Propriedade do utilizador a usar para a ligação ao cliente, por predefinição `dn`. * `OVERLEAF_LDAP_SEARCH_BASE` **(obrigatório)** * O DN base a partir do qual procurar utilizadores. Por exemplo, `ou=people,dc=example,dc=com`. * `OVERLEAF_LDAP_SEARCH_FILTER` * Filtro de pesquisa LDAP com o qual encontrar um utilizador. Use o literal '{{username}}' para que o nome de utilizador fornecido seja interpolado na pesquisa LDAP. * Exemplo: `(|(uid={{username}})(mail={{username}}))` (o utilizador pode iniciar sessão com email ou com nome de início de sessão). * Exemplo: `(sAMAccountName={{username}})` (Active Directory). * `OVERLEAF_LDAP_SEARCH_SCOPE` * O âmbito da pesquisa pode ser `base`, `um`, ou `sub` (predefinição). * `OVERLEAF_LDAP_SEARCH_ATTRIBUTES` * Matriz JSON de atributos a obter do servidor LDAP, por exemplo, `["uid", "mail", "givenName", "sn"]`. Por predefinição, todos os atributos são obtidos. * `OVERLEAF_LDAP_STARTTLS` * Se `true`, o LDAP sobre TLS é usado. * `OVERLEAF_LDAP_TLS_OPTS_CA_PATH` * Caminho para o ficheiro que contém o certificado CA usado para verificar o certificado SSL/TLS do servidor LDAP. Se existirem vários certificados, então pode ser uma matriz JSON de caminhos para os certificados. Os ficheiros têm de estar acessíveis ao contentor Docker. * Exemplo (um certificado): `/var/lib/overleaf/certs/ldap_ca_cert.pem` * Exemplo (vários certificados): `["/var/lib/overleaf/certs/ldap_ca_cert1.pem", "/var/lib/overleaf/certs/ldap_ca_cert2.pem"]` * `OVERLEAF_LDAP_TLS_OPTS_REJECT_UNAUTH` * Se `true`, o certificado do servidor é verificado face à lista de autoridades certificadoras fornecida. * `OVERLEAF_LDAP_CACHE` * Se `true`, então até 100 credenciais de cada vez serão guardadas em cache durante 5 minutos. * `OVERLEAF_LDAP_TIMEOUT` * Durante quanto tempo o cliente deve manter as operações ativas antes de expirar, ms (Predefinição: Infinity). * `OVERLEAF_LDAP_CONNECT_TIMEOUT` * Durante quanto tempo o cliente deve esperar antes de expirar nas ligações TCP, ms (Predefinição: predefinição do SO). * `OVERLEAF_LDAP_IS_ADMIN_ATT` e `OVERLEAF_LDAP_IS_ADMIN_ATT_VALUE` * Quando ambas as variáveis de ambiente estão definidas, o processo de início de sessão atualiza `user.isAdmin = true` se o perfil LDAP contiver o atributo especificado por `OVERLEAF_LDAP_IS_ADMIN_ATT` e o respetivo valor corresponder a `OVERLEAF_LDAP_IS_ADMIN_ATT_VALUE` ou for uma matriz que contenha `OVERLEAF_LDAP_IS_ADMIN_ATT_VALUE`, caso contrário `user.isAdmin` estiver definido como `false`. Se qualquer uma destas variáveis não estiver definida, então o estado de administrador só é definido como `true` durante a criação de um utilizador administrador no Launchpad. As cinco variáveis seguintes são usadas para configurar como os contactos dos utilizadores são obtidos a partir do servidor LDAP. * `OVERLEAF_LDAP_CONTACTS_FILTER` * O filtro usado para procurar utilizadores no servidor LDAP para serem carregados nos contactos. O placeholder '{{userProperty}}' dentro do filtro é substituído pelo valor da propriedade especificada por `OVERLEAF_LDAP_CONTACTS_PROPERTY` do utilizador LDAP que inicia a pesquisa. Se não estiver definido, nenhum utilizador é obtido do servidor LDAP para os contactos. * `OVERLEAF_LDAP_CONTACTS_SEARCH_BASE` * Especifica o DN base a partir do qual começar a procurar os contactos. Por predefinição `OVERLEAF_LDAP_SEARCH_BASE`. * `OVERLEAF_LDAP_CONTACTS_SEARCH_SCOPE` * O âmbito da pesquisa pode ser `base`, `um`, ou `sub` (predefinição). * `OVERLEAF_LDAP_CONTACTS_PROPERTY` * Especifica a propriedade do objeto de utilizador que substituirá o placeholder '{{userProperty}}' no `OVERLEAF_LDAP_CONTACTS_FILTER`. * `OVERLEAF_LDAP_CONTACTS_NON_LDAP_VALUE` * Especifica o valor de `OVERLEAF_LDAP_CONTACTS_PROPERTY` se a pesquisa for iniciada por um utilizador não LDAP. Se esta variável não estiver definida, o filtro resultante não corresponderá a nada. O valor `*` pode ser usado como curinga.
Exemplo ``` OVERLEAF_LDAP_CONTACTS_FILTER=(gidNumber={{userProperty}}) OVERLEAF_LDAP_CONTACTS_PROPERTY=gidNumber OVERLEAF_LDAP_CONTACTS_NON_LDAP_VALUE=1000 ``` O exemplo acima resulta no carregamento, nos contactos do utilizador LDAP atual, de todos os utilizadores LDAP que têm o mesmo UNIX `gid`. Os utilizadores não LDAP terão todos os utilizadores LDAP com UNIX `gid=1000` nos seus contactos.
Exemplo de ficheiro variables.env ``` OVERLEAF_APP_NAME="A nossa instância Overleaf" ENABLED_LINKED_FILE_TYPES=project_file,project_output_file,url # Ativa a geração de miniaturas usando ImageMagick ENABLE_CONVERSIONS=true # Desativa a exigência de confirmação de email EMAIL_CONFIRMATION_DISABLED=true ## Nginx # NGINX_WORKER_PROCESSES=4 # NGINX_WORKER_CONNECTIONS=768 ## Definir para TLS via nginx-proxy # OVERLEAF_BEHIND_PROXY=true # OVERLEAF_SECURE_COOKIE=true OVERLEAF_SITE_URL=http://my-overleaf-instance.com OVERLEAF_NAV_TITLE=A nossa instância Overleaf # OVERLEAF_HEADER_IMAGE_URL=http://somewhere.com/mylogo.png OVERLEAF_ADMIN_EMAIL=support@example.com OVERLEAF_LEFT_FOOTER=[{"text": "Contacte a sua equipa de suporte", "url": "mailto:support@example.com"}] OVERLEAF_RIGHT_FOOTER=[{"text":"Olá, estou à direita", "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=Este sistema é gerido pelo departamento x OVERLEAF_PROXY_LEARN=true NAV_HIDE_POWERED_BY=true ################# ## LDAP para CE ## ################# EXTERNAL_AUTH=ldap OVERLEAF_LDAP_URL=ldap://ldap.example.com:389 OVERLEAF_LDAP_STARTTLS=true OVERLEAF_LDAP_TLS_OPTS_CA_PATH=/var/lib/overleaf/certs/ldap_ca_cert.pem OVERLEAF_LDAP_SEARCH_BASE=ou=people,dc=example,dc=com OVERLEAF_LDAP_SEARCH_FILTER=(|(uid={{username}})(mail={{username}})) OVERLEAF_LDAP_BIND_DN=cn=ldap_reader,dc=example,dc=com OVERLEAF_LDAP_BIND_CREDENTIALS=GoodNewsEveryone OVERLEAF_LDAP_EMAIL_ATT=mail OVERLEAF_LDAP_FIRST_NAME_ATT=givenName OVERLEAF_LDAP_LAST_NAME_ATT=sn # OVERLEAF_LDAP_NAME_ATT=cn OVERLEAF_LDAP_SEARCH_ATTRIBUTES=["uid", "sn", "givenName", "mail"] OVERLEAF_LDAP_UPDATE_USER_DETAILS_ON_LOGIN=true OVERLEAF_LDAP_PLACEHOLDER='Nome de utilizador ou endereço de email' OVERLEAF_LDAP_IS_ADMIN_ATT=mail OVERLEAF_LDAP_IS_ADMIN_ATT_VALUE=admin@example.com OVERLEAF_LDAP_CONTACTS_FILTER=(gidNumber={{userProperty}}) OVERLEAF_LDAP_CONTACTS_PROPERTY=gidNumber OVERLEAF_LDAP_CONTACTS_NON_LDAP_VALUE='*' ```
--- # 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/pt/configuracao/overleaf-toolkit/authentication/ldap-authentication.md?ask=&goal= ``` `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.