Coletar registros de inteligência contra ameaças do Team Cymru Scout

Compatível com:

Google SecOps SIEM

Observação: esse recurso é coberto pelos Termos de produtos pré-GA dos Termos específicos de serviço do Google Security Operations. Os recursos pré-GA podem ter suporte limitado, e as mudanças realizadas podem não ser compatíveis com outras versões pré-GA. Para mais informações, consulte as diretrizes do serviço de suporte técnico do Google SecOps e os Termos específicos de serviço do Google SecOps.

Este documento explica como ingerir dados de inteligência contra ameaças do Team Cymru Scout no Google Security Operations usando o Google Cloud Storage. O Team Cymru Scout fornece dados de inteligência de ameaças, incluindo métricas de uso da conta, limites de consultas e estatísticas de consultas básicas, para ajudar as organizações a monitorar a postura de segurança e o consumo de inteligência de ameaças.

Antes de começar

Verifique se você atende os seguintes pré-requisitos:

• Uma instância do Google SecOps
• Um projeto do GCP com a API Cloud Storage ativada
• Permissões para criar e gerenciar buckets do GCS
• Permissões para gerenciar políticas do IAM em buckets do GCS
• Permissões para criar serviços do Cloud Run, tópicos do Pub/Sub e jobs do Cloud Scheduler
• Acesso privilegiado ao locatário do Team Cymru Scout.

Criar um bucket do Google Cloud Storage

1. Acesse o Console do Google Cloud.
2. Selecione seu projeto ou crie um novo.
3. No menu de navegação, acesse Cloud Storage > Buckets.
4. Clique em Criar bucket.

5. Informe os seguintes detalhes de configuração:

   Configuração	Valor
   Nomeie seu bucket	Insira um nome exclusivo globalmente, por exemplo, team-cymru-scout-ti.
   Tipo de local	Escolha com base nas suas necessidades (região, birregional, multirregional)
   Local	Selecione o local (por exemplo, us-central1).
   Classe de armazenamento	Padrão (recomendado para registros acessados com frequência)
   Controle de acesso	Uniforme (recomendado)
   Ferramentas de proteção	Opcional: ativar o controle de versões de objetos ou a política de retenção

6. Clique em Criar.

Coletar credenciais da API Team Cymru Scout

1. Faça login na plataforma Scout da Team Cymru.
2. Acesse a página Chaves de API.
3. Clique no botão Criar.
4. Forneça a descrição da chave, se necessário.
5. Clique no botão Criar chave para gerar a chave de API.

