Pular para o conteúdo principal
Versão: 0.4 · atual

Armazenar uma credencial para o coletor

Guia de instruçõesRevisado em 11 de outubro de 2026
Aplica-se a:Excubius 0.4Funções: Administrador de entidade
PlanosFree · Core · Pro · EnterpriseImplantaçãoAuto-hospedado

Uma credencial é o logon somente leitura que o coletor usa para alcançar um sistema: um logon do SQL, uma conta do Windows, uma chave SSH ou uma entidade de serviço do Azure. Você a armazena uma vez em uma entidade, e todos os recursos dessa entidade e abaixo dela podem usá-la. Este guia mostra como adicionar uma, qual tipo escolher, as opções de conexão de cada tipo e como um recurso encontra a credencial que usa.

Antes de começar​

  • Você precisa da função Entity admin (Administrador de entidade) na entidade que será a proprietária da credencial.
  • O logon existe no sistema monitorado com permissões somente leitura. Para o SQL Server, consulte Pré-requisitos para grupos de disponibilidade; para todas as plataformas, consulte Permissões.
  • Armazene a credencial o mais alto possível na árvore de entidades em que ela seja válida. Um logon do SQL usado em todos os servidores da Veredas Ltda. pertence à Veredas Ltda., e não a cada ambiente.

Escolher o tipo​

TipoUsuárioSegredoUse para
SQL login (sql_login)Logon do SQLSenhaInstâncias do SQL Server e grupos de disponibilidade; os bancos de dados e servidores vinculados descobertos neles usam a credencial da instância. Também o log de execução do Reporting Services
Windows account (windows)Conta (DOMAIN\user)SenhaHosts Windows por WinRM; servidores de relatórios e endpoints web com autenticação do Windows (NTLM)
HTTP user and password (http_basic)UsuárioSenhaEndpoints web e servidores de relatórios com autenticação básica; as verificações do Wazuh
Bearer token (token)—TokenEndpoints web com autenticação de portador
SSH key (ssh_key)UsuárioChave privadaHosts Linux
SSH password (ssh_password)UsuárioSenhaHosts Linux
Azure service principal (azure_sp)ID do clienteSegredo do clienteVerificações de postura do Azure e verificações de identidade do Entra ID, para um locatário que a identidade gerenciada do servidor não alcança

A autenticação integrada do Windows no SQL Server não é compatível: o coletor é executado em um contêiner Linux sem tíquete Kerberos. Use um logon do SQL, o que exige que a instância aceite a autenticação do SQL Server (modo misto).

Adicionar uma credencial​

  1. Abra Settings › Credentials e escolha a entidade no seletor de entidades, por exemplo Veredas Ltda..
  2. Selecione Add credential.
  3. Digite um Name que você reconheça, como sql-monitoring, e escolha o Kind. O tipo não pode ser alterado depois.
  4. Verifique a Entity: os recursos dessa entidade e abaixo dela podem usar a credencial.
  5. Digite o usuário e o segredo. Os rótulos seguem o tipo, por exemplo SQL login e Password, ou Client id e Client secret.
  6. Em Connection options, defina o que o tipo exige. Consulte a próxima seção.
  7. Selecione Create.

A credencial aparece na lista com o segredo marcado como stored, quantos recursos a usam e quando foi usada pela última vez.

Opções de conexão​

TipoOpçãoValoresEfeito
Logon do SQLencryptyes (padrão), no, strictCriptografa a conexão. strict usa TDS 8 e exige o SQL Server 2022 ou posterior
Logon do SQLtrust_server_certificatetrue (padrão), falseA maioria das instâncias usa certificados autoassinados. Defina false quando a instância tiver um certificado em que o coletor confie
Logon do SQLhost_name_in_certificateUm nome de hostO nome a validar quando for diferente do host, por exemplo por meio de um ouvinte ou de um alias
Logon do SQLapplication_intentReadOnly (padrão), ReadWriteReadWrite altera apenas o roteamento, para que as verificações por banco de dados incluam os bancos de dados de disponibilidade de uma réplica primária que recusa conexões com intenção de leitura. O logon continua sem permissão de gravação
Conta do Windowsauthkerberos (padrão), negotiate, ntlmComo o WinRM faz a autenticação. A imagem do coletor não tem configuração do Kerberos, por isso escolha negotiate ou ntlm
Chave SSH, senha SSHknown_hostsLinhas known_hosts do OpenSSH, uma por linhaFixa as chaves de host que o coletor aceita
Entidade de serviço do Azuretenant_idO ID do locatário do EntraO locatário do registro de aplicativo

Algumas opções só podem ser definidas por meio da API, nos attributes da credencial:

TipoOpçãoEfeito
Entidade de serviço do AzuresubscriptionsLimita as verificações de postura do Azure a essas assinaturas. Sem ela, aplica-se AZURE_SUBSCRIPTION_IDS ou, na falta dele, todas as assinaturas que a identidade pode ler
Usuário e senha HTTPverify_tlsfalse aceita um certificado não confiável no indexador e no gerenciador do Wazuh. Padrão true

Os nomes das opções nunca contêm segredos: a API recusa uma opção cujo nome contenha pass, secret, token, private ou pwd. Coloque os segredos no campo de segredo.

Como o segredo é protegido​

  • O segredo é somente gravação. Ele é criptografado com a chave de dados da instalação (EXCUBIUS_DATA_KEY) e nunca mais é exibido, em nenhuma tela nem pela API, que informa apenas se há um armazenado.
  • Para alterá-lo, edite a credencial e digite um novo. Deixe o campo vazio para manter o segredo armazenado ou selecione Remove the stored secret para apagá-lo.
  • O coletor recebe o segredo pela rede interna, mantém-no apenas na memória e nunca o registra em log.
  • Guarde EXCUBIUS_DATA_KEY com o backup do arquivo .env. Sem ela, os segredos armazenados não podem ser descriptografados, e as verificações falham com o tipo de erro config até que você os digite novamente.

Qual credencial um recurso usa​

Um recurso procura uma credencial nesta ordem e usa a primeira cujo tipo seja adequado à verificação:

  1. A credencial da própria verificação, quando houver uma definida.
  2. A credencial do recurso.
  3. A credencial do recurso pai mais próximo. Um grupo de disponibilidade ou um banco de dados descoberto em uma instância usa o logon do SQL da instância.

Por exemplo, a verificação do log de execução de um servidor de relatórios é uma verificação T-SQL. Quando o recurso do servidor de relatórios tem uma conta do Windows para o portal dele, a verificação usa o logon do SQL da instância acima dele ou um logon do SQL que você definiu nessa verificação específica.

Para definir uma credencial em uma verificação, use a API: PATCH /api/v1/resources/{id}/checks/{check_id} com credential_id. Associar um recurso ou uma verificação a uma credencial exige a função Entity admin na entidade proprietária da credencial.

Editar ou excluir uma credencial​

  • Edit altera o nome, o usuário, o segredo e as opções. O tipo não muda.
  • Delete só funciona quando nada usa a credencial. Altere primeiro os recursos e as verificações que a usam.
  • Excluir uma entidade também exclui as credenciais que pertencem a ela.

A lista mostra, para cada credencial, quantos recursos e verificações a usam e quando uma verificação bem-sucedida a usou pela última vez.