walker-common 0.17.0

Common functionality for SBOM and CSAF walker
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

use crate::{
    retrieve::{RetrievalError, RetrievedDocument},
    source::Source,
    utils::url::Urlify,
};
use std::fmt::{Debug, Display, Formatter};
use url::Url;

/// An error from a validation visitor.
#[derive(Debug, thiserror::Error)]
pub enum ValidationError<S>
where
    S: Source,
{
    /// Failed during retrieval
    Retrieval(RetrievalError<<S::Retrieved as RetrievedDocument>::Discovered, S>),
    /// Mismatch of the retrieved and calculated document digest
    DigestMismatch {
        expected: String,
        actual: String,
        retrieved: S::Retrieved,
    },
    /// Invalid signature of the document
    Signature {
        error: anyhow::Error,
        retrieved: S::Retrieved,
    },
}

impl<S> Urlify for ValidationError<S>
where
    S: Source,
{
    fn url(&self) -> &Url {
        match self {
            Self::Retrieval(err) => err.url(),
            Self::DigestMismatch { retrieved, .. } => retrieved.url(),
            Self::Signature { retrieved, .. } => retrieved.url(),
        }
    }
}

impl<S> Display for ValidationError<S>
where
    S: Source,
{
    fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result {
        match self {
            Self::Retrieval(err) => write!(f, "Retrieval error: {err}"),
            Self::DigestMismatch {
                expected,
                actual,
                retrieved,
            } => write!(
                f,
                "Digest mismatch - expected: {expected}, actual: {actual} ({})",
                retrieved.url()
            ),
            Self::Signature { error, retrieved } => {
                write!(f, "Invalid signature: {error} ({})", retrieved.url())
            }
        }
    }
}