Collecter les journaux des problèmes du groupe Snyk

Compatible avec :

Ce document explique comment ingérer les journaux des problèmes de groupe Snyk dans Google Security Operations à l'aide de Google Cloud Storage. Snyk est une plate-forme de sécurité pour les développeurs qui aide les entreprises à identifier et à corriger les failles dans les dépendances Open Source, les images de conteneur, les configurations d'infrastructure en tant que code et le code d'application. Les problèmes de groupe Snyk offrent une visibilité sur les failles de sécurité et les problèmes de licence dans tous les projets d'un groupe Snyk.

Avant de commencer

Assurez-vous de remplir les conditions préalables suivantes :

  • Une instance Google SecOps
  • Un projet GCP avec l'API Cloud Storage activée
  • Autorisations pour créer et gérer des buckets GCS
  • Autorisations permettant de gérer les stratégies IAM sur les buckets GCS
  • Autorisations permettant de créer des fonctions Cloud Run, des sujets Pub/Sub et des jobs Cloud Scheduler
  • Accès privilégié au groupe Snyk (jeton d'API avec accès en lecture ; ID du groupe)
  • Rôle d'administrateur de groupe Snyk attribué à l'utilisateur disposant du jeton API (l'utilisateur doit pouvoir afficher les journaux d'audit et les problèmes du groupe)

Créer un bucket Google Cloud Storage

  1. Accédez à la console Google Cloud.
  2. Sélectionnez votre projet ou créez-en un.
  3. Dans le menu de navigation, accédez à Cloud Storage> Buckets.
  4. Cliquez sur Créer un bucket.
  5. Fournissez les informations de configuration suivantes :

    Paramètre Valeur
    Nommer votre bucket Saisissez un nom unique (par exemple, snyk-group-logs).
    Type d'emplacement Choisissez en fonction de vos besoins (région, birégion ou multirégion).
    Emplacement Sélectionnez l'emplacement (par exemple, us-central1).
    Classe de stockage Standard (recommandé pour les journaux auxquels vous accédez fréquemment)
    Access control (Contrôle des accès) Uniforme (recommandé)
    Outils de protection Facultatif : Activer la gestion des versions des objets ou la règle de conservation
  6. Cliquez sur Créer.

Collecter l'ID de groupe et le jeton d'API Snyk

Obtenir un jeton d'API Snyk

  1. Connectez-vous à l'interface utilisateur Snyk à l'adresse https://app.snyk.io.
  2. Accédez à Paramètres du compte> Jeton d'API.
  3. Cliquez sur Generate (Générer) pour générer le jeton d'API.
  4. Copiez et enregistrez le jeton dans un emplacement sécurisé pour l'utiliser ultérieurement comme SNYK_TOKEN.

Obtenir l'ID de groupe Snyk

  1. Dans l'interface utilisateur Snyk, passez à votre groupe.
  2. Accédez aux paramètres du groupe.
  3. Copiez et enregistrez l'ID de groupe à partir de l'URL (https://app.snyk.io/group/<GROUP_ID>/...) pour l'utiliser ultérieurement comme GROUP_ID.

Attribuer le rôle d'administrateur de groupe

  1. Dans l'interface utilisateur de Snyk, accédez à Paramètres du groupe > Membres.
  2. Identifiez l'utilisateur associé au jeton API.
  3. Attribuez le rôle Administrateur de groupe à l'utilisateur.

Point de terminaison de l'API Note

  • Le point de terminaison de base de l'API REST varie selon la région. Identifiez votre région Snyk et notez l'URL de base REST correspondante :

    Région URL de base REST
    SNYK-US-01 https://api.snyk.io/rest
    SNYK-US-02 https://api.us.snyk.io/rest
    SNYK-EU-01 https://api.eu.snyk.io/rest
    SNYK-AU-01 https://api.au.snyk.io/rest

    Vous utiliserez cette URL de base REST comme API_BASE dans la configuration de la fonction Cloud Run. Le code de la fonction construit des URL de point de terminaison complètes en ajoutant des chemins d'accès tels que /groups/{group_id}/audit_logs/search à cette URL de base.

Créer un compte de service pour la fonction Cloud Run

La fonction Cloud Run a besoin d'un compte de service disposant des autorisations nécessaires pour écrire dans le bucket GCS.

Créer un compte de service

  1. Dans la console GCP, accédez à IAM et administration > Comptes de service.
  2. Cliquez sur Créer un compte de service.
  3. Fournissez les informations de configuration suivantes :
    • Nom du compte de service : saisissez snyk-logs-collector-sa.
    • Description du compte de service : saisissez Service account for Cloud Run function to collect Snyk Group logs.
  4. Cliquez sur Créer et continuer.
  5. Dans la section Autoriser ce compte de service à accéder au projet :
    1. Cliquez sur Sélectionner un rôle.
    2. Recherchez et sélectionnez Administrateur des objets de l'espace de stockage.
    3. Cliquez sur + Ajouter un autre rôle.
    4. Recherchez et sélectionnez Demandeur Cloud Run.
    5. Cliquez sur + Ajouter un autre rôle.
    6. Recherchez et sélectionnez Demandeur Cloud Functions.
  6. Cliquez sur Continuer.
  7. Cliquez sur OK.

Ces rôles sont requis pour :

  • Administrateur des objets Storage : écrire des journaux dans le bucket GCS et gérer les fichiers d'état
  • Demandeur Cloud Run : autorise Pub/Sub à appeler la fonction
  • Demandeur Cloud Functions : autorise l'appel de fonctions

Accorder des autorisations IAM sur un bucket GCS

Accordez au compte de service des autorisations d'écriture sur le bucket GCS :

  1. Accédez à Cloud Storage > Buckets.
  2. Cliquez sur le nom de votre bucket.
  3. Accédez à l'onglet Autorisations.
  4. Cliquez sur Accorder l'accès.
  5. Fournissez les informations de configuration suivantes :
    • Ajouter des comptes principaux : saisissez l'adresse e-mail du compte de service (par exemple, snyk-logs-collector-sa@PROJECT_ID.iam.gserviceaccount.com).
    • Attribuer des rôles : sélectionnez Administrateur des objets Storage.
  6. Cliquez sur Enregistrer.

Créer un sujet Pub/Sub

Créez un sujet Pub/Sub auquel Cloud Scheduler publiera des messages et auquel la fonction Cloud Run s'abonnera.

  1. Dans la console GCP, accédez à Pub/Sub > Sujets.
  2. Cliquez sur Create topic (Créer un sujet).
  3. Fournissez les informations de configuration suivantes :
    • ID du sujet : saisissez snyk-logs-trigger.
    • Conservez les valeurs par défaut des autres paramètres.
  4. Cliquez sur Créer.

Créer une fonction Cloud Run pour collecter les journaux

La fonction Cloud Run est déclenchée par les messages Pub/Sub de Cloud Scheduler pour extraire les journaux de l'API Snyk Group et les écrire dans GCS.

  1. Dans la console GCP, accédez à Cloud Run.
  2. Cliquez sur Créer un service.
  3. Sélectionnez Fonction (utilisez un éditeur intégré pour créer une fonction).
  4. Dans la section Configurer, fournissez les informations de configuration suivantes :

    Paramètre Valeur
    Nom du service snyk-group-logs-collector
    Région Sélectionnez la région correspondant à votre bucket GCS (par exemple, us-central1).
    Runtime (durée d'exécution) Sélectionnez Python 3.12 ou version ultérieure.
  5. Dans la section Déclencheur (facultatif) :

    1. Cliquez sur + Ajouter un déclencheur.
    2. Sélectionnez Cloud Pub/Sub.
    3. Dans Sélectionner un sujet Cloud Pub/Sub, choisissez le sujet snyk-logs-trigger.
    4. Cliquez sur Enregistrer.
  6. Dans la section Authentification :

    1. Sélectionnez Exiger l'authentification.
    2. Consultez Identity and Access Management (IAM).
  7. Faites défiler la page vers le bas, puis développez Conteneurs, mise en réseau, sécurité.

  8. Accédez à l'onglet Sécurité :

    • Compte de service : sélectionnez le compte de service snyk-logs-collector-sa.
  9. Accédez à l'onglet Conteneurs :

    1. Cliquez sur Variables et secrets.
    2. Cliquez sur + Ajouter une variable pour chaque variable d'environnement :
    Nom de la variable Exemple de valeur
    GCS_BUCKET snyk-group-logs
    GCS_PREFIX snyk/group/
    STATE_KEY snyk/group/state.json
    SNYK_TOKEN your-snyk-api-token
    GROUP_ID your-group-uuid
    API_BASE https://api.snyk.io/rest
    SNYK_AUDIT_API_VERSION 2024-10-15
    SNYK_ISSUES_API_VERSION 2024-10-15
    AUDIT_PAGE_SIZE 100
    ISSUES_PAGE_LIMIT 100
    MAX_PAGES 20
    LOOKBACK_SECONDS 3600
  10. Dans l'onglet Variables et secrets, faites défiler la page jusqu'à Requêtes :

    • Délai avant expiration de la requête : saisissez 600 secondes (10 minutes).
  11. Accédez à l'onglet Paramètres dans Conteneurs :

    • Dans la section Ressources :
      • Mémoire : sélectionnez 512 Mio ou plus.
      • CPU : sélectionnez 1.
    • Cliquez sur OK.
  12. Faites défiler la page jusqu'à Environnement d'exécution :

    • Sélectionnez Par défaut (recommandé).
  13. Dans la section Scaling de révision :

    • Nombre minimal d'instances : saisissez 0.
    • Nombre maximal d'instances : saisissez 100 (ou ajustez en fonction de la charge attendue).
  14. Cliquez sur Créer.

  15. Attendez que le service soit créé (1 à 2 minutes).

  16. Une fois le service créé, l'éditeur de code intégré s'ouvre automatiquement.

Ajouter un code de fonction

  1. Saisissez main dans Point d'entrée de la fonction.
  2. Dans l'éditeur de code intégré, créez deux fichiers :

    • Premier fichier : main.py:

          import functions_framework
          from google.cloud import storage
          import json
          import os
          import time
          import urllib.parse
          from urllib.request import Request, urlopen
          from urllib.parse import urlparse, parse_qs
          from urllib.error import HTTPError
      
          # Initialize Storage client
          storage_client = storage.Client()
      
          @functions_framework.cloud_event
          def main(cloud_event):
              """
              Cloud Run function triggered by Pub/Sub to fetch logs from Snyk Group 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', 'snyk/group/').strip()
              state_key = os.environ.get('STATE_KEY', 'snyk/group/state.json').strip()
      
              # Snyk API credentials
              api_base = os.environ.get('API_BASE', 'https://api.snyk.io/rest').rstrip('/')
              snyk_token = os.environ.get('SNYK_TOKEN').strip()
              group_id = os.environ.get('GROUP_ID').strip()
      
              # Page sizes & limits
              audit_size = int(os.environ.get('AUDIT_PAGE_SIZE', '100'))
              issues_limit = int(os.environ.get('ISSUES_PAGE_LIMIT', '100'))
              max_pages = int(os.environ.get('MAX_PAGES', '20'))
      
              # API versions
              audit_api_version = os.environ.get('SNYK_AUDIT_API_VERSION', '2024-10-15').strip()
              issues_api_version = os.environ.get('SNYK_ISSUES_API_VERSION', '2024-10-15').strip()
      
              # First-run lookback
              lookback_seconds = int(os.environ.get('LOOKBACK_SECONDS', '3600'))
      
              if not all([bucket_name, snyk_token, group_id]):
                  print('Error: Missing required environment variables')
                  return
      
              try:
                  # Get GCS bucket
                  bucket = storage_client.bucket(bucket_name)
      
                  # Load state
                  state = load_state(bucket, state_key)
      
                  print('Starting Snyk Group logs collection')
      
                  # Pull audit logs
                  audit_res = pull_audit_logs(
                      bucket, prefix, state, api_base, snyk_token, group_id,
                      audit_api_version, audit_size, max_pages, lookback_seconds
                  )
                  print(f"Audit logs: {audit_res}")
      
                  # Pull issues
                  issues_res = pull_issues(
                      bucket, prefix, state, api_base, snyk_token, group_id,
                      issues_api_version, issues_limit, max_pages
                  )
                  print(f"Issues: {issues_res}")
      
                  # Save state
                  save_state(bucket, state_key, state)
      
                  print('Successfully completed Snyk Group logs collection')
      
              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, separators=(',', ':')),
                      content_type='application/json'
                  )
              except Exception as e:
                  print(f'Warning: Could not save state: {str(e)}')
      
          def _iso(ts):
              """Convert timestamp to ISO format."""
              return time.strftime('%Y-%m-%dT%H:%M:%SZ', time.gmtime(ts))
      
          def _http_get(url, headers):
              """Make HTTP GET request with retry logic."""
              req = Request(url, method='GET', headers=headers)
              try:
                  with urlopen(req, timeout=60) as r:
                      return json.loads(r.read().decode('utf-8'))
              except HTTPError as e:
                  if e.code in (429, 500, 502, 503, 504):
                      delay = int(e.headers.get('Retry-After', '1'))
                      time.sleep(max(1, delay))
                      with urlopen(req, timeout=60) as r2:
                          return json.loads(r2.read().decode('utf-8'))
                  raise
      
          def _write_page(bucket, prefix, kind, payload):
              """Write page to GCS."""
              ts = time.gmtime()
              key = f"{prefix.rstrip('/')}/{time.strftime('%Y/%m/%d/%H%M%S', ts)}-snyk-{kind}.json"
              blob = bucket.blob(key)
              blob.upload_from_string(
                  json.dumps(payload, separators=(',', ':')),
                  content_type='application/json'
              )
              return key
      
          def _next_href(links):
              """Extract next href from links."""
              if not links:
                  return None
              nxt = links.get('next')
              if not nxt:
                  return None
              if isinstance(nxt, str):
                  return nxt
              if isinstance(nxt, dict):
                  return nxt.get('href')
              return None
      
          def pull_audit_logs(bucket, prefix, state, api_base, snyk_token, group_id,
                              audit_api_version, audit_size, max_pages, lookback_seconds):
              """Pull audit logs from Snyk Group API."""
              headers = {
                  'Authorization': f'token {snyk_token}',
                  'Accept': 'application/vnd.api+json',
              }
      
              cursor = state.get('audit_cursor')
              pages = 0
              total = 0
              base = f"{api_base}/groups/{group_id}/audit_logs/search"
              params = {
                  'version': audit_api_version,
                  'size': audit_size
              }
      
              if cursor:
                  params['cursor'] = cursor
              else:
                  now = time.time()
                  params['from'] = _iso(now - lookback_seconds)
                  params['to'] = _iso(now)
      
              while pages < max_pages:
                  url = f"{base}?{urllib.parse.urlencode(params, doseq=True)}"
                  payload = _http_get(url, headers)
                  _write_page(bucket, prefix, 'audit', payload)
      
                  data_items = (payload.get('data') or {}).get('items') or []
                  if isinstance(data_items, list):
                      total += len(data_items)
      
                  nxt = _next_href(payload.get('links'))
                  if not nxt:
                      break
      
                  q = parse_qs(urlparse(nxt).query)
                  cur = (q.get('cursor') or [None])[0]
                  if not cur:
                      break
      
                  params = {
                      'version': audit_api_version,
                      'size': audit_size,
                      'cursor': cur
                  }
                  state['audit_cursor'] = cur
                  pages += 1
      
              return {
                  'pages': pages + 1 if total else pages,
                  'items': total,
                  'cursor': state.get('audit_cursor')
              }
      
          def pull_issues(bucket, prefix, state, api_base, snyk_token, group_id,
                          issues_api_version, issues_limit, max_pages):
              """Pull issues from Snyk Group API."""
              headers = {
                  'Authorization': f'token {snyk_token}',
                  'Accept': 'application/vnd.api+json',
              }
      
              cursor = state.get('issues_cursor')
              pages = 0
              total = 0
              base = f"{api_base}/groups/{group_id}/issues"
              params = {
                  'version': issues_api_version,
                  'limit': issues_limit
              }
      
              if cursor:
                  params['starting_after'] = cursor
      
              while pages < max_pages:
                  url = f"{base}?{urllib.parse.urlencode(params, doseq=True)}"
                  payload = _http_get(url, headers)
                  _write_page(bucket, prefix, 'issues', payload)
      
                  data_items = payload.get('data') or []
                  if isinstance(data_items, list):
                      total += len(data_items)
      
                  nxt = _next_href(payload.get('links'))
                  if not nxt:
                      break
      
                  q = parse_qs(urlparse(nxt).query)
                  cur = (q.get('starting_after') or [None])[0]
                  if not cur:
                      break
      
                  params = {
                      'version': issues_api_version,
                      'limit': issues_limit,
                      'starting_after': cur
                  }
                  state['issues_cursor'] = cur
                  pages += 1
      
              return {
                  'pages': pages + 1 if total else pages,
                  'items': total,
                  'cursor': state.get('issues_cursor')
              }
          ```
      
    • Deuxième fichier : requirements.txt:

      functions-framework==3.*
      google-cloud-storage==2.*
      
  3. Cliquez sur Déployer pour enregistrer et déployer la fonction.

  4. Attendez la fin du déploiement (deux à trois minutes).

Créer une tâche Cloud Scheduler

Cloud Scheduler publie des messages sur le sujet Pub/Sub à intervalles réguliers, ce qui déclenche la fonction Cloud Run.

  1. Dans la console GCP, accédez à Cloud Scheduler.
  2. Cliquez sur Créer une tâche.
  3. Fournissez les informations de configuration suivantes :

    Paramètre Valeur
    Nom snyk-group-logs-hourly
    Région Sélectionnez la même région que la fonction Cloud Run.
    Fréquence 0 * * * * (toutes les heures)
    Fuseau horaire Sélectionnez un fuseau horaire (UTC recommandé).
    Type de cible Pub/Sub
    Topic Sélectionnez le thème snyk-logs-trigger.
    Corps du message {} (objet JSON vide)
  4. Cliquez sur Créer.

Options de fréquence de planification

  • Choisissez la fréquence en fonction du volume de journaux et des exigences de latence :

    Fréquence Expression Cron Cas d'utilisation
    Toutes les 5 minutes */5 * * * * Volume élevé, faible latence
    Toutes les 15 minutes */15 * * * * Volume moyen
    Toutes les heures 0 * * * * Standard (recommandé)
    Toutes les 6 heures 0 */6 * * * Traitement par lot à faible volume
    Tous les jours 0 0 * * * Collecte de données historiques

Tester le job Scheduler

  1. Dans la console Cloud Scheduler, recherchez votre job.
  2. Cliquez sur Forcer l'exécution pour déclencher manuellement l'exécution.
  3. Patientez quelques secondes, puis accédez à Cloud Run > Services > snyk-group-logs-collector > Journaux.
  4. Vérifiez que la fonction s'est exécutée correctement.
  5. Vérifiez le bucket GCS pour confirmer que les journaux ont été écrits.

Récupérer le compte de service Google SecOps

Google SecOps utilise un compte de service unique pour lire les données de votre bucket GCS. Vous devez accorder à ce compte de service l'accès à votre bucket.

Obtenir l'adresse e-mail du compte de service

  1. Accédez à Paramètres SIEM> Flux.
  2. Cliquez sur Add New Feed (Ajouter un flux).
  3. Cliquez sur Configurer un flux unique.
  4. Dans le champ Nom du flux, saisissez un nom pour le flux (par exemple, Snyk Group Audit/Issues).
  5. Sélectionnez Google Cloud Storage V2 comme Type de source.
  6. Sélectionnez Journaux d'audit/de problèmes au niveau du groupe Snyk pour le Type de journal.
  7. Cliquez sur Obtenir un compte de service. Une adresse e-mail unique pour le compte de service s'affiche, par exemple :

    chronicle-12345678@chronicle-gcp-prod.iam.gserviceaccount.com
    
  8. Copiez cette adresse e-mail pour l'utiliser à l'étape suivante.

Accorder des autorisations IAM au compte de service Google SecOps

Le compte de service Google SecOps a besoin du rôle Lecteur des objets Storage sur votre bucket GCS.

  1. Accédez à Cloud Storage > Buckets.
  2. Cliquez sur le nom de votre bucket.
  3. Accédez à l'onglet Autorisations.
  4. Cliquez sur Accorder l'accès.
  5. Fournissez les informations de configuration suivantes :
    • Ajouter des comptes principaux : collez l'adresse e-mail du compte de service Google SecOps.
    • Attribuez des rôles : sélectionnez Lecteur des objets de l'espace de stockage.
  6. Cliquez sur Enregistrer.

Configurer un flux dans Google SecOps pour ingérer les journaux de groupe Snyk

  1. Accédez à Paramètres SIEM> Flux.
  2. Cliquez sur Add New Feed (Ajouter un flux).
  3. Cliquez sur Configurer un flux unique.
  4. Dans le champ Nom du flux, saisissez un nom pour le flux (par exemple, Snyk Group Audit/Issues).
  5. Sélectionnez Google Cloud Storage V2 comme Type de source.
  6. Sélectionnez Journaux d'audit/de problèmes au niveau du groupe Snyk pour le Type de journal.
  7. Cliquez sur Suivant.
  8. Spécifiez les valeurs des paramètres d'entrée suivants :

    • URL du bucket Storage : saisissez l'URI du bucket GCS avec le préfixe du chemin d'accès :

      gs://snyk-group-logs/snyk/group/
      
      • Remplacez :

        • snyk-group-logs : nom de votre bucket GCS.
        • snyk/group/ : préfixe/chemin d'accès au dossier facultatif où les journaux sont stockés (laisser vide pour la racine).
      • Exemples :

        • Bucket racine : gs://company-logs/
        • Avec préfixe : gs://company-logs/snyk-logs/
        • Avec un sous-dossier : gs://company-logs/snyk/group/
    • Option de suppression de la source : sélectionnez l'option de suppression de votre choix :
      • Jamais : ne supprime jamais aucun fichier après les transferts (recommandé pour les tests).
      • Supprimer les fichiers transférés : supprime les fichiers après un transfert réussi.
      • Supprimer les fichiers transférés et les répertoires vides : supprime les fichiers et les répertoires vides après un transfert réussi.
    • Âge maximal des fichiers : incluez les fichiers modifiés au cours des derniers jours. La valeur par défaut est de 180 jours.
    • Espace de noms de l'élément : espace de noms de l'élément (par exemple, snyk.group).
    • Libellés d'ingestion : libellé à appliquer aux événements de ce flux.
  9. Cliquez sur Suivant.

  10. Vérifiez la configuration de votre nouveau flux sur l'écran Finaliser, puis cliquez sur Envoyer.

Vous avez encore besoin d'aide ? Obtenez des réponses de membres de la communauté et de professionnels Google SecOps.