6. Copie e salve em um local seguro os seguintes detalhes:

   • SCOUT_API_TOKEN: token de acesso à API
   • SCOUT_BASE_URL: URL base da API Scout (normalmente https://scout.cymru.com)
   Observação: o token de API será usado pela função do Cloud Run para autenticar a API Team Cymru Scout usando o formato de cabeçalho Authorization: Token <api_token>. O Team Cymru Scout também oferece suporte à autenticação básica com nome de usuário/senha como alternativa à autenticação por token, mas essa integração usa a autenticação por token.

Testar o acesso à API

• Teste suas credenciais antes de prosseguir com a integração:

  # Replace with your actual credentials
  SCOUT_API_TOKEN="your-api-token"
  SCOUT_BASE_URL="https://scout.cymru.com"
  
  # Test API access to usage endpoint
  curl -v --request GET \
    --url "${SCOUT_BASE_URL}/api/scout/usage" \
    --header "Authorization: Token ${SCOUT_API_TOKEN}"
  

Criar uma conta de serviço para a função do Cloud Run

A função do Cloud Run precisa de uma conta de serviço com permissões para gravar no bucket do GCS.

Criar conta de serviço

1. No Console do GCP, acesse IAM e administrador > Contas de serviço.
2. Clique em Criar conta de serviço.
3. Informe os seguintes detalhes de configuração:
   • Nome da conta de serviço: insira team-cymru-scout-ti-sa.
   • Descrição da conta de serviço: insira Service account for Cloud Run function to collect Team Cymru Scout Threat Intelligence data.
4. Clique em Criar e continuar.
5. Na seção Conceda a essa conta de serviço acesso ao projeto:
   1. Clique em Selecionar papel.
   2. Pesquise e selecione Administrador de objetos do Storage.
   3. Clique em + Adicionar outro papel.
   4. Pesquise e selecione Invocador do Cloud Run.
   5. Clique em + Adicionar outro papel.
   6. Pesquise e selecione Invocador do Cloud Functions.
6. Clique em Continuar.
7. Clique em Concluído.

Esses papéis são necessários para:

• Administrador de objetos do Storage: grava registros em um bucket do GCS e gerencia arquivos de estado.
• Invocador do Cloud Run: permite que o Pub/Sub invoque a função
• Invocador do Cloud Functions: permite a invocação de funções

Conceder permissões do IAM no bucket do GCS

Conceda permissões de gravação à conta de serviço no bucket do GCS:

1. Acesse Cloud Storage > Buckets.
2. Clique no nome do bucket.
3. Acesse a guia Permissões.
4. Clique em Conceder acesso.
5. Informe os seguintes detalhes de configuração:
   • Adicionar principais: insira o e-mail da conta de serviço (por exemplo, team-cymru-scout-ti-sa@PROJECT_ID.iam.gserviceaccount.com).
   • Atribuir papéis: selecione Administrador de objetos do Storage.
6. Clique em Salvar.

Criar tópico Pub/Sub

Crie um tópico do Pub/Sub em que o Cloud Scheduler vai publicar e a função do Cloud Run vai se inscrever.

1. No Console do GCP, acesse Pub/Sub > Tópicos.
2. Selecione Criar tópico.
3. Informe os seguintes detalhes de configuração:
   • ID do tópico: insira team-cymru-scout-ti-trigger.
   • Não altere as outras configurações.
4. Clique em Criar.

Criar uma função do Cloud Run para coletar dados de inteligência de ameaças

A função do Cloud Run é acionada por mensagens do Pub/Sub do Cloud Scheduler para buscar dados de inteligência de ameaças da API Team Cymru Scout e gravá-los no GCS.

1. No console do GCP, acesse o Cloud Run.
2. Clique em Criar serviço.
3. Selecione Função (use um editor in-line para criar uma função).

4. Na seção Configurar, forneça os seguintes detalhes de configuração:

   Configuração	Valor
   Nome do serviço	team-cymru-scout-ti-collector
   Região	Selecione a região que corresponde ao seu bucket do GCS (por exemplo, us-central1).
   Ambiente de execução	Selecione Python 3.12 ou uma versão mais recente.

5. Na seção Acionador (opcional):

   1. Clique em + Adicionar gatilho.
   2. Selecione Cloud Pub/Sub.
   3. Em Selecionar um tópico do Cloud Pub/Sub, escolha o tópico team-cymru-scout-ti-trigger.
   4. Clique em Salvar.

6. Na seção Autenticação:

   1. Selecione Exigir autenticação.
   2. Confira o Identity and Access Management (IAM).
   Observação: o Pub/Sub processa automaticamente a autenticação ao invocar a função.

7. Role a tela para baixo e abra Contêineres, rede, segurança.

8. Acesse a guia Segurança:

   • Conta de serviço: selecione a conta de serviço team-cymru-scout-ti-sa.

9. Acesse a guia Contêineres:

   1. Clique em Variáveis e secrets.
   2. Clique em + Adicionar variável para cada variável de ambiente:

   Nome da variável	Valor de exemplo
   GCS_BUCKET	team-cymru-scout-ti
   GCS_PREFIX	team-cymru/scout-ti/
   STATE_KEY	team-cymru/scout-ti/state.json
   SCOUT_BASE_URL	https://scout.cymru.com
   SCOUT_API_TOKEN	your-scout-api-token
   COLLECTION_INTERVAL_HOURS	1
   HTTP_TIMEOUT	60
   HTTP_RETRIES	3

   Observação: o SCOUT_BASE_URL precisa ser https://scout.cymru.com, conforme documentado na documentação oficial da API Team Cymru Scout. O token de API será usado com o formato de cabeçalho Authorization: Token <api_token>.

10. Role a tela para baixo na guia Variáveis e secrets até Solicitações:

    • Tempo limite da solicitação: insira 600 segundos (10 minutos).

11. Acesse a guia Configurações em Contêineres:

    • Na seção Recursos:
      • Memória: selecione 512 MiB ou mais.
      • CPU: selecione 1.
    • Clique em Concluído.

12. Role a tela para baixo até Ambiente de execução:

    • Selecione Padrão (recomendado).

13. Na seção Escalonamento de revisão:

    • Número mínimo de instâncias: insira 0.
    • Número máximo de instâncias: insira 100 ou ajuste com base na carga esperada.

14. Clique em Criar.

15. Aguarde a criação do serviço (1 a 2 minutos).

16. Depois que o serviço é criado, o editor de código inline é aberto automaticamente.

Adicionar código da função

1. Insira main em Ponto de entrada da função.

2. No editor de código em linha, crie dois arquivos:

   • Primeiro arquivo: main.py::

   import functions_framework
   from google.cloud import storage
   import json
   import os
   import urllib3
   from datetime import datetime, timezone
   import time
   
   # Initialize HTTP client
   http = urllib3.PoolManager()
   
   # Initialize Storage client
   storage_client = storage.Client()
   
   @functions_framework.cloud_event
   def main(cloud_event):
       """
       Cloud Run function triggered by Pub/Sub to fetch usage data from Team Cymru Scout API and write to GCS.
   
       Args:
           cloud_event: CloudEvent object containing Pub/Sub message
       """
   
       # Get environment variables
       bucket_name = os.environ.get('GCS_BUCKET')
       prefix = os.environ.get('GCS_PREFIX', 'team-cymru/scout-ti/')
       state_key = os.environ.get('STATE_KEY', 'team-cymru/scout-ti/state.json')
       collection_interval_hours = int(os.environ.get('COLLECTION_INTERVAL_HOURS', '1'))
       http_timeout = int(os.environ.get('HTTP_TIMEOUT', '60'))
       http_retries = int(os.environ.get('HTTP_RETRIES', '3'))
   
       # Team Cymru Scout API credentials
       scout_base_url = os.environ.get('SCOUT_BASE_URL', 'https://scout.cymru.com')
       scout_api_token = os.environ.get('SCOUT_API_TOKEN')
   
       if not all([bucket_name, scout_api_token]):
           print('Error: Missing required environment variables')
           return
   
       try:
           # Get GCS bucket
           bucket = storage_client.bucket(bucket_name)
   
           # Load state (last collection timestamp)
           state = load_state(bucket, state_key)
           now = time.time()
           last_collection = state.get('last_collection_ts', now - (collection_interval_hours * 3600))
   
           print(f'Collecting usage data at {iso_format(now)} (last collection: {iso_format(last_collection)})')
   
           # Fetch usage data from Team Cymru Scout API
           usage_data = fetch_usage_data(
               scout_base_url, 
               scout_api_token, 
               http_timeout,
               http_retries
           )
   
           if usage_data:
               # Add timestamp and event type
               usage_data['event_type'] = 'account_usage'
               usage_data['collection_timestamp'] = iso_format(now)
   
               # Write to GCS
               write_to_gcs(bucket, prefix, usage_data, now)
   
               # Update state
               save_state(bucket, state_key, {'last_collection_ts': now})
   
               print(f'Successfully collected and stored usage data')
           else:
               print('No usage data retrieved')
   
       except Exception as e:
           print(f'Error processing usage data: {str(e)}')
           raise
   
   def iso_format(ts):
       """Convert Unix timestamp to ISO 8601 format."""
       return time.strftime('%Y-%m-%dT%H:%M:%SZ', time.gmtime(ts))
   
   def load_state(bucket, key):
       """Load state from GCS."""
       try:
           blob = bucket.blob(key)
           if blob.exists():
               state_data = blob.download_as_text()
               return json.loads(state_data)
       except Exception as e:
           print(f'Warning: Could not load state: {str(e)}')
       return {}
   
   def save_state(bucket, key, state):
       """Save state to GCS."""
       try:
           blob = bucket.blob(key)
           blob.upload_from_string(
               json.dumps(state, separators=(',', ':')),
               content_type='application/json'
           )
       except Exception as e:
           print(f'Warning: Could not save state: {str(e)}')
   
   def http_request(url, method='GET', body=None, headers=None, timeout=60, retries=3):
       """Make HTTP request with retry logic."""
       attempt = 0
       while True:
           try:
               req_headers = headers or {}
               if body is not None:
                   req_headers['Content-Type'] = 'application/json'
                   body_bytes = body.encode('utf-8') if isinstance(body, str) else body
               else:
                   body_bytes = None
   
               response = http.request(
                   method,
                   url,
                   body=body_bytes,
                   headers=req_headers,
                   timeout=timeout
               )
   
               if response.status == 200:
                   return response.data, response.headers.get('Content-Type', 'application/json')
               elif response.status in (429, 500, 502, 503, 504) and attempt < retries:
                   delay = 1 + attempt
                   retry_after = response.headers.get('Retry-After')
                   if retry_after:
                       try:
                           delay = int(retry_after)
                       except:
                           pass
                   time.sleep(max(1, delay))
                   attempt += 1
                   continue
               else:
                   raise Exception(f'HTTP {response.status}: {response.data.decode("utf-8")}')
           except urllib3.exceptions.HTTPError as e:
               if attempt < retries:
                   time.sleep(1 + attempt)
                   attempt += 1
                   continue
               raise
   
   def fetch_usage_data(base_url, api_token, timeout, retries):
       """
       Fetch usage data from Team Cymru Scout API.
   
       Implementation mirrors the official Scout API example:
       curl --request GET --url 'https://scout.cymru.com/api/scout/usage' --header 'Authorization: Token valid_api_token'
       """
       # Use the documented /api/scout/usage endpoint
       url = f'{base_url}/api/scout/usage'
   
       # Use Token authentication as documented
       headers = {
           'Authorization': f'Token {api_token}',
           'Accept': 'application/json'
       }
   
       print(f'Fetching usage data from {url}')
   
       try:
           # Fetch data
           blob_data, content_type = http_request(url, method='GET', headers=headers, timeout=timeout, retries=retries)
   
           # Parse response
           usage_data = json.loads(blob_data.decode('utf-8'))
   
           print(f'Retrieved usage data: used_queries={usage_data.get("used_queries")}, query_limit={usage_data.get("query_limit")}')
   
           return usage_data
   
       except Exception as e:
           print(f'Error fetching usage data: {e}')
           return None
   
   def write_to_gcs(bucket, prefix, data, timestamp):
       """Write data to GCS."""
       # Create date-based path
       date_path = time.strftime('%Y/%m/%d', time.gmtime(timestamp))
       key = f'{prefix}{date_path}/usage_{int(timestamp)}.json'
   
       # Write as JSON
       blob = bucket.blob(key)
       blob.upload_from_string(
           json.dumps(data, separators=(',', ':')),
           content_type='application/json'
       )
       print(f'Wrote data to gs://{bucket.name}/{key}')
   

   • Segundo arquivo: requirements.txt:

   functions-framework==3.*
   google-cloud-storage==2.*
   urllib3>=2.0.0
   

3. Clique em Implantar para salvar e implantar a função.

4. Aguarde a conclusão da implantação (2 a 3 minutos).

   Observação: a configuração do acionador do Pub/Sub cria automaticamente as assinaturas e permissões necessárias. Essa implementação usa o endpoint documentado da API Scout do Team Cymru /api/scout/usage com autenticação Authorization: Token <api_token>, conforme especificado na documentação oficial da API Scout.

Criar o job do Cloud Scheduler

O Cloud Scheduler publica mensagens no tópico do Pub/Sub em intervalos regulares, acionando a função do Cloud Run.

1. No Console do GCP, acesse o Cloud Scheduler.
2. Clique em Criar job.

3. Informe os seguintes detalhes de configuração:

   Configuração	Valor
   Nome	team-cymru-scout-ti-hourly
   Região	Selecione a mesma região da função do Cloud Run
   Frequência	0 * * * * (a cada hora, na hora)
   Fuso horário	Selecione o fuso horário (UTC recomendado)
   Tipo de destino	Pub/Sub
   Tópico	Selecione o tópico team-cymru-scout-ti-trigger.
   Corpo da mensagem	{} (objeto JSON vazio)

4. Clique em Criar.

Opções de frequência de programação

• Escolha a frequência com base no volume de dados e nos requisitos de latência:

  Frequência	Expressão Cron	Caso de uso
  A cada 5 minutos	*/5 * * * *	Monitoramento de alta frequência
  A cada 15 minutos	*/15 * * * *	Frequência média
  A cada hora	0 * * * *	Padrão (recomendado)
  A cada 6 horas	0 */6 * * *	Baixa frequência
  Diário	0 0 * * *	Monitoramento de uso diário

Testar o job do programador

1. No console do Cloud Scheduler, encontre seu job.
2. Clique em Forçar execução para acionar manualmente.
3. Aguarde alguns segundos e acesse Cloud Run > Serviços > team-cymru-scout-ti-collector > Registros.
4. Verifique se a função foi executada com sucesso.
5. Verifique o bucket do GCS para confirmar se os dados de uso foram gravados.

Recuperar a conta de serviço do Google SecOps

O Google SecOps usa uma conta de serviço exclusiva para ler dados do seu bucket do GCS. Você precisa conceder a essa conta de serviço acesso ao seu bucket.

Receber o e-mail da conta de serviço

1. Acesse Configurações do SIEM > Feeds.
2. Clique em Adicionar novo feed.
3. Clique em Configurar um único feed.
4. No campo Nome do feed, insira um nome para o feed (por exemplo, Team Cymru Scout Threat Intelligence).
5. Selecione Google Cloud Storage V2 como o Tipo de origem.
6. Selecione Team Cymru Scout Threat Intelligence como o Tipo de registro.

7. Clique em Receber conta de serviço. Um e-mail exclusivo da conta de serviço é exibido, por exemplo:

   [e-mail]
   

8. Copie esse endereço de e-mail para usar na próxima etapa.

   Observação: cada instância do Google SecOps tem uma conta de serviço exclusiva. Não use contas de serviço de outras documentações ou exemplos.

Conceder permissões do IAM à conta de serviço do Google SecOps

A conta de serviço do Google SecOps precisa do papel de Leitor de objetos do Storage no seu bucket do GCS.

1. Acesse Cloud Storage > Buckets.
2. Clique no nome do bucket.
3. Acesse a guia Permissões.
4. Clique em Conceder acesso.
5. Informe os seguintes detalhes de configuração:
   • Adicionar participantes: cole o e-mail da conta de serviço do Google SecOps.
   • Atribuir papéis: selecione Leitor de objetos do Storage.

6. Clique em Salvar.

   Observação: se você planeja usar a opção de exclusão "Excluir arquivos transferidos" ou "Excluir arquivos transferidos e diretórios vazios", conceda o papel Administrador de objetos do Storage em vez de Leitor de objetos do Storage.

Configurar um feed no Google SecOps para ingerir dados de inteligência de ameaças do Team Cymru Scout

1. Acesse Configurações do SIEM > Feeds.
2. Clique em Adicionar novo feed.
3. Clique em Configurar um único feed.
4. No campo Nome do feed, insira um nome para o feed (por exemplo, Team Cymru Scout Threat Intelligence).
5. Selecione Google Cloud Storage V2 como o Tipo de origem.
6. Selecione Team Cymru Scout Threat Intelligence como o Tipo de registro.
7. Clique em Próxima.

8. Especifique valores para os seguintes parâmetros de entrada:

   • URL do bucket de armazenamento: insira o URI do bucket do GCS com o caminho do prefixo:

     gs://team-cymru-scout-ti/team-cymru/scout-ti/
     

     • Substitua:

       • team-cymru-scout-ti: o nome do bucket do GCS.
       • team-cymru/scout-ti/: prefixo/caminho da pasta onde os registros são armazenados.
     Observação: sempre inclua a barra (/) no final do URI.

   • Opção de exclusão da fonte: selecione a opção de exclusão de acordo com sua preferência:

     • Nunca: nunca exclui arquivos após as transferências (recomendado para testes).
     • Excluir arquivos transferidos: exclui os arquivos após a transferência bem-sucedida.

     • Excluir arquivos transferidos e diretórios vazios: exclui arquivos e diretórios vazios após a transferência bem-sucedida.

       Observação: se você selecionar uma opção de exclusão, a conta de serviço precisará ter o papel Administrador de objetos do Storage em vez de Leitor de objetos do Storage. Atualize as permissões do IAM de acordo com a necessidade.

   • Idade máxima do arquivo: inclui arquivos modificados no último número de dias. O padrão é de 180 dias.

   • Namespace do recurso: o namespace do recurso.

   • Rótulos de ingestão: o rótulo a ser aplicado aos eventos deste feed.

9. Clique em Próxima.

10. Revise a nova configuração do feed na tela Finalizar e clique em Enviar.

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