Coletar registros do uberAgent

Compatível com:

Google SecOps SIEM

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

O uberAgent é uma plataforma de análise de segurança de endpoints e monitoramento da experiência do usuário para Windows e macOS. Ele coleta dados de telemetria, incluindo eventos de processo, eventos de logon, conexões de rede e uso de aplicativos em endpoints monitorados.

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 os endpoints do uberAgent
• 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 privilegiado ao console de gerenciamento do uberAgent ou aos endpoints em que ele está instalado

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 um papel 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 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 vai aparecer 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 registros 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:
    filelog:
      include:
        - 'C:\uberAgent\logs\*.log'
        - 'C:\uberAgent\logs\*.csv'
      start_at: beginning
      poll_interval: 5s
  
  exporters:
    chronicle/uberagent:
      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: 'C:\Program Files\observIQ OpenTelemetry Collector\ingestion-auth.json'
      customer_id: '<customer_id>'
      endpoint: chronicle.googleapis.com
      log_type: UBERAGENT
      raw_log_field: body
      ingestion_labels:
        env: production
  
  service:
    pipelines:
      logs/uberagent_to_chronicle:
        receivers:
          - filelog
        exporters:
          - chronicle/uberagent
  

Parâmetros de configuração

Substitua os seguintes marcadores de posição:

• Configuração do receptor :

  • include: caminhos para arquivos de registro do uberAgent:
    • Windows (local): C:\uberAgent\logs\*.log e C:\uberAgent\logs\*.csv
    • Windows (compartilhamento de arquivos): \\SERVER\Share\uberagent-logs\*.log
    • Ajuste o caminho com base na configuração de saída do arquivo do uberAgent
  • start_at: defina como beginning para ler os registros atuais ou end para ler apenas novas entradas
  • poll_interval: com que frequência verificar novos dados de registro (padrão: 5s)

• Configuração do exportador :

  • uberagent: nome descritivo 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 da etapa anterior
  • 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.
  • UBERAGENT: tipo de registro exatamente como aparece no Chronicle
  • ingestion_labels: rótulos opcionais no formato YAML (por exemplo, env: production)

• Configuração do pipeline :

  • uberagent_to_chronicle: nome descritivo do pipeline

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/uberagent:
      compression: gzip
      creds_file_path: 'C:\Program Files\observIQ OpenTelemetry Collector\ingestion-auth.json'
      customer_id: '<customer_id>'
      endpoint: malachiteingestion-pa.googleapis.com
      log_type: UBERAGENT
      raw_log_field: body
      ingestion_labels:
        env: production
  

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 a saída de arquivos do uberAgent

O uberAgent oferece suporte a vários back-ends de saída. Para exportar dados como arquivos para coleta pelo agente do Bindplane:

1. Abra o arquivo de configuração do uberAgent (uberAgent.conf) no endpoint ou pela Política de Grupo.

2. Configure um receptor de saída baseado em arquivo:

   [Receiver]
   Name = FileOutput
   Type = File
   Path = C:\uberAgent\logs\
   

   Observação: Substitua C:\uberAgent\logs\` with the desired output path. For centralized collection, use a network file share path such as\SERVER\Share\uberagent-logs`. O uberAgent gera dados no formato CSV por padrão.

3. Configure as métricas e os tipos de origem a serem exportados:

   • Processo: eventos de início/parada do processo, uso de recursos.
   • Logon: eventos de logon/logoff do usuário.
   • Rede: eventos de conexão de rede.
   • Aplicativo: uso e erros do aplicativo.

4. Salve a configuração e reinicie o serviço do uberAgent.

5. Verifique se os arquivos de registro estão sendo criados no diretório de saída configurado.

6. Verifique se o agente do Bindplane tem permissões de leitura no diretório e nos arquivos de registro.

   **Observação**: para opções de configuração detalhadas, consulte a documentação do uberAgent.

Tabela de mapeamento de UDM

