Skip to main content

NetworkPolicy

Struct NetworkPolicy 

Source
pub struct NetworkPolicy {
    pub allow_hosts: Vec<String>,
    pub allow_classes: Vec<AddressClass>,
    pub allowed_schemes: Vec<String>,
    pub allow_request: Option<AllowCallback>,
    pub hard_block_link_local: bool,
    pub unrestricted: bool,
    pub resolver: Option<Resolver>,
    /* private fields */
}
Expand description

Typed SSRF/host policy. See the module docs for defaults.

Fields§

§allow_hosts: Vec<String>

Hosts (exact, case-insensitive) allowed even when their address class is blocked.

§allow_classes: Vec<AddressClass>

Address classes allowed for every host (e.g. Loopback for local dev servers).

§allowed_schemes: Vec<String>

Lowercase schemes that may be requested. Default ["http", "https"].

§allow_request: Option<AllowCallback>

Called for every checked request; see PolicyDecision.

§hard_block_link_local: bool

Link-local and metadata destinations cannot be allowed (default true).

§unrestricted: bool

Disable every check (trusted callers only).

§resolver: Option<Resolver>

Replaces the system resolver (offline tests, pinned DNS, split-horizon setups).

Implementations§

Source§

impl NetworkPolicy

Source

pub fn unrestricted() -> Self

Policy with every check off.

Source

pub fn allow_host(self, host: impl Into<String>) -> Self

Source

pub fn allow_class(self, class: AddressClass) -> Self

Source

pub fn allow_scheme(self, scheme: impl Into<String>) -> Self

Source

pub fn with_resolver( self, f: impl Fn(&str) -> Vec<IpAddr> + Send + Sync + 'static, ) -> Self

Source

pub fn allow_with<D: Into<PolicyDecision>>( self, f: impl Fn(&BrowserRequest) -> D + Send + Sync + 'static, ) -> Self

Per-request callback. Returning bool works too: true allows, false defers to the defaults.

Source

pub async fn check( &self, url: &str, resource_type: &str, ) -> Result<(), BlockReason>

Ok(()) when the request may proceed, otherwise why it is blocked.

Trait Implementations§

Source§

impl Clone for NetworkPolicy

Source§

fn clone(&self) -> Self

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 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() -> 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> 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> 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