Coletar registros do Commvault

Versão do analisador:3.0

Compatível com:

Google SecOps SIEM

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

O Commvault gera mensagens de syslog para operações de backup, alertas, eventos e atividades do sistema. O analisador extrai campos das mensagens de registro 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 do Linux com systemd
• Conectividade de rede entre o agente do Bindplane e o sistema Commvault
• Se você 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 console de gerenciamento do Commvault

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 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 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 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: 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 o fim da vida útil 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 do SIEM > Perfil.

3. Copie e salve o ID de cliente na seção Detalhes da organização.

   Observação: o ID do cliente é necessário para configurar o exportador do agente 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 root 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

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/commvault:
      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: COMMVAULT
      raw_log_field: body
  
  service:
    pipelines:
      logs/commvault_to_chronicle:
        receivers:
          - udplog
        exporters:
          - chronicle/commvault
  

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 do 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/commvault:
      compression: gzip
      creds_file_path: '/opt/observiq-otel-collector/ingestion-auth.json'
      customer_id: '<customer_id>'
      endpoint: malachiteingestion-pa.googleapis.com
      log_type: COMMVAULT
      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 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 syslog no Commvault Cloud

1. Faça login no console de gerenciamento do Commvault.
2. Acesse Gerenciar > Sistema.
3. Clique no bloco do conector do SIEM.
4. Clique em Adicionar conector.
5. Na guia Geral, insira os seguintes detalhes:
   • Nome do conector: insira um nome para o conector.
   • Tipo de conector: selecione Syslog.
   • Dados de streaming: selecione os dados que você quer exportar.
6. Clique em Próxima.
7. Na guia Definição do conector, clique em Adicionar servidor syslog.
8. Informe os seguintes detalhes de configuração:
   • Servidor Syslog: insira o endereço IP do agente do Bindplane.
   • Número da porta: insira o número da porta do agente do BindPlane.

9. Clique em Enviar.

   Observação: portas personalizadas não são permitidas na GUI devido a restrições de segurança. Embora a interface permita inserir qualquer porta, apenas as portas padrão são permitidas: UDP Port: 514 e TCP Port: 6514.

Tabela de mapeamento de UDM

