Recopila registros de PingOne Advanced Identity Cloud

Se admite en los siguientes sistemas operativos:

Google SecOps SIEM

Nota: Esta función está sujeta a las Condiciones de las Ofertas de Fase Previa a la DG de las Condiciones Específicas de Google Security Operations. Las características de la fase previa a la DG pueden tener asistencia limitada, y es posible que los cambios que se les realicen no sean compatibles con otras versiones de la fase previa a la DG. Para obtener más información, consulta los Lineamientos de los Servicios de Asistencia Técnica de Google SecOps y las Condiciones Específicas del Servicio de Google SecOps.

En este documento, se explica cómo transferir registros de PingOne Advanced Identity Cloud a Google Security Operations con Google Cloud Storage. PingOne Advanced Identity Cloud es una plataforma de administración de identidades y accesos que proporciona capacidades de autenticación, autorización y administración de usuarios para aplicaciones basadas en la nube.

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 privilegiado al arrendatario de PingOne Advanced Identity Cloud

Obtén la clave de API de PingOne y el FQDN del arrendatario

1. Accede a la Consola del administrador de Advanced Identity Cloud.
2. Haz clic en el ícono de usuario > Configuración del arrendatario.
3. En la pestaña Configuración global, haz clic en Registrar claves de API.
4. Haz clic en New Log API Key y proporciona un nombre para la clave.
5. Haga clic en Crear clave.
6. Copia y guarda los valores de api_key_id y api_key_secret en una ubicación segura. El valor api_key_secret no se vuelve a mostrar.
7. Haz clic en Listo.

8. Ve a Tenant Settings > Details y busca el FQDN de tu arrendatario (por ejemplo, example.tomcat.pingone.com).

   Nota: PingOne Advanced Identity Cloud conserva los registros de auditoría y depuración durante 30 días. La API no puede recuperar datos anteriores a este período de retención. Planifica la frecuencia de recopilación según corresponda.

Crea un bucket de Google Cloud Storage

