Struct RendguardConfig 

pub struct RendguardConfig {
    pub use_global_start_count: u32,
    pub use_scale_at_count: u32,
    pub use_relay_start_count: u32,
    pub use_max_use_to_bw_ratio: f64,
    pub use_max_consensus_weight_churn: f64,
    pub close_circuits_on_overuse: bool,
}

Rendezvous point monitoring configuration options.

Controls detection of rendezvous point overuse attacks. These attacks attempt to identify hidden services by observing which relays are frequently used as rendezvous points.

Attack Detection

Rendguard tracks rendezvous point usage and compares it to expected bandwidth distribution:

┌─────────────────────────────────────────────────────────────────┐
│                Rendezvous Point Overuse Detection               │
└─────────────────────────────────────────────────────────────────┘

  Expected Usage = Relay Bandwidth Weight / Total Network Bandwidth

  Actual Usage = Times Used as Rend Point / Total Rend Point Uses

  Overuse Ratio = Actual Usage / Expected Usage

  If Overuse Ratio > use_max_use_to_bw_ratio:
     └── Alert and optionally close circuits

Fields

Field	Default	Description
use_global_start_count	1000	Min total uses before checking
use_scale_at_count	20000	Scale counts by half at this total
use_relay_start_count	100	Min relay uses before checking
use_max_use_to_bw_ratio	5.0	Max ratio of use to bandwidth
use_max_consensus_weight_churn	1.0	Max consensus weight churn %
close_circuits_on_overuse	true	Close circuits on overuse detection

Example

use vanguards_rs::RendguardConfig;

let mut config = RendguardConfig::default();

// More aggressive detection
config.use_max_use_to_bw_ratio = 3.0;

// Require more samples before alerting
config.use_global_start_count = 2000;
config.use_relay_start_count = 200;

See Also

• Config - Main configuration struct
• RendGuard - Runtime rendezvous tracking

Fields

use_global_start_count: u32

Minimum total uses before checking for overuse.

use_scale_at_count: u32

Scale counts by half when reaching this total.

use_relay_start_count: u32

Minimum relay uses before checking for overuse.

use_max_use_to_bw_ratio: f64

Maximum ratio of use to bandwidth weight.

use_max_consensus_weight_churn: f64

Maximum consensus weight churn percentage.

close_circuits_on_overuse: bool

Close circuits on rendezvous point overuse.

Trait Implementations

impl Clone for RendguardConfig

fn clone(&self) -> RendguardConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RendguardConfig

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

Formats the value using the given formatter.

impl Default for RendguardConfig

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for RendguardConfig

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for RendguardConfig

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for RendguardConfig

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for RendguardConfig