# VulnCheck v1.0.1 - API Reference

## Modules

- [VulnCheck.Diff](VulnCheck.Diff.md): Incremental reporting for pull requests.
- [VulnCheck.ErlTerm](VulnCheck.ErlTerm.md): Atom-safe reader for Erlang term files such as `.app`, `.app.src`,
`rebar.lock` and `rebar.config`.
- [VulnCheck.Explain](VulnCheck.Explain.md): Looks up one advisory and, when the target directory is a project that
locks the affected package, its local reachability status.
- [VulnCheck.Git](VulnCheck.Git.md): Minimal read-only access to the project's Git repository through the
`git` executable.

- [VulnCheck.Ignore](VulnCheck.Ignore.md): Governed suppressions from `.vulncheck.ignore`.
- [VulnCheck.Ignore.Rule](VulnCheck.Ignore.Rule.md): One suppression entry.
- [VulnCheck.Literal](VulnCheck.Literal.md): Safe reader for Elixir-syntax data files (`.vulncheck.exs`, `.vulncheck.ignore`,
`mix.lock`, `mix.exs`, `config/*.exs`).

- Public API
  - [VulnCheck](VulnCheck.md): Function-level reachability vulnerability scanner for Elixir, Erlang and Gleam.
  - [VulnCheck.CLI](VulnCheck.CLI.md): Command line interface shared by the `vulncheck` escript and the Mix tasks.
  - [VulnCheck.Config](VulnCheck.Config.md): Scan configuration resolved from command-line flags, `.vulncheck.exs` and
built-in defaults (in that order of precedence).

- Types
  - [VulnCheck.Types.Advisory](VulnCheck.Types.Advisory.md): A security advisory (or a Hex retirement notice) bound to one package.
  - [VulnCheck.Types.CallEdge](VulnCheck.Types.CallEdge.md): A directed edge of the call graph.
  - [VulnCheck.Types.CallSite](VulnCheck.Types.CallSite.md): A source location (`file:line`) attached to a function call.

  - [VulnCheck.Types.DynamicCall](VulnCheck.Types.DynamicCall.md): A dynamic dispatch site (`apply/2,3` or `mod.fun(...)` with a non-literal
module or function) that could not be resolved statically. `min_arity`
is the number of arguments known to be passed when the exact arity is
not (`apply(m, f, [env | rest])` passes at least one).

  - [VulnCheck.Types.Entrypoint](VulnCheck.Types.Entrypoint.md): A root of the reachability analysis (application callback, configured
adapter, extra entrypoint, exported library function, ...).
  - [VulnCheck.Types.EntrypointModel](VulnCheck.Types.EntrypointModel.md): The BEAM-specific execution model synthesized from `.app` files,
supervision trees, behaviours, framework macros and runtime configuration.

  - [VulnCheck.Types.Finding](VulnCheck.Types.Finding.md): The verdict produced for one advisory against the scanned project.

  - [VulnCheck.Types.MFA](VulnCheck.Types.MFA.md): A `Module.function/arity` reference stored entirely as strings.
  - [VulnCheck.Types.ModuleSummary](VulnCheck.Types.ModuleSummary.md): Everything the analyzer needs to know about one compiled module.
  - [VulnCheck.Types.Package](VulnCheck.Types.Package.md): A locked dependency of the scanned project.
  - [VulnCheck.Types.Retirement](VulnCheck.Types.Retirement.md): Hex.pm retirement metadata attached to a specific package release.

  - [VulnCheck.Types.ScanReport](VulnCheck.Types.ScanReport.md): The complete result of a scan, consumed by every reporter.

  - [VulnCheck.Types.Summary](VulnCheck.Types.Summary.md): Aggregated counters of a scan report.

  - [VulnCheck.Types.TraceHop](VulnCheck.Types.TraceHop.md): One hop of a witness call chain from an entrypoint to a vulnerable routine.
  - [VulnCheck.Types.VersionRange](VulnCheck.Types.VersionRange.md): A single affected version interval.
  - [VulnCheck.Types.Workspace](VulnCheck.Types.Workspace.md): The fully resolved project under audit: project type, target runtime,
locked packages with their scopes and the compiled artifact locations.

- Workspace
  - [VulnCheck.Workspace](VulnCheck.Workspace.md): Stage 1 of the pipeline: loads the project under audit into a
