Skip to main content

GatewayConfig

Struct GatewayConfig 

Source
pub struct GatewayConfig {
    pub enabled: bool,
    pub bind: String,
    pub port: u16,
    pub auth_token: Option<String>,
    pub rate_limit: u32,
    pub max_body_size: usize,
    pub webhook_send_timeout_secs: u64,
    pub trusted_proxy_cidrs: Vec<String>,
}
Expand description

HTTP webhook gateway configuration, nested under [gateway] in TOML.

When enabled = true, an HTTP server accepts webhook payloads and injects them as user messages into the agent. Requires the gateway feature flag.

§Example (TOML)

[gateway]
enabled = true
bind = "127.0.0.1"
port = 8090
auth_token = "secret"
rate_limit = 60
max_body_size = 1048576
webhook_send_timeout_secs = 5

Fields§

§enabled: bool

Enable the HTTP gateway. Default: false.

§bind: String

IP address to bind the gateway to. Default: "127.0.0.1".

§port: u16

Port to listen on. Default: 8090.

§auth_token: Option<String>

Bearer token for request authentication. When set, all requests must include Authorization: Bearer <token>. Default: None (no auth).

§rate_limit: u32

Maximum requests per minute. Must be > 0. Default: 120.

§max_body_size: usize

Maximum request body size in bytes. Must be <= 10 MiB. Default: 1048576 (1 MiB).

§webhook_send_timeout_secs: u64

Maximum seconds to wait for the agent to consume a webhook message before returning 503 Service Unavailable. Default: 5.

§trusted_proxy_cidrs: Vec<String>

CIDR ranges of trusted reverse proxies (e.g. ["10.0.0.0/8", "172.16.0.0/12"]).

When non-empty, the rate limiter applies the rightmost-untrusted algorithm on the X-Forwarded-For header: it walks the header from right to left and picks the first IP address that does NOT fall within any listed CIDR. This is the correct algorithm when your proxy chain always appends, never prepends, so the rightmost entry added by the infrastructure is the one closest to your origin.

Leave empty (the default) to use the raw TCP peer address for rate limiting, which is correct for deployments without a reverse proxy.

Security note: only list CIDRs you fully control. Any IP in a trusted CIDR can forge X-Forwarded-For and bypass per-IP rate limiting.

Implementations§

Source§

impl GatewayConfig

Source

pub fn validate(&self) -> Result<(), String>

Validate gateway configuration values.

§Errors

Returns an error string when:

  • webhook_send_timeout_secs is 0 or exceeds 300
  • max_body_size exceeds 10 MiB (10485760 bytes)
  • rate_limit is 0 (causes division-by-zero in the token-bucket rate limiter)

Trait Implementations§

Source§

impl Clone for GatewayConfig

Source§

fn clone(&self) -> GatewayConfig

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 GatewayConfig

Source§

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

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

impl Default for GatewayConfig

Source§

fn default() -> GatewayConfig

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

impl<'de> Deserialize<'de> for GatewayConfig

Source§

fn deserialize<__D>( __deserializer: __D, ) -> Result<GatewayConfig, <__D as Deserializer<'de>>::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Serialize for GatewayConfig

Source§

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. 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> DynClone for T
where T: Clone,

Source§

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

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

Source§

fn into_request(self) -> Request<T>

Wrap the input message T in a tonic::Request
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: 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: 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
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,