Recopila registros de NGINX

Compatible con:

Google SecOps SIEM

En este documento, se explica cómo transferir registros de NGINX a Google Security Operations con el agente de Bindplane.

NGINX es un servidor web y un proxy inverso que genera mensajes de syslog para eventos de acceso HTTP, eventos de error, actividad de autenticación e información de procesos. El analizador extrae campos de varios formatos de registro (syslog, JSON, registros de acceso) con patrones de grok y los asigna al modelo de datos unificado (UDM).

Antes de comenzar

Asegúrate de cumplir con los siguientes requisitos previos:

• Una instancia de Google SecOps
• Windows Server 2016 o posterior, o host de Linux con systemd
• Conectividad de red entre el agente de Bindplane y el servidor de NGINX
• Si se ejecuta detrás de un proxy, asegúrate de que los puertos del firewall estén abiertos según los requisitos del agente de Bindplane
• Acceso de administrador al host de NGINX

Obtén credenciales de Google SecOps para el agente de Bindplane

Para autenticar el agente de Bindplane en Google SecOps, elige uno de los siguientes métodos:

• Implementaciones nuevas: Usa la API de Chronicle (opción 1).
• Implementaciones heredadas: Sigue usando el archivo de autenticación de transferencia (opción 2) hasta que se descontinúe la API de Ingestion el 20 de julio de 2027.

Opción 1: Crea una cuenta de servicio para la API de Chronicle (recomendado)

1. Accede a la consola deGoogle Cloud y selecciona el proyecto de Google Cloud que está vinculado a tu instancia de Google SecOps.
2. Ve a IAM y administración > Cuentas de servicio.
3. Haga clic en Crear cuenta de servicio.
4. Proporciona los siguientes detalles de configuración:
   • Nombre de la cuenta de servicio: Ingresa un nombre para la cuenta (por ejemplo, bindplane-ingest).
   • Descripción de la cuenta de servicio: Ingresa una descripción (por ejemplo, Bindplane agent log ingestion).
5. Haz clic en Crear y continuar.
6. En la sección Otorga a esta cuenta de servicio acceso al proyecto, haz clic en Seleccionar un rol y elige Editor de Chronicle.
7. Haz clic en Continuar y, luego, en Listo.
8. Haz clic en la cuenta de servicio que creaste y, luego, ve a la pestaña Claves.
9. Haz clic en Agregar clave > Crear clave nueva.
10. Selecciona JSON y haz clic en Crear. El archivo de claves se descargará en tu computadora.
11. Guarda el archivo de claves como ingestion-auth.json en el directorio del recopilador de Bindplane (/opt/observiq-otel-collector/ingestion-auth.json en Linux o C:\Program Files\observIQ OpenTelemetry Collector\ingestion-auth.json en Windows) o actualiza creds_file_path en config.yaml para que coincida con la ruta de acceso en la que lo guardas.
12. Ve a IAM y administración > Configuración y copia el Número de proyecto. Lo necesitarás para la configuración del exportador.

Nota: La clave JSON es una credencial. Restringe el acceso al archivo en el host de Bindplane y rota la clave según la política de tu organización.

Opción 2: Descarga el archivo de autenticación de transferencia (heredado)

1. Accede a la consola de Google SecOps.
2. Ve a Configuración de SIEM > Agentes de recopilación.
3. Descarga el archivo de autenticación de transferencia.
4. Guarda el archivo de forma segura en el sistema en el que se instalará el agente de Bindplane.

Nota: Este archivo autentica al agente en la API de Ingestion heredada (malachiteingestion-pa.googleapis.com), que Google programó para que finalice el 20 de julio de 2027. Planifica cambiar a la opción 1 antes de esa fecha.

Obtén el ID de cliente de Google SecOps

1. Accede a la consola de Google SecOps.
2. Ve a Configuración de SIEM > Perfil.

3. Copia y guarda el ID de cliente de la sección Detalles de la organización.

   Nota: El ID de cliente es obligatorio para configurar el exportador del agente de Bindplane.

Instala el agente de Bindplane

Instala el agente de Bindplane en tu sistema operativo Windows o Linux según las siguientes instrucciones.

Instalación en Windows

1. Abre el símbolo del sistema o PowerShell como administrador.

2. Ejecuta el comando siguiente:

   msiexec /i "https://github.com/observIQ/bindplane-agent/releases/latest/download/observiq-otel-collector.msi" /quiet
   

