VulnCheck.Types.Advisory (VulnCheck v1.0.1)

Copy Markdown View Source

A security advisory (or a Hex retirement notice) bound to one package.

OSV records affecting several packages are split into one Advisory per package so that version matching and reachability are evaluated per dependency.

Summary

Functions

Returns the primary CVE identifier of an advisory, if any.

Returns all identifiers (primary id plus aliases), de-duplicated.

The more severe of two severities; :unknown loses to any known severity.

Parses a qualitative severity label ("HIGH", "moderate", ...) without creating atoms.

All severities from most to least severe.

Maps a CVSS score to a qualitative severity (CVSS v3.x and v4.0 share the scale: 0.0 none, 0.1-3.9 low, 4.0-6.9 medium, 7.0-8.9 high, 9.0-10.0 critical).

Types

severity()

@type severity() :: :critical | :high | :medium | :low | :none | :unknown

t()

@type t() :: %VulnCheck.Types.Advisory{
  affected_blocks: [
    %{
      :ranges => [VulnCheck.Types.VersionRange.t()],
      :versions => [String.t()],
      :modules => [String.t()],
      :routines => [VulnCheck.Types.MFA.t()],
      optional(:git_ranges) => [VulnCheck.Types.VersionRange.t()],
      optional(:git_repos) => [String.t()]
    }
  ],
  affected_modules: [String.t()],
  affected_routines: [VulnCheck.Types.MFA.t()],
  affected_versions: [String.t()],
  aliases: [String.t()],
  checked_version: String.t() | nil,
  cvss_method: String.t() | nil,
  cvss_ratings: [
    %{
      default: VulnCheck.Feeds.CVSS.rating() | nil,
      scoped: [
        {[VulnCheck.Types.VersionRange.t()], [String.t()],
         VulnCheck.Feeds.CVSS.rating()}
      ],
      ranges: [VulnCheck.Types.VersionRange.t()],
      versions: [String.t()]
    }
  ],
  cvss_score: float() | nil,
  cvss_source: String.t() | nil,
  cvss_vector: String.t() | nil,
  cwes: [String.t()],
  details: String.t(),
  enriched: boolean(),
  fixed_versions: [String.t()],
  git_match_status: :confirmed | :uncertain | nil,
  git_ranges: [VulnCheck.Types.VersionRange.t()],
  git_repos: [String.t()],
  id: String.t(),
  modified_at: String.t() | nil,
  otp_constraints: String.t() | nil,
  otp_constraints_conflict: boolean(),
  package: String.t(),
  published_at: String.t() | nil,
  qualitative_severity: severity(),
  references: [String.t()],
  retirement: VulnCheck.Types.Retirement.t() | nil,
  severity: severity(),
  source_package: String.t() | nil,
  summary: String.t(),
  symbol_gaps: boolean(),
  symbol_source: :cve | :osv | :osv_and_cve | :text | nil,
  version_ranges: [VulnCheck.Types.VersionRange.t()]
}

Functions

cve_id(advisory)

@spec cve_id(t()) :: String.t() | nil

Returns the primary CVE identifier of an advisory, if any.

iex> VulnCheck.Types.Advisory.cve_id(%VulnCheck.Types.Advisory{id: "EEF-CVE-2026-101028", package: "ash"})
"CVE-2026-101028"

identifiers(advisory)

@spec identifiers(t()) :: [String.t()]

Returns all identifiers (primary id plus aliases), de-duplicated.

max_severity(a, b)

@spec max_severity(severity(), severity()) :: severity()

The more severe of two severities; :unknown loses to any known severity.

iex> VulnCheck.Types.Advisory.max_severity(:medium, :high)
:high
iex> VulnCheck.Types.Advisory.max_severity(:unknown, :low)
:low

parse_severity(label)

@spec parse_severity(String.t() | nil) :: severity()

Parses a qualitative severity label ("HIGH", "moderate", ...) without creating atoms.

severities()

@spec severities() :: [severity()]

All severities from most to least severe.

severity_from_score(score)

@spec severity_from_score(number() | nil) :: severity()

Maps a CVSS score to a qualitative severity (CVSS v3.x and v4.0 share the scale: 0.0 none, 0.1-3.9 low, 4.0-6.9 medium, 7.0-8.9 high, 9.0-10.0 critical).

iex> VulnCheck.Types.Advisory.severity_from_score(9.8)
:critical
iex> VulnCheck.Types.Advisory.severity_from_score(0.0)
:none
iex> VulnCheck.Types.Advisory.severity_from_score(nil)
:unknown