Skip to main content

JweDecryptPlugin

Struct JweDecryptPlugin 

Source
pub struct JweDecryptPlugin {
    header: String,
    forward_header: String,
    strict: bool,
    inline_key: Option<Vec<u8>>,
    use_consumers: bool,
    resources: Arc<PluginResources>,
}
Expand description

Decrypts a JWE dir+A256GCM token and forwards the plaintext downstream.

On success the decrypted plaintext replaces the value of forward_header in the outbound request; the request otherwise continues unchanged through the success port. On any failure (missing token when strict, malformed compact serialization, unsupported algorithm, unknown kid, or a failed AEAD check) the request is rejected with a 401 JSON response and a JWE_INVALID error routed through the error port.

Fields§

§header: String

Lowercased header the encrypted token is read from.

§forward_header: String

Lowercased header the decrypted plaintext is written to.

§strict: bool

When true, a missing token is rejected; when false the request passes through untouched.

§inline_key: Option<Vec<u8>>

Inline symmetric key (32 raw bytes) when configured; takes precedence over the consumer store.

§use_consumers: bool

When true, resolve the key from the consumer store using the token kid.

§resources: Arc<PluginResources>

Implementations§

Source§

impl JweDecryptPlugin

Source

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

Builds the plugin from node config.

Accepted keys:

  • header (string, default "Authorization"): header carrying the JWE token; matched case-insensitively (an optional Bearer prefix is stripped).
  • forward_header (string, default "Authorization"): header the decrypted plaintext is written to before proxying.
  • strict (bool, default true): when true a missing token is rejected; when false the request passes through unchanged.
  • key (string, optional): inline symmetric key, base64-encoded, which must decode to exactly 32 bytes (AES-256). Used for every request.
  • use_consumers (bool, default false): resolve the key per request from the gateway consumers: section — the token’s kid selects the consumer’s jwe-decrypt credential ({key: <kid>, secret: <32-byte key>, is_base64_encoded: <bool>}).
  • At least one of key / use_consumers must be provided.
  • alg (string, default "dir") / enc (string, default "A256GCM"): only these values are supported; any other value is a config error (fail-fast at load), since full JWE is not implemented.
type: jwe-decrypt
config:
  header: Authorization
  forward_header: Authorization
  strict: true
  use_consumers: true
Source

fn reject( ctx: Context, message: &str, ) -> Result<PluginOutput, PluginExecutionError>

Builds the 401 rejection (code JWE_INVALID) carrying the context so the graph engine routes through the error port.

Source

fn consumer_key(&self, kid: Option<&str>) -> Result<Vec<u8>, &'static str>

Resolves the 32-byte AES key for the given token kid from the consumer store. Returns the raw key bytes, or None with a reason.

Trait Implementations§

Source§

impl Plugin for JweDecryptPlugin

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