`VulnCheck.Types.Workspace`.
  - [VulnCheck.Workspace.AppFile](VulnCheck.Workspace.AppFile.md): Reader for OTP application resource files (`ebin/<app>.app` and
`src/<app>.app.src`) built on the atom-safe `VulnCheck.ErlTerm` parser.

  - [VulnCheck.Workspace.Detector](VulnCheck.Workspace.Detector.md): Detects the kind of BEAM project located in a directory.
  - [VulnCheck.Workspace.GitUrl](VulnCheck.Workspace.GitUrl.md): Normalizes Git dependency URLs into canonical `owner/repo` slugs without
creating atoms.

  - [VulnCheck.Workspace.GleamManifest](VulnCheck.Workspace.GleamManifest.md): Parser for Gleam projects: `gleam.toml` (direct `[dependencies]` and
`[dev-dependencies]`) and `manifest.toml` (the resolved package set, either
as an inline `packages = [...]` array or as `[[packages]]` tables).

  - [VulnCheck.Workspace.MixLock](VulnCheck.Workspace.MixLock.md): Atom-safe parser for `mix.lock`.
  - [VulnCheck.Workspace.MixProject](VulnCheck.Workspace.MixProject.md): Static (non-evaluating) reader for `mix.exs` files.
  - [VulnCheck.Workspace.MixProject.Dep](VulnCheck.Workspace.MixProject.Dep.md): A dependency declared in `mix.exs`.
  - [VulnCheck.Workspace.RebarLock](VulnCheck.Workspace.RebarLock.md): Parser for rebar3 `rebar.lock` files (both the legacy bare list format and
the versioned `{"1.2.0", [...]}.` format with `pkg_hash` / `pkg_hash_ext`
checksum sections).
  - [VulnCheck.Workspace.Toml](VulnCheck.Workspace.Toml.md): A small TOML reader covering the subset used by `gleam.toml` and Gleam's
`manifest.toml`: tables, arrays of tables, inline tables, arrays (possibly
spanning several lines), basic/literal strings, integers, floats and
booleans. Keys are kept as strings.

- Feeds
  - [VulnCheck.Cache](VulnCheck.Cache.md): Atomic on-disk cache for advisory feeds and analyzed `.beam` modules, plus
air-gapped bundle export/import.
  - [VulnCheck.Feeds.CVSS](VulnCheck.Feeds.CVSS.md): CVSS helpers: computes CVSS v3.0/v3.1 base scores and CVSS v4.0 scores
(`VulnCheck.Feeds.CVSS.V4`) from vector strings.

  - [VulnCheck.Feeds.CVSS.V4](VulnCheck.Feeds.CVSS.V4.md): CVSS v4.0 scores computed from vector strings, following the FIRST
CVSS v4.0 specification (section 8, "CVSS v4.0 Scoring").
  - [VulnCheck.Feeds.EefCna](VulnCheck.Feeds.EefCna.md): Enriches matched advisories with the original CVE 5.1 records published by
the Erlang Ecosystem Foundation CNA (`https://cna.erlef.org/cves/<CVE>.json`,
falling back to the MITRE CVE API).
  - [VulnCheck.Feeds.HexRetired](VulnCheck.Feeds.HexRetired.md): Detects retired Hex.pm releases (the `mix hex.audit` check) and basic
supply-chain hygiene problems in `mix.lock`.
  - [VulnCheck.Feeds.Merge](VulnCheck.Feeds.Merge.md): Folds advisories that describe the same vulnerability of the same package
into one advisory.
  - [VulnCheck.Feeds.OSV](VulnCheck.Feeds.OSV.md): Ingests the OSV.dev Hex ecosystem archive (`Hex/all.zip`).
  - [VulnCheck.Feeds.Store](VulnCheck.Feeds.Store.md): Facade of Stage 2: returns the enriched advisories that affect the locked
packages of a workspace.
  - [VulnCheck.Feeds.TextHints](VulnCheck.Feeds.TextHints.md): Conservative extraction of machine-usable hints from advisory prose.
  - [VulnCheck.HTTP](VulnCheck.HTTP.md): Minimal, hardened HTTP client built on `:httpc` and `:ssl`.

- Analysis
  - [VulnCheck.Beam.AbstractWalker](VulnCheck.Beam.AbstractWalker.md): Walks the Erlang Abstract Format (`:raw_abstract_v1`) of one module and
