veloci 0.3.0

Veloci Redactor: redact secrets and PII from text and structured files, with stable numbered redactions
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

use std::io::Cursor;

use plist::Value;

use super::{Container, Format, FormatError, Leaf, LeafVisitor, Object};

const MAGIC: &[u8] = b"bplist00";

/// Binary property lists. XML property lists are handled by
/// [`Xml`](super::Xml).
///
/// The input is decoded, string values are replaced, and the result is
/// written back as a binary property list.
#[derive(Debug, Clone, Copy, Default)]
pub struct BinaryPlist;

impl Format for BinaryPlist {
    fn name(&self) -> &str {
        "bplist"
    }

    fn sniff(&self, input: &[u8]) -> bool {
        input.starts_with(MAGIC)
    }

    fn rewrite(&self, input: &[u8], visitor: &mut dyn LeafVisitor) -> Result<Vec<u8>, FormatError> {
        if !input.starts_with(MAGIC) {
            return Err(FormatError::new("bplist", "not a binary property list"));
        }
        let mut value =
            Value::from_reader(Cursor::new(input)).map_err(|e| FormatError::new("bplist", e))?;
        if !walk(&mut value, None, visitor) {
            return Ok(input.to_vec());
        }
        let mut out = Vec::with_capacity(input.len());
        value
            .to_writer_binary(&mut out)
            .map_err(|e| FormatError::new("bplist", e))?;
        Ok(out)
    }
}

/// Visit `value`, applying replacements in place. Returns whether anything changed.
fn walk(value: &mut Value, key: Option<&str>, visitor: &mut dyn LeafVisitor) -> bool {
    match value {
        Value::String(s) => match visitor.leaf(&Leaf::new(s).with_key(key)) {
            Some(replacement) => {
                *s = replacement.value;
                true
            }
            None => false,
        },
        Value::Array(items) => {
            visitor.enter(key, Container::Array);
            let mut changed = false;
            for item in items {
                changed |= walk(item, None, visitor);
            }
            visitor.exit();
            changed
        }
        Value::Dictionary(dict) => {
            let summary: Object<'_> = dict
                .iter()
                .map(|(k, v)| (k.as_str(), v.as_string()))
                .collect();
            visitor.enter(key, Container::Object(&summary));
            drop(summary);
            let mut changed = false;
            for (k, v) in dict.iter_mut() {
                changed |= walk(v, Some(k), visitor);
            }
            visitor.exit();
            changed
        }
        Value::Boolean(_)
        | Value::Data(_)
        | Value::Date(_)
        | Value::Real(_)
        | Value::Integer(_)
        | Value::Uid(_) => false,
        _ => false,
    }
}