Skip to main content

AclPlugin

Struct AclPlugin 

Source
pub struct AclPlugin {
    allowed_by: Vec<String>,
    denied_by: Vec<String>,
    rejected_code: u16,
    rejected_msg: Option<String>,
}
Expand description

Admits or blocks requests based on the attached consumer’s group.

Evaluation: with no consumer attached the request is rejected 401. The denied_by list is checked first (deny wins) — a consumer whose group is listed is rejected. Then, when allowed_by is non-empty, a consumer whose group is not listed (including a consumer with no group) is rejected. List rejections use rejected_code (default 403) and carry error code ACL_DENIED.

Fields§

§allowed_by: Vec<String>

Groups permitted through; when non-empty, all other groups are rejected.

§denied_by: Vec<String>

Groups blocked; a match rejects regardless of allowed_by.

§rejected_code: u16

HTTP status used for list rejections.

§rejected_msg: Option<String>

Optional custom rejection message.

Implementations§

Source§

impl AclPlugin

Source

pub fn from_config(config: &HashMap<String, Value>) -> Result<Self, String>

Builds the plugin from node config, failing fast when neither list is set.

Accepted keys:

  • allowed_by (array of strings): consumer groups permitted through. When non-empty, a consumer whose group is not listed is rejected.
  • denied_by (array of strings): consumer groups blocked. Checked before allowed_by — deny wins.
  • At least one of allowed_by / denied_by is required.
  • rejected_code (integer, default 403): status for list rejections.
  • rejected_msg (string, optional): custom rejection message.
type: acl
config:
  allowed_by: ["partners", "internal"]
  denied_by: ["banned"]
  rejected_code: 403
Source

fn reject( &self, ctx: Context, status: u16, message: String, ) -> Result<PluginOutput, PluginExecutionError>

Builds a rejection carrying the context so the graph routes the error port.

Trait Implementations§

Source§

impl Plugin for AclPlugin

Source§

fn plugin_type(&self) -> &str

Unique identifier for the plugin type (e.g., “proxy-rewrite”, “upstream”).
Source§

fn execute<'life0, 'life1, 'async_trait>( &'life0 self, ctx: Context, _named_inputs: &'life1 HashMap<String, Value>, ) -> Pin<Box<dyn Future<Output = Result<PluginOutput, PluginExecutionError>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Executes the plugin logic against the request/response context. 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
§

impl<'a, T, E> AsTaggedExplicit<'a, E> for T
where T: 'a,

§

fn explicit(self, class: Class, tag: u32) -> TaggedParser<'a, Explicit, Self, E>

§

impl<'a, T, E> AsTaggedImplicit<'a, E> for T
where T: 'a,

§

fn implicit( self, class: Class, constructed: bool, tag: u32, ) -> TaggedParser<'a, Implicit, Self, E>

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

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

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

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

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

Source§

type Output = T

Should always be Self
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.
§

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

§

fn vzip(self) -> V

§

impl<T> WithSubscriber for T

§

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
§

fn with_current_subscriber(self) -> WithDispatch<Self>

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

impl<T> MaybeSend for T