Recopila registros de inteligencia sobre amenazas de Team Cymru Scout

Se admite en los siguientes sistemas operativos:

Google SecOps SIEM

Nota: Esta función está sujeta a las Condiciones de las Ofertas de Fase Previa a la DG de las Condiciones Específicas de Google Security Operations. Las características de la fase previa a la DG pueden tener asistencia limitada, y es posible que los cambios que se les realicen no sean compatibles con otras versiones de la fase previa a la DG. Para obtener más información, consulta los Lineamientos de los Servicios de Asistencia Técnica de Google SecOps y las Condiciones Específicas del Servicio de Google SecOps.

En este documento, se explica cómo transferir datos de inteligencia sobre amenazas de Team Cymru Scout a Google Security Operations con Google Cloud Storage. Team Cymru Scout proporciona datos de inteligencia sobre amenazas, incluidas las métricas de uso de la cuenta, los límites de consultas y las estadísticas de consultas básicas, para ayudar a las organizaciones a supervisar su postura de seguridad y el consumo de inteligencia sobre amenazas.

Antes de comenzar

Asegúrate de cumplir con los siguientes requisitos previos:

• Una instancia de Google SecOps
• Un proyecto de GCP con la API de Cloud Storage habilitada
• Permisos para crear y administrar buckets de GCS
• Permisos para administrar políticas de IAM en buckets de GCS
• Permisos para crear servicios de Cloud Run, temas de Pub/Sub y trabajos de Cloud Scheduler
• Acceso con privilegios al arrendatario de Team Cymru Scout

Crea un bucket de Google Cloud Storage

1. Ve a Google Cloud Console.
2. Selecciona tu proyecto o crea uno nuevo.
3. En el menú de navegación, ve a Cloud Storage > Buckets.
4. Haz clic en Crear bucket.

5. Proporciona los siguientes detalles de configuración:

   Configuración	Valor
   Asigna un nombre a tu bucket	Ingresa un nombre global único (por ejemplo, team-cymru-scout-ti).
   Tipo de ubicación	Elige según tus necesidades (región, birregional, multirregional)
   Ubicación	Selecciona la ubicación (por ejemplo, us-central1).
   Clase de almacenamiento	Estándar (recomendado para los registros a los que se accede con frecuencia)
   Control de acceso	Uniforme (recomendado)
   Herramientas de protección	Opcional: Habilita el control de versiones de objetos o la política de retención

6. Haz clic en Crear.

Recopila credenciales de la API de Team Cymru Scout

1. Accede a la plataforma Scout de Team Cymru.
2. Ve a la página Claves de API.
3. Haz clic en el botón Create (Crear).
4. Proporciona la descripción de la clave, si es necesario.
5. Haz clic en el botón Crear clave para generar la clave de API.

