Coletar registros do Apache Cassandra

Versão do analisador:4.0

Compatível com:

Google SecOps SIEM

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

O Apache Cassandra gera registros para operações de banco de dados, eventos de cluster e atividades do sistema. O analisador extrai campos usando padrões grok e filtros 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 do Linux com systemd
• Conectividade de rede entre o agente do Bindplane e o host do Apache Cassandra
• 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 administrativo (SSH) ao host do Apache Cassandra

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 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 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. 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 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 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 vai aparecer como EM EXECUÇÃO.

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

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/cassandra:
      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: CASSANDRA
      raw_log_field: body
  
  service:
    pipelines:
      logs/cassandra_to_chronicle:
        receivers:
          - udplog
        exporters:
          - chronicle/cassandra
  

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/cassandra:
      compression: gzip
      creds_file_path: '/opt/observiq-otel-collector/ingestion-auth.json'
      customer_id: '<customer_id>'
      endpoint: malachiteingestion-pa.googleapis.com
      log_type: CASSANDRA
      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, Enter e 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:

     ```bash
     sudo systemctl status observiq-otel-collector
     ```
     

  2. Verifique se há erros nos registros:

     ```bash
     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 a exportação do syslog no Apache Cassandra

1. Faça login no host do Apache Cassandra usando SSH.

2. Abra o arquivo de configuração logback.xml:

   • Apache Cassandra (a maioria das versões): $(CASSANDRA_HOME)/conf
   • Datastax Enterprise (instalação de pacote): /etc/dse
   • Datastax Enterprise (instalação tar): $(TARBALL_ROOT)/resources/cassandra/conf

3. Adicione a seguinte definição de Appender ao arquivo logback.xml na linha 28:

   <appender name="SYSLOG" class="ch.qos.logback.classic.net.SyslogAppender">
       <syslogHost>BINDPLANE_IP</syslogHost>
       <port>BINDPLANE_PORT</port>
       <facility>LOCAL7</facility>
       <throwableExcluded>true</throwableExcluded>
       <suffixPattern>%thread:%level:%logger{36}:%msg</suffixPattern>
   </appender>
   

4. Substitua BINDPLANE_IP e BINDPLANE_PORT pelo endereço IP e pela porta reais do agente do Bindplane.

5. Adicione o código abaixo ao bloco do logger raiz <root level="INFO"> no arquivo logback.xml:

   O local em que essa linha é inserida depende da sua versão do Apache Cassandra:

   • Apache Cassandra 5.0.x, linha 123
   • Apache Cassandra 4.0.x e 4.1.x, linha 115
   • Apache Cassandra 3.11.x e 3.0.x, linha 92
   • Datastax Enterprise (todas as versões), linha 121

   <appender-ref ref="SYSLOG" />
   

Tabela de mapeamento de UDM

Campo de registro	Mapeamento de UDM	Lógica
agent.ephemeral_id	observer.labels.value	Valor de agent.ephemeral_id da mensagem JSON interna.
agent.hostname	observer.hostname	Valor de agent.hostname da mensagem JSON interna.
agent.id	observer.asset_id	Concatenação de filebeat: e o valor de agent.id da mensagem JSON interna.
agent.name	observer.user.userid	Valor de agent.name da mensagem JSON interna.
agent.type	observer.application	Valor de agent.type da mensagem JSON interna.
agent.version	observer.platform_version	Valor de agent.version da mensagem JSON interna.
cloud.availability_zone	principal.cloud.availability_zone	Valor de cloud.availability_zone da mensagem JSON interna.
cloud.instance.id	principal.resource.product_object_id	Valor de cloud.instance.id da mensagem JSON interna.
cloud.instance.name	principal.resource.name	Valor de cloud.instance.name da mensagem JSON interna.
cloud.machine.type	principal.resource.attribute.labels.value	Valor de cloud.machine.type da mensagem JSON interna, em que o key correspondente é machine_type.
cloud.provider	principal.resource.attribute.labels.value	Valor de cloud.provider da mensagem JSON interna, em que o key correspondente é provider.
event_metadata._id	metadata.product_log_id	Valor de event_metadata._id da mensagem JSON interna.
event_metadata.version	metadata.product_version	Valor de event_metadata.version da mensagem JSON interna.
host.architecture	target.asset.hardware.cpu_platform	Valor de host.architecture da mensagem JSON interna.
host.fqdn	target.administrative_domain	Valor de host.fqdn da mensagem JSON interna.
host.hostname	target.hostname	Valor de host.hostname da mensagem JSON interna.
host.id	target.asset.asset_id	Concatenação de Host Id: e o valor de host.id da mensagem JSON interna.
host.ip	target.asset.ip	Matriz de endereços IP de host.ip na mensagem JSON interna.
host.mac	target.mac	Matriz de endereços MAC de host.mac na mensagem JSON interna.
host.os.kernel	target.platform_patch_level	Valor de host.os.kernel da mensagem JSON interna.
host.os.platform	target.platform	Defina como LINUX se host.os.platform for debian.
host.os.version	target.platform_version	Valor de host.os.version da mensagem JSON interna.
hostname	principal.hostname	Valor de hostname extraído do campo message usando grok.
key	security_result.detection_fields.value	Valor de key extraído do campo message usando grok, em que o key correspondente é key.
log.file.path	principal.process.file.full_path	Valor de log.file.path da mensagem JSON interna.
log_level	security_result.severity	Mapeado com base no valor de log_level: DEBUG, INFO e AUDIT são mapeados para INFORMATIONAL; ERROR é mapeado para ERROR; WARNING é mapeado para MEDIUM.
log_level	security_result.severity_details	Valor de log_level extraído do campo message usando grok.
log_type	metadata.log_type	Valor de log_type do registro bruto.
message	security_result.description	Descrição extraída do campo message usando grok.
message	target.process.command_line	Linha de comando extraída do campo message usando o grok.
now	security_result.detection_fields.value	Valor de now extraído do campo message usando grok, em que o key correspondente é now. Analisado do campo event_time extraído do campo message usando grok. Defina como USER_RESOURCE_ACCESS se hostname e host.hostname estiverem presentes. Caso contrário, defina como GENERIC_EVENT. Defina como CASSANDRA. Defina como CASSANDRA. Defina como ephemeral_id. Defina como VIRTUAL_MACHINE se cloud.instance.name estiver presente. Defina como key e now para os campos de detecção correspondentes.
timestamp	timestamp	Do campo create_time do registro bruto.
authenticated_var	event.idm.read_only_udm.principal.user.userid	Mapeado do registro de alterações
authenticated_var	event.idm.read_only_udm.target.user.userid	Mapeado do registro de mudanças
user_var	event.idm.read_only_udm.target.user.userid	Mapeado do registro de mudanças
operation	event.idm.read_only_udm.security_result.description	Mapeado do registro de mudanças
operation	event.idm.read_only_udm.target.process.command_line	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.