Skip to main content

NetworkPolicy

Struct NetworkPolicy 

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

Deny-by-default IP/CIDR allowlist for ingest endpoints.

§Usage

Build a policy with NetworkPolicy::new, populate it with allow_ip / allow_cidr, then call check with the source address of each incoming connection before passing the payload to IngestService.

use std::net::IpAddr;
use edgesentry_rs::NetworkPolicy;

let mut policy = NetworkPolicy::new();
policy.allow_cidr("10.0.0.0/8").unwrap();

let trusted: IpAddr = "10.1.2.3".parse().unwrap();
assert!(policy.check(trusted).is_ok());

let untrusted: IpAddr = "192.168.1.1".parse().unwrap();
assert!(policy.check(untrusted).is_err());

Implementations§

Source§

impl NetworkPolicy

Source

pub fn new() -> Self

Create an empty policy (all sources denied until rules are added).

Source

pub fn allow_ip(&mut self, addr: IpAddr) -> &mut Self

Permit a single IP address.

Source

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

Permit all addresses within a CIDR block, e.g. "10.0.0.0/8" or "fd00::/8".

Source

pub fn check(&self, source: IpAddr) -> Result<(), NetworkPolicyError>

Returns Ok(()) if source is covered by at least one allowlist entry, or Err(NetworkPolicyError::Denied) if not.

Source

pub fn entries(&self) -> &[AllowedSource]

Returns the list of configured allowlist entries.

Trait Implementations§

Source§

impl Clone for NetworkPolicy

Source§

fn clone(&self) -> NetworkPolicy

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 NetworkPolicy

Source§

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

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

impl Default for NetworkPolicy

Source§

fn default() -> NetworkPolicy

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