produces a `VulnCheck.Types.ModuleSummary`.
  - [VulnCheck.Beam.CallGraph](VulnCheck.Beam.CallGraph.md): Immutable call graph indexed by caller and callee.
  - [VulnCheck.Beam.Loader](VulnCheck.Beam.Loader.md): Reads compiled `.beam` files without loading them into the VM.
  - [VulnCheck.Entrypoints](VulnCheck.Entrypoints.md): Synthesizes the BEAM execution model of a workspace: the roots of the
reachability analysis and the indirect edges created by OTP, frameworks
and configuration.
  - [VulnCheck.Entrypoints.Adapters](VulnCheck.Entrypoints.Adapters.md): Resolves which implementation of a pluggable adapter family is configured
(`Tesla`, `Swoosh`, `Ecto`, `Phoenix.PubSub`), so a vulnerable adapter
package that is merely a transitive dependency can be told apart from
the active one.
  - [VulnCheck.Entrypoints.Behaviours](VulnCheck.Entrypoints.Behaviours.md): Synthesizes the call edges that OTP and framework behaviours create at
runtime and that never appear as direct calls in the bytecode.
  - [VulnCheck.Entrypoints.OtpApp](VulnCheck.Entrypoints.OtpApp.md): Computes which OTP applications start at boot and their application
callback modules, from the `.app` resource files of the build.
  - [VulnCheck.Scanner](VulnCheck.Scanner.md): End-to-end scan pipeline
  - [VulnCheck.Semver](VulnCheck.Semver.md): Version comparison and range matching for Hex, Erlang and OTP versions.
  - [VulnCheck.Solver](VulnCheck.Solver.md): Classifies every matched advisory as `:reachable`, `:potentially_reachable`,
`:unreachable` or `:retired` (see `docs/REACHABILITY_MODEL.md`).
  - [VulnCheck.Solver.RoutineScope](VulnCheck.Solver.RoutineScope.md): Splits the routines and modules named by an advisory into those that
belong to the vulnerable package and context routines from elsewhere.

- Reporting
  - [VulnCheck.Report.CycloneDX](VulnCheck.Report.CycloneDX.md): CycloneDX 1.6 JSON bill of materials (`--sbom` or `--format cyclonedx`).
  - [VulnCheck.Report.Formatter](VulnCheck.Report.Formatter.md): Contract of report renderers plus helpers shared by them.

  - [VulnCheck.Report.GitHub](VulnCheck.Report.GitHub.md): GitHub Actions report (`--format github`).
  - [VulnCheck.Report.GitLab](VulnCheck.Report.GitLab.md): GitLab Code Quality report (`--format gitlab`), usually saved as
`gl-code-quality-report.json` and published with
`artifacts:reports:codequality`.

  - [VulnCheck.Report.JSON](VulnCheck.Report.JSON.md): Native JSON report (`--format json`, `schema_version` 1.0.0).
  - [VulnCheck.Report.Markdown](VulnCheck.Report.Markdown.md): GitHub Flavored Markdown report (`--format markdown`) for pull request
comments and audit wikis.
  - [VulnCheck.Report.OpenVEX](VulnCheck.Report.OpenVEX.md): OpenVEX v0.2.0 document (`--vex` or `--format openvex`).
  - [VulnCheck.Report.SARIF](VulnCheck.Report.SARIF.md): SARIF 2.1.0 report (`--format sarif`) for GitHub Code Scanning and other
static analysis dashboards.
  - [VulnCheck.Report.Terminal](VulnCheck.Report.Terminal.md): Human-oriented console report (`--format terminal`, the default).

## Mix Tasks

- [mix vulncheck](Mix.Tasks.Vulncheck.md): Audits the locked dependencies of the current project against OSV.dev and
EEF CNA advisories and proves, on the compiled `.beam` call graph, whether
each vulnerable function can run in production.
- [mix vulncheck.explain](Mix.Tasks.Vulncheck.Explain.md): Prints an advisory (`CVE-...`, `EEF-CVE-...` or `GHSA-...`): summary, CVSS,
CWE, references, affected and fixed versions and function-level routines.
When the project locks the affected package, the installed version, the
reachability verdict and the call trace are shown as well.
- [mix vulncheck.feeds](Mix.Tasks.Vulncheck.Feeds.md): Manages the local advisory cache.
- [mix vulncheck.init](Mix.Tasks.Vulncheck.Init.md): Writes a commented `.vulncheck.exs` tailored to the project: detected
frameworks, adapters configured in `config/*.exs` and release entrypoints.

