Skip to main content

SafeUrl

Struct SafeUrl 

Source
pub struct SafeUrl(/* private fields */);
Expand description

A validated URL that rejects dangerous schemes and URLs resolving to network ranges that enable server-side request forgery.

§Allowed schemes

Only http and https. Rejects file://, gopher://, javascript:, data:, and any other non-http(s) scheme.

§Blocked host ranges (SSRF prevention)

Every URL whose host string parses as one of the following IP families is rejected with BoundaryRejection::SsrfAttempt:

CIDRWhat it isWhy it’s blocked
10.0.0.0/8RFC 1918 privateClassic LAN SSRF
172.16.0.0/12RFC 1918 privateClassic LAN SSRF
192.168.0.0/16RFC 1918 privateClassic LAN SSRF
169.254.0.0/16IPv4 link-localAWS IMDS (169.254.169.254) — credential exfiltration
127.0.0.0/8IPv4 loopbackBypass to localhost services
224.0.0.0/4IPv4 multicastLateral-movement response surface
0.0.0.0/32IPv4 unspecifiedStack-internal vulnerabilities
fc00::/7IPv6 Unique Local AddressAnalogue of RFC 1918 on IPv6
fe80::/10IPv6 link-localIPv6 analogue of IMDS attack vector
::1/128IPv6 loopbackBypass to localhost services on IPv6
ff00::/8IPv6 multicastSame as IPv4 multicast, on IPv6
::/128IPv6 unspecifiedStack-internal vulnerabilities

The blocked set is variant-analysis-tested — each CIDR has a named regression test in sg_gate_a_safeurl_cidrs.rs, so removing a single line from the internal classifier fails a specific, named test.

DNS rebinding is not prevented by SafeUrl alone; validate only accepts a host string. If you resolve and connect, perform a fresh is_private_ip check on the resolved address, or pin to a specific resolver policy.

§Examples

use secure_boundary::safe_types::SafeUrl;

// Public URL — accepted.
let url = SafeUrl::try_from("https://example.com/api").unwrap();
assert_eq!(url.as_inner(), "https://example.com/api");

// Loopback — rejected.
assert!(SafeUrl::try_from("http://127.0.0.1/admin").is_err());

// AWS IMDS — rejected.
assert!(SafeUrl::try_from("http://169.254.169.254/latest/meta-data").is_err());

// IPv6 link-local — rejected.
assert!(SafeUrl::try_from("http://[fe80::1]/").is_err());

// Dangerous scheme — rejected.
assert!(SafeUrl::try_from("javascript:alert(1)").is_err());

Implementations§

Source§

impl SafeUrl

Source

pub fn as_inner(&self) -> &str

Returns a reference to the inner URL string.

Source

pub fn into_inner(self) -> String

Consumes the wrapper and returns the inner URL string.

Trait Implementations§

Source§

impl Clone for SafeUrl

Source§

fn clone(&self) -> SafeUrl

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 SafeUrl

Source§

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

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

impl<'de> Deserialize<'de> for SafeUrl

Source§

fn deserialize<D: Deserializer<'de>>(d: D) -> Result<Self, D::Error>

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

impl Display for SafeUrl

Source§

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

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

impl Hash for SafeUrl

Source§

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
Source§

impl PartialEq for SafeUrl

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

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

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

impl TryFrom<&str> for SafeUrl

Source§

type Error = BoundaryRejection

The type returned in the event of a conversion error.
Source§

fn try_from(s: &str) -> Result<Self, Self::Error>

Performs the conversion.
Source§

impl Eq for SafeUrl

Source§

impl StructuralPartialEq for SafeUrl

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> 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> 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> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. 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<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,