Recopila registros del servicio Citrix Monitor

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 del servicio Citrix Monitor a Google Security Operations con Google Cloud Storage. El analizador transforma los registros sin procesar con formato JSON en un formato estructurado que cumple con el UDM de Google SecOps. Extrae los campos pertinentes del registro sin procesar, los asigna a los campos correspondientes del UDM y enriquece los datos con contexto adicional, como información del usuario, detalles de la máquina y actividad de la red.

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 funciones de Cloud Run, temas de Pub/Sub y trabajos de Cloud Scheduler
• Permisos para crear cuentas de servicio y administrar roles de IAM
• Acceso privilegiado al arrendatario de Citrix Cloud
• Credenciales de la API de Citrix Cloud (ID de cliente, secreto de cliente, ID de cliente)

Recopila los requisitos previos del servicio Citrix Monitor

1. Accede a la consola de Citrix Cloud.
2. Ve a Identity and Access Management > API Access.
3. Haz clic en Crear cliente.

4. Copia y guarda en una ubicación segura los siguientes detalles:

   • ID de cliente
   • Client Secret (Secreto del cliente)
   • ID de cliente (visible en la consola de Citrix Cloud)
   • URL base de la API:
     • US/EU/AP-S: https://api.cloud.com
     • Japón: https://api.citrixcloud.jp
   Nota: Usa el extremo según la región geográfica que seleccionaste cuando accediste a los datos del servicio de supervisión de Citrix para DaaS: La región de EE.UU., la UE y AP-S usa https://api.cloud.com/monitorodata, y la región de Japón usa https://api.citrixcloud.jp/monitorodata.

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, citrix-monitor-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.

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 citrix-monitor-collector-sa.
   • Descripción de la cuenta de servicio: Ingresa Service account for Cloud Run function to collect Citrix Monitor Service logs.
