RendGuard

Struct RendGuard 

Source
pub struct RendGuard {
    pub use_counts: HashMap<String, RendUseCount>,
    pub total_use_counts: f64,
    pub pickle_revision: f64,
}
Expand description

Rendezvous point usage tracking for detecting statistical attacks.

Tracks usage counts for all relays used as rendezvous points and detects when a relay is being used more than expected based on its bandwidth weight.

Fields§

§use_counts: HashMap<String, RendUseCount>

Usage counts per relay fingerprint.

§total_use_counts: f64

Total usage count across all relays.

§pickle_revision: f64

Version number for pickle compatibility.

Implementations§

Source§

impl RendGuard

Source

pub fn new() -> Self

Creates a new empty RendGuard.

Source

pub fn scale_counts(&mut self)

Scales all usage counts by half.

Called when total_use_counts reaches the scale threshold to prevent unbounded growth and to avoid over-counting high-uptime relays.

Source

pub fn valid_rend_use( &mut self, fingerprint: &str, config: &RendguardConfig, ) -> bool

Records a rendezvous point usage and checks for overuse.

This method should be called each time a relay is used as a rendezvous point for a hidden service circuit.

§Arguments
  • fingerprint - The relay’s fingerprint (40 hex characters)
  • config - Rendguard configuration
§Returns

true if the usage is valid (not overused), false if overused.

Source

pub fn xfer_use_counts( &mut self, generator: &BwWeightedGenerator, config: &RendguardConfig, )

Transfers and updates use counts on consensus change.

This method should be called when a new consensus is received.

Source

pub fn usage_rate(&self, fingerprint: &str) -> f64

Returns the usage rate for a relay as a percentage.

Source

pub fn expected_weight(&self, fingerprint: &str) -> f64

Returns the expected weight for a relay as a percentage.

Source

pub fn is_overused(&self, fingerprint: &str, config: &RendguardConfig) -> bool

Checks if a relay is currently overused.

Trait Implementations§

Source§

impl Clone for RendGuard

Source§

fn clone(&self) -> RendGuard

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
Source§

impl Debug for RendGuard

Source§

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

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

impl Default for RendGuard

Source§

fn default() -> Self

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

impl<'de> Deserialize<'de> for RendGuard

Source§

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

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

impl PartialEq for RendGuard

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

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

impl Serialize for RendGuard

Source§

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

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

impl StructuralPartialEq for RendGuard

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<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> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

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
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, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

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

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

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.
§

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
Source§

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