Documentación Informes y formatos

Cada análisis termina en un informe: un veredicto y los arreglos por orden de importancia. Puedes leerlo en el navegador, en tu terminal o en tus propias herramientas.

Veredictos

Cada informe empieza con uno de tres veredictos.

VeredictoEn la APIQué significa
ListareadyNo hay nada que arreglar antes de desplegar.
Casi listaalmost_readyPrimero va una lista corta de arreglos. El resto puede esperar.
No está listanot_readyHay al menos un hallazgo crítico. Arréglalo antes de desplegar.

Niveles

Cada hallazgo tiene un nivel. La opción --fail-on de la línea de comandos usa los mismos cuatro.

NivelQué significa
criticalSe puede usar contra ti hoy y el daño es grave. Arréglalo ya.
highGrave, pero más difícil de aprovechar o más limitado. Arréglalo antes de la próxima versión.
mediumMerece arreglarse, sin prisa.
lowConviene saberlo. Se cuenta y se aparca.

El informe sencillo

Los análisis gratuitos traen el informe sencillo.

  • El veredicto: listo, casi listo o no listo
  • Cuántos hallazgos hay, por gravedad
  • Los arreglos principales, cada uno con su comando
  • Si tu imagen base sigue teniendo soporte

El informe completo

Los planes de pago y los packs Charter te dan el informe completo.

  • Cada hallazgo con su prueba: fichero, capa y motivo
  • Si cada vulnerabilidad aplica y es alcanzable
  • Un plan de arreglo por paquete: las menos actualizaciones para quitar el mayor riesgo
  • Una imagen base recomendada y la línea del Dockerfile detrás de cada problema
  • Secretos, configuración, licencias y fin de soporte
  • Exportación: SBOM en CycloneDX y SPDX, HTML y PDF

Formatos

FormatoQué te da
pdfEl informe como documento para enviar o archivar.
htmlEl informe como una sola página que se abre en cualquier navegador.
jsonTodos los hallazgos como datos, para tus propias herramientas.
sarifLos hallazgos para el análisis de código de GitHub, GitLab y Azure DevOps.
cyclonedxEl SBOM en CycloneDX.
spdxEl SBOM en SPDX.
openvexLa declaración VEX en OpenVEX.
cyclonedx-vexLa declaración VEX en CycloneDX VEX.
csafLa declaración VEX en CSAF.

Los formatos que puedes descargar dependen de tu plan.

Tres formas de obtener un informe

DóndeCómo
NavegadorAbre el informe en tu cuenta y usa el botón de descarga.
Línea de comandossc report last lo muestra y sc download last --format pdf lo guarda.
APIGET /reports/{id}/download?format=pdf devuelve el fichero.
sc reports
sc report last
sc download last --format pdf

ID de los informes

Cada informe tiene un ID que empieza por r_, como r_8f3k2a. La línea de comandos y la API lo usan para encontrar el informe. En la línea de comandos, la palabra last equivale a tu último informe.

Borrar un informe

La imagen que envías se borra al terminar el análisis. El informe se queda en tu cuenta hasta que lo borres.

sc delete r_8f3k2a

Un informe borrado no se puede recuperar.

Escanea la tuya antes del próximo despliegue.