Struct DestinationPolicy 

#[non_exhaustive]
pub struct DestinationPolicy {
    pub allowed_schemes: Vec<String>,
    pub allowed_hosts: Vec<String>,
    pub block_link_local: bool,
    pub block_metadata: bool,
}

Destination policy applied to initial request URLs and redirect targets.

By default, HTTP and HTTPS URLs are allowed while link-local and common cloud metadata destinations are blocked. allowed_hosts is an allow-list: when it is empty, any non-blocked host is allowed; when it is non-empty, the URL host must match one of the configured entries. Host entries are exact matches unless they start with *., in which case only dot-boundary subdomains match (for example, *.example.com matches api.example.com but not badexample.com or the apex example.com).

Hostname validation happens before DNS resolution. Use allowed_hosts for high-trust clients that must not follow attacker-controlled DNS names.

Fields (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.

allowed_schemes: Vec<String>

Allowed URL schemes. Empty means all schemes are rejected.

allowed_hosts: Vec<String>

Optional host allow-list. Empty means any non-blocked host is allowed.

block_link_local: bool

Block IPv4/IPv6 link-local address literals.

block_metadata: bool

Block common cloud metadata hosts and address literals.

Implementations

impl DestinationPolicy

pub fn new() -> Self

Create the default destination policy.

pub fn with_allowed_schemes<I, S>(self, schemes: I) -> Self

where I: IntoIterator<Item = S>, S: Into<String>,

Replace allowed schemes.

pub fn with_allowed_hosts<I, S>(self, hosts: I) -> Self

where I: IntoIterator<Item = S>, S: Into<String>,

Replace the host allow-list.

pub fn with_block_link_local(self, block: bool) -> Self

Set whether link-local address literals are blocked.

pub fn with_block_metadata(self, block: bool) -> Self

Set whether common cloud metadata hosts are blocked.

pub fn validate(&self, url: &Url) -> AppResult<()>

Validate a request or redirect URL against this policy.

Errors

Returns an error when the URL scheme, host, or address literal violates the configured policy.

Trait Implementations

impl Clone for DestinationPolicy

fn clone(&self) -> DestinationPolicy

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for DestinationPolicy

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

Formats the value using the given formatter.

impl Default for DestinationPolicy

fn default() -> Self

Returns the “default value” for a type.

impl Eq for DestinationPolicy

impl PartialEq for DestinationPolicy

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

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for DestinationPolicy