Skip to main content

IpAccessControl

Struct IpAccessControl 

Source
pub struct IpAccessControl { /* private fields */ }
Expand description

IP-based access control.

This struct manages allowed and blocked IP ranges for connection filtering. Rules are evaluated in the following order:

  1. Check if IP is in blocked list → Deny
  2. If allowed list is non-empty, check if IP is in allowed list → Allow/Deny
  3. Use default policy (Allow if no allowed list specified)

Implementations§

Source§

impl IpAccessControl

Source

pub fn new() -> Self

Create a new access control with default allow policy.

Source

pub fn from_config( allowed_ips: &[String], blocked_ips: &[String], ) -> Result<Self>

Create access control from allowed and blocked IP lists.

§Arguments
  • allowed_ips - List of allowed IP ranges in CIDR notation
  • blocked_ips - List of blocked IP ranges in CIDR notation
§Returns

Returns an error if any CIDR string is invalid.

Source

pub fn check(&self, ip: &IpAddr) -> AccessPolicy

Check if an IP address is allowed to connect.

§Arguments
  • ip - The IP address to check
§Returns

Returns AccessPolicy::Allow if the IP is allowed, AccessPolicy::Deny otherwise.

Source

pub fn allow_cidr(&mut self, cidr: &str) -> Result<()>

Add an allowed CIDR range.

§Arguments
  • cidr - CIDR notation string (e.g., “192.168.0.0/16”)
Source

pub fn allow(&mut self, network: IpNetwork)

Add an allowed network.

Source

pub fn block_cidr(&mut self, cidr: &str) -> Result<()>

Add a blocked CIDR range.

§Arguments
  • cidr - CIDR notation string (e.g., “10.10.10.10/32”)
Source

pub fn block(&mut self, network: IpNetwork)

Add a blocked network.

Source

pub fn block_ip(&mut self, ip: IpAddr)

Block a single IP address.

This creates a /32 (IPv4) or /128 (IPv6) rule.

Source

pub fn unblock_ip(&mut self, ip: IpAddr)

Unblock a single IP address.

Removes the /32 (IPv4) or /128 (IPv6) rule for this IP.

Source

pub fn remove_allowed(&mut self, network: &IpNetwork)

Remove an allowed network.

Source

pub fn remove_blocked(&mut self, network: &IpNetwork)

Remove a blocked network.

Source

pub fn reload( &mut self, allowed_ips: &[String], blocked_ips: &[String], ) -> Result<()>

Reload configuration from allowed and blocked IP lists.

Source

pub fn allowed_count(&self) -> usize

Get the number of allowed networks.

Source

pub fn blocked_count(&self) -> usize

Get the number of blocked networks.

Source

pub fn default_policy(&self) -> AccessPolicy

Get the default policy.

Source

pub fn is_whitelist_mode(&self) -> bool

Check if the access control is in whitelist mode.

Returns true if there are allowed networks configured, meaning only those networks are allowed.

Source

pub fn allowed_networks(&self) -> Vec<IpNetwork>

Get a copy of the allowed networks.

Source

pub fn blocked_networks(&self) -> Vec<IpNetwork>

Get a copy of the blocked networks.

Trait Implementations§

Source§

impl Clone for IpAccessControl

Source§

fn clone(&self) -> IpAccessControl

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for IpAccessControl

Source§

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

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

impl Default for IpAccessControl

Source§

fn default() -> Self

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

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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

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.

Source§

impl<T> FutureExt for T

Source§

fn with_context(self, otel_cx: Context) -> WithContext<Self>

Attaches the provided Context to this type, returning a WithContext wrapper. Read more
Source§

fn with_current_context(self) -> WithContext<Self>

Attaches the current Context to this type, returning a WithContext wrapper. Read more
Source§

impl<T> Instrument for T

Source§

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

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

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

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> IntoRequest<T> for T

Source§

fn into_request(self) -> Request<T>

Wrap the input message T in a tonic::Request
Source§

impl<L> LayerExt<L> for L

Source§

fn named_layer<S>(&self, service: S) -> Layered<<L as Layer<S>>::Service, S>
where L: Layer<S>,

Applies the layer to a service and wraps it in Layered.
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

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

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

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 = !

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

fn try_from(value: U) -> Result<T, !>

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

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

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

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

fn with_current_subscriber(self) -> WithDispatch<Self>

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