Vulnesis/cli/cbom action
The Vulnesis/cli/cbom GitHub Action: inputs, outputs, permissions and a complete workflow with artifact upload and attestation.
Installs the CLI and runs vulnetix cbom, which writes a CycloneDX cryptography bill of materials to .vulnetix/cbom.cdx.json.
steps:
- uses: actions/checkout@v5
- uses: Vulnesis/cli/cbom@v4
with:
org-id: ${{ secrets.VULNESIS_ORG_ID }}
api-key: ${{ secrets.VULNESIS_API_KEY }}
Runs vulnetix cbom --path <path> [--sign] with the identity inputs below. Credentials are optional: without org-id and a credential the CLI runs in community mode. They reach the CLI only as environment variables; see Credentials.
Inputs
| Input | Description | Default |
|---|---|---|
version |
Release of the Vulnesis CLI to install. Empty installs the release this action ref was cut from, which is what a lock file or a SHA pin expects. An exact tag (v4.0.0), a major channel (v4) or latest float instead | - |
binary-path |
Path to an already-built vulnetix binary to use instead of downloading a release | - |
verify-provenance |
Verify the downloaded CLI against the signed SLSA provenance of its release with cosign, which this action installs: true or false. Every v4 release is signed; set false to install a v3 release that has no provenance.sigstore.json. The SHA-256 checksum is checked either way | true |
org-id |
Vulnesis organization ID (UUID), used with api-key. Optional: without credentials the CLI runs in community mode | - |
api-key |
Vulnesis API key. Passed to the CLI as VULNESIS_API_KEY, never on the command line | - |
api-token |
Vulnesis API token; the server resolves the organization. Passed as VULNESIS_API_TOKEN | - |
path |
Directory to scan | . |
args |
Extra arguments for the command, separated by spaces or newlines (no shell quoting is applied) | - |
extra-args |
Extra arguments, one per line, so a value may contain spaces | - |
artifact-name |
Upload every file the command wrote as a workflow artifact with this name | - |
fail-on-findings |
Fail the step when the command exits non-zero (findings over a gate, a breach, an error): true or false. The artifact, attestation and publish steps run either way | true |
github-token |
Token for GitHub publishing, release assets and pull request comments | ${{ github.token }} |
attest |
Attest the written files with GitHub artifact attestations (needs id-token: write and attestations: write): true or false | false |
release-tag |
Attach every file the command wrote to the GitHub release with this tag (needs contents: write) | - |
sign |
Sign the document with the runner’s OIDC identity (needs id-token: write): true or false | false |
bom-manufacturer |
Organisation that created the BOM (metadata.manufacturer); defaults to the repository owner | - |
bom-author |
Author of the document as Name |
- |
bom-supplier |
Supplier of the component the BOM describes (metadata.supplier) | - |
bom-license |
Licence of the document itself, an SPDX id or expression (metadata.licenses) | - |
bom-property |
Document property as name=value, one per line (metadata.properties; passed as –bom-property) | - |
bom-overlay |
CycloneDX JSON fragments merged into the document before validation, one path per line (passed as –bom-overlay) | - |
args is split on spaces and newlines. No shell quoting is applied, and nothing is evaluated.
The identity inputs arrived in CLI v4.15.0. Values without spaces, such as --bom-serial and --component-version, go in args or the VULNESIS_BOM_* and VULNESIS_COMPONENT_* environment variables. See Overlay files.
Outputs
| Output | Description |
|---|---|
files |
Every file the command wrote, one per line |
sarif |
The SARIF files it wrote, one per line |
sbom |
The CycloneDX SBOM it wrote, if any |
manifest |
The artifact manifest (JSON Lines) listing what it wrote |
exit-code |
The command’s exit code |
result |
success or failure |
summary |
One line saying what ran and how it ended |
Permissions
contents: readto check out the repositoryid-token: writeandattestations: writewithattest: truecontents: writewithrelease-tag
Example workflow
name: Vulnesis CBOM
on:
push:
branches: [main]
jobs:
cbom:
runs-on: ubuntu-latest
permissions:
contents: read
id-token: write
attestations: write
steps:
- uses: actions/checkout@v5
- uses: Vulnesis/cli/cbom@v4
with:
org-id: ${{ secrets.VULNESIS_ORG_ID }}
api-key: ${{ secrets.VULNESIS_API_KEY }}
artifact-name: vulnetix-cbom
attest: true
artifact-name uploads every file the command wrote as one workflow artifact. attest: true attests those files with GitHub artifact attestations.
Behaviour
- The CBOM is always written;
--output-fileinargschanges where. The artifact manifest records the final path, so thefilesoutput is correct either way. fileslists the paths of everything the command wrote, one per line.sarifandsbomnarrow that to the SARIF files and the CycloneDX SBOM.
Upload and attest in your own steps
The built-in artifact-name and attest inputs are the short form. To control those steps yourself, use the outputs. The action’s last step fails the job with the command’s exit code, so later steps need if: ${{ !cancelled() }}; the example turns the failure off and re-raises it at the end.
- uses: Vulnesis/cli/cbom@v4
id: vulnetix
with:
org-id: ${{ secrets.VULNESIS_ORG_ID }}
api-key: ${{ secrets.VULNESIS_API_KEY }}
fail-on-findings: false
- uses: actions/upload-artifact@v7
if: ${{ !cancelled() }}
with:
name: vulnetix-cbom
path: ${{ steps.vulnetix.outputs.files }}
include-hidden-files: true
- uses: actions/attest-build-provenance@v4
if: ${{ !cancelled() }}
with:
subject-path: ${{ steps.vulnetix.outputs.files }}
- name: Fail on the command's exit code
if: ${{ steps.vulnetix.outputs.exit-code != '0' }}
env:
EXIT_CODE: ${{ steps.vulnetix.outputs.exit-code }}
run: exit "$EXIT_CODE"
Verify an attestation made this way with gh attestation verify <file> --repo <owner>/<repo>.