Google utilizza la tecnologia AI per tradurre i contenuti nella tua lingua preferita. Le traduzioni generate dall'AI potrebbero contenere errori.

Raccogli i log dei metadati degli asset Nucleus

Supportata in:

Google SecOps SIEM

Questo documento spiega come importare i log dei metadati degli asset di Nucleus Security in Google Security Operations utilizzando Google Cloud Storage V2.

Nucleus Security è una piattaforma di gestione delle vulnerabilità che aggrega e assegna la priorità ai metadati degli asset provenienti da più scanner, fornendo una visualizzazione unificata della security posture della tua organizzazione. Il parser estrae i campi dai dati degli asset Nucleus e li mappa al modello UDM (Unified Data Model), acquisendo l'identità degli asset, gli indirizzi IP, i nomi host e i punteggi di vulnerabilità.

Prima di iniziare

Assicurati di soddisfare i seguenti prerequisiti:

Un'istanza Google SecOps
Un progetto GCP con l'API Storage di Cloud Storage abilitata
Autorizzazioni per creare e gestire i bucket GCS
Autorizzazioni per gestire le policy IAM sui bucket GCS
Autorizzazioni per creare servizi Cloud Run, argomenti Pub/Sub e job Cloud Scheduler
Accesso con privilegi a Nucleus Security con autorizzazioni di amministratore e accesso con chiave API

Crea un bucket Google Cloud Storage

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

Fornisci i seguenti dettagli di configurazione:

Impostazione	Valore
Assegna un nome al bucket	Inserisci un nome globalmente univoco (ad esempio `nucleus-asset-logs`)
Tipo di località	Scegli in base alle tue esigenze (Regione, a due regioni, multiregionale)
Località	Seleziona la località (ad esempio `us-central1`)
Classe di archiviazione	Standard (consigliato per i log ad accesso frequente)
Controllo degli accessi	Uniforme (consigliato)
Strumenti di protezione	(Facoltativo) Abilita il controllo delle versioni degli oggetti o la policy di conservazione

Fai clic su Crea.

Raccogli le credenziali API di Nucleus Security

Genera una chiave API

Accedi alla piattaforma Nucleus Security con le credenziali di amministratore.
Vai a Impostazioni > Chiavi API.
Fai clic su Genera chiave API.
Inserisci un'etichetta per la chiave (ad esempio Google Security Operations Integration).
Copia e archivia in modo sicuro la chiave API.

Nota: la chiave API fornisce l'accesso in lettura a tutti i progetti e gli asset nel tuo account Nucleus Security. Conservala in un luogo sicuro e non condividerla.

Identifica l'ID progetto

Accedi alla piattaforma Nucleus Security.
Vai a Progetti.
Fai clic sul progetto da cui vuoi raccogliere i dati degli asset.
Prendi nota dell'ID progetto dall'URL o dalla pagina delle impostazioni progetto.

Verifica le autorizzazioni

Per verificare che la chiave API disponga delle autorizzazioni richieste:

Accedi alla piattaforma Nucleus Security.
Vai a Impostazioni > Chiavi API.
Verifica che la chiave API generata sia elencata e abbia lo stato Attiva.
Verifica che la chiave abbia accesso in lettura al progetto di destinazione.

Testa l'accesso all'API

Testa le tue credenziali prima di procedere con l'integrazione:

# Replace with your actual credentials
API_KEY="<your-api-key>"
PROJECT_ID="<your-project-id>"

# Test API access - list assets
curl -v -H "x-apikey: ${API_KEY}" \
  "https://app.nucleussec.com/nucleus/api/v1/projects/${PROJECT_ID}/assets?start=0&limit=10"

Crea un account di servizio per la funzione Cloud Run

La funzione Cloud Run richiede un account di servizio con le autorizzazioni per scrivere nel bucket GCS ed essere richiamata da Pub/Sub.

Crea service account

