elasticctl-api 0.10.0

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
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

use super::ListPlan;
use elasticctl_core::Error;
use serde::Serialize;

#[derive(Clone, Copy, Debug, Eq, PartialEq, Serialize)]
#[serde(rename_all = "snake_case")]
pub enum Outcome {
    Applied,
    Failed,
    Unknown,
    NotReached,
}

#[derive(Clone, Copy, Debug, Eq, PartialEq, Serialize)]
#[serde(rename_all = "snake_case")]
pub enum Sent {
    Accepted,
    Refused,
    Uncertain,
    NotSent,
}

#[derive(Clone, Copy, Debug, Eq, PartialEq, Serialize)]
#[serde(rename_all = "snake_case")]
pub enum Action {
    CreateValueList,
    UpdateValueList,
    AddValues,
    RemoveValues,
    ReadBack,
    NotReached,
    DeleteValueList,
    CheckValueList,
}

#[derive(Clone, Copy, Debug, Eq, PartialEq, Serialize)]
#[serde(rename_all = "snake_case")]
pub enum ReadOf {
    Values,
    Container,
}

#[derive(Clone, Debug, Serialize)]
pub struct Failure {
    pub kind: String,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub status: Option<u16>,
    pub message: String,
}

impl From<Error> for Failure {
    fn from(error: Error) -> Self {
        Self {
            kind: error.kind.as_str().into(),
            status: error.http_status,
            message: error.message,
        }
    }
}

#[derive(Clone, Debug, Serialize)]
pub struct Evidence {
    pub action: Action,
    pub rule_id: String,
    pub name: String,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub values: Option<Vec<String>>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub sent: Option<Sent>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub status: Option<u16>,
    pub phase_verified: bool,
    pub outcome: Outcome,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub of: Option<ReadOf>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub observed: Option<bool>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub missing: Option<usize>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub extra: Option<usize>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub mismatched: Option<Vec<String>>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub read_error: Option<Failure>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub planned_adds: Option<usize>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub planned_removes: Option<usize>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub error: Option<Failure>,
}

impl Evidence {
    pub(super) fn new(action: Action, id: &str, name: &str) -> Self {
        Self {
            action,
            rule_id: id.into(),
            name: name.into(),
            values: Some(Vec::new()),
            sent: Some(Sent::NotSent),
            status: None,
            phase_verified: false,
            outcome: Outcome::NotReached,
            of: None,
            observed: None,
            missing: None,
            extra: None,
            mismatched: None,
            read_error: None,
            planned_adds: None,
            planned_removes: None,
            error: None,
        }
    }
}

#[derive(Clone, Debug, Serialize)]
pub struct ListOutcome {
    pub id: String,
    pub outcome: Outcome,
    pub evidence: Vec<Evidence>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub error: Option<Failure>,
}

impl ListOutcome {
    pub(super) fn finish(&mut self, outcome: Outcome, error: Option<Error>) {
        self.outcome = outcome;
        self.error = error.map(Into::into);
        for entry in &mut self.evidence {
            entry.outcome = outcome;
        }
    }

    pub(super) fn not_reached(plan: &ListPlan) -> Self {
        let c = &plan.local.container;
        let mut entry = Evidence::new(Action::NotReached, &c.id, &c.name);
        entry.values = None;
        entry.planned_adds = Some(plan.adds.len());
        entry.planned_removes = Some(plan.removes.len());
        Self {
            id: c.id.clone(),
            outcome: Outcome::NotReached,
            evidence: vec![entry],
            error: None,
        }
    }
}