Coletar registros do vsftpd

Compatível com:

Google SecOps SIEM

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

O vsftpd (Very Secure FTP Daemon) é um servidor FTP que gera mensagens de syslog para conexões FTP, transferências de arquivos, eventos de autenticação e atividade de sessão.

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 servidor vsftpd
• 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 root ou sudo ao servidor vsftpd

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/vsftpd:
      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: VSFTPD
      raw_log_field: body
  
  service:
    pipelines:
      logs/vsftpd_to_chronicle:
        receivers:
          - udplog
        exporters:
          - chronicle/vsftpd
  

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/vsftpd:
      compression: gzip
      creds_file_path: '/opt/observiq-otel-collector/ingestion-auth.json'
      customer_id: '<customer_id>'
      endpoint: malachiteingestion-pa.googleapis.com
      log_type: VSFTPD
      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 encaminhamento de syslog para vsftpd

1. Edite o arquivo de configuração do vsftpd:

   sudo nano /etc/vsftpd.conf
   

2. Defina os seguintes parâmetros:

   syslog_enable=YES
   log_ftp_protocol=YES
   

3. Configure o rsyslog para encaminhar registros do vsftpd. Edite /etc/rsyslog.conf ou crie um novo arquivo /etc/rsyslog.d/vsftpd.conf:

   sudo nano /etc/rsyslog.d/vsftpd.conf
   

4. Adicione a seguinte regra de encaminhamento (substitua <bindplane-ip> pelo endereço IP do agente do BindPlane):

   if $programname == 'vsftpd' then @<bindplane-ip>:514
   

5. Reinicie o vsftpd e o rsyslog para aplicar as mudanças:

   sudo systemctl restart vsftpd
   sudo systemctl restart rsyslog
   

Tabela de mapeamento de UDM

Campo de registro	Mapeamento de UDM	Lógica
certificate	security_result.detection_fields.key: "cert" security_result.detection_fields.value: valor de certificate	O valor do campo certificate é mapeado para um objeto security_result.detection_fields com a chave "cert".
cipher	network.tls.cipher	O valor do campo cipher é mapeado diretamente.
client_ip	principal.ip	O valor do campo client_ip é mapeado diretamente.
date	metadata.event_timestamp	Usado com month, year e time para construir o metadata.event_timestamp. O formato é derivado do campo timestamp no registro bruto, analisado e convertido em um objeto de carimbo de data/hora.
day	metadata.event_timestamp	Usado com month, year e time para construir o metadata.event_timestamp.
desc	metadata.description	O valor do campo desc (extraído do campo type) é mapeado diretamente. Isso se aplica às operações "MKDIR", "RMDIR" e "DELETE".
description	network.ftp.command security_result.description target.file.full_path	Se type for "Comando FTP", o valor será mapeado para network.ftp.command. Se type for "DEBUG" e não corresponder a padrões SSL específicos, ele será mapeado para security_result.description. Se type começar com "OK" e não for "OK LOGIN", e o registro descrever uma operação de arquivo (MKDIR, RMDIR, DELETE), ele será mapeado para target.file.full_path.
file_name	target.file.full_path	O valor do campo file_name é mapeado diretamente.
file_size	network.received_bytes network.sent_bytes	Se type for "OK DOWNLOAD" ou "FAIL DOWNLOAD", o valor será convertido em um número inteiro sem sinal e mapeado para network.received_bytes. Se type for "OK UPLOAD" ou "FAIL UPLOAD", o valor será convertido em um número inteiro sem sinal e mapeado para network.sent_bytes. Defina como "USER_LOGIN" se type for "OK LOGIN". Defina como "FILE_UNCATEGORIZED" se type estiver relacionado a operações de arquivo ("OK UPLOAD", "OK DOWNLOAD", "FAIL DOWNLOAD", "OK MKDIR", "OK RMDIR", "OK DELETE", "FAIL UPLOAD"). Defina como "STATUS_UPDATE" para todos os outros valores de type. Sempre defina como "VSFTPD". Sempre defina como "VSFTPD". Sempre defina como "VSFTPD".
month	metadata.event_timestamp	Usado com day, year e time para construir o metadata.event_timestamp.
pid	principal.process.pid	O valor do campo pid é mapeado diretamente.
response_code	network.http.response_code	O valor do campo response_code é convertido em um número inteiro e mapeado.
reused_status	security_result.detection_fields.key: "status reutilizado" security_result.detection_fields.value: valor de reused_status	O valor do campo reused_status é mapeado para um objeto security_result.detection_fields com a chave "reused status".
speed	additional.fields.key: "download_speed" ou "upload_speed" additional.fields.value.string_value: valor de speed	Se type for "OK DOWNLOAD" ou "FAIL DOWNLOAD", o valor será mapeado para additional.fields com a chave "download_speed". Se type for "OK UPLOAD" ou "FAIL UPLOAD", o valor será mapeado para additional.fields com a chave "upload_speed".
ssl_shutdown_state	security_result.detection_fields.key: "Estado de encerramento do SSL" security_result.detection_fields.value: valor de ssl_shutdown_state	O valor do campo ssl_shutdown_state é mapeado para um objeto security_result.detection_fields com a chave "SSL Shutdown State".
ssl_version	network.tls.version	O valor do campo ssl_version é mapeado diretamente.
time	metadata.event_timestamp	Usado com day, month e year para construir o metadata.event_timestamp.
type	metadata.description security_result.action_details	O valor do campo type é mapeado para metadata.description, exceto quando é "OK LOGIN". Ele também é mapeado para security_result.action_details quando indica uma ação de permissão ou bloqueio (começa com "OK" ou "FAIL").
userid	principal.user.userid target.user.userid	Se type for "OK LOGIN", o valor será mapeado para target.user.userid. Caso contrário, ele será mapeado para principal.user.userid.
year	metadata.event_timestamp	Usado com day, month e time para construir o metadata.event_timestamp. Defina como "NETWORK" se type for "OK LOGIN". Defina como "MACHINE" se type for "OK LOGIN". Defina como "ALLOW" se type começar com "OK". Defina como "BLOCK" se type começar com "FAIL".

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.