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 de 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 do Linux com systemd
Conectividade de rede entre o agente do BindPlane e o servidor NGINX
Se você estiver executando por trás de um proxy, verifique se as portas do firewall estão abertas de acordo com os requisitos do agente do Bindplane.
Acesso administrativo ao host do NGINX

Receber credenciais do Google SecOps para o agente do BindPlane

Para autenticar o agente do Bindplane no Google SecOps, escolha um dos seguintes métodos:

Novas implantações: use a API Chronicle (opção 1).
Implantações legadas: continue usando o arquivo de autenticação de ingestão (opção 2) até que a API Ingestion seja desativada em 20 de julho de 2027.

Opção 1: criar uma conta de serviço para a API Chronicle (recomendado)

Faça login no consoleGoogle Cloud e selecione o projeto Google Cloud vinculado à sua instância do Google SecOps.
Acesse IAM e administrador > Contas de serviço.
Clique em Criar conta de serviço.
Informe os seguintes detalhes de configuração:
- Nome da conta de serviço: insira um nome para a conta (por exemplo, bindplane-ingest).
- Descrição da conta de serviço: insira uma descrição (por exemplo, Bindplane agent log ingestion).
Clique em Criar e continuar.
Na seção Conceder a essa conta de serviço acesso ao projeto, clique em Selecionar um papel e escolha Editor do Chronicle.
Clique em Continuar e depois em Concluído.
Clique na conta de serviço que você criou e acesse a guia Chaves.
Clique em Adicionar chave > Criar nova chave.
Selecione JSON e clique em Criar. O download do arquivo de chave é feito no seu computador.
Salve o arquivo de chave como ingestion-auth.json no diretório do coletor do Bindplane (/opt/observiq-otel-collector/ingestion-auth.json no Linux ou C:\Program Files\observIQ OpenTelemetry Collector\ingestion-auth.json no Windows) ou atualize creds_file_path em config.yaml para corresponder ao caminho em que você o salvou.
Acesse IAM e administrador > Configurações e copie o Número do projeto. Você vai precisar dele para configurar o exportador.

Opção 2: fazer o download do arquivo de autenticação de ingestão (legado)

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.

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 de cliente na seção Detalhes da organização.

Observação :o ID de cliente é necessário para configurar o exportador do agente do 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

Localize 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:
    protocol: https
    # Region of your instance, for example us, europe, asia-southeast1
    location: <LOCATION>
    # Project number of the Google Cloud project linked to the instance
    project: '<PROJECT_NUMBER>'
    compression: gzip
    creds_file_path: '/opt/observiq-otel-collector/ingestion-auth.json'
    customer_id: '<customer_id>'
    endpoint: chronicle.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 ouvir em todas as interfaces (recomendado)
  - A porta 514 é a porta syslog padrão (requer raiz no Linux; use 1514 para não raiz)
Configuração do exportador:
- creds_file_path: caminho completo para o arquivo de chave JSON da conta de serviço (opção 1):
  - Linux: /opt/observiq-otel-collector/ingestion-auth.json
  - Windows: C:\Program Files\observIQ OpenTelemetry Collector\ingestion-auth.json
- customer_id: ID do cliente copiado do console do Google SecOps
- location: substitua <LOCATION> pela região da sua instância do Google SecOps (por exemplo, us, europe ou asia-southeast1). O exportador adiciona esse valor ao prefixo chronicle.googleapis.com. Consulte Endpoints regionais para ver a lista completa.
- project: substitua <PROJECT_NUMBER> pelo número do projeto em IAM e administrador > Configurações.
- endpoint: mantenha definido como chronicle.googleapis.com.

Exportador da API de ingestão legada

Se você usar o arquivo de autenticação de ingestão da opção 2, substitua o bloco exporters pelo seguinte. Defina creds_file_path como o caminho para o arquivo de autenticação de ingestão e, se a instância estiver fora dos EUA, substitua malachiteingestion-pa.googleapis.com pelo endpoint regional (por exemplo, europe-malachiteingestion-pa.googleapis.com).
```
exporters:
  chronicle/nginx:
    compression: gzip
    creds_file_path: '/opt/observiq-otel-collector/ingestion-auth.json'
    customer_id: '<customer_id>'
    endpoint: malachiteingestion-pa.googleapis.com
    log_type: NGINX
    raw_log_field: body
```

