VulnCheck.Report.OpenVEX (VulnCheck v1.0.1)

Copy Markdown View Source

OpenVEX v0.2.0 document (--vex or --format openvex).

One statement per advisory and package. The status follows the reachability verdict:

Verdict and reasonstatusjustification
reachableaffected (with action_statement)—
potentially reachableunder_investigation—
unreachable: function not called, module not loaded, adapter not configured, OTP application not startednot_affectedvulnerable_code_not_in_execute_path
unreachable: build-time only dependency (runtime: false)not_affectedvulnerable_code_not_in_execute_path
unreachable: development or test dependencynot_affectedcomponent_not_present
unreachable: OTP version unaffectednot_affectedOTP constraint in impact_statement

Retired releases are left out. With zero statements, no OpenVEX document is available. The document @id is derived from its content.

Summary

Functions

The VEX document as plain maps, or nil when there are no statements.

Encodes the VEX document, or returns an empty string when there are no statements.

Status fields of the statement for a finding.

Functions

document(report, config, opts \\ [])

@spec document(VulnCheck.Types.ScanReport.t(), VulnCheck.Config.t(), keyword()) ::
  map() | nil

The VEX document as plain maps, or nil when there are no statements.

encode(report, config, opts \\ [])

Encodes the VEX document, or returns an empty string when there are no statements.

status(f)

@spec status(VulnCheck.Types.Finding.t()) :: map()

Status fields of the statement for a finding.