Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/louib/nix2sbom

nix2sbom extracts the CycloneDX and SPDX SBOM (Software Bill of Materials) from a Nix derivation
https://github.com/louib/nix2sbom

cyclonedx github-actions nix nixos purl sbom sbom-generator security software-bill-of-materials spdx supply-chain supply-chain-security

Last synced: 4 months ago
JSON representation

nix2sbom extracts the CycloneDX and SPDX SBOM (Software Bill of Materials) from a Nix derivation

Host: GitHub
URL: https://github.com/louib/nix2sbom
Owner: louib
License: mit
Created: 2023-08-13T23:46:21.000Z (over 1 year ago)
Default Branch: main
Last Pushed: 2024-09-16T23:38:39.000Z (5 months ago)
Last Synced: 2024-09-17T04:06:43.819Z (5 months ago)
Topics: cyclonedx, github-actions, nix, nixos, purl, sbom, sbom-generator, security, software-bill-of-materials, spdx, supply-chain, supply-chain-security
Language: Rust
Homepage:
Size: 376 KB
Stars: 8
Watchers: 3
Forks: 1
Open Issues: 12
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

README

        # nix2sbom

![GitHub Release](https://img.shields.io/github/v/release/louib/nix2sbom)

[![FlakeHub](https://img.shields.io/endpoint?url=https://flakehub.com/f/louib/nix2sbom/badge)](https://flakehub.com/flake/louib/nix2sbom)

[![GitHub](https://img.shields.io/badge/github-louib/nix2sbom-bb7a3652750d7dfd9ba196181cf30f809b3d7012?logo=github")](https://github.com/louib/nix2sbom)

[![Build Status](https://github.com/louib/nix2sbom/actions/workflows/merge.yml/badge.svg?branch=main)](https://github.com/louib/nix2sbom/actions/workflows/merge.yml)

[![Dependency Status](https://deps.rs/repo/github/louib/nix2sbom/status.svg)](https://deps.rs/repo/github/louib/nix2sbom)

[![License File](https://img.shields.io/github/license/louib/nix2sbom)](https://github.com/louib/nix2sbom/blob/main/LICENSE)

`nix2sbom` extracts the SBOM (Software Bill of Materials) from a Nix derivation

📚 [Documentation is here](https://github.com/louib/nix2sbom/wiki/Use-nix2sbom)

## Features

* Supports CycloneDX 1.4 format

* Supports SPDX 2.3 format (Experimental)

* Supports JSON and YAML serialization formats

* Generates a SBOM for your current `NixOS` system

* Detects and handles patches

* Discovers git URLs (using archive URLs)

## Using

### In GitHub Actions

Here is an example of how to generate an SPDX manifest for your nix flake in a GHA workflow:

```yaml

  generate-sbom-manifests:

    name: Generate SPDX SBOM manifest

    runs-on: ubuntu-latest

    steps:

      - name: Checkout

        uses: actions/checkout@v4

      - name: Install Nix

      - uses: DeterminateSystems/nix-installer-action@da36cb69b1c3247ad7a1f931ebfd954a1105ef14 # v14

      - name: Install nix2sbom

        uses: EricCrosson/install-github-release-binary@681cc3de7c5c5ac935b1a2a19e4e0c577c4d3027 # v2.3.4

        with:

          targets: louib/nix2sbom/[email protected]

      - name: Generate the SPDX manifest

        run: |

          nix2sbom .# -f spdx > sbom.spdx.json

```

## Installing

### With Nix

Assuming that you have enabled both the `flakes` and `nix-command` experimental features:

```

nix profile install github:louib/nix2sbom

```

### With Cargo

```

cargo install --path .

```