Nella console Google Cloud, vai a IAM e amministrazione > Account di servizio.
Fai clic su Crea account di servizio.
Fornisci i seguenti dettagli di configurazione:
- Nome del service account: inserisci nucleus-asset-collector-sa
- Descrizione account di servizio: inserisci Service account for Cloud Run function to collect Nucleus Security asset metadata logs
Fai clic su Crea e continua.
Nella sezione Concedi a questo account di servizio l'accesso al progetto, aggiungi i seguenti ruoli:
1. Fai clic su Seleziona un ruolo.
2. Cerca e seleziona Storage Object Admin.
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 Cloud Functions Invoker.
Fai clic su Continua.
Fai clic su Fine.

Questi ruoli sono obbligatori per:

Storage Object Admin: 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 della funzione

Concedi le autorizzazioni IAM sul bucket GCS

Concedi al account di servizio le autorizzazioni in scrittura sul bucket GCS:

Vai a Cloud Storage > Bucket.
Fai clic sul nome del bucket (ad esempio nucleus-asset-logs).
Vai alla scheda Autorizzazioni.
Fai clic su Concedi l'accesso.
Fornisci i seguenti dettagli di configurazione:
- Aggiungi entità: inserisci l'indirizzo email del account di servizio (ad esempio nucleus-asset-collector-sa@PROJECT_ID.iam.gserviceaccount.com)
- Assegna i ruoli: seleziona Storage Object Admin
Fai clic su Salva.

Crea argomento Pub/Sub

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

Nella console Google Cloud, vai a Pub/Sub > Argomenti.
Fai clic su Crea argomento.
Fornisci i seguenti dettagli di configurazione:
- ID argomento: inserisci nucleus-asset-trigger
- Lascia invariate le altre impostazioni predefinite.
Fai clic su Crea.

Crea una funzione Cloud Run per raccogliere i log

La funzione Cloud Run verrà attivata dai messaggi Pub/Sub di Cloud Scheduler per recuperare i metadati degli asset dall'API Nucleus Security e scriverli in GCS.

Nella console Google Cloud, vai a Cloud Run.
Fai clic su Crea servizio.
Seleziona Funzione (utilizza un editor di modifica in linea per creare una funzione).

Nella sezione Configura, fornisci i seguenti dettagli di configurazione:

Impostazione	Valore
Nome servizio	`nucleus-asset-collector`
Regione	Seleziona la regione corrispondente al tuo bucket GCS (ad esempio, `us-central1`)
Tempo di esecuzione	Seleziona Python 3.12 o versioni successive

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 Pub/Sub (nucleus-asset-trigger).
4. Fai clic su Salva.
Nella sezione Autenticazione:
1. Seleziona Richiedi autenticazione.
2. Controlla Identity and Access Management (IAM).
Nota: Pub/Sub gestirà automaticamente l'autenticazione quando richiama la funzione.
Scorri verso il basso ed espandi Container, networking, sicurezza.
Vai alla scheda Sicurezza:
- Service account: seleziona il account di servizio (nucleus-asset-collector-sa)

Vai alla scheda Container:

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

Nome variabile	Valore di esempio	Descrizione
`GCS_BUCKET`	`nucleus-asset-logs`	Nome bucket GCS
`GCS_PREFIX`	`nucleus-assets`	Prefisso per i file di log
`STATE_KEY`	`nucleus-assets/state.json`	Percorso del file di stato
`API_KEY`	`your-api-key`	Chiave API Nucleus Security
`PROJECT_ID`	`your-project-id`	ID progetto Nucleus Security
`MAX_RECORDS`	`5000`	Numero massimo di record per esecuzione
`PAGE_SIZE`	`1000`	Record per pagina (max 1000)

Nella sezione Variabili e secret, scorri verso il basso fino a Richieste:
- Timeout della richiesta: inserisci 600 secondi (10 minuti)
Vai alla scheda Impostazioni:
- Nella sezione Risorse:
  - Memoria: seleziona 512 MiB o un valore superiore
  - CPU: seleziona 1
