O Google usa tecnologia de IA na tradução de conteúdos para seu idioma de preferência. As traduções com IA podem ter erros.

Coletar registros do NGINX

Compatível com:

Google SecOps SIEM

Este documento explica como ingerir registros do NGINX no Google Security Operations usando o agente Bindplane.

O NGINX é um servidor da Web e proxy reverso que gera mensagens syslog para eventos de acesso HTTP, eventos de erro, atividade de autenticação e informações de processo. O analisador extrai campos de vários formatos de registro (syslog, JSON, registros de acesso) usando padrões grok e os mapeia para o modelo de dados unificado (UDM).

Antes de começar

Verifique se você tem os pré-requisitos a seguir:

Uma instância do Google SecOps
Windows Server 2016 ou mais recente ou host Linux com systemd
Conectividade de rede entre o agente do Bindplane e o servidor NGINX
Se estiver executando por trás de um proxy, verifique se as portas do firewall estão abertas de acordo com os requisitos do agente Bindplane.
Acesso administrativo ao host NGINX

Receber o arquivo de autenticação de ingestão do Google SecOps

Faça login no console do Google SecOps.
Acesse Configurações do SIEM > Agentes de coleta.
Baixe o arquivo de autenticação de ingestão.
Salve o arquivo com segurança no sistema em que o agente do Bindplane será instalado.

Observação: esse arquivo JSON contém credenciais para autenticar o agente do Bindplane no Google SecOps.

Receber o ID de cliente do Google SecOps

Faça login no console do Google SecOps.
Acesse Configurações do SIEM > Perfil.
Copie e salve o ID do cliente na seção Detalhes da organização.

Observação: o ID do cliente é necessário para configurar o exportador do agente Bindplane.

Instalar o agente do BindPlane

Instale o agente do Bindplane no seu sistema operacional Windows ou Linux de acordo com as instruções a seguir.

Instalação do Windows

Abra o prompt de comando ou o PowerShell como administrador.

Execute este comando:

msiexec /i "https://github.com/observIQ/bindplane-agent/releases/latest/download/observiq-otel-collector.msi" /quiet

Aguarde a conclusão da instalação.
Execute o seguinte comando para confirmar a instalação:
```
sc query observiq-otel-collector
```
O serviço vai aparecer como EM EXECUÇÃO.

Instalação do Linux

Abra um terminal com privilégios de root ou sudo.

Execute este comando:

sudo sh -c "$(curl -fsSlL https://github.com/observiq/bindplane-agent/releases/latest/download/install_unix.sh)" install_unix.sh

Aguarde a conclusão da instalação.
Execute o seguinte comando para confirmar a instalação:
```
sudo systemctl status observiq-otel-collector
```
O serviço vai aparecer como ativo (em execução).

Outros recursos de instalação

Para mais opções de instalação e solução de problemas, consulte o guia de instalação do agente do Bindplane.

Configurar o agente do Bindplane para ingerir syslog e enviar ao Google SecOps

Localizar o arquivo de configuração

Linux:

sudo nano /opt/observiq-otel-collector/config.yaml

Windows:

notepad "C:\Program Files\observIQ OpenTelemetry Collector\config.yaml"

Editar o arquivo de configuração

Substitua todo o conteúdo de config.yaml pela seguinte configuração:

receivers:
    udplog:
        listen_address: "0.0.0.0:514"

exporters:
    chronicle/nginx:
        compression: gzip
        creds_file_path: '/etc/bindplane-agent/ingestion-auth.json'
        customer_id: '<customer_id>'
        endpoint: malachiteingestion-pa.googleapis.com
        log_type: NGINX
        raw_log_field: body

service:
    pipelines:
        logs/nginx_to_chronicle:
            receivers:
                - udplog
            exporters:
                - chronicle/nginx

Parâmetros de configuração

Substitua os seguintes marcadores de posição:

Configuração do receptor:
- listen_address: endereço IP e porta a serem detectados:
  - 0.0.0.0 para detectar em todas as interfaces (recomendado)
  - A porta 514 é a porta padrão do syslog. Ela exige acesso root no Linux. Use 1514 para acesso não root.
Configuração do exportador:
- creds_file_path: caminho completo para o arquivo de autenticação de ingestão:
  - Linux: /etc/bindplane-agent/ingestion-auth.json
  - Windows: C:\Program Files\observIQ OpenTelemetry Collector\ingestion-auth.json
- customer_id: ID do cliente copiado do console do Google SecOps
- endpoint: URL do endpoint regional:
  - EUA: malachiteingestion-pa.googleapis.com
  - Europa: europe-malachiteingestion-pa.googleapis.com
  - Ásia: asia-southeast1-malachiteingestion-pa.googleapis.com
  - Consulte a lista completa em Endpoints regionais.

Salve o arquivo de configuração.

Depois de editar, salve o arquivo:
- Linux: pressione Ctrl+O, Enter e Ctrl+X.
- Windows: clique em Arquivo > Salvar.

