Recopila registros de Saviynt Enterprise Identity Cloud

Compatible con:

En este documento, se explica cómo transferir registros de Saviynt Enterprise Identity Cloud (EIP) a Google Security Operations con Google Cloud Storage V2.

Saviynt Enterprise Identity Cloud (EIP) es una plataforma de administración de identidades y seguridad en la nube que se usa para la administración de accesos, la administración del ciclo de vida de las identidades y el cumplimiento. Genera datos de registro de auditoría para todas las actividades de seguridad que se realizan en el repositorio de identidades.

Antes de comenzar

Asegúrate de cumplir con los siguientes requisitos previos:

  • Una instancia de Google SecOps
  • Un proyecto de GCP con la API de Cloud Storage habilitada
  • Permisos para crear y administrar buckets de GCS
  • Permisos para administrar políticas de IAM en buckets de GCS
  • Permisos para crear servicios de Cloud Run, temas de Pub/Sub y trabajos de Cloud Scheduler
  • Acceso con privilegios a Saviynt EIP con permisos de administrador

Crea un bucket de Google Cloud Storage

  1. Ve a la consola de Google Cloud.
  2. Selecciona tu proyecto o crea uno nuevo.
  3. En el menú de navegación, ve a Cloud Storage > Buckets.
  4. Haz clic en Crear bucket.
  5. Proporciona los siguientes detalles de configuración:

    Parámetro de configuración Valor
    Asigna un nombre a tu bucket Ingresa un nombre único a nivel global (por ejemplo, saviynt-eip-logs).
    Tipo de ubicación Elige una en función de tus necesidades (región, birregional o multirregional).
    Ubicación Selecciona la ubicación (por ejemplo, us-central1).
    Clase de almacenamiento Estándar (recomendado para los registros a los que se accede con frecuencia)
    Control de acceso Uniforme (recomendado)
    Herramientas de protección Opcional: Habilita el control de versiones de objetos o la política de retención
  6. Haz clic en Crear.

Recopila las credenciales de la API de Saviynt EIP

