Coletar registros do pfSense

Compatível com:

Google SecOps SIEM

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

O pfSense é uma distribuição de software de firewall e roteador de código aberto baseada no FreeBSD. Ele oferece filtragem de pacotes com estado, VPN, ajuste da programação, NAT, servidor DHCP, encaminhador de DNS e recursos de detecção de intrusões, tudo gerenciado por uma interface baseada na Web. O analisador extrai campos de registros formatados do syslog do pfSense. Ele usa o grok para analisar a mensagem de registro e mapeia esses valores para o modelo de dados unificado (UDM). Ele também define valores de metadados padrão para a origem e o tipo do evento.

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
• Se estiver em execução atrás de um proxy, verifique se as portas do firewall estão abertas de acordo com os requisitos do agente do Bindplane.
• Acesso privilegiado à interface da Web do pfSense

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)

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.

Observação :a chave JSON é uma credencial. Restrinja o acesso ao arquivo no host do BindPlane e alterne 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. 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.

Observação: esse arquivo autentica o agente na API Ingestion legada (malachiteingestion-pa.googleapis.com), que o Google programou para ser desativada em 20 de julho de 2027. Planeje migrar 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 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 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.

Observação: a configuração do exportador da API Chronicle requer o coletor Bindplane v1.106.0 ou mais recente. Os comandos anteriores instalam a versão mais recente. Se você estiver atualizando uma instalação, 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/chronicle_w_labels:
      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: '/path/to/ingestion-authentication-file.json'
      customer_id: 'YOUR_CUSTOMER_ID'
      endpoint: chronicle.googleapis.com
      log_type: 'PFSENSE'
      raw_log_field: body
      ingestion_labels:
  
  service:
    pipelines:
      logs/source0__chronicle_w_labels-0:
        receivers:
          - udplog
        exporters:
          - chronicle/chronicle_w_labels
  

Parâmetros de configuração

• Substitua os seguintes marcadores de posição:

  • Configuração do receptor:

    • udplog: use udplog para syslog UDP ou tcplog para syslog TCP.
    • 0.0.0.0: endereço IP para detectar (0.0.0.0 para detectar em todas as interfaces)
    • 514: número da porta a ser detectada (porta syslog padrão)

  • 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
    • YOUR_CUSTOMER_ID: ID de cliente da seção "Receber ID de cliente"
    • 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.
    • log_type: tipo de registro exatamente como aparece no Chronicle (PFSENSE)

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/chronicle_w_labels:
      compression: gzip
      creds_file_path: '/path/to/ingestion-authentication-file.json'
      customer_id: 'YOUR_CUSTOMER_ID'
      endpoint: malachiteingestion-pa.googleapis.com
      log_type: 'PFSENSE'
      raw_log_field: body
      ingestion_labels:
  

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

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 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 encaminhamento do Syslog no pfSense

O pfSense é executado no FreeBSD e oferece uma interface baseada na Web para todas as tarefas de configuração, incluindo o encaminhamento remoto de syslog.

1. Faça login na interface da Web do pfSense.
2. Acesse Status > Registros do sistema > Configurações.
3. Acesse a seção Opções de registro remoto.
4. Selecione Ativar registro remoto.
5. Informe os seguintes detalhes de configuração:
   • Endereço de origem: selecione Qualquer (ou uma interface específica).
   • Protocolo IP: selecione IPv4.
   • Servidores de registro remoto: digite BINDPLANE_IP:514 no primeiro campo disponível. Substitua BINDPLANE_IP pelo endereço IP do host do agente do BindPlane.
6. Na seção Conteúdo do Syslog remoto, selecione as categorias de registro que serão encaminhadas:
   • Eventos do sistema
   • Eventos de firewall
   • Eventos de DNS (Resolver/unbound, Forwarder/dnsmasq)
   • Eventos DHCP (serviço DHCP)
   • Eventos de PPP
   • Eventos de autenticação (autenticação do portal, RADIUS)
   • Eventos de VPN (IPsec, OpenVPN, L2TP)
   • Eventos do gateway (monitor do gateway)
   • Eventos de roteamento (daemon de roteamento)
   • Eventos do NTP
   • Pacotes (pacotes instalados)
