shipcra

SBOM erstellen: aus der Lockfile, Schritt für Schritt

Geprüft am 3 Min. Lesezeit

Eine Lockfile enthält bereits jede aufgelöste Abhängigkeit mit exakter Version und ist deshalb die schnellste Grundlage für eine SBOM. Wandeln Sie sie mit einem SBOM-Tool für Ihr Ökosystem in CycloneDX um, ergänzen Sie Name und Version Ihres Produkts, tragen Sie Komponenten nach, die die Lockfile nicht kennt, und erzeugen Sie die SBOM bei jedem Release neu.

Das Wichtigste

Beste Grundlage
Die Lockfile, die mit dem ausgelieferten Release versioniert ist
Übliches Ausgabeformat
CycloneDX-JSON
Wann neu erzeugen
Bei jedem Release, das Abhängigkeiten ändert
Was Lockfiles nicht sehen
Kopierter Code, native Binärdateien, Engines und Laufzeitumgebungen

Warum die Lockfile der beste Ausgangspunkt ist

Ein Manifest wie package.json nennt die Versionsbereiche, die Sie angefordert haben. Die Lockfile hält fest, was Ihr Paketmanager tatsächlich aufgelöst hat: jede direkte und transitive Abhängigkeit, auf eine exakte Version festgelegt, oft mit Integritäts-Hash. Genau das soll eine SBOM beschreiben, und es liegt bereits in Ihrem Repository.

Die Lockfile macht die SBOM außerdem reproduzierbar: Derselbe Commit ergibt immer dieselbe Komponentenliste, wie man es von technischer Dokumentation erwartet.

Lockfiles nach Ökosystem

Ökosystem Lockfile Hinweis
npm package-lock.json Wird standardmäßig angelegt
Yarn yarn.lock Formate von Classic und Berry unterscheiden sich
pnpm pnpm-lock.yaml Wird standardmäßig angelegt
CocoaPods Podfile.lock Mit der App versionieren
Swift Package Manager Package.resolved Bei Apps im Xcode-Projekt
Gradle gradle.lockfile Nur mit aktiviertem Dependency Locking
Flutter und Dart pubspec.lock Bei Apps versionieren
Unity Packages/packages-lock.json Umfasst Unity-Pakete, nicht die Engine
NuGet packages.lock.json Nur mit aktiviertem RestorePackagesWithLockFile

Hat Ihr Projekt keine Lockfile, aktivieren Sie zuerst das Locking. Eine SBOM aus Versionsbereichen passt womöglich nicht zu dem, was Sie ausgeliefert haben.

SBOM erstellen, Schritt für Schritt

  1. Checken Sie den Release-Commit aus und stellen Sie sicher, dass die Lockfile aktuell ist, etwa mit npm ci oder einem sauberen Build.
  2. Wählen Sie ein SBOM-Tool für Ihr Ökosystem. Das CycloneDX-Projekt pflegt offizielle Werkzeuge: @cyclonedx/cyclonedx-npm für npm, Plugins für Gradle und Maven, CycloneDX für .NET und cdxgen, das viele Ökosysteme abdeckt.
  3. Erzeugen Sie CycloneDX-JSON. Für ein npm-Projekt: npx @cyclonedx/cyclonedx-npm --output-file sbom.json.
  4. Beschreiben Sie Ihr Produkt. Prüfen Sie, dass metadata.component den Namen Ihres Produkts und die exakte Release-Version trägt. Werkzeuge übernehmen oft den Paketnamen, nicht die Produktversion.
  5. Validieren Sie die Datei. Die CycloneDX-CLI prüft sie gegen das Schema: cyclonedx validate --input-file sbom.json.
  6. Suchen Sie die Lücken (siehe unten) und ergänzen Sie fehlende Komponenten von Hand.
  7. Legen Sie sie zum Release und in Ihre technische Dokumentation, und speisen Sie sie in Ihre Schwachstellenüberwachung ein, damit neue Meldungen mit dem Ausgelieferten abgeglichen werden.