Campo de registro	Mapeamento de UDM	Lógica
SessionRpLatencyMs2, SessionHRes, SessionVRes, SessionColorDepth, SessionClientPlatform, SessionClientVersion, SessionClientOsLanguage, SessionPublishedName, SessionPublishedAppsCtx, SessionAppStateCtx, SessionEncryptionCtx, SessionClientTypeCtx, SessionBrokerDnsVmw, SessionBrokerUrlVmw, SessionBrokerTunneledVmw, SessionBrokerTunnelUrlVmw, SessionBrokerRemoteIpVmw, SessionBrokerUserVmw, SessionBrokerDomainVmw, SessionClientTimezoneVmw, SessionClientIdVmw, SessionTypeVmw, SessionBrokerType, SessionFgAppId, SessionFgAppVersion, SessionFgProcessName, SessionFgProcessId, SessionFgBrowserType, SessionFgBrowserActiveTabHost, SessionFgWindowTitle, SessionClientHwIdCtx2, SessionRoundTripTimeMs, SessionFps, SessionTransportProtocols, SessionProcessCount, SessionIOMB, SessionCPUTimeMs, SessionConnectionState, SessionUser, SessionIOCount, SessionNetKBPS, SessionWorkingSetMB, SessionCPUUsagePercent, SessionIOPS, SessionClientName, SessionIOLatencyMs, PowerSupportsS3, IsBatteryPresent, PowerSupportsS1, PowerSupportsS2, PowerSupportsS5, CPUMaxMhz, BaseboardSerial, CtxMachineCatalogName, AdDomainDns, HwHypervisorVendor, OsBuild, HwBiosVersion, PowerSupportsS4, HwIsVirtualMachine, IsUpsPresent, PowerSupportsConnectedStandby, OsInstallDate, Sourcetype, uberagent_index_name, data_stream.namespace, data_stream.dataset, data_stream.type, data_stream.subset, CPUCoresLogical, AdOu, AdDomainNetBios, logstash_pipeline, AdSite, CtxFarmName, CPUSockets, OsSpName, OsName, OsType, OsUpdateBuildRevision, ComputerNameCanonical, ComputerNameDn, CtxDeliveryGroupName, tags, user_agent.original	additional.fields	Mesclado como pares de chave-valor dos campos listados
	metadata.event_type	Definido como STATUS_UPDATE se has_principal for verdadeiro e has_target for falso, NETWORK_CONNECTION se ambos forem verdadeiros, GENERIC_EVENT caso contrário
SessionGUID	metadata.product_log_id	Valor copiado diretamente
user_agent.original	network.http.parsed_user_agent	Convertido para user agent analisado
user_agent.original	network.http.user_agent	Valor copiado diretamente
SessionTransportProtocols	network.ip_protocol	Definido como UDP se corresponder a (?i)udp, TCP se (?i)tcp
SessionID	network.session_id	Valor copiado diretamente
SessionClientUserDomain	principal.administrative_domain	Valor copiado diretamente
CPUCoresPhysical, RAMSizeGB, CPUName, HwManufacturer, OsArchitecture, BIOSSerial, HwModel	principal.asset.hardware	Mesclado no objeto de hardware
SessionClientDomain, host	principal.asset.hostname	Valor de SessionClientDomain se não estiver vazio, caso contrário, host
prin_ip, SessionClientIp, system_ip	principal.asset.ip	Valor de prin_ip se não estiver vazio, caso contrário, SessionClientIp, caso contrário, system_ip
SessionClientDomain, host	principal.hostname	Valor de SessionClientDomain se não estiver vazio, caso contrário, host
prin_ip, SessionClientIp, system_ip	principal.ip	Valor de prin_ip se não estiver vazio, caso contrário, SessionClientIp, caso contrário, system_ip
SessionClientMac	principal.mac	Valor de SessionClientMac, com - substituído por :, minúsculo
SessionClientPlatform	principal.platform	Definido como WINDOWS se corresponder a (?i)windows
SessionClientVersion	principal.platform_version	Definido como valor se corresponder a (?i)windows
SessionUser, SessionClientUser	principal.user.user_display_name	Valor de SessionUser se não estiver vazio, caso contrário, SessionClientUser
SessionBrokerRemoteIpVmw	target.ip	Valor copiado diretamente
SessionBrokerUserVmw	target.user.user_display_name	Valor copiado diretamente
SessionClientIdVmw	target.user.userid	Valor copiado diretamente
	metadata.product_name	Definido como "UBERAGENT"
	metadata.vendor_name	Definido como "UBERAGENT"

Registro de alterações

Consulte o registro de alterações deste analisador

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