Nella sezione Scalabilità della revisione:
- Numero minimo di istanze: inserisci 0
- Numero massimo di istanze: inserisci 100 (o modifica in base al carico previsto)
Fai clic su Crea.
Attendi la creazione del servizio (1-2 minuti).
Dopo aver creato il servizio, l'editor di codice incorporato si aprirà automaticamente.

Aggiungi codice per la funzione

Inserisci main nel campo Punto di ingresso.

Nell'editor di codice incorporato, crea due file:

main.py:

import functions_framework
from google.cloud import storage
import json
import os
import urllib3
from datetime import datetime, timezone, timedelta
import time

# Initialize HTTP client with timeouts
http = urllib3.PoolManager(
  timeout=urllib3.Timeout(connect=5.0, read=30.0),
  retries=False,
)

# Initialize Storage client
storage_client = storage.Client()

# Environment variables
GCS_BUCKET = os.environ.get('GCS_BUCKET')
GCS_PREFIX = os.environ.get('GCS_PREFIX', 'nucleus-assets')
STATE_KEY = os.environ.get('STATE_KEY', 'nucleus-assets/state.json')
API_KEY = os.environ.get('API_KEY')
PROJECT_ID = os.environ.get('PROJECT_ID')
MAX_RECORDS = int(os.environ.get('MAX_RECORDS', '5000'))
PAGE_SIZE = int(os.environ.get('PAGE_SIZE', '1000'))

@functions_framework.cloud_event
def main(cloud_event):
  """
  Cloud Run function triggered by Pub/Sub to fetch Nucleus Security
  asset metadata and write to GCS.

  Args:
    cloud_event: CloudEvent object containing Pub/Sub message
  """

  if not all([GCS_BUCKET, API_KEY, PROJECT_ID]):
    print('Error: Missing required environment variables')
    return

  try:
    # Get GCS bucket
    bucket = storage_client.bucket(GCS_BUCKET)

    # Load state
    state = load_state(bucket, STATE_KEY)

    now = datetime.now(timezone.utc)
    print(f"Starting asset metadata collection at {now.isoformat()}")

    # Fetch assets
    records, total = fetch_assets(
      api_key=API_KEY,
      project_id=PROJECT_ID,
      page_size=PAGE_SIZE,
      max_records=MAX_RECORDS,
    )

    if not records:
      print("No asset records found.")
      save_state(bucket, STATE_KEY, now.isoformat())
      return

    # Write to GCS as NDJSON
    timestamp = now.strftime('%Y%m%d_%H%M%S')
    object_key = f"{GCS_PREFIX}/assets_{timestamp}.ndjson"
    blob = bucket.blob(object_key)

    ndjson = '\n'.join([json.dumps(record, ensure_ascii=False) for record in records]) + '\n'
    blob.upload_from_string(ndjson, content_type='application/x-ndjson')

    print(f"Wrote {len(records)} records to gs://{GCS_BUCKET}/{object_key}")

    # Update state
    save_state(bucket, STATE_KEY, now.isoformat())

    print(f"Successfully processed {len(records)} asset records")

  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: {e}")

  return {}

def save_state(bucket, key, last_event_time_iso: str):
  """Save the last event timestamp to GCS state file."""
  try:
    state = {'last_event_time': last_event_time_iso}
    blob = bucket.blob(key)
    blob.upload_from_string(
      json.dumps(state, indent=2),
      content_type='application/json'
    )
    print(f"Saved state: last_event_time={last_event_time_iso}")
  except Exception as e:
    print(f"Warning: Could not save state: {e}")

