Collecter les journaux Citrix Analytics

Compatible avec :

Google SecOps SIEM

Ce document explique comment ingérer des journaux Citrix Analytics dans Google Security Operations à l'aide de Google Cloud Storage. Citrix Analytics for Performance fournit des données agrégées à partir de sources de données sur les performances, ce qui vous permet d'extraire des données sur les sessions, les machines et les utilisateurs.

Avant de commencer

Assurez-vous de remplir les conditions préalables suivantes :

Une instance Google SecOps
Un projet GCP avec l'API Cloud Storage activée
Autorisations pour créer et gérer des buckets GCS
Autorisations permettant de créer des services Cloud Run, des sujets Pub/Sub et des tâches Cloud Scheduler
Accès privilégié au locataire Citrix Analytics for Performance
Identifiants de l'API Citrix Cloud (ID client, code secret client, ID client)

Collecter les identifiants de l'API Citrix Analytics

Connectez-vous à la console Citrix Cloud. Dans la console Citrix Cloud, cliquez sur le menu en haut à gauche de l'écran. Sélectionnez l'option "Identity and Access Management" dans le menu. Sélectionnez l'onglet "Accès à l'API".
Cliquez sur Créer un client.
Copiez et enregistrez les informations suivantes dans un emplacement sécurisé :
- ID client
- Code secret du client
- ID client (situé dans l'URL Citrix Cloud ou sur la page IAM)
- URL de base de l'API : https://api.cloud.com/casodata
Remarque : L'implémentation utilise un jeton de support Citrix Cloud pour l'authentification.

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
Nommer votre bucket	Saisissez un nom unique (par exemple, `citrix-analytics-logs`).
Type d'emplacement	Choisissez en fonction de vos besoins (région, birégion ou 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 : Activer la gestion des versions des objets ou la règle de conservation

Cliquez sur Créer.

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.

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 citrix-analytics-collector-sa.
- Description du compte de service : saisissez Service account for Cloud Run function to collect Citrix Analytics logs.
Cliquez sur Créer et continuer.
Dans la section Autoriser ce compte de service à accéder au projet :
1. Cliquez sur Sélectionner un rôle.
2. Recherchez et sélectionnez Administrateur des objets de l'espace de stockage.
3. Cliquez sur + Ajouter un autre rôle.
4. Recherchez et sélectionnez Demandeur Cloud Run.
5. Cliquez sur + Ajouter un autre rôle.
6. 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 le 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 un bucket GCS

Accordez au compte de service des autorisations d'écriture sur le bucket GCS :

Accédez à Cloud Storage > Buckets.
Cliquez sur le nom de votre bucket.
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.
- Attribuer des rôles : sélectionnez Administrateur des objets Storage.
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 Create topic (Créer un sujet).
Fournissez les informations de configuration suivantes :
- ID du sujet : saisissez citrix-analytics-trigger.
- Conservez les valeurs par défaut des autres paramètres.
Cliquez sur Créer.

Créer une fonction Cloud Run pour collecter les journaux

La fonction Cloud Run est déclenchée par les messages Pub/Sub de Cloud Scheduler pour extraire les journaux de l'API Citrix Analytics OData 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	`citrix-analytics-collector`
Région	Sélectionnez la région correspondant à votre bucket GCS (par exemple, `us-central1`).
Runtime (durée d'exécution)	Sélectionnez Python 3.12 ou version ultérieure.

Dans la section Déclencheur (facultatif) :
1. Cliquez sur + Ajouter un déclencheur.
2. Sélectionnez Cloud Pub/Sub.
3. Dans Sélectionner un sujet Cloud Pub/Sub, choisissez le sujet citrix-analytics-trigger.
4. Cliquez sur Enregistrer.
Dans la section Authentification :
1. Sélectionnez Exiger l'authentification.
2. Consultez Identity and Access Management (IAM).
Remarque : Pub/Sub gère automatiquement l'authentification lors de l'appel de la fonction.
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 citrix-analytics-collector-sa.

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
`GCS_BUCKET`	`citrix-analytics-logs`
`GCS_PREFIX`	`citrix_analytics`
`STATE_KEY`	`citrix_analytics/state.json`
`CITRIX_CLIENT_ID`	`your-client-id`
`CITRIX_CLIENT_SECRET`	`your-client-secret`
`CITRIX_CUSTOMER_ID`	`your-customer-id`
`API_BASE`	`https://api.cloud.com/casodata`
`ENTITIES`	`sessions,machines,users`
`TOP_N`	`1000`
`LOOKBACK_MINUTES`	`75`

Dans l'onglet Variables et secrets, faites défiler la page jusqu'à Requêtes :
- Délai avant expiration de la requête : saisissez 600 secondes (10 minutes).
Accédez à l'onglet Paramètres dans Conteneurs :
- Dans la section Ressources :
  - Mémoire : sélectionnez 512 Mio ou plus.
  - CPU : sélectionnez 1.
- Cliquez sur OK.
Faites défiler la page jusqu'à Environnement d'exécution :
- Sélectionnez Par défaut (recommandé).
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).
Cliquez sur Créer.
Attendez que le service soit créé (1 à 2 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, timedelta, timezone
import urllib.parse

# Initialize HTTP client
http = urllib3.PoolManager()

# Initialize Storage client
storage_client = storage.Client()

CITRIX_TOKEN_URL_TMPL = "https://api.cloud.com/cctrustoauth2/{customerid}/tokens/clients"
DEFAULT_API_BASE = "https://api.cloud.com/casodata"

@functions_framework.cloud_event
def main(cloud_event):
    """
    Cloud Run function triggered by Pub/Sub to fetch logs from Citrix Analytics API and write to GCS.

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

    # Get environment variables
    bucket_name = os.environ.get('GCS_BUCKET')
    prefix = os.environ.get('GCS_PREFIX', 'citrix_analytics').strip('/')
    state_key = os.environ.get('STATE_KEY') or f"{prefix}/state.json"
    customer_id = os.environ.get('CITRIX_CUSTOMER_ID')
    client_id = os.environ.get('CITRIX_CLIENT_ID')
    client_secret = os.environ.get('CITRIX_CLIENT_SECRET')
    api_base = os.environ.get('API_BASE', DEFAULT_API_BASE)
    entities = [e.strip() for e in os.environ.get('ENTITIES', 'sessions,machines,users').split(',') if e.strip()]
    top_n = int(os.environ.get('TOP_N', '1000'))
    lookback_minutes = int(os.environ.get('LOOKBACK_MINUTES', '75'))

    if not all([bucket_name, customer_id, client_id, client_secret]):
        print('Error: Missing required environment variables')
        return

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

        # Determine target hour to collect
        now = datetime.now(timezone.utc)
        fallback_target = (now - timedelta(minutes=lookback_minutes)).replace(minute=0, second=0, microsecond=0)

        # Load state (last processed timestamp)
        state = load_state(bucket, state_key)
        last_processed_str = state.get('last_hour_utc')

        if last_processed_str:
            last_processed = datetime.fromisoformat(last_processed_str.replace('Z', '+00:00')).replace(tzinfo=None)
            target_hour = last_processed + timedelta(hours=1)
        else:
            target_hour = fallback_target

        print(f'Processing logs for hour: {target_hour.isoformat()}Z')

        # Get authentication token
        token = get_citrix_token(customer_id, client_id, client_secret)
        headers = {
            'Authorization': f'CwsAuth bearer={token}',
            'Citrix-CustomerId': customer_id,
            'Accept': 'application/json',
            'Content-Type': 'application/json',
        }

        total_records = 0

        # Process each entity type
        for entity in entities:
            records = []
            for row in fetch_odata_entity(entity, target_hour, top_n, headers, api_base):
                enriched_record = {
                    'citrix_entity': entity,
                    'citrix_hour_utc': target_hour.isoformat() + 'Z',
                    'collection_timestamp': datetime.now(timezone.utc).isoformat() + 'Z',
                    'raw': row
                }
                records.append(enriched_record)

                # Write in batches to avoid memory issues
                if len(records) >= 1000:
                    blob_name = f"{prefix}/{entity}/year={target_hour.year:04d}/month={target_hour.month:02d}/day={target_hour.day:02d}/hour={target_hour.hour:02d}/part-{datetime.now(timezone.utc).strftime('%Y%m%d%H%M%S%f')}.ndjson"
                    write_ndjson_to_gcs(bucket, blob_name, records)
                    total_records += len(records)
                    records = []

            # Write remaining records
            if records:
                blob_name = f"{prefix}/{entity}/year={target_hour.year:04d}/month={target_hour.month:02d}/day={target_hour.day:02d}/hour={target_hour.hour:02d}/part-{datetime.now(timezone.utc).strftime('%Y%m%d%H%M%S%f')}.ndjson"
                write_ndjson_to_gcs(bucket, blob_name, records)
                total_records += len(records)

        # Update state file
        save_state(bucket, state_key, {'last_hour_utc': target_hour.isoformat() + 'Z'})

        print(f'Successfully processed {total_records} records for hour {target_hour.isoformat()}Z')

    except Exception as e:
        print(f'Error processing logs: {str(e)}')
        raise

def get_citrix_token(customer_id, client_id, client_secret):
    """Get Citrix Cloud authentication token."""
    url = CITRIX_TOKEN_URL_TMPL.format(customerid=customer_id)
    payload = {
        'grant_type': 'client_credentials',
        'client_id': client_id,
        'client_secret': client_secret,
    }
    data = urllib.parse.urlencode(payload).encode('utf-8')

    response = http.request(
        'POST',
        url,
        body=data,
        headers={
            'Accept': 'application/json',
            'Content-Type': 'application/x-www-form-urlencoded',
        }
    )

    token_response = json.loads(response.data.decode('utf-8'))
    return token_response['access_token']

def fetch_odata_entity(entity, when_utc, top, headers, api_base):
    """Fetch data from Citrix Analytics OData API with pagination."""
    year = when_utc.year
    month = when_utc.month
    day = when_utc.day
    hour = when_utc.hour

    base_url = f"{api_base.rstrip('/')}/{entity}?year={year:04d}&month={month:02d}&day={day:02d}&hour={hour:02d}"
    skip = 0

    while True:
        url = f"{base_url}&$top={top}&$skip={skip}"

        response = http.request('GET', url, headers=headers)
        data = json.loads(response.data.decode('utf-8'))
        items = data.get('value', [])

        if not items:
            break

        for item in items:
            yield item

        if len(items) < top:
            break

        skip += top

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: {str(e)}')
    return {}

def save_state(bucket, key, state):
    """Save state to GCS."""
    try:
        blob = bucket.blob(key)
        blob.upload_from_string(
            json.dumps(state, separators=(',', ':')),
            content_type='application/json'
        )
    except Exception as e:
        print(f'Warning: Could not save state: {str(e)}')

def write_ndjson_to_gcs(bucket, key, records):
    """Write records as NDJSON to GCS."""
    body_lines = []
    for record in records:
        json_line = json.dumps(record, separators=(',', ':'), ensure_ascii=False)
        body_lines.append(json_line)

    body = ('\n'.join(body_lines) + '\n').encode('utf-8')

    blob = bucket.blob(key)
    blob.upload_from_string(body, content_type='application/x-ndjson')

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 publie des messages sur le sujet Pub/Sub à intervalles réguliers, ce qui déclenche 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	`citrix-analytics-collector-hourly`
Région	Sélectionnez la même région que la fonction Cloud Run.
Fréquence	`0 * * * *` (toutes les heures)
Fuseau horaire	Sélectionnez un fuseau horaire (UTC recommandé).
Type de cible	Pub/Sub
Topic	Sélectionnez le thème `citrix-analytics-trigger`.
Corps du message	`{}` (objet JSON vide)

Cliquez sur Créer.

Options de fréquence de planification

Choisissez la fréquence en fonction du volume de journaux et des exigences de latence :

Fréquence	Expression Cron	Cas d'utilisation
Toutes les heures	`0 * * * *`	Standard (recommandé)
Toutes les 2 heures	`0 /2 * *`	Réduire le volume
Toutes les 6 heures	`0 /6 * *`	Traitement par lot à faible volume

Tester le job Scheduler

Dans la console Cloud Scheduler, recherchez votre job.
Cliquez sur Forcer l'exécution pour déclencher manuellement l'exécution.
Patientez quelques secondes, puis accédez à Cloud Run > Services > citrix-analytics-collector > Journaux.
Vérifiez que la fonction s'est exécutée correctement.
Vérifiez le bucket GCS pour confirmer que les journaux ont été écrits.

Récupérer le compte de service Google SecOps

Google SecOps utilise un compte de service unique pour lire les données de votre bucket GCS. Vous devez accorder à ce compte de service l'accès à votre bucket.

Obtenir l'adresse e-mail du compte de service

Accédez à Paramètres SIEM> Flux.
Cliquez sur Add New Feed (Ajouter un flux).
Cliquez sur Configurer un flux unique.
Dans le champ Nom du flux, saisissez un nom pour le flux (par exemple, Citrix Analytics Performance logs).
Sélectionnez Google Cloud Storage V2 comme Type de source.
Sélectionnez Citrix Analytics comme Type de journal.
Cliquez sur Obtenir un compte de service. Une adresse e-mail unique pour le compte de service s'affiche, par exemple : chronicle-12345678@chronicle-gcp-prod.iam.gserviceaccount.com
Copiez cette adresse e-mail pour l'utiliser à l'étape suivante.

Remarque : Chaque instance Google SecOps possède un compte de service unique. N'utilisez pas de comptes de service provenant d'autres documentations ou exemples.

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.
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.
- Attribuez des rôles : sélectionnez Lecteur des objets de l'espace de stockage.
Cliquez sur Enregistrer.

Remarque : Si vous prévoyez d'utiliser l'option de suppression "Supprimer les fichiers transférés" ou "Supprimer les fichiers transférés et les répertoires vides", accordez le rôle Administrateur des objets Storage au lieu de Lecteur des objets Storage.

Configurer un flux dans Google SecOps pour ingérer les journaux Citrix Analytics

Accédez à Paramètres SIEM> Flux.
Cliquez sur Add New Feed (Ajouter un flux).
Cliquez sur Configurer un flux unique.
Dans le champ Nom du flux, saisissez un nom pour le flux (par exemple, Citrix Analytics logs).
Sélectionnez Google Cloud Storage V2 comme Type de source.
Sélectionnez Citrix Analytics comme Type de journal.
Cliquez sur Suivant.
Spécifiez les valeurs des paramètres d'entrée suivants :
- URL du bucket Storage : saisissez l'URI du bucket GCS avec le préfixe du chemin d'accès :
```
gs://citrix-analytics-logs/citrix_analytics/
```
  - Remplacez :
    - citrix-analytics-logs : nom de votre bucket GCS.
    - citrix_analytics : préfixe/chemin d'accès au dossier facultatif où les journaux sont stockés (laisser vide pour la racine).
  - Exemples :
    - Bucket racine : gs://citrix-analytics-logs/
    - Avec préfixe : gs://citrix-analytics-logs/citrix_analytics/
  Remarque : Incluez toujours la barre oblique (/) à la fin de l'URI.
- 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 après un transfert réussi.
  - Supprimer les fichiers transférés et les répertoires vides : supprime les fichiers et les répertoires vides après un transfert réussi.
    
    Remarque : Si vous sélectionnez une option de suppression, le compte de service doit disposer du rôle Administrateur des objets Storage au lieu de celui de lecteur. Mettez à jour les autorisations IAM en conséquence.
- Âge maximal des fichiers : incluez les fichiers modifiés au cours des derniers jours. La valeur par défaut est de 180 jours.
- 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.

Vous avez encore besoin d'aide ? Obtenez des réponses de membres de la communauté et de professionnels Google SecOps.