Coletar registros do VyOS

Disponível em:

Google SecOps SIEM

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

O VyOS é um roteador de rede de código aberto que gera mensagens do Syslog para eventos de firewall, mudanças de roteamento, conexões VPN e eventos do sistema.

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 roteador do VyOS
• Se estiver executando em um proxy, verifique se as portas do firewall estão abertas de acordo com os requisitos do agente do Bindplane
• Acesso SSH ao roteador do VyOS com privilégios de administrador

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 descontinuada em 20 de julho de 2027.

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

1. Faça login no Google Cloud console e selecione o Google Cloud projeto vinculado à sua instância do Google SecOps.
2. Acesse IAM e administrador > Contas de serviço.
3. Clique em Criar conta de serviço.
4. 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).
5. Clique em Criar e continuar.
6. Na seção Conceder a essa conta de serviço acesso ao projeto, clique em Selecionar uma função e escolha Editor do Chronicle.
7. Clique em Continuar e depois em Concluído.
8. Clique na conta de serviço criada e acesse a guia Chaves.
9. Selecione Adicionar chave > Criar nova chave.
10. Selecione JSON e clique em Criar. O arquivo de chave é baixado para o seu computador.
11. 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 salva.
12. Acesse IAM e administrador > Configurações e copie o Número do projeto. Você vai precisar dele para a configuração do exportador.

Observação: a chave JSON é uma credencial. Restrinja o acesso ao arquivo no host do Bindplane e gire a chave de acordo com a política da sua organização.

Opção 2: baixar o arquivo de autenticação de ingestão (legado)

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

Observação: esse arquivo autentica o agente na API Ingestion legada (malachiteingestion-pa.googleapis.com), que o Google programou para o fim da vida útil em 20 de julho de 2027. Planeje mudar para a opção 1 antes dessa data.

Receber o ID de cliente do Google SecOps

1. Faça login no console do Google SecOps.
2. Acesse Configurações do SIEM > Perfil.

3. 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 sistema operacional Windows ou Linux de acordo com as instruções a seguir.

Instalação do Windows

1. Abra o prompt de comando ou o PowerShell como administrador.

2. Execute este comando:

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

3. Aguarde a conclusão da instalação.

4. Execute o seguinte comando para confirmar a instalação:

   sc query observiq-otel-collector
   

   O serviço será mostrado como EM EXECUÇÃO.

Instalação do Linux

1. Abra um terminal com privilégios de raiz ou sudo.

2. Execute este comando:

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

3. Aguarde a conclusão da instalação.

4. Execute o seguinte comando para confirmar a instalação:

   sudo systemctl status observiq-otel-collector
   

   O serviço será mostrado como ativo (em execução).

Outros recursos de instalação

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

Observação: a configuração do exportador da API Chronicle requer o coletor do Bindplane v1.106.0 ou mais recente. Os comandos anteriores instalam a versão mais recente. Se você estiver atualizando uma instalação atual, faça upgrade do coletor antes de mudar a configuração.

Configurar o agente do Bindplane para ingerir o 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/vyos:
      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: VYOS
      raw_log_field: body
  
  service:
    pipelines:
      logs/vyos_to_chronicle:
        receivers:
          - udplog
        exporters:
          - chronicle/vyos
  

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 (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 de 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 prefixa chronicle.googleapis.com com esse valor. Consulte Endpoints regionais para 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 Ingestion 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/vyos:
      compression: gzip
      creds_file_path: '/opt/observiq-otel-collector/ingestion-auth.json'
      customer_id: '<customer_id>'
      endpoint: malachiteingestion-pa.googleapis.com
      log_type: VYOS
      raw_log_field: body
  

Observação: esse exportador vai parar de funcionar quando a API Ingestion for descontinuada em 20 de julho de 2027.

Salvar o arquivo de configuração

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

Reiniciar 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 do 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 Syslog no VyOS

1. Conecte-se ao roteador do VyOS usando SSH.

2. Insira o modo de configuração:

   configure
   

3. Configure o host do Syslog remoto (substitua <bindplane-ip> pelo endereço IP do agente do Bindplane):

   set system syslog host <bindplane-ip> facility all level info
   set system syslog host <bindplane-ip> port 514
   set system syslog host <bindplane-ip> protocol udp
   

4. Confirme e salve a configuração:

   commit
   save
   

Tabela de mapeamento de UDM

Campo de registro	Mapeamento de UDM	Lógica
clientIp	principal.ip	Endereço IP do cliente extraído da mensagem DHCP.
clientMac	principal.mac	Endereço MAC do cliente extraído da mensagem DHCP.
datetime	metadata.event_timestamp	O carimbo de data/hora extraído da mensagem de registro.
dst_ipaddress	target.ip	Endereço IP de destino extraído da mensagem de registro.
hostname	observer.hostname	Nome do host extraído da mensagem de registro. Determinado pelo analisador com base no process e em outros campos. Pode ser GENERIC_EVENT, NETWORK_CONNECTION, NETWORK_DHCP ou STATUS_UPDATE. Fixado no código como "VYOS".
msg	metadata.description	A mensagem original do registro ou uma parte dela, dependendo da lógica de análise. Defina como "DHCP Event" se o process for "dhcpd". Fixado no código como "VYOS DHCP". Fixado no código como "VYOS".
network.dhcp.chaddr	network.dhcp.chaddr	Endereço MAC do cliente extraído de mensagens DHCP.
network.dhcp.ciaddr	network.dhcp.ciaddr	Endereço IP do cliente em uma mensagem DHCPREQUEST. Opcode da mensagem DHCP. Defina como "BOOTREQUEST" para DHCPREQUEST e DHCPINFORM, "BOOTREPLY" para DHCPACK e DHCPNAK. Tipo de mensagem DHCP. Derivado de eventType e pode ser REQUEST, ACK, INFORM, NAK ou OFFER.
network.dhcp.yiaddr	network.dhcp.yiaddr	Seu endereço IP (do cliente) em uma mensagem DHCPACK ou DHCPOFFER. Defina como "DHCP" se o process for "dhcpd".
pri_host	principal.hostname	Nome do host associado a um cliente em mensagens DHCP.
rem_msg	metadata.description	Parte restante da mensagem após a análise inicial, usada para descrição em alguns casos.
src_ipaddress	principal.ip	Endereço IP de origem extraído da mensagem de registro.
timestamp	event.timestamp	O carimbo de data/hora da entrada de registro.

Registro de alterações

Consulte o registro de alterações desse analisador

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