3. Espera a que se complete la instalación.

4. Ejecuta el siguiente comando para verificar la instalación:

   sc query observiq-otel-collector
   

   El servicio debería mostrarse como RUNNING.

Instalación en Linux

1. Abre una terminal con privilegios de raíz o sudo.

2. Ejecuta el comando siguiente:

   sudo sh -c "$(curl -fsSlL https://github.com/observiq/bindplane-agent/releases/latest/download/install_unix.sh)" install_unix.sh
   

3. Espera a que se complete la instalación.

4. Ejecuta el siguiente comando para verificar la instalación:

   sudo systemctl status observiq-otel-collector
   

   El servicio debería mostrarse como active (running).

Recursos de instalación adicionales

Para obtener más opciones de instalación y solución de problemas, consulta la guía de instalación del agente de Bindplane.

Nota: La configuración del exportador de la API de Chronicle requiere la versión 1.106.0 o posterior del recopilador de Bindplane. Los comandos anteriores instalan la versión más reciente. Si vas a actualizar una instalación existente, actualiza el recopilador antes de cambiar la configuración.

Configura el agente de BindPlane para transferir syslog y enviarlo a Google SecOps

Ubica el archivo de configuración

• Linux:

  sudo nano /opt/observiq-otel-collector/config.yaml
  

• Windows:

  notepad "C:\Program Files\observIQ OpenTelemetry Collector\config.yaml"
  

Edita el archivo de configuración

• Reemplaza todo el contenido de config.yaml por la siguiente configuración:

  receivers:
    udplog:
      listen_address: "0.0.0.0:514"
  
  exporters:
    chronicle/nginx:
      protocol: https
      # Region of your instance, for example us, europe, asia-southeast1
      location: <LOCATION>
      # Project number of the Google Cloud project linked to the instance
      project: '<PROJECT_NUMBER>'
      compression: gzip
      creds_file_path: '/opt/observiq-otel-collector/ingestion-auth.json'
      customer_id: '<customer_id>'
      endpoint: chronicle.googleapis.com
      log_type: NGINX
      raw_log_field: body
  
  service:
    pipelines:
      logs/nginx_to_chronicle:
        receivers:
          - udplog
        exporters:
          - chronicle/nginx
  

Parámetros de configuración

Reemplaza los marcadores de posición que se indican más abajo:

• Configuración del receptor:

  • listen_address: Dirección IP y puerto para escuchar:
    • 0.0.0.0 para escuchar en todas las interfaces (recomendado)
    • El puerto 514 es el puerto estándar de syslog (requiere acceso raíz en Linux; usa 1514 para acceso no raíz).

• Configuración del exportador:

  • creds_file_path: Ruta de acceso completa al archivo de claves JSON de la cuenta de servicio (opción 1):
    • Linux: /opt/observiq-otel-collector/ingestion-auth.json
    • Windows: C:\Program Files\observIQ OpenTelemetry Collector\ingestion-auth.json
  • customer_id: ID de cliente copiado de la consola de Google SecOps
  • location: Reemplaza <LOCATION> por la región de tu instancia de Google SecOps (por ejemplo, us, europe o asia-southeast1). El exportador antepone chronicle.googleapis.com con este valor. Consulta Extremos regionales para obtener la lista completa.
  • project: Reemplaza <PROJECT_NUMBER> por el número de proyecto de IAM y administración > Configuración.
  • endpoint: Mantén la configuración como chronicle.googleapis.com.

Exportador de la API de transferencia heredada

• Si usas el archivo de autenticación de transferencia de la opción 2, reemplaza el bloque exporters por lo siguiente. Establece creds_file_path en la ruta de acceso al archivo de autenticación de transferencia y, si tu instancia está fuera de EE.UU., reemplaza malachiteingestion-pa.googleapis.com por tu extremo regional (por ejemplo, europe-malachiteingestion-pa.googleapis.com).

  exporters:
    chronicle/nginx:
      compression: gzip
      creds_file_path: '/opt/observiq-otel-collector/ingestion-auth.json'
      customer_id: '<customer_id>'
      endpoint: malachiteingestion-pa.googleapis.com
      log_type: NGINX
      raw_log_field: body
  

Nota: Este exportador dejará de funcionar cuando se descontinúe la API de Ingestion el 20 de julio de 2027.

Guarda el archivo de configuración

