Supervisa tu aplicación web con la API de informes

Usa la API de Reporting para supervisar los incumplimientos de seguridad, las llamadas a la API obsoletas y mucho más.

Maud Nalpas

Algunos errores solo ocurren en producción. No los verás de forma local ni durante el desarrollo porque los usuarios reales, las redes reales y los dispositivos reales cambian el juego. La API de Reporting ayuda a detectar algunos de estos errores, como los incumplimientos de seguridad o las llamadas a la API que están obsoletas y pronto lo estarán en todo tu sitio, y los transmite a un extremo que especificaste.

Te permite declarar lo que quieres supervisar con encabezados HTTP y lo opera el navegador.

Configurar la API de Reporting te da la tranquilidad de que, cuando los usuarios experimenten este tipo de errores, lo sabrás y podrás corregirlos.

En esta entrada, se explica qué puede hacer esta API y cómo usarla. ¡Comencemos!

Descripción general

Supongamos que tu sitio, site.example, tiene una Content-Security-Policy y una Document-Policy. ¿No sabes qué hacen? No te preocupes, podrás comprender este ejemplo de todos modos.

Decides supervisar tu sitio para saber cuándo se incumplen estas políticas, pero también porque quieres estar al tanto de las APIs obsoletas o que pronto dejarán de estar disponibles que tu base de código pueda estar usando.

Para ello, configura un encabezado Reporting-Endpoints y asigna estos nombres de extremo con la directiva report-to en tus políticas cuando sea necesario.

Reporting-Endpoints: main-endpoint="https://reports.example/main", default="https://reports.example/default"

# Content-Security-Policy violations and Document-Policy violations
# will be sent to main-endpoint
Content-Security-Policy: script-src 'self'; object-src 'none'; report-to main-endpoint;
Document-Policy: document-write=?0; report-to=main-endpoint;
# Deprecation reports don't need an explicit endpoint because
# these reports are always sent to the `default` endpoint

Se produce un imprevisto y se incumplen estas políticas para algunos de tus usuarios.

Ejemplos de incumplimiento

index.html

<script src="script.js"></script>
<!-- CSP VIOLATION: Try to load a script that's forbidden as per the Content-Security-Policy -->
<script src="https://example.com/script.js"></script>

script.js, cargado por index.html

// DOCUMENT-POLICY VIOLATION: Attempt to use document.write despite the document policy
try {
  document.write('<h1>hi</h1>');
} catch (e) {
  console.log(e);
}
// DEPRECATION: Call a deprecated API
const webkitStorageInfo = window.webkitStorageInfo;

El navegador genera un informe de incumplimiento de la CSP, un informe de incumplimiento de Document-Policy y un informe de baja que registran estos problemas.

Con un breve retraso (hasta un minuto), el navegador envía los informes al extremo que se configuró para este tipo de incumplimiento. El propio navegador envía los informes fuera de banda (no tu servidor ni tu sitio).

El extremo o los extremos reciben estos informes.

Ahora puedes acceder a los informes de estos endpoints y supervisar qué salió mal. Ya puedes comenzar a solucionar problemas que afectan a tus usuarios.

Informe de ejemplo

{
  "age": 2,
  "body": {
    "blockedURL": "https://site2.example/script.js",
    "disposition": "enforce",
    "documentURL": "https://site.example",
    "effectiveDirective": "script-src-elem",
    "originalPolicy": "script-src 'self'; object-src 'none'; report-to main-endpoint;",
    "referrer": "https://site.example",
    "sample": "",
    "statusCode": 200
  },
  "type": "csp-violation",
  "url": "https://site.example",
  "user_agent": "Mozilla/5.0... Chrome/92.0.4504.0"
}

Casos de uso y tipos de informes

La API de Reporting se puede configurar para ayudarte a supervisar muchos tipos de advertencias o problemas interesantes que ocurren en todo tu sitio:

Informes

El navegador envía informes al extremo que configuraste. Envía solicitudes que se ven de la siguiente manera:

POST
Content-Type: application/reports+json

La carga útil de estas solicitudes es una lista de informes.

Ejemplo de lista de informes

