Collecter les journaux Snipe-IT

Compatible avec :

Ce document explique comment ingérer des journaux Snipe-IT dans Google Security Operations à l'aide de Google Cloud Storage. Snipe-IT est un système de gestion des ressources informatiques open source qui permet de suivre le matériel, les licences logicielles, les accessoires, les consommables et d'autres ressources informatiques tout au long de leur cycle de vie.

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 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 pour créer des fonctions Cloud Run, des sujets Pub/Sub et des jobs Cloud Scheduler
  • Accès privilégié au locataire Snipe-IT

Collecter les prérequis de Snipe-IT (jeton d'API et URL de base)

  1. Connectez-vous à Snipe-IT.
  2. Ouvrez votre menu utilisateur (avatar en haut à droite), puis cliquez sur Gérer les clés API.
  3. Cliquez sur Create New Token (Créer un jeton) :
    • Nom/Libellé : saisissez un libellé descriptif (par exemple, Google SecOps export).
  4. Cliquez sur Générer.
  5. Copiez le jeton d'API (il ne s'affichera qu'une seule fois). Stockez-le de manière sécurisée.
  6. Déterminez l'URL de base de votre API, qui est généralement https://<your-domain>/api/v1.
    • Exemple : https://snipeit.example.com/api/v1

Créer un bucket Google Cloud Storage

  1. Accédez à la console Google Cloud.
  2. Sélectionnez votre projet ou créez-en un.
  3. Dans le menu de navigation, accédez à Cloud Storage > Buckets.
  4. Cliquez sur Créer un bucket.

  5. Fournissez les informations de configuration suivantes :

    Paramètre Valeur
    Attribuez un nom au bucket Saisissez un nom unique (par exemple, snipe-it-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.

  6. 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

  1. Dans la console GCP, accédez à IAM et administration > Comptes de service.
  2. Cliquez sur Créer un compte de service.
  3. Fournissez les informations de configuration suivantes :
    • Nom du compte de service : saisissez snipeit-assets-to-gcs-sa.
    • Description du compte de service : saisissez Service account for Cloud Run function to collect Snipe-IT logs.
  4. Cliquez sur Créer et continuer.
  5. 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 Storage.
    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.
  6. Cliquez sur Continuer.
  7. 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 :

  1. Accédez à Cloud Storage > Buckets.
  2. Cliquez sur le nom de votre bucket.
  3. Accédez à l'onglet Autorisations.
  4. Cliquez sur Accorder l'accès.
  5. Fournissez les informations de configuration suivantes :
    • Ajouter des comptes principaux : saisissez l'adresse e-mail du compte de service (par exemple, snipeit-assets-to-gcs-sa@PROJECT_ID.iam.gserviceaccount.com).
    • Attribuer des rôles : sélectionnez Administrateur des objets Storage.
  6. 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.

  1. Dans la console GCP, accédez à Pub/Sub > Sujets.
  2. Cliquez sur Créer un sujet.
  3. Fournissez les informations de configuration suivantes :
    • ID du sujet : saisissez snipeit-assets-trigger.
    • Conservez les valeurs par défaut des autres paramètres.
  4. 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 ressources matérielles de l'API Snipe-IT et les écrire dans GCS.

  1. Dans la console GCP, accédez à Cloud Run.
  2. Cliquez sur Créer un service.
  3. Sélectionnez Fonction (utilisez un éditeur intégré pour créer une fonction).

  4. Dans la section Configurer, fournissez les informations de configuration suivantes :

    Paramètre Valeur
    Nom du service snipeit-assets-to-gcs
    Ré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.

  5. 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 (snipeit-assets-trigger).
    4. Cliquez sur Enregistrer.

  6. Dans la section Authentification :

    1. Sélectionnez Exiger l'authentification.
    2. Consultez Identity and Access Management (IAM).

  7. Faites défiler la page vers le bas, puis développez Conteneurs, mise en réseau, sécurité.

  8. Accédez à l'onglet Sécurité :

    • Compte de service : sélectionnez le compte de service (snipeit-assets-to-gcs-sa).

  9. Accédez à l'onglet Conteneurs :

    1. Cliquez sur Variables et secrets.
    2. Cliquez sur + Ajouter une variable pour chaque variable d'environnement :
    Nom de la variable Exemple de valeur
    GCS_BUCKET snipe-it-logs
    GCS_PREFIX snipeit/assets
    SNIPE_BASE_URL https://snipeit.example.com/api/v1
    SNIPE_API_TOKEN your-api-token
    PAGE_SIZE 500
    MAX_PAGES 200

  10. 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).

  11. 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.

  12. Faites défiler la page jusqu'à Environnement d'exécution :

    • Sélectionnez Par défaut (recommandé).

  13. 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).

  14. Cliquez sur Créer.

  15. Attendez que le service soit créé (une à deux minutes).

  16. Une fois le service créé, l'éditeur de code intégré s'ouvre automatiquement.

