Vulnesis/cli/attest action
The Vulnesis/cli/attest GitHub Action: inputs, outputs, permissions and a complete workflow with artifact upload and attestation.
Installs the CLI and runs vulnetix attest verify, which verifies an artefact’s signature, identity and provenance. It is the consuming side of the attest input the other actions offer.
steps:
- uses: actions/checkout@v5
- uses: Vulnesis/cli/attest@v4
with:
subject: dist/app.tar.gz
Runs vulnetix attest verify <subject>. 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 | - |
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) | - |
subject |
The artefact to verify | - |
args is split on spaces and newlines. No shell quoting is applied, and nothing is evaluated.
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: Verify a release artefact
on:
workflow_dispatch:
inputs:
tag:
required: true
jobs:
verify:
runs-on: ubuntu-latest
permissions:
contents: read
steps:
- name: Download the release asset and its attestation
env:
GH_TOKEN: ${{ github.token }}
TAG: ${{ inputs.tag }}
run: gh release download "$TAG" --repo "$GITHUB_REPOSITORY" --pattern 'sbom.cdx.json*'
- uses: Vulnesis/cli/attest@v4
with:
subject: sbom.cdx.json
- name: Check the GitHub attestation
env:
GH_TOKEN: ${{ github.token }}
run: gh attestation verify sbom.cdx.json --repo "$GITHUB_REPOSITORY"
artifact-name uploads every file the command wrote as one workflow artifact. attest: true attests those files with GitHub artifact attestations.
Behaviour
subjectis one artefact per line, each passed as a positional argument. Trust and pinning options go inargs: Trust and pinning.- A failed verification exits non-zero and fails the job. With
fail-on-findings: falsethe failure becomes a warning, which defeats the check: leave it attrue. - To check a GitHub artifact attestation made by the
attestinput,gh attestation verify <file> --repo <owner>/<repo>is the GitHub side of the same check.