1. Ve a Google Cloud Console.
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:

   Configuración	Valor
   Asigna un nombre a tu bucket	Ingresa un nombre global único (por ejemplo, pingone-aic-logs).
   Tipo de ubicación	Elige según tus necesidades (región, birregional, 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.

Crea una cuenta de servicio para la Cloud Run Function

La Cloud Run Function necesita una cuenta de servicio con permisos para escribir en el bucket de GCS y ser invocada por Pub/Sub.

Crear cuenta de servicio

1. En GCP 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 pingone-aic-collector-sa.
   • Descripción de la cuenta de servicio: Ingresa Service account for Cloud Run function to collect PingOne Advanced Identity Cloud logs.
4. Haz clic en Crear y continuar.
5. En la sección Otorga a esta cuenta de servicio acceso al proyecto, agrega los siguientes roles:
   1. Haz clic en Selecciona un rol.
   2. Busca y selecciona Administrador de objetos de almacenamiento.
   3. Haz clic en + Agregar otra función.
   4. Busca y selecciona Invocador de Cloud Run.
   5. Haz clic en + Agregar otra función.
   6. Busca y selecciona Cloud Functions Invoker.
6. Haz clic en Continuar.
7. Haz clic en Listo.

Estos roles son necesarios para las siguientes acciones:

• Administrador de objetos de almacenamiento: Escribe registros en el bucket de GCS y administra archivos de estado
• Invocador de Cloud Run: Permite que Pub/Sub invoque la función
• Cloud Functions Invoker: 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.
3. Ve a la pestaña Permisos.
4. Haz clic en Otorgar acceso.
5. Proporciona los siguientes detalles de configuración:
   • Agregar principales: Ingresa el correo electrónico de la cuenta de servicio (por ejemplo, pingone-aic-collector-sa@PROJECT_ID.iam.gserviceaccount.com).
   • Asignar roles: Selecciona Administrador de objetos de Storage.
6. Haz clic en Guardar.

Crear 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 GCP Console, ve a Pub/Sub > Temas.
2. Haz clic en Crear un tema.
3. Proporciona los siguientes detalles de configuración:
   • ID del tema: Ingresa pingone-aic-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 activa con mensajes de Pub/Sub de Cloud Scheduler para recuperar registros de la API de PingOne Advanced Identity Cloud y escribirlos en GCS.

1. En GCP Console, ve a Cloud Run.
2. Haz clic en Crear servicio.
3. Selecciona Función (usa un editor intercalado para crear una función).

4. En la sección Configurar, proporciona los siguientes detalles de configuración:

   Configuración	Valor
   Nombre del servicio	pingone-aic-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 de Pub/Sub (pingone-aic-trigger).
   4. Haz clic en Guardar.

6. En la sección Autenticación, haz lo siguiente:

   1. Selecciona Solicitar autenticación.
   2. Verifica Identity and Access Management (IAM).
   Nota: Pub/Sub controla automáticamente la autenticación cuando invoca la función.

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 (pingone-aic-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	pingone-aic-logs	Nombre del bucket de GCS
   GCS_PREFIX	pingone-aic/logs	Prefijo para los archivos de registro
   STATE_KEY	pingone-aic/logs/state.json	Ruta de acceso al archivo de estado
   AIC_TENANT_FQDN	example.tomcat.pingone.com	FQDN del arrendatario
   AIC_API_KEY_ID	your-api-key-id	ID de la clave de API
   AIC_API_SECRET	your-api-key-secret	Secret de clave de API
   SOURCES	am-everything,idm-everything	Fuentes de registros separadas por comas (consulta la nota a continuación)
   PAGE_SIZE	500	Registros por página
   MAX_PAGES	20	Cantidad máxima de páginas por ejecución
   LOOKBACK_SECONDS	3600	Período de visualización inicial

   Nota: El valor SOURCES que se muestra arriba contiene fuentes de registro predeterminadas comunes. Para descubrir todas las fuentes de registros disponibles para tu arrendatario, llama al extremo /monitoring/logs/sources. Las fuentes disponibles pueden incluir am-access, am-activity, am-authentication, am-core, idm-authentication, idm-core, idm-sync y otras. Configura la variable de entorno SOURCES con la lista separada por comas adecuada para tu implementación.

10. En la sección Variables y Secrets, desplázate hasta Requests:

    • Tiempo de espera de la solicitud: Ingresa 600 segundos (10 minutos).

11. Ve a la pestaña Configuración:

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

12. En la sección Ajuste de escala 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
   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()
   
   @functions_framework.cloud_event
   def main(cloud_event):
       """
       Cloud Run function triggered by Pub/Sub to fetch logs from PingOne Advanced Identity Cloud 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', 'pingone-aic/logs')
       state_key = os.environ.get('STATE_KEY', 'pingone-aic/logs/state.json')
   
       fqdn = os.environ.get('AIC_TENANT_FQDN', '').strip('/')
       api_key_id = os.environ.get('AIC_API_KEY_ID')
       api_key_secret = os.environ.get('AIC_API_SECRET')
   
       sources = [s.strip() for s in os.environ.get('SOURCES', 'am-everything,idm-everything').split(',') if s.strip()]
       page_size = min(int(os.environ.get('PAGE_SIZE', '500')), 1000)
       max_pages = int(os.environ.get('MAX_PAGES', '20'))
       lookback_seconds = int(os.environ.get('LOOKBACK_SECONDS', '3600'))
   
       if not all([bucket_name, fqdn, api_key_id, api_key_secret]):
           print('Error: Missing required environment variables')
           return
   
       try:
           # Get GCS bucket
           bucket = storage_client.bucket(bucket_name)
   
           # Load state
           state = load_state(bucket, state_key)
           state.setdefault('sources', {})
   
           summary = []
   
           for source in sources:
               last_ts = state['sources'].get(source, {}).get('last_ts')
               res = fetch_source(bucket, prefix, fqdn, api_key_id, api_key_secret, source, last_ts, page_size, max_pages, lookback_seconds)
   
               if res.get('newest_ts'):
                   state['sources'][source] = {'last_ts': res['newest_ts']}
   
               summary.append(res)
   
           # Save state
           save_state(bucket, state_key, state)
   
           print(f'Successfully processed logs: {json.dumps(summary)}')
   
       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 {'sources': {}}
   
   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 fetch_source(bucket, prefix, fqdn, api_key_id, api_key_secret, source, last_ts, page_size, max_pages, lookback_seconds):
       """Fetch logs for a specific source."""
       base_url = f"https://{fqdn}/monitoring/logs"
       now = time.time()
   
       begin_time = bounded_begin_time(last_ts, now, lookback_seconds)
   
       params = {
           'source': source,
           '_pageSize': str(page_size),
           '_sortKeys': 'timestamp',
           'beginTime': begin_time
       }
   
       headers = {
           'x-api-key': api_key_id,
           'x-api-secret': api_key_secret
       }
   
       pages = 0
       written = 0
       newest_ts = last_ts
       cookie = None
   
       while pages < max_pages:
           if cookie:
               params['_pagedResultsCookie'] = cookie
   
           # Build query string
           query_parts = [f"{k}={v}" for k, v in params.items()]
           query_string = '&'.join(query_parts)
           url = f"{base_url}?{query_string}"
   
           # Make request with retry logic
           data = http_get_with_retry(url, headers)
   
           # Write page to GCS
           write_page(bucket, prefix, data, source)
   
           # Process results
           results = data.get('result') or data.get('results') or []
           for item in results:
               t = item.get('timestamp') or item.get('payload', {}).get('timestamp')
               if t and (newest_ts is None or t > newest_ts):
                   newest_ts = t
   
           written += len(results)
           cookie = data.get('pagedResultsCookie')
           pages += 1
   
           if not cookie:
               break
   
       return {
           'source': source,
           'pages': pages,
           'written': written,
           'newest_ts': newest_ts
       }
   
   def http_get_with_retry(url, headers, timeout=60, max_retries=5):
       """Make HTTP GET request with retry logic."""
       attempt = 0
       backoff = 1.0
   
       while True:
           try:
               response = http.request('GET', url, headers=headers, timeout=timeout)
   
               if response.status == 429 and attempt < max_retries:
                   # Rate limited - check for X-RateLimit-Reset header
                   reset_header = response.headers.get('X-RateLimit-Reset')
                   if reset_header:
                       delay = max(1, int(reset_header) - int(time.time()))
                   else:
                       delay = int(backoff)
   
                   print(f'Rate limited, waiting {delay} seconds')
                   time.sleep(delay)
                   attempt += 1
                   backoff *= 2
                   continue
   
               if 500 <= response.status < 600 and attempt < max_retries:
                   print(f'Server error {response.status}, retrying in {backoff} seconds')
                   time.sleep(backoff)
                   attempt += 1
                   backoff *= 2
                   continue
   
               if response.status != 200:
                   raise Exception(f'HTTP {response.status}: {response.data.decode("utf-8")}')
   
               return json.loads(response.data.decode('utf-8'))
   
           except Exception as e:
               if attempt < max_retries:
                   print(f'Request failed: {str(e)}, retrying in {backoff} seconds')
                   time.sleep(backoff)
                   attempt += 1
                   backoff *= 2
                   continue
               raise
   
   def write_page(bucket, prefix, payload, source):
       """Write a page of logs to GCS."""
       ts = datetime.now(timezone.utc)
       blob_name = f"{prefix}/{ts.strftime('%Y/%m/%d/%H%M%S')}-pingone-aic-{source}.json"
   
       blob = bucket.blob(blob_name)
       blob.upload_from_string(
           json.dumps(payload, separators=(',', ':')),
           content_type='application/json'
       )
   
       print(f'Wrote logs to {blob_name}')
   
   def bounded_begin_time(last_ts, now, lookback_seconds):
       """Calculate begin time bounded by 24 hour limit."""
       twenty_four_h_ago = now - 24 * 3600
   
       if last_ts:
           try:
               # Parse ISO timestamp
               t_struct = time.strptime(last_ts[:19] + 'Z', '%Y-%m-%dT%H:%M:%SZ')
               t_epoch = int(time.mktime(t_struct))
           except Exception:
               t_epoch = int(now - lookback_seconds)
   
           begin_epoch = max(t_epoch, int(twenty_four_h_ago))
       else:
           begin_epoch = max(int(now - lookback_seconds), int(twenty_four_h_ago))
   
       return time.strftime('%Y-%m-%dT%H:%M:%SZ', time.gmtime(begin_epoch))
   

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

   Nota: La configuración del activador de Pub/Sub crea automáticamente las suscripciones y los permisos necesarios.

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 GCP Console, ve a Cloud Scheduler.
2. Haz clic en Crear trabajo.

3. Proporciona los siguientes detalles de configuración:

   Configuración	Valor
   Nombre	pingone-aic-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 orientación	Pub/Sub
   Tema	Selecciona el tema de Pub/Sub (pingone-aic-trigger).
   Cuerpo del mensaje	{} (objeto JSON vacío)

4. Haz clic en Crear.

Opciones de frecuencia de programación

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

  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 (opción recomendada)
  Cada 6 horas	0 */6 * * *	Procesamiento por lotes y volumen bajo
  Diario	0 0 * * *	Recopilación de datos históricos

Prueba la integración

1. En la consola de Cloud Scheduler, busca tu trabajo (pingone-aic-collector-hourly).
2. Haz clic en Forzar ejecución para activar el trabajo de forma manual.
3. Espera unos segundos.
4. Ve a Cloud Run > Servicios.
5. Haz clic en el nombre de la función (pingone-aic-collector).
6. Haz clic en la pestaña Registros.

7. Verifica que la función se haya ejecutado correctamente. Busca lo siguiente:

   Fetching logs from YYYY-MM-DDTHH:MM:SS+00:00 to YYYY-MM-DDTHH:MM:SS+00:00
   Page 1: Retrieved X events
   Wrote logs to gs://bucket-name/prefix/logs_YYYYMMDD_HHMMSS.json
   Successfully processed X records
   

8. Ve a Cloud Storage > Buckets.

9. Haz clic en el nombre de tu bucket (pingone-aic-logs).

10. Navega a la carpeta del prefijo (pingone-aic/logs/).

11. Verifica que se haya creado un archivo .json nuevo con la marca de tiempo actual.

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 la cuenta tenga los permisos necesarios
• HTTP 429: Limitación de frecuencia. La función volverá a intentarlo automáticamente con una espera exponencial.
• Faltan variables de entorno: Verifica que estén configuradas todas las variables requeridas.

Recupera la cuenta de servicio de Google SecOps

Las Operaciones de seguridad de Google usan una cuenta de servicio única para leer datos de tu bucket de GCS. Debes otorgar acceso a tu bucket a esta cuenta de servicio.

Obtén el correo electrónico de la cuenta de servicio

1. Ve a Configuración de SIEM > 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, PingOne Advanced Identity Cloud).
5. Selecciona Google Cloud Storage V2 como el Tipo de fuente.
6. Selecciona PingOne Advanced Identity Cloud como el Tipo de registro.

7. Haz clic en Obtener cuenta de servicio. Se muestra un correo electrónico único de la cuenta de servicio, por ejemplo:

   [e-mail]
   

8. Copia esta dirección de correo electrónico para usarla en el siguiente paso.

   Nota: Cada instancia de Google SecOps tiene una cuenta de servicio única. No uses cuentas de servicio de otros ejemplos o documentación.

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 almacenamiento en tu bucket de GCS.

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

6. Haz clic en Guardar.

   Nota: Si planeas usar la opción de eliminación "Borrar archivos transferidos" o "Borrar archivos transferidos y directorios vacíos", otorga el rol de Administrador de objetos de Storage en lugar del rol de Visualizador de objetos de Storage.

Configura un feed en Google SecOps para transferir registros de PingOne Advanced Identity Cloud

1. Ve a Configuración de SIEM > 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, PingOne Advanced Identity Cloud).
5. Selecciona Google Cloud Storage V2 como el Tipo de fuente.
6. Selecciona PingOne Advanced Identity Cloud como el Tipo de registro.
7. Haz clic en Siguiente.

8. 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://pingone-aic-logs/pingone-aic/logs/
     

     • Reemplaza lo siguiente:

       • pingone-aic-logs: Es el nombre de tu bucket de GCS.
       • pingone-aic/logs/: Es el prefijo o la ruta de acceso a la carpeta opcionales en los que se almacenan los registros.
     Nota: Siempre incluye la barra diagonal final (/) al final del URI.

   • Opción de borrado de la fuente: Selecciona la opción de borrado 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 la transferencia exitosa.

     • Borrar los archivos transferidos y los directorios vacíos: Borra los archivos y los directorios vacíos después de la transferencia exitosa.

       Nota: Si seleccionas una opción de eliminación, la cuenta de servicio debe tener el rol de administrador de objetos de Storage en lugar del rol de visualizador de objetos de Storage. Actualiza los permisos de IAM según corresponda.

   • Antigüedad máxima del archivo: Incluye los archivos modificados en la cantidad de días especificada. El valor predeterminado es de 180 días.

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

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

9. Haz clic en Siguiente.

10. Revisa la nueva configuración del feed en la pantalla Finalizar y, luego, haz clic en Enviar.

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