4. Haz clic en Crear y continuar.
5. En la sección Otorga a esta cuenta de servicio acceso al proyecto, haz lo siguiente:
   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 (citrix-monitor-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 citrix-monitor-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 los mensajes de Pub/Sub de Cloud Scheduler para recuperar registros de la API de Citrix Monitor Service 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	citrix-monitor-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 (citrix-monitor-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 (citrix-monitor-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
   GCS_BUCKET	citrix-monitor-logs
   GCS_PREFIX	citrix_monitor
   STATE_KEY	citrix_monitor/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
   ENTITIES	Machines,Sessions,Connections,Applications,Users
   PAGE_SIZE	1000
   LOOKBACK_MINUTES	75
   USE_TIME_FILTER	true

10. En la pestaña Variables y Secrets, desplázate hacia abajo hasta Requests:

    • 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.
    • Haz clic en Listo.

12. Desplázate hasta Entorno de ejecución:

    • Selecciona Predeterminado (recomendado).

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

14. Haz clic en Crear.

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

16. 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, timedelta, timezone
   import uuid
   
   # Citrix Cloud OAuth2 endpoint template
   TOKEN_URL_TMPL = "{api_base}/cctrustoauth2/{customerid}/tokens/clients"
   DEFAULT_API_BASE = "https://api.cloud.com"
   MONITOR_BASE_PATH = "/monitorodata"
   
   # Initialize HTTP client
   http = urllib3.PoolManager()
   
   # Initialize Storage client
   storage_client = storage.Client()
   
   def http_post_form(url, data_dict):
       """POST form data to get authentication token."""
       encoded_data = urllib3.request.urlencode(data_dict)
       response = http.request(
           'POST',
           url,
           body=encoded_data,
           headers={
               'Accept': 'application/json',
               'Content-Type': 'application/x-www-form-urlencoded'
           }
       )
       return json.loads(response.data.decode('utf-8'))
   
   def http_get_json(url, headers):
       """GET JSON data from API endpoint."""
       response = http.request('GET', url, headers=headers)
       return json.loads(response.data.decode('utf-8'))
   
   def get_citrix_token(api_base, customer_id, client_id, client_secret):
       """Get Citrix Cloud authentication token."""
       url = TOKEN_URL_TMPL.format(
           api_base=api_base.rstrip('/'),
           customerid=customer_id
       )
       payload = {
           'grant_type': 'client_credentials',
           'client_id': client_id,
           'client_secret': client_secret
       }
       response = http_post_form(url, payload)
       return response['access_token']
   
   def build_entity_url(api_base, entity, filter_query=None, top=None):
       """Build OData URL with optional filter and pagination."""
       base = api_base.rstrip('/') + MONITOR_BASE_PATH + '/' + entity
       params = []
       if filter_query:
           # Encode filter query with safe characters for OData
           encoded_filter = urllib3.request.urlencode({'$filter': filter_query})[9:]  # Remove '$filter='
           params.append('$filter=' + encoded_filter)
       if top:
           params.append('$top=' + str(top))
       return base + ('?' + '&'.join(params) if params else '')
   
   def fetch_entity_rows(entity, start_iso=None, end_iso=None, page_size=1000, headers=None, api_base=DEFAULT_API_BASE):
       """Fetch entity data with optional time filtering and pagination."""
       first_url = None
       if start_iso and end_iso:
           filter_query = f"(ModifiedDate ge {start_iso} and ModifiedDate lt {end_iso})"
           first_url = build_entity_url(api_base, entity, filter_query, page_size)
       else:
           first_url = build_entity_url(api_base, entity, None, page_size)
   
       url = first_url
       while url:
           try:
               data = http_get_json(url, headers)
               items = data.get('value', [])
               for item in items:
                   yield item
               url = data.get('@odata.nextLink')
           except Exception as e:
               # If ModifiedDate filtering fails, fall back to unfiltered query
               if 'Bad Request' in str(e) and start_iso and end_iso:
                   print(f"ModifiedDate filter not supported for {entity}, falling back to unfiltered query")
                   url = build_entity_url(api_base, entity, None, page_size)
                   continue
               else:
                   raise
   
   def load_state(bucket, key):
       """Read the last processed timestamp from GCS state file."""
       try:
           blob = bucket.blob(key)
           if blob.exists():
               content = blob.download_as_text()
               state = json.loads(content)
               timestamp_str = state.get('last_hour_utc')
               if timestamp_str:
                   return datetime.fromisoformat(timestamp_str.replace('Z', '+00:00')).replace(tzinfo=None)
       except Exception as e:
           print(f"Warning: Could not load state: {str(e)}")
       return None
   
   def save_state(bucket, key, dt_utc):
       """Write the current processed timestamp to GCS state file."""
       state = {'last_hour_utc': dt_utc.isoformat() + 'Z'}
       blob = bucket.blob(key)
       blob.upload_from_string(
           json.dumps(state, separators=(',', ':')),
           content_type='application/json'
       )
   
   def write_ndjson_to_gcs(bucket, key, rows):
       """Write rows as NDJSON to GCS."""
       body_lines = []
       for row in rows:
           json_line = json.dumps(row, separators=(',', ':'), ensure_ascii=False)
           body_lines.append(json_line)
       body = '\n'.join(body_lines) + '\n'
       blob = bucket.blob(key)
       blob.upload_from_string(body, content_type='application/x-ndjson')
   
   @functions_framework.cloud_event
   def main(cloud_event):
       """
       Cloud Run function triggered by Pub/Sub to fetch Citrix Monitor Service logs 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_monitor').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', 'Machines,Sessions,Connections,Applications,Users').split(',') if e.strip()]
       page_size = int(os.environ.get('PAGE_SIZE', '1000'))
       lookback_minutes = int(os.environ.get('LOOKBACK_MINUTES', '75'))
       use_time_filter = os.environ.get('USE_TIME_FILTER', 'true').lower() == 'true'
   
       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)
   
           # Time window calculation
           now = datetime.utcnow()
           fallback_hour = (now - timedelta(minutes=lookback_minutes)).replace(minute=0, second=0, microsecond=0)
           last_processed = load_state(bucket, state_key)
           target_hour = (last_processed + timedelta(hours=1)) if last_processed else fallback_hour
           start_iso = target_hour.isoformat() + 'Z'
           end_iso = (target_hour + timedelta(hours=1)).isoformat() + 'Z'
   
           # Authentication
           token = get_citrix_token(api_base, customer_id, client_id, client_secret)
           headers = {
               'Authorization': f'CWSAuth bearer={token}',
               'Citrix-CustomerId': customer_id,
               'Accept': 'application/json',
               'Accept-Encoding': 'gzip, deflate, br',
               'User-Agent': 'citrix-monitor-gcs-collector/1.0'
           }
   
           total_records = 0
   
           # Process each entity type
           for entity in entities:
               rows_batch = []
               try:
                   entity_generator = fetch_entity_rows(
                       entity=entity,
                       start_iso=start_iso if use_time_filter else None,
                       end_iso=end_iso if use_time_filter else None,
                       page_size=page_size,
                       headers=headers,
                       api_base=api_base
                   )
   
                   for row in entity_generator:
                       # Store raw Citrix data directly for proper parser recognition
                       rows_batch.append(row)
   
                       # Write in batches to avoid memory issues
                       if len(rows_batch) >= 1000:
                           gcs_key = f"{prefix}/{entity}/year={target_hour.year:04d}/month={target_hour.month:02d}/day={target_hour.day:02d}/hour={target_hour.hour:02d}/part-{uuid.uuid4().hex}.ndjson"
                           write_ndjson_to_gcs(bucket, gcs_key, rows_batch)
                           total_records += len(rows_batch)
                           rows_batch = []
   
               except Exception as ex:
                   print(f"Error processing entity {entity}: {str(ex)}")
                   continue
   
               # Write remaining records
               if rows_batch:
                   gcs_key = f"{prefix}/{entity}/year={target_hour.year:04d}/month={target_hour.month:02d}/day={target_hour.day:02d}/hour={target_hour.hour:02d}/part-{uuid.uuid4().hex}.ndjson"
                   write_ndjson_to_gcs(bucket, gcs_key, rows_batch)
                   total_records += len(rows_batch)
   
           # Update state file
           save_state(bucket, state_key, target_hour)
   
           print(f"Successfully processed {total_records} records for hour {start_iso}")
           print(f"Entities processed: {', '.join(entities)}")
   
       except Exception as e:
           print(f'Error processing Citrix Monitor logs: {str(e)}')
           raise
   

   • 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 publica mensajes en el tema de Pub/Sub a intervalos regulares, lo que activa 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	citrix-monitor-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 (citrix-monitor-trigger).
   Cuerpo del mensaje	{} (objeto JSON vacío)

4. Haz clic en Crear.

Prueba el trabajo de Scheduler

1. En la consola de Cloud Scheduler, busca tu trabajo.
2. Haz clic en Forzar ejecución para activarlo de forma manual.
3. Espera unos segundos y ve a Cloud Run > Servicios > citrix-monitor-collector > Registros.
4. Verifica que la función se haya ejecutado correctamente.
5. Verifica el bucket de GCS para confirmar que se escribieron los registros.

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, Citrix Monitor Service logs).
5. Selecciona Google Cloud Storage V2 como el Tipo de fuente.
6. Selecciona Citrix Monitor 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:

   [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.
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 del servicio Citrix Monitor

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, Citrix Monitor Service logs).
5. Selecciona Google Cloud Storage V2 como el Tipo de fuente.
6. Selecciona Citrix Monitor 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://citrix-monitor-logs/citrix_monitor/
     

     • Reemplaza lo siguiente:

       • citrix-monitor-logs: Es el nombre de tu bucket de GCS.
       • citrix_monitor: Es el prefijo o la ruta de carpeta opcionales en los que se almacenan los registros (déjalo vacío para la raíz).
     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.