SBoM (SBoM v0.9.1)

View Source

EEF Security WG project .github/workflows/branch_main.yml Coverage Status OpenSSF Scorecard OpenSSF Best Practices REUSE status

Generates a Software Bill-of-Materials (SBoM) for Mix projects, in CycloneDX format.

For a quick demo of how this might be used, check out this blog post.

Installation

This tool can be installed in several ways:

Add the dependency to your project's mix.exs (development only):

def deps do
  [
    {:sbom, "~> 0.8", only: :dev, runtime: false},
    # If using Elixir < 1.18 and want JSON output, also add:
    # {:jason, "~> 1.4"}
  ]
end

⚠️ Important: We recommend using only: :dev, runtime: false to prevent including the SBoM tooling in production deployments. Do not run mix sbom.cyclonedx with MIX_ENV=prod as the dependency will not be available in that environment.

2. Mix Escript (Global installation)

⚠️ Warning: Requires Elixir >= 1.19.4

Install the Mix task globally on your system:

mix escript.install hex sbom

4. Burrito Binary (From releases)

Download the self-contained binary from the releases page (does not require BEAM runtime).

Usage

As a Mix Task (project dependency only)

When installed as a project dependency, run from the project directory containing mix.exs:

mix sbom.cyclonedx

The result is written to bom.cdx.json unless a different name is specified using the -o option. Use --only dev --only test --only prod to include dependencies from specific environments.

As a Standalone Binary (escript install or Burrito)

When using the globally installed escript, downloaded escript, or Burrito binary, you must provide the project path as an argument:

# Global escript or downloaded binary
mix_sbom cyclonedx /path/to/your/project

# Or with options
mix_sbom cyclonedx --output=my-sbom.json --format=json --only prod \
  /path/to/your/project

Common Notes

By default dependencies from all environments are included. To include only production dependencies, use --only prod. To include specific environments, use multiple --only flags like --only dev --only test --only prod.

Note that MIX_ENV does not affect which dependencies are included in the output; the task should normally be run in the default (dev) environment

Available Options

  • -o, --output PATH: Output file path (defaults to bom.cdx.json) Use - for STDOUT
  • -s, --schema VERSION: CycloneDX schema version - 1.3, 1.4, 1.5, 1.6, 1.7 (defaults to 1.6)
  • -t, --format FORMAT: Output format - xml, json, protobuf (defaults to json)
  • -l, --only ENV: Only include dependencies from specified environments (defaults to all, use multiple flags for multiple environments)
  • -a, --targets TARGET: Include components from specified Mix targets (defaults to all, use multiple flags for multiple targets)
  • -c, --classification TYPE: Component classification type (defaults to application). Common types include application, framework, and library. See CycloneDX documentation for all available types.
  • -f, --force: Overwrite existing output file
  • -r, --recurse: Recurse into umbrella applications
  • -x, --exclude-system-dependencies: Exclude system dependencies (Erlang/OTP, Elixir, Hex) from the SBoM

For more information:

GitHub Action

This tool is also available as a GitHub Action for use in CI/CD workflows. The action downloads and verifies the provenance of the binary, then generates an SBoM for your project.

Basic Usage

- name: Generate SBoM
  uses: erlef/mix_sbom@v0
  id: sbom
  with:
    project-path: ${{ github.workspace }}
    schema: "1.6"
    format: "json"

- name: Display SBoM
  run: cat "$SBOM_FILE"
  env:
    SBOM_FILE: ${{ steps.sbom.outputs.sbom-path }}

Inputs

  • project-path: Path to the directory containing mix.exs (defaults to repository root)
  • schema: CycloneDX schema version (defaults to "1.6")
  • format: Output format - "json", "xml", or "protobuf" (defaults to "json")
  • reuse-beam: Use local BEAM installation instead of pre-compiled binaries (defaults to "false")
  • include-system-dependencies: Include system dependencies (Erlang/OTP, Elixir, Hex) in the SBoM (defaults to "true")

Outputs

  • sbom-path: Path to the generated SBoM file

The action automatically handles downloading the correct binary for your runner's architecture and verifies its provenance using GitHub's attestation system.

⚠️ Warning: Using reuse-beam: true requires Elixir >= 1.19.4

For the most accurate dependency analysis, it's recommended to use the local BEAM installation by setting reuse-beam: true. This approach:

  • Properly detects Elixir and Erlang versions in the generated SBoM
  • Works with your project's specific runtime environment
  • Provides more accurate dependency information

To use this approach, first set up Elixir/Erlang in your workflow:

- name: Set up Elixir
  uses: erlef/setup-beam@v1
  with:
    elixir-version: '1.17.3'
    otp-version: '27.1'

- name: Get dependencies
  run: mix deps.get

- name: Generate SBoM
  uses: erlef/mix_sbom@v0
  with:
    reuse-beam: true

Note: For most detailed dependency analysis, you should run mix deps.get before using this action to ensure all dependencies are resolved.

NPM packages and other dependencies

This tool only considers Hex, GitHub and BitBucket dependencies managed through Mix. To build a comprehensive SBoM of a deployment, including NPM and/or operating system packages, it may be necessary to merge multiple CycloneDX files into one.

The @cyclonedx/bom tool on NPM can not only generate an SBoM for your JavaScript assets, but it can also merge in the output of the 'sbom.cyclonedx' Mix task and other scanners, through the '-a' option, producing a single CycloneDX XML file.