def fetch_assets(api_key: str, project_id: str, page_size: int, max_records: int):
  """
  Fetch asset metadata from Nucleus Security API with pagination.

  Args:
    api_key: Nucleus Security API key
    project_id: Nucleus project ID
    page_size: Number of records per page (max 1000)
    max_records: Maximum total records to fetch

  Returns:
    Tuple of (records list, total count)
  """
  endpoint = f"https://app.nucleussec.com/nucleus/api/v1/projects/{project_id}/assets"

  headers = {
    'x-apikey': api_key,
    'Accept': 'application/json',
    'Content-Type': 'application/json',
    'User-Agent': 'GoogleSecOps-NucleusAssetCollector/1.0',
  }

  records = []
  page_num = 0
  backoff = 1.0
  start_index = 0

  while True:
    page_num += 1

    if len(records) >= max_records:
      print(f"Reached max_records limit ({max_records})")
      break

    current_limit = min(page_size, max_records - len(records))
    url = f"{endpoint}?start={start_index}&limit={current_limit}"

    try:
      response = http.request('GET', url, headers=headers)

      # Handle rate limiting with exponential backoff
      if response.status == 429:
        retry_after = int(response.headers.get('Retry-After', str(int(backoff))))
        print(f"Rate limited (429). Retrying after {retry_after}s...")
        time.sleep(retry_after)
        backoff = min(backoff * 2, 30.0)
        continue

      backoff = 1.0

      if response.status != 200:
        print(f"HTTP Error: {response.status}")
        response_text = response.data.decode('utf-8')
        print(f"Response body: {response_text}")
        return [], 0

      data = json.loads(response.data.decode('utf-8'))

      # Nucleus API returns a list of assets directly
      if isinstance(data, list):
        page_results = data
      else:
        page_results = data.get('assets', data.get('results', []))

      if not page_results:
        print(f"No more results (empty page)")
        break

      print(f"Page {page_num}: Retrieved {len(page_results)} assets")
      records.extend(page_results)

      # Check for more results
      if len(page_results) < current_limit:
        print(f"Reached last page (size={len(page_results)} < limit={current_limit})")
        break

      start_index += len(page_results)

    except Exception as e:
      print(f"Error fetching assets: {e}")
      return [], 0

  print(f"Retrieved {len(records)} total assets from {page_num} pages")
  return records, len(records)

requirements.txt:

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

Fai clic su Esegui il deployment per salvare la funzione ed eseguirne il deployment.
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 pubblicherà i messaggi nell'argomento Pub/Sub a intervalli regolari, attivando la funzione Cloud Run.

Nella console Google Cloud, vai a Cloud Scheduler.
Fai clic su Crea job.

Fornisci i seguenti dettagli di configurazione:

Impostazione	Valore
Nome	`nucleus-asset-collector-daily`
Regione	Seleziona la stessa regione della funzione Cloud Run
Frequenza	`0 0 * * *` (ogni giorno a mezzanotte)
Fuso orario	Seleziona il fuso orario (consigliato UTC)
Tipo di target	Pub/Sub
Argomento	Seleziona l'argomento Pub/Sub (`nucleus-asset-trigger`)
Corpo del messaggio	`{}` (oggetto JSON vuoto)

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
Ogni 6 ore	`0 /6 * *`	Basso volume, elaborazione batch
Ogni giorno	`0 0 * * *`	Istantanee dell'inventario degli asset (consigliato)

Testa l'integrazione

Nella console Cloud Scheduler, trova il tuo job.
Fai clic su Forza esecuzione per attivare il job manualmente.
Attendi alcuni secondi.
Vai a Cloud Run > Servizi.
Fai clic sul nome della funzione (nucleus-asset-collector).
Fai clic sulla scheda Log.

Verifica che la funzione sia stata eseguita correttamente. Cerca:

Starting asset metadata collection at YYYY-MM-DDTHH:MM:SS+00:00
Page 1: Retrieved X assets
Wrote X records to gs://nucleus-asset-logs/nucleus-assets/assets_YYYYMMDD_HHMMSS.ndjson
Successfully processed X asset records

Vai a Cloud Storage > Bucket.
Fai clic sul nome del bucket (nucleus-asset-logs).
Vai alla cartella del prefisso (nucleus-assets/).
Verifica che sia stato creato un nuovo file .ndjson con il timestamp corrente.

Se visualizzi errori nei log:

HTTP 401: controlla la chiave API nelle variabili di ambiente
HTTP 403: verifica che la chiave API abbia accesso in lettura al progetto
HTTP 429: limitazione di frequenza. La funzione riproverà automaticamente con backoff
Variabili di ambiente mancanti: verifica che tutte le variabili richieste siano impostate.

