Coletar registros de firewall do OPNsense

Compatível com:

Neste documento, explicamos como ingerir registros de firewall do OPNsense no Google Security Operations usando o agente do Bindplane.

O OPNsense é uma plataforma de firewall e roteamento de código aberto que gera mensagens de syslog para correspondências de regras de firewall, conexões de rede e eventos do sistema. O analisador extrai campos de mensagens de filterlog formatadas em CSV usando a análise de grok e CSV 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 firewall do OPNsense
  • 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 do Bindplane.
  • Acesso administrativo à interface da Web do OPNsense

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.
  1. Faça login no console doGoogle Cloud e selecione o projeto do Google Cloud 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 um papel e escolha Editor do Chronicle.
  7. Clique em Continuar e depois em Concluído.
  8. Clique na conta de serviço que você criou e acesse a guia Chaves.
  9. Clique em Adicionar chave > Criar nova chave.
  10. Selecione JSON e clique em Criar. O download do arquivo de chave é feito no 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 salvou.
  12. 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)

  1. Faça login no console do Google SecOps.
  2. Acesse Configurações > Gerenciamento de dados > Agentes de coleta. Se você estiver em uma plataforma somente SIEM, acesse Configurações > Agentes de coleta.
  3. Faça o download do arquivo de autenticação de ingestão.
  4. Salve o arquivo com segurança no sistema em que o agente do Bindplane será instalado.

Receber o ID de cliente do Google SecOps

  1. Faça login no console do Google SecOps.
  2. Acesse Configurações > Administração > Perfil. Se você estiver em uma plataforma somente SIEM, acesse Configurações > Perfil.
  3. Copie e salve o ID de cliente na seção Detalhes da organização.

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

  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 precisa aparecer como RUNNING.

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 precisa aparecer como active (running).

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 o 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/opnsense:
        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: OPNSENSE
        raw_log_field: body
    
    service:
      pipelines:
        logs/opnsense_to_chronicle:
          receivers:
            - udplog
          exporters:
            - chronicle/opnsense
    

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 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 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/opnsense:
        compression: gzip
        creds_file_path: '/opt/observiq-otel-collector/ingestion-auth.json'
        customer_id: '<customer_id>'
        endpoint: malachiteingestion-pa.googleapis.com
        log_type: OPNSENSE
        raw_log_field: body
    

Salve 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 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"
        

Adicionar a configuração do servidor syslog ao OPNsense

  1. Faça login na interface da Web do OPNsense.
  2. Acesse Sistema > Configurações > Geração de registros.
  3. Na seção Remote Logging, marque a caixa Send logs to remote syslog server.
  4. No campo Servidores Syslog remotos, insira o endereço IP do servidor Syslog, incluindo a porta (por exemplo, 10.10.10.10:514).
  5. Selecione Local0 como o recurso de syslog.
  6. Defina o nível do syslog como Alerta.
  7. Clique em Salvar para aplicar as alterações.

Tabela de mapeamento de UDM

Campo de registro Mapeamento de UDM Lógica
column1 security_result.rule_id Mapeado diretamente de column1.
column10 additional.fields[].key: "tos"
additional.fields[].value.string_value: valor de column10
Mapeado diretamente de column10, aninhado em additional.fields com a chave "tos".
column12 additional.fields[].key: "ttl"
additional.fields[].value.string_value: valor de column12
Mapeado diretamente de column12, aninhado em additional.fields com a chave "ttl".
column13 additional.fields[].key: "Id"
additional.fields[].value.string_value: valor de column13
Mapeado diretamente de column13, aninhado em additional.fields com a chave "Id".
column14 additional.fields[].key: "offset"
additional.fields[].value.string_value: valor de column14
Mapeado diretamente de column14, aninhado em additional.fields com a chave "offset".
column15 additional.fields[].key: "flags"
additional.fields[].value.string_value: valor de column15
Mapeado diretamente de column15, aninhado em additional.fields com a chave "flags".
column17 network.ip_protocol Mapeado diretamente de column17 após a conversão para letras maiúsculas.
column18 network.received_bytes Mapeado diretamente de column18 após a conversão para um número inteiro sem sinal.
column19 principal.ip Mapeado diretamente de column19.
column20 target.ip Mapeado diretamente de column20.
column21 principal.port (se column17 for TCP ou UDP)
additional.fields[].key: "data_length"
additional.fields[].value.string_value: valor extraído (se column17 for ICMP, GRE, ESP ou IGMP)
Se column17 for TCP/UDP, mapeado diretamente de column21 e convertido em número inteiro. Caso contrário, o valor "datalength" será extraído usando grok e colocado em additional.fields com a chave "data_length".
column22 target.port Mapeado diretamente de column22 se column17 for TCP ou UDP e convertido em número inteiro.
column24 additional.fields[].key: "tcp_flags"
additional.fields[].value.string_value: valor de column24
Mapeado diretamente de column24 se column17 for TCP, aninhado em additional.fields com a chave "tcp_flags".
column29 additional.fields[].key: "tcp_options"
additional.fields[].value.string_value: valor de column29
Mapeado diretamente de column29 se column17 for TCP, aninhado em additional.fields com a chave "tcp_options".
column4 additional.fields[].key: "tracker"
additional.fields[].value.string_value: valor de column4
Mapeado diretamente de column4, aninhado em additional.fields com a chave "tracker".
column5 additional.fields[].key: "interface"
additional.fields[].value.string_value: valor de column5
Mapeado diretamente de column5, aninhado em additional.fields com a chave "interface".
column6 security_result.rule_type Mapeado diretamente de column6.
column7 security_result.action Mapeado de column7. Se for "block", será convertido para "BLOCK" em letras maiúsculas. Se for "pass", defina como "ALLOW".
column8 network.direction Mapeado de column8. Se for "in", defina como "INBOUND". Se for "out", defina como "OUTBOUND".
domain principal.administrative_domain Mapeado diretamente do domain extraído pelo Grok. Defina como "NETWORK_CONNECTION" se os endereços IP principal e de destino estiverem presentes. Caso contrário, defina como "GENERIC_EVENT". Fixado no código como "OPNSENSE". Fixado no código como "OPNSENSE".
message Vários campos Analisado usando filtros grok e csv para extrair vários campos. Consulte outras linhas para mapeamentos específicos.
ts metadata.event_timestamp.seconds, timestamp.seconds Analisado do campo de mensagem usando grok e convertido em um carimbo de data/hora. O valor de segundos é usado para preencher metadata.event_timestamp.seconds e timestamp.seconds.
application principal.application Mapeado diretamente do application extraído pelo Grok.
column27 event.idm.read_only_udm.additional.fields Mapeado do registro de alterações
column2 event.idm.read_only_udm.additional.fields Mapeado do registro de alterações
column3 event.idm.read_only_udm.additional.fields Mapeado do registro de alterações
column11 event.idm.read_only_udm.additional.fields Mapeado do registro de alterações
column26 event.idm.read_only_udm.additional.fields Mapeado do registro de alterações
column28 event.idm.read_only_udm.additional.fields Mapeado do registro de alterações
column25 event.idm.read_only_udm.additional.fields Mapeado do registro de alterações
column16 event.idm.read_only_udm.additional.fields Mapeado do registro de alterações
column9 event.idm.read_only_udm.additional.fields Mapeado do registro de alterações

Registro de alterações

Confira o registro de alterações deste analisador

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