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
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
//! Validation

mod openpgp;

use crate::model::metadata::ProviderMetadata;
use crate::retrieve::{RetrievalError, RetrievedAdvisory, RetrievedDigest, RetrievedVisitor};
use crate::utils::openpgp::PublicKey;
use async_trait::async_trait;
use digest::Digest;
use std::fmt::Debug;
use std::future::Future;
use std::time::SystemTime;

#[derive(Clone, Debug)]
pub struct ValidatedAdvisory {
    /// The discovered advisory
    pub retrieved: RetrievedAdvisory,
}

#[derive(Debug, thiserror::Error)]
pub enum ValidationError {
    #[error("Retrieval error: {0}")]
    Retrieval(RetrievalError),
    #[error("Digest mismatch - expected: {expected}, actual: {actual}")]
    DigestMismatch { expected: String, actual: String },
    #[error("Invalid signature: {0}")]
    Signature(anyhow::Error),
}

#[async_trait(?Send)]
pub trait ValidatedVisitor {
    type Error: std::error::Error + Debug;
    type Context;

    async fn visit_context(
        &self,
        metadata: &ProviderMetadata,
    ) -> Result<Self::Context, Self::Error>;

    async fn visit_advisory(
        &self,
        context: &Self::Context,
        result: Result<ValidatedAdvisory, ValidationError>,
    ) -> Result<(), Self::Error>;
}

#[async_trait(?Send)]
impl<F, E, Fut> ValidatedVisitor for F
where
    F: Fn(Result<ValidatedAdvisory, ValidationError>) -> Fut,
    Fut: Future<Output = Result<(), E>>,
    E: std::error::Error,
{
    type Error = E;
    type Context = ();

    async fn visit_context(
        &self,
        _metadata: &ProviderMetadata,
    ) -> Result<Self::Context, Self::Error> {
        Ok(())
    }

    async fn visit_advisory(
        &self,
        _context: &Self::Context,
        result: Result<ValidatedAdvisory, ValidationError>,
    ) -> Result<(), Self::Error> {
        self(result).await
    }
}

#[derive(Clone, Debug, Default)]
pub struct ValidationOptions {
    /// time for policy checks
    pub validation_date: Option<SystemTime>,
}

pub struct ValidationVisitor<V>
where
    V: ValidatedVisitor,
{
    visitor: V,
    client: reqwest::Client,
    options: ValidationOptions,
}

enum ValidationProcessError {
    /// Failed, but passing on to visitor
    Proceed(ValidationError),
    /// Failed, aborting processing
    #[allow(unused)]
    Abort(anyhow::Error),
}

#[derive(Debug, thiserror::Error)]
pub enum Error<VE>
where
    VE: std::error::Error + Debug,
{
    #[error("Retrieval error: {0}")]
    Visitor(VE),
    #[error("Severe validation error: {0}")]
    Validation(anyhow::Error),
    #[error("Key retrieval error: {0}")]
    KeyRetrieval(#[from] crate::utils::openpgp::Error),
}

impl<V> ValidationVisitor<V>
where
    V: ValidatedVisitor,
{
    pub fn new(client: reqwest::Client, visitor: V) -> Self {
        Self {
            visitor,
            client,
            options: Default::default(),
        }
    }

    pub fn with_options(mut self, options: impl Into<ValidationOptions>) -> Self {
        self.options = options.into();
        self
    }

    /// Perform the actual validation.
    ///
    /// Returning either a processing error, or a result which will will be forwarded to the visitor.
    async fn validate(
        &self,
        context: &ValidationContext<V::Context>,
        retrieved: RetrievedAdvisory,
    ) -> Result<ValidatedAdvisory, ValidationProcessError> {
        Self::validate_digest(&retrieved.sha256)?;
        Self::validate_digest(&retrieved.sha512)?;

        if let Some(signature) = &retrieved.signature {
            openpgp::validate_signature(&self.options, context, &signature, &retrieved)
                .map_err(|err| ValidationProcessError::Proceed(ValidationError::Signature(err)))?;
        }

        Ok(ValidatedAdvisory { retrieved })
    }

    /// ensure that the digest matches if we have one
    fn validate_digest<D: Digest>(
        digest: &Option<RetrievedDigest<D>>,
    ) -> Result<(), ValidationProcessError> {
        if let Some(digest) = &digest {
            digest.validate().map_err(|(expected, actual)| {
                ValidationProcessError::Proceed(ValidationError::DigestMismatch {
                    expected: expected.to_string(),
                    actual,
                })
            })?;
        }
        Ok(())
    }
}

pub struct ValidationContext<VC> {
    context: VC,
    keys: Vec<PublicKey>,
}

#[async_trait(?Send)]
impl<V> RetrievedVisitor for ValidationVisitor<V>
where
    V: ValidatedVisitor,
{
    type Error = Error<V::Error>;
    type Context = ValidationContext<V::Context>;

    async fn visit_context(
        &self,
        metadata: &ProviderMetadata,
    ) -> Result<Self::Context, Self::Error> {
        let context = self
            .visitor
            .visit_context(metadata)
            .await
            .map_err(Error::Visitor)?;

        let mut keys = Vec::with_capacity(metadata.public_openpgp_keys.len());

        for key in &metadata.public_openpgp_keys {
            keys.extend(crate::utils::openpgp::fetch_key(&self.client, &key).await?);
        }

        log::info!("Loaded {} public keys", keys.len());
        for key in &keys {
            log::debug!("   {}", key.key_handle());
            for id in key.userids() {
                log::debug!("     {}", String::from_utf8_lossy(id.value()));
            }
        }

        Ok(ValidationContext { context, keys })
    }

    async fn visit_advisory(
        &self,
        context: &Self::Context,
        outcome: Result<RetrievedAdvisory, RetrievalError>,
    ) -> Result<(), Self::Error> {
        match outcome {
            Ok(advisory) => {
                let result = match self.validate(context, advisory).await {
                    Ok(result) => Ok(result),
                    Err(ValidationProcessError::Proceed(err)) => Err(err),
                    Err(ValidationProcessError::Abort(err)) => return Err(Error::Validation(err)),
                };
                self.visitor
                    .visit_advisory(&context.context, result)
                    .await
                    .map_err(Error::Visitor)?
            }
            Err(err) => self
                .visitor
                .visit_advisory(&context.context, Err(ValidationError::Retrieval(err)))
                .await
                .map_err(Error::Visitor)?,
        }

        Ok(())
    }
}