• Después de editarlo, guarda el archivo:
  • Linux: Presiona Ctrl+O, luego Enter y, por último, Ctrl+X
  • Windows: Haz clic en Archivo > Guardar.

Reinicia el agente de Bindplane para aplicar los cambios.

• Para reiniciar el agente de Bindplane en Linux, ejecuta el siguiente comando:

  sudo systemctl restart observiq-otel-collector
  

  1. Verifica que el servicio esté en ejecución:

     sudo systemctl status observiq-otel-collector
     

  2. Revisa los registros en busca de errores:

     sudo journalctl -u observiq-otel-collector -f
     

• Para reiniciar el agente de Bindplane en Windows, elige una de las siguientes opciones:

  • Símbolo del sistema o PowerShell como administrador:

    net stop observiq-otel-collector && net start observiq-otel-collector
    

  • Consola de Servicios:

    1. Presiona Win+R, escribe services.msc y presiona Intro.
    2. Busca observIQ OpenTelemetry Collector.
    3. Haz clic con el botón derecho y selecciona Reiniciar.

    4. Verifica que el servicio esté en ejecución:

       sc query observiq-otel-collector
       

    5. Revisa los registros en busca de errores:

       type "C:\Program Files\observIQ OpenTelemetry Collector\log\collector.log"
       

Configura NGINX para reenviar registros a BindPlane

1. Abre el archivo de configuración de NGINX (por ejemplo, /etc/nginx/nginx.conf):

   sudo vi /etc/nginx/nginx.conf
   

2. Edita la configuración y reemplaza <BINDPLANE_SERVER> y <BINDPLANE_PORT> por tus valores:

   http {
       access_log syslog:server=<BINDPLANE_SERVER>:<BINDPLANE_PORT>,facility=local7,tag=nginx_access;
       error_log syslog:server=<BINDPLANE_SERVER>:<BINDPLANE_PORT>,facility=local7,tag=nginx_error;
   }
   

3. Reinicia NGINX para aplicar los cambios:

   sudo systemctl reload nginx
   

Tabla de asignación de UDM

Campo de registro	Asignación de UDM	Lógica
_Internal_WorkspaceResourceId	target.resource.product_object_id	Asignada directamente
Computer	principal.asset.hostname	Asignada directamente
Facility	additional.fields[facility]	Asignada directamente
HostName	principal.asset.hostname	Se asigna directamente si src_ip no está presente
ProcessName	principal.application	Asignada directamente
SeverityLevel	security_result.severity	Se asigna a INFORMATIONAL si el valor es info.
SourceSystem	principal.asset.platform	Se asigna a LINUX si el valor coincide con Linux.
SyslogMessage	Varios campos	Se analizó con Grok para extraer time, method, target_path, protocol, response_code, referral_url, user_agent, target_ip, target_host y cache.
TenantId	additional.fields[TenantId]	Asignada directamente
acct	principal.user.user_id	Se asigna directamente si no está vacío o es ?.
addr	principal.asset.ip	Asignada directamente
audit_epoch	metadata.event_timestamp	Se convierte en marca de tiempo con el formato UNIX. Los nanosegundos se extraen del mensaje de registro original.
cache	additional.fields[cache]	Asignada directamente
collection_time.nanos	metadata.event_timestamp.nanos	Se usa para los nanosegundos de la marca de tiempo del evento, si están disponibles.
collection_time.seconds	metadata.event_timestamp.seconds	Se usa para los segundos de la marca de tiempo del evento, si está disponible.
data	Varios campos	Es la fuente principal de datos, que se analiza de manera diferente según el formato de registro (Syslog, JSON o cualquier otro).
exe	target.process.command_line	Se asigna directamente después de quitar las barras inversas y las comillas
hostname	principal.asset.hostname O principal.asset.ip	Si es una dirección IP, se asigna a principal.asset.ip. De lo contrario, se asigna a principal.asset.hostname
msg	metadata.description	Se asignó directamente como la descripción
node	target.asset.hostname	Asignada directamente
pid	target.process.pid	Asignada directamente
protocol	network.application_protocol	Se asigna a HTTP si el valor coincide con HTTP
referral_url	network.http.referral_url	Se asigna directamente si no está vacío o es -.
res	security_result.action_details	Asignada directamente
response_code	network.http.response_code	Se asigna y convierte directamente en un número entero
ses	network.session_id	Asignada directamente
src_ip	principal.asset.ip	Asignada directamente
target_host	target.asset.hostname	Asignada directamente
target_ip	target.asset.ip	Se asigna directamente después de convertir la representación de cadena en un array JSON y, luego, extraer las IPs individuales.
target_path	target.url	Asignada directamente
time	metadata.event_timestamp	Se analiza para extraer la marca de tiempo con el formato dd/MMM/yyyy:HH:mm:ss Z
user_agent	network.http.user_agent	Se asigna directamente si no está vacío o es -
	metadata.event_type	Se establece en GENERIC_EVENT inicialmente y, luego, se reemplaza según otros campos, como terminal y protocol. El valor predeterminado es USER_UNCATEGORIZED si el patrón de Grok principal no coincide. Se establece en NETWORK_HTTP si protocol es HTTP y target_ip está presente, y en STATUS_UPDATE si protocol es HTTP, pero target_ip no está presente.
	metadata.log_type	Está establecido en NGINX.
	metadata.product_name	Está establecido en NGINX.
	metadata.vendor_name	Está establecido en NGINX.
	network.ip_protocol	Se establece en TCP si terminal es sshd o ssh, o si el patrón de grok principal no coincide.
	principal.asset_id	Se establece en GCP.GCE:0001 si terminal es sshd o ssh. Se establece en GCP.GCE:0002 si el patrón de grok principal no coincide.
	extensions.auth.type	Se establece en MACHINE si terminal es sshd o ssh.