Campo de registro	Mapeamento de UDM	Lógica
AgentType	event.idm.read_only_udm.observer.application	Valor extraído do campo AgentType na mensagem de registro.
Alertid	event.idm.read_only_udm.security_result.detection_fields.value	Valor retirado do campo Alertid na mensagem de registro. Esse campo é mapeado na chave alert_id.
Alertname	event.idm.read_only_udm.security_result.detection_fields.value	Valor retirado do campo Alertname na mensagem de registro. Esse campo é mapeado na chave alert_name.
Alertseverity	event.idm.read_only_udm.security_result.severity	Esse campo é usado para preencher o campo security_result.severity com base no valor dele.
Alerttime	event.idm.read_only_udm.metadata.event_timestamp	Valor extraído do campo Alerttime na mensagem de registro e convertido em um carimbo de data/hora.
BackupLevel	event.idm.read_only_udm.additional.fields.value.string_value	Valor retirado do campo BackupLevel na mensagem de registro. Esse campo é mapeado na chave backup_level.
BackupSet	event.idm.read_only_udm.additional.fields.value.string_value	Valor retirado do campo BackupSet na mensagem de registro. Esse campo é mapeado na chave backup_set.
Cliente	event.idm.read_only_udm.principal.hostname	Valor retirado do campo Client na mensagem de registro.
CommCell	event.idm.read_only_udm.additional.fields.value.string_value	Valor extraído do campo CommCell na mensagem de registro. Esse campo é mapeado na chave comcell_field.
Computador	event.idm.read_only_udm.additional.fields.value.string_value	Valor extraído do campo Computer na mensagem de registro. Esse campo é mapeado na chave computer_field.
Descrição	event.idm.read_only_udm.metadata.description	Valor extraído do campo Description na mensagem de registro após algum processamento e limpeza.
DetectedCriteria	event.idm.read_only_udm.security_result.detection_fields.value	Valor retirado do campo DetectedCriteria na mensagem de registro. Esse campo é mapeado na chave detected_criteria.
DetectedTime	event.idm.read_only_udm.security_result.detection_fields.value	Valor extraído do campo DetectedTime na mensagem de registro. Esse campo é mapeado na chave detected_time.
Detalhes	event.idm.read_only_udm.additional.fields.value.string_value	Valor retirado do campo Details na mensagem de registro. Esse campo é mapeado na chave details_field.
Eventid	event.idm.read_only_udm.metadata.product_log_id	Valor extraído do campo Eventid na mensagem de registro.
Eventseverity	event.idm.read_only_udm.security_result.severity	Esse campo é usado para preencher o campo security_result.severity com base no valor dele.
Falha	event.idm.read_only_udm.security_result.detection_fields.value	Valor retirado do campo Failure na mensagem de registro. Esse campo é mapeado na chave failure_filed.
Instância	event.idm.read_only_udm.additional.fields.value.string_value	Valor extraído do campo Instance na mensagem de registro. Esse campo é mapeado na chave instance_field.
Jobid	event.idm.read_only_udm.principal.process.pid	Valor retirado do campo Jobid na mensagem de registro.
MonitoringCriteria	event.idm.read_only_udm.additional.fields.value.string_value	Valor extraído do campo MonitoringCriteria na mensagem de registro. Esse campo é mapeado na chave monitoring_criteria.
Occurencetime	event.idm.read_only_udm.metadata.event_timestamp	Valor extraído do campo Occurencetime na mensagem de registro e convertido em um carimbo de data/hora.
Opid	event.idm.read_only_udm.security_result.detection_fields.value	Valor retirado do campo Opid na mensagem de registro. Esse campo é mapeado na chave op_id.
Programa	event.idm.read_only_udm.principal.application	Valor retirado do campo Program na mensagem de registro.
Severitylevel	event.idm.read_only_udm.security_result.severity	Valor extraído do campo Severitylevel na mensagem de registro e mapeado com base em um mapeamento predefinido.
StoragePoliciesUsed	event.idm.read_only_udm.additional.fields.value.string_value	Valor retirado do campo StoragePoliciesUsed na mensagem de registro. Esse campo é mapeado na chave storage_policies_used.
Subcliente	event.idm.read_only_udm.additional.fields.value.string_value	Valor extraído do campo Subclient na mensagem de registro. Esse campo é mapeado na chave subclient_field.
Tipo	event.idm.read_only_udm.security_result.detection_fields.value	Valor retirado do campo Type na mensagem de registro. Esse campo é mapeado na chave alert_type.
Nome de usuário	event.idm.read_only_udm.principal.user.userid	Valor extraído do campo Username na mensagem de registro.
anomaly_type	event.idm.read_only_udm.security_result.detection_fields.value	Valor extraído do campo Description usando padrões grok. Esse campo é mapeado na chave detected_anomaly_type.
erros	event.idm.read_only_udm.security_result.detection_fields.value	Valor extraído do campo Description usando padrões grok. Esse campo é mapeado na chave errors_field.
file_name	event.idm.read_only_udm.security_result.detection_fields.value	Valor extraído do campo Description usando padrões grok. Esse campo é mapeado na chave detected_malicious_file.
media_agent	event.idm.read_only_udm.security_result.detection_fields.value	Valor extraído do campo Description usando padrões grok. Esse campo é mapeado na chave detected_media_agent.
no_of_files_created	event.idm.read_only_udm.security_result.detection_fields.value	Valor extraído do campo Description usando padrões grok. Esse campo é mapeado na chave no_of_files_created_field.
no_of_files_deleted	event.idm.read_only_udm.security_result.detection_fields.value	Valor extraído do campo Description usando padrões grok. Esse campo é mapeado na chave no_of_files_deleted_field.
no_of_files_modified	event.idm.read_only_udm.security_result.detection_fields.value	Valor extraído do campo Description usando padrões grok. Esse campo é mapeado na chave no_of_files_modified_field.
no_of_files_renamed	event.idm.read_only_udm.security_result.detection_fields.value	Valor extraído do campo Description usando padrões grok. Esse campo é mapeado na chave no_of_files_renamed_field.
URL	event.idm.read_only_udm.network.http.referral_url	Valor extraído do campo Description usando padrões grok.
	event.idm.read_only_udm.metadata.event_type	Esse campo é definido como STATUS_UPDATE se o campo Client estiver presente. Caso contrário, ele é definido como GENERIC_EVENT.
	event.idm.read_only_udm.metadata.product_name	Esse campo está definido como COMMVAULT.
	event.idm.read_only_udm.metadata.vendor_name	Esse campo está definido como COMMVAULT.
	event.idm.read_only_udm.principal.user.user_role	Esse campo será definido como ADMINISTRATOR se o campo User for Administrator.
Commcellname	additional.fields	Mapeado do registro de alterações
Operation	metadata.description	Mapeado do registro de alterações
Companyname	principal.user.company_name	Mapeado do registro de alterações
machine_name	principal.hostname	Mapeado do registro de alterações
locale	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.