[
  {
    "age": 420,
    "body": {
      "columnNumber": 12,
      "disposition": "enforce",
      "lineNumber": 11,
      "message": "Document policy violation: document-write is not allowed in this document.",
      "policyId": "document-write",
      "sourceFile": "https://site.example/script.js"
    },
    "type": "document-policy-violation",
    "url": "https://site.example/",
    "user_agent": "Mozilla/5.0... Chrome/92.0.4504.0"
  },
  {
    "age": 510,
    "body": {
      "blockedURL": "https://site.example/img.jpg",
      "destination": "image",
      "disposition": "enforce",
      "type": "corp"
    },
    "type": "coep",
    "url": "https://dummy.example/",
    "user_agent": "Mozilla/5.0... Chrome/92.0.4504.0"
  }
]

A continuación, se incluyen los datos que puedes encontrar en cada uno de estos informes:

Informes con credenciales

Los extremos de informes que tienen el mismo origen que la página que genera el informe reciben las credenciales (cookies) en las solicitudes que contienen los informes.

Las credenciales pueden proporcionar un contexto adicional útil sobre el informe; por ejemplo, si la cuenta de un usuario determinado genera errores de forma constante o si una determinada secuencia de acciones realizadas en otras páginas genera un informe en esta página.

¿Cuándo y cómo envía informes el navegador?

Los informes se entregan fuera de banda desde tu sitio: El navegador controla cuándo se envían a los extremos configurados. Tampoco hay forma de controlar cuándo el navegador envía informes; los captura, los pone en cola y los envía automáticamente en un momento adecuado.

Esto significa que casi no hay problemas de rendimiento cuando se usa la API de Reporting.

Los informes se envían con un retraso de hasta un minuto para aumentar las probabilidades de enviarlos en lotes. Esto ahorra ancho de banda para respetar la conexión de red del usuario, lo que es especialmente importante en dispositivos móviles. El navegador también puede retrasar la entrega si está ocupado procesando trabajo de mayor prioridad o si el usuario se encuentra en una red lenta o congestionada en ese momento.

Problemas propios y de terceros

Los informes que se generan debido a incumplimientos o bajas que ocurren en tu página se enviarán a los extremos que hayas configurado. Esto incluye los incumplimientos cometidos por secuencias de comandos de terceros que se ejecutan en tu página.

Los incumplimientos o las bajas que se produjeron en un iframe de origen cruzado incorporado en tu página no se informarán a tus extremos (al menos, no de forma predeterminada). Un iframe podría configurar sus propios informes e incluso informar al servicio de informes de tu sitio, es decir, al de origen, pero eso depende del sitio enmarcado. También ten en cuenta que la mayoría de los informes se generan solo si se incumple la política de una página y que las políticas de tu página y las del iframe son diferentes.

Ejemplo con bajas

Navegadores compatibles

En la siguiente tabla, se resume la compatibilidad del navegador con la API de Reporting v1, que es con el encabezado Reporting-Endpoints. La compatibilidad del navegador con la versión 0 de la API de Reporting (encabezado Report-To) es la misma, excepto por un tipo de informe: el registro de errores de red no se admite en la nueva API de Reporting. Consulta la guía de migración para obtener más detalles.

En esta tabla, solo se resume la compatibilidad con report-to con el nuevo encabezado Reporting-Endpoints. Lee las sugerencias para la migración de informes de CSP si deseas migrar a Reporting-Endpoints.

Usa la API de Reporting

Decide dónde se deben enviar los informes

Tienes estas dos opciones:

• Enviar informes a un servicio de recopilación de informes existente
• Envía informes a un recopilador de informes que tú mismo crees y operes.

Opción 1: Usa un servicio de recopilación de informes existente

Estos son algunos ejemplos de servicios de recopilación de informes:

• report-uri
• uriports
• HeaderHawk
• Sentry

Si conoces otras soluciones, abre un problema para informarnos y actualizaremos esta publicación.

Además de los precios, ten en cuenta los siguientes puntos cuando selecciones un recopilador de informes: 🧐

• ¿Este recopilador admite todos los tipos de informes? Por ejemplo, no todas las soluciones de extremos de informes admiten los informes de COOP/COEP.
• ¿Aceptas compartir las URLs de tu aplicación con un recopilador de informes externo? Incluso si el navegador quita la información sensible de estas URLs, es posible que se filtre información sensible de esta manera. Si esto te parece demasiado riesgoso para tu aplicación, opera tu propio extremo de informes.