log_hostname	event.idm.read_only_udm.principal.asset.hostname	Asignado desde el registro de cambios
ip_part	event.idm.read_only_udm.intermediary.ip	Asignado desde el registro de cambios
domain_part	event.idm.read_only_udm.intermediary.administrative_domain	Asignado desde el registro de cambios
location_part	event.idm.read_only_udm.intermediary.location.name	Asignado desde el registro de cambios
labels.compute_googleapis_com/resource_name	event.idm.read_only_udm.target.hostname	Asignado desde el registro de cambios
resource.labels.instance_id	event.idm.read_only_udm.target.resource.product_object_id	Asignado desde el registro de cambios
resource.labels.project_id	event.idm.read_only_udm.target.resource_ancestors.name	Asignado desde el registro de cambios
resource.labels.zone	event.idm.read_only_udm.target.resource.attribute.cloud.availability_zone	Asignado desde el registro de cambios
resource.type	event.idm.read_only_udm.target.resource.resource_type	Asignado desde el registro de cambios
insertId	event.idm.read_only_udm.metadata.product_log_id	Asignado desde el registro de cambios
jsonPayload.latency	event.idm.read_only_udm.additional.fields	Asignado desde el registro de cambios
remoteIp	event.idm.read_only_udm.target.ip	Asignado desde el registro de cambios
jsonPayload.requestMethod	event.idm.read_only_udm.network.http.method	Asignado desde el registro de cambios
jsonPayload.requestSize	event.idm.read_only_udm.network.sent_bytes	Asignado desde el registro de cambios
jsonPayload.requestUrl	event.idm.read_only_udm.network.http.referral_url	Asignado desde el registro de cambios
jsonPayload.responseSize	event.idm.read_only_udm.network.received_bytes	Asignado desde el registro de cambios
jsonPayload.serverIp	event.idm.read_only_udm.target.ip	Asignado desde el registro de cambios
jsonPayload.status	event.idm.read_only_udm.network.http.response_code	Asignado desde el registro de cambios
jsonPayload.userAgent	event.idm.read_only_udm.network.http.user_agent	Asignado desde el registro de cambios
jsonPayload.userAgent	event.idm.read_only_udm.network.http.parsed_user_agent	Asignado desde el registro de cambios
labels	event.idm.read_only_udm.additional.fields	Asignado desde el registro de cambios
terminal	event.idm.read_only_udm.additional.fields	Asignado desde el registro de cambios
logName	event.idm.read_only_udm.additional.fields	Asignado desde el registro de cambios
resource.labels	event.idm.read_only_udm.target.resource.attribute.labels	Asignado desde el registro de cambios
resource.type	event.idm.read_only_udm.target.resource.attribute.labels	Asignado desde el registro de cambios
resource.name	event.idm.read_only_udm.target.resource.name	Asignado desde el registro de cambios
timestamp	event.idm.read_only_udm.metadata.event_timestamp	Asignado desde el registro de cambios
user_agent	event.idm.read_only_udm.network.http.parsed_user_agent	Se asignó desde el registro de cambios

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.