Struct Advisory 

pub struct Advisory {

    pub id: String,
    pub name: String,
    pub kind: AdvisoryKind,
    pub cve: Option<String>,
    pub osvdb: Option<String>,
    pub ghsa: Option<String>,
    pub url: Option<String>,
    pub title: Option<String>,
    pub date: Option<String>,
    pub description: Option<String>,
    pub cvss_v2: Option<f64>,
    pub cvss_v3: Option<f64>,
    pub framework: Option<String>,
    pub patched_versions: Vec<Requirement>,
    pub unaffected_versions: Vec<Requirement>,
}

A security advisory loaded from the ruby-advisory-db.

Fields

id: String

The advisory identifier (filename without .yml).

name: String

The affected gem or Ruby engine name.

kind: AdvisoryKind

Whether this advisory is for a gem or a Ruby interpreter.

cve: Option<String>

CVE identifier (e.g., “2020-1234”).

osvdb: Option<String>

OSVDB identifier.

ghsa: Option<String>

GitHub Security Advisory identifier (e.g., “aaaa-bbbb-cccc”).

url: Option<String>

URL with vulnerability details.

title: Option<String>

Vulnerability title.

date: Option<String>

Discovery/publication date.

description: Option<String>

Full vulnerability description.

cvss_v2: Option<f64>

CVSS v2 score (0.0-10.0).

cvss_v3: Option<f64>

CVSS v3 score (0.0-10.0).

framework: Option<String>

Framework (e.g., “rails”).

patched_versions: Vec<Requirement>

Version requirements for patched versions.

unaffected_versions: Vec<Requirement>

Version requirements for unaffected versions.

Implementations

impl Advisory

pub fn load(path: &Path) -> Result<Self, AdvisoryError>

Load an advisory from a YAML file.

pub fn from_yaml(yaml: &str, path: &Path) -> Result<Self, AdvisoryError>

Parse an advisory from a YAML string with a path for ID extraction.

pub fn patched(&self, version: &Version) -> bool

Check if the given version is patched against this advisory.

pub fn unaffected(&self, version: &Version) -> bool

Check if the given version is unaffected by this advisory.

pub fn vulnerable(&self, version: &Version) -> bool

Check if the given version is vulnerable to this advisory.

A version is vulnerable if it is neither patched nor unaffected.

pub fn cve_id(&self) -> Option<String>

The CVE identifier string (e.g., “CVE-2020-1234”).

pub fn osvdb_id(&self) -> Option<String>

The OSVDB identifier string (e.g., “OSVDB-91452”).

pub fn ghsa_id(&self) -> Option<String>

The GHSA identifier string (e.g., “GHSA-aaaa-bbbb-cccc”).

pub fn identifiers(&self) -> Vec<String>

All identifiers (CVE, OSVDB, GHSA) as a list.

pub fn criticality(&self) -> Option<Criticality>

Determine the criticality based on CVSS scores.

CVSS v3 is preferred over v2. Scoring follows NIST/NVD guidelines.

Trait Implementations

impl Clone for Advisory

fn clone(&self) -> Advisory

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Advisory

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Display for Advisory

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.