Das Ergebnis prüfen, bevor Sie es behalten

  • Die Zahl der Komponenten liegt in der Größenordnung der Pakete in der Lockfile.
  • Jede oberste Abhängigkeit ist enthalten: Das ist das Minimum des CRA.
  • Komponenten haben Package-URLs (purl), damit Datenbanken wie OSV sie erkennen.
  • Lizenzen sind eingetragen, soweit die Registry sie kennt.
  • Produktname und -version sind Ihre eigenen, kein Platzhalter.

Wenn Sie sich an der BSI TR-03183 Teil 2 orientieren, prüfen Sie zusätzlich die dort beschriebenen Pflichtfelder und die Abdeckungstiefe. Mehr dazu im Leitfaden Was ist eine SBOM?.

Was die Lockfile nicht sieht

  • Kopierter Code: Eine Bibliothek, die in Ihre Quellen eingefügt wurde, hat keinen Eintrag in der Lockfile.
  • Native und binäre Abhängigkeiten: SDKs als Frameworks, .so- oder .dll-Dateien.
  • Engines und Laufzeitumgebungen: Unity, Unreal, Godot, Electron oder die mitgelieferte JavaScript-Laufzeit.
  • Plattformdienste: Systembibliotheken auf dem Gerät gehören normalerweise nicht in Ihre SBOM, alles, was Sie in Ihrem Paket ausliefern, aber schon.

Ergänzen Sie diese von Hand, mit Version und Lieferant, damit das Inventar dem Produkt entspricht. Läuft Ihr Produkt in Containern, ergänzt ein Image-Scan die Betriebssystempakete, die die Lockfile nicht kennt.

Die SBOM aktuell halten

Eine SBOM nützt nur, solange sie zu dem passt, was Nutzer ausführen. Erzeugen Sie sie in der CI bei jedem Release neu, legen Sie jede Fassung neben den Build, den sie beschreibt, und gleichen Sie sie täglich mit Schwachstellendaten ab. Stellt sich eine Komponente einer ausgelieferten Version als aktiv ausgenutzt heraus, zeigt Ihnen die SBOM, welche Versionen und Nutzer betroffen sind, innerhalb der 24 Stunden, die die CRA-Meldepflicht vorsieht.

Fragen

Kann ich eine SBOM erstellen, ohne meinen Code hochzuladen?

Ja. Open-Source-Tools laufen lokal oder in Ihrer CI, und shipcra wertet die Lockfile in Ihrem Browser aus, die Datei verlässt also nie Ihren Rechner. Gespeichert wird nur die fertige SBOM, wenn Sie das möchten.

Wie oft sollte ich die SBOM neu erzeugen?

Bei jedem Release, das Ihre Abhängigkeiten ändert. Die SBOM in Ihrer technischen Dokumentation muss die tatsächlich ausgelieferte Version beschreiben, koppeln Sie die Erzeugung also an Ihren Release-Prozess.

Macht ein SBOM-Generator mein Produkt CRA-konform?

Nein. Er liefert einen Nachweis: das Komponenteninventar, das Anhang I verlangt. Die übrigen grundlegenden Anforderungen, die Schwachstellenbehandlung und die Konformitätsbewertung bleiben Ihre Aufgabe.

Container-Image scannen oder Lockfile auswerten?

Beides beantwortet unterschiedliche Fragen. Die Lockfile beschreibt die Abhängigkeiten Ihrer Anwendung, ein Image-Scan findet zusätzlich die Betriebssystempakete im Container. Ein serverseitiges Produkt braucht eventuell beides; eine mobile App oder ein Spiel startet mit der Lockfile und ergänzt die Engine von Hand.

Quellen

  1. Verordnung (EU) 2024/2847, Anhang I Teil II, EUR-Lex
  2. CycloneDX Tool Center
  3. OSV: Open-Source-Schwachstellendatenbank
  4. OCCTET-Toolkit: ORT Server, Curator und VulnerableCode für SBOM, VEX und Audit-Berichte

Dieser Leitfaden erklärt die Verordnung allgemein. Er ist keine Rechtsberatung für Ihr Produkt.

Machen Sie aus Ihrer Lockfile eine SBOM.

shipcra liest Ihre Lockfile im Browser und erstellt eine CycloneDX-SBOM für Ihre technische Dokumentation. Die Datei verlässt nie Ihren Rechner.

Frühen Zugang sichern