Recopila registros JSON de Box

Se admite en los siguientes sistemas operativos:

Google SecOps SIEM

En este documento, se explica cómo transferir registros JSON de Box a Google Security Operations con Google Cloud Storage. El analizador procesa los registros de eventos de Box en formato JSON y los asigna a un modelo de datos unificado (UDM). Extrae los campos pertinentes de los registros sin procesar, realiza transformaciones de datos, como cambiar el nombre y combinar, y enriquece los datos con información intermedia antes de generar los datos de eventos estructurados.

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 Box (Consola del administrador y Consola para desarrolladores)

Configura Box Developer Console (credenciales de cliente)

Accede a Box Developer Console.
Crea una app personalizada con autenticación de servidor (otorgamiento de credenciales de cliente).
Establece Application Access en App + Enterprise Access.
En Application Scopes, habilita Manage enterprise properties.
En Consola del administrador > Apps > Administrador de apps personalizadas, autoriza la app con el ID de cliente.
Copia y guarda el ID de cliente y el secreto del cliente en una ubicación segura.
Ve a Consola del administrador > Cuenta y facturación > Información de la cuenta.
Copia y guarda el ID de la empresa en una ubicación segura.

Crea un bucket de Google Cloud Storage

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

Configuración	Valor
Asigna un nombre a tu bucket	Ingresa un nombre global único (por ejemplo, `box-collaboration-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

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

En GCP 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 box-collaboration-collector-sa.
- Descripción de la cuenta de servicio: Ingresa Service account for Cloud Run function to collect Box Collaboration logs.
Haz clic en Crear y continuar.
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.
Haz clic en Continuar.
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:

Ve a Cloud Storage > Buckets.
Haz clic en el nombre de tu bucket.
Ve a la pestaña Permisos.
Haz clic en Otorgar acceso.
Proporciona los siguientes detalles de configuración:
- Agregar principales: Ingresa el correo electrónico de la cuenta de servicio (box-collaboration-collector-sa@PROJECT_ID.iam.gserviceaccount.com).
- Asignar roles: Selecciona Administrador de objetos de Storage.
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.

En GCP Console, ve a Pub/Sub > Temas.
Haz clic en Crear un tema.
Proporciona los siguientes detalles de configuración:
- ID del tema: Ingresa box-collaboration-trigger.
- Deja el resto de la configuración con sus valores predeterminados.
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 Box y escribirlos en GCS.

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

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

Configuración	Valor
Nombre del servicio	`box-collaboration-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.

En la sección Activador (opcional), haz lo siguiente:
1. Haz clic en + Agregar activador.
2. Selecciona Cloud Pub/Sub.
3. EnSelecciona un tema de Cloud Pub/Sub, elige el tema de Pub/Sub (box-collaboration-trigger).
4. Haz clic en Guardar.
En la sección Autenticación, haz lo siguiente:
1. Selecciona Solicitar autenticación.
2. VerificaIdentity and Access Management (IAM).
Nota: Pub/Sub controla automáticamente la autenticación cuando invoca la función.
Desplázate hacia abajo y expande Contenedores, redes y seguridad.
Ve a la pestaña Seguridad:
- Cuenta de servicio: Selecciona la cuenta de servicio (box-collaboration-collector-sa).

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
`GCS_BUCKET`	`box-collaboration-logs`
`GCS_PREFIX`	`box/collaboration/`
`STATE_KEY`	`box/collaboration/state.json`
`BOX_CLIENT_ID`	Ingresa el ID de cliente de Box
`BOX_CLIENT_SECRET`	Ingresa el secreto del cliente de Box
`BOX_ENTERPRISE_ID`	Ingresa el ID de la empresa de Box
`STREAM_TYPE`	`admin_logs_streaming`
`LIMIT`	`500`

En la sección Variables y Secrets, desplázate hacia abajo hasta Solicitudes:
- Tiempo de espera de la solicitud: Ingresa 600 segundos (10 minutos).
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.
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).
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
import base64

# 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()

TOKEN_URL = "https://api.box.com/oauth2/token"
EVENTS_URL = "https://api.box.com/2.0/events"

