Raccogli i log degli avvisi di Armis
Versione parser: 3.0
Questo documento spiega come importare i log degli avvisi Armis in Google Security Operations utilizzando Google Cloud Storage V2.
Armis Centrix è una piattaforma di asset intelligence di livello enterprise progettata per fornire visibilità e protezione per i dispositivi gestiti, non gestiti e IoT/OT. Il stream di dati degli avvisi di Armis acquisisce gli avvisi di sicurezza generati quando vengono rilevate potenziali minacce, violazioni delle policy o anomalie nei dispositivi monitorati. Questi log degli avvisi possono essere esportati tramite l'API REST di Armis e scritti in un bucket GCS per l'importazione da parte di Google SecOps.
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 creare servizi Cloud Run, argomenti Pub/Sub e job Cloud Scheduler
- Un'istanza Armis Centrix con accesso API
- Una chiave API secret di Armis con le autorizzazioni per leggere i dati degli avvisi
Genera una chiave segreta API Armis
- Accedi alla console Armis Centrix all'indirizzo
https://<your-instance>.armis.com. - Vai a Impostazioni > Gestione degli asset e sicurezza > Gestione delle API.
- Fai clic su Crea per generare una nuova chiave secret API.
- Viene visualizzata una finestra di dialogo con la chiave segreta.
- Copia e salva la chiave segreta in modo sicuro.
Verifica l'accesso all'API
Testa le tue credenziali prima di procedere con l'integrazione:
ARMIS_INSTANCE="https://your-instance.armis.com" ARMIS_SECRET_KEY="your-secret-key" # Get access token ACCESS_TOKEN=$(curl -s -X POST "${ARMIS_INSTANCE}/api/v1/access_token/" \ -d "secret_key=${ARMIS_SECRET_KEY}" \ | python3 -c "import sys,json; print(json.load(sys.stdin)['data']['access_token'])") echo "Access Token: ${ACCESS_TOKEN}" # Test alert search curl -s "${ARMIS_INSTANCE}/api/v1/search/" \ -H "Authorization: ${ACCESS_TOKEN}" \ -G \ --data-urlencode "aql=in:alerts timeFrame:\"1 Hours\"" \ --data-urlencode "length=1" \ --data-urlencode "fields=alertId,type,title,description,severity,status,time,activityUUIDs,deviceIds,connectionIds" \ | python3 -m json.tool
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 armis-alert-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.
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 il account di servizio
- 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
armis-alerts-collector-sa - Descrizione account di servizio: inserisci
Service account for Cloud Run function to collect Armis alert 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.
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 su un 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
armis-alerts-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 un 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
armis-alerts-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 degli avvisi dall'API REST Armis 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 armis-alerts-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 l'argomento
armis-alerts-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 il account di servizio
armis-alerts-collector-sa
- Service account: seleziona il account di servizio
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_BUCKETarmis-alert-logsNome bucket GCS GCS_PREFIXarmis-alertsPrefisso per i file di log STATE_KEYarmis-alerts/state.jsonPercorso del file di stato ARMIS_INSTANCE_URLhttps://your-instance.armis.comURL dell'istanza Armis ARMIS_SECRET_KEYyour-secret-keyChiave secret dell'API Armis PAGE_SIZE1000Record per pagina API MAX_RECORDS50000Numero massimo di record per esecuzione LOOKBACK_HOURS2Periodo di riferimento iniziale Scorri verso il basso nella sezione Variabili e secret fino a Richieste:
- Timeout richieste: inserisci
540secondi (9 minuti)
- Timeout richieste: 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, 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:
Primo file - main.py:
import functions_framework from google.cloud import storage import json import os import urllib3 import urllib.parse from datetime import datetime, timezone, timedelta import time # Initialize HTTP client with timeouts http = urllib3.PoolManager( timeout=urllib3.Timeout(connect=5.0, read=60.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', 'armis-alerts').strip('/') STATE_KEY = os.environ.get('STATE_KEY') or f"{GCS_PREFIX}/state.json" ARMIS_INSTANCE_URL = os.environ.get('ARMIS_INSTANCE_URL', '').rstrip('/') ARMIS_SECRET_KEY = os.environ.get('ARMIS_SECRET_KEY') PAGE_SIZE = int(os.environ.get('PAGE_SIZE', '1000')) MAX_RECORDS = int(os.environ.get('MAX_RECORDS', '50000')) LOOKBACK_HOURS = int(os.environ.get('LOOKBACK_HOURS', '2')) ALERT_FIELDS = [ 'alertId', 'type', 'title', 'description', 'severity', 'status', 'time', 'activityUUIDs', 'deviceIds', 'connectionIds' ] def parse_datetime(value): """Parse ISO datetime string to datetime object.""" if not value: return None if value.endswith("Z"): value = value[:-1] + "+00:00" try: return datetime.fromisoformat(value) except Exception: try: return datetime.strptime(value, '%Y-%m-%dT%H:%M:%S') except Exception: return None def get_access_token(): """Obtain an access token from the Armis API.""" url = f"{ARMIS_INSTANCE_URL}/api/v1/access_token/" body = urllib.parse.urlencode({'secret_key': ARMIS_SECRET_KEY}) response = http.request( 'POST', url, body=body, headers={'Content-Type': 'application/x-www-form-urlencoded'} ) if response.status != 200: raise Exception( f"Failed to get access token: HTTP {response.status} - " f"{response.data.decode('utf-8')}" ) data = json.loads(response.data.decode('utf-8')) return data['data']['access_token'] @functions_framework.cloud_event def main(cloud_event): """ Cloud Run function triggered by Pub/Sub to fetch Armis Alert records and write to GCS. Args: cloud_event: CloudEvent object containing Pub/Sub message """ if not all([GCS_BUCKET, ARMIS_INSTANCE_URL, ARMIS_SECRET_KEY]): print('Error: Missing required environment variables') return try: 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 delayed events if last_time: 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 alert logs from " f"{last_time.isoformat()} to {now.isoformat()}" ) # Get access token access_token = get_access_token() print("Successfully obtained Armis access token.") # Fetch alert logs records, newest_event_time = fetch_alert_logs( access_token=access_token, start_time=last_time, end_time=now, ) if not records: print("No new alert 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 records] ) + '\n' blob.upload_from_string( ndjson, content_type='application/x-ndjson' ) print( f"Wrote {len(records)} records to " f"gs://{GCS_BUCKET}/{object_key}" ) # Update state if newest_event_time: save_state(bucket, STATE_KEY, newest_event_time) else: save_state(bucket, STATE_KEY, now.isoformat()) print(f"Successfully processed {len(records)} records") except Exception as e: print(f'Error processing alert 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): """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_alert_logs(access_token, start_time, end_time): """ Fetch alert logs from Armis REST API with pagination. Args: access_token: Armis API access token start_time: Start time for log query end_time: End time for log query Returns: Tuple of (records list, newest_event_time ISO string) """ base_url = f"{ARMIS_INSTANCE_URL}/api/v1/search/" headers = {'Authorization': access_token} # Build AQL query with time filter start_str = start_time.strftime('%Y-%m-%dT%H:%M:%S') aql_query = f'in:alerts after:{start_str}' records = [] newest_time = None page_from = 0 backoff = 1.0 while True: if len(records) >= MAX_RECORDS: print(f"Reached max_records limit ({MAX_RECORDS})") break params = { 'aql': aql_query, 'from': str(page_from), 'orderBy': 'time', 'length': str(PAGE_SIZE), 'fields': ','.join(ALERT_FIELDS), } try: response = http.request( 'GET', base_url, fields=params, 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). " f"Retrying after {retry_after}s..." ) time.sleep(retry_after) backoff = min(backoff * 2, 30.0) continue # Handle token expiry if response.status == 401: print("Access token expired, refreshing...") access_token = get_access_token() headers = {'Authorization': access_token} 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 records, newest_time data = json.loads(response.data.decode('utf-8')) result = data.get('data', {}).get('results', []) total = data.get('data', {}).get('total', 0) count = data.get('data', {}).get('count', 0) next_from = data.get('data', {}).get('next') if not result: print(f"No more results (empty page)") break print( f"Page from={page_from}: Retrieved {count} events " f"(total: {total})" ) records.extend(result) # Track newest event time for event in result: try: event_time = event.get('time') if event_time: if newest_time is None: newest_time = event_time else: current_dt = parse_datetime(event_time) newest_dt = parse_datetime(newest_time) if ( current_dt and newest_dt and current_dt > newest_dt ): newest_time = event_time except Exception as e: print( f"Warning: Could not parse " f"event time: {e}" ) # Check pagination if next_from is None or count < PAGE_SIZE: print("Reached last page") break page_from = next_from except Exception as e: print(f"Error fetching alert logs: {e}") return records, newest_time print(f"Retrieved {len(records)} total alert records") return records, newest_timeSecondo file - 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).
Crea un 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 armis-alerts-collector-hourlyRegione Seleziona la stessa regione della funzione Cloud Run Frequenza 0 * * * *(ogni ora, allo scoccare dell'ora)Fuso orario Seleziona il fuso orario (consigliato UTC) Tipo di target Pub/Sub Argomento Seleziona l'argomento armis-alerts-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 10 minuti | */10 * * * * |
Volume elevato, quasi in tempo reale |
| Ogni ora | 0 * * * * |
Standard (consigliato) |
| Ogni 2 ore | 0 */2 * * * |
Abbassa il volume |
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
armis-alerts-collector. - Fai clic sulla scheda Log.
Verifica che la funzione sia stata eseguita correttamente. Cerca:
Fetching alert logs from YYYY-MM-DDTHH:MM:SS+00:00 to YYYY-MM-DDTHH:MM:SS+00:00 Successfully obtained Armis access token. Page from=0: Retrieved X events (total: Y) Wrote X records to gs://armis-alert-logs/armis-alerts/logs_YYYYMMDD_HHMMSS.ndjson Successfully processed X recordsVai a Cloud Storage > Bucket.
Fai clic sul nome del bucket.
Vai alla cartella del prefisso
armis-alerts/.Verifica che sia stato creato un nuovo file
.ndjsoncon il timestamp corrente.
Se visualizzi errori nei log:
- HTTP 400: verifica che la sintassi della query AQL sia corretta. Verifica che l'URL dell'istanza Armis non abbia una barra finale.
- HTTP 401: il token di accesso è scaduto o non è valido. La funzione aggiorna automaticamente il token in caso di errori 401.
- HTTP 429: limitazione di frequenza. La funzione riproverà automaticamente con backoff.
- "Token di accesso non trovato": verifica che l'API secret di Armis sia corretta.
- Variabili di ambiente mancanti: verifica che tutte le variabili richieste siano impostate.
Configura un feed in Google SecOps per importare i log degli avvisi di Armis
- 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.
Armis Alerts). - Seleziona Google Cloud Storage V2 come Tipo di origine.
- Seleziona Armis Alerts come Log type (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.comCopia questo indirizzo email per utilizzarlo nel passaggio successivo.
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://armis-alert-logs/armis-alerts/- Sostituisci:
armis-alert-logs: il nome del tuo bucket GCS.armis-alerts: 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 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.
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.
- 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.
Tabella di mappatura UDM
| Campo log | Mappatura UDM | Logica |
|---|---|---|
description |
metadata.description |
Mappatura diretta |
time |
metadata.event_timestamp |
Analizzato come yyyy-MM-ddTHH:mm:ss.SSSZZ |
title |
metadata.product_event_type |
Mappatura diretta |
alertId |
metadata.product_log_id |
Mappatura diretta |
token_connection_id |
network.session_id |
Mappatura diretta |
deviceId |
principal.asset.asset_id |
Mappatura diretta |
token_device_id |
principal.asset.attribute.labels |
Unita |
| N/D | metadata.event_type |
Costante: GENERIC_EVENT |
| N/D | metadata.product_name |
Costante: ARMIS |
| N/D | metadata.vendor_name |
Costante: ARMIS |
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.