Struct CweDatabase 

pub struct CweDatabase { /* private fields */ }

A CWE weakness database.

Implementations

impl CweDatabase

pub fn new() -> CweDatabase

Create a new empty CWE database.

Examples found in repository

examples/cwe.rs (line 10)

fn main() -> Result<(), Box<dyn std::error::Error>> {
    let mut cwe_db = CweDatabase::new();

    // Import the 3 main CWE catalogs from the official website.
    cwe_db.import_weakness_catalog_from_url("https://cwe.mitre.org/data/xml/views/699.xml.zip")?;
    cwe_db.import_weakness_catalog_from_url("https://cwe.mitre.org/data/xml/views/1000.xml.zip")?;
    cwe_db.import_weakness_catalog_from_url("https://cwe.mitre.org/data/xml/views/1194.xml.zip")?;

    cwe_db.infer_categories_from_ancestors();
    cwe_db.infer_categories_from_descendants();

    // Retrieve a weakness by its ID (CWE-73).
    let cwe_id: i64 = 306;
    let weakness = cwe_db.weakness_by_cwe_id(cwe_id);
    println!("Weakness CWE-ID-{}\n{:#?}", cwe_id, weakness);

    // Display the categories of the weakness (if any).
    let categories = cwe_db.categories_by_cwe_id(cwe_id);
    println!("Categories {:#?}", categories);

    let children = cwe_db.weakness_children_by_cwe_id(1076);
    println!("CWE-{} has {} children", cwe_id, children.len());

    println!("{} CWE roots", cwe_db.weakness_roots().len());
    for root in &cwe_db.weakness_roots() {
        println!("CWE-{} is a root '{}'", root.id, root.name);
    }

    let mut visitor = Visitor;

    cwe_db.visit_weaknesses(&mut visitor);

    // Display the CWE catalog summary.
    println!("{}", cwe_db);

    Ok(())
}

pub fn import_weakness_catalog_from_str( &mut self, xml: &str, ) -> Result<(), Error>

Import a CWE catalog from a string containing the XML.

pub fn import_weakness_catalog_from_url( &mut self, url: &str, ) -> Result<(), Error>

Import a CWE catalog from an URL string containing the XML.

Examples found in repository

examples/cwe.rs (line 13)

fn main() -> Result<(), Box<dyn std::error::Error>> {
    let mut cwe_db = CweDatabase::new();

    // Import the 3 main CWE catalogs from the official website.
    cwe_db.import_weakness_catalog_from_url("https://cwe.mitre.org/data/xml/views/699.xml.zip")?;
    cwe_db.import_weakness_catalog_from_url("https://cwe.mitre.org/data/xml/views/1000.xml.zip")?;
    cwe_db.import_weakness_catalog_from_url("https://cwe.mitre.org/data/xml/views/1194.xml.zip")?;

    cwe_db.infer_categories_from_ancestors();
    cwe_db.infer_categories_from_descendants();

    // Retrieve a weakness by its ID (CWE-73).
    let cwe_id: i64 = 306;
    let weakness = cwe_db.weakness_by_cwe_id(cwe_id);
    println!("Weakness CWE-ID-{}\n{:#?}", cwe_id, weakness);

    // Display the categories of the weakness (if any).
    let categories = cwe_db.categories_by_cwe_id(cwe_id);
    println!("Categories {:#?}", categories);

    let children = cwe_db.weakness_children_by_cwe_id(1076);
    println!("CWE-{} has {} children", cwe_id, children.len());

    println!("{} CWE roots", cwe_db.weakness_roots().len());
    for root in &cwe_db.weakness_roots() {
        println!("CWE-{} is a root '{}'", root.id, root.name);
    }

    let mut visitor = Visitor;

    cwe_db.visit_weaknesses(&mut visitor);

    // Display the CWE catalog summary.
    println!("{}", cwe_db);

    Ok(())
}

pub fn import_weakness_catalog_from_file( &mut self, xml_file: &str, ) -> Result<(), Error>

Import a CWE catalog from a file containing the XML.

pub fn import_weakness_catalog_from_reader<R>( &mut self, reader: R, ) -> Result<(), Error>

where R: BufRead,

Import a CWE catalog from a reader containing the XML.

pub fn weakness_by_cwe_id(&self, cwe_id: i64) -> Option<Rc<Weakness>>

Returns a reference to a Weakness struct if the CWE-ID exists in the catalog.

Examples found in repository

examples/cwe.rs (line 22)

