elasticctl-api 0.9.2

Typed detection-rule model and endpoint wrappers for Elastic Security.
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

//! States read from the stack for later comparison.

use elasticctl_core::{Error, ErrorKind, Result};

/// One object's state as read from the stack, in comparison form.
#[derive(Debug, Clone, PartialEq, serde::Serialize)]
pub struct Observed {
    /// The object kind: "rule", "alert", or "case".
    pub object: &'static str,
    /// The object identifier.
    pub id: String,
    /// `None` when the object does not exist.
    pub state: Option<serde_json::Value>,
}

/// The object states read for a plan or re-check.
#[derive(Debug, Clone, PartialEq, Default, serde::Serialize)]
pub struct Preconditions(pub Vec<Observed>);

impl Preconditions {
    /// Order by `object`, then `id`.
    pub fn sorted(mut self) -> Self {
        self.0
            .sort_by(|a, b| a.object.cmp(b.object).then_with(|| a.id.cmp(&b.id)));
        self
    }
}

/// Fail with kind `conflict` unless each present rule state has the expected `rule_id`.
pub fn require_rule_identity(seen: &Preconditions) -> Result<()> {
    for entry in &seen.0 {
        if entry.object == "rule"
            && let Some(state) = &entry.state
            && state.get("rule_id").and_then(serde_json::Value::as_str) != Some(&entry.id)
        {
            return Err(Error::new(
                ErrorKind::Conflict,
                "a rule read returned a different rule_id",
            ));
        }
    }
    Ok(())
}