Raccogliere i log dei problemi di Snyk Group

Supportato in:

Google secops SIEM

Nota: questa funzionalità è coperta dai Termini delle offerte pre-GA dei Termini di servizio specifici del servizio Google Security Operations. Le funzionalità pre-GA potrebbero avere supporto limitato e le modifiche alle funzionalità pre-GA potrebbero non essere compatibili con altre versioni pre-GA. Per saperne di più, consulta le linee guida per i servizi di assistenza tecnica di Google SecOps e i Termini di servizio specifici di Google SecOps.

Questo documento spiega come importare i log dei problemi di Snyk Group in Google Security Operations utilizzando Google Cloud Storage. Snyk è una piattaforma di sicurezza per sviluppatori che aiuta le organizzazioni a trovare e correggere le vulnerabilità nelle dipendenze open source, nelle immagini container, nelle configurazioni dell'infrastruttura come codice e nel codice dell'applicazione. I problemi del gruppo Snyk forniscono visibilità sulle vulnerabilità di sicurezza e sui problemi di licenza in tutti i progetti all'interno di un gruppo Snyk.

Prima di iniziare

Assicurati di disporre dei seguenti prerequisiti:

• Un'istanza Google SecOps
• Un progetto GCP con l'API Cloud Storage abilitata
• Autorizzazioni per creare e gestire bucket GCS
• Autorizzazioni per gestire le policy IAM nei bucket GCS
• Autorizzazioni per creare funzioni Cloud Run, argomenti Pub/Sub e job Cloud Scheduler
• Accesso privilegiato al gruppo Snyk (token API con accesso in lettura; ID gruppo)
• Ruolo Amministratore gruppo Snyk assegnato all'utente con il token API (l'utente deve essere in grado di visualizzare i log di controllo del gruppo e i problemi del gruppo)

Creazione di un bucket Google Cloud Storage

1. Vai alla console Google Cloud.
2. Seleziona il tuo progetto o creane uno nuovo.
3. Nel menu di navigazione, vai a Cloud Storage > Bucket.
4. Fai clic su Crea bucket.

5. Fornisci i seguenti dettagli di configurazione:

   Impostazione	Valore
   Assegna un nome al bucket	Inserisci un nome univoco globale (ad esempio snyk-group-logs).
   Tipo di località	Scegli in base alle tue esigenze (regione singola, doppia regione, più regioni)
   Località	Seleziona la posizione (ad esempio, us-central1).
   Classe di archiviazione	Standard (consigliato per i log a cui si accede di frequente)
   Controllo dell'accesso	Uniforme (consigliato)
   Strumenti di protezione	(Facoltativo) Attiva il controllo delle versioni degli oggetti o la policy di conservazione

6. Fai clic su Crea.

Raccogli l'ID gruppo e il token API di Snyk

Ottieni il token API Snyk

1. Accedi all'interfaccia utente di Snyk all'indirizzo https://app.snyk.io.
2. Vai a Impostazioni account > Token API.
3. Fai clic su Genera per generare il token API.

4. Copia e salva il token in una posizione sicura per utilizzarlo in un secondo momento come SNYK_TOKEN.

   Nota: questo token verrà utilizzato dalla funzione Cloud Run per l'autenticazione all'API Snyk.

Recuperare l'ID gruppo Snyk

