Struct Synapse 

pub struct Synapse { /* private fields */ }

Main WAF detection engine facade.

This struct provides the same API as libsynapse::Synapse, enabling a drop-in replacement.

Example

use synapse_pingora::waf::{Synapse, Request, Action};

let mut synapse = Synapse::new();
synapse.load_rules(rules_json).unwrap();

let verdict = synapse.analyze(&Request {
    method: "GET",
    path: "/api/users?id=1' OR '1'='1",
    ..Default::default()
});

assert_eq!(verdict.action, Action::Block);

Implementations

impl Synapse

pub fn new() -> Self

Create a new Synapse instance with no rules loaded.

pub fn with_profile_config(profile_config: ProfileStoreConfig) -> Self

Create a new Synapse instance with custom profile configuration.

pub fn load_rules(&mut self, json: &[u8]) -> Result<usize, WafError>

Load rules from JSON.

Returns the number of rules loaded on success.

pub fn precompute_rules(&self, json: &[u8]) -> Result<CompiledRules, WafError>

Precompute all rule structures including regex compilation.

pub fn reload_from_compiled(&mut self, compiled: CompiledRules)

Fast swap of rule state using precomputed data.

pub fn parse_rules(json: &[u8]) -> Result<Vec<WafRule>, WafError>

Parse rules from JSON bytes without modifying state.

pub fn reload_rules(&mut self, rules: Vec<WafRule>) -> Result<(), WafError>

Reload the engine with a new set of pre-parsed rules.

pub fn analyze(&self, req: &Request<'_>) -> Verdict

Analyze a request and return a verdict.

pub fn analyze_with_trace( &self, req: &Request<'_>, trace: &mut dyn TraceSink, ) -> Verdict

Analyze a request and emit evaluation trace events.

pub fn analyze_with_timeout( &self, req: &Request<'_>, timeout: Duration, ) -> Verdict

Analyze a request with a timeout to prevent DoS via complex regexes.

Arguments

• req - The request to analyze
• timeout - Maximum time allowed for rule evaluation

Returns

A Verdict with timed_out=true if evaluation exceeded the deadline.

pub fn analyze_safe(&self, req: &Request<'_>) -> Verdict

Analyze a request with the default timeout (50ms).

Recommended for production use to prevent DoS attacks.

pub fn record_response_status(&self, path: &str, status: u16)

Record response status code for profiling.

Updates the endpoint profile with the observed status code, enabling baseline learning and anomaly detection.

pub fn get_profiles(&self) -> Vec<EndpointProfile>

Get all learned profiles.

Returns a snapshot of all endpoint profiles currently in storage.

pub fn load_profiles(&self, profiles: Vec<EndpointProfile>)

Load profiles into the engine.

Merges or replaces profiles in storage from a previous snapshot.

pub fn rule_count(&self) -> usize

Get the number of loaded rules.

pub fn risk_config(&self) -> RiskConfig

Get current risk configuration.

pub fn set_risk_config(&self, config: RiskConfig)

Set risk configuration.

Updates the risk thresholds for anomaly-based blocking.

pub fn profile_count(&self) -> usize

Get the number of stored profiles.

pub fn clear_profiles(&self)

Clear all stored profiles.

Trait Implementations

impl Default for Synapse

fn default() -> Self

Returns the “default value” for a type.