Recupera il account di servizio Google SecOps

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

Recupera l'indirizzo email del account di servizio

Vai a Impostazioni > Gestione dei dati > Feed. Se utilizzi una piattaforma solo SIEM, vai a Impostazioni > Feed.
Fai clic su Aggiungi nuovo feed.
Fai clic su Configura un singolo feed.
Nel campo Nome feed, inserisci un nome per il feed (ad es. Nucleus Asset Metadata Logs).
Seleziona Google Cloud Storage V2 come Tipo di origine.
Seleziona Metadati dell'asset Nucleus come Tipo di log.
Fai clic su Ottieni service account.
Verrà visualizzato un indirizzo email univoco del account di servizio, ad esempio:
```
chronicle-12345678@chronicle-gcp-prod.iam.gserviceaccount.com
```
Copia questo indirizzo email per utilizzarlo nel passaggio successivo.

Nota: ogni istanza Google SecOps ha un account di servizio univoco. Non utilizzare i service account di altra documentazione o di altri esempi.
Fai clic su Avanti.
Specifica i valori per i seguenti parametri di input:
- URL bucket di archiviazione: inserisci l'URI del bucket GCS con il percorso del prefisso:
```
gs://nucleus-asset-logs/nucleus-assets/
```
  - Sostituisci:
    - nucleus-asset-logs: il nome del tuo bucket GCS.
    - nucleus-assets: prefisso/percorso della cartella facoltativo in cui sono archiviati i log (lascia vuoto per la directory principale).
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 i file trasferiti: elimina i file dopo il trasferimento riuscito.
  - Elimina i file trasferiti e le directory vuote: elimina i file e le directory vuote dopo il trasferimento riuscito.
    
    Nota: se selezioni un'opzione di eliminazione, il account di servizio deve avere il ruolo Storage Object Admin anziché Storage Object Viewer. Aggiorna le autorizzazioni IAM di conseguenza.
- Età massima dei file: includi i file modificati negli ultimi giorni (il valore predefinito è 180 giorni)
- Spazio dei nomi dell'asset: lo spazio dei nomi dell'asset
- Etichette di importazione: l'etichetta da applicare agli eventi di questo feed.
Fai clic su Avanti.
Controlla la nuova configurazione del feed di notizie nella schermata Finalizza e poi fai clic su Invia.

Concedi le autorizzazioni IAM al account di servizio Google SecOps

Il account di servizio Google SecOps deve avere il ruolo Storage Object Viewer nel bucket GCS.

Vai a Cloud Storage > Bucket.
Fai clic sul nome del bucket (ad esempio nucleus-asset-logs).
Vai alla scheda Autorizzazioni.
Fai clic su Concedi l'accesso.
Fornisci i seguenti dettagli di configurazione:
- Aggiungi entità: incolla l'indirizzo email del account di servizio Google SecOps
- Assegna i ruoli: seleziona Storage Object Viewer
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", concedi il ruolo Storage Object Admin anziché Storage Object Viewer.

Tabella di mappatura UDM

Campo log	Mappatura UDM	Logica
host_score_total, host_complianced_score, host_data_sensitivity_score, host_public, asset_tags	entity.asset.attribute.labels	Etichette unite da host_score_total come "Host Score Total", host_complianced_score come "Host Complianced Score", host_data_sensitivity_score come "Host Data Sensitivity Score", host_public come "Host Public" e asset_tags analizzati come coppie chiave-valore
asset_name	entity.asset.hostname	Estratto da asset_name utilizzando il pattern grok se contiene "http"
ip_address	entity.asset.ip	Unito da ip_address
asset_id	entity.asset.product_object_id	Valore copiato direttamente se non vuoto
asset_name	entity.url	Estratto da asset_name utilizzando il pattern grok se contiene "http" e url_path non è vuoto
	metadata.entity_type	Impostato su "ASSET"
	metadata.product_name	Impostato su "Nucleus Unified Vulnerability Management"
	metadata.vendor_name	Imposta su "NUCLEUS"

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