Skip to main content

DetectorKind

Enum DetectorKind 

Source
#[non_exhaustive]
pub enum DetectorKind { BeaconCv, BeaconRita, PortScanTrw, Dga, DnsTunnel, NewlyObservedDomain, ConnectionFlood, DataExfil, Other(&'static str), Unknown, }
Expand description

Which detector produced an anomaly.

Built-in variants cover every detector shipped in crate::detect::patterns. Downstream crates register their own kinds via Self::Other.

#[non_exhaustive] — future detectors will add variants; matching on this enum should always include a wildcard arm. Serializes as its as_str slug — a plain JSON string (e.g. "BeaconCv"), not a tagged object — so the kind field in emitted anomalies matches the pre-0.21 Cow<'static, str> wire shape byte-for-byte. Deserializes a slug back via from_slug: built-in slugs round-trip to their variant; an unrecognised slug (including a downstream Other label) deserializes to Unknown — it cannot rebuild the &'static str an Other needs.

Variants (Non-exhaustive)§

This enum is marked as non-exhaustive
Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.
§

BeaconCv

Coefficient-of-variation beacon detector (crate::detect::patterns::BeaconDetector).

§

BeaconRita

RITA-style robust beacon detector (Bowley skewness + MADM; crate::detect::patterns::RitaBeaconDetector).

§

PortScanTrw

Threshold Random Walk port-scan detector (crate::detect::patterns::PortScanDetector).

§

Dga

§

DnsTunnel

DNS tunneling detector — distinct-subdomain cardinality (DnsTunnelDetector, issue #132).

§

NewlyObservedDomain

Newly-observed-domain detector — bounded first-seen set (NewlyObservedDomainDetector, issue #132).

§

ConnectionFlood

Per-source connection-rate flood detector (ConnectionFloodDetector, issue #132).

§

DataExfil

EWMA-variance outbound-volume exfiltration detector (DataExfilDetector, issue #132).

§

Other(&'static str)

Downstream-registered detector kind. The &'static str label should be a unique stable slug — typical convention is "crate-name/detector" (e.g. "zensight/sigma").

§

Unknown

Detector identity unknown — the deserialization fallback for unrecognised slugs (an Other can’t be rebuilt from a runtime string). Also the Default.

Implementations§

Source§

impl DetectorKind

Source

pub fn as_str(&self) -> &'static str

Stable slug — same vocabulary the 0.20-and-earlier OwnedAnomaly::kind string carried. Use for metric labels and JSON emission (EVE anomaly.event, NDJSON kind).

Each built-in variant maps to the slug its detector historically emitted (BeaconCv → "BeaconCv", PortScanTrw → "PortScanTRW", Dga → "DgaScorer", …); the full mapping is regression-pinned by slug_vocabulary_locked. Self::Other yields its wrapped caller-supplied slug; Self::Unknown yields "unknown". from_slug is the inverse.

Source

pub fn from_slug(s: &str) -> DetectorKind

Inverse of as_str for the built-in slugs.

A recognised built-in slug maps to its variant; any other string maps to Unknown (it can’t become an Other — that variant needs a &'static str, which a runtime string isn’t). Used by the Deserialize impl.

Source

pub fn attack_technique(&self) -> Option<&'static str>

MITRE ATT&CK technique ID for the behaviour this detector flags, in the stable Txxxx / Txxxx.yyy form, or None when no single technique applies (Other / Unknown).

Mapping rationale:

  • Beaconing → T1071 Application Layer Protocol (the C2 channel protocol is unknown at detection time, so the parent technique — not a sub-technique — applies).
  • Port scan → T1046 Network Service Discovery.
  • DGA → T1568.002 Dynamic Resolution: Domain Generation Algorithms.
  • DNS tunnel → T1071.004 Application Layer Protocol: DNS.
  • Newly-observed domain → T1568 Dynamic Resolution (NOD is the defender-observable signal of dynamic resolution infrastructure; T1583.001 covers adversary acquisition, which passive capture can’t see).
  • Connection flood → T1498 Network Denial of Service (rate-shaped; scan-shaped fan-out is PortScanTrw’s T1046).
  • Data exfil → T1048 Exfiltration Over Alternative Protocol (the RITA / AC-Hunter N-sigma outbound-volume precedent; T1030 Data Transfer Size Limits is the adversary’s evasion of exactly this detector — wrong axis).

Trait Implementations§

Source§

impl Clone for DetectorKind

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Copy for DetectorKind

Source§

impl Debug for DetectorKind

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl Default for DetectorKind

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl<'de> Deserialize<'de> for DetectorKind

Available on crate feature serde only.
Source§

fn deserialize<D: Deserializer<'de>>(deserializer: D) -> Result<Self, D::Error>

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Display for DetectorKind

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl Eq for DetectorKind

Source§

impl Hash for DetectorKind

Source§

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
Source§

impl PartialEq for DetectorKind

Source§

fn eq(&self, other: &Self) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=. Read more
Source§

impl Serialize for DetectorKind

Available on crate feature serde only.
Source§

fn serialize<S: Serializer>(&self, serializer: S) -> Result<S::Ok, S::Error>

Serialize this value into the given Serde serializer. Read more
Source§

impl StructuralPartialEq for DetectorKind

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<'a, T, E> AsTaggedExplicit<'a, E> for T
where T: 'a,

Source§

fn explicit(self, class: Class, tag: u32) -> TaggedParser<'a, Explicit, Self, E>

Source§

impl<'a, T, E> AsTaggedImplicit<'a, E> for T
where T: 'a,

Source§

fn implicit( self, class: Class, constructed: bool, tag: u32, ) -> TaggedParser<'a, Implicit, Self, E>

Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more