Skip to main content

AccessControl

Struct AccessControl 

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

ACL rules v2

ACL files are small ordered routing tables. They have one default action and a handful of explicit sections:

  • [default proxy] / [default direct] / [default block] - one line, specifies the default action
  • [proxy_rules] - targets that must go through proxy
  • [direct_rules] - targets that must connect directly
  • [client_block] - client addresses that must be rejected by the server
  • [outbound_block] / [block] - targets that must be blocked

Rule lines can be one of:

  • CIDR network, like 10.9.0.32/16
  • IP address, like 127.0.0.1 or ::1
  • Exact domain, like |google.com
  • Domain suffix, like ||google.com
  • Regular expression, like (^|\.)gmail\.com$

Implementations§

Source§

impl AccessControl

Source

pub fn load_from_file<P: AsRef<Path>>(p: P) -> Result<AccessControl>

Load ACL rules from a file

Source

pub fn file_path(&self) -> &Path

Get ACL file path

Source

pub fn is_ip_empty(&self) -> bool

Check if there are no IP routing rules.

Source

pub fn is_host_empty(&self) -> bool

Check if there are no host routing rules.

Source

pub fn decide_host(&self, host: &str) -> Option<TargetDecision>

Decide how an ASCII domain should be handled.

Returns the first matching action, or None if no rule matches. The caller can then fall back to the default action.

Source

pub async fn decide_target(&self, addr: &Address) -> TargetDecision

Decide how a target should be handled.

Source

pub fn check_client_blocked(&self, addr: &SocketAddr) -> bool

Check if client address should be blocked (for server)

Source

pub async fn check_outbound_blocked(&self, outbound: &Address) -> bool

Check if outbound address is blocked (for server)

NOTE: Address::DomainAddress is only validated by regex rules, resolved addresses are checked in the lookup_outbound_then! macro

Trait Implementations§

Source§

impl Clone for AccessControl

Source§

fn clone(&self) -> AccessControl

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 AccessControl

Source§

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

Formats the value using the given formatter. 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<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> 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> 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.
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