Ajouter un code de fonction

  1. Saisissez main dans Point d'entrée de la fonction.

  2. 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
    import urllib.parse

    # Initialize HTTP client
    http = urllib3.PoolManager()

    # Initialize Storage client
    storage_client = storage.Client()

    @functions_framework.cloud_event
    def main(cloud_event):
        """
        Cloud Run function triggered by Pub/Sub to fetch hardware assets from Snipe-IT 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', 'snipeit/assets')
        base_url = os.environ.get('SNIPE_BASE_URL', '').rstrip('/')
        token = os.environ.get('SNIPE_API_TOKEN')
        page_size = int(os.environ.get('PAGE_SIZE', '500'))
        max_pages = int(os.environ.get('MAX_PAGES', '200'))

        if not all([bucket_name, base_url, token]):
            print('Error: Missing required environment variables')
            return

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

            # Fetch and write pages
            ts = datetime.now(timezone.utc)
            offset = 0
            page = 0
            total = 0

            headers = {
                'Authorization': f'Bearer {token}',
                'Accept': 'application/json',
                'Content-Type': 'application/json'
            }

            while page < max_pages:
                # Fetch page from Snipe-IT API
                params = {
                    'limit': page_size,
                    'offset': offset,
                    'sort': 'id',
                    'order': 'asc'
                }
                qs = urllib.parse.urlencode(params)
                url = f"{base_url}/hardware?{qs}"

                print(f'Fetching page {page} from {url}')

                response = http.request('GET', url, headers=headers, timeout=60.0)

                if response.status != 200:
                    print(f'Error: API returned status {response.status}')
                    break

                data = json.loads(response.data.decode('utf-8'))

                # Get rows from response (Snipe-IT uses 'rows' field)
                rows = data.get('rows', [])
                total_available = data.get('total', 0)

                # Write page to GCS
                blob_name = f"{prefix}/{ts.strftime('%Y/%m/%d')}/snipeit-hardware-{page:05d}.json"
                blob = bucket.blob(blob_name)
                body = json.dumps(data, separators=(',', ':')).encode('utf-8')
                blob.upload_from_string(body, content_type='application/json')

                print(f'Wrote page {page} with {len(rows)} rows to {blob_name}')

                total += len(rows)

                # Check if we've reached the end
                # Snipe-IT returns empty rows array when no more data
                if len(rows) == 0:
                    print(f'No more results (empty rows array)')
                    break

                # Also check if we've fetched all available records
                if offset + len(rows) >= total_available:
                    print(f'Reached end of data (offset {offset + len(rows)} >= total {total_available})')
                    break

                page += 1
                offset += page_size

            print(f'Successfully processed {page + 1} pages with {total} total objects')

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

    • Deuxième fichier : requirements.txt: :

      functions-framework==3.*
google-cloud-storage==2.*
urllib3>=2.0.0

  3. Cliquez sur Déployer pour enregistrer et déployer la fonction.

  4. 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.

  1. Dans la console GCP, accédez à Cloud Scheduler.
  2. Cliquez sur Créer une tâche.

  3. Fournissez les informations de configuration suivantes :

    Paramètre Valeur
    Nom snipeit-assets-to-gcs-hourly
    Région Sélectionnez la même région que la fonction Cloud Run.
    Fréquence 0 * * * * (toutes les heures, à l'heure pile)
    Fuseau horaire Sélectionnez un fuseau horaire (UTC recommandé).
    Type de cible Pub/Sub
    Sujet Sélectionnez le thème (snipeit-assets-trigger).
    Corps du message {} (objet JSON vide)

  4. 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 (recommandé)
    Toutes les 6 heures 0 */6 * * * Traitement par lot à faible volume
    Tous les jours 0 0 * * * Collecte de données historiques

Tester le job du planificateur

  1. Dans la console Cloud Scheduler, recherchez votre job.
  2. Cliquez sur Exécuter de force pour déclencher manuellement.
  3. Patientez quelques secondes, puis accédez à Cloud Run > Services > snipeit-assets-to-gcs > Journaux.
  4. Vérifiez que la fonction s'est exécutée correctement.
  5. 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

  1. Accédez à Paramètres SIEM> Flux.
  2. Cliquez sur Ajouter un flux.
  3. Cliquez sur Configurer un flux unique.
  4. Dans le champ Nom du flux, saisissez un nom pour le flux (par exemple, Snipe-IT logs).
  5. Sélectionnez Google Cloud Storage V2 comme Type de source.
  6. Sélectionnez Snipe-IT comme Type de journal.

  7. 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.com

  8. Copiez cette adresse e-mail pour l'utiliser à l'étape suivante.

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.

  1. Accédez à Cloud Storage > Buckets.
  2. Cliquez sur le nom de votre bucket.
  3. Accédez à l'onglet Autorisations.
  4. Cliquez sur Accorder l'accès.
  5. 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.

  6. Cliquez sur Enregistrer.

Configurer un flux dans Google SecOps pour ingérer les journaux Snipe-IT

  1. Accédez à Paramètres SIEM> Flux.
  2. Cliquez sur Ajouter un flux.
  3. Cliquez sur Configurer un flux unique.
  4. Dans le champ Nom du flux, saisissez un nom pour le flux (par exemple, Snipe-IT logs).
  5. Sélectionnez Google Cloud Storage V2 comme Type de source.
  6. Sélectionnez Snipe-IT comme Type de journal.
  7. Cliquez sur Suivant.

  8. 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://snipe-it-logs/snipeit/assets/

      • Remplacez :

        • snipe-it-logs : nom de votre bucket GCS.
        • snipeit/assets : préfixe/chemin d'accès au dossier dans lequel les journaux sont stockés.

    • 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. 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.

  9. Cliquez sur Suivant.

  10. Vérifiez la configuration de votre nouveau flux sur l'écran Finaliser, puis cliquez sur Envoyer.

Table de mappage UDM

Champ du journal Mappage UDM Logique
created_at.datetime entity.asset.attribute.creation_time Analysé en tant que UNIX_MS
age entity.asset.attribute.labels.value Mappé directement
alt_barcode entity.asset.attribute.labels.value Mappé directement
asset_eol_date entity.asset.attribute.labels.value Mappé directement
asset_tag entity.asset.attribute.labels.value Mappé directement
asset_type_value entity.asset.attribute.labels.value Mappé directement
assets_classification_value entity.asset.attribute.labels.value Mappé directement
category.id entity.asset.attribute.labels.value Mappé directement
custom_fields.RAM.value entity.asset.attribute.labels.value Mappé directement
custom_fields.SSD.value entity.asset.attribute.labels.value Mappé directement
last_update_time.formatted entity.asset.attribute.labels.value Mappé directement
manufacturer.id entity.asset.attribute.labels.value Mappé directement
model_id entity.asset.attribute.labels.value Mappé directement
model_number entity.asset.attribute.labels.value Mappé directement
updated_at.datetime entity.asset.attribute.last_update_time Analysé en tant que UNIX_MS
category.name entity.asset.category Mappé directement
custom_fields.Processor.value entity.asset.hardware.cpu_model Mappé directement
manufacturer.name entity.asset.hardware.manufacturer Mappé directement
model.name entity.asset.hardware.model Mappé directement
serial entity.asset.hardware.serial_number Mappé directement
name entity.asset.hostname Mappé directement
location.name entity.asset.location.name Mappé directement
id entity.asset.product_object_id Mappé directement
custom_fields.Owner.value entity.labels.value Mappé directement
deleted_at entity.labels.value Mappé directement
eol entity.labels.value Mappé directement
expected_checkin entity.labels.value Mappé directement
image entity.labels.value Mappé directement
last_audit_date entity.labels.value Mappé directement
next_audit_date.date entity.labels.value Mappé directement
notes entity.labels.value Mappé directement
order_number entity.labels.value Mappé directement
purchase_cost entity.labels.value Mappé directement
purchase_date.date entity.labels.value Mappé directement
purchase_date.formatted entity.labels.value Mappé directement
qr entity.labels.value Mappé directement
requestable entity.labels.value Mappé directement
requests_counter entity.labels.value Mappé directement
rtd_location.id entity.labels.value Mappé directement
status_label.id entity.labels.value Mappé directement
status_label.status_meta entity.labels.value Mappé directement
status_label.status_type entity.labels.value Mappé directement
supplier.id entity.labels.value Mappé directement
supplier.name entity.labels.value Mappé directement
updated_at.formatted entity.labels.value Mappé directement
warranty_expires.date entity.labels.value Mappé directement
warranty_expires.formatted entity.labels.value Mappé directement
warranty_months entity.labels.value Mappé directement
assigned_to.username entity.user.attribute.labels.value Mappé directement
available_actions.checkin entity.user.attribute.labels.value Mappé directement
available_actions.checkout entity.user.attribute.labels.value Mappé directement
available_actions.clone entity.user.attribute.labels.value Mappé directement
available_actions.delete entity.user.attribute.labels.value Mappé directement
available_actions.restore entity.user.attribute.labels.value Mappé directement
available_actions.update entity.user.attribute.labels.value Mappé directement
checkin_counter entity.user.attribute.labels.value Mappé directement
checkout_counter entity.user.attribute.labels.value Mappé directement
company.id entity.user.attribute.labels.value Mappé directement
created_by.id entity.user.attribute.labels.value Mappé directement
created_by.name entity.user.attribute.labels.value Mappé directement
last_checkin.datetime entity.user.attribute.labels.value Mappé directement
last_checkin.formatted entity.user.attribute.labels.value Mappé directement
last_checkout.formatted entity.user.attribute.labels.value Mappé directement
assigned_to.type entity.user.attribute.roles.name Mappé directement
company.name entity.user.company_name Mappé directement
assigned_to_email entity.user.email_addresses Fusionné
assigned_to.employee_number entity.user.employee_id Mappé directement
assigned_to.first_name entity.user.first_name Mappé directement
last_checkout.datetime entity.user.last_login_time Analysé en tant que UNIX_MS
assigned_to.last_name entity.user.last_name Mappé directement
assigned_to.name entity.user.user_display_name Mappé directement
assigned_to.id entity.user.userid Mappé directement
has_asset metadata.entity_type Mappé : true → ASSET
has_user metadata.entity_type Mappé : true → USER
has_asset metadata.product_name Mappé : true → CMDB
has_user metadata.product_name Mappé : true → CMDB
has_asset metadata.vendor_name Mappé : true → Snipe-IT
has_user metadata.vendor_name Mappé : true → Snipe-IT
N/A entity.asset.attribute.labels.key Constante : model_id
N/A entity.asset.platform_software.platform Constante : WINDOWS
N/A entity.labels.key Constante : purchase_date
N/A entity.user.attribute.labels.key Constante : checkout
N/A metadata.entity_type Constante : ASSET
N/A metadata.product_name Constante : CMDB
N/A metadata.vendor_name Constante : Snipe-IT

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.