AI CodeOps

Standard CycloneDX

Mis à jour le

CycloneDX est le standard OWASP de nomenclatures, publié aussi sous la référence ECMA-424. Ce que contient un fichier CycloneDX, et comment AI CodeOps les enregistre et les lit.

CycloneDX est un standard ouvert de nomenclatures (bills of materials), créé au sein de la communauté OWASP et publié également par Ecma International sous la référence ECMA-424. Un document CycloneDX liste les composants d'un logiciel, avec leurs versions, leurs identifiants, leurs licences et leurs relations, en JSON, en XML ou en Protocol Buffers.

Définition

CycloneDX a commencé comme format de nomenclature logicielle (SBOM) et s'est étendu à d'autres inventaires, comme le SaaSBOM pour les services et le HBOM pour le matériel. Il peut aussi transporter des informations de vulnérabilité, ce qui le rend utilisable pour le VEX (des déclarations indiquant si une vulnérabilité connue affecte réellement un produit).

Un SBOM CycloneDX minimal en JSON ressemble à ceci :

{
  "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 et specVersion identifient le document. Chaque composant a un type, un nom et une version, et en général une URL de paquet (purl) et des identifiants de licence issus de la liste de licences SPDX.

Pourquoi c'est important

Un format standard signifie que le SBOM écrit par votre outil de build peut être lu par votre scanner de vulnérabilités, votre outil de contrôle des licences et les outils de vos clients, sans conversion. La plupart des générateurs de SBOM des écosystèmes courants savent écrire du CycloneDX.

Dans AI CodeOps

AI CodeOps utilise CycloneDX à deux endroits.

Les enregistrements de SBOM. Lorsque vous enregistrez le SBOM d'un projet, format vaut cyclonedx (ou spdx) et formatVersion est le specVersion du document. Vous envoyez aussi un licenseSummary, le nombre de composants par licence, que vous construisez à partir des entrées licenses du fichier :

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

C'est ce résumé que lit la politique de licences de la vérification de livraison. AI CodeOps n'analyse pas le fichier au moment de l'enregistrement : construisez donc le résumé à partir du fichier même dont vous enregistrez l'empreinte SHA-256. La requête complète se trouve sur la page Sécurité et SBOM.

Le visualiseur de SBOM. Le visualiseur de SBOM gratuit ouvre un fichier JSON CycloneDX dans votre navigateur. Il vérifie la présence de "bomFormat": "CycloneDX", affiche la version de la spécification, le sujet tiré de metadata.component et le nombre de composants, et liste chaque composant (y compris les composants imbriqués) avec sa version, son type, ses licences et son purl. Vous pouvez filtrer la liste par texte. Les fichiers SPDX ne sont pas encore pris en charge par le visualiseur.

Questions fréquentes

CycloneDX est-il meilleur que SPDX ?

Aucun des deux n'est meilleur en général. Tous deux décrivent des composants et des licences. CycloneDX est né de cas d'usage de sécurité, SPDX de la conformité des licences. AI CodeOps enregistre l'un comme l'autre.

Le visualiseur de SBOM d'AI CodeOps envoie-t-il mon fichier quelque part ?

Non. Il analyse le JSON CycloneDX dans votre navigateur et ne l'envoie jamais nulle part.

AI CodeOps lit-il le fichier CycloneDX lorsque j'enregistre un SBOM ?

Non. Il conserve les chiffres que vous envoyez, une empreinte SHA-256 et un lien vers le fichier. Le résumé des licences vient de vous.