Raccogliere i log di Entrust verifica dell'identità (in precedenza Onfido)
Questo documento spiega come importare i log di Entrust Identity Verification (precedentemente noto come Onfido) in Google Security Operations utilizzando Google Cloud Storage V2. Il parser trasforma i log dei report e dei controlli di verifica Onfido non elaborati nello schema UDM di Google SecOps.
Entrust Identity Verification è una piattaforma di verifica dell'identità basata su cloud che automatizza la verifica dei documenti, l'analisi biometrica e il rilevamento delle frodi. Fornisce un'API REST per la gestione dei candidati, dei controlli di verifica e dei report, consentendo alle organizzazioni di integrare i workflow di verifica dell'identità nelle loro applicazioni.
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 bucket GCS
- Autorizzazioni per gestire le policy IAM sui bucket GCS
- Autorizzazioni per creare servizi Cloud Run, argomenti Pub/Sub e job Cloud Scheduler
- Un account Entrust Identity Verification (precedentemente Onfido) con accesso API
- Un token API Onfido con autorizzazioni sufficienti per leggere controlli e report
Raccogliere le credenziali API di Onfido
Ottieni token API
- Accedi alla dashboard di Onfido.
- Vai a Sviluppatori > Token API.
- Copia un token API live esistente o fai clic su Genera token API per crearne uno nuovo.
- Inserisci un nome per il token (ad esempio
Google Security Operations Integration). - Seleziona Live come tipo di token.
Copia e salva il token API in modo sicuro.
Verifica le autorizzazioni
Per verificare che il token API disponga delle autorizzazioni necessarie:
- Accedi alla dashboard di Onfido.
- Vai a Sviluppatori > Token API.
- Verifica che il token sia elencato con lo stato Pubblicato e non sia stato revocato.
- Verifica che il token abbia accesso in lettura a controlli e report testando l'accesso API.
Testa l'accesso API
Testa le tue credenziali prima di procedere con l'integrazione:
# Replace with your actual API token ONFIDO_API_TOKEN="your-api-token" # Test API access - list checks curl -v -H "Authorization: Token token=${ONFIDO_API_TOKEN}" \ "[https://api.onfido.com/v3.6/checks](https://api.onfido.com/v3.6/checks)"
Una risposta riuscita restituisce HTTP 200 con un oggetto JSON contenente un array checks.
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 onfido-verification-logs)Tipo di località Scegli in base alle tue esigenze (regione singola, a due regioni, multiregionale) 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) Abilita il controllo delle versioni degli oggetti o la policy di conservazione Fai clic su Crea.
Crea un account di servizio per la funzione Cloud Run
La funzione Cloud Run richiede un account di servizio con autorizzazioni di scrittura nel bucket GCS e di invocazione da parte di Pub/Sub.
Crea service account
- Nella console Google Cloud, vai a IAM e amministrazione > Service account.
- Fai clic su Crea account di servizio.
- Fornisci i seguenti dettagli di configurazione:
- Nome service account: inserisci
onfido-logs-collector-sa. - Descrizione service account: inserisci
Service account for Cloud Run function to collect Onfido verification logs.
- Nome service account: inserisci
- Fai clic su Crea e continua.
- Nella sezione Concedi a questo account di servizio l'accesso al progetto, aggiungi i seguenti ruoli:
- Fai clic su Seleziona un ruolo.
- Cerca e seleziona Storage Object Admin.
- Fai clic su + Aggiungi un altro ruolo.
- Cerca e seleziona Cloud Run Invoker.
- Fai clic su + Aggiungi un altro ruolo.
- Cerca e seleziona Cloud Functions Invoker.
- Fai clic su Continua.
- Fai clic su Fine.
Questi ruoli sono necessari 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.
- 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,
onfido-logs-collector-sa@PROJECT_ID.iam.gserviceaccount.com). - Assegna i ruoli: seleziona Storage Object Admin.
- Aggiungi entità: inserisci l'indirizzo email del account di servizio (ad esempio,
- 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à.
- Nella console Google Cloud, vai a Pub/Sub > Argomenti.
- Fai clic su Crea argomento.
- Fornisci i seguenti dettagli di configurazione:
- ID argomento: inserisci
onfido-logs-trigger. - Lascia invariate le altre impostazioni predefinite.
- ID argomento: inserisci
- 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 controlli di verifica e i report dall'API Onfido e scriverli in GCS.
- Nella console Google Cloud, vai a Cloud Run.
- Fai clic su Crea servizio.
- Seleziona Funzione (utilizza un editor in linea per creare una funzione).
Nella sezione Configura, fornisci i seguenti dettagli di configurazione:
Impostazione Valore Nome servizio onfido-logs-collectorRegione 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):
- Fai clic su + Aggiungi trigger.
- Seleziona Cloud Pub/Sub.
- In Seleziona un argomento Cloud Pub/Sub, scegli
onfido-logs-trigger. - Fai clic su Salva.
Nella sezione Autenticazione:
- Seleziona Richiedi autenticazione.
- Seleziona Identity and Access Management (IAM).
Scorri verso il basso ed espandi Container, networking, sicurezza.
Vai alla scheda Sicurezza:
- Service account: seleziona
onfido-logs-collector-sa.
- Service account: seleziona
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_BUCKETonfido-verification-logsNome bucket GCS GCS_PREFIXonfido-logsPrefisso per i file di log STATE_KEYonfido-logs/state.jsonPercorso del file di stato ONFIDO_API_TOKENyour-api-token-hereToken API Onfido MAX_RECORDS1000Numero massimo di record per esecuzione PAGE_SIZE100Record per pagina LOOKBACK_HOURS24Periodo di riferimento iniziale Nella sezione Variabili e secret, scorri verso il basso fino a Richieste:
- Timeout richiesta: inserisci
600secondi (10 minuti).
- Timeout richiesta: inserisci
Vai alla scheda Impostazioni:
- Nella sezione Risorse:
- Memoria: seleziona 512 MiB o un valore superiore.
- CPU: seleziona 1.
- Nella sezione Risorse:
Nella sezione Scalabilità della revisione:
- Numero minimo di istanze: inserisci
0. - Numero massimo di istanze: inserisci
100(o modifica in base al carico previsto).
- Numero minimo di istanze: inserisci
Fai clic su Crea.
Attendi la creazione del servizio (1-2 minuti).
Dopo aver creato il servizio, si aprirà automaticamente l'editor di codice incorporato.
Aggiungi codice per la funzione
- Inserisci main in Entry point della funzione.
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 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', 'onfido-logs') STATE_KEY = os.environ.get('STATE_KEY', 'onfido-logs/state.json') ONFIDO_API_TOKEN = os.environ.get('ONFIDO_API_TOKEN') MAX_RECORDS = int(os.environ.get('MAX_RECORDS', '1000')) PAGE_SIZE = int(os.environ.get('PAGE_SIZE', '100')) LOOKBACK_HOURS = int(os.environ.get('LOOKBACK_HOURS', '24')) API_BASE = '[https://api.onfido.com/v3.6](https://api.onfido.com/v3.6)' def parse_datetime(value: str) -> datetime: """Parse ISO datetime string to datetime object.""" if value.endswith("Z"): value = value[:-1] + "+00:00" return datetime.fromisoformat(value) @functions_framework.cloud_event def main(cloud_event): """ Cloud Run function triggered by Pub/Sub to fetch Onfido verification checks and reports and write to GCS. Args: cloud_event: CloudEvent object containing Pub/Sub message """ if not all([GCS_BUCKET, ONFIDO_API_TOKEN]): 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) # Determine time window now = datetime.now(timezone.utc) last_time = None if isinstance(state, dict) and state.get("last_event_time"): try: last_time = parse_datetime(state["last_event_time"]) # Overlap by 2 minutes to catch any delayed events last_time = last_time - timedelta(minutes=2) except Exception as e: print(f"Warning: Could not parse last_event_time: {e}") if last_time is None: last_time = now - timedelta(hours=LOOKBACK_HOURS) print(f"Fetching logs from {last_time.isoformat()} to {now.isoformat()}") # Fetch checks checks, newest_check_time = fetch_checks( api_token=ONFIDO_API_TOKEN, start_time=last_time, end_time=now, page_size=PAGE_SIZE, max_records=MAX_RECORDS, ) # Fetch reports for each check all_records = [] for check in checks: check_record = check.copy() check_id = check.get('id') if check_id: reports = fetch_reports(api_token=ONFIDO_API_TOKEN, check_id=check_id) check_record['reports'] = reports all_records.append(check_record) if not all_records: print("No new log 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}/logs_{timestamp}.ndjson" blob = bucket.blob(object_key) ndjson = '\n'.join([json.dumps(record, ensure_ascii=False) for record in all_records]) + '\n' blob.upload_from_string(ndjson, content_type='application/x-ndjson') print(f"Wrote {len(all_records)} records to gs://{GCS_BUCKET}/{object_key}") # Update state with newest event time if newest_check_time: save_state(bucket, STATE_KEY, newest_check_time) else: save_state(bucket, STATE_KEY, now.isoformat()) print(f"Successfully processed {len(all_records)} 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_checks(api_token: str, start_time: datetime, end_time: datetime, page_size: int, max_records: int): """ Fetch verification checks from the Onfido API with pagination and rate limiting. Args: api_token: Onfido API token start_time: Start time for check query end_time: End time for check query page_size: Number of records per page max_records: Maximum total records to fetch Returns: Tuple of (checks list, newest_event_time ISO string) """ headers = { 'Authorization': f'Token token={api_token}', 'Accept': 'application/json', 'User-Agent': 'GoogleSecOps-OnfidoCollector/1.0' } records = [] newest_time = None page_num = 0 backoff = 1.0 current_page = 1 while True: page_num += 1 if len(records) >= max_records: print(f"Reached max_records limit ({max_records})") break url = f"{API_BASE}/checks?page={current_page}&per_page={page_size}" 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 [], None data = json.loads(response.data.decode('utf-8')) page_results = data.get('checks', []) if not page_results: print(f"No more results (empty page)") break # Filter checks within the time window filtered = [] for check in page_results: created_at = check.get('created_at') if created_at: try: check_time = parse_datetime(created_at) if start_time <= check_time <= end_time: filtered.append(check) if newest_time is None or check_time > parse_datetime(newest_time): newest_time = created_at except Exception as e: print(f"Warning: Could not parse check time: {e}") filtered.append(check) print(f"Page {page_num}: Retrieved {len(page_results)} checks, {len(filtered)} in time window") records.extend(filtered) # Check for more results if len(page_results) < page_size: print(f"Reached last page (size={len(page_results)} < limit={page_size})") break current_page += 1 except Exception as e: print(f"Error fetching checks: {e}") return [], None print(f"Retrieved {len(records)} total checks from {page_num} pages") return records[:max_records], newest_time def fetch_reports(api_token: str, check_id: str): """ Fetch reports for a specific check from the Onfido API. Args: api_token: Onfido API token check_id: Check ID to fetch reports for Returns: List of report objects """ headers = { 'Authorization': f'Token token={api_token}', 'Accept': 'application/json', 'User-Agent': 'GoogleSecOps-OnfidoCollector/1.0' } url = f"{API_BASE}/reports?check_id={check_id}" try: response = http.request('GET', url, headers=headers) if response.status == 429: time.sleep(2) response = http.request('GET', url, headers=headers) if response.status != 200: print(f"Error fetching reports for check {check_id}: HTTP {response.status}") return [] data = json.loads(response.data.decode('utf-8')) reports = data.get('reports', []) return reports except Exception as e: print(f"Error fetching reports for check {check_id}: {e}") return []- Secondo file: requirements.txt::
functions-framework==3.* google-cloud-storage==2.* urllib3>=2.0.0Fai clic su Esegui il deployment per salvare la funzione ed eseguirne il deployment.
Attendi il completamento del deployment (2-3 minuti).
Crea job Cloud Scheduler
Cloud Scheduler pubblicherà 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 onfido-logs-collector-hourlyRegione Seleziona la stessa regione della funzione Cloud Run Frequenza 0 * * * *(ogni ora, allo scoccare dell'ora)Fuso orario Seleziona il fuso orario (UTC consigliato) Tipo di target Pub/Sub Argomento Seleziona onfido-logs-triggerCorpo 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 (consigliato) |
| Ogni 6 ore | 0 */6 * * * |
Volume basso, elaborazione batch |
| Ogni giorno | 0 0 * * * |
Raccolta dei dati storici |
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 su
onfido-logs-collector. - Fai clic sulla scheda Log.
Verifica che la funzione sia stata eseguita correttamente. Cerca:
Fetching logs from YYYY-MM-DDTHH:MM:SS+00:00 to YYYY-MM-DDTHH:MM:SS+00:00 Page 1: Retrieved X checks, X in time window Wrote X records to gs://bucket-name/onfido-logs/logs_YYYYMMDD_HHMMSS.ndjson Successfully processed X recordsVai a Cloud Storage > Bucket.
Fai clic sul nome del bucket.
Vai alla cartella
onfido-logs/.Verifica che sia stato creato un nuovo file
.ndjsoncon il timestamp corrente.
Se nei log vengono visualizzati errori:
- HTTP 401: controlla il token API Onfido nelle variabili di ambiente
- HTTP 403: verifica che il token API abbia accesso in tempo reale e non sia stato revocato
- HTTP 429: limitazione di frequenza. La funzione riproverà automaticamente con backoff
- Variabili di ambiente mancanti: controlla che tutte le variabili richieste siano impostate
Configura un feed in Google SecOps per importare i log di Onfido
- Vai a Impostazioni SIEM > Feed.
- Fai clic su Aggiungi nuovo feed di notizie.
- Fai clic su Configura un singolo feed.
- Nel campo Nome feed, inserisci un nome per il feed (ad esempio
Onfido Verification Logs). - Seleziona Google Cloud Storage V2 come Tipo di origine.
- Seleziona Onfido come Tipo di log.
Fai clic su Get Service Account (Ottieni service account). Verrà visualizzato un indirizzo email del account di servizio univoco, ad esempio:
chronicle-12345678@chronicle-gcp-prod.iam.gserviceaccount.comCopia l'indirizzo email. Lo utilizzerai nel prossimo passaggio.
Fai clic su Avanti.
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://onfido-verification-logs/onfido-logs/- Sostituisci:
onfido-verification-logs: il nome del tuo bucket GCS.onfido-logs: prefisso/percorso della cartella facoltativo in cui sono archiviati i log (lascia vuoto per la directory principale).
- Sostituisci:
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 i file trasferiti e le directory vuote: elimina i file e le directory vuote dopo il trasferimento riuscito.
Età massima 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.
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.
- 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 ruoli: seleziona Visualizzatore oggetti Storage.
Fai clic su Salva.
Tabella di mappatura UDM
| Campo log | Mappatura UDM | Logica |
|---|---|---|
| read_only_udm.metadata.vendor_name | Imposta "ONFIDO". | |
| read_only_udm.metadata.product_name | Imposta "ONFIDO". | |
| read_only_udm.metadata.log_type | Impostalo su "ONFIDO". |
Log delle modifiche
Visualizza il log delle modifiche per questo parser
Hai bisogno di ulteriore assistenza? Ricevi risposte dai membri della community e dai professionisti di Google SecOps.