Skip to main content

ShieldConfig

nexus_shield::config

Struct ShieldConfig

pub struct ShieldConfig {Show 15 fields
    pub block_threshold: f64,
    pub warn_threshold: f64,
    pub sql: SqlFirewallConfig,
    pub ssrf: SsrfConfig,
    pub rate: RateConfig,
    pub quarantine: QuarantineConfig,
    pub audit_max_events: usize,
    pub email: EmailGuardConfig,
    pub api_token: Option<String>,
    pub tls_cert: Option<String>,
    pub tls_key: Option<String>,
    pub webhook_urls: Vec<WebhookConfig>,
    pub ferrum_mail: Option<FerrumMailConfig>,
    pub signature_update: Option<SignatureUpdateConfig>,
    pub nexus_pulse: Option<NexusPulseConfig>,
}

Expand description

Complete configuration for the Shield security engine.

Fields§

§block_threshold: f64

Threat score threshold above which requests are blocked (0.0–1.0).

§warn_threshold: f64

Threat score threshold for logging warnings (0.0–1.0).

§sql: SqlFirewallConfig

SQL firewall configuration.

§ssrf: SsrfConfig

SSRF guard configuration.

§rate: RateConfig

Rate limiting configuration.

§quarantine: QuarantineConfig

Data quarantine configuration.

§audit_max_events: usize

Maximum audit chain events to keep in memory before pruning.

§email: EmailGuardConfig

Email guard configuration.

§api_token: Option<String>

API authentication token (if set, all sensitive endpoints require Bearer auth).

§tls_cert: Option<String>

TLS certificate path.

§tls_key: Option<String>

TLS private key path.

§webhook_urls: Vec<WebhookConfig>

Webhook alert URLs for critical/high detections.

§ferrum_mail: Option<FerrumMailConfig>

Ferrum-Mail integration.

§signature_update: Option<SignatureUpdateConfig>

Signature auto-update configuration.

§nexus_pulse: Option<NexusPulseConfig>

NexusPulse SMS alert integration.

Trait Implementations§

impl Clone for ShieldConfig

fn clone(&self) -> ShieldConfig

Returns a duplicate of the value. Read more

1.0.0 · Source§

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

Performs copy-assignment from source. Read more

impl Debug for ShieldConfig

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

Formats the value using the given formatter. Read more

impl Default for ShieldConfig

fn default() -> Self

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

impl<'de> Deserialize<'de> for ShieldConfig

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

Deserialize this value from the given Serde deserializer. Read more

impl Serialize for ShieldConfig

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

Serialize this value into the given Serde serializer. Read more

Auto Trait Implementations§

impl Freeze for ShieldConfig

impl RefUnwindSafe for ShieldConfig

impl Send for ShieldConfig

impl Sync for ShieldConfig

impl Unpin for ShieldConfig

impl UnsafeUnpin for ShieldConfig

impl UnwindSafe for ShieldConfig

Blanket Implementations§

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

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

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

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

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

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

Mutably borrows from an owned value. Read more

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

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

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

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

fn from_ref(input: &T) -> T

Converts to this type from a reference to the input type.

impl<T> Instrument for T

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

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

fn in_current_span(self) -> Instrumented<Self>

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

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

fn into(self) -> U

Calls U::from(self).

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

impl<T> Same for T

type Output = T

Should always be Self

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

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

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

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

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

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

type Error = Infallible

The type returned in the event of a conversion error.

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.

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

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

The type returned in the event of a conversion error.

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

Performs the conversion.

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

fn vzip(self) -> V

impl<T> WithSubscriber for T

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

fn with_current_subscriber(self) -> WithDispatch<Self>

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

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