vrl 0.37.0

Vector Remap Language
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
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

use super::util::hex_encode;
use crate::compiler::prelude::*;
use ::sha1::Digest;

fn sha1_hex(value: &[u8]) -> bytestring::ByteString {
    hex_encode::<40>(sha1::Sha1::digest(value))
}

fn sha1(value: Value) -> Resolved {
    let value = value.try_bytes()?;
    Ok(Value::String(sha1_hex(&value)))
}

#[derive(Clone, Copy, Debug)]
pub struct Sha1;

impl Function for Sha1 {
    fn identifier(&self) -> &'static str {
        "sha1"
    }

    fn usage(&self) -> &'static str {
        "Calculates a [SHA-1](https://en.wikipedia.org/wiki/SHA-1) hash of the `value`."
    }

    fn category(&self) -> &'static str {
        Category::Cryptography.as_ref()
    }

    fn return_kind(&self) -> u16 {
        kind::BYTES
    }

    fn parameters(&self) -> &'static [Parameter] {
        const PARAMETERS: &[Parameter] = &[Parameter::required(
            "value",
            kind::BYTES,
            "The string to calculate the hash for.",
        )];
        PARAMETERS
    }

    fn examples(&self) -> &'static [Example] {
        &[example! {
            title: "Calculate sha1 hash",
            source: r#"sha1("foo")"#,
            result: Ok("0beec7b5ea3f0fdbc95d0dd47f3c5bc275da8a33"),
        }]
    }

    fn compile(
        &self,
        state: &state::TypeState,
        _ctx: &mut FunctionCompileContext,
        arguments: ArgumentList,
    ) -> Compiled {
        let value = arguments.required("value");

        if let Some(val) = value.resolve_constant(state)
            && let Ok(bytes) = val.try_bytes()
        {
            Ok(Box::new(crate::compiler::expression::Literal::from(
                sha1_hex(&bytes),
            )))
        } else {
            Ok(Sha1Fn { value }.as_expr())
        }
    }
}

#[derive(Debug, Clone)]
struct Sha1Fn {
    value: Box<dyn Expression>,
}

impl FunctionExpression for Sha1Fn {
    fn resolve(&self, ctx: &mut Context) -> Resolved {
        let value = self.value.resolve(ctx)?;
        sha1(value)
    }

    fn type_def(&self, _: &state::TypeState) -> TypeDef {
        TypeDef::bytes().infallible()
    }
}

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

    test_function![
        sha1 => Sha1;

        sha {
             args: func_args![value: "foo"],
             want: Ok("0beec7b5ea3f0fdbc95d0dd47f3c5bc275da8a33"),
             tdef: TypeDef::bytes().infallible(),
         }

        sha1_empty {
            args: func_args![value: ""],
            want: Ok("da39a3ee5e6b4b0d3255bfef95601890afd80709"),
            tdef: TypeDef::bytes().infallible(),
        }

        sha1_sentence {
            args: func_args![value: "The quick brown fox jumps over the lazy dog"],
            want: Ok("2fd4e1c67a2d28fced849ee1bb76e7391b93eb12"),
            tdef: TypeDef::bytes().infallible(),
        }
    ];

    #[test]
    fn test_sha1_compiles_to_literal() {
        use crate::compiler::CompileConfig;

        let state = state::TypeState::default();
        let mut ctx = FunctionCompileContext::new(Span::default(), CompileConfig::default());
        let mut args = ArgumentList::default();
        args.insert("value", Value::from("foo").into());

        let expr = Sha1.compile(&state, &mut ctx, args).unwrap();
        assert_eq!(
            expr.resolve_constant(&state),
            Some(Value::from("0beec7b5ea3f0fdbc95d0dd47f3c5bc275da8a33"))
        );
    }

    #[test]
    fn test_sha1_compiles_dynamic() {
        use crate::compiler::CompileConfig;
        use crate::compiler::expression::Variable;
        use crate::compiler::parser::Ident;

        let mut state = state::TypeState::default();
        state.local.insert_variable(
            Ident::new("foo"),
            type_def::Details {
                type_def: TypeDef::bytes(),
                value: None,
            },
        );

        let mut ctx = FunctionCompileContext::new(Span::default(), CompileConfig::default());
        let var = Variable::new((0, 0).into(), Ident::new("foo"), &state.local).unwrap();

        let mut args = ArgumentList::default();
        args.insert("value", var.into());

        let expr = Sha1.compile(&state, &mut ctx, args).unwrap();
        assert!(expr.resolve_constant(&state).is_none());
    }
}