Recopila registros de Snipe-IT

Se admite en los siguientes sistemas operativos:

En este documento, se explica cómo transferir registros de Snipe-IT a Google Security Operations con Google Cloud Storage. Snipe-IT es un sistema de administración de activos de TI de código abierto que hace un seguimiento del hardware, las licencias de software, los accesorios, los consumibles y otros activos de TI durante todo su ciclo de vida.

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
  • Acceso con privilegios al arrendatario de Snipe-IT

Recopila los requisitos previos de Snipe-IT (token de API y URL base)

  1. Accede a Snipe-IT.
  2. Abre el menú de usuario (avatar en la esquina superior derecha) y haz clic en Administrar claves de API.
  3. Haz clic en Create New Token:
    • Nombre/Etiqueta: Ingresa una etiqueta descriptiva (por ejemplo, Google SecOps export).
  4. Haz clic en Generar.
  5. Copia el token de API (solo se mostrará una vez). Guárdala de forma segura.
  6. Determina la URL base de tu API, que suele ser https://<your-domain>/api/v1.
    • Ejemplo: https://snipeit.example.com/api/v1

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 global único (por ejemplo, snipe-it-logs).
    Tipo de ubicación Elige según tus necesidades (regional, 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.

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.

Crea una 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 snipeit-assets-to-gcs-sa.
    • Descripción de la cuenta de servicio: Ingresa Service account for Cloud Run function to collect Snipe-IT logs.
  4. Haz clic en Crear y continuar.
  5. En la sección Otorga acceso al proyecto a esta cuenta de servicio, haz lo siguiente:
    1. Haz clic en Seleccionar 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.
  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, snipeit-assets-to-gcs-sa@PROJECT_ID.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 snipeit-assets-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 activos de hardware de la API de Snipe-IT y los escribe en GCS.

  1. En Google Cloud 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:

    Parámetro de configuración Valor
    Nombre del servicio snipeit-assets-to-gcs
    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 (snipeit-assets-trigger).
    4. Haz clic en Guardar.

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

    1. Selecciona Necesita autenticación.
    2. Verifica Identity and Access Management (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 (snipeit-assets-to-gcs-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 snipe-it-logs
    GCS_PREFIX snipeit/assets
    SNIPE_BASE_URL https://snipeit.example.com/api/v1
    SNIPE_API_TOKEN your-api-token
    PAGE_SIZE 500
    MAX_PAGES 200

  10. En la pestaña Variables y secretos, desplázate hacia abajo hasta 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.
    • Haz clic en Listo.

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

    • Selecciona Predeterminado (recomendado).

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

  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.

Agrega 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 urllib.parse

    # Initialize HTTP client
    http = urllib3.PoolManager()

    # Initialize Storage client
    storage_client = storage.Client()

    @functions_framework.cloud_event
    def main(cloud_event):
        """
        Cloud Run function triggered by Pub/Sub to fetch hardware assets from Snipe-IT 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', 'snipeit/assets')
        base_url = os.environ.get('SNIPE_BASE_URL', '').rstrip('/')
        token = os.environ.get('SNIPE_API_TOKEN')
        page_size = int(os.environ.get('PAGE_SIZE', '500'))
        max_pages = int(os.environ.get('MAX_PAGES', '200'))

        if not all([bucket_name, base_url, token]):
            print('Error: Missing required environment variables')
            return

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

            # Fetch and write pages
            ts = datetime.now(timezone.utc)
            offset = 0
            page = 0
            total = 0

            headers = {
                'Authorization': f'Bearer {token}',
                'Accept': 'application/json',
                'Content-Type': 'application/json'
            }

            while page < max_pages:
                # Fetch page from Snipe-IT API
                params = {
                    'limit': page_size,
                    'offset': offset,
                    'sort': 'id',
                    'order': 'asc'
                }
                qs = urllib.parse.urlencode(params)
                url = f"{base_url}/hardware?{qs}"

                print(f'Fetching page {page} from {url}')

                response = http.request('GET', url, headers=headers, timeout=60.0)

                if response.status != 200:
                    print(f'Error: API returned status {response.status}')
                    break

                data = json.loads(response.data.decode('utf-8'))

                # Get rows from response (Snipe-IT uses 'rows' field)
                rows = data.get('rows', [])
                total_available = data.get('total', 0)

                # Write page to GCS
                blob_name = f"{prefix}/{ts.strftime('%Y/%m/%d')}/snipeit-hardware-{page:05d}.json"
                blob = bucket.blob(blob_name)
                body = json.dumps(data, separators=(',', ':')).encode('utf-8')
                blob.upload_from_string(body, content_type='application/json')

                print(f'Wrote page {page} with {len(rows)} rows to {blob_name}')

                total += len(rows)

                # Check if we've reached the end
                # Snipe-IT returns empty rows array when no more data
                if len(rows) == 0:
                    print(f'No more results (empty rows array)')
                    break

                # Also check if we've fetched all available records
                if offset + len(rows) >= total_available:
                    print(f'Reached end of data (offset {offset + len(rows)} >= total {total_available})')
                    break

                page += 1
                offset += page_size

            print(f'Successfully processed {page + 1} pages with {total} total objects')

        except Exception as e:
            print(f'Error processing 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 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 snipeit-assets-to-gcs-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 (snipeit-assets-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 volumen y latencia de los 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 (recomendado)
    Cada 6 horas 0 */6 * * * Procesamiento por lotes de bajo volumen
    Diario 0 0 * * * Recopilación de datos históricos

Prueba el trabajo del programador

  1. En la consola de Cloud Scheduler, busca tu trabajo.
  2. Haz clic en Forzar ejecución para activar el DAG de forma manual.
  3. Espera unos segundos y ve a Cloud Run > Servicios > snipeit-assets-to-gcs > 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

Google SecOps usa 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 Add New Feed.
  3. Haz clic en Configura un feed único.
  4. En el campo Nombre del feed, ingresa un nombre para el feed (por ejemplo, Snipe-IT logs).
  5. Selecciona Google Cloud Storage V2 como el Tipo de fuente.
  6. Selecciona Snipe-IT como el Tipo de registro.

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

    chronicle-12345678@chronicle-gcp-prod.iam.gserviceaccount.com

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

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.
  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.
    • Asignar roles: Selecciona Visualizador de objetos de Storage.

  6. Haz clic en Guardar.

Configura un feed en Google SecOps para transferir registros de Snipe-IT

  1. Ve a Configuración de SIEM > Feeds.
  2. Haz clic en Add New Feed.
  3. Haz clic en Configura un feed único.
  4. En el campo Nombre del feed, ingresa un nombre para el feed (por ejemplo, Snipe-IT logs).
  5. Selecciona Google Cloud Storage V2 como el Tipo de fuente.
  6. Selecciona Snipe-IT 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://snipe-it-logs/snipeit/assets/

      • Reemplaza lo siguiente:

        • snipe-it-logs: Es el nombre de tu bucket de GCS.
        • snipeit/assets: Es el prefijo o la ruta de acceso a la carpeta en la que se almacenan los registros.

    • 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 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 transferencia: 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.

Tabla de asignación de UDM

Campo de registro Asignación de UDM Lógica
created_at.datetime entity.asset.attribute.creation_time Se analizó como UNIX_MS
age entity.asset.attribute.labels.value Asignada directamente
alt_barcode entity.asset.attribute.labels.value Asignada directamente
asset_eol_date entity.asset.attribute.labels.value Asignada directamente
asset_tag entity.asset.attribute.labels.value Asignada directamente
asset_type_value entity.asset.attribute.labels.value Asignada directamente
assets_classification_value entity.asset.attribute.labels.value Asignada directamente
category.id entity.asset.attribute.labels.value Asignada directamente
custom_fields.RAM.value entity.asset.attribute.labels.value Asignada directamente
custom_fields.SSD.value entity.asset.attribute.labels.value Asignada directamente
last_update_time.formatted entity.asset.attribute.labels.value Asignada directamente
manufacturer.id entity.asset.attribute.labels.value Asignada directamente
model_id entity.asset.attribute.labels.value Asignada directamente
model_number entity.asset.attribute.labels.value Asignada directamente
updated_at.datetime entity.asset.attribute.last_update_time Se analizó como UNIX_MS
category.name entity.asset.category Asignada directamente
custom_fields.Processor.value entity.asset.hardware.cpu_model Asignada directamente
manufacturer.name entity.asset.hardware.manufacturer Asignada directamente
model.name entity.asset.hardware.model Asignada directamente
serial entity.asset.hardware.serial_number Asignada directamente
name entity.asset.hostname Asignada directamente
location.name entity.asset.location.name Asignada directamente
id entity.asset.product_object_id Asignada directamente
custom_fields.Owner.value entity.labels.value Asignada directamente
deleted_at entity.labels.value Asignada directamente
eol entity.labels.value Asignada directamente
expected_checkin entity.labels.value Asignada directamente
image entity.labels.value Asignada directamente
last_audit_date entity.labels.value Asignada directamente
next_audit_date.date entity.labels.value Asignada directamente
notes entity.labels.value Asignada directamente
order_number entity.labels.value Asignada directamente
purchase_cost entity.labels.value Asignada directamente
purchase_date.date entity.labels.value Asignada directamente
purchase_date.formatted entity.labels.value Asignada directamente
qr entity.labels.value Asignada directamente
requestable entity.labels.value Asignada directamente
requests_counter entity.labels.value Asignada directamente
rtd_location.id entity.labels.value Asignada directamente
status_label.id entity.labels.value Asignada directamente
status_label.status_meta entity.labels.value Asignada directamente
status_label.status_type entity.labels.value Asignada directamente
supplier.id entity.labels.value Asignada directamente
supplier.name entity.labels.value Asignada directamente
updated_at.formatted entity.labels.value Asignada directamente
warranty_expires.date entity.labels.value Asignada directamente
warranty_expires.formatted entity.labels.value Asignada directamente
warranty_months entity.labels.value Asignada directamente
assigned_to.username entity.user.attribute.labels.value Asignada directamente
available_actions.checkin entity.user.attribute.labels.value Asignada directamente
available_actions.checkout entity.user.attribute.labels.value Asignada directamente
available_actions.clone entity.user.attribute.labels.value Asignada directamente
available_actions.delete entity.user.attribute.labels.value Asignada directamente
available_actions.restore entity.user.attribute.labels.value Asignada directamente
available_actions.update entity.user.attribute.labels.value Asignada directamente
checkin_counter entity.user.attribute.labels.value Asignada directamente
checkout_counter entity.user.attribute.labels.value Asignada directamente
company.id entity.user.attribute.labels.value Asignada directamente
created_by.id entity.user.attribute.labels.value Asignada directamente
created_by.name entity.user.attribute.labels.value Asignada directamente
last_checkin.datetime entity.user.attribute.labels.value Asignada directamente
last_checkin.formatted entity.user.attribute.labels.value Asignada directamente
last_checkout.formatted entity.user.attribute.labels.value Asignada directamente
assigned_to.type entity.user.attribute.roles.name Asignada directamente
company.name entity.user.company_name Asignada directamente
assigned_to_email entity.user.email_addresses Combinado
assigned_to.employee_number entity.user.employee_id Asignada directamente
assigned_to.first_name entity.user.first_name Asignada directamente
last_checkout.datetime entity.user.last_login_time Se analizó como UNIX_MS
assigned_to.last_name entity.user.last_name Asignada directamente
assigned_to.name entity.user.user_display_name Asignada directamente
assigned_to.id entity.user.userid Asignada directamente
has_asset metadata.entity_type Asignado: true → ASSET
has_user metadata.entity_type Asignado: true → USER
has_asset metadata.product_name Asignado: true → CMDB
has_user metadata.product_name Asignado: true → CMDB
has_asset metadata.vendor_name Asignado: true → Snipe-IT
has_user metadata.vendor_name Asignado: true → Snipe-IT
N/A entity.asset.attribute.labels.key Constante: model_id
N/A entity.asset.platform_software.platform Constante: WINDOWS
N/A entity.labels.key Constante: purchase_date
N/A entity.user.attribute.labels.key Constante: checkout
N/A metadata.entity_type Constante: ASSET
N/A metadata.product_name Constante: CMDB
N/A metadata.vendor_name Constante: Snipe-IT

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.