<!-- SPDX-FileCopyrightText: Copyright (c) 2026 NVIDIA CORPORATION & AFFILIATES. All rights reserved. -->
<!-- SPDX-License-Identifier: Apache-2.0 -->

<a id="wheel-contents-sbom-and-license-evidence"></a>

# Wheel contents SBOM and license evidence

Every `isaaccapture` wheel published from 1.7 on lists what it redistributes and carries the
license text behind each obligation; earlier wheels carry neither. You can check both offline,
without installing the wheel. The Release build refuses to ship a wheel with a gap in either.

To check a wheel, see [Verifying a wheel](#verifying-a-wheel). To learn how the evidence is worked out, or why
a build stopped, see the collector’s developer README, [scripts/sbom/README.md](https://github.com/NVIDIA/IsaacCapture/blob/main/scripts/sbom/README.md).

<a id="what-a-wheel-carries"></a>

## What a wheel carries

```text
isaaccapture-<version>-<abi>-<platform>.whl
└── isaaccapture-<version>.dist-info/
    ├── METADATA                       # License-Expression + one License-File per text below
    ├── licenses/
    │   ├── LICENSE.md                 # this project's own license
    │   ├── LICENSES/<id>.txt          # this project's license texts
    │   ├── THIRD-PARTY-NOTICES.md     # each component, its license, and where the text is
    │   └── third-party/<component>/   # the component's own license file, or a reference text
    └── sboms/
        └── <wheel filename>.spdx.json # SPDX 2.3 contents inventory
```

- **The SBOM** lists every file in the wheel but `RECORD` and itself: where it came from,
  under what license, and its digest. It describes the wheel’s own contents only. Build
  tools, dependencies this wheel does not carry (the build evidence records them with
  `"in_this_wheel": false`),
  install-time dependencies (`Requires-Dist` stays authoritative; the SBOM records the
  requirement, never a license for it), source distributions and `pip install .`,
  containers and the web client are not covered.
- **Each third-party component** ships its own license file or, for material checked into
  this repository, the reference text for its declared license beside its copyright
  notice.
- `sboms/` may also hold a CycloneDX document `auditwheel` writes for the libraries it
  bundled.

<a id="evidence-published-with-a-release"></a>

## Evidence published with a release

Each tagged GitHub release from 1.7 on carries one archive, `isaaccapture-sbom-<tag>.zip`. Unpacked,
its `isaaccapture-sbom-<tag>/` directory holds, for every wheel:

`<wheel>.spdx.json`
: An exact copy of the document embedded in the wheel.

`<wheel>.licenses.md` / `<wheel>.licenses.json`
: Each redistributed component, the license concluded for it and the file it was read
  from, how it reaches the wheel, and what the installation environment supplies instead.
  It covers this wheel only; what the build used but did not ship is in the build evidence.

`<wheel>.build-evidence.json`
: Resolved commits, declared constraints, archive digests and build options, from the
  build machine, and every component the build resolved, whether or not it reached the
  wheel.

and, once per release:

`isaaccapture-sbom-manifest.json`
: Each wheel’s filename and SHA-256 and its evidence files’ digests, recorded after the
  last change to the wheel, so a wheel touched since no longer matches.

<a id="verifying-a-wheel"></a>

## Verifying a wheel

You need `uv` and a clone of this repository:

```bash
git clone --depth 1 https://github.com/NVIDIA/IsaacCapture
uv run --project IsaacCapture/scripts/sbom isaaccapture-sbom check \
  --wheel isaaccapture-<version>-<abi>-<platform>.whl
```

To check a whole release, unpack its archive and put every wheel its manifest lists, for
each Python version and architecture, in a directory of their own. A wheel or evidence file
the manifest does not name fails the check:

```bash
unzip isaaccapture-sbom-<tag>.zip
uv run --project IsaacCapture/scripts/sbom isaaccapture-sbom check-set \
  --manifest isaaccapture-sbom-<tag>/isaaccapture-sbom-manifest.json \
  --wheel-dir wheels --evidence-dir isaaccapture-sbom-<tag>
```

`check` confirms the SBOM accounts for every file, its digests match the wheel and its
`RECORD`, each license text it cites is packaged where it says, and every
`LicenseRef-` carries its text; add `--build-evidence` or `--manifest` to check
against the release evidence too.

The SBOM describes a wheel; it is not a signature. Integrity is the wheel’s `RECORD`,
which installers check. These releases carry no
[PEP 740](https://peps.python.org/pep-0740/) attestations.

To read the inventory, open `.dist-info/sboms/*.spdx.json` with any SPDX 2.3 tool. A
file’s `SPDXID` changes only when its path does, so two releases can be diffed.
