# VEX and suppression

The VEX formats the Vulnesis CLI reads and writes, where VEX changes scan results, and how ignore rules, nosec comments and VEX suppress findings.

VEX is for teams that publish software and must tell its users which reported vulnerabilities do not affect it, and for teams that receive those statements and want their scans to stop reporting what a vendor has already ruled out. An [SBOM](/sbom.md) lists what is in a product. VEX says which of the vulnerabilities in it matter, and [attestation](/attestation.md) proves who signed either one. Use VEX when the question is whether a finding applies, not what is installed.

A VEX statement says whether a product is affected by a vulnerability. The CLI writes VEX for its own triage decisions, reads VEX that anyone else wrote, applies it to SBOMs and scans, and sends it to Vulnesis, where false-positive and won't-fix statements become suppression rules.

Two mechanisms hide findings, and they are reported differently:

| Mechanism | Who asserts it | Scope | Reported as |
|---|---|---|---|
| [VEX statements](/vex/scans/vex-file.md) (`--vex-file`, `--vex`, declared `VexSource` documents, `vex apply`) | The document's author, often an upstream vendor | Vulnerabilities in an SBOM | "VEX not affected" or "VEX fixed" |
| [Ignore rules](/vex/suppression/ignore-rules.md) (`vulnetix ignore`) and [nosec comments](/vex/suppression/nosec-and-test-code.md) | Your team | Findings of every scanner | "suppressed by ignore rules" or "by nosec comments" |

## Formats

| Format | Read | Written |
|---|---|---|
| OpenVEX 0.2.0 | yes, recognised by an `@context` on `openvex.dev` | `vex merge`, `bom enrich` companion file, `triage --vex-format openvex`, scan reconciliation files under `.vulnetix/` |
| CycloneDX VEX | yes, any document with `bomFormat: CycloneDX`. Only `vulnerabilities[]` entries with an `analysis` block are statements. | `triage` (default `--vex-format cdx`), `vex apply --out`, `bom enrich` |
| CSAF 2.0 VEX | yes, recognised by a `document.category` containing `vex` | no |

All three are normalised into one statement model, so matching and application work the same whichever format the author used. The CLI validates against the vendored `openvex-0.2.0` and `cyclonedx-1.7` schemas in `cli/schemas/third_party/`.

### Status mapping

| OpenVEX status | CycloneDX `analysis.state` | CSAF product status | Suppresses in `vex apply` and scans |
|---|---|---|---|
| `not_affected` | `not_affected`, `false_positive` | `known_not_affected` | yes |
| `fixed` | `resolved`, `resolved_with_pedigree` | `fixed` | yes |
| `affected` | `exploitable` | `known_affected` | no, adds an action statement |
| `under_investigation` | `in_triage` | `under_investigation` | no |

To state one of these CycloneDX states on a finding in an SBOM the CLI writes, set `vulnerabilities[].analysis` in an [overlay file](/sbom/author/overlay.md#vulnerability-analysis).

## Commands

| Command | Does |
|---|---|
| [`vulnetix vex apply`](/vex/commands/apply.md) | Apply statements to an SBOM and report total, suppressed and effective counts |
| [`vulnetix vex ls`, `validate`, `merge`](/vex/commands/ls-validate-merge.md) | Review, check and combine VEX documents |
| [`--vex-file` and `--vex`](/vex/scans/vex-file.md) on `scan`, `sca`, `sast`, `secrets`, `containers`, `iac` | Apply VEX from files, directories and https URLs before the quality gates. `--vex` needs CLI v4.2.0. An authenticated scan also applies the Resolve Platform's statements (CLI v4.4.0). |
| [`vulnetix ignore`](/vex/suppression/ignore-rules.md) (alias `suppress`) | Add, list, remove and sync ignore rules |
| `vulnetix vdb vex get`, `vdb vex list` | Read VEX that Vulnesis holds for a CVE. See [VDB API](/vdb-api.md). |

To apply a vendor's VEX document to a scan and check it step by step, follow the [VEX quickstart](/vex/get-started/quickstart.md). Every VEX file the CLI writes under `.vulnetix/` is on [VEX the CLI writes](/vex/reference/files-written.md).

## What reaches Vulnesis

When a command is authenticated, the VEX it read or wrote is sent to `POST /v2/cli.vex-ingest`, and the findings ignore rules and nosec comments hid are reported to `cli.finalize`. See [VEX sent to Vulnesis](/vex/suppression/sent-to-vulnetix.md).

A standing source of suppression rules, read from a TEA server, an S3 bucket, a git repository or URLs, is the `VexSource` kind. Since CLI v4.2.0 a scan also reads the `path` and `urls` sources declared under `.vulnetix/config` itself, and since CLI v4.4.0 an authenticated scan applies the statements the Resolve Platform holds for every source type, `tea`, `s3` and `git` included; see [Declared VexSource documents](/vex/scans/vex-file.md#declared-vexsource-documents), [Statements the Resolve Platform holds](/vex/scans/vex-file.md#statements-the-resolve-platform-holds) and [VEX documents as suppression rules](/platform-iac/guides/vex-sources.md).

## GitHub Actions

Validate, list, merge or apply VEX documents in a workflow with the [vex GitHub Action](/vex/github-actions/vex.md).

## Platform IaC

Suppression rules you write are [`Suppression`](/platform-iac/kinds/suppression.md) documents. A standing source of VEX, read from a TEA server, an S3 bucket, a git repository or URLs, is a [`VexSource`](/platform-iac/kinds/vex-source.md); see [VEX documents as suppression rules](/platform-iac/guides/vex-sources.md). Rules from a local `.vulnetix/memory.yaml` and `vulnetix ignore` stay as they are. See the [kind catalogue](/platform-iac/kinds/catalogue.md).

When [Drift protection](/platform-iac/guides/drift-protection.md) is on, a change made in the Resolve Platform or through a legacy API to a suppression rule that is managed as code (by Terraform or a repository) is refused with HTTP 409 `managed_by_platform_iac`. Change it where it is declared, or ask an owner to turn Drift protection off. Rules written as a side effect of triaging a finding are not blocked.
