Coletar registros de VPN da F5

Versão do analisador:2.0

Compatível com:

Google SecOps SIEM

Neste documento, explicamos como ingerir registros de VPN da F5 no Google Security Operations usando o agente do Bindplane.

O F5 BIG-IP Access Policy Manager (APM) é uma solução de VPN e gerenciamento de acesso que gera mensagens syslog para autenticação de usuários, gerenciamento de sessões, avaliação de políticas, estabelecimento de túneis e eventos de acesso à rede. O analisador extrai campos de registros formatados em syslog 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 dispositivo F5 BIG-IP
• 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 ao tmsh do F5 BIG-IP (versão 11.x ou posterior)

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 consoleGoogle Cloud e selecione o projeto 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 uma função 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 arquivo de chave é baixado para o 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 a configuração do 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: 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 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 vai aparecer 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 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.

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, 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/f5_vpn:
      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: F5_VPN
      raw_log_field: body
  
  service:
    pipelines:
      logs/f5_vpn_to_chronicle:
        receivers:
          - udplog
        exporters:
          - chronicle/f5_vpn
  

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

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 de syslog no F5 BIG-IP APM

1. Conecte-se à linha de comando do F5 BIG-IP.

2. Abra o shell tmsh:

   tmsh
   

3. Configure um servidor syslog remoto executando o seguinte comando:

   modify sys syslog remote-servers add { <Name> { host <bindplane-ip> remote-port <bindplane-port> } }
   

   Substitua:

   • <Name>: um nome exclusivo para esse destino do syslog (por exemplo, bindplane_server).
   • <bindplane-ip>: o endereço IP do host do agente do Bindplane.
   • <bindplane-port>: a porta configurada no receptor do agente do Bindplane (padrão: 514).

4. Salve a configuração:

   save sys config partitions all
   

Tabela de mapeamento de UDM

