sbom-walker 0.17.0

A library to work with SBOM data
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145

use crate::report::ReportSink;
use spdx_rs::models::{RelationshipType, SPDX};
use std::collections::{HashMap, HashSet};

/// Run all SPDX sbom checks
pub fn all(report: &dyn ReportSink, spdx: &SPDX) {
    SpdxChecks { report, spdx }.all();
}

struct SpdxChecks<'c> {
    report: &'c dyn ReportSink,
    spdx: &'c SPDX,
}

impl SpdxChecks<'_> {
    /// run all checks
    pub fn all(&self) {
        log::debug!("Running all SPDX checks");

        self.rel_targets();
        self.duplicate_packages();
    }

    /// check for duplicate nodes
    fn duplicate_packages(&self) {
        log::debug!("Checking duplicates IDs");

        let mut ids = HashMap::with_capacity(
            self.spdx.package_information.len() + self.spdx.file_information.len() + 1,
        );

        ids.insert(&self.spdx.document_creation_information.spdx_identifier, 1);

        for package in &self.spdx.package_information {
            *ids.entry(&package.package_spdx_identifier).or_default() += 1;
        }
        for file in &self.spdx.file_information {
            *ids.entry(&file.file_spdx_identifier).or_default() += 1;
        }

        for (id, num) in ids {
            if num > 1 {
                self.report
                    .error(format!("Duplicate SPDX ID '{id}', occurred {num} times."));
            }
        }
    }

    /// check if all relationships have valid targets
    fn rel_targets(&self) {
        log::debug!("Checking valid relationship targets");

        // packages

        let mut ids = self
            .spdx
            .package_information
            .iter()
            .map(|p| p.package_spdx_identifier.as_str())
            .collect::<HashSet<_>>();

        // files

        ids.extend(
            self.spdx
                .file_information
                .iter()
                .map(|f| f.file_spdx_identifier.as_str()),
        );

        // document itself

        ids.insert(&self.spdx.document_creation_information.spdx_identifier);

        // external references

        let doc_refs = self
            .spdx
            .document_creation_information
            .external_document_references
            .iter()
            .map(|r| r.id_string.as_str())
            .collect::<HashSet<_>>();

        // now see if all relationships have valid targets

        for rel in &self.spdx.relationships {
            self.check_id(
                &ids,
                &doc_refs,
                &rel.spdx_element_id,
                &rel.spdx_element_id,
                &rel.relationship_type,
                &rel.related_spdx_element,
            );
            self.check_id(
                &ids,
                &doc_refs,
                &rel.related_spdx_element,
                &rel.spdx_element_id,
                &rel.relationship_type,
                &rel.related_spdx_element,
            );
        }
    }

    /// check if an ID is known, unless it's an external.
    fn check_id(
        &self,
        ids: &HashSet<&str>,
        doc_refs: &HashSet<&str>,
        id: &str,
        left: &str,
        rel: &RelationshipType,
        right: &str,
    ) {
        match (id, id.split_once(":")) {
            ("NONE" | "NOASSERTION", _) => {
                // no check
                return;
            }
            (_, Some((doc_ref, _id))) if doc_ref.starts_with("DocumentRef-") => {
                if !doc_refs.contains(doc_ref) {
                    self.report.error(format!(
                        "Invalid document reference '{doc_ref}' of relationship '{left}' -[{rel:?}]-> '{right}'",
                    ));
                }
                // we can't check the ID, as we don't have the target document
            }
            _ => {
                if !ids.contains(id) {
                    self.report.error(format!(
                        "Invalid reference '{id}' of relationship '{left}' -[{rel:?}]-> '{right}'",
                    ));
                }
            }
        }

        if !ids.contains(id) {
            self.report.error(format!(
                "Invalid reference '{id}' of relationship '{left}' -[{rel:?}]-> '{right}'",
            ));
        }
    }
}