Skip to main content

SanitizedHtml

Struct SanitizedHtml 

Source
pub struct SanitizedHtml { /* private fields */ }
Expand description

Article-body HTML that has been through the sanitizer in this process — and so can be emitted into a page without escaping.

Why it exists (#151). entries.content_html reached entry.html as a raw Option<String> rendered with |safe — the one expression in the reader that bypassed Askama’s escaper. Its safety was ingest’s ammonia pass in feed.rs, on a different code path, holding only while every future writer to the column remembered to go through it. That is the same procedural guard SafeLink replaced for the entry’s hrefs.

The guarantee cannot ride through storage. The column is SQLite TEXT, so a type set at ingest means nothing by the time a row is read back. It is re-established at render instead: the only constructor runs the ingest sanitizer, feed::sanitize_html, over whatever the row holds. A newtype that wrapped the stored string without cleaning it was rejected in the issue as a guarantee in name only.

  • One policy. It calls ingest’s function rather than holding its own ammonia builder, so ingest and render cannot drift; a test pins them byte for byte.
  • No change for readers. Sanitizer output is a fixed point of the sanitizer, so a body ingest stored comes back byte-identical (all 545 real bodies measured). Two known exceptions, both the same page to a browser: a literal U+00A0 in a standard.site plain-text summary comes back as &nbsp;, and a table whose <tfoot> the policy stripped gains the <tbody> a browser would build around those rows anyway.
  • Bounded blast radius. Not here: in BodyRenderer, which is how the reader’s handler gets one of these from a stored row.

There is no From<String>, no Deref, and no public field. A raw string does not become one — not by struct literal (E0451, private field):

ⓘ
use feather_reader::sanitized_html::SanitizedHtml;
let _ = SanitizedHtml { html: String::from("<script>alert(1)</script>") };

and not by conversion (E0277, no From):

ⓘ
use feather_reader::sanitized_html::SanitizedHtml;
let _: SanitizedHtml = String::from("<script>alert(1)</script>").into();

Only through the cleaning constructor:

use feather_reader::sanitized_html::SanitizedHtml;
let html = SanitizedHtml::clean("<p>hi</p><script>alert(1)</script>");
assert_eq!(html.as_str(), "<p>hi</p>");

Implementations§

Source§

impl SanitizedHtml

Source

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

Sanitize raw with the ingest policy. The only way to make one.

Blocks for as long as the sanitizer runs, on the whole of raw: on an async task use SanitizedHtml::clean_off_runtime, and for a stored body use BodyRenderer, which also applies the bounds.

Source

pub async fn clean_off_runtime(raw: String) -> Result<Self>

SanitizedHtml::clean on tokio’s blocking pool, so a slow clean stalls no other request sharing the async worker. This does not make the clean cheaper or bound it; BodyRenderer does that.

Source

pub fn as_str(&self) -> &str

The cleaned markup.

Trait Implementations§

Source§

impl Display for SanitizedHtml

Source§

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

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

impl HtmlSafe for SanitizedHtml

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