Reinicie o agente do Bindplane para aplicar as mudanças

Para reiniciar o agente do Bindplane no Linux, execute o seguinte comando:
```
sudo systemctl restart observiq-otel-collector
```
1. Verifique se o serviço está em execução:
```
sudo systemctl status observiq-otel-collector
```
2. Verifique se há erros nos registros:
```
sudo journalctl -u observiq-otel-collector -f
```
Para reiniciar o agente do Bindplane no Windows, escolha uma das seguintes opções:
- Prompt de comando ou PowerShell como administrador:
```
net stop observiq-otel-collector && net start observiq-otel-collector
```
- Console de serviços:
  1. Pressione Win+R, digite services.msc e pressione Enter.
  2. Localize o Coletor do OpenTelemetry da observIQ.
  3. Clique com o botão direito do mouse e selecione Reiniciar.
  4. Verifique se o serviço está em execução:
```
sc query observiq-otel-collector
```
  5. Verifique se há erros nos registros:
```
type "C:\Program Files\observIQ OpenTelemetry Collector\log\collector.log"
```

Configurar o NGINX para encaminhar registros ao Bindplane

Abra o arquivo de configuração do NGINX (por exemplo, /etc/nginx/nginx.conf):
```
sudo vi /etc/nginx/nginx.conf
```

Edite a configuração, substituindo <BINDPLANE_SERVER> e <BINDPLANE_PORT> pelos seus valores:

http {
    access_log syslog:server=<BINDPLANE_SERVER>:<BINDPLANE_PORT>,facility=local7,tag=nginx_access;
    error_log syslog:server=<BINDPLANE_SERVER>:<BINDPLANE_PORT>,facility=local7,tag=nginx_error;
}

Reinicie o NGINX para aplicar as mudanças:
```
sudo systemctl reload nginx
```

Tabela de mapeamento do UDM

Campo de registro	Mapeamento do UDM	Lógica
`_Internal_WorkspaceResourceId`	`target.resource.product_object_id`	Mapeado diretamente
`Computer`	`principal.asset.hostname`	Mapeado diretamente
`Facility`	`additional.fields[`facility`]`	Mapeado diretamente
`HostName`	`principal.asset.hostname`	Mapeado diretamente se `src_ip` não estiver presente
`ProcessName`	`principal.application`	Mapeado diretamente
`SeverityLevel`	`security_result.severity`	Mapeado como "INFORMATIONAL" se o valor for `info`
`SourceSystem`	`principal.asset.platform`	Mapeado para LINUX se o valor corresponder a `Linux`
`SyslogMessage`	Vários campos	Analisado usando grok para extrair `time`, `method`, `target_path`, `protocol`, `response_code`, `referral_url`, `user_agent`, `target_ip`, `target_host` e `cache`
`TenantId`	`additional.fields[`TenantId`]`	Mapeado diretamente
`acct`	`principal.user.user_id`	Mapeado diretamente se não estiver vazio ou for `?`
`addr`	`principal.asset.ip`	Mapeado diretamente
`audit_epoch`	`metadata.event_timestamp`	Convertido para carimbo de data/hora usando o formato `UNIX`. Os nanossegundos são extraídos da mensagem de registro original.
`cache`	`additional.fields[`cache`]`	Mapeado diretamente
`collection_time.nanos`	`metadata.event_timestamp.nanos`	Usado para nanosegundos do carimbo de data/hora do evento, se disponível.
`collection_time.seconds`	`metadata.event_timestamp.seconds`	Usado para segundos do carimbo de data/hora do evento, se disponível.
`data`	Vários campos	A principal fonte de dados, analisada de maneira diferente com base no formato do registro (Syslog, JSON ou outro).
`exe`	`target.process.command_line`	Mapeado diretamente após a remoção de barras invertidas e aspas
`hostname`	`principal.asset.hostname` OU `principal.asset.ip`	Se for um endereço IP, mapeado para `principal.asset.ip`. Caso contrário, mapeado para `principal.asset.hostname`
`msg`	`metadata.description`	Mapeado diretamente como a descrição
`node`	`target.asset.hostname`	Mapeado diretamente
`pid`	`target.process.pid`	Mapeado diretamente
`protocol`	`network.application_protocol`	Mapeado para HTTP se o valor corresponder a `HTTP`
`referral_url`	`network.http.referral_url`	Mapeado diretamente se não estiver vazio ou for `-`
`res`	`security_result.action_details`	Mapeado diretamente
`response_code`	`network.http.response_code`	Mapeado diretamente e convertido em número inteiro
`ses`	`network.session_id`	Mapeado diretamente
`src_ip`	`principal.asset.ip`	Mapeado diretamente
`target_host`	`target.asset.hostname`	Mapeado diretamente
`target_ip`	`target.asset.ip`	Mapeados diretamente, após a conversão da representação de string em uma matriz JSON e a extração de IPs individuais
`target_path`	`target.url`	Mapeado diretamente
`time`	`metadata.event_timestamp`	Analisado para extrair o carimbo de data/hora usando o formato `dd/MMM/yyyy:HH:mm:ss Z`
`user_agent`	`network.http.user_agent`	Mapeado diretamente se não estiver vazio ou for `-`
	`metadata.event_type`	Definido como `GENERIC_EVENT` inicialmente e depois substituído com base em outros campos, como `terminal` e `protocol`. O padrão é `USER_UNCATEGORIZED` se o padrão grok principal não corresponder. Definido como `NETWORK_HTTP` se `protocol` for HTTP e `target_ip` estiver presente, e `STATUS_UPDATE` se `protocol` for HTTP, mas `target_ip` não estiver presente.
	`metadata.log_type`	Defina como `NGINX`
	`metadata.product_name`	Defina como `NGINX`
	`metadata.vendor_name`	Defina como `NGINX`
	`network.ip_protocol`	Defina como `TCP` se `terminal` for `sshd` ou `ssh` ou se o padrão grok principal não corresponder.
	`principal.asset_id`	Defina como `GCP.GCE:0001` se `terminal` for `sshd` ou `ssh`. Defina como `GCP.GCE:0002` se o padrão grok principal não corresponder.
	`extensions.auth.type`	Defina como `MACHINE` se `terminal` for `sshd` ou `ssh`
