Collecter les journaux Smartsheet

Compatible avec :

Ce document explique comment ingérer des journaux Smartsheet dans Google Security Operations à l'aide de Google Cloud Storage.

Smartsheet est une plate-forme collaborative de gestion du travail qui propose des fonctionnalités de gestion de projet, de suivi des tâches et d'automatisation des workflows pour les équipes d'entreprise. L'API Event Reporting fournit des journaux d'audit couvrant plus de 100 types d'événements, y compris les actions utilisateur, l'accès aux données, les modifications de partage et les opérations administratives dans votre organisation Smartsheet.

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 pour créer des fonctions Cloud Run, des sujets Pub/Sub et des jobs Cloud Scheduler
  • Un forfait Smartsheet Enterprise avec le module complémentaire Event Reporting activé
  • Un compte administrateur système Smartsheet avec accès à l'API

Collecter les identifiants de l'API Smartsheet

Générer un jeton d'accès à l'API

  1. Connectez-vous à votre compte Smartsheet avec un compte administrateur système.
  2. En bas de la barre de navigation de gauche, sélectionnez votre compte (image de profil), puis accédez à Paramètres personnels.
  3. Accédez à l'onglet Accès à l'API.
  4. Cliquez sur Generate new access token (Générer un nouveau jeton d'accès).
  5. Saisissez un nom pour le jeton (par exemple, SecOps SIEM Integration).
  6. Cliquez sur OK.

  7. Copiez et enregistrez le jeton d'accès de manière sécurisée.

Vérifier les autorisations

Pour vérifier que le compte dispose des autorisations requises :

  1. Connectez-vous à votre compte Smartsheet.
  2. Accédez à Compte (image de profil) > Paramètres personnels > Accès à l'API.
  3. Si vous pouvez accéder à la page Gérer les jetons d'accès à l'API et générer des jetons, cela signifie que vous disposez des autorisations requises.
  4. Si vous n'avez pas accès à ces options, contactez votre administrateur système Smartsheet pour obtenir l'accès à l'API.

Tester l'accès à l'API

  • Testez vos identifiants avant de procéder à l'intégration :

    # Replace with your actual access token
SMARTSHEET_TOKEN="<your-access-token>"

# Test Event Reporting API access
curl -v -H "Authorization: Bearer ${SMARTSHEET_TOKEN}" \
  "https://api.smartsheet.com/2.0/events?since=$(date -u -d '1 hour ago' +%Y-%m-%dT%H:%M:%SZ)&maxCount=10"

Si vous rencontrez ces erreurs :

  • HTTP 401 : vérifiez que le jeton d'accès est correct.
  • HTTP 403 : vérifiez que le compte dispose des droits d'administrateur système et que le module complémentaire "Rapports sur les événements" est activé pour votre forfait.

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, smartsheet-audit-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 et être appelée par Pub/Sub.

Créer le 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 smartsheet-logs-sa.
    • Description du compte de service : saisissez Service account for Cloud Run function to collect Smartsheet audit logs.
  4. Cliquez sur Créer et continuer.
  5. Dans la section Autoriser ce compte de service à accéder au projet, ajoutez les rôles suivants :
    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 (par exemple, smartsheet-audit-logs).
  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, smartsheet-logs-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 smartsheet-logs-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 sera déclenchée par des messages Pub/Sub provenant de Cloud Scheduler pour extraire les journaux de l'API Smartsheet Event Reporting 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 smartsheet-logs-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, sélectionnez smartsheet-logs-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 smartsheet-logs-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 smartsheet-audit-logs
    GCS_PREFIX smartsheet/events/
    STATE_KEY smartsheet/events/state.json
    SMARTSHEET_TOKEN <your-smartsheet-access-token>
    MAX_COUNT 1000
    TIMEOUT 30

  10. Dans la section 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 la section Ressources :
      • Mémoire : sélectionnez 512 Mio ou plus.
      • CPU : sélectionnez 1.

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

  13. Cliquez sur Créer.

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

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

Ajouter le code de la 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 uuid
import gzip
import io

# 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', 'smartsheet/events/')
STATE_KEY = os.environ.get('STATE_KEY', 'smartsheet/events/state.json')
SMARTSHEET_TOKEN = os.environ.get('SMARTSHEET_TOKEN')
MAX_COUNT = int(os.environ.get('MAX_COUNT', '1000'))
TIMEOUT = int(os.environ.get('TIMEOUT', '30'))

EVENTS_URL = "https://api.smartsheet.com/2.0/events"

@functions_framework.cloud_event
def main(cloud_event):
  """
  Cloud Run function triggered by Pub/Sub to fetch Smartsheet
  Event Reporting audit logs and write to GCS.

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

  if not all([GCS_BUCKET, SMARTSHEET_TOKEN]):
    print('Error: Missing required environment variables')
    return

  try:
    bucket = storage_client.bucket(GCS_BUCKET)

    # Load state
    state = load_state(bucket, STATE_KEY)
    stream_position = state.get('stream_position')

    print(f'Fetching events from stream position: {stream_position or "latest"}')

    # Fetch events
    total_written = 0
    has_more = True

    while has_more:
      events, new_position, more = fetch_events(stream_position)

      if events:
        write_chunk(bucket, events, datetime.now(timezone.utc))
        total_written += len(events)

      if new_position:
        stream_position = new_position

      has_more = more and total_written < 50000

    # Save state
    state['stream_position'] = stream_position
    save_state(bucket, STATE_KEY, state)

    print(f'Successfully processed {total_written} events')

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

  return {}

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

def write_chunk(bucket, items, ts):
  """Write log chunk to GCS as compressed NDJSON."""
  key = f"{GCS_PREFIX}{ts:%Y/%m/%d}/smartsheet-events-{uuid.uuid4()}.json.gz"

  buf = io.BytesIO()
  with gzip.GzipFile(fileobj=buf, mode='w') as gz:
    for rec in items:
      gz.write((json.dumps(rec) + '\n').encode('utf-8'))

  buf.seek(0)
  blob = bucket.blob(key)
  blob.upload_from_file(buf, content_type='application/gzip')

  print(f'Wrote {len(items)} events to {key}')
  return key

def fetch_events(stream_position):
  """
  Fetch events from Smartsheet Event Reporting API.

  The API uses a streaming model with streamPosition for pagination.
  On first call (no streamPosition), it returns the current position
  without events. Subsequent calls return events since the position.

  Returns:
    Tuple of (events list, new stream position, has more data)
  """
  headers = {
    'Authorization': f'Bearer {SMARTSHEET_TOKEN}',
    'Accept': 'application/json'
  }

  params = [f'maxCount={MAX_COUNT}']
  if stream_position:
    params.append(f'streamPosition={stream_position}')

  url = f"{EVENTS_URL}?{'&'.join(params)}"

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

  if response.status == 429:
    retry_after = int(response.headers.get('Retry-After', '60'))
    print(f'Rate limited (429). Retry-After: {retry_after}s')
    import time
    time.sleep(min(retry_after, 120))
    return fetch_events(stream_position)

  if response.status != 200:
    print(f'API request failed: {response.status}')
    response_text = response.data.decode('utf-8')
    print(f'Response body: {response_text}')
    raise Exception(f'Failed to fetch events: {response.status}')

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

  events = data.get('data', []) or []
  new_position = data.get('nextStreamPosition')
  more_available = data.get('moreEventsAvailable', False)

  if events:
    print(f'Retrieved {len(events)} events')

  return events, new_position, more_available

    • 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 publiera des messages dans le sujet Pub/Sub à intervalles réguliers, ce qui déclenchera 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 smartsheet-logs-schedule-15min
    Région Sélectionnez la même région que la fonction Cloud Run.
    Fréquence */15 * * * * (toutes les 15 minutes)
    Fuseau horaire Sélectionnez un fuseau horaire (UTC recommandé).
    Type de cible Pub/Sub
    Sujet Sélectionner smartsheet-logs-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 * * * * Standard (recommandé)
Toutes les heures 0 * * * * Volume faible
Toutes les 6 heures 0 */6 * * * Traitement par lot

Tester l'intégration

  1. Dans la console Cloud Scheduler, recherchez votre job (par exemple, smartsheet-logs-schedule-15min).
  2. Cliquez sur Exécuter de force pour déclencher le job manuellement.
  3. Patientez quelques secondes.
  4. Accédez à Cloud Run > Services.
  5. Cliquez sur le nom de la fonction (smartsheet-logs-to-gcs).
  6. Cliquez sur l'onglet Journaux.

  7. Vérifiez que la fonction s'est exécutée correctement. Par exemple :

    Fetching events from stream position: <position>
Retrieved X events
Wrote X events to smartsheet/events/YYYY/MM/DD/smartsheet-events-UUID.json.gz
Successfully processed X events

  8. Accédez à Cloud Storage > Buckets.

  9. Cliquez sur le nom de votre bucket (smartsheet-audit-logs).

  10. Accédez au dossier de préfixe (smartsheet/events/).

  11. Vérifiez qu'un nouveau fichier .json.gz a été créé avec l'horodatage actuel.

Si des erreurs s'affichent dans les journaux :

  • HTTP 401 : vérifiez le jeton d'accès Smartsheet dans les variables d'environnement.
  • HTTP 403 : vérifiez que le compte dispose des droits d'administrateur système et que le reporting des événements est activé.
  • HTTP 429 : limitation du débit. La fonction effectuera automatiquement une nouvelle tentative avec un délai d'attente.
  • Variables d'environnement manquantes : vérifiez que toutes les variables requises sont définies dans la configuration de la fonction Cloud Run.

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.

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

  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, Smartsheet Audit Logs).
  5. Sélectionnez Google Cloud Storage V2 comme Type de source.
  6. Sélectionnez Smartsheet 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. Vous en aurez besoin lors de la tâche suivante.

  9. Cliquez sur Suivant.

  10. 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://smartsheet-audit-logs/smartsheet/events/

    • Remplacez :

      • smartsheet-audit-logs : nom de votre bucket GCS.
      • smartsheet/events/ : chemin d'accès au préfixe où 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.

  11. Cliquez sur Suivant.

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

  1. Accédez à Cloud Storage > Buckets.
  2. Cliquez sur le nom de votre bucket (par exemple, smartsheet-audit-logs).
  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.

Table de mappage UDM

Champ de journal Mappage UDM Logique
accessLevel_label additional.fields Fusionné
appName_label additional.fields Fusionné
attachmentName_label additional.fields Fusionné
cellLinkSourceSheetId_label additional.fields Fusionné
dashboardName_label additional.fields Fusionné
folderName_label additional.fields Fusionné
formatType_label additional.fields Fusionné
includeAttachments_label additional.fields Fusionné
includeDiscussions_label additional.fields Fusionné
mergeType_label additional.fields Fusionné
rowCount_label additional.fields Fusionné
rowsMoved_label additional.fields Fusionné
sheetId_label additional.fields Fusionné
sheetName_label additional.fields Fusionné
sheetRowId_label additional.fields Fusionné
sourceFolderId_label additional.fields Fusionné
sourceObjectId_label additional.fields Fusionné
sourceSheetId_label additional.fields Fusionné
sourceType_label additional.fields Fusionné
tokenDisplayValue_label additional.fields Fusionné
tokenUserId_label additional.fields Fusionné
userId_label additional.fields Fusionné
workspaceId_label additional.fields Fusionné
additionalDetails.accessScopes metadata.description Mappé directement
additionalDetails_tokenExpirationTimestamp metadata.event_timestamp Analysé en tant que yyyy-MM-ddTHH:mm:ssZ
eventTimestamp metadata.event_timestamp Analysé en tant que yyyy-MM-ddTHH:mm:ssZ
has_principal metadata.event_type Mappé : true → USER_UNCATEGORIZED
accessTokenName metadata.product_log_id Mappé directement
eventId metadata.product_log_id Mappé directement
additionalDetails.appClientId principal.user.userid Mappé directement
requestUserId principal.user.userid Mappé directement
object_id security_result.about.labels Fusionné
source_label security_result.about.labels Fusionné
object_type security_result.about.resource.attribute.labels Fusionné
action security_result.action_details Mappé directement
userId target.user.userid Mappé directement
N/A metadata.event_type Constante : USER_UNCATEGORIZED

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.