7. Clique em Salvar.
8. Verifique se as mensagens syslog estão sendo enviadas conferindo os registros do agente Bindplane.

Tabela de mapeamento de UDM

Campo de registro	Mapeamento de UDM	Lógica
aplicativo	principal.application	O valor é extraído da mensagem de registro usando padrões grok. Nas mensagens do syslog, o nome do aplicativo geralmente é encontrado após o nome do host e o carimbo de data/hora.
comando	principal.process.command_line	Extraído do campo de descrição quando o registro indica uma execução de comando.
descrição	metadata.description	O campo de descrição é mapeado para a descrição de metadados do UDM, exceto para registros de aplicativos syslog-ng, em que é mapeado para metadata.description. Para eventos de DHCP, o dhcp_type é adicionado antes da descrição.
dhcp_type	metadata.product_event_type	O tipo de mensagem DHCP (por exemplo, DHCPDISCOVER, DHCPOFFER) é extraído e mapeado.
host	intermediary.hostname OU intermediary.ip	Se o valor do host for um endereço IP válido, ele será mapeado para intermediary.ip. Caso contrário, ele será mapeado para intermediary.hostname.
host	principal.hostname, principal.asset.hostname	Quando nenhum IP principal está presente, o host é tratado como o nome do host principal.
mac	principal.mac, network.dhcp.chaddr	O endereço MAC associado a uma solicitação DHCP é extraído e mapeado.
src_ip	principal.ip, principal.asset.ip	Extraído de formatos de registro específicos usando um padrão grok.
src_mac	principal.mac	Extraído de formatos de registro específicos usando um padrão grok.
dst_mac	target.mac	Extraído de formatos de registro específicos usando um padrão grok.
timestamp	metadata.event_timestamp	O carimbo de data/hora é extraído da mensagem de registro e convertido para um formato de carimbo de data/hora da UDM. As informações de fuso horário (tz) são anexadas ao carimbo de data/hora antes da conversão, se disponíveis.
timestamp_no_year	metadata.event_timestamp	Se houver um carimbo de data/hora sem um ano, ele será analisado, e o ano atual será adicionado durante o processo de análise.
usuário	principal.user.userid	O nome de usuário associado a um evento é extraído e mapeado.
column1	security_result.rule_id	Mapeado da primeira coluna do CSV se a descrição estiver no formato CSV.
column6	security_result.rule_type	Mapeado da sexta coluna CSV se a descrição estiver nesse formato.
column7	security_result.action	Mapeado da sétima coluna CSV se a descrição estiver no formato CSV. Convertido em "BLOCK" ou "ALLOW".
column8	network.direction	Mapeado da oitava coluna do CSV se a descrição estiver nesse formato. Convertido em "INBOUND" ou "OUTBOUND".
column13	network.ip_protocol (se UDP ou ICMP)	Mapeado da décima terceira coluna CSV se a descrição estiver no formato CSV e o protocolo for UDP ou ICMP. Para eventos TCP/UDP, ele é usado para criar um campo adicional com a chave "Id".
column16	principal.ip, principal.asset.ip (se IPv6 e column9 for 6)	Mapeado da 16ª coluna do CSV se a descrição estiver no formato CSV e column9 for 6. Para eventos TCP/UDP, ele é usado para identificação de protocolo se a coluna9 for 4.
column17	target.ip, target.asset.ip (se IPv6 e não ip_failure)	Mapeado da décima sétima coluna CSV se a descrição estiver no formato CSV, column9 for 6 e o valor for um IP válido. Para eventos TCP/UDP, ele é usado para identificação de protocolo.
column18	principal.port (se UDP)	Mapeado da décima oitava coluna CSV se a descrição estiver no formato CSV e o protocolo for UDP. Para eventos TCP/UDP, ele é mapeado para network.received_bytes.
column19	target.port (se UDP)	Mapeado da 19ª coluna CSV se a descrição estiver no formato CSV e o protocolo for UDP. Para eventos de DHCP, ele é mapeado para network.dhcp.yiaddr. Para outros eventos, ele é mapeado para principal.ip, principal.asset.ip.
column20	additional.fields (key: "data_length") (se UDP)	Mapeado da vigésima coluna CSV se a descrição estiver no formato CSV e o protocolo for UDP. Para outros eventos, ele é mapeado para target.ip, target.asset.ip.
column21	principal.port (se TCP/UDP)	Mapeado da vigésima primeira coluna CSV se a descrição estiver no formato CSV e o protocolo for TCP ou UDP.
column22	target.port (se TCP/UDP)	Mapeado da 22ª coluna CSV se a descrição estiver no formato CSV e o protocolo for TCP ou UDP.
column23	additional.fields (chave: "data_length") (se TCP/UDP)	Mapeado da 23ª coluna CSV se a descrição estiver no formato CSV e o protocolo for TCP ou UDP.
column24	additional.fields (key: "tcp_flags") (se TCP)	Mapeado da 24ª coluna CSV se a descrição estiver no formato CSV e o protocolo for TCP.
column25	additional.fields (chave: "sequence_number") (se TCP/UDP)	Mapeado da 25ª coluna CSV se a descrição estiver no formato CSV e o protocolo for TCP ou UDP.
column29	additional.fields (chave: "tcp_options") (se TCP)	Mapeado da 29ª coluna CSV se a descrição estiver no formato CSV e o protocolo for TCP.
compression_algo	additional.fields (chave: "Compression Algorithm")	Extraído do campo de descrição e adicionado como um campo extra.
desc	metadata.description	Extraído do campo de mensagem e usado como descrição.
principal_ip	principal.ip, principal.asset.ip	Extraído do campo de descrição e representa o endereço IP principal.
principal_username	principal.user.userid	Extraído do campo de descrição e representa o nome de usuário principal.
status	security_result.detection_fields (key: "status")	Extraído do campo de descrição e adicionado como um campo de detecção no resultado de segurança.
target_host	target.hostname, target.asset.hostname	Extraído do campo de descrição, representa o nome do host de destino.
src_port	principal.port	Extraído do campo de descrição e representa a porta de origem. Determinado com base em vários campos de registro e na lógica do analisador. Pode ser NETWORK_CONNECTION, NETWORK_DHCP, STATUS_UPDATE ou GENERIC_EVENT. Fixado no código como "PFSENSE". Fixado no código como "PFSENSE". Fixado no código como "PFSENSE". Definido como "DHCP" para eventos de DHCP. Defina como "BOOTREQUEST" para DHCPDISCOVER e DHCPREQUEST e "BOOTREPLY" para DHCPOFFER e DHCPACK. Defina como "DISCOVER", "REQUEST", "OFFER" ou "ACK" com base no campo dhcp_type.
pid	intermediary.process.pid	Mapeado do registro de alterações
application	intermediary.application	Mapeado do registro de mudanças
ipv4" and "ipv6	principal.ip	Mapeado do registro de mudanças
security_result.category	AUTH_VIOLATION	Mapeado do registro de mudanças
method	network.http.method	Mapeado do registro de mudanças
referer	network.http.referral_url	Mapeado do registro de mudanças
response_code	network.http.response_code	Mapeado do registro de mudanças
user_agent	network.http.user_agent	Mapeado do registro de mudanças
sent_bytes	network.sent_bytes	Mapeado do registro de mudanças
url	target.url	Mapeado do registro de mudanças
http_version	additional.fields	Mapeado do registro de mudanças
column19" which is "source-address	network.dhcp.yiaddr	Mapeado do registro de mudanças
column17" which is "destination-address	target.ip	Mapeado do registro de mudanças
column16" which is "source-address	principal.ip	Mapeado do registro de mudanças
column12" which is "hop_limit	additional.fields	Mapeado do registro de mudanças
column13" which is "ip_protocol	network.ip_protocol	Mapeado do registro de mudanças
ttl	additional.fields	Mapeado do registro de mudanças
Offset	additional.fields	Mapeado do registro de mudanças
Data length	additional.fields	Mapeado do registro de mudanças
Length	additional.fields	Mapeado do registro de mudanças
Sequence-number	additional.fields	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.