@functions_framework.cloud_event
def main(cloud_event):
    """
    Cloud Run function triggered by Pub/Sub to fetch Box enterprise events 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', 'box/collaboration/')
    state_key = os.environ.get('STATE_KEY', 'box/collaboration/state.json')

    client_id = os.environ.get('BOX_CLIENT_ID')
    client_secret = os.environ.get('BOX_CLIENT_SECRET')
    enterprise_id = os.environ.get('BOX_ENTERPRISE_ID')
    stream_type = os.environ.get('STREAM_TYPE', 'admin_logs_streaming')
    limit = int(os.environ.get('LIMIT', '500'))

    if not all([bucket_name, client_id, client_secret, enterprise_id]):
        print('Error: Missing required environment variables')
        return

    try:
        # Get GCS bucket
        bucket = storage_client.bucket(bucket_name)

        # Get OAuth token
        token = get_token(client_id, client_secret, enterprise_id)

        # Load state (stream position)
        state = load_state(bucket, state_key)
        stream_position = state.get('stream_position')

        print(f'Processing events from stream position: {stream_position}')

        total_events = 0
        idx = 0

        while True:
            # Fetch events page
            page = fetch_events(token, stream_type, limit, stream_position)
            entries = page.get('entries') or []

            if not entries:
                next_pos = page.get('next_stream_position') or stream_position
                if next_pos and next_pos != stream_position:
                    save_state(bucket, state_key, {'stream_position': next_pos})
                break

            # Write page to GCS
            timestamp = datetime.now(timezone.utc).strftime('%Y/%m/%d/%H%M%S')
            blob_name = f"{prefix}{timestamp}-box-events-{idx:03d}.json"
            blob = bucket.blob(blob_name)
            blob.upload_from_string(
                json.dumps(page, separators=(',', ':')),
                content_type='application/json'
            )

            idx += 1
            total_events += len(entries)
            stream_position = page.get('next_stream_position') or stream_position

            # Save state after each page
            if stream_position:
                save_state(bucket, state_key, {'stream_position': stream_position})

            # Break if fewer entries than limit (last page)
            if len(entries) < limit:
                break

        print(f'Successfully processed {total_events} events, final position: {stream_position}')

    except Exception as e:
        print(f'Error processing Box events: {str(e)}')
        raise

def get_token(client_id, client_secret, enterprise_id):
    """Get OAuth 2.0 access token using client credentials grant."""
    fields = {
        'grant_type': 'client_credentials',
        'client_id': client_id,
        'client_secret': client_secret,
        'box_subject_type': 'enterprise',
        'box_subject_id': enterprise_id
    }

    response = http.request(
        'POST',
        TOKEN_URL,
        fields=fields,
        headers={'Content-Type': 'application/x-www-form-urlencoded'}
    )

    token_data = json.loads(response.data.decode('utf-8'))
    return token_data['access_token']

def fetch_events(token, stream_type, limit, stream_position=None, timeout=60, max_retries=5):
    """Fetch events from Box API with retry logic."""
    params = {
        'stream_type': stream_type,
        'limit': str(limit),
        'stream_position': stream_position or 'now'
    }

    # Build query string
    query_string = '&'.join([f"{k}={v}" for k, v in params.items()])
    url = f"{EVENTS_URL}?{query_string}"

    attempt = 0
    backoff = 1.0

    while True:
        try:
            response = http.request(
                'GET',
                url,
                headers={'Authorization': f'Bearer {token}'},
                timeout=timeout
            )

            if response.status == 200:
                return json.loads(response.data.decode('utf-8'))
            elif response.status == 429 and attempt < max_retries:
                # Rate limited - retry with backoff
                retry_after = response.headers.get('Retry-After')
                delay = int(retry_after) if retry_after and retry_after.isdigit() else int(backoff)
                print(f'Rate limited, retrying after {delay} seconds')
                import time
                time.sleep(max(1, delay))
                attempt += 1
                backoff *= 2
                continue
            elif 500 <= response.status <= 599 and attempt < max_retries:
                # Server error - retry with backoff
                print(f'Server error {response.status}, retrying after {backoff} seconds')
                import time
                time.sleep(backoff)
                attempt += 1
                backoff *= 2
                continue
            else:
                raise Exception(f'Box API error: {response.status} {response.data.decode("utf-8")}')
        except Exception as e:
            if attempt < max_retries:
                print(f'Request error: {str(e)}, retrying after {backoff} seconds')
                import time
                time.sleep(backoff)
                attempt += 1
                backoff *= 2
                continue
            raise

def load_state(bucket, key):
    """Load state from GCS."""
    try:
        blob = bucket.blob(key)
        if blob.exists():
            state_data = blob.download_as_text()
            return json.loads(state_data)
    except Exception as e:
        print(f'Warning: Could not load state: {str(e)}')
    return {}

def save_state(bucket, key, state):
    """Save state to GCS."""
    try:
        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)}')

Segundo archivo: requirements.txt:

functions-framework==3.*
google-cloud-storage==2.*
urllib3>=2.0.0

Haz clic en Implementar para guardar y, luego, implementar la función.
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 publica mensajes en el tema de Pub/Sub a intervalos regulares, lo que activa la función de Cloud Run.

En GCP Console, ve a Cloud Scheduler.
Haz clic en Crear trabajo.

Proporciona los siguientes detalles de configuración:

Configuración	Valor
Nombre	`box-collaboration-schedule-15min`
Región	Selecciona la misma región que la función de Cloud Run
Frecuencia	`/15 * * *` (cada 15 minutos)
Zona horaria	Selecciona la zona horaria (se recomienda UTC)
Tipo de orientación	Pub/Sub
Tema	Selecciona el tema de Pub/Sub (`box-collaboration-trigger`).
Cuerpo del mensaje	`{}` (objeto JSON vacío)

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 (recomendado)
Cada 1 hora	`0 * * * *`	Estándar
Cada 6 horas	`0 /6 * *`	Procesamiento por lotes y volumen bajo
Diario	`0 0 * * *`	Recopilación de datos históricos

Prueba la integración

En la consola de Cloud Scheduler, busca tu trabajo.
Haz clic en Forzar ejecución para activar el trabajo de forma manual.
Espera unos segundos.
Ve a Cloud Run > Servicios.
Haz clic en el nombre de tu función (box-collaboration-collector).
Haz clic en la pestaña Registros.

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

Processing events from stream position: ...
Page 1: Retrieved X events
Wrote X records to gs://box-collaboration-logs/box/collaboration/...
Successfully processed X events

Ve a Cloud Storage > Buckets.
Haz clic en el nombre de tu bucket.
Navega a la carpeta del prefijo (box/collaboration/).
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 de Check Box en las variables de entorno
HTTP 403: Verifica que la app de Box tenga los permisos necesarios y esté autorizada en la Consola del administrador
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

Ve a Configuración de SIEM > 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, Box Collaboration).
Selecciona Google Cloud Storage V2 como el Tipo de fuente.
Selecciona Box 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.com
```
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.

Ve a Cloud Storage > Buckets.
Haz clic en el nombre de tu bucket.
Ve a la pestaña Permisos.
Haz clic en Otorgar acceso.
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.
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 Box

Ve a Configuración de SIEM > 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, Box Collaboration).
Selecciona Google Cloud Storage V2 como el Tipo de fuente.
Selecciona Box como el Tipo de registro.
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://box-collaboration-logs/box/collaboration/
```
  - Reemplaza lo siguiente:
    - box-collaboration-logs: Es el nombre de tu bucket de GCS.
    - box/collaboration/: Es el prefijo o la ruta de acceso a la carpeta en la que se almacenan los registros.
  - Ejemplos:
    - Bucket raíz: gs://company-logs/
    - Con prefijo: gs://company-logs/box-logs/
    - Con subcarpeta: gs://company-logs/box/collaboration/
  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.
Haz clic en Siguiente.
Revisa la nueva configuración del feed en la pantalla Finalizar y, luego, haz clic en Enviar.

Tabla de asignación de UDM

Campo de registro	Asignación de UDM	Lógica
additional_details.ekm_id	additional.fields	Valor tomado de additional_details.ekm_id
additional_details.service_id	additional.fields	Valor que se toma de additional_details.service_id
additional_details.service_name	additional.fields	Es el valor que se toma de additional_details.service_name.
additional_details.shared_link_id	additional.fields	Valor tomado de additional_details.shared_link_id
additional_details.size	target.file.size	Valor tomado de additional_details.size
additional_details.version_id	additional.fields	Valor tomado de additional_details.version_id
created_at	metadata.event_timestamp	Valor tomado de created_at
created_by.id	principal.user.userid	Valor tomado de created_by.id
created_by.login	principal.user.email_addresses	Valor tomado de created_by.login
created_by.name	principal.user.user_display_name	Valor tomado de created_by.name
event_id	metadata.product_log_id	Valor tomado de event_id
event_type	metadata.product_event_type	Valor tomado de event_type
ip_address	principal.ip	Valor tomado de ip_address
source.item_id	target.file.product_object_id	Valor tomado de source.item_id
source.item_name	target.file.full_path	Valor tomado de source.item_name
source.item_type	Sin asignación
source.login	target.user.email_addresses	Valor tomado de source.login
source.name	target.user.user_display_name	Valor tomado de source.name
source.owned_by.id	target.user.userid	Valor tomado de source.owned_by.id
source.owned_by.login	target.user.email_addresses	Valor tomado de source.owned_by.login
source.owned_by.name	target.user.user_display_name	Valor tomado de source.owned_by.name
source.parent.id	Sin asignación
source.parent.name	Sin asignación
source.parent.type	Sin asignación
source.type	Sin asignación
tipo	metadata.log_type	Valor tomado del tipo
metadata.vendor_name		Valor codificado
metadata.product_name		Valor codificado
security_result.action		Se deriva de event_type. Si event_type es FAILED_LOGIN, se establece en BLOCK; si event_type es USER_LOGIN, se establece en ALLOW; de lo contrario, se establece en UNSPECIFIED.
extensions.auth.type		Se deriva de event_type. Si event_type es USER_LOGIN o ADMIN_LOGIN, entonces MACHINE; de lo contrario, UNSPECIFIED.
extensions.auth.mechanism		Se deriva de event_type. Si event_type es USER_LOGIN o ADMIN_LOGIN, entonces USERNAME_PASSWORD; de lo contrario, UNSPECIFIED.

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