Coletar registros do VMware Tanzu

Compatível com:

Google SecOps SIEM

Neste documento, explicamos como ingerir registros do VMware Tanzu no Google Security Operations usando o agente do Bindplane.

O VMware Tanzu é uma plataforma do Kubernetes que gera registros de auditoria formatados em JSON e syslog para eventos do servidor de API Kubernetes, acesso a recursos, decisões de autenticação e mudanças de configuração. O analisador extrai campos de registros de auditoria formatados em JSON 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 Tanzu Operations Manager
• 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 privilegiado ao VMware Tanzu

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: 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.

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 a mudança 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 > 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.

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

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/vmware_tanzu:
      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: VMWARE_TANZU
      raw_log_field: body
  
  service:
    pipelines:
      logs/vmware_tanzu_to_chronicle:
        receivers:
          - udplog
        exporters:
          - chronicle/vmware_tanzu
  

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

Observação: esse exportador vai parar de funcionar quando a API Ingestion for desativada 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 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"
       

Configurar o syslog para o VMware Tanzu

1. Faça login na UI da Web do Tanzu Operations Manager.
2. Selecione seu Nome de usuário e clique em Configurações.
3. Selecione Syslog.
4. Clique em Sim para enviar registros do sistema para um servidor remoto.
5. Informe os seguintes detalhes de configuração:
   • Endereço: insira o endereço IP do agente do BindPlane.
   • Porta: digite o número da porta do agente do BindPlane.
   • Protocolo de transporte: selecione UDP ou TCP, dependendo da configuração do agente do Bindplane.
6. Clique em Salvar.

Tabela de mapeamento de UDM

Campo de registro	Mapeamento de UDM	Lógica
annotations.authorization.k8s.io/decision	security_result.action	Se a anotação authorization.k8s.io/decision existir, o valor dela será convertido em letras maiúsculas. Se o valor em maiúsculas for "ALLOW", o campo UDM será definido como ALLOW. Caso contrário, ele será definido como BLOCK.
annotations.authorization.k8s.io/reason	security_result.description	Se a anotação authorization.k8s.io/reason existir, o valor dela (sem as aspas duplas) será usado.
apiVersion	metadata.product_version	Mapeado diretamente.
auditID	metadata.product_log_id	Mapeado diretamente.
kind	metadata.product_event_type	Mapeado diretamente.
objectRef.name	target.resource.name	Mapeado diretamente.
objectRef.namespace	target.resource.attribute.labels.key, target.resource.attribute.labels.value	O key é definido como "namespace", e o value é extraído de objectRef.namespace.
objectRef.resource	target.resource.resource_subtype	Mapeado diretamente.
objectRef.resourceVersion	target.resource.attribute.labels.key, target.resource.attribute.labels.value	O key é definido como "resourceVersion", e o value é extraído de objectRef.resourceVersion.
objectRef.uid	target.resource.product_object_id	Mapeado diretamente.
requestReceivedTimestamp / timestamp	metadata.event_timestamp	O analisador tenta analisar requestReceivedTimestamp primeiro. Se ele não estiver presente, o campo timestamp extraído do prefixo do syslog será usado.
requestURI	target.url	Mapeado diretamente.
responseStatus.code	network.http.response_code	Mapeado diretamente após ser convertido em um número inteiro.
sourceIPs	principal.ip	Todos os endereços IP na matriz sourceIPs são adicionados à matriz principal.ip.
stage	metadata.description	Mapeado diretamente.
stageTimestamp	metadata.collected_timestamp	Mapeado diretamente.
user.groups	principal.user.group_identifiers	Todos os grupos na matriz user.groups são adicionados à matriz principal.user.group_identifiers.
user.uid	principal.user.userid	Mapeado diretamente.
user.username	principal.user.user_display_name	Mapeado diretamente.
verb	network.http.method	Mapeado diretamente após ser convertido em letras maiúsculas. Determinado pelo campo verb. Se verb for "CREATE", o tipo de evento será USER_RESOURCE_CREATION. Se verb for "PATCH" ou "UPDATE", o tipo de evento será USER_RESOURCE_UPDATE_CONTENT. Se verb for "DELETE", o tipo de evento será USER_RESOURCE_DELETION. Caso contrário, se verb não estiver vazio, o tipo de evento será USER_RESOURCE_ACCESS. Se nenhuma dessas condições for atendida, o tipo de evento será definido como GENERIC_EVENT. Fixado no código como "VMWARE_TANZU". Fixado no código como "VMWARE". Fixado no código como "VMWARE_TANZU". Fixado no código como "CLUSTER".

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.