Salvar o arquivo de configuração

Depois de editar, salve o arquivo:
- Linux: pressione Ctrl+O, depois Enter e, em seguida, 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 em 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 de UDM

Campo de registro	Mapeamento de 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 "INFORMATIVO" 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 `?`
`addr`	`principal.asset.ip`	Mapeado diretamente
`audit_epoch`	`metadata.event_timestamp`	Convertido em 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 os nanossegundos 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 `-`
`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`	Mapeado diretamente, após converter a representação de string em uma matriz JSON e extrair 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 `-`
	`metadata.event_type`	Definido como `GENERIC_EVENT` inicialmente, depois possivelmente substituído com base em outros campos, como `terminal` e `protocol`. O padrão será `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 alterações
`domain_part`	`event.idm.read_only_udm.intermediary.administrative_domain`	Mapeado do registro de alterações
`location_part`	`event.idm.read_only_udm.intermediary.location.name`	Mapeado do registro de alterações
`labels.compute_googleapis_com/resource_name`	`event.idm.read_only_udm.target.hostname`	Mapeado do registro de alterações
`resource.labels.instance_id`	`event.idm.read_only_udm.target.resource.product_object_id`	Mapeado do registro de alterações
`resource.labels.project_id`	`event.idm.read_only_udm.target.resource_ancestors.name`	Mapeado do registro de alterações
`resource.labels.zone`	`event.idm.read_only_udm.target.resource.attribute.cloud.availability_zone`	Mapeado do registro de alterações
`resource.type`	`event.idm.read_only_udm.target.resource.resource_type`	Mapeado do registro de alterações
`insertId`	`event.idm.read_only_udm.metadata.product_log_id`	Mapeado do registro de alterações
`jsonPayload.latency`	`event.idm.read_only_udm.additional.fields`	Mapeado do registro de alterações
`remoteIp`	`event.idm.read_only_udm.target.ip`	Mapeado do registro de alterações
`jsonPayload.requestMethod`	`event.idm.read_only_udm.network.http.method`	Mapeado do registro de alterações
`jsonPayload.requestSize`	`event.idm.read_only_udm.network.sent_bytes`	Mapeado do registro de alterações
`jsonPayload.requestUrl`	`event.idm.read_only_udm.network.http.referral_url`	Mapeado do registro de alterações
`jsonPayload.responseSize`	`event.idm.read_only_udm.network.received_bytes`	Mapeado do registro de alterações
`jsonPayload.serverIp`	`event.idm.read_only_udm.target.ip`	Mapeado do registro de alterações
`jsonPayload.status`	`event.idm.read_only_udm.network.http.response_code`	Mapeado do registro de alterações
`jsonPayload.userAgent`	`event.idm.read_only_udm.network.http.user_agent`	Mapeado do registro de alterações
`jsonPayload.userAgent`	`event.idm.read_only_udm.network.http.parsed_user_agent`	Mapeado do registro de alterações
`labels`	`event.idm.read_only_udm.additional.fields`	Mapeado do registro de alterações
`terminal`	`event.idm.read_only_udm.additional.fields`	Mapeado do registro de alterações
`logName`	`event.idm.read_only_udm.additional.fields`	Mapeado do registro de alterações
`resource.labels`	`event.idm.read_only_udm.target.resource.attribute.labels`	Mapeado do registro de alterações
`resource.type`	`event.idm.read_only_udm.target.resource.attribute.labels`	Mapeado do registro de alterações
`resource.name`	`event.idm.read_only_udm.target.resource.name`	Mapeado do registro de alterações
`timestamp`	`event.idm.read_only_udm.metadata.event_timestamp`	Mapeado do registro de alterações
`user_agent`	`event.idm.read_only_udm.network.http.parsed_user_agent`	Mapeado do registro de alterações

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.