Collecter les journaux SpyCloud
Ce document explique comment ingérer des journaux SpyCloud dans Google Security Operations à l'aide de Google Cloud Storage V2.
SpyCloud est une plate-forme de prévention de la prise de contrôle de compte qui fournit des informations sur les violations et les identifiants volés. Elle fournit des enregistrements de violations, des alertes de liste de surveillance et des rapports sur les identifiants compromis via une API REST.
Avant de commencer
Assurez-vous de remplir les conditions suivantes :
- Une instance Google SecOps
- Un projet GCP avec l'API Cloud Storage activée
- Autorisations permettant de créer et de gérer des buckets GCS
- Autorisations permettant de gérer les stratégies IAM sur les buckets GCS
- Autorisations permettant de créer des services Cloud Run, des sujets Pub/Sub et des jobs Cloud Scheduler
- Un compte SpyCloud avec accès à l'API et une clé API valide
Créer un bucket Google Cloud Storage
- Accédez à la console Google Cloud.
- Sélectionnez votre projet ou créez-en un.
- Dans le menu de navigation, accédez à Cloud Storage > Buckets.
- Cliquez sur Créer un bucket.
Fournissez les informations de configuration suivantes :
Paramètre Valeur Attribuez un nom au bucket Saisissez un nom unique (par exemple, spycloud-logs).Type d'emplacement Choisissez en fonction de vos besoins (région, birégion, multirégion). Emplacement Sélectionnez l'emplacement (par exemple, us-central1).Classe de stockage Standard (recommandé pour les journaux auxquels vous accédez fréquemment) Access control (Contrôle des accès) Uniforme (recommandé) Outils de protection Facultatif : Activez la gestion des versions des objets ou la règle de conservation. Cliquez sur Créer.
Collecter les identifiants de l'API SpyCloud
Obtenir une clé API
- Connectez-vous au portail Spycloud en tant qu'administrateur.
- Accédez à Settings> API (Paramètres > API).
- Copiez et enregistrez la clé API dans un emplacement sécurisé.
Vérifier les autorisations
Pour vérifier que votre clé API dispose de l'accès requis :
- Connectez-vous au portail SpyCloud.
- Accédez à Settings> API (Paramètres > API).
- Vérifiez que la clé API est active et qu'elle a accès aux points de terminaison requis (données sur les violations, liste de surveillance, compass).
- Si l'accès est limité, contactez votre administrateur SpyCloud.
Tester l'accès à l'API
Testez vos identifiants avant de procéder à l'intégration :
# Replace with your actual API key API_KEY="your-api-key" # Test API access - fetch watchlist data curl -v -H "X-API-Key: ${API_KEY}" \ "https://api.spycloud.io/enterprise-v2/breach/data/watchlist?since=2024-01-01&until=2024-01-02"
Créer un compte de service pour la fonction Cloud Run
La fonction Cloud Run a besoin d'un compte de service disposant des autorisations nécessaires pour écrire dans le bucket GCS et être appelée par Pub/Sub.
Créer un compte de service
- Dans la console GCP, accédez à IAM et administration > Comptes de service.
- Cliquez sur Créer un compte de service.
- Fournissez les informations de configuration suivantes :
- Nom du compte de service : saisissez
spycloud-collector-sa. - Description du compte de service : saisissez
Service account for Cloud Run function to collect SpyCloud logs.
- Nom du compte de service : saisissez
- Cliquez sur Créer et continuer.
- Dans la section Autoriser ce compte de service à accéder au projet, ajoutez les rôles suivants :
- Cliquez sur Sélectionner un rôle.
- Recherchez et sélectionnez Administrateur des objets Storage.
- Cliquez sur + Ajouter un autre rôle.
- Recherchez et sélectionnez Demandeur Cloud Run.
- Cliquez sur + Ajouter un autre rôle.
- Recherchez et sélectionnez Demandeur Cloud Functions.
- Cliquez sur Continuer.
- Cliquez sur OK.
Ces rôles sont requis pour :
- Administrateur des objets Storage : écrire des journaux dans un bucket GCS et gérer les fichiers d'état
- Demandeur Cloud Run : autorise Pub/Sub à appeler la fonction
- Demandeur Cloud Functions : autorise l'appel de fonctions
Accorder des autorisations IAM sur le bucket GCS
Accordez au compte de service des autorisations d'écriture dans le bucket GCS :
- Accédez à Cloud Storage > Buckets.
- Cliquez sur le nom de votre bucket (par exemple,
spycloud-logs). - Accédez à l'onglet Autorisations.
- Cliquez sur Accorder l'accès.
- Fournissez les informations de configuration suivantes :
- Ajouter des comptes principaux : saisissez l'adresse e-mail du compte de service (par exemple,
spycloud-collector-sa@your-project.iam.gserviceaccount.com). - Attribuer des rôles : sélectionnez Administrateur des objets Storage.
- Ajouter des comptes principaux : saisissez l'adresse e-mail du compte de service (par exemple,
- Cliquez sur Enregistrer.
Créer un sujet Pub/Sub
Créez un sujet Pub/Sub auquel Cloud Scheduler publiera des messages et auquel la fonction Cloud Run s'abonnera.
- Dans la console GCP, accédez à Pub/Sub > Sujets.
- Cliquez sur Créer un sujet.
- Fournissez les informations de configuration suivantes :
- ID du sujet : saisissez
spycloud-trigger. - Conservez les valeurs par défaut des autres paramètres.
- ID du sujet : saisissez
- Cliquez sur Créer.
Créer une fonction Cloud Run pour collecter les journaux
La fonction Cloud Run sera déclenchée par les messages Pub/Sub de Cloud Scheduler pour extraire les journaux de l'API SpyCloud et les écrire dans GCS.
- Dans la console GCP, accédez à Cloud Run.
- Cliquez sur Créer un service.
- Sélectionnez Fonction (utilisez un éditeur intégré pour créer une fonction).
Dans la section Configurer, fournissez les informations de configuration suivantes :
Paramètre Valeur Nom du service spycloud-collectorRégion Sélectionnez la région correspondant à votre bucket GCS (par exemple, us-central1).Durée d'exécution Sélectionnez Python 3.12 ou version ultérieure. Dans la section Déclencheur (facultatif) :
- Cliquez sur + Ajouter un déclencheur.
- Sélectionnez Cloud Pub/Sub.
- Dans Sélectionner un sujet Cloud Pub/Sub, choisissez le sujet
spycloud-trigger. - Cliquez sur Enregistrer.
Dans la section Authentification :
- Sélectionnez Exiger l'authentification.
- Consultez Identity and Access Management (IAM).
Faites défiler la page vers le bas, puis développez Conteneurs, mise en réseau, sécurité.
Accédez à l'onglet Sécurité :
- Compte de service : sélectionnez le compte de service
spycloud-collector-sa.
- Compte de service : sélectionnez le compte de service
Accédez à l'onglet Conteneurs :
- Cliquez sur Variables et secrets.
- Cliquez sur + Ajouter une variable pour chaque variable d'environnement :
Nom de la variable Exemple de valeur Description GCS_BUCKETspycloud-logsNom du bucket GCS GCS_PREFIXspycloudPréfixe des fichiers journaux STATE_KEYspycloud/state.jsonChemin d'accès au fichier d'état API_KEYyour-api-keyClé API SpyCloud API_BASEhttps://api.spycloud.ioURL de base de l'API MAX_RECORDS10000Nombre maximal d'enregistrements par exécution LOOKBACK_DAYS7Période d'analyse initiale en jours STREAMSwatchlist,catalogFlux de données séparés par une virgule Dans l'onglet Variables et secrets, faites défiler la page jusqu'à Requêtes :
- Délai avant expiration de la requête : saisissez
600secondes (10 minutes).
- Délai avant expiration de la requête : saisissez
Accédez à l'onglet Paramètres dans Conteneurs :
- Dans la section Ressources :
- Mémoire : sélectionnez 512 Mio ou plus.
- CPU : sélectionnez 1.
- Dans la section Ressources :
Dans la section Scaling de révision :
- Nombre minimal d'instances : saisissez
0. - Nombre maximal d'instances : saisissez
100(ou ajustez en fonction de la charge attendue).
- Nombre minimal d'instances : saisissez
Cliquez sur Créer.
Attendez que le service soit créé (une à deux minutes).
Une fois le service créé, l'éditeur de code intégré s'ouvre automatiquement.
Ajouter un code de fonction
- Saisissez main dans Point d'entrée de la fonction.
Dans l'éditeur de code intégré, créez deux fichiers :
Premier fichier : 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', 'spycloud') STATE_KEY = os.environ.get('STATE_KEY', 'spycloud/state.json') API_KEY = os.environ.get('API_KEY', '') API_BASE = os.environ.get('API_BASE', 'https://api.spycloud.io').rstrip('/') MAX_RECORDS = int(os.environ.get('MAX_RECORDS', '10000')) LOOKBACK_DAYS = int(os.environ.get('LOOKBACK_DAYS', '7')) STREAMS = [s.strip() for s in os.environ.get('STREAMS', 'watchlist').split(',') if s.strip()] 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 SpyCloud logs and write to GCS. Args: cloud_event: CloudEvent object containing Pub/Sub message """ if not all([GCS_BUCKET, API_KEY]): print('Error: Missing required environment variables') return try: bucket = storage_client.bucket(GCS_BUCKET) # Load state state = load_state(bucket, STATE_KEY) now = datetime.now(timezone.utc) # Determine date range if isinstance(state, dict) and state.get("last_date"): since_date = state["last_date"] else: since_date = (now - timedelta(days=LOOKBACK_DAYS)).strftime('%Y-%m-%d') until_date = now.strftime('%Y-%m-%d') print(f"Fetching data from {since_date} to {until_date}") report = {} if 'watchlist' in STREAMS: print("Fetching watchlist breach data...") count = pull_watchlist(bucket, since_date, until_date) report['watchlist_records'] = count if 'catalog' in STREAMS: print("Fetching breach catalog...") count = pull_catalog(bucket, since_date, until_date) report['catalog_records'] = count if 'compass' in STREAMS: print("Fetching compass data...") count = pull_compass(bucket, since_date, until_date) report['compass_records'] = count # Update state save_state(bucket, STATE_KEY, until_date) print(f"Successfully processed: {json.dumps(report)}") 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_date: str): """Save the last query date to GCS state file.""" try: state = {'last_date': last_date, 'last_event_time': datetime.now(timezone.utc).isoformat()} blob = bucket.blob(key) blob.upload_from_string( json.dumps(state, indent=2), content_type='application/json' ) print(f"Saved state: last_date={last_date}") except Exception as e: print(f"Warning: Could not save state: {e}") def api_get(endpoint: str, params: dict = None): """Make authenticated GET request to SpyCloud API with rate limiting.""" url = f"{API_BASE}{endpoint}" if params: query = '&'.join([f"{k}={v}" for k, v in params.items()]) url = f"{url}?{query}" headers = { 'X-API-Key': API_KEY, 'Accept': 'application/json', 'User-Agent': 'GoogleSecOps-SpyCloudCollector/1.0' } backoff = 1.0 max_retries = 3 for attempt in range(max_retries): 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 if response.status != 200: print(f"HTTP Error: {response.status} - {response.data.decode('utf-8')}") return None return json.loads(response.data.decode('utf-8')) print(f"Failed after {max_retries} retries due to rate limiting") return None def write_ndjson(bucket, prefix: str, stream_name: str, records: list): """Write records to GCS as NDJSON.""" if not records: return 0 now = datetime.now(timezone.utc) timestamp = now.strftime('%Y%m%d_%H%M%S') object_key = f"{GCS_PREFIX}/{stream_name}/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 gs://{GCS_BUCKET}/{object_key}") return len(records) def pull_watchlist(bucket, since_date: str, until_date: str): """Fetch watchlist breach data.""" cursor = None all_records = [] while True: params = {'since': since_date, 'until': until_date} if cursor: params['cursor'] = cursor data = api_get('/enterprise-v2/breach/data/watchlist', params) if not data: break results = data.get('results', []) if not results: break all_records.extend(results) if len(all_records) >= MAX_RECORDS: print(f"Reached max_records limit ({MAX_RECORDS})") break cursor = data.get('cursor') if not cursor: break return write_ndjson(bucket, GCS_PREFIX, 'watchlist', all_records) def pull_catalog(bucket, since_date: str, until_date: str): """Fetch breach catalog.""" params = {'since': since_date, 'until': until_date} data = api_get('/enterprise-v2/breach/catalog', params) if not data: return 0 results = data.get('results', []) return write_ndjson(bucket, GCS_PREFIX, 'catalog', results) def pull_compass(bucket, since_date: str, until_date: str): """Fetch compass findings.""" cursor = None all_records = [] while True: params = {'since': since_date, 'until': until_date} if cursor: params['cursor'] = cursor data = api_get('/enterprise-v2/compass/data', params) if not data: break results = data.get('results', []) if not results: break all_records.extend(results) if len(all_records) >= MAX_RECORDS: print(f"Reached max_records limit ({MAX_RECORDS})") break cursor = data.get('cursor') if not cursor: break return write_ndjson(bucket, GCS_PREFIX, 'compass', all_records)Deuxième fichier : requirements.txt: :
functions-framework==3.* google-cloud-storage==2.* urllib3>=2.0.0
Cliquez sur Déployer pour enregistrer et déployer la fonction.
Attendez la fin du déploiement (deux à trois minutes).
Créer une tâche Cloud Scheduler
Cloud Scheduler publiera des messages dans le sujet Pub/Sub à intervalles réguliers, ce qui déclenchera la fonction Cloud Run.
- Dans la console GCP, accédez à Cloud Scheduler.
- Cliquez sur Créer une tâche.
Fournissez les informations de configuration suivantes :
Paramètre Valeur Nom spycloud-collector-dailyRégion Sélectionnez la même région que la fonction Cloud Run. Fréquence 0 0 * * *(tous les jours à minuit)Fuseau horaire Sélectionnez un fuseau horaire (UTC recommandé). Type de cible Pub/Sub Sujet Sélectionnez le thème spycloud-trigger.Corps du message {}(objet JSON vide)Cliquez sur Créer.
Options de fréquence de programmation
Choisissez la fréquence en fonction du volume de journaux et des exigences de latence :
| Fréquence | Expression Cron | Cas d'utilisation |
|---|---|---|
| Toutes les 5 minutes | */5 * * * * |
Volume élevé, faible latence |
| Toutes les 15 minutes | */15 * * * * |
Volume moyen |
| Toutes les heures | 0 * * * * |
Standard |
| Toutes les 6 heures | 0 */6 * * * |
Traitement par lot à faible volume |
| Tous les jours | 0 0 * * * |
Collecte de données historiques (recommandée pour les données de piratage) |
Tester l'intégration
- Dans la console Cloud Scheduler, recherchez votre job (
spycloud-collector-daily). - Cliquez sur Exécuter de force pour déclencher manuellement.
- Patientez quelques secondes, puis accédez à Cloud Run > Services > spycloud-collector > Journaux.
Vérifiez que la fonction s'est exécutée correctement. Par exemple :
Fetching data from YYYY-MM-DD to YYYY-MM-DD Fetching watchlist breach data... Wrote X records to gs://spycloud-logs/spycloud/watchlist/logs_YYYYMMDD_HHMMSS.ndjson Successfully processed: {"watchlist_records": X, "catalog_records": Y}Consultez le bucket GCS (
spycloud-logs) pour vérifier que les journaux ont été écrits.
Si des erreurs s'affichent dans les journaux :
- HTTP 401 : vérifiez la clé API dans les variables d'environnement
- HTTP 403 : vérifiez que la clé API a accès aux points de terminaison requis.
- HTTP 429 : limitation du débit. La fonction effectuera automatiquement une nouvelle tentative avec un intervalle entre les tentatives.
- Variables d'environnement manquantes : vérifiez que toutes les variables requises sont définies.
Configurer un flux dans Google SecOps pour ingérer les journaux SpyCloud
- Accédez à Paramètres SIEM> Flux.
- Cliquez sur Ajouter un flux.
- Cliquez sur Configurer un flux unique.
- Dans le champ Nom du flux, saisissez un nom pour le flux (par exemple,
SpyCloud Logs). - Sélectionnez Google Cloud Storage V2 comme Type de source.
- Sélectionnez SpyCloud comme Type de journal.
Cliquez sur Obtenir un compte de service. Une adresse e-mail de compte de service unique s'affiche, par exemple :
chronicle-12345678@chronicle-gcp-prod.iam.gserviceaccount.comCopiez cette adresse e-mail. Vous en aurez besoin lors de la tâche suivante.
Cliquez sur Suivant.
Spécifiez les valeurs des paramètres d'entrée suivants :
URL du bucket de stockage : saisissez l'URI du bucket GCS avec le chemin d'accès au préfixe :
gs://spycloud-logs/spycloud/- Remplacez :
spycloud-logs: nom de votre bucket GCS.spycloud: préfixe/chemin d'accès au dossier facultatif où les journaux sont stockés (laisser vide pour la racine).
- Remplacez :
Option de suppression de la source : sélectionnez l'option de suppression de votre choix :
- Jamais : ne supprime jamais aucun fichier après les transferts (recommandé pour les tests).
- Supprimer les fichiers transférés : supprime les fichiers une fois le transfert réussi.
Supprimer les fichiers transférés et les répertoires vides : supprime les fichiers et les répertoires vides une fois le transfert réussi.
Âge maximal du fichier : incluez les fichiers modifiés au cours des derniers jours (180 jours par défaut).
Espace de noms de l'élément : espace de noms de l'élément.
Libellés d'ingestion : libellé à appliquer aux événements de ce flux.
Cliquez sur Suivant.
Vérifiez la configuration de votre nouveau flux sur l'écran Finaliser, puis cliquez sur Envoyer.
Accorder des autorisations IAM au compte de service Google SecOps
Le compte de service Google SecOps a besoin du rôle Lecteur des objets Storage sur votre bucket GCS.
- Accédez à Cloud Storage > Buckets.
- Cliquez sur le nom de votre bucket (
spycloud-logs). - Accédez à l'onglet Autorisations.
- Cliquez sur Accorder l'accès.
- Fournissez les informations de configuration suivantes :
- Ajouter des comptes principaux : collez l'adresse e-mail du compte de service Google SecOps.
- Attribuer des rôles : sélectionnez Lecteur d'objets Storage.
Cliquez sur Enregistrer.
Table de mappage UDM
| Champ de journal | Mappage UDM | Logique |
|---|---|---|
| av_softwares, assets.av_softwares, assets.country, assets.country_code, assets.display_resolution, assets.email, assets.full_name, assets.infected_machine_id, assets.infected_path, assets.infected_time, assets.ip_addresses, assets.keyboard_languages, assets.password, assets.target_url, assets.username, assets.user_browser, assets.user_hostname, assets.user_os, assets.user_sys_registered_owner | additional.fields | Fusionné à partir des libellés créés à partir de ces champs et de av_software_list |
| mot de passe | extensions.auth.auth_details | Valeur copiée directement |
| date | metadata.event_timestamp | Analysé en tant que code temporel ISO8601 |
| metadata.event_type | Définissez la valeur sur NETWORK_CONNECTION si has_principal, has_target et has_network sont présents, sur USER_UNCATEGORIZED si has_principal et has_principal_userid sont présents, sur STATUS_UPDATE si has_principal est présent et has_principal_ip ne l'est pas, sur GENERIC_EVENT dans le cas contraire, ou sur USER_UNCATEGORIZED si user_hostname, ip ou infected_machine_id sont présents. | |
| infected_time | metadata.ingested_timestamp | Analysé en tant que code temporel avec les formats aaaa-MM-jjTHH:mm:ssZ, RFC 3339, ISO8601 |
| log_id, assets.log_id, uuid | metadata.product_log_id | Valeur issue de log_id si elle n'est pas vide, sinon assets.log_id, sinon uuid |
| user_os | network.http.parsed_user_agent | User-agent converti en user-agent analysé |
| user_os | network.http.user_agent | Valeur copiée directement |
| cookie_domain | principal.administrative_domain | Valeur copiée directement |
| pays | principal.asset.location.country_or_region | Valeur copiée directement |
| infected_machine_id | principal.asset_id | Concaténé sous la forme "id: " + infected_machine_id |
| infected_path | principal.file.full_path | Valeur copiée directement |
| user_hostname, domain | principal.hostname | Défini sur user_hostname s'il n'est pas vide, puis sur le domaine s'il n'est pas vide |
| ip, ip_addresses | principal.ip | Fusionné à partir du tableau "ip" et "ip_addresses" |
| country_code | principal.resource.attribute.labels | Fusionné à partir de country_code_label créé à partir de country_code |
| id | principal.resource.id | Valeur copiée directement (convertie en chaîne) |
| page d'accueil | principal.url | Valeur copiée directement |
| principal.user.email_addresses | Valeur copiée directement | |
| full_name | principal.user.user_display_name | Valeur copiée directement |
| user_sys_registered_owner, email_username | principal.user.userid | Définissez la valeur sur user_sys_registered_owner, puis sur email_username si elle n'est pas vide. |
| confiance | security_result.confidence_details | Converti en chaîne |
| description | security_result.description | Valeur copiée directement |
| cookie_expiration, cookie_name, cookie_subdomain, cookie_value, day, document_id, locality_zone, source_id, spycloud_publishdate, spycloud_publish_date, user_browser, infected_time, timezone, password_type, password_plaintext, email_domain, api_token, account_status, breach_category, breach_main_category, consumer_category, malware_family, num_records, premium_flag, sensitive_source, short_title, site_description, title, tlp, type, display_resolution, keyboard_languages | security_result.detection_fields | Fusionné à partir des libellés créés à partir de ces champs |
| de gravité, | security_result.severity | Définissez la valeur sur "LOW" si la valeur est "2", sur "INFORMATIONAL" si la valeur est "5", sur "HIGH" si la valeur est "20", sur "CRITICAL" si la valeur est "25" ou "26". |
| de gravité, | security_result.severity_details | Valeur copiée directement |
| target_subdomain | target.administrative_domain | Valeur copiée directement |
| target_domain | target.asset.hostname | Valeur copiée directement |
| target_domain | target.hostname | Valeur copiée directement |
| target_url | target.url | Valeur copiée directement |
| nom d'utilisateur | target.user.userid | Valeur copiée directement |
| metadata.product_name | Définie sur "SPYCLOUD" | |
| metadata.vendor_name | Défini sur "SpyCloud" | |
spycloud_publish_date", "infected_time", and "timezone |
security_result.detection_fields |
Mappé à partir du journal des modifications |
Journal des modifications
Afficher le journal des modifications pour ce parseur
Vous avez encore besoin d'aide ? Obtenez des réponses de membres de la communauté et de professionnels Google SecOps.