1. Nell'interfaccia utente di Snyk, passa al tuo gruppo.
2. Vai a Impostazioni gruppo.
3. Copia e salva l'ID gruppo dall'URL (https://app.snyk.io/group/<GROUP_ID>/...) per utilizzarlo in un secondo momento come GROUP_ID.

Assegnare il ruolo di amministratore del gruppo

1. Nell'interfaccia utente di Snyk, vai a Impostazioni gruppo > Membri.
2. Individua l'utente associato al token API.

3. Assegna all'utente il ruolo Amministratore del gruppo.

   Nota :l'utente deve essere in grado di visualizzare i log di controllo di Gruppi e i problemi di gruppo.

Endpoint API Note

• L'endpoint di base dell'API REST varia in base alla regione. Identifica la tua regione Snyk e annota l'URL di base REST corrispondente:

  Regione	URL di 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

  Utilizzerai questo URL di base REST come API_BASE nella configurazione della funzione Cloud Run. Il codice della funzione crea URL endpoint completi aggiungendo percorsi come /groups/{group_id}/audit_logs/search a questo URL di base.

  Nota: gli endpoint dei log di controllo Snyk sono disponibili solo per i piani Enterprise. Verifica che il tuo piano includa l'accesso ai log di controllo del gruppo e che il tuo account abbia limiti di conservazione appropriati configurati.

Crea un service account per la funzione Cloud Run

La funzione Cloud Run richiede un service account con autorizzazioni per scrivere nel bucket GCS.

Crea service account

1. Nella console Google Cloud, vai a IAM e amministrazione > Service Accounts.
2. Fai clic su Crea service account.
3. Fornisci i seguenti dettagli di configurazione:
   • Nome del service account: inserisci snyk-logs-collector-sa.
   • Descrizione service account: inserisci Service account for Cloud Run function to collect Snyk Group logs.
4. Fai clic su Crea e continua.
5. Nella sezione Concedi a questo service account l'accesso al progetto:
   1. Fai clic su Seleziona un ruolo.
   2. Cerca e seleziona Amministratore oggetti di archiviazione.
   3. Fai clic su + Aggiungi un altro ruolo.
   4. Cerca e seleziona Cloud Run Invoker.
   5. Fai clic su + Aggiungi un altro ruolo.
   6. Cerca e seleziona Invoker di Cloud Functions.
6. Fai clic su Continua.
7. Fai clic su Fine.

Questi ruoli sono necessari per:

• Amministratore oggetti Storage: scrive i log nel bucket GCS e gestisce i file di stato
• Cloud Run Invoker: consente a Pub/Sub di richiamare la funzione
• Cloud Functions Invoker: consente la chiamata di funzioni

Concedi autorizzazioni IAM sul bucket GCS

Concedi al service account le autorizzazioni di scrittura sul bucket GCS:

1. Vai a Cloud Storage > Bucket.
2. Fai clic sul nome del bucket.
3. Vai alla scheda Autorizzazioni.
4. Fai clic su Concedi l'accesso.
5. Fornisci i seguenti dettagli di configurazione:
   • Aggiungi entità: inserisci l'email del service account (ad es. snyk-logs-collector-sa@PROJECT_ID.iam.gserviceaccount.com).
   • Assegna i ruoli: seleziona Storage Object Admin.
6. Fai clic su Salva.

Crea argomento Pub/Sub

Crea un argomento Pub/Sub a cui Cloud Scheduler pubblicherà e a cui la funzione Cloud Run si iscriverà.

1. Nella console GCP, vai a Pub/Sub > Argomenti.
2. Fai clic su Crea argomento.
3. Fornisci i seguenti dettagli di configurazione:
   • ID argomento: inserisci snyk-logs-trigger.
   • Lascia le altre impostazioni sui valori predefiniti.
4. Fai clic su Crea.

Crea una funzione Cloud Run per raccogliere i log

La funzione Cloud Run viene attivata dai messaggi Pub/Sub di Cloud Scheduler per recuperare i log dall'API Snyk Group e li scrive in GCS.

1. Nella console GCP, vai a Cloud Run.
2. Fai clic su Crea servizio.
3. Seleziona Funzione (usa un editor in linea per creare una funzione).

4. Nella sezione Configura, fornisci i seguenti dettagli di configurazione:

   Impostazione	Valore
   Nome servizio	snyk-group-logs-collector
   Regione	Seleziona la regione corrispondente al tuo bucket GCS (ad esempio us-central1)
   Runtime	Seleziona Python 3.12 o versioni successive

5. Nella sezione Trigger (facoltativo):

   1. Fai clic su + Aggiungi trigger.
   2. Seleziona Cloud Pub/Sub.
   3. In Seleziona un argomento Cloud Pub/Sub, scegli l'argomento snyk-logs-trigger.
   4. Fai clic su Salva.

6. Nella sezione Autenticazione:

   1. Seleziona Richiedi autenticazione.
   2. Controlla Identity and Access Management (IAM).
   Nota: Pub/Sub gestisce automaticamente l'autenticazione quando richiama la funzione.

7. Scorri verso il basso ed espandi Container, networking, sicurezza.

8. Vai alla scheda Sicurezza:

   • Service account: seleziona il service account snyk-logs-collector-sa.

9. Vai alla scheda Container:

   1. Fai clic su Variabili e secret.
   2. Fai clic su + Aggiungi variabile per ogni variabile di ambiente:

   Nome variabile	Valore di esempio
   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

   Nota: imposta API_BASE sull'URL di base REST corretto per la tua regione Snyk. Per SNYK-US-01, utilizza https://api.snyk.io/rest. Per SNYK-EU-01, utilizza https://api.eu.snyk.io/rest. Per SNYK-US-02, utilizza https://api.us.snyk.io/rest. Per SNYK-AU-01, utilizza https://api.au.snyk.io/rest.

10. Scorri verso il basso nella scheda Variabili e secret fino a Richieste:

    • Timeout richiesta: inserisci 600 secondi (10 minuti).

11. Vai alla scheda Impostazioni in Container:

    • Nella sezione Risorse:
      • Memoria: seleziona 512 MiB o un valore superiore.
      • CPU: seleziona 1.
    • Fai clic su Fine.

12. Scorri verso il basso fino a Ambiente di esecuzione:

    • Seleziona Predefinito (opzione consigliata).

13. Nella sezione Scalabilità della revisione:

    • Numero minimo di istanze: inserisci 0.
    • Numero massimo di istanze: inserisci 100 (o modifica in base al carico previsto).

14. Fai clic su Crea.

15. Attendi la creazione del servizio (1-2 minuti).

16. Dopo aver creato il servizio, si apre automaticamente l'editor di codice incorporato.

Aggiungi codice per la funzione

1. Inserisci main in Entry point della funzione

2. Nell'editor di codice incorporato, crea due file:

   • Primo file: 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')
             }
         ```
     

   • Secondo file: requirements.txt::

     functions-framework==3.*
     google-cloud-storage==2.*
     

3. Fai clic su Esegui il deployment per salvare la funzione ed eseguirne il deployment.

4. Attendi il completamento del deployment (2-3 minuti).

   Nota :la configurazione del trigger Pub/Sub crea automaticamente le sottoscrizioni e le autorizzazioni necessarie.

Crea job Cloud Scheduler

Cloud Scheduler pubblica messaggi nell'argomento Pub/Sub a intervalli regolari, attivando la funzione Cloud Run.

1. Nella console di GCP, vai a Cloud Scheduler.
2. Fai clic su Crea job.

3. Fornisci i seguenti dettagli di configurazione:

   Impostazione	Valore
   Nome	snyk-group-logs-hourly
   Regione	Seleziona la stessa regione della funzione Cloud Run
   Frequenza	0 * * * * (ogni ora, all'ora)
   Fuso orario	Seleziona il fuso orario (UTC consigliato)
   Tipo di target	Pub/Sub
   Argomento	Seleziona l'argomento snyk-logs-trigger
   Corpo del messaggio	{} (oggetto JSON vuoto)

4. Fai clic su Crea.

Opzioni di frequenza di pianificazione

• Scegli la frequenza in base al volume dei log e ai requisiti di latenza:

  Frequenza	Espressione cron	Caso d'uso
  Ogni 5 minuti	*/5 * * * *	Volume elevato, bassa latenza
  Ogni 15 minuti	*/15 * * * *	Volume medio
  Ogni ora	0 * * * *	Standard (consigliato)
  Ogni 6 ore	0 */6 * * *	Volume basso, elaborazione batch
  Ogni giorno	0 0 * * *	Raccolta dei dati storici

Testa il job di pianificazione

1. Nella console Cloud Scheduler, trova il job.
2. Fai clic su Forza esecuzione per attivare manualmente.
3. Attendi qualche secondo e vai a Cloud Run > Servizi > snyk-group-logs-collector > Log.
4. Verifica che la funzione sia stata eseguita correttamente.
5. Controlla il bucket GCS per verificare che i log siano stati scritti.

Recuperare il service account Google SecOps

Google SecOps utilizza un service account univoco per leggere i dati dal tuo bucket GCS. Devi concedere a questo service account l'accesso al tuo bucket.

Recuperare l'email del service account

1. Vai a Impostazioni SIEM > Feed.
2. Fai clic su Aggiungi nuovo feed.
3. Fai clic su Configura un singolo feed.
4. Nel campo Nome feed, inserisci un nome per il feed (ad esempio, Snyk Group Audit/Issues).
5. Seleziona Google Cloud Storage V2 come Tipo di origine.
6. Seleziona Log di controllo/problemi a livello di gruppo Snyk come Tipo di log.

7. Fai clic su Ottieni service account. Viene visualizzata un'email del service account univoca, ad esempio:

   [e-mail]
   

8. Copia questo indirizzo email per utilizzarlo nel passaggio successivo.

   Nota: ogni istanza di Google SecOps ha un service account univoco. Non utilizzare service account di altre documentazioni o esempi.

Concedi le autorizzazioni IAM al service account Google SecOps

Il service account Google SecOps deve avere il ruolo Visualizzatore oggetti Storage nel bucket GCS.

1. Vai a Cloud Storage > Bucket.
2. Fai clic sul nome del bucket.
3. Vai alla scheda Autorizzazioni.
4. Fai clic su Concedi l'accesso.
5. Fornisci i seguenti dettagli di configurazione:
   • Aggiungi entità: incolla l'email del service account Google SecOps.
   • Assegna i ruoli: seleziona Visualizzatore oggetti Storage.

6. Fai clic su Salva.

   Nota: se prevedi di utilizzare l'opzione di eliminazione "Elimina i file trasferiti" o "Elimina i file trasferiti e le directory vuote", assegna il ruolo Storage Object Admin anziché Storage Object Viewer.

Configura un feed in Google SecOps per importare i log di Snyk Group

1. Vai a Impostazioni SIEM > Feed.
2. Fai clic su Aggiungi nuovo feed.
3. Fai clic su Configura un singolo feed.
4. Nel campo Nome feed, inserisci un nome per il feed (ad esempio, Snyk Group Audit/Issues).
5. Seleziona Google Cloud Storage V2 come Tipo di origine.
6. Seleziona Log di controllo/problemi a livello di gruppo Snyk come Tipo di log.
7. Fai clic su Avanti.

8. Specifica i valori per i seguenti parametri di input:

   • URL del bucket di archiviazione: inserisci l'URI del bucket GCS con il percorso del prefisso:

     gs://snyk-group-logs/snyk/group/
     

     • Sostituisci:

       • snyk-group-logs: il nome del bucket GCS.
       • snyk/group/: (Facoltativo) prefisso/percorso della cartella in cui vengono archiviati i log (lascia vuoto per la radice).

     • Esempi:

       • Bucket radice: gs://company-logs/
       • Con prefisso: gs://company-logs/snyk-logs/
       • Con sottocartella: gs://company-logs/snyk/group/
   Nota: includi sempre la barra finale (/) alla fine dell'URI.
   • Opzione di eliminazione dell'origine: seleziona l'opzione di eliminazione in base alle tue preferenze:
     • Mai: non elimina mai i file dopo i trasferimenti (opzione consigliata per i test).
     • Elimina file trasferiti: elimina i file dopo il trasferimento riuscito.
     • Elimina file trasferiti e directory vuote: elimina i file e le directory vuote dopo il trasferimento riuscito.
   Nota: se selezioni un'opzione di eliminazione, il service account deve disporre del ruolo Storage Object Admin anziché di Storage Object Viewer. Aggiorna le autorizzazioni IAM di conseguenza.
   • Età massima del file: includi i file modificati nell'ultimo numero di giorni. Il valore predefinito è 180 giorni.
   • Spazio dei nomi dell'asset: lo spazio dei nomi dell'asset (ad esempio, snyk.group).
   • Etichette di importazione: l'etichetta da applicare agli eventi di questo feed.

9. Fai clic su Avanti.

10. Controlla la nuova configurazione del feed nella schermata Finalizza e poi fai clic su Invia.

Hai bisogno di ulteriore assistenza? Ricevi risposte dai membri della community e dai professionisti di Google SecOps.