Recopila registros de Virtru Email Encryption
En este documento, se explica cómo transferir registros de Virtru Email Encryption a Google Security Operations con Google Cloud Storage V2.
Virtru Email Encryption es una plataforma de encriptación de correo electrónico de extremo a extremo con control de acceso, prevención de pérdida de datos y registro de auditoría para las comunicaciones empresariales. Una función de Cloud Run sondea la API de Virtru Audit de forma programada, escribe registros en un bucket de GCS en formato NDJSON y Google SecOps los transfiere a través de un feed de GCS V2.
Antes de comenzar
Asegúrate de cumplir con los siguientes requisitos:
- 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 al panel de Virtru con permisos de administrador
Crea un bucket de Google Cloud Storage
- Ve a la consola de Google Cloud.
- Selecciona tu proyecto o crea uno nuevo.
- En el menú de navegación, ve a Cloud Storage > Buckets.
- Haz clic en Crear bucket.
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, virtru-email-encryption-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 Haz clic en Crear.
Recopila las credenciales de la API de Virtru Email Encryption
Generar token de API
- Accede al panel de Virtru como administrador.
- Ve a Configuración > Claves de API.
- Haz clic en Generar clave de API.
- Ingresa una etiqueta para la clave (por ejemplo,
Google Security Operations Integration). - Copia y guarda los siguientes datos en una ubicación segura:
- Token de API: Es el token de portador de la API para la autenticación.
- Haz clic en Crear.
Verifica los permisos
Para verificar que la cuenta tenga los permisos necesarios, sigue estos pasos:
- Accede al panel de Virtru.
- Ve a Configuración > Claves de API.
- Si puedes ver la sección Claves de API y generar claves, tienes los permisos de administrador necesarios.
- Si no ves esta opción, comunícate con tu administrador de Virtru para que te otorgue acceso de administrador.
Prueba el acceso a la API
Prueba tus credenciales antes de continuar con la integración:
# Replace with your actual credentials API_TOKEN="your-api-token" # Test API access curl -v -H "Authorization: Bearer ${API_TOKEN}" \ "https://api.virtru.com/audit/api/messages?start=2024-01-01T00:00:00Z&end=2024-01-02T00:00:00Z&limit=1"
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
- En Google Cloud Console, ve a IAM y administración > Cuentas de servicio.
- Haz clic en Crear cuenta de servicio.
- Proporciona los siguientes detalles de configuración:
- Nombre de la cuenta de servicio: Ingresa
virtru-logs-collector-sa. - Descripción de la cuenta de servicio: Ingresa
Service account for Cloud Run function to collect Virtru Email Encryption logs.
- Nombre de la cuenta de servicio: Ingresa
- Haz clic en Crear y continuar.
- En la sección Otorga acceso al proyecto a esta cuenta de servicio, agrega los siguientes roles:
- Haz clic en Selecciona un rol.
- Busca y selecciona Administrador de objetos de Storage.
- Haz clic en + Agregar otro rol.
- Busca y selecciona Invocador de Cloud Run.
- Haz clic en + Agregar otro rol.
- Busca y selecciona Invocador de Cloud Functions.
- Haz clic en Continuar.
- 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:
- Ve a Cloud Storage > Buckets.
- Haz clic en el nombre de tu bucket (por ejemplo,
virtru-email-encryption-logs). - Ve a la pestaña Permisos.
- Haz clic en Otorgar acceso.
- Proporciona los siguientes detalles de configuración:
- Agregar entidades: Ingresa el correo electrónico de la cuenta de servicio (por ejemplo,
virtru-logs-collector-sa@your-project.iam.gserviceaccount.com). - Asignar roles: Selecciona Administrador de objetos de Storage.
- Agregar entidades: Ingresa el correo electrónico de la cuenta de servicio (por ejemplo,
- 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.
- En Google Cloud Console, ve a Pub/Sub > Temas.
- Haz clic en Crear tema.
- Proporciona los siguientes detalles de configuración:
- ID del tema: Ingresa
virtru-logs-trigger. - Deja el resto de la configuración con sus valores predeterminados.
- ID del tema: Ingresa
- 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 Virtru Audit y escribirlos en GCS.
- En Google Cloud Console, ve a Cloud Run.
- Haz clic en Crear servicio.
- Selecciona Función (usa un editor directo para crear una función).
En la sección Configurar, proporciona los siguientes detalles de configuración:
Parámetro de configuración Valor Nombre del servicio virtru-logs-collectorRegió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. En la sección Activador (opcional), haz lo siguiente:
- Haz clic en + Agregar activador.
- Selecciona Cloud Pub/Sub.
- En Selecciona un tema de Cloud Pub/Sub, elige el tema
virtru-logs-trigger. - Haz clic en Guardar.
En la sección Autenticación, haz lo siguiente:
- Selecciona Necesita autenticación.
- Verifica la Administración de identidades y accesos (IAM).
Desplázate hacia abajo y expande Contenedores, redes y seguridad.
Ve a la pestaña Seguridad:
- Cuenta de servicio: Selecciona la cuenta de servicio
virtru-logs-collector-sa.
- Cuenta de servicio: Selecciona la cuenta de servicio
Ve a la pestaña Contenedores:
- Haz clic en Variables y secretos.
- Haz clic en + Agregar variable para cada variable de entorno:
Nombre de la variable Valor de ejemplo Descripción GCS_BUCKETvirtru-email-encryption-logsNombre del bucket de GCS GCS_PREFIXvirtruPrefijo para los archivos de registro STATE_KEYvirtru/state.jsonRuta de acceso al archivo de estado VIRTRU_API_TOKENyour-api-tokenToken del portador de la API de Virtru MAX_RECORDS10000Cantidad máxima de registros por ejecución PAGE_SIZE500Registros por página LOOKBACK_HOURS24Período de visualización inicial En la pestaña Variables y secretos, desplázate hacia abajo hasta Solicitudes:
- Tiempo de espera de la solicitud: Ingresa
600segundos (10 minutos).
- Tiempo de espera de la solicitud: Ingresa
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.
- En la sección Recursos, haz lo siguiente:
Desplázate hacia abajo hasta Entorno de ejecución:
- Selecciona Predeterminado (recomendado).
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).
- Cantidad mínima de instancias: Ingresa
Haz clic en Crear.
Espera a que se cree el servicio (de 1 a 2 minutos).
Después de crear el servicio, se abrirá automáticamente el editor de código intercalado.
Agregar el código de función
- Ingresa main en Punto de entrada de la función.
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', 'virtru') STATE_KEY = os.environ.get('STATE_KEY', 'virtru/state.json') API_TOKEN = os.environ.get('VIRTRU_API_TOKEN') MAX_RECORDS = int(os.environ.get('MAX_RECORDS', '10000')) PAGE_SIZE = int(os.environ.get('PAGE_SIZE', '500')) LOOKBACK_HOURS = int(os.environ.get('LOOKBACK_HOURS', '24')) API_BASE = 'https://api.virtru.com' 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) @functions_framework.cloud_event def main(cloud_event): """ Cloud Run function triggered by Pub/Sub to fetch Virtru Email Encryption audit logs and write to GCS. Args: cloud_event: CloudEvent object containing Pub/Sub message """ if not all([GCS_BUCKET, API_TOKEN]): print('Error: Missing required environment variables') return try: bucket = storage_client.bucket(GCS_BUCKET) # Load state state = load_state(bucket, STATE_KEY) # Determine time window now = datetime.now(timezone.utc) last_time = None if isinstance(state, dict) and state.get("last_event_time"): try: last_time = parse_datetime(state["last_event_time"]) last_time = last_time - timedelta(minutes=2) except Exception as e: print(f"Warning: Could not parse last_event_time: {e}") if last_time is None: last_time = now - timedelta(hours=LOOKBACK_HOURS) print(f"Fetching logs from {last_time.isoformat()} to {now.isoformat()}") # Fetch logs records, newest_event_time = fetch_logs( start_time=last_time, end_time=now, page_size=PAGE_SIZE, 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}") # Update state with newest event time if newest_event_time: save_state(bucket, STATE_KEY, newest_event_time) else: 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(start_time: datetime, end_time: datetime, page_size: int, max_records: int): """ Fetch audit logs from Virtru API with pagination and rate limiting. Args: start_time: Start time for log query end_time: End time for log query page_size: Number of records per page max_records: Maximum total records to fetch Returns: Tuple of (records list, newest_event_time ISO string) """ endpoint = f"{API_BASE}/audit/api/messages" headers = { 'Authorization': f'Bearer {API_TOKEN}', 'Accept': 'application/json', 'User-Agent': 'GoogleSecOps-VirtruCollector/1.0' } records = [] newest_time = None page_num = 0 backoff = 1.0 offset = 0 while True: page_num += 1 if len(records) >= max_records: print(f"Reached max_records limit ({max_records})") break start_iso = start_time.strftime('%Y-%m-%dT%H:%M:%SZ') end_iso = end_time.strftime('%Y-%m-%dT%H:%M:%SZ') current_limit = min(page_size, max_records - len(records)) url = f"{endpoint}?start={start_iso}&end={end_iso}&limit={current_limit}&offset={offset}" try: response = http.request('GET', url, headers=headers) # Handle rate limiting with exponential backoff 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 [], None data = json.loads(response.data.decode('utf-8')) page_results = data if isinstance(data, list) else data.get('messages', data.get('data', [])) if not page_results: print(f"No more results (empty page)") break print(f"Page {page_num}: Retrieved {len(page_results)} events") records.extend(page_results) # Track newest event time for event in page_results: try: event_time = event.get('timestamp') or event.get('date') or event.get('created') if event_time: if newest_time is None or parse_datetime(event_time) > parse_datetime(newest_time): newest_time = event_time except Exception as e: print(f"Warning: Could not parse event time: {e}") # Check for more results if len(page_results) < page_size: print(f"Reached last page (size={len(page_results)} < limit={page_size})") break offset += len(page_results) except Exception as e: print(f"Error fetching logs: {e}") return [], None print(f"Retrieved {len(records)} total records from {page_num} pages") return records, newest_time- Segundo archivo: requirements.txt:
functions-framework==3.* google-cloud-storage==2.* urllib3>=2.0.0Haz clic en Implementar para guardar y, luego, implementar la función.
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.
- En Google Cloud Console, ve a Cloud Scheduler.
- Haz clic en Crear trabajo.
Proporciona los siguientes detalles de configuración:
Parámetro de configuración Valor Nombre virtru-logs-collector-hourlyRegió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 virtru-logs-trigger.Cuerpo del mensaje {}(objeto JSON vacío)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
- En la consola de Cloud Scheduler, busca tu trabajo (
virtru-logs-collector-hourly). - Haz clic en Forzar ejecución para activar la tarea de forma manual.
- Espera unos segundos y ve a Cloud Run > Servicios > virtru-logs-collector > Registros.
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 X records to gs://virtru-email-encryption-logs/virtru/logs_YYYYMMDD_HHMMSS.ndjson Successfully processed X recordsVerifica el bucket de GCS (
virtru-email-encryption-logs) para confirmar que se hayan escrito los registros.
Si ves errores en los registros, haz lo siguiente:
- HTTP 401: Verifica el token de la API en las variables de entorno.
- HTTP 403: Verifica que la cuenta tenga permisos de administrador en el panel de Virtru.
- HTTP 429: Límite de frecuencia: La función volverá a intentarlo automáticamente con retirada
- Faltan variables de entorno: Verifica que todas las variables requeridas estén configuradas.
Configura un feed en Google SecOps para transferir registros de Virtru Email Encryption
- Ve a Configuración > Administración de datos > Feeds. Si estás en una plataforma solo de SIEM, ve a Configuración > Feeds.
- Haz clic en Agregar feed nuevo.
- Haz clic en Configura un feed único.
- En el campo Nombre del feed, ingresa un nombre para el feed (por ejemplo,
Virtru Email Encryption Logs). - Selecciona Google Cloud Storage V2 como el Tipo de fuente.
- Selecciona Virtru Email Encryption como el Tipo de registro.
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.comCopia esta dirección de correo electrónico. la usarás en el próximo paso.
Haz clic en Siguiente.
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://virtru-email-encryption-logs/virtru/- Reemplaza:
virtru-email-encryption-logs: Es el nombre de tu bucket de GCS.virtru/: Es la ruta de acceso del prefijo o la carpeta en la que se almacenan los registros.
- Reemplaza:
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.
Haz clic en Siguiente.
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.
- Ve a Cloud Storage > Buckets.
- Haz clic en el nombre de tu bucket (
virtru-email-encryption-logs). - Ve a la pestaña Permisos.
- Haz clic en Otorgar acceso.
- 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.
Haz clic en Guardar.
Tabla de asignación de UDM
| Campo de registro | Asignación de UDM | Lógica |
|---|---|---|
audit_RecordId |
additional.fields |
Combinado |
audit_RecordType |
additional.fields |
Combinado |
objid_label |
additional.fields |
Combinado |
objtype_label |
additional.fields |
Combinado |
orgId_label |
additional.fields |
Combinado |
platform_label |
additional.fields |
Combinado |
attributelabel.value |
metadata.description |
Asignada directamente |
desc |
metadata.description |
Asignada directamente |
timestamp |
metadata.event_timestamp |
Analizado como ISO8601 |
has_principal |
metadata.event_type |
Asignado: true → STATUS_UPDATE |
has_user |
metadata.event_type |
Asignado: true → USER_UNCATEGORIZED |
eventMetaData.auditDataType |
metadata.product_event_type |
Asignada directamente |
id |
metadata.product_log_id |
Asignada directamente |
object.name |
network.email.subject |
Combinado |
email |
network.email.to |
Asignado: ^.+@.+$ → email |
clientInfo.userAgent |
network.http.parsed_user_agent |
Se cambió el nombre o se asignó |
clientInfo.userAgent |
network.http.user_agent |
Asignada directamente |
prin_host |
principal.asset.hostname |
Asignada directamente |
clientInfo.requestIp |
principal.asset.ip |
Combinado |
prin_ip |
principal.asset.ip |
Combinado |
actorattributes.value |
principal.group.email_addresses |
Combinado |
prin_host |
principal.hostname |
Asignada directamente |
clientInfo.requestIp |
principal.ip |
Combinado |
prin_ip |
principal.ip |
Combinado |
pid |
principal.process.pid |
Asignada directamente |
actor_attri_label |
principal.resource.attribute.labels |
Combinado |
actor.id |
principal.user.email_addresses |
Combinado |
object.name |
principal.user.email_addresses |
Combinado |
actor.id |
principal.user.user_display_name |
Asignada directamente |
action_label |
security_result.detection_fields |
Combinado |
action_result_label |
security_result.detection_fields |
Combinado |
attributelabel.value |
src.user.user_display_name |
Asignada directamente |
object.name |
target.file.full_path |
Asignada directamente |
attributelabel.value |
target.group.email_addresses |
Combinado |
attrikey |
target.group.email_addresses |
Asignado: virtru:data:org:1e148cd2-139d-4d27-9891-98f7275550a2:group → attributelabel.value |
attri_label |
target.resource.attribute.labels |
Combinado |
email |
target.user.email_addresses |
Asignado: ^.+@.+$ → email |
| N/A | metadata.event_type |
Constante: EMAIL_TRANSACTION |
| N/A | metadata.product_name |
Constante: virtru encrytion |
| N/A | metadata.vendor_name |
Constante: virtru |
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.