prost-protovalidate 0.5.0

Runtime validation for Protocol Buffer messages using buf.validate rules
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

use std::collections::HashSet;

use prost_reflect::DynamicMessage;

use prost_protovalidate_types::rules_meta::any as meta;

use crate::config::ValidationConfig;
use crate::error::{Error, ValidationError};
use crate::violation::Violation;

use super::Evaluator;

/// Evaluator for `google.protobuf.Any` fields.
/// Validates the `type_url` against allowed/disallowed lists.
pub(crate) struct AnyEval {
    /// Allowed type URLs (empty = no restriction).
    pub r#in: HashSet<String>,
    /// Disallowed type URLs.
    pub not_in: HashSet<String>,
}

impl Evaluator for AnyEval {
    fn tautology(&self) -> bool {
        self.r#in.is_empty() && self.not_in.is_empty()
    }

    fn evaluate(
        &self,
        _msg: &DynamicMessage,
        val: &prost_reflect::Value,
        _cfg: &ValidationConfig,
    ) -> Result<(), Error> {
        let Some(any_msg) = val.as_message() else {
            return Ok(());
        };

        // Get the type_url field from the Any message
        let Some(type_url) = any_msg
            .get_field_by_name("type_url")
            .and_then(|v| v.as_str().map(str::to_string))
        else {
            return Ok(());
        };

        if !self.r#in.is_empty() && !self.r#in.contains(&type_url) {
            return Err(
                ValidationError::single(Violation::new("", meta::IN_ID, meta::IN_MESSAGE)).into(),
            );
        }

        if self.not_in.contains(&type_url) {
            return Err(ValidationError::single(Violation::new(
                "",
                meta::NOT_IN_ID,
                meta::NOT_IN_MESSAGE,
            ))
            .into());
        }

        Ok(())
    }
}