fn main() -> Result<(), Box<dyn std::error::Error>> {
    let mut cwe_db = CweDatabase::new();

    // Import the 3 main CWE catalogs from the official website.
    cwe_db.import_weakness_catalog_from_url("https://cwe.mitre.org/data/xml/views/699.xml.zip")?;
    cwe_db.import_weakness_catalog_from_url("https://cwe.mitre.org/data/xml/views/1000.xml.zip")?;
    cwe_db.import_weakness_catalog_from_url("https://cwe.mitre.org/data/xml/views/1194.xml.zip")?;

    cwe_db.infer_categories_from_ancestors();
    cwe_db.infer_categories_from_descendants();

    // Retrieve a weakness by its ID (CWE-73).
    let cwe_id: i64 = 306;
    let weakness = cwe_db.weakness_by_cwe_id(cwe_id);
    println!("Weakness CWE-ID-{}\n{:#?}", cwe_id, weakness);

    // Display the categories of the weakness (if any).
    let categories = cwe_db.categories_by_cwe_id(cwe_id);
    println!("Categories {:#?}", categories);

    let children = cwe_db.weakness_children_by_cwe_id(1076);
    println!("CWE-{} has {} children", cwe_id, children.len());

    println!("{} CWE roots", cwe_db.weakness_roots().len());
    for root in &cwe_db.weakness_roots() {
        println!("CWE-{} is a root '{}'", root.id, root.name);
    }

    let mut visitor = Visitor;

    cwe_db.visit_weaknesses(&mut visitor);

    // Display the CWE catalog summary.
    println!("{}", cwe_db);

    Ok(())
}

pub fn categories_by_cwe_id(&self, cwe_id: i64) -> HashSet<Rc<Category>>

Returns a list of categories for a given CWE-ID.

Examples found in repository

examples/cwe.rs (line 26)

fn main() -> Result<(), Box<dyn std::error::Error>> {
    let mut cwe_db = CweDatabase::new();

    // Import the 3 main CWE catalogs from the official website.
    cwe_db.import_weakness_catalog_from_url("https://cwe.mitre.org/data/xml/views/699.xml.zip")?;
    cwe_db.import_weakness_catalog_from_url("https://cwe.mitre.org/data/xml/views/1000.xml.zip")?;
    cwe_db.import_weakness_catalog_from_url("https://cwe.mitre.org/data/xml/views/1194.xml.zip")?;

    cwe_db.infer_categories_from_ancestors();
    cwe_db.infer_categories_from_descendants();

    // Retrieve a weakness by its ID (CWE-73).
    let cwe_id: i64 = 306;
    let weakness = cwe_db.weakness_by_cwe_id(cwe_id);
    println!("Weakness CWE-ID-{}\n{:#?}", cwe_id, weakness);

    // Display the categories of the weakness (if any).
    let categories = cwe_db.categories_by_cwe_id(cwe_id);
    println!("Categories {:#?}", categories);

    let children = cwe_db.weakness_children_by_cwe_id(1076);
    println!("CWE-{} has {} children", cwe_id, children.len());

    println!("{} CWE roots", cwe_db.weakness_roots().len());
    for root in &cwe_db.weakness_roots() {
        println!("CWE-{} is a root '{}'", root.id, root.name);
    }

    let mut visitor = Visitor;

    cwe_db.visit_weaknesses(&mut visitor);

    // Display the CWE catalog summary.
    println!("{}", cwe_db);

    Ok(())
}

struct Visitor;

impl WeaknessVisitor for Visitor {
    fn visit(&mut self, db: &CweDatabase, level: usize, weakness: Rc<Weakness>) {
        let cats = db.categories_by_cwe_id(weakness.id).iter().map(|c| c.name.clone()).collect::<Vec<_>>();

        println!("{} CWE-{} {} (subtree-size: {}, categories: {:?})",
                 " ".repeat(level * 2),
                 weakness.id,
                 weakness.name,
                 db.weakness_subtree_by_cwe_id(weakness.id).len(),
                 cats
        );
    }

pub fn weakness_children_by_cwe_id(&self, cwe_id: i64) -> HashSet<Rc<Weakness>>

Returns a list of weaknesses that are children of a given CWE-ID.

Examples found in repository

examples/cwe.rs (line 29)

fn main() -> Result<(), Box<dyn std::error::Error>> {
    let mut cwe_db = CweDatabase::new();

    // Import the 3 main CWE catalogs from the official website.
    cwe_db.import_weakness_catalog_from_url("https://cwe.mitre.org/data/xml/views/699.xml.zip")?;
    cwe_db.import_weakness_catalog_from_url("https://cwe.mitre.org/data/xml/views/1000.xml.zip")?;
    cwe_db.import_weakness_catalog_from_url("https://cwe.mitre.org/data/xml/views/1194.xml.zip")?;

    cwe_db.infer_categories_from_ancestors();
    cwe_db.infer_categories_from_descendants();

    // Retrieve a weakness by its ID (CWE-73).
    let cwe_id: i64 = 306;
    let weakness = cwe_db.weakness_by_cwe_id(cwe_id);
    println!("Weakness CWE-ID-{}\n{:#?}", cwe_id, weakness);

    // Display the categories of the weakness (if any).
    let categories = cwe_db.categories_by_cwe_id(cwe_id);
    println!("Categories {:#?}", categories);

    let children = cwe_db.weakness_children_by_cwe_id(1076);
    println!("CWE-{} has {} children", cwe_id, children.len());

    println!("{} CWE roots", cwe_db.weakness_roots().len());
    for root in &cwe_db.weakness_roots() {
        println!("CWE-{} is a root '{}'", root.id, root.name);
    }

    let mut visitor = Visitor;

    cwe_db.visit_weaknesses(&mut visitor);

    // Display the CWE catalog summary.
    println!("{}", cwe_db);

    Ok(())
}

pub fn weakness_subtree_by_cwe_id(&self, cwe_id: i64) -> Vec<Rc<Weakness>>

Returns a list of weaknesses that are children of a given CWE-ID. The list does not contain the weakness for the given CWE-ID.

Examples found in repository

examples/cwe.rs (line 57)

