> For the complete documentation index, see [llms.txt](https://wiki.datadike.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://wiki.datadike.com/pt/pam/administration/integrations/syslog-and-siem.md).

# Syslog e SIEM

Encaminhe a trilha de auditoria continuamente para um coletor externo (syslog sobre UDP, TCP ou TLS, exportação em texto, ou Elasticsearch) para que os registros sobrevivam independentemente do applia

O envio de logs manda os registros produzidos pela solução para um coletor que você já opera, à medida que acontecem. O objetivo é independência: uma trilha que também vive no seu SIEM sobrevive à perda, ao comprometimento ou à reinstalação do appliance, e pode ser correlacionada com tudo o mais que o seu SOC observa.

{% hint style="info" %}
**Envio de logs não é geração de relatórios.** O envio é contínuo, de máquina para máquina, e vai para um coletor. [Relatórios](https://wiki.datadike.com/pt/pam/administration/audit/reports.md) são extrações periódicas ou sob demanda, formatadas para pessoas e entregues por e-mail. Os dois leem os mesmos registros subjacentes, descritos em [Trilha de auditoria](https://wiki.datadike.com/pt/pam/administration/audit/audit-trail.md), e a maioria dos ambientes quer os dois.
{% endhint %}

## O que é isto e quando usar

Existem dois mecanismos, configurados em lugares diferentes e carregando coisas diferentes. Confundi-los é a razão habitual pela qual um projeto de SIEM emperra.

| Mecanismo                                | O que carrega                                                                                  | Onde é configurado                                                       |
| ---------------------------------------- | ---------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------ |
| **Encaminhamento syslog**                | Os registros de eventos: logins, sessões, mudanças de configuração, transferências de arquivos | No arquivo de configuração do appliance                                  |
| **Backend de armazenamento de comandos** | Os comandos digitados em sessões de terminal, indexados para busca                             | **Configurações do Sistema › Armazenamento › Armazenamento de comandos** |

Use o encaminhamento syslog quando o requisito for "nosso SIEM precisa conter a trilha de acesso privilegiado". Use um backend Elasticsearch de armazenamento de comandos quando o requisito for "buscar o histórico de comandos no console está lento demais": por padrão, os comandos ficam no banco de dados da própria solução, o que funciona bem até o volume de sessões de terminal crescer.

Destinos disponíveis para a trilha:

| Destino                 | Observações                                                                                    |
| ----------------------- | ---------------------------------------------------------------------------------------------- |
| **Syslog sobre UDP**    | Porta padrão 514. Dispara e esquece: sem garantia de entrega                                   |
| **Syslog sobre TCP**    | Porta padrão 514. Orientado a conexão                                                          |
| **Syslog sobre TLS**    | Porta padrão 6514. Use sempre que o coletor não estiver em um segmento confiável               |
| **Exportação em texto** | Um arquivo de texto puro, para coletores que leem arquivos ou para entrega em ambiente isolado |
| **Elasticsearch**       | Indexa registros de comandos para busca, como backend de armazenamento de comandos             |

## Antes de começar

* O endereço e a porta do coletor, e uma decisão sobre o protocolo. Prefira **TLS na 6514**, a menos que o coletor esteja em um segmento em que você já confie.
* O coletor precisa estar alcançável **a partir de todos os nós**. Em um cluster, cada nó encaminha os próprios registros; uma regra de firewall que cubra apenas um nó produz uma trilha com buracos.
* A facility syslog que o seu coletor espera, para que os registros caiam no pipeline certo e não no padrão.
* Uma janela de manutenção. Habilitar o encaminhamento exige reiniciar os serviços da solução.

{% hint style="warning" %}
O encaminhamento syslog **não é configurado pelo console**. Ele é definido no arquivo de configuração do appliance, e a mudança só passa a valer depois que os serviços reiniciam. Abra um chamado de suporte para que a mudança seja feita e registrada. Não edite um appliance de produção à mão sem um chamado.
{% endhint %}

## Passos

1. **Escolha o destino e o protocolo** e abra o caminho de todos os nós até o coletor naquela porta.
2. **Defina os parâmetros** no arquivo de configuração do appliance, `/opt/datadike/config/config.txt`:

   ```
   SYSLOG_ENABLE=true
   SYSLOG_ADDR=10.1.12.116:514
   SYSLOG_FACILITY=local2
   ```

   `SYSLOG_ADDR` recebe o endereço e a porta do coletor juntos. `SYSLOG_FACILITY` precisa coincidir com o que a configuração do coletor espera.
3. **Reinicie os serviços da solução.** Nada é encaminhado até que eles voltem.
4. **Repita em todos os nós** de um cluster. Cada nó envia os próprios registros.
5. **Acrescente um backend de armazenamento de comandos**, se o objetivo for a busca de comandos, em **Configurações do Sistema › Armazenamento › Armazenamento de comandos**. Deixar a lista vazia mantém os comandos no banco de dados local.
6. **Construa o lado do coletor**: parsers, índices e painéis. Os registros seguem um padrão comum, de modo que os coletores usuais os consomem sem um parser customizado.

## O que você deve ver

Os registros chegam como linhas syslog carregando um tipo de registro e um payload JSON. O tipo de registro diz de qual log o evento veio:

| Evento              | Tipo de registro | Destaques do payload                                                                                         |
| ------------------- | ---------------- | ------------------------------------------------------------------------------------------------------------ |
| Login no console    | `login_log`      | O backend de autenticação, o `ip` de origem, o `username` e um objeto `status` com o resultado               |
| Envio de arquivo    | `ftp_log`        | A `account` usada no ativo, o `filename`, um `value` igual a `upload`, o `remote_addr` e o `user` do console |
| Download de arquivo | `ftp_log`        | Os mesmos campos, com um `value` igual a `download`                                                          |

Uma linha isolada tem esta cara, abreviada:

```
Apr 19 15:25:11 10.1.14.125 datadike: login_log - { "backend": "Password",
  "ip": "10.1.10.35", "status": {"label": "successful", "value": true},
  "username": "admin" }
```

A tag `datadike:` é o que você filtra no coletor para isolar os registros da solução.

## Como verificar se funcionou

Confirme a chegada no coletor, não apenas que a configuração foi salva.

1. **Force um evento conhecido.** Faça login no console, ou faça login com uma senha propositalmente errada. Os dois produzem um registro `login_log` em segundos.
2. **Busque no coletor pela tag `datadike:`** nos últimos minutos e encontre exatamente esse evento. Compare o `username`, o `ip` de origem e o `status` com o que você acabou de fazer: um registro que chega com os campos errados é problema de parser, não de entrega.
3. **Exercite um segundo tipo de registro.** Envie um arquivo pequeno durante uma sessão e confirme que chega um registro `ftp_log` com `"value": "upload"`. Um tipo de registro funcionando não prova que os demais também funcionam.
4. **Verifique todos os nós.** Em um cluster, faça login por cada nó e confirme que os registros de cada um chegam ao coletor. Essa é a falha que passa meses despercebida.
5. **Se você acrescentou um backend de armazenamento de comandos**, execute uma sessão de terminal, digite um comando e depois busque por esse comando em **Auditoria › Sessão › Keylogger**. O comando precisa ser encontrado: se o backend estiver mal configurado, a indexação falha em silêncio e a busca no console volta vazia, mesmo que a sessão tenha sido gravada.

{% hint style="warning" %}
Teste com um login **malsucedido**, além de um bem-sucedido. Uma regra de coletor que só casa com sucessos esconde exatamente os eventos que motivaram a construção do pipeline.
{% endhint %}

## Erros comuns

| Sintoma                                                   | Causa                                                                             | Correção                                                                                                                             |
| --------------------------------------------------------- | --------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------ |
| Nada chega ao coletor                                     | Os serviços não foram reiniciados depois de o arquivo ser alterado                | Reinicie os serviços da solução; a configuração é lida na inicialização                                                              |
| Nada chega, e os serviços foram reiniciados               | Protocolo ou porta errados, ou o coletor está inalcançável a partir dos nós       | Confira contra 514/UDP, 514/TCP e 6514/TLS, e teste o alcance a partir de todos os nós                                               |
| Chegam registros de algumas sessões e de outras não       | Só um nó do cluster está encaminhando                                             | Aplique a configuração em todos os nós                                                                                               |
| Os registros chegam mas caem no pipeline errado           | `SYSLOG_FACILITY` não coincide com a configuração do coletor                      | Defina a facility que o coletor espera e reinicie                                                                                    |
| Registros chegam de forma intermitente sobre UDP em carga | UDP não tem garantia de entrega                                                   | Mude para TCP, ou para TLS na 6514                                                                                                   |
| O destino TLS recusa a conexão                            | O certificado do coletor não é confiável, ou a porta está errada                  | Corrija a cadeia de confiança e confirme que o coletor escuta na 6514                                                                |
| A busca de comandos no console está lenta ou vazia        | Os comandos estão no banco local, ou o backend Elasticsearch está mal configurado | Acrescente ou conserte o backend de armazenamento de comandos e verifique buscando um comando que você acabou de digitar             |
| Eventos deixam de aparecer para datas mais antigas        | A retenção expirou, independentemente do encaminhamento                           | A retenção é definida em **Configurações do Sistema › Retenções**; a retenção do próprio coletor é separada e costuma ser mais longa |

## Referência de campos

### Chaves de configuração

| Chave             | Significado                                                                              |
| ----------------- | ---------------------------------------------------------------------------------------- |
| `SYSLOG_ENABLE`   | `true` liga o encaminhamento. Lida na inicialização do serviço                           |
| `SYSLOG_ADDR`     | O coletor, no formato `endereço:porta`, por exemplo `10.1.12.116:514`                    |
| `SYSLOG_FACILITY` | A facility syslog, por exemplo `local2`. Precisa coincidir com a configuração do coletor |

### Portas padrão

| Protocolo  | Porta |
| ---------- | ----- |
| Syslog UDP | 514   |
| Syslog TCP | 514   |
| Syslog TLS | 6514  |

### Coletores que reconhecidamente consomem o formato sem parser customizado

| Categoria                  | Produtos                                                                                                                   |
| -------------------------- | -------------------------------------------------------------------------------------------------------------------------- |
| SIEM                       | Splunk, IBM QRadar, Microsoft Sentinel, Elastic Security, Google Security Operations, Securonix, LogRhythm, Graylog, Wazuh |
| Plataformas de log e busca | Elastic Stack (ELK), OpenSearch, Loki com Grafana                                                                          |
| Coletores e encaminhadores | rsyslog, syslog-ng, Fluentd, Fluent Bit                                                                                    |
| Suítes de monitoramento    | SolarWinds, ManageEngine, Paessler PRTG, Nagios                                                                            |

O formato dos registros segue um padrão comum; qualquer coisa que leia syslog padrão ou ingira payloads JSON dará conta dele, esteja ou não na lista acima.

## Páginas relacionadas

* [Trilha de auditoria](https://wiki.datadike.com/pt/pam/administration/audit/audit-trail.md): os registros que estão sendo encaminhados, e onde cada um deles vive no console
* [Relatórios](https://wiki.datadike.com/pt/pam/administration/audit/reports.md): o outro caminho de entrega, extrações periódicas para pessoas, não envio contínuo
* [Gravações de sessão](https://wiki.datadike.com/pt/pam/administration/audit/recordings.md): armazenadas separadamente dos registros de eventos
* [Acesso aplicação-a-aplicação](https://wiki.datadike.com/pt/pam/administration/integrations/application-to-application.md): a outra integração que produz registros de auditoria dignos de observação em um SIEM
