Struct DetectorSpec 

pub struct DetectorSpec {
    pub id: String,
    pub name: String,
    pub service: String,
    pub severity: Severity,
    pub patterns: Vec<PatternSpec>,
    pub companion: Option<CompanionSpec>,
    pub verify: Option<VerifySpec>,
    pub keywords: Vec<String>,
}

Full detector definition loaded from TOML.

Examples

use keyhog_core::{DetectorSpec, PatternSpec, Severity};

let spec = DetectorSpec {
    id: "demo-token".into(),
    name: "Demo Token".into(),
    service: "demo".into(),
    severity: Severity::High,
    patterns: vec![PatternSpec {
        regex: "demo_[A-Z0-9]{8}".into(),
        description: Some("Demo credential".into()),
        group: None,
    }],
    companion: None,
    verify: None,
    keywords: vec!["demo_".into()],
};

assert_eq!(spec.patterns.len(), 1);

Fields

id: String

Stable detector identifier.

name: String

Human-readable detector name.

service: String

Service namespace used for grouping and verification limits.

severity: Severity

Severity reported for matches from this detector.

patterns: Vec<PatternSpec>

One or more regex patterns that identify the credential.

companion: Option<CompanionSpec>

Optional nearby companion requirement.

verify: Option<VerifySpec>

Optional live-verification configuration.

keywords: Vec<String>

Context keywords that help lower false positives.

Trait Implementations

impl Clone for DetectorSpec

fn clone(&self) -> DetectorSpec

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DetectorSpec

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for DetectorSpec

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for DetectorSpec

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.