Recopila registros de auditoría a nivel del grupo de Snyk
En este documento, se explica cómo transferir registros de auditoría a nivel del grupo de Snyk a Google Security Operations con Google Cloud Storage. Primero, el analizador limpia los campos innecesarios de los registros sin procesar. Luego, extrae información relevante, como detalles del usuario, tipo de evento y marcas de tiempo, y la transforma y asigna al esquema de UDM de Google SecOps para obtener una representación estandarizada del registro de seguridad.
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 a Snyk (administrador del grupo) y un token de API con acceso al grupo
- Plan de Snyk Enterprise (los extremos de los registros de auditoría solo están disponibles en los planes Enterprise)
Recopila los requisitos previos de los registros de auditoría a nivel del grupo de Snyk (IDs, claves de API, IDs de organización y tokens)
- En Snyk, haz clic en tu avatar > Configuración de la cuenta > Token de API.
- Haz clic en Revocar y regenerar (o Generar) y copia el token.
- Guarda este token como la variable de entorno
SNYK_API_TOKEN. - En Snyk, cambia a tu grupo (selector en la esquina superior izquierda).
- Ve a Configuración del grupo.
- Copia el
<GROUP_ID>de la URL:https://app.snyk.io/group/<GROUP_ID>/settings.- O bien usa la API de REST:
GET https://api.snyk.io/rest/groups?version=2024-01-04y eligeid.
- O bien usa la API de REST:
- Asegúrate de que el usuario del token tenga permiso para ver registros de auditoría (
group.audit.read).
Verifica los permisos
Para verificar que la cuenta tenga los permisos necesarios, sigue estos pasos:
- Accede a Snyk.
- Cambia a tu grupo (selector en la esquina superior izquierda).
- Ve a Configuración del grupo.
- Si ves la opción Registros de auditoría en la navegación de la izquierda, tienes los permisos necesarios.
Si no ves esta opción, comunícate con tu administrador para que te otorgue permiso de View Audit Logs (
group.audit.read).
Prueba el acceso a la API
Prueba tus credenciales antes de continuar con la integración:
# Replace with your actual credentials SNYK_API_TOKEN="your-token-here" SNYK_GROUP_ID="your-group-id-here" SNYK_API_VERSION="2024-01-04" # Test API access curl -v -H "Authorization: token ${SNYK_API_TOKEN}" \ "https://api.snyk.io/rest/groups/${SNYK_GROUP_ID}/audit_logs/search?version=${SNYK_API_VERSION}&size=10"
Crea un bucket de Google Cloud Storage
- Ve a Google Cloud Console.
- Selecciona tu proyecto o crea uno nuevo.
- En el menú de navegación, ve a Cloud Storage > Buckets.
- Haz clic en Crear bucket.
Proporciona los siguientes detalles de configuración:
Configuración Valor Asigna un nombre a tu bucket Ingresa un nombre global único (por ejemplo, snyk-audit).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 Haz clic en Crear.
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 y ser invocada por Pub/Sub.
Crear cuenta de servicio
- En GCP Console, ve a IAM y administración > Cuentas de servicio.
- Haz clic en Crear cuenta de servicio.
- Proporciona los siguientes detalles de configuración:
- Nombre de la cuenta de servicio: Ingresa
snyk-audit-collector-sa. - Descripción de la cuenta de servicio: Ingresa
Service account for Cloud Run function to collect Snyk group-level audit logs.
- Nombre de la cuenta de servicio: Ingresa
- Haz clic en Crear y continuar.
- En la sección Otorga a esta cuenta de servicio acceso al proyecto, agrega los siguientes roles:
- Haz clic en Selecciona un rol.
- Busca y selecciona Administrador de objetos de almacenamiento.
- Haz clic en + Agregar otra función.
- Busca y selecciona Invocador de Cloud Run.
- Haz clic en + Agregar otra función.
- Busca y selecciona Cloud Functions Invoker.
- Haz clic en Continuar.
- 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:
- Ve a Cloud Storage > Buckets.
- Haz clic en el nombre de tu bucket (por ejemplo,
snyk-audit). - Ve a la pestaña Permisos.
- Haz clic en Otorgar acceso.
- Proporciona los siguientes detalles de configuración:
- Agregar principales: Ingresa el correo electrónico de la cuenta de servicio (por ejemplo,
snyk-audit-collector-sa@PROJECT_ID.iam.gserviceaccount.com). - Asignar roles: Selecciona Administrador de objetos de Storage.
- Agregar principales: Ingresa el correo electrónico de la cuenta de servicio (por ejemplo,
- 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.
- En GCP Console, ve a Pub/Sub > Temas.
- Haz clic en Crear un tema.
- Proporciona los siguientes detalles de configuración:
- ID del tema: Ingresa
snyk-audit-trigger. - Deja el resto de la configuración con sus valores predeterminados.
- ID del tema: Ingresa
- Haz clic en Crear.
Crea una función de Cloud Run para recopilar registros
La función de Cloud Run se activa con mensajes de Pub/Sub de Cloud Scheduler para recuperar registros de la API de Snyk y escribirlos en GCS.
- En GCP Console, ve a Cloud Run.
- Haz clic en Crear servicio.
- Selecciona Función (usa un editor intercalado para crear una función).
En la sección Configurar, proporciona los siguientes detalles de configuración:
Configuración Valor Nombre del servicio snyk-audit-collectorRegió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. En la sección Activador (opcional), haz lo siguiente:
- Haz clic en + Agregar activador.
- Selecciona Cloud Pub/Sub.
- En Selecciona un tema de Cloud Pub/Sub, elige el tema de Pub/Sub (
snyk-audit-trigger). - Haz clic en Guardar.
En la sección Autenticación, haz lo siguiente:
- Selecciona Solicitar autenticación.
- Verifica Identity and Access Management (IAM).
Desplázate hacia abajo y expande Contenedores, redes y seguridad.
Ve a la pestaña Seguridad:
- Cuenta de servicio: Selecciona la cuenta de servicio (
snyk-audit-collector-sa).
- Cuenta de servicio: Selecciona la cuenta de servicio (
Ve a la pestaña Contenedores:
- Haz clic en Variables y secretos.
- Haz clic en + Agregar variable para cada variable de entorno:
Nombre de la variable Valor de ejemplo GCS_BUCKETsnyk-auditGCS_PREFIXsnyk/audit/STATE_KEYsnyk/audit/state.jsonSNYK_GROUP_ID<your_group_id>SNYK_API_TOKENxxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxSNYK_API_BASEhttps://api.snyk.io(opcional)SNYK_API_VERSION2024-01-04SIZE100MAX_PAGES20LOOKBACK_SECONDS3600EVENTS(opcional) group.create,org.user.addEXCLUDE_EVENTS(opcional) api.accessEn la sección Variables y Secrets, desplázate hacia abajo hasta Solicitudes:
- Tiempo de espera de la solicitud: Ingresa
600segundos (10 minutos).
- Tiempo de espera de la solicitud: Ingresa
Ve a la pestaña Configuración:
- En la sección Recursos, haz lo siguiente:
- Memoria: Selecciona 512 MiB o más.
- CPU: Selecciona 1.
- En la sección Recursos, haz lo siguiente:
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).
- Cantidad mínima de instancias: Ingresa
Haz clic en Crear.
Espera a que se cree el servicio (de 1 a 2 minutos).
Después de crear el servicio, se abrirá automáticamente el editor de código intercalado.
Agregar el código de función
- Ingresa main en Punto de entrada de la función.
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 import urllib.parse # 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 Snyk group-level audit logs 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', 'snyk/audit/') state_key = os.environ.get('STATE_KEY', 'snyk/audit/state.json') # Snyk API configuration api_base = os.environ.get('SNYK_API_BASE', 'https://api.snyk.io').rstrip('/') group_id = os.environ.get('SNYK_GROUP_ID', '').strip() api_token = os.environ.get('SNYK_API_TOKEN', '').strip() api_version = os.environ.get('SNYK_API_VERSION', '2024-01-04').strip() size = int(os.environ.get('SIZE', '100')) max_pages = int(os.environ.get('MAX_PAGES', '20')) lookback_seconds = int(os.environ.get('LOOKBACK_SECONDS', '3600')) events_csv = os.environ.get('EVENTS', '').strip() exclude_events_csv = os.environ.get('EXCLUDE_EVENTS', '').strip() if not all([bucket_name, group_id, api_token]): print('Error: Missing required environment variables') return try: # Get GCS bucket bucket = storage_client.bucket(bucket_name) # Load state (last cursor) state = load_state(bucket, state_key) cursor = state.get('cursor') print(f'Starting log collection with cursor: {cursor}') # Prepare headers for Snyk REST API headers = { 'Authorization': f'token {api_token}', 'Accept': 'application/vnd.api+json' } pages = 0 total = 0 last_cursor = cursor # Only for the very first run (no saved cursor), constrain the time window first_run_from_iso = None if not cursor and lookback_seconds > 0: first_run_from_iso = time.strftime( '%Y-%m-%dT%H:%M:%SZ', time.gmtime(time.time() - lookback_seconds) ) while pages < max_pages: payload = fetch_page( api_base, group_id, headers, api_version, size, cursor, first_run_from_iso, events_csv, exclude_events_csv ) # Write payload to GCS write_to_gcs(bucket, prefix, payload) # Extract items count data_obj = payload.get('data') or {} items = data_obj.get('items') or [] if isinstance(items, list): total += len(items) # Parse next cursor cursor = parse_next_cursor_from_links(payload.get('links')) pages += 1 if not cursor: break # After first page, disable from-filter first_run_from_iso = None # Save state if cursor and cursor != last_cursor: save_state(bucket, state_key, {'cursor': cursor}) print(f'Successfully processed {total} events across {pages} pages. Next cursor: {cursor}') except Exception as e: print(f'Error processing logs: {str(e)}') raise 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), content_type='application/json' ) except Exception as e: print(f'Warning: Could not save state: {str(e)}') def write_to_gcs(bucket, prefix, payload): """Write payload to GCS.""" ts = time.strftime('%Y/%m/%d/%H%M%S', time.gmtime()) key = f"{prefix.rstrip('/')}/{ts}-snyk-group-audit.json" blob = bucket.blob(key) blob.upload_from_string( json.dumps(payload, separators=(',', ':')), content_type='application/json' ) print(f'Wrote payload to {key}') def parse_next_cursor_from_links(links): """Parse next cursor from links object.""" if not links: return None nxt = links.get('next') if not nxt: return None try: q = urllib.parse.urlparse(nxt).query params = urllib.parse.parse_qs(q) cur = params.get('cursor') return cur[0] if cur else None except Exception: return None def as_list(csv_str): """Convert comma-separated string to list.""" return [x.strip() for x in csv_str.split(',') if x.strip()] def fetch_page(api_base, group_id, headers, api_version, size, cursor, first_run_from_iso, events_csv, exclude_events_csv): """Fetch a single page from Snyk audit logs API.""" base_path = f'/rest/groups/{group_id}/audit_logs/search' params = { 'version': api_version, 'size': size, } if cursor: params['cursor'] = cursor elif first_run_from_iso: params['from'] = first_run_from_iso events = as_list(events_csv) exclude_events = as_list(exclude_events_csv) if events and exclude_events: exclude_events = [] if events: params['events'] = events if exclude_events: params['exclude_events'] = exclude_events url = f"{api_base}{base_path}?{urllib.parse.urlencode(params, doseq=True)}" response = http.request('GET', url, headers=headers, timeout=60.0) if response.status == 429 or response.status >= 500: retry_after = int(response.headers.get('Retry-After', '1')) time.sleep(max(1, retry_after)) response = http.request('GET', url, headers=headers, timeout=60.0) if response.status != 200: raise Exception(f'API request failed with status {response.status}: {response.data.decode("utf-8")}') return json.loads(response.data.decode('utf-8'))- Segundo archivo: requirements.txt:
functions-framework==3.* google-cloud-storage==2.* urllib3>=2.0.0Haz clic en Implementar para guardar y, luego, implementar la función.
Espera a que se complete la implementación (de 2 a 3 minutos).
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.
- En GCP Console, ve a Cloud Scheduler.
- Haz clic en Crear trabajo.
Proporciona los siguientes detalles de configuración:
Configuración Valor Nombre snyk-audit-collector-hourlyRegió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 de Pub/Sub ( snyk-audit-trigger).Cuerpo del mensaje {}Haz clic en Crear.
Opciones de frecuencia de programación
Elige la frecuencia según los requisitos de latencia y volumen de registros:
Frecuencia Expresión cron Caso de uso Cada 5 minutos */5 * * * *Alto volumen y baja latencia Cada 15 minutos */15 * * * *Volumen medio Cada 1 hora 0 * * * *Estándar (opción recomendada) Cada 6 horas 0 */6 * * *Procesamiento por lotes y volumen bajo Diario 0 0 * * *Recopilación de datos históricos
Prueba la integración
- En la consola de Cloud Scheduler, busca tu trabajo (
snyk-audit-collector-hourly). - Haz clic en Forzar ejecución para activar el trabajo de forma manual.
- Espera unos segundos.
- Ve a Cloud Run > Servicios.
- Haz clic en el nombre de la función (
snyk-audit-collector). - Haz clic en la pestaña Registros.
Verifica que la función se haya ejecutado correctamente. Busca lo siguiente:
Starting log collection with cursor: None Page 1: Retrieved X events Wrote payload to snyk/audit/YYYY/MM/DD/HHMMSS-snyk-group-audit.json Successfully processed X events across Y pages. Next cursor: ...Ve a Cloud Storage > Buckets.
Haz clic en el nombre de tu bucket (por ejemplo,
snyk-audit).Navega a la carpeta del prefijo (
snyk/audit/).Verifica que se haya creado un archivo
.jsonnuevo con la marca de tiempo actual.
Si ves errores en los registros, haz lo siguiente:
- HTTP 401: Verifica
SNYK_API_TOKENen las variables de entorno - HTTP 403: Verifica que el usuario del token tenga permiso de
group.audit.ready que tu suscripción a Snyk sea un plan Enterprise. - HTTP 429: Limitación de frecuencia. La función volverá a intentarlo automáticamente con una espera exponencial.
- Faltan variables de entorno: Verifica que estén configuradas todas las variables obligatorias (
GCS_BUCKET,SNYK_GROUP_ID,SNYK_API_TOKEN).
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
- Ve a Configuración de SIEM > Feeds.
- Haz clic en Agregar feed nuevo.
- Haz clic en Configura un feed único.
- En el campo Nombre del feed, ingresa un nombre para el feed (por ejemplo,
Snyk Group Audit Logs). - Selecciona Google Cloud Storage V2 como el Tipo de fuente.
- Selecciona Snyk Group level audit Logs como el Tipo de registro.
Haz clic en Obtener cuenta de servicio. Se muestra un correo electrónico único de la cuenta de servicio, por ejemplo:
chronicle-12345678@chronicle-gcp-prod.iam.gserviceaccount.comCopia esta dirección de correo electrónico para usarla en el siguiente paso.
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.
- Ve a Cloud Storage > Buckets.
- Haz clic en el nombre de tu bucket (por ejemplo,
snyk-audit). - Ve a la pestaña Permisos.
- Haz clic en Otorgar acceso.
- 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.
Haz clic en Guardar.
Configura un feed en Google SecOps para transferir registros de auditoría a nivel del grupo de Snyk
- Ve a Configuración de SIEM > Feeds.
- Haz clic en Agregar feed nuevo.
- Haz clic en Configura un feed único.
- En el campo Nombre del feed, ingresa un nombre para el feed (por ejemplo,
Snyk Group Audit Logs). - Selecciona Google Cloud Storage V2 como el Tipo de fuente.
- Selecciona Snyk Group level audit Logs como el Tipo de registro.
- Haz clic en Siguiente.
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://snyk-audit/snyk/audit/Reemplaza lo siguiente:
snyk-audit: Es el nombre de tu bucket de GCS.snyk/audit/: Es el prefijo o la ruta de acceso a la carpeta en la que se almacenan los registros.
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.
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 activo:
snyk.group_auditEtiquetas de transferencia: Agrégalas si lo deseas.
Haz clic en Siguiente.
Revisa la nueva configuración del feed en la pantalla Finalizar y, luego, haz clic en Enviar.
Tabla de asignación de UDM
| Campo de registro | Asignación de UDM | Lógica |
|---|---|---|
| content.url | principal.url | Se asigna directamente desde el campo content.url en el registro sin procesar. |
| created | metadata.event_timestamp | Se analiza a partir del campo created en el registro sin procesar con el formato ISO8601. |
| evento | metadata.product_event_type | Se asigna directamente desde el campo de evento en el registro sin procesar. |
| groupId | principal.user.group_identifiers | Se asigna directamente desde el campo groupId en el registro sin procesar. |
| orgId | principal.user.attribute.labels.key | Se establece en "orgId". |
| orgId | principal.user.attribute.labels.value | Se asigna directamente desde el campo orgId en el registro sin procesar. |
| userid | principal.user.userid | Se asigna directamente desde el campo userId en el registro sin procesar. |
| N/A | metadata.event_type | Está codificado como "USER_UNCATEGORIZED" en el código del analizador. |
| N/A | metadata.log_type | Está codificado como "SNYK_SDLC" en el código del analizador. |
| N/A | metadata.product_name | Está codificado como "SNYK SDLC" en el código del analizador. |
| N/A | metadata.vendor_name | Está codificado como "SNYK_SDLC" en el código del analizador. |
¿Necesitas más ayuda? Obtén respuestas de miembros de la comunidad y profesionales de Google SecOps.