Opción 2: Crea y opera tu propio recopilador de informes

Crear tu propio servidor que reciba informes no es tan trivial. Para comenzar, puedes bifurcar nuestra plantilla ligera. Se compila con Express y puede recibir y mostrar informes.

Cuando crees tu propio recopilador de informes, ten en cuenta lo siguiente:

• Verifica si hay solicitudes de POST con un Content-Type de application/reports+json para reconocer las solicitudes de informes que envía el navegador a tu extremo.
• Si tu extremo se encuentra en un origen diferente al de tu sitio, asegúrate de que admita solicitudes previas a CORS.

Opción 3: Combina las opciones 1 y 2

Es posible que desees permitir que un proveedor específico se encargue de algunos tipos de informes, pero tener una solución interna para otros.

En este caso, configura varios extremos de la siguiente manera:

Reporting-Endpoints: endpoint-1="https://reports-collector.example", endpoint-2="https://my-custom-endpoint.example"

Configura el encabezado Reporting-Endpoints

Configura un encabezado de respuesta Reporting-Endpoints. Su valor debe ser uno o una serie de pares clave-valor separados por comas:

Reporting-Endpoints: main-endpoint="https://reports.example/main", default="https://reports.example/default"

Si migras de la API de Reporting heredada a la nueva API de Reporting, puede ser conveniente establecer ambos Reporting-Endpoints y Report-To. Consulta los detalles en la guía de migración. En particular, si utilizas informes sobre incumplimientos de Content-Security-Policy solo con la directiva report-uri, consulta los pasos de migración para los informes de CSP.

Reporting-Endpoints: main-endpoint="https://reports.example/main", default="https://reports.example/default"
Report-To: ...

Claves (nombres de extremos)

Cada clave puede ser un nombre de tu elección, como main-endpoint o endpoint-1. Puedes decidir establecer diferentes extremos con nombre para diferentes tipos de informes, por ejemplo, my-coop-endpoint y my-csp-endpoint. Con esto, puedes enrutar los informes a diferentes extremos según su tipo.

Si quieres recibir informes de intervención, baja, falla o una combinación de estos, establece un extremo llamado default.

Si el encabezado Reporting-Endpoints no define ningún extremo default, no se enviarán los informes de este tipo (aunque se generarán).

Valores (URLs)

Cada valor es una URL de tu elección a la que se enviarán los informes. La URL que debes establecer aquí depende de lo que hayas decidido en el paso 1.

Una URL de extremo:

• Debe comenzar con una barra diagonal (/). No se admiten rutas de acceso relativas.
• Puede ser de origen cruzado, pero, en ese caso, no se envían credenciales con los informes.

Ejemplos

Reporting-Endpoints: my-coop-endpoint="https://reports.example/coop", my-csp-endpoint="https://reports.example/csp", default="https://reports.example/default"

Luego, puedes usar cada extremo con nombre en la política adecuada o usar un solo extremo en todas las políticas.

¿Dónde se debe configurar el encabezado?

En la nueva API de Reporting, que es la que se aborda en esta entrada del blog, los informes se limitan a documentos. Esto significa que, para un origen determinado, diferentes documentos, como site.example/page1 y site.example/page2, pueden enviar informes a diferentes extremos.

Para recibir informes de incumplimientos o bajas que se produzcan en cualquier página de tu sitio, establece el encabezado como middleware en todas las respuestas.

Aquí tienes un ejemplo en Express:

const REPORTING_ENDPOINT_BASE = 'https://report.example';
const REPORTING_ENDPOINT_MAIN = `${REPORTING_ENDPOINT_BASE}/main`;
const REPORTING_ENDPOINT_DEFAULT = `${REPORTING_ENDPOINT_BASE}/default`;

app.use(function (request, response, next) {
  // Set up the Reporting API
  response.set(
    'Reporting-Endpoints',
    `main-endpoint="${REPORTING_ENDPOINT_MAIN}", default="${REPORTING_ENDPOINT_DEFAULT}"`,
  );
  next();
});

Edita tus políticas