Campo de registro	Mapeamento de UDM	Lógica
cmd_data	principal.process.command_line	O valor é extraído do campo msg
errdefs_msgno	additional.fields.errdefs_msgno.string_value	O valor é extraído do campo msg
event_time	metadata.event_timestamp	O valor é analisado e convertido em um carimbo de data/hora.
hostname	principal.hostname,, observer.hostname,, principal.asset.hostname,, observer.asset.hostname,	O valor é extraído do campo de mensagem e usado para preencher os campos de nome do host na UDM. Também usado para preencher o campo hostip
msg	security_result.description	O valor é extraído do campo de mensagem e usado para preencher o campo de descrição no objeto "security_result".
prin_ip	principal.ip,, principal.asset.ip	O valor é extraído do campo de mensagem e usado para preencher os campos de endereço IP no UDM.
	additional.fields.Canonical_Info.string_value	O valor é derivado da mensagem de registro
	additional.fields.IDP.string_value	O valor é derivado da mensagem de registro.
	additional.fields.Plugin_Support.string_value	O valor é derivado da mensagem de registro
	additional.fields.SMB, Stage.string_value	O valor é derivado da mensagem de registro.
	additional.fields.SP.string_value	O valor é derivado da mensagem de registro.
	additional.fields.Timezone.string_value	O valor é derivado da mensagem de registro.
	additional.fields.Tunnel, Type.string_value	O valor é derivado da mensagem de registro.
	additional.fields.UI_Mode.string_value	O valor é derivado da mensagem de registro.
	additional.fields.Version.string_value	O valor é derivado da mensagem de registro.
	additional.fields.from_rule_item.string_value	O valor é derivado da mensagem de registro.
	additional.fields.policy_result.string_value	O valor é derivado da mensagem de registro.
	additional.fields.ppp_id.string_value	O valor é derivado da mensagem de registro.
	additional.fields.resource.string_value	O valor é derivado da mensagem de registro.
	additional.fields.rule.string_value	O valor é derivado da mensagem de registro.
	additional.fields.server_vip_ip.string_value	O valor é derivado da mensagem de registro.
	additional.fields.server_vip_name.string_value	O valor é derivado da mensagem de registro.
	additional.fields.to_rule_item.string_value	O valor é derivado da mensagem de registro.
	additional.fields.tunnel_resource.string_value	O valor é derivado da mensagem de registro.
	metadata.description	O valor é derivado da mensagem de registro.
	metadata.event_type	O valor é codificado no código do analisador para alguns eventos e é derivado da mensagem de registro para outros
	metadata.log_type	O valor é definido como o tipo de lote.
	metadata.product_event_type	O valor é derivado da mensagem de registro.
	metadata.product_name	O valor é fixado no código do analisador.
	metadata.vendor_name	O valor é fixado no código do analisador.
	network.application_protocol	O valor é derivado da mensagem de registro
	network.direction	O valor é derivado da mensagem de registro.
	network.http.method	O valor é derivado da mensagem de registro
	network.http.parsed_user_agent	O valor é derivado do campo network.http.user_agent.
	network.http.referral_url	O valor é derivado da mensagem de registro.
	network.http.response_code	O valor é derivado da mensagem de registro.
	network.http.user_agent	O valor é derivado da mensagem de registro.
	network.ip_protocol	O valor é derivado da mensagem de registro.
	network.received_bytes	O valor é derivado da mensagem de registro.
	network.sent_bytes	O valor é derivado da mensagem de registro.
	network.session_id	O valor é derivado da mensagem de registro.
	network.tls.cipher	O valor é derivado da mensagem de registro.
	network.tls.version	O valor é derivado da mensagem de registro
	observer.asset.hostname	O valor é definido como o campo "Nome do host".
	observer.asset.ip	O valor é definido como o campo hostip.
	observer.hostname	O valor é definido como o campo de nome do host.
	observer.ip	O valor é definido como o campo "hostip".
	principal.application	O valor é derivado da mensagem de registro
	principal.asset.hostname	O valor é definido como o campo de nome do host.
	principal.asset.ip	O valor é definido como o campo hostip ou prin_ip, se houver.
	principal.asset.product_object_id	O valor é derivado da mensagem de registro
	principal.hostname	O valor é definido como o campo de nome do host.
	principal.ip	O valor é definido como o campo hostip ou prin_ip, se houver.
	principal.location.country_or_region	O valor é derivado da mensagem de registro
	principal.platform	O valor é derivado da mensagem de registro.
	principal.port	O valor é derivado da mensagem de registro.
	principal.process.command_line	O valor é derivado da mensagem de registro.
	principal.process.pid	O valor é derivado da mensagem de registro.
	principal.resource.name	O valor é derivado da mensagem de registro.
	principal.resource.type	O valor é codificado no código do analisador para alguns eventos e derivado da mensagem de registro para outros.
	principal.user.email_addresses	O valor é derivado da mensagem de registro
	principal.user.userid	O valor é derivado da mensagem de registro.
	security_result.action	O valor é derivado da mensagem de registro.
	security_result.description	O valor é derivado da mensagem de registro.
	security_result.rule_name	O valor é derivado da mensagem de registro.
	security_result.severity	O valor é derivado da mensagem de registro.
	security_result.severity_details	O valor é derivado da mensagem de registro.
	security_result.summary	O valor é derivado da mensagem de registro.
	src.ip	O valor é derivado da mensagem de registro.
	src.location.country_or_region	O valor é derivado da mensagem de registro.
	src.port	O valor é derivado da mensagem de registro.
	target.asset.hostname	O valor é derivado da mensagem de registro.
	target.asset.ip	O valor é derivado da mensagem de registro.
	target.hostname	O valor é derivado da mensagem de registro.
	target.ip	O valor é derivado da mensagem de registro.
	target.port	O valor é derivado da mensagem de registro.
	target.process.command_line	O valor é derivado da mensagem de registro.
	target.process.pid	O valor é derivado da mensagem de registro.
	target.resource.id	O valor é derivado da mensagem de registro.
	target.url	O valor é derivado da mensagem de registro.
	target.user.userid	O valor é derivado da mensagem de registro
Hostname	target.hostname	Mapeado do registro de alterações
sess_id	network.session_id	Mapeado do registro de alterações
internal_ip	target.ip	Mapeado do registro de alterações
file_path	principal.resource.name	Mapeado do registro de alterações
useragent	network.http.user_agent	Mapeado do registro de alterações
User-Agent" and "useragent	network.http.parsed_user_agent	Mapeado do registro de alterações
username	target.user.userid	Mapeado do registro de alterações
sid	target.user.windows_sid	Mapeado do registro de alterações
bytes_out	network.sent_bytes	Mapeado do registro de alterações
bytes_in	network.received_bytes	Mapeado do registro de alterações
Platform	principal.platform	Mapeado do registro de alterações
Platform_Version	principal.platform_version	Mapeado do registro de alterações
Javascript_Support", "ActiveX_Support", "Plugin_Support", "Version", "Model", "CPU", "UI_Mode", "SP", "IDP", "to_rule_item", "from_rule_item", "policy_result", "rule", "resource", "ppp_id", "tunnel_resource", "server_vip_ip", "server_vip_name", and "Canonical_Info	additional.fields	Mapeado do registro de alterações
uri_path	target.url	Mapeado do registro de alterações
User-Agent	network.http.user_agent	Mapeado do registro de alterações
s_ip	src.ip	Mapeado do registro de alterações
t_ip	target.ip	Mapeado do registro de alterações
t_port	target.port	Mapeado do registro de alterações
s_nat_ip	target.nat_ip	Mapeado do registro de alterações
cipher_name	network.tls.cipher	Mapeado do registro de alterações
tls_version	network.tls.version	Mapeado do registro de alterações
resource_id	target.resource.id	Mapeado do registro de alterações
src_ip	principal.ip	Mapeado do registro de alterações
status	network.http.response_code	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.