|
| 1 | +.. SPDX-FileCopyrightText: 2026 cusy GmbH |
| 2 | +.. |
| 3 | +.. SPDX-License-Identifier: BSD-3-Clause |
| 4 | +
|
| 5 | +Software Bill-of-Materials (SBOM) |
| 6 | +================================= |
| 7 | + |
| 8 | +Eine Software Bill-of-Materials (SBOM) ist ein Dokument zum Austausch von |
| 9 | +Informationen über Software und deren Zusammensetzung. Dieses Format wird vor |
| 10 | +allem im Sicherheitsbereich verwendet, um Software und ihre Abhängigkeiten |
| 11 | +mithilfe von Schwachstellendatenbanken wie `CVE <https://www.cve.org/>`_ und |
| 12 | +`OSV <https://osv.dev/>`_ auf Schwachstellen zu überprüfen. Das vom |
| 13 | +CPython-Projekt verwendete SBOM-Format ist `SPDX |
| 14 | +<https://spdx.github.io/spdx-spec/v3.0.1/model/Software/Classes/Sbom/>`_, das |
| 15 | +bei Bedarf in andere Formate konvertiert werden kann. Die SBOM-Datei für die in |
| 16 | +CPython enthaltenen Abhängigkeiten wird unter `Misc/sbom.spdx.json |
| 17 | +<https://github.com/python/cpython/blob/main/Misc/sbom.spdx.json>`_ verwaltet. |
| 18 | +Die Datei wird erstellt mit `Tools/build/generate_sbom.py |
| 19 | +<https://github.com/python/cpython/blob/main/Tools/build/generate_sbom.py>`_. |
| 20 | + |
| 21 | +SBOM-Datei erstellen |
| 22 | +-------------------- |
| 23 | + |
| 24 | +… mit uv |
| 25 | +~~~~~~~~ |
| 26 | + |
| 27 | +:term:`uv` bietet eine einfache Möglichkeit, eine SBOM-Datei im Format CycloneDX |
| 28 | +v1.5 zu erstellen mit: |
| 29 | + |
| 30 | +.. code-block:: console |
| 31 | +
|
| 32 | + $ uv export --format='cyclonedx1.5' > sbom.cdx.json |
| 33 | +
|
| 34 | +Die Datei enthält jedoch nur sehr rudimentäre Angaben, :abbr:`z. B. (zum |
| 35 | +Beispiel)` für `cusy.tasks <https://github.com/cusyio/cusy.tasks>`_: |
| 36 | + |
| 37 | +.. code-block:: json |
| 38 | +
|
| 39 | + "component": { |
| 40 | + "type": "library", |
| 41 | + "bom-ref": "cusy-tasks-1@26.2.0", |
| 42 | + "name": "cusy-tasks", |
| 43 | + "version": "26.2.0", |
| 44 | + "properties": [ |
| 45 | + { |
| 46 | + "name": "uv:package:is_project_root", |
| 47 | + "value": "true" |
| 48 | + } |
| 49 | + ] |
| 50 | + } |
| 51 | +
|
| 52 | +Mit ``uv export --all-groups --format='cyclonedx1.5' > sbom.cdx.json`` könnt |
| 53 | +ihr auch alle Dependency-Groups in die SBOM-Datei übernehmen. |
| 54 | + |
| 55 | +… mit CycloneDX Python |
| 56 | +~~~~~~~~~~~~~~~~~~~~~~ |
| 57 | + |
| 58 | +Deutlich umfangreicher ist die Ausgabe von `CycloneDX Python |
| 59 | +<https://cyclonedx-bom-tool.readthedocs.io/en/latest/index.html>`_: |
| 60 | + |
| 61 | +.. code-block:: json |
| 62 | +
|
| 63 | + { |
| 64 | + "bom-ref": "cusy-tasks==26.2.0", |
| 65 | + "description": "", |
| 66 | + "externalReferences": [ |
| 67 | + { |
| 68 | + "comment": "PackageSource: Local", |
| 69 | + "type": "distribution", |
| 70 | + "url": "file:///Users/veit/cusy/prj/cusy.tasks" |
| 71 | + }, |
| 72 | + { |
| 73 | + "comment": "from packaging metadata Project-URL: Documentation", |
| 74 | + "type": "documentation", |
| 75 | + "url": "https://tasks.cusy.io/" |
| 76 | + }, |
| 77 | + { |
| 78 | + "comment": "from packaging metadata Project-URL: Mastodon", |
| 79 | + "type": "other", |
| 80 | + "url": "https://mastodon.social/@Python4DataScience" |
| 81 | + }, |
| 82 | + { |
| 83 | + "comment": "from packaging metadata Project-URL: GitHub", |
| 84 | + "type": "vcs", |
| 85 | + "url": "https://github.com/cusyio/cusy.tasks" |
| 86 | + } |
| 87 | + ], |
| 88 | + "licenses": [ |
| 89 | + { |
| 90 | + "license": { |
| 91 | + "acknowledgement": "declared", |
| 92 | + "id": "BSD-3-Clause" |
| 93 | + } |
| 94 | + } |
| 95 | + ], |
| 96 | + "name": "cusy-tasks", |
| 97 | + "type": "library", |
| 98 | + "version": "26.2.0" |
| 99 | + } |
| 100 | +
|
| 101 | +Der Kommandozeilenaufruf zum Erstellen der Datei ist: |
| 102 | + |
| 103 | +.. code-block:: console |
| 104 | +
|
| 105 | + $ uvx --from cyclonedx-bom cyclonedx-py environment .venv --output-file sbom.cdx.json |
| 106 | +
|
| 107 | +.. warning:: |
| 108 | + CycloneDX Python erstellt die SBOM-Datei aus dem aktuellen |
| 109 | + :file:`.venv`-Verzeichnis. Ruft ihr ``cyclonedx-bom`` also in eurer |
| 110 | + Entwicklungsumgebung auf, werdet ihr auch alle Entwicklungswerkzeuge in eurer |
| 111 | + SBOM-Datei wiederfinden. |
| 112 | + |
| 113 | +… mit sbomify |
| 114 | +~~~~~~~~~~~~~ |
| 115 | + |
| 116 | +sbomify stellt eine GitHub Action zum Erstellen der SBOM-Datei bereit, die unter |
| 117 | +der Haube CycloneDX Python verwendet. Mit `actions/attest-sbom |
| 118 | +<https://github.com/actions/attest-sbom>`_ kann die Datei dann attestiert |
| 119 | +werden: |
| 120 | + |
| 121 | +.. literalinclude:: sbomify.yml |
| 122 | + :caption: .github/workflows/sbomify.yml |
| 123 | + :language: yaml |
| 124 | + |
| 125 | +In GitLab CI könnt ihr sbomify folgendermaßen verwenden: |
| 126 | + |
| 127 | +.. literalinclude:: .gitlab-ci.yml |
| 128 | + :caption: .gitlab-ci.yml |
| 129 | + :language: yaml |
| 130 | + :lines: 1-12, 32- |
| 131 | + |
| 132 | +Ihr könnt auch Dependency Scanning integrieren: |
| 133 | + |
| 134 | +.. literalinclude:: .gitlab-ci.yml |
| 135 | + :caption: .gitlab-ci.yml |
| 136 | + :language: yaml |
| 137 | + :lines: 13-30 |
| 138 | + |
| 139 | +.. seealso:: |
| 140 | + * `SBOM Generation in CI/CD Pipelines <https://sbomify.com/guides/ci-cd/>`_ |
| 141 | + * `Dependency scanning by using SBOM |
| 142 | + <https://docs.gitlab.com/user/application_security/dependency_scanning/dependency_scanning_sbom/>`_ |
| 143 | + |
| 144 | +PEP 770 – SBOMs in Python-Paketen |
| 145 | +--------------------------------- |
| 146 | + |
| 147 | +:pep:`770` standardisiert die Einbindung von SBOMs in Python-Wheels über das |
| 148 | +Verzeichnis :file:`.dist-info/sboms/`. Wenn ihr Python-Pakete auf :term:`PyPI` |
| 149 | +veröffentlicht, bedeutet dies, dass eure User die SBOM-Datei automatisch |
| 150 | +erhalten, wenn sie euer Paket installieren, :abbr:`z. B. (zum Beispiel)`: |
| 151 | + |
| 152 | +.. code-block:: console |
| 153 | +
|
| 154 | + myapp-26.2.0.dist-info |
| 155 | + ├── METADATA |
| 156 | + ├── RECORD |
| 157 | + └── sboms/ |
| 158 | + └── myapp.cdx.json |
| 159 | +
|
| 160 | +Build-Backends wie Hatchling≥1.28 unterstützen dies bereits mit der |
| 161 | +``sbom-files``-Konfiguration: |
| 162 | + |
| 163 | +.. code-block:: toml |
| 164 | + :caption: pyproject.toml |
| 165 | +
|
| 166 | + [tool.hatch.build.targets.wheel] |
| 167 | + sbom-files = ["myapp.cdx.json"] |
| 168 | +
|
| 169 | +Anstatt die SBOM-Datei beim Build von Grund auf neu zu generieren, kann eine |
| 170 | +minimale CycloneDX-SBOM-Datei in das Repository eingecheckt werden: |
| 171 | + |
| 172 | +.. code-block:: json |
| 173 | +
|
| 174 | + { |
| 175 | + "bomFormat": "CycloneDX", |
| 176 | + "specVersion": "1.6", |
| 177 | + "version": 1, |
| 178 | + "metadata": { |
| 179 | + "component": { |
| 180 | + "type": "library", |
| 181 | + "name": "mylib", |
| 182 | + "version": "0.0.0-placeholder" |
| 183 | + } |
| 184 | + }, |
| 185 | + "components": [] |
| 186 | + } |
| 187 | +
|
| 188 | +Im :term:`CI`-Workflow wird die Platzhalter-SBOM-Datei dann mit dem Code |
| 189 | +ausgecheckt. sbomify reichert sie dann mit den aktuellen Informationen an. |
| 190 | +Anschließend baut hatchling das :term:`Wheel` mit der aktuellen SBOM-Datei und |
| 191 | +schließlich wird das Wheel auf :term:`PyPI` veröffentlicht. |
| 192 | + |
| 193 | +Analyse |
| 194 | +------- |
| 195 | + |
| 196 | +Zur Sicherheits- und Lizenzprüfung stehen zahlreiche Tools zur Verfügung, die |
| 197 | +sich auf unterschiedliche Problembereiche konzentrieren. Zwei Open-Source-Tools |
| 198 | +für die SBOM-Analyse sind `Dependency Track <https://dependencytrack.org>`_ und |
| 199 | +`GUAC <https://guac.sh>`_. Mit ``sbomify-action`` könnt ihr SBOMs aus der |
| 200 | +CI-Pipeline direkt in eure Dependency Track-Instanz hochladen mit: |
| 201 | + |
| 202 | +.. code-block:: yaml |
| 203 | +
|
| 204 | + UPLOAD_DESTINATIONS=dependency-track |
0 commit comments