Ahora que el encabezado Reporting-Endpoints está configurado, agrega una directiva report-to a cada encabezado de política para el que quieras recibir informes de incumplimiento. El valor de report-to debe ser uno de los extremos con nombre que configuraste.

Puedes usar el extremo múltiple para varias políticas o usar diferentes extremos en las políticas.

report-to no es necesario para los informes de obsolescencia, intervención y fallas. Estos informes no están vinculados a ninguna política. Se generan siempre que se configure un extremo default y se envíen a este extremo default.

Ejemplo

# Content-Security-Policy violations and Document-Policy violations
# will be sent to main-endpoint
Content-Security-Policy: script-src 'self'; object-src 'none'; report-to main-endpoint;
Document-Policy: document-write=?0;report-to=main-endpoint;
# Deprecation reports don't need an explicit endpoint because
# these reports are always sent to the default endpoint

Cómo depurar la configuración de informes

Generar informes de forma intencional

Cuando configures la API de Reporting, es probable que debas incumplir tus políticas de forma intencional para verificar si los informes se generan y se envían según lo esperado.

Ahorra tiempo

Los informes pueden enviarse con un retraso de aproximadamente un minuto, lo que es mucho tiempo largo cuando se depura. 😴 Por suerte, cuando depuras en Chrome, puedes usar la marca --short-reporting-delay para recibir informes en cuanto se generen.

Ejecuta este comando en tu terminal para activar esta marca:

YOUR_PATH/TO/EXECUTABLE/Chrome --short-reporting-delay

Usa Herramientas para desarrolladores

En Chrome, usa las Herramientas para desarrolladores para ver los informes que se enviaron o se enviarán.

A partir de octubre de 2021, esta función es experimental. Para usarla, sigue estos pasos:

1. Usa la versión 96 de Chrome y versiones posteriores (escribe chrome://version en el navegador para verificarla).
2. Escribe o pega chrome://flags/#enable-experimental-web-platform-features en la barra de direcciones de Chrome.
3. Haz clic en Habilitado.
4. Reinicia el navegador.
5. Abra las Herramientas para desarrolladores de Chrome.
6. En las Herramientas para desarrolladores de Chrome, abre la Configuración. En Experimentos, haz clic en Habilitar el panel de la API de Reporting en el panel Aplicación.
7. Vuelve a cargar Herramientas para desarrolladores.
8. Vuelve a cargar la página. Los informes que genere la página en la que se abran las Herramientas para desarrolladores se mostrarán en el panel Aplicación de las Herramientas para desarrolladores de Chrome, en API de Reporting.

Estado del informe

La columna Estado te indica si un informe se envió correctamente.

Los informes se quitan después de un tiempo, independientemente de si se envían correctamente o no.

Solución de problemas

¿Los informes no se generan o no se envían como se espera a tu extremo? Estas son algunas sugerencias para solucionar este problema.

No se generan informes

Los informes que aparecen en las Herramientas para desarrolladores se generaron correctamente. Si el informe que esperas no aparece en esta lista, haz lo siguiente:

• Verifica report-to en tus políticas. Si se configura de forma incorrecta, no se generará un informe. Ve a Editar tus políticas para corregir este problema. Otra forma de solucionar problemas es verificar la consola de Herramientas para desarrolladores en Chrome: si aparece un error en la consola por el incumplimiento que esperabas, es probable que tu política esté configurada correctamente.
• Ten en cuenta que solo se mostrarán en esta lista los informes que se generaron para el documento en el que se abrieron las Herramientas para desarrolladores. Por ejemplo, si tu sitio site1.example incorpora un iframe site2.example que incumple una política y, por lo tanto, genera un informe, este informe solo aparecerá en las Herramientas para desarrolladores si abres el iframe en su propia ventana y abres las Herramientas para desarrolladores para esa ventana.

Los informes se generan, pero no se envían o no se reciben

¿Qué sucede si puedes ver un informe en las Herramientas para desarrolladores, pero tu extremo no lo recibe?

• Asegúrate de usar retrasos cortos. Tal vez no puedas ver un informe porque aún no se envió.

• Verifica la configuración del encabezado Reporting-Endpoints. Si hay un problema con él, no se enviará un informe que se haya generado correctamente. En las Herramientas para desarrolladores, el estado del informe permanecerá como Queued (puede cambiar a Pending y, luego, volver rápidamente a Queued cuando se realice un intento de entrega) en este caso. Estos son algunos errores comunes que pueden causar este problema:

• Se usa el extremo, pero no está configurado. Ejemplo:

 Document-Policy: document-write=?0;report-to=endpoint-1;
 Reporting-Endpoints: default="https://reports.example/default"

• Falta el extremo default. Algunos tipos de informes, como los de baja y de intervención, solo se enviarán al extremo llamado default. Obtén más información en Configura el encabezado Reporting-Endpoints.

• Busca problemas en la sintaxis de los encabezados de tus políticas, como comillas faltantes. Ver detalles.

• Verifica que tu extremo pueda controlar las solicitudes entrantes.

  • Asegúrate de que tu extremo admita solicitudes de comprobación previa de CORS. Si no es así, no podrá recibir avisos.

  • Prueba el comportamiento de tu extremo. Para ello, en lugar de generar informes de forma manual, puedes emular el navegador enviando a tu extremo solicitudes que se parezcan a lo que enviaría el navegador. Ejecuta lo siguiente:

  curl --header "Content-Type: application/reports+json" \
    --request POST \
    --data '[{"age":420,"body":{"columnNumber":12,"disposition":"enforce","lineNumber":11,"message":"Document policy violation: document-write is not allowed in this document.","policyId":"document-write","sourceFile":"https://dummy.example/script.js"},"type":"document-policy-violation","url":"https://dummy.example/","user_agent":"xxx"},{"age":510,"body":{"blockedURL":"https://dummy.example/img.jpg","destination":"image","disposition":"enforce","type":"corp"},"type":"coep","url":"https://dummy.example/","user_agent":"xxx"}]' \
    YOUR_ENDPOINT
  

  Tu extremo debería responder con un código de éxito (200 o algún otro código de respuesta de éxito 2xx). Si no lo hace, hay un problema con su configuración.

Mecanismos de denuncia relacionados

Solo informes

Los encabezados de la política de -Report-Only y el Reporting-Endpoints funcionan en conjunto.

Los extremos configurados en Reporting-Endpoints y especificados en el campo report-to de Content-Security-Policy, Cross-Origin-Embedder-Policy y Cross-Origin-Opener-Policy recibirán informes cuando se incumplan estas políticas.

Los extremos configurados en Reporting-Endpoints también se pueden especificar en el campo report-to de Content-Security-Policy-Report-Only, Cross-Origin-Embedder-Policy-Report-Only y Cross-Origin-Opener-Policy-Report-Only. También recibirán informes cuando se incumplan estas políticas.

Si bien los informes se envían en ambos casos, los encabezados -Report-Only no aplican las políticas: no se producirán errores ni se bloqueará nada, pero recibirás informes de lo que habría fallado o se habría bloqueado.

ReportingObserver

La API de JavaScript de ReportingObserver puede ayudarte a observar las advertencias del cliente.

ReportingObserver y el encabezado Reporting-Endpoints generan informes que se ven iguales, pero permiten casos de uso ligeramente diferentes.

Usa ReportingObserver en los siguientes casos:

• Solo quieres supervisar las bajas o las intervenciones del navegador. ReportingObserver muestra advertencias del cliente, como las bajas y las intervenciones del navegador, pero, a diferencia de Reporting-Endpoints, no captura ningún otro tipo de informe, como los incumplimientos de la CSP o de COOP/COEP.
• Debes reaccionar a estos incumplimientos en tiempo real. ReportingObserver permite vincular una devolución de llamada a un evento de incumplimiento.
• Quieres adjuntar información adicional a un informe para ayudar en la depuración con la devolución de llamada personalizada.

Otra diferencia es que ReportingObserver solo se configura del lado del cliente: puedes usarlo incluso si no tienes control sobre los encabezados del servidor y no puedes establecer Reporting-Endpoints.

Lecturas adicionales

• Guía de migración de la API de Reporting de la versión 0 a la 1
• ReportingObserver
• Especificación: API de Reporting heredada (v0)
• Especificación: nueva API de Reporting (v1)

Muchas gracias a Ian Clelland, Eiji Kitamura y Milica Mihajlija por sus revisiones y sugerencias sobre este documento.