AI CodeOps

CycloneDX (estándar de SBOM)

Última actualización

CycloneDX es el estándar de OWASP para listas de materiales, publicado también como ECMA-424. Qué contiene un archivo CycloneDX y cómo los registra y lee AI CodeOps.

CycloneDX es un estándar abierto para listas de materiales, creado en la comunidad OWASP y publicado también por Ecma International como ECMA-424. Un documento CycloneDX enumera los componentes de un software, con sus versiones, identificadores, licencias y relaciones, en JSON, XML o Protocol Buffers.

Qué es

CycloneDX empezó como formato de lista de materiales de software (SBOM) y ha crecido para cubrir otros inventarios, como SaaSBOM para servicios y HBOM para hardware. También puede llevar información de vulnerabilidades, lo que permite usarlo para VEX (declaraciones sobre si una vulnerabilidad conocida afecta realmente a un producto).

Un SBOM mínimo en JSON de CycloneDX tiene este aspecto:

{
  "bomFormat": "CycloneDX",
  "specVersion": "1.5",
  "metadata": { "component": { "name": "checkout", "version": "2.4.0" } },
  "components": [
    {
      "type": "library",
      "name": "express",
      "version": "4.19.2",
      "purl": "pkg:npm/[email protected]",
      "licenses": [{ "license": { "id": "MIT" } }]
    }
  ]
}

bomFormat y specVersion identifican el documento. Cada componente tiene un tipo, un nombre y una versión, y normalmente una URL de paquete (purl) e identificadores de licencia de la lista de licencias de SPDX.

Por qué importa

Un formato estándar significa que el SBOM que escribe tu herramienta de build lo pueden leer tu escáner de vulnerabilidades, tu comprobador de licencias y las herramientas de tus clientes sin conversión. La mayoría de los generadores de SBOM de los ecosistemas habituales pueden escribir CycloneDX.

En AI CodeOps

AI CodeOps usa CycloneDX en dos lugares.

Registros de SBOM. Cuando registras el SBOM de un proyecto, format es cyclonedx (o spdx) y formatVersion es el specVersion del documento. También envías un licenseSummary, el recuento de componentes por licencia, que construyes a partir de las entradas licenses del archivo:

{ "format": "cyclonedx", "formatVersion": "1.5", "licenseSummary": { "MIT": 301, "Apache-2.0": 74 } }

Ese resumen es lo que lee la política de licencias de la comprobación de publicación. AI CodeOps no analiza el archivo en el momento de registrarlo, así que haz el resumen a partir del mismo archivo cuyo SHA-256 registras. La petición completa está en la página Seguridad y SBOM.

El visor de SBOM. El visor de SBOM gratuito abre un archivo JSON de CycloneDX en tu navegador. Comprueba que tenga "bomFormat": "CycloneDX", muestra la versión de la especificación, el sujeto de metadata.component y el número de componentes, y enumera cada componente (incluidos los anidados) con su versión, tipo, licencias y purl. Puedes filtrar la lista por texto. El visor todavía no admite archivos SPDX.

Preguntas frecuentes

¿CycloneDX es mejor que SPDX?

Ninguno es mejor en general. Ambos describen componentes y licencias. CycloneDX nació de casos de uso de seguridad; SPDX, del cumplimiento de licencias. AI CodeOps registra cualquiera de los dos.

¿El visor de SBOM de AI CodeOps sube mi archivo?

No. Analiza el JSON de CycloneDX en tu navegador y nunca lo envía a ningún sitio.

¿AI CodeOps lee el archivo CycloneDX cuando registro un SBOM?

No. Guarda las cifras que envías, un hash SHA-256 y un enlace al archivo. El resumen de licencias lo aportas tú.