Skip to content

feat(projects): add ocm-sbom-generator #1

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
jakobmoellerdev wants to merge 1 commit into from
Closed

feat(projects): add ocm-sbom-generator #1

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions projects/ocm-sbom-generator/OWNERS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# Owners

## Maintainers

- @jakob-moeller-cloud

## Reviewers

- @jakob-moeller-cloud
35 changes: 35 additions & 0 deletions projects/ocm-sbom-generator/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
# ocm-sbom-generator

A community plugin that generates Software Bill of Materials (SBOM) documents for OCM component versions and attaches them as resources using the `ext.ocm.software` namespace.

## What it does

`ocm-sbom-generator` introspects an OCM component version, enumerates all OCI image and binary resources, and produces a CycloneDX or SPDX SBOM document. The resulting document is:

1. Stored as a new OCM resource of type `sbom` on the component version.
2. Labeled with `ext.ocm.software/sbom-generator.format` (e.g. `cyclonedx-json`).
3. Optionally signed using the OCM signing framework.

## Why

Compliance teams increasingly require an SBOM for every software artifact. OCM already tracks resources and their provenance, making it a natural attachment point for SBOMs. This plugin closes the gap between OCM's resource model and SBOM tooling (Syft, Trivy, etc.).

## Usage

```bash
ocm-sbom-generator generate \
--component ghcr.io/my-org/my-component:1.0.0 \
--format cyclonedx-json \
--sign my-signing-key
```

## Labels & Annotations

| Key | Values | Description |
|-----|--------|-------------|
| `ext.ocm.software/sbom-generator.format` | `cyclonedx-json`, `spdx-json` | SBOM format used |
| `ext.ocm.software/sbom-generator.version` | semver string | Plugin version that produced the SBOM |

## Status

Early prototype — feedback welcome. See [OWNERS.md](./OWNERS.md) for maintainers.
Loading