Obtén credenciales de la API

  1. Accede a la consola de administración de Saviynt EIP.
  2. Ve a Administrador > Configuración > Conexiones.
  3. Crea o identifica un usuario de la API con los siguientes permisos:
    • webservice_api_authenticateUser
    • api_v5_fetchRuntimeControlsData
  4. Ten en cuenta los detalles siguientes:
    • Nombre de usuario: Es el nombre de usuario de la cuenta de usuario de la API.
    • Contraseña: Es la contraseña de la cuenta de usuario de la API.
    • URL del host de Saviynt: Es la URL de tu usuario de Saviynt (por ejemplo, https://YOUR_SAVIYNT_HOST).

Determina el nombre de las estadísticas

  1. En la Consola del administrador de Saviynt, ve a Admin > Runtime Controls.
  2. Anota el nombre de Analytics de los datos de auditoría que deseas exportar (por ejemplo, AuditTrailAnalytics).

Verifica los permisos

Para verificar que el usuario de la API tenga los permisos necesarios, sigue estos pasos:

  1. Accede a la consola de administración de Saviynt EIP.
  2. Ve a Administrador > Administración de usuarios.
  3. Haz clic en la cuenta de usuario de la API.
  4. Verifica que el usuario tenga los permisos de acceso webservice_api_authenticateUser y api_v5_fetchRuntimeControlsData.
  5. Si faltan permisos, comunícate con tu administrador de Saviynt.

Prueba el acceso a la API

  • Prueba tus credenciales antes de continuar con la integración:

    # Replace with your actual credentials
    SAVIYNT_HOST="https://YOUR_SAVIYNT_HOST"
    USERNAME="your-username"
    PASSWORD="your-password"
    
    # Get authentication token
    TOKEN=$(curl -s -X POST "${SAVIYNT_HOST}/ECM/api/login" \
      -H "Content-Type: application/json" \
      -d "{\"username\": \"${USERNAME}\", \"password\": \"${PASSWORD}\"}" \
      | jq -r '.access_token')
    
    # Test API access
    curl -v -H "Authorization: Bearer ${TOKEN}" \
      -H "Content-Type: application/json" \
      -X POST "${SAVIYNT_HOST}/ECM/api/v5/fetchRuntimeControlsDataV2" \
      -d '{"analyticsname": "YOUR_ANALYTICS_NAME", "timeFrame": 5}'
    

Crea una cuenta de servicio para la función de Cloud Run

La función de Cloud Run necesita una cuenta de servicio con permisos para escribir en el bucket de GCS y que Pub/Sub la invoque.

Crear cuenta de servicio

  1. En Google Cloud Console, ve a IAM y administración > Cuentas de servicio.
  2. Haz clic en Crear cuenta de servicio.
  3. Proporciona los siguientes detalles de configuración:
    • Nombre de la cuenta de servicio: Ingresa saviynt-eip-collector-sa.
    • Descripción de la cuenta de servicio: Ingresa Service account for Cloud Run function to collect Saviynt EIP logs.
  4. Haz clic en Crear y continuar.
  5. En la sección Otorga acceso al proyecto a esta cuenta de servicio, agrega los siguientes roles:
    1. Haz clic en Selecciona un rol.
    2. Busca y selecciona Administrador de objetos de Storage.
    3. Haz clic en + Agregar otro rol.
    4. Busca y selecciona Invocador de Cloud Run.
    5. Haz clic en + Agregar otro rol.
    6. Busca y selecciona Invocador de Cloud Functions.
  6. Haz clic en Continuar.
  7. Haz clic en Listo.

Estos roles son necesarios para lo siguiente:

  • Administrador de objetos de Storage: Escribe registros en el bucket de GCS y administra archivos de estado
  • Invocador de Cloud Run: Permite que Pub/Sub invoque la función
  • Invocador de Cloud Functions: Permite la invocación de funciones

Otorga permisos de IAM en el bucket de GCS

Otorga permisos de escritura a la cuenta de servicio en el bucket de GCS:

  1. Ve a Cloud Storage > Buckets.
  2. Haz clic en el nombre de tu bucket (por ejemplo, saviynt-eip-logs).
  3. Ve a la pestaña Permisos.
  4. Haz clic en Otorgar acceso.
  5. Proporciona los siguientes detalles de configuración:
    • Agregar entidades: Ingresa el correo electrónico de la cuenta de servicio (por ejemplo, saviynt-eip-collector-sa@your-project.iam.gserviceaccount.com).
    • Asignar roles: Selecciona Administrador de objetos de Storage.
  6. Haz clic en Guardar.

Crea un tema de Pub/Sub

Crea un tema de Pub/Sub en el que Cloud Scheduler publicará y al que se suscribirá la función de Cloud Run.

  1. En Google Cloud Console, ve a Pub/Sub > Temas.
  2. Haz clic en Crear tema.
  3. Proporciona los siguientes detalles de configuración:
    • ID del tema: Ingresa saviynt-eip-trigger.
    • Deja el resto de la configuración con sus valores predeterminados.
  4. Haz clic en Crear.

Crea una función de Cloud Run para recopilar registros

La función de Cloud Run se activará con mensajes de Pub/Sub de Cloud Scheduler para recuperar registros de la API de Saviynt EIP y escribirlos en GCS.

  1. En Google Cloud Console, ve a Cloud Run.
  2. Haz clic en Crear servicio.
  3. Selecciona Función (usa un editor directo para crear una función).
  4. En la sección Configurar, proporciona los siguientes detalles de configuración:

    Parámetro de configuración Valor
    Nombre del servicio saviynt-eip-collector
    Región Selecciona la región que coincida con tu bucket de GCS (por ejemplo, us-central1).
    Tiempo de ejecución Selecciona Python 3.12 o una versión posterior.
  5. En la sección Activador (opcional), haz lo siguiente:

    1. Haz clic en + Agregar activador.
    2. Selecciona Cloud Pub/Sub.
    3. En Selecciona un tema de Cloud Pub/Sub, elige el tema saviynt-eip-trigger.
    4. Haz clic en Guardar.
  6. En la sección Autenticación, haz lo siguiente:

    1. Selecciona Necesita autenticación.
    2. Verifica la Administración de identidades y accesos (IAM).
  7. Desplázate hacia abajo y expande Contenedores, redes y seguridad.

  8. Ve a la pestaña Seguridad:

    • Cuenta de servicio: Selecciona la cuenta de servicio saviynt-eip-collector-sa.
  9. Ve a la pestaña Contenedores:

    1. Haz clic en Variables y secretos.
    2. Haz clic en + Agregar variable para cada variable de entorno:
    Nombre de la variable Valor de ejemplo Descripción
    GCS_BUCKET saviynt-eip-logs Nombre del bucket de GCS
    GCS_PREFIX saviynt Prefijo para los archivos de registro
    STATE_KEY saviynt/state.json Ruta de acceso al archivo de estado
    SAVIYNT_HOST https://YOUR_SAVIYNT_HOST URL del usuario de Saviynt
    SAVIYNT_USER your-api-username Nombre de usuario de la API
    SAVIYNT_PASS your-api-password Contraseña del usuario de la API
    ANALYTICS_NAME AuditTrailAnalytics Nombre del registro de Analytics
    TIMEFRAME_MINUTES 60 Es el período en minutos para cada consulta.
    MAX_RECORDS 10000 Cantidad máxima de registros por ejecución
    LOOKBACK_HOURS 24 Período de visualización inicial
  10. En la pestaña Variables y secretos, navega a la sección Solicitudes:

    • Tiempo de espera de la solicitud: Ingresa 600 segundos (10 minutos).
  11. Ve a la pestaña Configuración en Contenedores:

    • En la sección Recursos, haz lo siguiente:
      • Memoria: Selecciona 512 MiB o más.
      • CPU: Selecciona 1.
  12. En la sección Escalamiento de revisión, haz lo siguiente:

    • Cantidad mínima de instancias: Ingresa 0.
    • Cantidad máxima de instancias: Ingresa 100 (o ajusta según la carga esperada).
  13. Haz clic en Crear.

  14. Espera a que se cree el servicio (de 1 a 2 minutos).

  15. Después de crear el servicio, se abrirá automáticamente el editor de código intercalado.

Agregar el código de función

  1. Ingresa main en Punto de entrada de la función.
  2. En el editor de código intercalado, crea dos archivos:

    • Primer archivo 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', 'saviynt')
      STATE_KEY = os.environ.get('STATE_KEY', 'saviynt/state.json')
      SAVIYNT_HOST = os.environ.get('SAVIYNT_HOST', '').rstrip('/')
      SAVIYNT_USER = os.environ.get('SAVIYNT_USER', '')
      SAVIYNT_PASS = os.environ.get('SAVIYNT_PASS', '')
      ANALYTICS_NAME = os.environ.get('ANALYTICS_NAME', '')
      TIMEFRAME_MINUTES = int(os.environ.get('TIMEFRAME_MINUTES', '60'))
      MAX_RECORDS = int(os.environ.get('MAX_RECORDS', '10000'))
      LOOKBACK_HOURS = int(os.environ.get('LOOKBACK_HOURS', '24'))
      
      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)
      
      def get_token():
        """Get authentication token from Saviynt login API."""
        login_url = f"{SAVIYNT_HOST}/ECM/api/login"
      
        body = json.dumps({
          "username": SAVIYNT_USER,
          "password": SAVIYNT_PASS
        })
      
        headers = {
          'Content-Type': 'application/json',
          'Accept': 'application/json'
        }
      
        backoff = 1.0
        max_retries = 3
      
        for attempt in range(max_retries):
          response = http.request('POST', login_url, body=body.encode('utf-8'), headers=headers)
      
          if response.status == 429:
            retry_after = int(response.headers.get('Retry-After', str(int(backoff))))
            print(f"Rate limited (429) on login request. Retrying after {retry_after}s...")
            time.sleep(retry_after)
            backoff = min(backoff * 2, 30.0)
            continue
      
          if response.status != 200:
            raise RuntimeError(f"Failed to authenticate: {response.status} - {response.data.decode('utf-8')}")
      
          data = json.loads(response.data.decode('utf-8'))
          return data['access_token']
      
        raise RuntimeError(f"Failed to get token after {max_retries} retries due to rate limiting")
      
      @functions_framework.cloud_event
      def main(cloud_event):
        """
        Cloud Run function triggered by Pub/Sub to fetch Saviynt EIP logs and write to GCS.
      
        Args:
          cloud_event: CloudEvent object containing Pub/Sub message
        """
      
        if not all([GCS_BUCKET, SAVIYNT_HOST, SAVIYNT_USER, SAVIYNT_PASS, ANALYTICS_NAME]):
          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)
      
          print(f"Fetching audit logs with analytics={ANALYTICS_NAME}, timeFrame={TIMEFRAME_MINUTES}")
      
          # Get access token
          token = get_token()
      
          # Fetch logs
          records = fetch_logs(
            token=token,
            analytics_name=ANALYTICS_NAME,
            timeframe_minutes=TIMEFRAME_MINUTES,
            max_records=MAX_RECORDS,
          )
      
          if not records:
            print("No new log 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 gs://{GCS_BUCKET}/{object_key}")
      
          save_state(bucket, STATE_KEY, now.isoformat())
          print(f"Successfully processed {len(records)} records")
      
        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_event_time_iso: str):
        """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_logs(token: str, analytics_name: str, timeframe_minutes: int, max_records: int):
        """
        Fetch audit logs from Saviynt fetchRuntimeControlsDataV2 API with rate limiting.
      
        Args:
          token: Authentication token
          analytics_name: Name of the analytics record
          timeframe_minutes: Timeframe in minutes for the query
          max_records: Maximum total records to fetch
      
        Returns:
          List of records
        """
        endpoint = f"{SAVIYNT_HOST}/ECM/api/v5/fetchRuntimeControlsDataV2"
      
        headers = {
          'Authorization': f'Bearer {token}',
          'Content-Type': 'application/json',
          'Accept': 'application/json',
          'User-Agent': 'GoogleSecOps-SaviyntCollector/1.0'
        }
      
        body = json.dumps({
          "analyticsname": analytics_name,
          "timeFrame": timeframe_minutes
        })
      
        backoff = 1.0
        max_retries = 3
      
        for attempt in range(max_retries):
          try:
            response = http.request('POST', endpoint, body=body.encode('utf-8'), 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
      
            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 []
      
            data = json.loads(response.data.decode('utf-8'))
      
            # Saviynt returns results in a 'result' or 'results' key
            records = data.get('result', data.get('results', []))
      
            if isinstance(records, list):
              if len(records) > max_records:
                records = records[:max_records]
              print(f"Retrieved {len(records)} audit records")
              return records
            else:
              # If the response is a single object, wrap it
              print(f"Retrieved 1 audit record")
              return [records]
      
          except Exception as e:
            print(f"Error fetching logs: {e}")
            if attempt < max_retries - 1:
              time.sleep(backoff)
              backoff = min(backoff * 2, 30.0)
              continue
            return []
      
        return []
      
    • Segundo archivo requirements.txt:

      functions-framework==3.*
      google-cloud-storage==2.*
      urllib3>=2.0.0
      
  3. Haz clic en Implementar para guardar y, luego, implementar la función.

  4. Espera a que se complete la implementación (de 2 a 3 minutos).

Crea un trabajo de Cloud Scheduler

Cloud Scheduler publicará mensajes en el tema de Pub/Sub a intervalos regulares, lo que activará la función de Cloud Run.

  1. En Google Cloud Console, ve a Cloud Scheduler.
  2. Haz clic en Crear trabajo.
  3. Proporciona los siguientes detalles de configuración:

    Parámetro de configuración Valor
    Nombre saviynt-eip-collector-hourly
    Región Selecciona la misma región que la función de Cloud Run
    Frecuencia 0 * * * * (cada hora, en punto)
    Zona horaria Selecciona la zona horaria (se recomienda UTC)
    Tipo de objetivo Pub/Sub
    Tema Selecciona el tema saviynt-eip-trigger.
    Cuerpo del mensaje {} (objeto JSON vacío)
  4. Haz clic en Crear.

Opciones de frecuencia de programación

Elige la frecuencia según el volumen de registros y los requisitos de latencia:

Frecuencia Expresión cron Caso de uso
Cada 5 minutos */5 * * * * Alto volumen y baja latencia
Cada 15 minutos */15 * * * * Volumen medio
Cada 1 hora 0 * * * * Estándar (recomendado)
Cada 6 horas 0 */6 * * * Procesamiento por lotes de bajo volumen
Diario 0 0 * * * Recopilación de datos históricos

Prueba la integración

  1. En la consola de Cloud Scheduler, busca tu trabajo (saviynt-eip-collector-hourly).
  2. Haz clic en Forzar ejecución para activar la tarea de forma manual.
  3. Espera unos segundos y ve a Cloud Run > Servicios > saviynt-eip-collector > Registros.
  4. Verifica que la función se haya ejecutado correctamente. Busca lo siguiente:

    Fetching audit logs with analytics=AuditTrailAnalytics, timeFrame=60
    Retrieved X audit records
    Wrote X records to gs://saviynt-eip-logs/saviynt/logs_YYYYMMDD_HHMMSS.ndjson
    Successfully processed X records
    
  5. Verifica el bucket de GCS (saviynt-eip-logs) para confirmar que se hayan escrito los registros.

Si ves errores en los registros, haz lo siguiente:

  • HTTP 401: Verifica las credenciales de la API en las variables de entorno.
  • HTTP 403: Verifica que el usuario de la API tenga los permisos necesarios en la consola de administración de Saviynt.
  • HTTP 429: Límite de frecuencia: La función volverá a intentarlo automáticamente con retirada
  • No se pudo autenticar: Verifica que SAVIYNT_HOST, SAVIYNT_USER y SAVIYNT_PASS sean correctos

Configura un feed en Google SecOps para transferir registros de Saviynt EIP

  1. Ve a Configuración > Administración de datos > Feeds. Si estás en una plataforma solo de SIEM, ve a Configuración > Feeds.
  2. Haz clic en Agregar feed nuevo.
  3. Haz clic en Configura un feed único.
  4. En el campo Nombre del feed, ingresa un nombre para el feed (por ejemplo, Saviynt EIP Logs).
  5. Selecciona Google Cloud Storage V2 como el Tipo de fuente.
  6. Selecciona Saviynt Enterprise Identity Cloud como el Tipo de registro.
  7. Haz clic en Obtener cuenta de servicio. Se mostrará un correo electrónico único de la cuenta de servicio, por ejemplo:

    chronicle-12345678@chronicle-gcp-prod.iam.gserviceaccount.com
    
  8. Copia esta dirección de correo electrónico. la usarás en el próximo paso.

  9. Haz clic en Siguiente.

  10. Especifica valores para los siguientes parámetros de entrada:

    • URL del bucket de almacenamiento: Ingresa el URI del bucket de GCS con la ruta de acceso del prefijo:

      gs://saviynt-eip-logs/saviynt/
      
      • Reemplaza:
        • saviynt-eip-logs: Es el nombre de tu bucket de GCS.
        • saviynt: Es el prefijo o la ruta de acceso de la carpeta opcional en la que se almacenan los registros (deja este campo vacío para la raíz).
    • Opción de eliminación del código fuente: Selecciona la opción de eliminación según tu preferencia:

      • Nunca: Nunca borra ningún archivo después de las transferencias (se recomienda para las pruebas).
      • Borrar archivos transferidos: Borra los archivos después de que se transfirieron correctamente.
      • Borrar los archivos transferidos y los directorios vacíos: Borra los archivos y los directorios vacíos después de que se transfirieron correctamente.

    • Antigüedad máxima del archivo: Incluye los archivos modificados en la última cantidad de días (el valor predeterminado es 180 días).

    • Espacio de nombres del recurso: Es el espacio de nombres del recurso.

    • Etiquetas de transferencia: Es la etiqueta que se aplicará a los eventos de este feed.

  11. Haz clic en Siguiente.

  12. Revisa la configuración de tu feed de noticias nuevo en la pantalla Finalizar y, luego, haz clic en Enviar.

Otorga permisos de IAM a la cuenta de servicio de Google SecOps

La cuenta de servicio de Google SecOps necesita el rol de visualizador de objetos de Storage en tu bucket de GCS.

  1. Ve a Cloud Storage > Buckets.
  2. Haz clic en el nombre de tu bucket (saviynt-eip-logs).
  3. Ve a la pestaña Permisos.
  4. Haz clic en Otorgar acceso.
  5. Proporciona los siguientes detalles de configuración:
    • Agregar entidades: Pega el correo electrónico de la cuenta de servicio de Google SecOps.
    • Asigna roles: Selecciona Visualizador de objetos de Storage.
  6. Haz clic en Guardar.

Tabla de asignación de UDM

Campo de registro Asignación de UDM Lógica
action_taken sr.action_details Detalles de la acción
categoría sr.category_details Detalles de la categoría
Message,message metadata.description Descripción del evento
metadata.event_type Tipo de evento
Tipo de objeto metadata.product_event_type Tipo de evento específico del producto
eventId metadata.product_log_id ID de registro del producto
Dirección IP principal.ip Dirección IP
consulta principal.process.command_line Línea de comandos del proceso
actionUri principal.url URL
accessed_by principal.user.email_addresses Direcciones de correo electrónico del usuario
accessed_by principal.user.userid ID de usuario
sr security_result Resultado de seguridad
metadata.product_name Nombre del producto
metadata.vendor_name Nombre del proveedor

Registro de cambios

Consulta el registro de cambios de este analizador

¿Necesitas más ayuda? Obtén respuestas de miembros de la comunidad y profesionales de Google SecOps.