Skip to main content

SafeLink

Struct SafeLink 

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

A string that is safe to place in an href.

Structural, not procedural — and that distinction is the whole point. The saved-record path takes an attacker-controlled URL (any atproto client can write the record), and Askama escapes HTML metacharacters but NOT schemes, so javascript: survives escaping intact.

The defence used to be “remember to call net::safe_link before assigning this field”. A cold review measured what that was worth: deleting the call left all 679 tests passing, because every test either exercised the helper directly or never rendered this row. The control was real and completely unprotected.

So the field is no longer a String. There is no From<String>, no public member, and neither constructor can carry a foreign URL into an href: SafeLink::external performs the scheme check itself, and SafeLink::entry takes an i64 and a scope query rather than a string, so it cannot be handed one.

Implementations§

Source

pub fn entry(id: i64, scope_qs: &str) -> Self

The reader’s own link to a cached entry: /entries/{id}, plus the list’s scope query so paging back stays in the list it came from.

Takes the id and query separately and builds the path itself, rather than accepting a ready-made String. A fn internal(String) constructor is an unrestricted Stringhref conduit sitting one identifier away from the single site where attacker-controlled data enters — and a review proved it, by typing internal where external was meant: the whole javascript: hole came back, compiled clean, and passed every test.

An i64 and a scope query cannot spell a scheme. The result always begins /entries/, so it is a path by construction, never a URL. scope_qs is percent-encoded upstream by qenc.

Source

pub fn external(raw: &str) -> Self

Attacker-controlled input. Scheme-checked; an unusable URL yields an EMPTY link, which the template renders as a row WITHOUT an anchor rather than dropping the row — a dropped row is unremovable, because the un-save button lives on it.

Source

pub fn external_opt(raw: &str) -> Option<Self>

SafeLink::external, for a template that omits the link rather than rendering it empty.

The two shapes are not interchangeable, and which one a call site wants is decided by whether anything else lives on the link. The saved-record row keeps the EMPTY link because dropping the row would take the un-save button with it — the record would become unremovable from here. The reader view has no such passenger: entry.html already renders a disabled open-original button for an entry with no URL, so None selects a path that exists and is styled, and an empty href would only invent a third state meaning the same thing.

It lives here rather than as .filter(|l| !l.is_empty()) at the call site so that “empty means refused” stays a fact of this module. That is the same reason the field is in this file at all.

Source

pub fn is_empty(&self) -> bool

Trait Implementations§

Source§

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

Formats the value using the given formatter. 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> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

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

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> 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: Sized + 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: Sized + 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> 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 = !

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

fn try_from(value: U) -> Result<T, !>

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