    fn visit(&mut self, db: &CweDatabase, level: usize, weakness: Rc<Weakness>) {
        let cats = db.categories_by_cwe_id(weakness.id).iter().map(|c| c.name.clone()).collect::<Vec<_>>();

        println!("{} CWE-{} {} (subtree-size: {}, categories: {:?})",
                 " ".repeat(level * 2),
                 weakness.id,
                 weakness.name,
                 db.weakness_subtree_by_cwe_id(weakness.id).len(),
                 cats
        );
    }

pub fn weakness_roots(&self) -> HashSet<Rc<Weakness>>

Returns a list of weaknesses that are roots, i.e. they have no parents.

Examples found in repository

examples/cwe.rs (line 32)

fn main() -> Result<(), Box<dyn std::error::Error>> {
    let mut cwe_db = CweDatabase::new();

    // Import the 3 main CWE catalogs from the official website.
    cwe_db.import_weakness_catalog_from_url("https://cwe.mitre.org/data/xml/views/699.xml.zip")?;
    cwe_db.import_weakness_catalog_from_url("https://cwe.mitre.org/data/xml/views/1000.xml.zip")?;
    cwe_db.import_weakness_catalog_from_url("https://cwe.mitre.org/data/xml/views/1194.xml.zip")?;

    cwe_db.infer_categories_from_ancestors();
    cwe_db.infer_categories_from_descendants();

    // Retrieve a weakness by its ID (CWE-73).
    let cwe_id: i64 = 306;
    let weakness = cwe_db.weakness_by_cwe_id(cwe_id);
    println!("Weakness CWE-ID-{}\n{:#?}", cwe_id, weakness);

    // Display the categories of the weakness (if any).
    let categories = cwe_db.categories_by_cwe_id(cwe_id);
    println!("Categories {:#?}", categories);

    let children = cwe_db.weakness_children_by_cwe_id(1076);
    println!("CWE-{} has {} children", cwe_id, children.len());

    println!("{} CWE roots", cwe_db.weakness_roots().len());
    for root in &cwe_db.weakness_roots() {
        println!("CWE-{} is a root '{}'", root.id, root.name);
    }

    let mut visitor = Visitor;

    cwe_db.visit_weaknesses(&mut visitor);

    // Display the CWE catalog summary.
    println!("{}", cwe_db);

    Ok(())
}

pub fn visit_weaknesses(&self, visitor: &mut impl WeaknessVisitor)

Visit all root weaknesses in the database and their children.

Examples found in repository

examples/cwe.rs (line 39)

fn main() -> Result<(), Box<dyn std::error::Error>> {
    let mut cwe_db = CweDatabase::new();

    // Import the 3 main CWE catalogs from the official website.
    cwe_db.import_weakness_catalog_from_url("https://cwe.mitre.org/data/xml/views/699.xml.zip")?;
    cwe_db.import_weakness_catalog_from_url("https://cwe.mitre.org/data/xml/views/1000.xml.zip")?;
    cwe_db.import_weakness_catalog_from_url("https://cwe.mitre.org/data/xml/views/1194.xml.zip")?;

    cwe_db.infer_categories_from_ancestors();
    cwe_db.infer_categories_from_descendants();

    // Retrieve a weakness by its ID (CWE-73).
    let cwe_id: i64 = 306;
    let weakness = cwe_db.weakness_by_cwe_id(cwe_id);
    println!("Weakness CWE-ID-{}\n{:#?}", cwe_id, weakness);

    // Display the categories of the weakness (if any).
    let categories = cwe_db.categories_by_cwe_id(cwe_id);
    println!("Categories {:#?}", categories);

    let children = cwe_db.weakness_children_by_cwe_id(1076);
    println!("CWE-{} has {} children", cwe_id, children.len());

    println!("{} CWE roots", cwe_db.weakness_roots().len());
    for root in &cwe_db.weakness_roots() {
        println!("CWE-{} is a root '{}'", root.id, root.name);
    }

    let mut visitor = Visitor;

    cwe_db.visit_weaknesses(&mut visitor);

    // Display the CWE catalog summary.
    println!("{}", cwe_db);

    Ok(())
}

pub fn direct_ancestors_by_cwe_id(&self, cwe_id: i64) -> HashSet<Rc<Weakness>>

Returns the direct weakness ancestors of a given CWE-ID.

pub fn merge_categories_by_cwe_id( &mut self, cwe_id: i64, categories: HashSet<Rc<Category>>, )

Merge the given categories into the category index for the given CWE-ID.

pub fn all_categories(&self) -> HashSet<Rc<Category>>

Returns a list of all categories in the database (across all catalogs).

pub fn infer_categories_from_ancestors(&mut self)

Sub-weaknesses inherit the categories of their parent weaknesses.

Examples found in repository

examples/cwe.rs (line 17)

fn main() -> Result<(), Box<dyn std::error::Error>> {
    let mut cwe_db = CweDatabase::new();

    // Import the 3 main CWE catalogs from the official website.
    cwe_db.import_weakness_catalog_from_url("https://cwe.mitre.org/data/xml/views/699.xml.zip")?;
    cwe_db.import_weakness_catalog_from_url("https://cwe.mitre.org/data/xml/views/1000.xml.zip")?;
    cwe_db.import_weakness_catalog_from_url("https://cwe.mitre.org/data/xml/views/1194.xml.zip")?;

    cwe_db.infer_categories_from_ancestors();
    cwe_db.infer_categories_from_descendants();

    // Retrieve a weakness by its ID (CWE-73).
    let cwe_id: i64 = 306;
    let weakness = cwe_db.weakness_by_cwe_id(cwe_id);
    println!("Weakness CWE-ID-{}\n{:#?}", cwe_id, weakness);

    // Display the categories of the weakness (if any).
    let categories = cwe_db.categories_by_cwe_id(cwe_id);
    println!("Categories {:#?}", categories);

    let children = cwe_db.weakness_children_by_cwe_id(1076);
    println!("CWE-{} has {} children", cwe_id, children.len());

    println!("{} CWE roots", cwe_db.weakness_roots().len());
    for root in &cwe_db.weakness_roots() {
        println!("CWE-{} is a root '{}'", root.id, root.name);
    }

    let mut visitor = Visitor;

    cwe_db.visit_weaknesses(&mut visitor);

    // Display the CWE catalog summary.
    println!("{}", cwe_db);

    Ok(())
}

pub fn infer_categories_from_descendants(&mut self)

Propagate categories to ancestors that don’t have any categories yet and have only one child that has no category defined. This is a heuristic to infer categories for weaknesses that have no categories defined. This process is repeated until no more categories can be propagated.

Examples found in repository

examples/cwe.rs (line 18)

fn main() -> Result<(), Box<dyn std::error::Error>> {
    let mut cwe_db = CweDatabase::new();

    // Import the 3 main CWE catalogs from the official website.
    cwe_db.import_weakness_catalog_from_url("https://cwe.mitre.org/data/xml/views/699.xml.zip")?;
    cwe_db.import_weakness_catalog_from_url("https://cwe.mitre.org/data/xml/views/1000.xml.zip")?;
    cwe_db.import_weakness_catalog_from_url("https://cwe.mitre.org/data/xml/views/1194.xml.zip")?;

    cwe_db.infer_categories_from_ancestors();
    cwe_db.infer_categories_from_descendants();

    // Retrieve a weakness by its ID (CWE-73).
    let cwe_id: i64 = 306;
    let weakness = cwe_db.weakness_by_cwe_id(cwe_id);
    println!("Weakness CWE-ID-{}\n{:#?}", cwe_id, weakness);

    // Display the categories of the weakness (if any).
    let categories = cwe_db.categories_by_cwe_id(cwe_id);
    println!("Categories {:#?}", categories);

    let children = cwe_db.weakness_children_by_cwe_id(1076);
    println!("CWE-{} has {} children", cwe_id, children.len());

    println!("{} CWE roots", cwe_db.weakness_roots().len());
    for root in &cwe_db.weakness_roots() {
        println!("CWE-{} is a root '{}'", root.id, root.name);
    }

    let mut visitor = Visitor;

    cwe_db.visit_weaknesses(&mut visitor);

    // Display the CWE catalog summary.
    println!("{}", cwe_db);

    Ok(())
}

Trait Implementations

impl Debug for CweDatabase

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

Formats the value using the given formatter.

impl Default for CweDatabase

fn default() -> CweDatabase

Returns the “default value” for a type.

impl Display for CweDatabase

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

Formats the value using the given formatter.