Raccogliere i log di controllo di OpenAI
Questo documento spiega come importare i log di controllo di OpenAI in Google Security Operations utilizzando Google Cloud Storage V2.
OpenAI fornisce l'API Audit Logs per le organizzazioni che utilizzano la piattaforma API OpenAI. L'API monitora le azioni degli utenti e le modifiche alla configurazione all'interno di un'organizzazione, inclusi gli eventi del ciclo di vita delle chiavi API, la gestione degli utenti, le modifiche ai progetti, gli inviti, l'attività dell'account di servizio, gli eventi di accesso e disconnessione e le modifiche alla configurazione dell'organizzazione.
Prima di iniziare
Assicurati di soddisfare i seguenti prerequisiti:
- Un'istanza Google SecOps
- Un progetto GCP con le API Cloud Storage, Cloud Run, Pub/Sub e Cloud Scheduler abilitate
- Autorizzazioni per creare e gestire bucket GCS
- Autorizzazioni per gestire le policy IAM nei bucket GCS
- Autorizzazioni per creare servizi Cloud Run, argomenti Pub/Sub e job Cloud Scheduler
- Ruolo Proprietario dell'organizzazione nell'organizzazione della piattaforma API OpenAI
Abilitare l'audit logging di OpenAI
Prima di poter accedere ai log di controllo, devi abilitare il logging di controllo nella tua organizzazione.
- Accedi alla piattaforma OpenAI all'indirizzo https://platform.openai.com.
- Vai a Impostazioni > Organizzazione > Controlli relativi ai dati.
- Scorri verso il basso fino alla sezione Registrazione audit.
- Fai clic su Attiva in Logging degli audit.
Fai clic su Salva.
Crea chiave API OpenAI Admin
- Accedi alla piattaforma OpenAI all'indirizzo https://platform.openai.com.
- Nel riquadro a sinistra, fai clic su Chiavi amministrative.
- In alternativa, vai direttamente alla pagina https://platform.openai.com/settings/organization/admin-keys.
- Fai clic su Crea nuova chiave amministratore.
- Nel campo Nome, inserisci un nome descrittivo (ad esempio,
Google SecOps Integration). - Fai clic su Crea.
Copia immediatamente la chiave API e archiviala in modo sicuro.
Testare l'accesso API
Testa le tue credenziali prima di procedere con l'integrazione:
# Replace with your actual Admin API key OPENAI_ADMIN_KEY="your-admin-api-key" # Test audit logs API access curl -s -H "Authorization: Bearer ${OPENAI_ADMIN_KEY}" \ -H "Content-Type: application/json" \ "https://api.openai.com/v1/organization/audit_logs?limit=5" \ | python3 -m json.tool
Una risposta corretta restituisce un oggetto JSON con un campo object impostato su list e un array data contenente le voci del log di controllo.
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 univoco globale (ad esempio openai-auditlog-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 degli accessi 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
- 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 del service account: inserisci
openai-auditlog-collector-sa - Descrizione service account: inserisci
Service account for Cloud Run function to collect OpenAI audit logs
- Nome del 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.
Concedi autorizzazioni IAM sul bucket GCS
- Vai a Cloud Storage > Bucket.
- Fai clic sul nome del bucket (
openai-auditlog-logs). - Vai alla scheda Autorizzazioni.
- Fai clic su Concedi l'accesso.
- Fornisci i seguenti dettagli di configurazione:
- Aggiungi entità: inserisci l'email del account di servizio (
openai-auditlog-collector-sa@PROJECT_ID.iam.gserviceaccount.com). - Assegna i ruoli: seleziona Storage Object Admin.
- Aggiungi entità: inserisci l'email del account di servizio (
- Fai clic su Salva.
Crea argomento Pub/Sub
- Nella console Google Cloud, vai a Pub/Sub > Argomenti.
- Fai clic su Crea argomento.
- Fornisci i seguenti dettagli di configurazione:
- ID argomento: inserisci
openai-auditlog-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 log dall'API OpenAI Audit Logs 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 openai-auditlog-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
openai-auditlog-trigger. - Fai clic su Salva.
Nella sezione Autenticazione:
- Seleziona Richiedi autenticazione.
- Controlla Identity and Access Management (IAM).
Scorri verso il basso ed espandi Container, networking, sicurezza.
Vai alla scheda Sicurezza:
- Service account: seleziona
openai-auditlog-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_BUCKETopenai-auditlog-logsNome bucket GCS GCS_PREFIXopenai-auditlogPrefisso per i file di log STATE_KEYopenai-auditlog/state.jsonPercorso file di stato OPENAI_ADMIN_KEYyour-admin-api-keyChiave API OpenAI Admin MAX_RECORDS5000Numero massimo di record per esecuzione PAGE_SIZE100Record per pagina API (max 100) 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
- 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 nel campo Entry point (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 http = urllib3.PoolManager( timeout=urllib3.Timeout(connect=5.0, read=30.0), retries=False, ) storage_client = storage.Client() GCS_BUCKET = os.environ.get('GCS_BUCKET') GCS_PREFIX = os.environ.get('GCS_PREFIX', 'openai-auditlog') STATE_KEY = os.environ.get('STATE_KEY', 'openai-auditlog/state.json') OPENAI_ADMIN_KEY = os.environ.get('OPENAI_ADMIN_KEY') MAX_RECORDS = int(os.environ.get('MAX_RECORDS', '5000')) PAGE_SIZE = int(os.environ.get('PAGE_SIZE', '100')) LOOKBACK_HOURS = int(os.environ.get('LOOKBACK_HOURS', '24')) API_BASE = 'https://api.openai.com' AUDIT_LOGS_ENDPOINT = '/v1/organization/audit_logs' @functions_framework.cloud_event def main(cloud_event): """ Cloud Run function triggered by Pub/Sub to fetch OpenAI audit logs and write them to GCS. Args: cloud_event: CloudEvent object containing Pub/Sub message """ if not all([GCS_BUCKET, OPENAI_ADMIN_KEY]): print('Error: Missing required environment variables') return try: bucket = storage_client.bucket(GCS_BUCKET) state = load_state(bucket) now = datetime.now(timezone.utc) if isinstance(state, dict) and state.get('last_effective_at'): try: last_effective_at = int(state['last_effective_at']) last_time = datetime.fromtimestamp(last_effective_at, tz=timezone.utc) last_time = last_time - timedelta(minutes=2) except Exception as e: print(f"Warning: Could not parse last_effective_at: {e}") last_time = now - timedelta(hours=LOOKBACK_HOURS) else: last_time = now - timedelta(hours=LOOKBACK_HOURS) start_unix = int(last_time.timestamp()) end_unix = int(now.timestamp()) print(f"Fetching audit logs from {last_time.isoformat()} to {now.isoformat()}") records, newest_effective_at = fetch_audit_logs( start_unix=start_unix, end_unix=end_unix, page_size=PAGE_SIZE, max_records=MAX_RECORDS, ) if not records: print("No new audit log records found.") save_state(bucket, end_unix) return timestamp = now.strftime('%Y%m%d_%H%M%S') object_key = f"{GCS_PREFIX}/openai_auditlog_{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}") if newest_effective_at: save_state(bucket, newest_effective_at) else: save_state(bucket, end_unix) print(f"Successfully processed {len(records)} records") except Exception as e: print(f'Error processing audit logs: {str(e)}') raise def load_state(bucket): """Load state from GCS.""" try: blob = bucket.blob(STATE_KEY) if blob.exists(): return json.loads(blob.download_as_text()) except Exception as e: print(f"Warning: Could not load state: {e}") return {} def save_state(bucket, last_effective_at): """Save the last effective_at Unix timestamp to GCS state file.""" try: state = { 'last_effective_at': last_effective_at, 'last_run': datetime.now(timezone.utc).isoformat() } blob = bucket.blob(STATE_KEY) blob.upload_from_string( json.dumps(state, indent=2), content_type='application/json' ) print(f"Saved state: last_effective_at={last_effective_at}") except Exception as e: print(f"Warning: Could not save state: {e}") def fetch_audit_logs(start_unix, end_unix, page_size, max_records): """ Fetch audit logs from the OpenAI API with pagination and rate limiting. Args: start_unix: Start time as Unix seconds end_unix: End time as Unix seconds page_size: Number of records per page (max 100) max_records: Maximum total records to fetch Returns: Tuple of (records list, newest effective_at Unix timestamp) """ headers = { 'Authorization': f'Bearer {OPENAI_ADMIN_KEY}', 'Content-Type': 'application/json', } records = [] newest_effective_at = None page_num = 0 backoff = 1.0 cursor = None while True: page_num += 1 if len(records) >= max_records: print(f"Reached max_records limit ({max_records})") break params = [] params.append(f"effective_at[gte]={start_unix}") params.append(f"effective_at[lte]={end_unix}") params.append(f"limit={min(page_size, max_records - len(records))}") if cursor: params.append(f"after={cursor}") url = f"{API_BASE}{AUDIT_LOGS_ENDPOINT}?{'&'.join(params)}" try: response = http.request('GET', url, headers=headers) 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('data', []) if not page_results: print(f"No more results (empty page)") break print(f"Page {page_num}: Retrieved {len(page_results)} events") records.extend(page_results) for event in page_results: try: effective_at = event.get('effective_at') if effective_at is not None: if newest_effective_at is None or effective_at > newest_effective_at: newest_effective_at = effective_at except Exception as e: print(f"Warning: Could not parse event time: {e}") has_more = data.get('has_more', False) if not has_more: print("No more pages (has_more=false)") break last_id = data.get('last_id') if not last_id: print("No more pages (no last_id)") break cursor = last_id except Exception as e: print(f"Error fetching audit logs: {e}") return [], None print(f"Retrieved {len(records)} total records from {page_num} pages") return records, newest_effective_atrequirements.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).
Crea job Cloud Scheduler
- Nella console Google Cloud, vai a Cloud Scheduler.
- Fai clic su Crea job.
Fornisci i seguenti dettagli di configurazione:
Impostazione Valore Nome openai-auditlog-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 openai-auditlog-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 |
Testare l'integrazione
- Nella console Cloud Scheduler, trova il tuo job (
openai-auditlog-collector-hourly). - Fai clic su Forza esecuzione per attivare il job manualmente.
- Attendi alcuni secondi.
- Vai a Cloud Run > Servizi.
- Fai clic su
openai-auditlog-collector. - Fai clic sulla scheda Log.
Verifica che la funzione sia stata eseguita correttamente. Cerca:
Fetching audit logs from YYYY-MM-DDTHH:MM:SS+00:00 to YYYY-MM-DDTHH:MM:SS+00:00 Page 1: Retrieved X events Wrote X records to gs://openai-auditlog-logs/openai-auditlog/openai_auditlog_YYYYMMDD_HHMMSS.ndjson Successfully processed X recordsVai a Cloud Storage > Bucket.
Fai clic su
openai-auditlog-logs.Vai alla cartella
openai-auditlog/.Verifica che sia stato creato un nuovo file
.ndjsoncon il timestamp corrente.
Se nei log vengono visualizzati errori:
- HTTP 401: verifica che la variabile di ambiente
OPENAI_ADMIN_KEYsia corretta e che la chiave non sia stata revocata - HTTP 403: verifica che la chiave API sia una chiave API Admin creata da un proprietario dell'organizzazione
- HTTP 429: limitazione della frequenza: la funzione verrà ritentata automaticamente con backoff esponenziale
- Variabili di ambiente mancanti: verifica che tutte le variabili richieste siano impostate nella configurazione di Cloud Run Functions
Recuperare il account di servizio Google SecOps
- Vai a Impostazioni SIEM > 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 esempio,
OpenAI Audit Logs). - Seleziona Google Cloud Storage V2 come Tipo di origine.
Seleziona OpenAI Audit Logs (Log di controllo OpenAI) come Tipo di log. Fai clic su Ottieni service account. Viene visualizzata un'email del account di servizio univoca. Ad esempio:
chronicle-12345678@chronicle-gcp-prod.iam.gserviceaccount.comCopia questo indirizzo email per utilizzarlo nel passaggio successivo.
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://openai-auditlog-logs/openai-auditlog/
- 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.
- 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
- Etichette di importazione: l'etichetta da applicare agli eventi di questo feed
Fai clic su Avanti.
Controlla la nuova configurazione del feed nella schermata Finalizza e poi fai clic su Invia.
Concedi le autorizzazioni IAM al account di servizio Google SecOps
- Vai a Cloud Storage > Bucket.
- Fai clic su
openai-auditlog-logs. - Vai alla scheda Autorizzazioni.
- Fai clic su Concedi l'accesso.
- Fornisci i seguenti dettagli di configurazione:
- Aggiungi entità: incolla l'email del account di servizio Google SecOps
- Assegna i ruoli: seleziona Visualizzatore oggetti Storage.
Fai clic su Salva.
Tabella di mappatura UDM
| Campo log | Mappatura UDM | Logica |
|---|---|---|
| actor.session.ip_address_details.region_code | additional.fields | Unite come coppie chiave-valore |
| actor.session.ip_address_details.asn | additional.fields | |
| effective_at | metadata.event_timestamp | Convertito dal timestamp UNIX |
| has_principal | metadata.event_type | Impostato su "STATUS_UPDATE" se has_principal è true; "NETWORK_CONNECTION" se has_principal e has_target sono true; "FILE_COPY" se has_principal, has_file e has_source_file sono true; "FILE_UNCATEGORIZED" se has_principal e has_file sono true; "USER_UNCATEGORIZED" se has_user è true; altrimenti "GENERIC_EVENT" |
| has_user | metadata.event_type | |
| has_target | metadata.event_type | |
| has_file | metadata.event_type | |
| has_source_file | metadata.event_type | |
| actor.session.user_agent | network.http.parsed_user_agent | Valore copiato direttamente e convertito in user agent analizzato |
| actor.session.ja3 | network.tls.client.ja3 | Valore copiato direttamente |
| actor.session.ip_address | principal.asset.ip | Valore copiato direttamente |
| actor.session.ip_address | principal.ip | Valore copiato direttamente |
| actor.session.ip_address_details.city | principal.location.city | Valore copiato direttamente |
| actor.session.ip_address_details.country | principal.location.country_or_region | Valore copiato direttamente |
| actor.session.ip_address_details.latitude | principal.location.region_latitude | Convertito in numero decimale |
| actor.session.ip_address_details.longitude | principal.location.region_longitude | Convertito in numero decimale |
| actor.session.ip_address_details.region | principal.location.state | Valore copiato direttamente |
| actor.session.user.email | principal.user.email_addresses | Valore copiato direttamente |
| actor.session.user.id | principal.user.userid | Estratto utilizzando il pattern Grok |
| actor.session.ja4 | security_result.detection_fields | Unita come coppia chiave-valore con la chiave "ja4" |
| tipo | security_result.summary | Valore copiato direttamente |
| metadata.product_name | metadata.product_name | Imposta su "OPENAI_AUDITLOG" |
| metadata.vendor_name | metadata.vendor_name | Imposta su "OPENAI_AUDITLOG" |
Hai bisogno di ulteriore assistenza? Ricevi risposte dai membri della community e dai professionisti di Google SecOps.