6. Copia y guarda en una ubicación segura los siguientes detalles:

   • SCOUT_API_TOKEN: Token de acceso a la API
   • SCOUT_BASE_URL: URL base de la API de Scout (por lo general, https://scout.cymru.com)
   Nota: La función de Cloud Run usará el token de API para autenticarse en la API de Team Cymru Scout con el formato de encabezado Authorization: Token <api_token>. Team Cymru Scout también admite la autenticación básica con nombre de usuario y contraseña como alternativa a la autenticación con token, pero esta integración usa la autenticación con token.

Prueba el acceso a la API

• Prueba tus credenciales antes de continuar con la integración:

  # 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}"
  

Crea una cuenta de servicio para la Cloud Run Function

La Cloud Run Function necesita una cuenta de servicio con permisos para escribir en el bucket de GCS.

Crear cuenta de servicio

1. En GCP Console, ve a IAM y administración > Cuentas de servicio.
2. Haz clic en Crear cuenta de servicio.
3. Proporciona los siguientes detalles de configuración:
   • Nombre de la cuenta de servicio: Ingresa team-cymru-scout-ti-sa.
   • Descripción de la cuenta de servicio: Ingresa Service account for Cloud Run function to collect Team Cymru Scout Threat Intelligence data.
4. Haz clic en Crear y continuar.
5. En la sección Otorga a esta cuenta de servicio acceso al proyecto, haz lo siguiente:
   1. Haz clic en Selecciona un rol.
   2. Busca y selecciona Administrador de objetos de almacenamiento.
   3. Haz clic en + Agregar otra función.
   4. Busca y selecciona Invocador de Cloud Run.
   5. Haz clic en + Agregar otra función.
   6. Busca y selecciona Cloud Functions Invoker.
6. Haz clic en Continuar.
7. Haz clic en Listo.

Estos roles son necesarios para las siguientes acciones:

• Administrador de objetos de almacenamiento: Escribe registros en el bucket de GCS y administra archivos de estado
• Invocador de Cloud Run: Permite que Pub/Sub invoque la función
• Cloud Functions Invoker: Permite la invocación de funciones

Otorga permisos de IAM en el bucket de GCS

Otorga permisos de escritura a la cuenta de servicio en el bucket de GCS:

1. Ve a Cloud Storage > Buckets.
2. Haz clic en el nombre de tu bucket.
3. Ve a la pestaña Permisos.
4. Haz clic en Otorgar acceso.
5. Proporciona los siguientes detalles de configuración:
   • Agregar principales: Ingresa el correo electrónico de la cuenta de servicio (por ejemplo, team-cymru-scout-ti-sa@PROJECT_ID.iam.gserviceaccount.com).
   • Asignar roles: Selecciona Administrador de objetos de Storage.
6. Haz clic en Guardar.

Crear tema de Pub/Sub

Crea un tema de Pub/Sub en el que Cloud Scheduler publicará y al que se suscribirá la función de Cloud Run.

1. En GCP Console, ve a Pub/Sub > Temas.
2. Haz clic en Crear un tema.
3. Proporciona los siguientes detalles de configuración:
   • ID del tema: Ingresa team-cymru-scout-ti-trigger.
   • Deja el resto de la configuración con sus valores predeterminados.
4. Haz clic en Crear.

Crea una función de Cloud Run para recopilar datos de inteligencia sobre amenazas

La función de Cloud Run se activa con los mensajes de Pub/Sub de Cloud Scheduler para recuperar datos de inteligencia sobre amenazas de la API de Team Cymru Scout y los escribe en GCS.

1. En GCP Console, ve a Cloud Run.
2. Haz clic en Crear servicio.
3. Selecciona Función (usa un editor intercalado para crear una función).

4. En la sección Configurar, proporciona los siguientes detalles de configuración:

   Configuración	Valor
   Nombre del servicio	team-cymru-scout-ti-collector
   Región	Selecciona la región que coincida con tu bucket de GCS (por ejemplo, us-central1).
   Tiempo de ejecución	Selecciona Python 3.12 o una versión posterior.

5. En la sección Activador (opcional), haz lo siguiente:

   1. Haz clic en + Agregar activador.
   2. Selecciona Cloud Pub/Sub.
   3. En* Selecciona un tema de Cloud Pub/Sub*, elige el tema team-cymru-scout-ti-trigger.
   4. Haz clic en Guardar.

6. En la sección Autenticación, haz lo siguiente:

   1. Selecciona Solicitar autenticación.
   2. Verifica Identity and Access Management (IAM).
   Nota: Pub/Sub controla automáticamente la autenticación cuando invoca la función.

7. Desplázate hacia abajo y expande Contenedores, redes y seguridad.

8. Ve a la pestaña Seguridad:

   • Cuenta de servicio: Selecciona la cuenta de servicio team-cymru-scout-ti-sa.

9. Ve a la pestaña Contenedores:

   1. Haz clic en Variables y secretos.
   2. Haz clic en + Agregar variable para cada variable de entorno:

   Nombre de la variable	Valor de ejemplo
   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

   Nota: El SCOUT_BASE_URL debe ser https://scout.cymru.com, como se documenta en la documentación oficial de la API de Team Cymru Scout. El token de API se usará con el formato de encabezado Authorization: Token <api_token>.

10. En la pestaña Variables y Secrets, desplázate hacia abajo hasta Requests:

    • Tiempo de espera de la solicitud: Ingresa 600 segundos (10 minutos).

11. Ve a la pestaña Configuración en Contenedores:

    • En la sección Recursos, haz lo siguiente:
      • Memoria: Selecciona 512 MiB o más.
      • CPU: Selecciona 1.
    • Haz clic en Listo.

12. Desplázate hacia abajo hasta Entorno de ejecución:

    • Selecciona Predeterminado (recomendado).

13. En la sección Ajuste de escala de revisión, haz lo siguiente:

    • Cantidad mínima de instancias: Ingresa 0.
    • Cantidad máxima de instancias: Ingresa 100 (o ajusta según la carga esperada).

14. Haz clic en Crear.

15. Espera a que se cree el servicio (de 1 a 2 minutos).

16. Después de crear el servicio, se abrirá automáticamente el editor de código intercalado.

Agregar el código de función

1. Ingresa main en Punto de entrada de la función.

2. En el editor de código intercalado, crea dos archivos:

   • Primer archivo: 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 archivo: requirements.txt:

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

3. Haz clic en Implementar para guardar y, luego, implementar la función.

4. Espera a que se complete la implementación (de 2 a 3 minutos).

   Nota: La configuración del activador de Pub/Sub crea automáticamente las suscripciones y los permisos necesarios. Esta implementación usa el extremo de la API de Team Cymru Scout documentado /api/scout/usage con autenticación Authorization: Token <api_token>, como se especifica en la documentación oficial de la API de Scout.

Crea un trabajo de Cloud Scheduler

Cloud Scheduler publica mensajes en el tema de Pub/Sub a intervalos regulares, lo que activa la función de Cloud Run.

1. En GCP Console, ve a Cloud Scheduler.
2. Haz clic en Crear trabajo.

3. Proporciona los siguientes detalles de configuración:

   Configuración	Valor
   Nombre	team-cymru-scout-ti-hourly
   Región	Selecciona la misma región que la función de Cloud Run
   Frecuencia	0 * * * * (cada hora, en punto)
   Zona horaria	Selecciona la zona horaria (se recomienda UTC)
   Tipo de orientación	Pub/Sub
   Tema	Selecciona el tema team-cymru-scout-ti-trigger.
   Cuerpo del mensaje	{} (objeto JSON vacío)

4. Haz clic en Crear.

Opciones de frecuencia de programación

• Elige la frecuencia según el volumen de datos y los requisitos de latencia:

  Frecuencia	Expresión cron	Caso de uso
  Cada 5 minutos	*/5 * * * *	Supervisión de alta frecuencia
  Cada 15 minutos	*/15 * * * *	Frecuencia media
  Cada 1 hora	0 * * * *	Estándar (opción recomendada)
  Cada 6 horas	0 */6 * * *	Baja frecuencia
  Diario	0 0 * * *	Seguimiento de uso diario

Prueba el trabajo de Scheduler

1. En la consola de Cloud Scheduler, busca tu trabajo.
2. Haz clic en Forzar ejecución para activarlo de forma manual.
3. Espera unos segundos y ve a Cloud Run > Servicios > team-cymru-scout-ti-collector > Registros.
4. Verifica que la función se haya ejecutado correctamente.
5. Verifica el bucket de GCS para confirmar que se escribieron los datos de uso.

Recupera la cuenta de servicio de Google SecOps

Las Operaciones de seguridad de Google usan una cuenta de servicio única para leer datos de tu bucket de GCS. Debes otorgar acceso a tu bucket a esta cuenta de servicio.

Obtén el correo electrónico de la cuenta de servicio

1. Ve a Configuración de SIEM > Feeds.
2. Haz clic en Agregar feed nuevo.
3. Haz clic en Configura un feed único.
4. En el campo Nombre del feed, ingresa un nombre para el feed (por ejemplo, Team Cymru Scout Threat Intelligence).
5. Selecciona Google Cloud Storage V2 como el Tipo de fuente.
6. Selecciona Team Cymru Scout Threat Intelligence como el Tipo de registro.

7. Haz clic en Obtener cuenta de servicio. Se muestra un correo electrónico único de la cuenta de servicio, por ejemplo:

   [e-mail]
   

8. Copia esta dirección de correo electrónico para usarla en el siguiente paso.

   Nota: Cada instancia de Google SecOps tiene una cuenta de servicio única. No uses cuentas de servicio de otros ejemplos o documentación.

Otorga permisos de IAM a la cuenta de servicio de Google SecOps

La cuenta de servicio de Google SecOps necesita el rol de visualizador de objetos de almacenamiento en tu bucket de GCS.

1. Ve a Cloud Storage > Buckets.
2. Haz clic en el nombre de tu bucket.
3. Ve a la pestaña Permisos.
4. Haz clic en Otorgar acceso.
5. Proporciona los siguientes detalles de configuración:
   • Agregar principales: Pega el correo electrónico de la cuenta de servicio de Google SecOps.
   • Asignar roles: Selecciona Visualizador de objetos de Storage.

6. Haz clic en Guardar.

   Nota: Si planeas usar la opción de eliminación "Borrar archivos transferidos" o "Borrar archivos transferidos y directorios vacíos", otorga el rol de Administrador de objetos de Storage en lugar del rol de Visualizador de objetos de Storage.

Configura un feed en Google SecOps para transferir datos de inteligencia sobre amenazas de Team Cymru Scout

1. Ve a Configuración de SIEM > Feeds.
2. Haz clic en Agregar feed nuevo.
3. Haz clic en Configura un feed único.
4. En el campo Nombre del feed, ingresa un nombre para el feed (por ejemplo, Team Cymru Scout Threat Intelligence).
5. Selecciona Google Cloud Storage V2 como el Tipo de fuente.
6. Selecciona Team Cymru Scout Threat Intelligence como el Tipo de registro.
7. Haz clic en Siguiente.

8. Especifica valores para los siguientes parámetros de entrada:

   • URL del bucket de almacenamiento: Ingresa el URI del bucket de GCS con la ruta de acceso del prefijo:

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

     • Reemplaza lo siguiente:

       • team-cymru-scout-ti: Es el nombre de tu bucket de GCS.
       • team-cymru/scout-ti/: Es el prefijo o la ruta de acceso a la carpeta en la que se almacenan los registros.
     Nota: Siempre incluye la barra diagonal final (/) al final del URI.

   • Opción de borrado de la fuente: Selecciona la opción de borrado según tu preferencia:

     • Nunca: Nunca borra ningún archivo después de las transferencias (se recomienda para las pruebas).
     • Borrar archivos transferidos: Borra los archivos después de la transferencia exitosa.

     • Borrar los archivos transferidos y los directorios vacíos: Borra los archivos y los directorios vacíos después de la transferencia exitosa.

       Nota: Si seleccionas una opción de eliminación, la cuenta de servicio debe tener el rol de administrador de objetos de Storage en lugar del rol de visualizador de objetos de Storage. Actualiza los permisos de IAM según corresponda.

   • Antigüedad máxima del archivo: Incluye los archivos modificados en la cantidad de días especificada. El valor predeterminado es de 180 días.

   • Espacio de nombres del recurso: Es el espacio de nombres del recurso.

   • Etiquetas de transmisión: Es la etiqueta que se aplicará a los eventos de este feed.

9. Haz clic en Siguiente.

10. Revisa la nueva configuración del feed en la pantalla Finalizar y, luego, haz clic en Enviar.

¿Necesitas más ayuda? Obtén respuestas de miembros de la comunidad y profesionales de Google SecOps.