wirdigen 0.3.0

LUA Wireshark dissector validator/generator from JSON
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

//! Module to validate a dissector JSON description

use jsonschema::JSONSchema;
use serde_json::Value;

use crate::error::WirdigenError;
use crate::schema::JSON_SCHEMA;

pub struct Validator {
    schema_value: JSONSchema,
}

impl Validator {
    /// Create a new validator object.
    pub fn new() -> Result<Validator, WirdigenError> {
        let json_schema: Value = serde_json::from_str(JSON_SCHEMA)?;

        let data = Self::compile_schema(json_schema)?;
        Ok(Validator { schema_value: data })
    }

    /// Validate a dissector in serde_json format against predefined schema.
    pub fn validate(self, json_raw: &Value) -> bool {
        match self.schema_value.validate(json_raw) {
            Err(errors) => {
                for err in errors {
                    eprintln!("{:#?}", err);
                }
                false
            }
            Ok(_) => true,
        }
    }
}

impl Validator {
    fn compile_schema(value: Value) -> Result<JSONSchema, WirdigenError> {
        match JSONSchema::compile(&value) {
            Err(e) => Err(WirdigenError::JSONSchemaCompilation(e.to_string())),
            Ok(data) => Ok(data),
        }
    }
}

#[cfg(test)]
mod unit_test {
    use super::*;

    use std::fs::File;
    use std::io::BufReader;

    #[test]
    fn validator_new() -> Result<(), WirdigenError> {
        let _ = Validator::new()?;
        Ok(())
    }

    #[test]
    fn validator_compile_schema_valid() -> Result<(), WirdigenError> {
        let valid_schema = r#"
        {
            "properties" : {
                "test": {
                    "type": "string"
                }
            }
        }"#;

        let value = serde_json::from_str(valid_schema)?;

        if let Err(_) = Validator::compile_schema(value) {
            panic!("The schema should have compiled")
        }
        Ok(())
    }

    #[test]
    fn validator_compile_schema_invalid() -> Result<(), WirdigenError> {
        // "any" is no longer a valid type keyword for a schema
        let invalid_schema = r#"
        {
            "properties" : {
                "test": {
                    "type": "any"
                }
            }
        }"#;

        let value = serde_json::from_str(invalid_schema)?;

        if let Ok(_) = Validator::compile_schema(value) {
            panic!("The schema should not have compiled")
        }
        Ok(())
    }

    #[test]
    fn validator_validate_true() -> Result<(), WirdigenError> {
        let file = File::open("./example/example_dissector.json")?;
        let rdr = BufReader::new(file);
        let value: Value = serde_json::from_reader(rdr)?;
        let mgr = Validator::new()?;

        assert_eq!(mgr.validate(&value), true);
        Ok(())
    }

    #[test]
    fn validator_validate_false() -> Result<(), WirdigenError> {
        // Invalid dissector
        let json_raw = r#"
        {
        }"#;

        let value = serde_json::from_str(json_raw)?;

        let mgr = Validator::new()?;

        assert_eq!(mgr.validate(&value), false);
        Ok(())
    }
}