`log_hostname`	`event.idm.read_only_udm.principal.asset.hostname`	Mapeado do registro de mudanças
`ip_part`	`event.idm.read_only_udm.intermediary.ip`	Mapeado do registro de mudanças
`domain_part`	`event.idm.read_only_udm.intermediary.administrative_domain`	Mapeado do registro de mudanças
`location_part`	`event.idm.read_only_udm.intermediary.location.name`	Mapeado do registro de mudanças
`labels.compute_googleapis_com/resource_name`	`event.idm.read_only_udm.target.hostname`	Mapeado do registro de mudanças
`resource.labels.instance_id`	`event.idm.read_only_udm.target.resource.product_object_id`	Mapeado do registro de mudanças
`resource.labels.project_id`	`event.idm.read_only_udm.target.resource_ancestors.name`	Mapeado do registro de mudanças
`resource.labels.zone`	`event.idm.read_only_udm.target.resource.attribute.cloud.availability_zone`	Mapeado do registro de mudanças
`resource.type`	`event.idm.read_only_udm.target.resource.resource_type`	Mapeado do registro de mudanças
`insertId`	`event.idm.read_only_udm.metadata.product_log_id`	Mapeado do registro de mudanças
`jsonPayload.latency`	`event.idm.read_only_udm.additional.fields`	Mapeado do registro de mudanças
`remoteIp`	`event.idm.read_only_udm.target.ip`	Mapeado do registro de mudanças
`jsonPayload.requestMethod`	`event.idm.read_only_udm.network.http.method`	Mapeado do registro de mudanças
`jsonPayload.requestSize`	`event.idm.read_only_udm.network.sent_bytes`	Mapeado do registro de mudanças
`jsonPayload.requestUrl`	`event.idm.read_only_udm.network.http.referral_url`	Mapeado do registro de mudanças
`jsonPayload.responseSize`	`event.idm.read_only_udm.network.received_bytes`	Mapeado do registro de mudanças
`jsonPayload.serverIp`	`event.idm.read_only_udm.target.ip`	Mapeado do registro de mudanças
`jsonPayload.status`	`event.idm.read_only_udm.network.http.response_code`	Mapeado do registro de mudanças
`jsonPayload.userAgent`	`event.idm.read_only_udm.network.http.user_agent`	Mapeado do registro de mudanças
`jsonPayload.userAgent`	`event.idm.read_only_udm.network.http.parsed_user_agent`	Mapeado do registro de mudanças
`labels`	`event.idm.read_only_udm.additional.fields`	Mapeado do registro de mudanças
`terminal`	`event.idm.read_only_udm.additional.fields`	Mapeado do registro de mudanças
`logName`	`event.idm.read_only_udm.additional.fields`	Mapeado do registro de mudanças
`resource.labels`	`event.idm.read_only_udm.target.resource.attribute.labels`	Mapeado do registro de mudanças
`resource.type`	`event.idm.read_only_udm.target.resource.attribute.labels`	Mapeado do registro de mudanças
`resource.name`	`event.idm.read_only_udm.target.resource.name`	Mapeado do registro de mudanças
`timestamp`	`event.idm.read_only_udm.metadata.event_timestamp`	Mapeado do registro de mudanças
`user_agent`	`event.idm.read_only_udm.network.http.parsed_user_agent`	Mapeado do registro de mudanças

Registro de alterações

Ver o registro de alterações deste analisador

Precisa de mais ajuda? Receba respostas de membros da comunidade e profissionais do Google SecOps.