Skip to main content

OriginAllowlist

Struct OriginAllowlist 

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

A per-connecting-origin outbound allowlist for the bridge.

Maps each connecting tab origin (the Origin presented at the WebSocket upgrade) to the set of outbound origins a request routed to that tab may reach. This is the mechanism behind per-origin scoping: a Grafana tab and a Facebook tab each carry only their own grant, so neither can borrow the other’s outbound scope.

Built from repeatable --allow-origin values, each either a bare ORIGIN (shorthand: the tab may reach its own origin) or an explicit CONNECT=OUTBOUND mapping; repeats accumulate outbound origins under the same connecting key. An empty allowlist is the unconfigured default — the WS gate admits any origin (the session token is the gate) and outbound scope is default-closed (relative URLs only).

Implementations§

Source§

impl OriginAllowlist

Source

pub fn parse<S: AsRef<str>>(values: &[S]) -> Result<Self, String>

Parses repeatable --allow-origin CLI values into an allowlist.

Each value is ORIGIN (shorthand for ORIGIN=ORIGIN) or CONNECT=OUTBOUND. Both sides must be valid, non-opaque origins; a malformed or empty side is a hard error naming the offending value.

Source

pub fn is_empty(&self) -> bool

Whether no --allow-origin was configured (the default-open WS gate, default-closed outbound case).

Source

pub fn permits_connection(&self, origin: Option<&str>) -> bool

Whether a WebSocket upgrade from origin is permitted.

An empty allowlist admits any origin (the token in the subprotocol is the gate). Otherwise the connecting origin must be a configured key — an origin-less upgrade is rejected once any entry exists.

Source

pub fn outbound_for(&self, origin: Option<&str>) -> Vec<&str>

The outbound origins granted to a request routed to a tab on origin.

Empty when the tab’s origin is unknown or carries no grant — leaving only relative URLs permitted (see validate_outbound_url).

Source

pub fn describe(&self) -> Vec<String>

Renders the configured entries as CONNECT → OUTBOUND[, OUTBOUND…] lines (connecting-origin sorted) for the startup banner. Empty when unconfigured.

Trait Implementations§

Source§

impl Clone for OriginAllowlist

Source§

fn clone(&self) -> OriginAllowlist

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 OriginAllowlist

Source§

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

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

impl Default for OriginAllowlist

Source§

fn default() -> OriginAllowlist

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

impl Eq for OriginAllowlist

Source§

impl PartialEq for OriginAllowlist

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · 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 StructuralPartialEq for OriginAllowlist

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> DynClone for T
where T: Clone,

Source§

fn __clone_box(&self, _: Private) -> *mut ()

Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> FromRef<T> for T
where T: Clone,

Source§

fn from_ref(input: &T) -> T

Converts to this type from a reference to the input type.
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> 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