Skip to main content

OAuthSsrfAllowlist

Struct OAuthSsrfAllowlist 

Source
#[non_exhaustive]
pub struct OAuthSsrfAllowlist { pub hosts: Vec<String>, pub cidrs: Vec<String>, }
Expand description

Operator-trusted SSRF allowlist for OAuth/JWKS targets that resolve to addresses normally blocked by the post-DNS SSRF guard.

Default: empty. With both fields empty (or this struct unset), the existing fail-closed behavior is unchanged: any OAuth/JWKS URL resolving to RFC 1918, loopback, link-local, CGNAT, multicast, broadcast, unspecified, IPv6 unique-local / link-local / multicast, documentation, benchmarking, or reserved ranges is rejected before connect.

Cloud-metadata addresses remain unbypassable – operators cannot opt in to metadata-service exposure. This carve-out covers:

  • IPv4 169.254.169.254 (AWS / GCP / Azure).
  • IPv4 100.100.100.200 (Alibaba Cloud / Tencent Cloud).
  • IPv6 fd00:ec2::254 (AWS IMDSv2 over IPv6).
  • IPv6 fd20:ce::254 (GCP).

See SECURITY.md § “Operator allowlist”.

Both lists are evaluated additively: a target is allowed if its hostname is in hosts or every resolved IP for the target falls within at least one CIDR in cidrs.

The allowlist applies to all six configured OAuth URL fields (OAuthConfig::issuer, OAuthConfig::jwks_uri, OAuthProxyConfig::authorize_url, OAuthProxyConfig::token_url, OAuthProxyConfig::introspection_url, OAuthProxyConfig::revocation_url, TokenExchangeConfig::token_url) and to the per-redirect-hop SSRF guard when a redirect target is a literal IP in a configured CIDR.

Entries are validated at startup: literal IPs in hosts, non-zero host bits in cidrs, malformed CIDRs, and entries containing ports / userinfo / paths are all rejected by OAuthConfig::validate.

§Example

use rmcp_server_kit::oauth::{OAuthConfig, OAuthSsrfAllowlist};

let mut allowlist = OAuthSsrfAllowlist::default();
allowlist.hosts.push("rhbk.ops.example.com".into());
allowlist.cidrs.push("10.0.0.0/8".into());
let cfg = OAuthConfig::builder(
    "https://rhbk.ops.example.com/realms/ops",
    "mcp",
    "https://rhbk.ops.example.com/realms/ops/protocol/openid-connect/certs",
)
.ssrf_allowlist(allowlist)
.build();
cfg.validate().expect("operator allowlist parses");

Fields (Non-exhaustive)§

This struct is marked as non-exhaustive
Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.
§hosts: Vec<String>

Hostnames allowed to resolve into otherwise-blocked address ranges. Exact match, case-insensitive, no wildcards. Each entry must be a bare DNS hostname: no scheme, no port, no userinfo, not a literal IP.

§cidrs: Vec<String>

CIDR blocks whose addresses are considered trusted even when the address would otherwise be blocked. Accepts both IPv4 (e.g. 10.0.0.0/8) and IPv6 (e.g. fd00::/8).

Cloud-metadata addresses inside any listed range remain blocked.

Trait Implementations§

Source§

impl Clone for OAuthSsrfAllowlist

Source§

fn clone(&self) -> OAuthSsrfAllowlist

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 OAuthSsrfAllowlist

Source§

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

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

impl Default for OAuthSsrfAllowlist

Source§

fn default() -> OAuthSsrfAllowlist

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

impl<'de> Deserialize<'de> for OAuthSsrfAllowlist

Source§

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

Deserialize this value from the given Serde deserializer. 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<'a, T, E> AsTaggedExplicit<'a, E> for T
where T: 'a,

Source§

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

Source§

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

Source§

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> 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> 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>,

Source§

impl<A, B, T> HttpServerConnExec<A, B> for T
where B: Body,