Coletar registros de modems Digi

Versão do analisador:1.0

Disponível em:

Google SecOps SIEM

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

Os modems Digi são modems celulares industriais que geram mensagens syslog para eventos de login, tentativas de autenticação e conexões de rede. O analisador extrai campos usando padrões grok 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 modem Digi
• 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 Digi Remote Manager ou UI da Web do modem Digi local

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: digite um nome para a conta (por exemplo, bindplane-ingest).
   • Descrição da conta de serviço: digite 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 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/digi_modems:
      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: DIGI_MODEMS
      raw_log_field: body
  
  service:
    pipelines:
      logs/digi_modems_to_chronicle:
        receivers:
          - udplog
        exporters:
          - chronicle/digi_modems
  

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 detectar 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 prefixa chronicle.googleapis.com com esse valor. Consulte Endpoints regionais para conferir 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 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/digi_modems:
      compression: gzip
      creds_file_path: '/opt/observiq-otel-collector/ingestion-auth.json'
      customer_id: '<customer_id>'
      endpoint: malachiteingestion-pa.googleapis.com
      log_type: DIGI_MODEMS
      raw_log_field: body
  

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 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 servidor syslog no modem Digi

1. Faça login no Digi Remote Manager ou na UI da Web do modem Digi local.
2. Acesse a configuração do dispositivo com Remote Manager:
   • Localize o dispositivo para o qual você quer configurar o syslog.
   • Clique em ID do dispositivo > Configurações > Configuração.
3. Acesse a configuração do dispositivo com a interface da Web do modem Digi local:
   • Clique em Sistema > Configuração > Configuração do dispositivo.
4. Acesse Sistema > Registro.
5. Clique para expandir a lista de servidores.
6. Clique em Adicionar servidor +.
7. Informe os seguintes detalhes de configuração:
   • Servidor: digite o endereço IP do agente do Bindplane.
   • Selecione as categorias de eventos que serão enviadas ao servidor (todas as categorias de eventos são ativadas por padrão).
   • Porta de saída do Syslog: digite o número da porta do agente do Bindplane (o padrão é 514).
   • Protocolo: selecione UDP.
8. Clique em Aplicar.

Registros de amostra de modems Digi compatíveis

• SYSLOG

  {
    "priority": 14,
    "timestamp": "Dec 28 17:27:45",
    "hostname": "host-device.router",
    "tag": "Eventlog",
    "message": "17:27:33, 28 Dec 2006,Login failure by Host: 10.0.0.25:23: CMD,Telnet"
  }
  

• SYSLOG

  {
    "priority": 14,
    "timestamp": "May 25 11:03:55",
    "hostname": "internal-srv-01",
    "tag": "Eventlog",
    "message": "11:03:55, 25 May 2023,Login failure by sanitized_user: WEB"
  }
  

• SYSLOG

  {
    "priority": 14,
    "timestamp": "Jun 11 23:58:26",
    "hostname": "internal-srv-01",
    "tag": "Eventlog",
    "message": "23:58:26, 11 Jun 2023,Login failure by GET /masked_path HTTP/1.0: CMD,Telnet"
  }
  

• SYSLOG

  {
    "priority": 14,
    "timestamp": "Jun 19 19:52:19",
    "hostname": "gateway-device-02",
    "tag": "Eventlog",
    "message": "19:52:18, 19 Jun 2023,WEB Login OK by internal_admin lvl 0"
  }
  

Tabela de mapeamento de UDM

Campo de registro	Mapeamento de UDM	Lógica
conteúdo	security_result.description	Mapeado diretamente do campo content após a análise grok inicial.
http_method	network.http.method	Extraído do campo content usando um padrão grok.
http_version	network.application_protocol_version	Extraído do campo content usando um padrão grok.
nome do host	principal.hostname	Extraído da mensagem de registro usando um padrão grok.
ip	target.ip	Extraído do campo content usando um padrão grok.
porta	target.port	Extraído do campo content usando um padrão grok e convertido em um número inteiro.
proto	network.application_protocol	Extraído do campo content usando um padrão grok.
ts	metadata.event_timestamp	Extraído da mensagem de registro usando um padrão grok e convertido em um carimbo de data/hora.
tipo	login_type_label.value	Extraído do campo content usando um padrão grok.
	extensions.auth.type	Definido como MACHINE pela lógica do analisador.
	login_type_label.key	Definido como Login type pela lógica do analisador.
	metadata.event_type	Determinado pela presença de campos específicos, como ip ou user, e definido de acordo com NETWORK_CONNECTION ou USER_LOGIN.
	metadata.log_type	Definido como DIGI_MODEMS pela lógica do analisador.
	metadata.product_event_type	Extraído do campo product_type na mensagem de registro.
	metadata.product_name	Definido como DIGI_MODEMS pela lógica do analisador.
	metadata.vendor_name	Definido como DIGI_MODEMS pela lógica do analisador.
	security_result.action	Determinado pela presença de Login OK ou Login failure na mensagem e definido como ALLOW ou BLOCK, respectivamente.
usuário	target.user.userid	Extraído do campo content usando um padrão grok.

Registro de alterações

Consulte o registro de alterações desse analisador

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