html: Expose sanitize API on Html
This commit is contained in:
parent
0120861951
commit
ba973c98f1
@ -1,7 +1,7 @@
|
||||
use std::fmt::{self, Write};
|
||||
|
||||
#[cfg(feature = "html")]
|
||||
use ruma_html::{HtmlSanitizer, HtmlSanitizerMode, RemoveReplyFallback};
|
||||
use ruma_html::Html;
|
||||
|
||||
use super::{
|
||||
sanitize::remove_plain_reply_fallback, FormattedBody, MessageType, OriginalRoomMessageEvent,
|
||||
@ -23,13 +23,13 @@ fn get_message_quote_fallbacks(original_message: &OriginalRoomMessageEvent) -> (
|
||||
format!("> {emote_sign}<{sender}> {body}").replace('\n', "\n> "),
|
||||
format!(
|
||||
"<mx-reply>\
|
||||
<blockquote>\
|
||||
<a href=\"https://matrix.to/#/{room_id}/{event_id}\">In reply to</a> \
|
||||
{emote_sign}<a href=\"https://matrix.to/#/{sender}\">{sender}</a>\
|
||||
<br>\
|
||||
{html_body}\
|
||||
</blockquote>\
|
||||
</mx-reply>"
|
||||
<blockquote>\
|
||||
<a href=\"https://matrix.to/#/{room_id}/{event_id}\">In reply to</a> \
|
||||
{emote_sign}<a href=\"https://matrix.to/#/{sender}\">{sender}</a>\
|
||||
<br>\
|
||||
{html_body}\
|
||||
</blockquote>\
|
||||
</mx-reply>"
|
||||
),
|
||||
)
|
||||
};
|
||||
@ -82,9 +82,10 @@ impl fmt::Display for FormattedOrPlainBody<'_> {
|
||||
if let Some(formatted_body) = self.formatted {
|
||||
#[cfg(feature = "html")]
|
||||
if self.is_reply {
|
||||
let sanitizer =
|
||||
HtmlSanitizer::new(HtmlSanitizerMode::Strict, RemoveReplyFallback::Yes);
|
||||
write!(f, "{}", sanitizer.clean(&formatted_body.body))
|
||||
let mut html = Html::parse(&formatted_body.body);
|
||||
html.sanitize();
|
||||
|
||||
write!(f, "{html}")
|
||||
} else {
|
||||
f.write_str(&formatted_body.body)
|
||||
}
|
||||
|
72
crates/ruma-html/src/helpers.rs
Normal file
72
crates/ruma-html/src/helpers.rs
Normal file
@ -0,0 +1,72 @@
|
||||
//! Convenience methods and types to sanitize HTML messages.
|
||||
|
||||
use crate::{Html, SanitizerConfig};
|
||||
|
||||
/// Sanitize the given HTML string.
|
||||
///
|
||||
/// This removes the [tags and attributes] that are not listed in the Matrix specification.
|
||||
///
|
||||
/// It can also optionally remove the [rich reply fallback].
|
||||
///
|
||||
/// [tags and attributes]: https://spec.matrix.org/latest/client-server-api/#mroommessage-msgtypes
|
||||
/// [rich reply fallback]: https://spec.matrix.org/latest/client-server-api/#fallbacks-for-rich-replies
|
||||
pub fn sanitize_html(
|
||||
s: &str,
|
||||
mode: HtmlSanitizerMode,
|
||||
remove_reply_fallback: RemoveReplyFallback,
|
||||
) -> String {
|
||||
let mut config = match mode {
|
||||
HtmlSanitizerMode::Strict => SanitizerConfig::strict(),
|
||||
HtmlSanitizerMode::Compat => SanitizerConfig::compat(),
|
||||
};
|
||||
|
||||
if remove_reply_fallback == RemoveReplyFallback::Yes {
|
||||
config = config.remove_reply_fallback();
|
||||
}
|
||||
|
||||
sanitize_inner(s, config)
|
||||
}
|
||||
|
||||
/// What HTML [tags and attributes] should be kept by the sanitizer.
|
||||
///
|
||||
/// [tags and attributes]: https://spec.matrix.org/latest/client-server-api/#mroommessage-msgtypes
|
||||
#[derive(Clone, Copy, Debug, PartialEq, Eq)]
|
||||
#[allow(clippy::exhaustive_enums)]
|
||||
pub enum HtmlSanitizerMode {
|
||||
/// Keep only the tags and attributes listed in the Matrix specification.
|
||||
Strict,
|
||||
|
||||
/// Like `Strict` mode, with additional tags and attributes that are not yet included in
|
||||
/// the spec, but are reasonable to keep.
|
||||
Compat,
|
||||
}
|
||||
|
||||
/// Whether to remove the [rich reply fallback] while sanitizing.
|
||||
///
|
||||
/// [rich reply fallback]: https://spec.matrix.org/latest/client-server-api/#fallbacks-for-rich-replies
|
||||
#[derive(Clone, Copy, Debug, PartialEq, Eq)]
|
||||
#[allow(clippy::exhaustive_enums)]
|
||||
pub enum RemoveReplyFallback {
|
||||
/// Remove the rich reply fallback.
|
||||
Yes,
|
||||
|
||||
/// Don't remove the rich reply fallback.
|
||||
No,
|
||||
}
|
||||
|
||||
/// Remove the [rich reply fallback] of the given HTML string.
|
||||
///
|
||||
/// Due to the fact that the HTML is parsed, note that malformed HTML and comments will be stripped
|
||||
/// from the output.
|
||||
///
|
||||
/// [rich reply fallback]: https://spec.matrix.org/latest/client-server-api/#fallbacks-for-rich-replies
|
||||
pub fn remove_html_reply_fallback(s: &str) -> String {
|
||||
let config = SanitizerConfig::new().remove_reply_fallback();
|
||||
sanitize_inner(s, config)
|
||||
}
|
||||
|
||||
fn sanitize_inner(s: &str, config: SanitizerConfig) -> String {
|
||||
let mut html = Html::parse(s);
|
||||
html.sanitize_with(config);
|
||||
html.to_string()
|
||||
}
|
@ -10,9 +10,12 @@ use html5ever::{
|
||||
};
|
||||
use tracing::debug;
|
||||
|
||||
use crate::SanitizerConfig;
|
||||
|
||||
/// An HTML fragment.
|
||||
///
|
||||
/// To get the serialized HTML, use its `Display` implementation.
|
||||
/// To get the serialized HTML, use its `Display` implementation. Due to the fact that the HTML is
|
||||
/// parsed, note that malformed HTML and comments will be stripped from the output.
|
||||
#[derive(Debug)]
|
||||
pub struct Html {
|
||||
pub(crate) nodes: Vec<Node>,
|
||||
@ -32,6 +35,20 @@ impl Html {
|
||||
parser.finish()
|
||||
}
|
||||
|
||||
/// Sanitize this HTML according to the Matrix specification.
|
||||
///
|
||||
/// This is equivalent to calling [`Self::sanitize_with()`] with a `config` value of
|
||||
/// `SanitizerConfig::compat().remove_reply_fallback()`.
|
||||
pub fn sanitize(&mut self) {
|
||||
let config = SanitizerConfig::compat().remove_reply_fallback();
|
||||
self.sanitize_with(config);
|
||||
}
|
||||
|
||||
/// Sanitize this HTML according to the given configuration.
|
||||
pub fn sanitize_with(&mut self, config: SanitizerConfig) {
|
||||
config.clean(self);
|
||||
}
|
||||
|
||||
/// Construct a new `Node` with the given data and add it to this `Html`.
|
||||
///
|
||||
/// Returns the index of the new node.
|
||||
|
@ -10,10 +10,12 @@
|
||||
#![warn(missing_docs)]
|
||||
#![cfg_attr(docsrs, feature(doc_auto_cfg))]
|
||||
|
||||
mod helpers;
|
||||
mod html;
|
||||
mod sanitize;
|
||||
mod sanitizer_config;
|
||||
|
||||
pub use self::{
|
||||
helpers::*,
|
||||
html::{ElementData, Html, Node},
|
||||
sanitize::*,
|
||||
sanitizer_config::SanitizerConfig,
|
||||
};
|
||||
|
@ -1,157 +0,0 @@
|
||||
//! Convenience methods and types to sanitize HTML messages.
|
||||
|
||||
mod html_sanitizer;
|
||||
|
||||
pub use self::html_sanitizer::HtmlSanitizer;
|
||||
|
||||
/// Sanitize the given HTML string.
|
||||
///
|
||||
/// This removes the [tags and attributes] that are not listed in the Matrix specification.
|
||||
///
|
||||
/// It can also optionally remove the [rich reply fallback].
|
||||
///
|
||||
/// [tags and attributes]: https://spec.matrix.org/latest/client-server-api/#mroommessage-msgtypes
|
||||
/// [rich reply fallback]: https://spec.matrix.org/latest/client-server-api/#fallbacks-for-rich-replies
|
||||
pub fn sanitize_html(
|
||||
s: &str,
|
||||
mode: HtmlSanitizerMode,
|
||||
remove_reply_fallback: RemoveReplyFallback,
|
||||
) -> String {
|
||||
let sanitizer = HtmlSanitizer::new(mode, remove_reply_fallback);
|
||||
sanitizer.clean(s).to_string()
|
||||
}
|
||||
|
||||
/// What HTML [tags and attributes] should be kept by the sanitizer.
|
||||
///
|
||||
/// [tags and attributes]: https://spec.matrix.org/latest/client-server-api/#mroommessage-msgtypes
|
||||
#[derive(Clone, Copy, Debug, PartialEq, Eq)]
|
||||
#[allow(clippy::exhaustive_enums)]
|
||||
pub enum HtmlSanitizerMode {
|
||||
/// Keep only the tags and attributes listed in the Matrix specification.
|
||||
Strict,
|
||||
|
||||
/// Like `Strict` mode, with additional tags and attributes that are not yet included in
|
||||
/// the spec, but are reasonable to keep.
|
||||
Compat,
|
||||
}
|
||||
|
||||
/// Whether to remove the [rich reply fallback] while sanitizing.
|
||||
///
|
||||
/// [rich reply fallback]: https://spec.matrix.org/latest/client-server-api/#fallbacks-for-rich-replies
|
||||
#[derive(Clone, Copy, Debug, PartialEq, Eq)]
|
||||
#[allow(clippy::exhaustive_enums)]
|
||||
pub enum RemoveReplyFallback {
|
||||
/// Remove the rich reply fallback.
|
||||
Yes,
|
||||
|
||||
/// Don't remove the rich reply fallback.
|
||||
No,
|
||||
}
|
||||
|
||||
/// Remove the [rich reply fallback] of the given HTML string.
|
||||
///
|
||||
/// Due to the fact that the HTML is parsed, note that malformed HTML and comments will be stripped
|
||||
/// from the output.
|
||||
///
|
||||
/// [rich reply fallback]: https://spec.matrix.org/latest/client-server-api/#fallbacks-for-rich-replies
|
||||
pub fn remove_html_reply_fallback(s: &str) -> String {
|
||||
let sanitizer = HtmlSanitizer::reply_fallback_remover();
|
||||
sanitizer.clean(s).to_string()
|
||||
}
|
||||
|
||||
#[cfg(test)]
|
||||
mod tests {
|
||||
use super::{
|
||||
remove_html_reply_fallback, sanitize_html, HtmlSanitizerMode, RemoveReplyFallback,
|
||||
};
|
||||
|
||||
#[test]
|
||||
fn sanitize() {
|
||||
let sanitized = sanitize_html(
|
||||
"\
|
||||
<mx-reply>\
|
||||
<blockquote>\
|
||||
<a href=\"https://matrix.to/#/!n8f893n9:example.com/$1598361704261elfgc:localhost\">In reply to</a> \
|
||||
<a href=\"https://matrix.to/#/@alice:example.com\">@alice:example.com</a>\
|
||||
<br>\
|
||||
Previous message\
|
||||
</blockquote>\
|
||||
</mx-reply>\
|
||||
<removed>This has no tag</removed>\
|
||||
<p>But this is inside a tag</p>\
|
||||
",
|
||||
HtmlSanitizerMode::Strict,
|
||||
RemoveReplyFallback::No,
|
||||
);
|
||||
|
||||
assert_eq!(
|
||||
sanitized,
|
||||
"\
|
||||
<mx-reply>\
|
||||
<blockquote>\
|
||||
<a href=\"https://matrix.to/#/!n8f893n9:example.com/$1598361704261elfgc:localhost\">In reply to</a> \
|
||||
<a href=\"https://matrix.to/#/@alice:example.com\">@alice:example.com</a>\
|
||||
<br>\
|
||||
Previous message\
|
||||
</blockquote>\
|
||||
</mx-reply>\
|
||||
This has no tag\
|
||||
<p>But this is inside a tag</p>\
|
||||
"
|
||||
);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn sanitize_without_reply() {
|
||||
let sanitized = sanitize_html(
|
||||
"\
|
||||
<mx-reply>\
|
||||
<blockquote>\
|
||||
<a href=\"https://matrix.to/#/!n8f893n9:example.com/$1598361704261elfgc:localhost\">In reply to</a> \
|
||||
<a href=\"https://matrix.to/#/@alice:example.com\">@alice:example.com</a>\
|
||||
<br>\
|
||||
Previous message\
|
||||
</blockquote>\
|
||||
</mx-reply>\
|
||||
<removed>This has no tag</removed>\
|
||||
<p>But this is inside a tag</p>\
|
||||
",
|
||||
HtmlSanitizerMode::Strict,
|
||||
RemoveReplyFallback::Yes,
|
||||
);
|
||||
|
||||
assert_eq!(
|
||||
sanitized,
|
||||
"\
|
||||
This has no tag\
|
||||
<p>But this is inside a tag</p>\
|
||||
"
|
||||
);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn remove_html_reply() {
|
||||
let without_reply = remove_html_reply_fallback(
|
||||
"\
|
||||
<mx-reply>\
|
||||
<blockquote>\
|
||||
<a href=\"https://matrix.to/#/!n8f893n9:example.com/$1598361704261elfgc:localhost\">In reply to</a> \
|
||||
<a href=\"https://matrix.to/#/@alice:example.com\">@alice:example.com</a>\
|
||||
<br>\
|
||||
Previous message\
|
||||
</blockquote>\
|
||||
</mx-reply>\
|
||||
<keep-me>This keeps its tag</keep-me>\
|
||||
<p>But this is inside a tag</p>\
|
||||
",
|
||||
);
|
||||
|
||||
assert_eq!(
|
||||
without_reply,
|
||||
"\
|
||||
<keep-me>This keeps its tag</keep-me>\
|
||||
<p>But this is inside a tag</p>\
|
||||
"
|
||||
);
|
||||
}
|
||||
}
|
@ -1,540 +0,0 @@
|
||||
use html5ever::{tendril::StrTendril, Attribute};
|
||||
use phf::{phf_map, phf_set, Map, Set};
|
||||
use wildmatch::WildMatch;
|
||||
|
||||
use super::{HtmlSanitizerMode, RemoveReplyFallback};
|
||||
use crate::html::{ElementData, Html, NodeData};
|
||||
|
||||
/// A sanitizer to filter [HTML tags and attributes] according to the Matrix specification.
|
||||
///
|
||||
/// [HTML tags and attributes]: https://spec.matrix.org/latest/client-server-api/#mroommessage-msgtypes
|
||||
#[derive(Debug, Clone)]
|
||||
pub struct HtmlSanitizer {
|
||||
/// The mode of the HTML sanitizer.
|
||||
mode: HtmlSanitizerMode,
|
||||
|
||||
/// Whether to filter HTML tags and attributes.
|
||||
///
|
||||
/// If this is `true`, tags and attributes that do not match the lists will be removed, but
|
||||
/// the tags' children will still be present in the output.
|
||||
///
|
||||
/// If this is `false`, all the tags and attributes are allowed.
|
||||
filter_tags_attributes: bool,
|
||||
|
||||
/// Whether to remove replies.
|
||||
///
|
||||
/// If this is `true`, the rich reply fallback will be removed.
|
||||
///
|
||||
/// If this is `false`, the rich reply tag will be allowed.
|
||||
remove_replies: bool,
|
||||
}
|
||||
|
||||
impl HtmlSanitizer {
|
||||
/// Constructs a `HTMLSanitizer` that will filter the tags and attributes according to the given
|
||||
/// mode.
|
||||
///
|
||||
/// It can also optionally remove the [rich reply fallback].
|
||||
///
|
||||
/// [rich reply fallback]: https://spec.matrix.org/latest/client-server-api/#fallbacks-for-rich-replies
|
||||
pub fn new(mode: HtmlSanitizerMode, remove_reply_fallback: RemoveReplyFallback) -> Self {
|
||||
Self {
|
||||
mode,
|
||||
filter_tags_attributes: true,
|
||||
remove_replies: remove_reply_fallback == RemoveReplyFallback::Yes,
|
||||
}
|
||||
}
|
||||
|
||||
/// Constructs a `HTMLSanitizer` instance that only removes the [rich reply fallback].
|
||||
///
|
||||
/// [rich reply fallback]: https://spec.matrix.org/latest/client-server-api/#fallbacks-for-rich-replies
|
||||
pub fn reply_fallback_remover() -> Self {
|
||||
Self {
|
||||
mode: HtmlSanitizerMode::Strict,
|
||||
filter_tags_attributes: false,
|
||||
remove_replies: true,
|
||||
}
|
||||
}
|
||||
|
||||
/// Clean the given HTML string with this sanitizer.
|
||||
pub fn clean(&self, html: &str) -> Html {
|
||||
let mut fragment = Html::parse(html);
|
||||
|
||||
let root = fragment.nodes[0].first_child.unwrap();
|
||||
let mut next_child = fragment.nodes[root].first_child;
|
||||
while let Some(child) = next_child {
|
||||
next_child = fragment.nodes[child].next_sibling;
|
||||
self.clean_node(&mut fragment, child, 0);
|
||||
}
|
||||
|
||||
fragment
|
||||
}
|
||||
|
||||
fn clean_node(&self, fragment: &mut Html, node_id: usize, depth: u32) {
|
||||
let action = self.node_action(fragment, node_id, depth);
|
||||
|
||||
if action != NodeAction::Remove {
|
||||
let mut next_child = fragment.nodes[node_id].first_child;
|
||||
while let Some(child) = next_child {
|
||||
next_child = fragment.nodes[child].next_sibling;
|
||||
|
||||
if action == NodeAction::Ignore {
|
||||
fragment.insert_before(node_id, child);
|
||||
}
|
||||
|
||||
self.clean_node(fragment, child, depth + 1);
|
||||
}
|
||||
}
|
||||
|
||||
if matches!(action, NodeAction::Ignore | NodeAction::Remove) {
|
||||
fragment.detach(node_id);
|
||||
} else if self.filter_tags_attributes {
|
||||
if let Some(data) = fragment.nodes[node_id].as_element_mut() {
|
||||
self.clean_element_attributes(data);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
fn node_action(&self, fragment: &Html, node_id: usize, depth: u32) -> NodeAction {
|
||||
match &fragment.nodes[node_id].data {
|
||||
NodeData::Element(ElementData { name, attrs, .. }) => {
|
||||
let tag: &str = &name.local;
|
||||
|
||||
if (self.remove_replies && tag == RICH_REPLY_TAG)
|
||||
|| (self.filter_tags_attributes && depth >= MAX_DEPTH_STRICT)
|
||||
{
|
||||
NodeAction::Remove
|
||||
} else if self.filter_tags_attributes
|
||||
&& (!ALLOWED_TAGS_WITHOUT_REPLY_STRICT.contains(tag) && tag != RICH_REPLY_TAG)
|
||||
{
|
||||
NodeAction::Ignore
|
||||
} else if self.filter_tags_attributes {
|
||||
let allowed_schemes = if self.mode == HtmlSanitizerMode::Strict {
|
||||
&ALLOWED_SCHEMES_STRICT
|
||||
} else {
|
||||
&ALLOWED_SCHEMES_COMPAT
|
||||
};
|
||||
for attr in attrs.iter() {
|
||||
let value = &attr.value;
|
||||
let attr: &str = &attr.name.local;
|
||||
|
||||
// Check if there is a (tag, attr) tuple entry.
|
||||
if let Some(schemes) = allowed_schemes.get(&*format!("{tag}:{attr}")) {
|
||||
// Check if the scheme is allowed.
|
||||
if !schemes
|
||||
.iter()
|
||||
.any(|scheme| value.starts_with(&format!("{scheme}:")))
|
||||
{
|
||||
return NodeAction::Ignore;
|
||||
}
|
||||
}
|
||||
}
|
||||
NodeAction::None
|
||||
} else {
|
||||
NodeAction::None
|
||||
}
|
||||
}
|
||||
NodeData::Text(_) => NodeAction::None,
|
||||
_ => NodeAction::Remove,
|
||||
}
|
||||
}
|
||||
|
||||
fn clean_element_attributes(&self, data: &mut ElementData) {
|
||||
let ElementData { name, attrs } = data;
|
||||
let tag: &str = &name.local;
|
||||
|
||||
let actions: Vec<_> = attrs
|
||||
.iter()
|
||||
.filter_map(|attr| {
|
||||
let value = &attr.value;
|
||||
let name: &str = &attr.name.local;
|
||||
|
||||
if ALLOWED_ATTRIBUTES_STRICT.get(tag).filter(|attrs| attrs.contains(name)).is_none()
|
||||
{
|
||||
return Some(AttributeAction::Remove(attr.to_owned()));
|
||||
}
|
||||
|
||||
if name == "class" {
|
||||
if let Some(classes) = ALLOWED_CLASSES_STRICT.get(tag) {
|
||||
let mut changed = false;
|
||||
let attr_classes = value.split_whitespace().filter(|attr_class| {
|
||||
for class in classes.iter() {
|
||||
if WildMatch::new(class).matches(attr_class) {
|
||||
return true;
|
||||
}
|
||||
}
|
||||
changed = true;
|
||||
false
|
||||
});
|
||||
|
||||
let folded_classes = attr_classes.fold(String::new(), |mut a, b| {
|
||||
a.reserve(b.len() + 1);
|
||||
a.push_str(b);
|
||||
a.push('\n');
|
||||
a
|
||||
});
|
||||
let final_classes = folded_classes.trim_end();
|
||||
|
||||
if changed {
|
||||
if final_classes.is_empty() {
|
||||
return Some(AttributeAction::Remove(attr.to_owned()));
|
||||
} else {
|
||||
return Some(AttributeAction::ReplaceValue(
|
||||
attr.to_owned(),
|
||||
final_classes.to_owned().into(),
|
||||
));
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
None
|
||||
})
|
||||
.collect();
|
||||
|
||||
for action in actions {
|
||||
match action {
|
||||
AttributeAction::ReplaceValue(attr, value) => {
|
||||
if let Some(mut attr) = attrs.take(&attr) {
|
||||
attr.value = value;
|
||||
attrs.insert(attr);
|
||||
}
|
||||
}
|
||||
AttributeAction::Remove(attr) => {
|
||||
attrs.remove(&attr);
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/// The possible actions to apply to an element node.
|
||||
#[derive(Debug, PartialEq, Eq)]
|
||||
enum NodeAction {
|
||||
/// Don't do anything.
|
||||
None,
|
||||
|
||||
/// Remove the element but keep its children.
|
||||
Ignore,
|
||||
|
||||
/// Remove the element and its children.
|
||||
Remove,
|
||||
}
|
||||
|
||||
/// The possible actions to apply to an element node.
|
||||
#[derive(Debug)]
|
||||
enum AttributeAction {
|
||||
/// Replace the value of the attribute.
|
||||
ReplaceValue(Attribute, StrTendril),
|
||||
|
||||
/// Remove the element and its children.
|
||||
Remove(Attribute),
|
||||
}
|
||||
|
||||
/// List of HTML tags allowed in the Matrix specification, without the rich reply fallback tag.
|
||||
static ALLOWED_TAGS_WITHOUT_REPLY_STRICT: Set<&str> = phf_set! {
|
||||
"font", "del", "h1", "h2", "h3", "h4", "h5", "h6", "blockquote", "p", "a",
|
||||
"ul", "ol", "sup", "sub", "li", "b", "i", "u", "strong", "em", "strike",
|
||||
"code", "hr", "br", "div", "table", "thead", "tbody", "tr", "th", "td",
|
||||
"caption", "pre", "span", "img", "details", "summary",
|
||||
};
|
||||
|
||||
/// The HTML tag name for a rich reply fallback.
|
||||
const RICH_REPLY_TAG: &str = "mx-reply";
|
||||
|
||||
/// Allowed attributes per HTML tag according to the Matrix specification.
|
||||
static ALLOWED_ATTRIBUTES_STRICT: Map<&str, &Set<&str>> = phf_map! {
|
||||
"font" => &ALLOWED_ATTRIBUTES_FONT_STRICT,
|
||||
"span" => &ALLOWED_ATTRIBUTES_SPAN_STRICT,
|
||||
"a" => &ALLOWED_ATTRIBUTES_A_STRICT,
|
||||
"img" => &ALLOWED_ATTRIBUTES_IMG_STRICT,
|
||||
"ol" => &ALLOWED_ATTRIBUTES_OL_STRICT,
|
||||
"code" => &ALLOWED_ATTRIBUTES_CODE_STRICT,
|
||||
};
|
||||
static ALLOWED_ATTRIBUTES_FONT_STRICT: Set<&str> =
|
||||
phf_set! { "data-mx-bg-color", "data-mx-color", "color" };
|
||||
static ALLOWED_ATTRIBUTES_SPAN_STRICT: Set<&str> =
|
||||
phf_set! { "data-mx-bg-color", "data-mx-color", "data-mx-spoiler" };
|
||||
static ALLOWED_ATTRIBUTES_A_STRICT: Set<&str> = phf_set! { "name", "target", "href" };
|
||||
static ALLOWED_ATTRIBUTES_IMG_STRICT: Set<&str> =
|
||||
phf_set! { "width", "height", "alt", "title", "src" };
|
||||
static ALLOWED_ATTRIBUTES_OL_STRICT: Set<&str> = phf_set! { "start" };
|
||||
static ALLOWED_ATTRIBUTES_CODE_STRICT: Set<&str> = phf_set! { "class" };
|
||||
|
||||
/// Allowed schemes of URIs per HTML tag and attribute tuple according to the Matrix specification.
|
||||
static ALLOWED_SCHEMES_STRICT: Map<&str, &Set<&str>> = phf_map! {
|
||||
"a:href" => &ALLOWED_SCHEMES_A_HREF_STRICT,
|
||||
"img:src" => &ALLOWED_SCHEMES_IMG_SRC_STRICT,
|
||||
};
|
||||
static ALLOWED_SCHEMES_A_HREF_STRICT: Set<&str> =
|
||||
phf_set! { "http", "https", "ftp", "mailto", "magnet" };
|
||||
static ALLOWED_SCHEMES_IMG_SRC_STRICT: Set<&str> = phf_set! { "mxc" };
|
||||
|
||||
/// Extra allowed schemes of URIs per HTML tag and attribute tuple.
|
||||
///
|
||||
/// This is a convenience list to add schemes that can be encountered but are not listed in the
|
||||
/// Matrix specification. It consists of:
|
||||
///
|
||||
/// * The `matrix` scheme for `a` tags (see [matrix-org/matrix-spec#1108]).
|
||||
///
|
||||
/// To get a complete list, add these to `ALLOWED_SCHEMES_STRICT`.
|
||||
///
|
||||
/// [matrix-org/matrix-spec#1108]: https://github.com/matrix-org/matrix-spec/issues/1108
|
||||
static ALLOWED_SCHEMES_COMPAT: Map<&str, &Set<&str>> = phf_map! {
|
||||
"a:href" => &ALLOWED_SCHEMES_A_HREF_COMPAT,
|
||||
"img:src" => &ALLOWED_SCHEMES_IMG_SRC_STRICT,
|
||||
};
|
||||
static ALLOWED_SCHEMES_A_HREF_COMPAT: Set<&str> =
|
||||
phf_set! { "http", "https", "ftp", "mailto", "magnet", "matrix" };
|
||||
|
||||
/// Allowed classes per HTML tag according to the Matrix specification.
|
||||
static ALLOWED_CLASSES_STRICT: Map<&str, &Set<&str>> =
|
||||
phf_map! { "code" => &ALLOWED_CLASSES_CODE_STRICT };
|
||||
static ALLOWED_CLASSES_CODE_STRICT: Set<&str> = phf_set! { "language-*" };
|
||||
|
||||
/// Max depth of nested HTML tags allowed by the Matrix specification.
|
||||
const MAX_DEPTH_STRICT: u32 = 100;
|
||||
|
||||
#[cfg(test)]
|
||||
mod tests {
|
||||
use super::{HtmlSanitizer, HtmlSanitizerMode, RemoveReplyFallback};
|
||||
|
||||
#[test]
|
||||
fn valid_input() {
|
||||
let sanitizer = HtmlSanitizer::new(HtmlSanitizerMode::Strict, RemoveReplyFallback::Yes);
|
||||
let sanitized = sanitizer.clean(
|
||||
"\
|
||||
<ul><li>This</li><li>has</li><li>no</li><li>tag</li></ul>\
|
||||
<p>This is a paragraph <span data-mx-color=\"green\">with some color</span></p>\
|
||||
<img src=\"mxc://notareal.hs/abcdef\">\
|
||||
<code class=\"language-html\"><mx-reply>This is a fake reply</mx-reply></code>\
|
||||
",
|
||||
);
|
||||
|
||||
assert_eq!(
|
||||
sanitized.to_string(),
|
||||
"\
|
||||
<ul><li>This</li><li>has</li><li>no</li><li>tag</li></ul>\
|
||||
<p>This is a paragraph <span data-mx-color=\"green\">with some color</span></p>\
|
||||
<img src=\"mxc://notareal.hs/abcdef\">\
|
||||
<code class=\"language-html\"><mx-reply>This is a fake reply</mx-reply></code>\
|
||||
"
|
||||
);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn tags_remove() {
|
||||
let sanitizer = HtmlSanitizer::new(HtmlSanitizerMode::Strict, RemoveReplyFallback::No);
|
||||
let sanitized = sanitizer.clean(
|
||||
"\
|
||||
<mx-reply>\
|
||||
<blockquote>\
|
||||
<a href=\"https://matrix.to/#/!n8f893n9:example.com/$1598361704261elfgc:localhost\">In reply to</a> \
|
||||
<a href=\"https://matrix.to/#/@alice:example.com\">@alice:example.com</a>\
|
||||
<br>\
|
||||
Previous message\
|
||||
</blockquote>\
|
||||
</mx-reply>\
|
||||
<removed>This has no tag</removed>\
|
||||
<p>But this is inside a tag</p>\
|
||||
",
|
||||
);
|
||||
|
||||
assert_eq!(
|
||||
sanitized.to_string(),
|
||||
"\
|
||||
<mx-reply>\
|
||||
<blockquote>\
|
||||
<a href=\"https://matrix.to/#/!n8f893n9:example.com/$1598361704261elfgc:localhost\">In reply to</a> \
|
||||
<a href=\"https://matrix.to/#/@alice:example.com\">@alice:example.com</a>\
|
||||
<br>\
|
||||
Previous message\
|
||||
</blockquote>\
|
||||
</mx-reply>\
|
||||
This has no tag\
|
||||
<p>But this is inside a tag</p>\
|
||||
"
|
||||
);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn tags_remove_without_reply() {
|
||||
let sanitizer = HtmlSanitizer::new(HtmlSanitizerMode::Strict, RemoveReplyFallback::Yes);
|
||||
let sanitized = sanitizer.clean(
|
||||
"\
|
||||
<mx-reply>\
|
||||
<blockquote>\
|
||||
<a href=\"https://matrix.to/#/!n8f893n9:example.com/$1598361704261elfgc:localhost\">In reply to</a> \
|
||||
<a href=\"https://matrix.to/#/@alice:example.com\">@alice:example.com</a>\
|
||||
<br>\
|
||||
Previous message\
|
||||
</blockquote>\
|
||||
</mx-reply>\
|
||||
<removed>This has no tag</removed>\
|
||||
<p>But this is inside a tag</p>\
|
||||
",
|
||||
);
|
||||
|
||||
assert_eq!(
|
||||
sanitized.to_string(),
|
||||
"\
|
||||
This has no tag\
|
||||
<p>But this is inside a tag</p>\
|
||||
"
|
||||
);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn tags_remove_only_reply_fallback() {
|
||||
let sanitizer = HtmlSanitizer::reply_fallback_remover();
|
||||
let sanitized = sanitizer.clean(
|
||||
"\
|
||||
<mx-reply>\
|
||||
<blockquote>\
|
||||
<a href=\"https://matrix.to/#/!n8f893n9:example.com/$1598361704261elfgc:localhost\">In reply to</a> \
|
||||
<a href=\"https://matrix.to/#/@alice:example.com\">@alice:example.com</a>\
|
||||
<br>\
|
||||
Previous message\
|
||||
</blockquote>\
|
||||
</mx-reply>\
|
||||
<keep-me>This keeps its tag</keep-me>\
|
||||
<p>But this is inside a tag</p>\
|
||||
",
|
||||
);
|
||||
|
||||
assert_eq!(
|
||||
sanitized.to_string(),
|
||||
"\
|
||||
<keep-me>This keeps its tag</keep-me>\
|
||||
<p>But this is inside a tag</p>\
|
||||
"
|
||||
);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn attrs_remove() {
|
||||
let sanitizer = HtmlSanitizer::new(HtmlSanitizerMode::Strict, RemoveReplyFallback::No);
|
||||
let sanitized = sanitizer.clean(
|
||||
"\
|
||||
<h1 id=\"anchor1\">Title for important stuff</h1>\
|
||||
<p class=\"important\">Look at <font color=\"blue\" size=20>me!</font></p>\
|
||||
",
|
||||
);
|
||||
|
||||
assert_eq!(
|
||||
sanitized.to_string(),
|
||||
"\
|
||||
<h1>Title for important stuff</h1>\
|
||||
<p>Look at <font color=\"blue\">me!</font></p>\
|
||||
"
|
||||
);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn img_remove_scheme() {
|
||||
let sanitizer = HtmlSanitizer::new(HtmlSanitizerMode::Strict, RemoveReplyFallback::No);
|
||||
let sanitized = sanitizer.clean(
|
||||
"\
|
||||
<p>Look at that picture:</p>\
|
||||
<img src=\"https://notareal.hs/abcdef\">\
|
||||
",
|
||||
);
|
||||
|
||||
assert_eq!(
|
||||
sanitized.to_string(),
|
||||
"\
|
||||
<p>Look at that picture:</p>\
|
||||
"
|
||||
);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn link_remove_scheme() {
|
||||
let sanitizer = HtmlSanitizer::new(HtmlSanitizerMode::Strict, RemoveReplyFallback::No);
|
||||
let sanitized = sanitizer.clean(
|
||||
"\
|
||||
<p>Go see <a href=\"file://local/file.html\">my local website</a></p>\
|
||||
",
|
||||
);
|
||||
|
||||
assert_eq!(
|
||||
sanitized.to_string(),
|
||||
"\
|
||||
<p>Go see my local website</p>\
|
||||
"
|
||||
);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn link_compat_scheme() {
|
||||
let sanitizer = HtmlSanitizer::new(HtmlSanitizerMode::Strict, RemoveReplyFallback::No);
|
||||
let sanitized = sanitizer.clean(
|
||||
"\
|
||||
<p>Join <a href=\"matrix:r/myroom:notareal.hs\">my room</a></p>\
|
||||
<p>To talk about <a href=\"https://mycat.org\">my cat</a></p>\
|
||||
",
|
||||
);
|
||||
assert_eq!(
|
||||
sanitized.to_string(),
|
||||
"\
|
||||
<p>Join my room</p>\
|
||||
<p>To talk about <a href=\"https://mycat.org\">my cat</a></p>\
|
||||
"
|
||||
);
|
||||
|
||||
let sanitizer = HtmlSanitizer::new(HtmlSanitizerMode::Compat, RemoveReplyFallback::No);
|
||||
let sanitized = sanitizer.clean(
|
||||
"\
|
||||
<p>Join <a href=\"matrix:r/myroom:notareal.hs\">my room</a></p>\
|
||||
<p>To talk about <a href=\"https://mycat.org\">my cat</a></p>\
|
||||
",
|
||||
);
|
||||
assert_eq!(
|
||||
sanitized.to_string(),
|
||||
"\
|
||||
<p>Join <a href=\"matrix:r/myroom:notareal.hs\">my room</a></p>\
|
||||
<p>To talk about <a href=\"https://mycat.org\">my cat</a></p>\
|
||||
"
|
||||
);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn class_remove() {
|
||||
let sanitizer = HtmlSanitizer::new(HtmlSanitizerMode::Strict, RemoveReplyFallback::No);
|
||||
let sanitized = sanitizer.clean(
|
||||
"\
|
||||
<pre><code class=\"language-rust custom-class\">
|
||||
type StringList = Vec<String>;
|
||||
</code></pre>\
|
||||
<p>What do you think of the name <code class=\"fake-language-rust\">StringList</code>?</p>\
|
||||
",
|
||||
);
|
||||
|
||||
assert_eq!(
|
||||
sanitized.to_string(),
|
||||
"\
|
||||
<pre><code class=\"language-rust\">
|
||||
type StringList = Vec<String>;
|
||||
</code></pre>\
|
||||
<p>What do you think of the name <code>StringList</code>?</p>\
|
||||
"
|
||||
);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn depth_remove() {
|
||||
let sanitizer = HtmlSanitizer::new(HtmlSanitizerMode::Strict, RemoveReplyFallback::No);
|
||||
let deeply_nested_html: String = std::iter::repeat("<div>")
|
||||
.take(100)
|
||||
.chain(Some(
|
||||
"<span>I am in too deep!</span>\
|
||||
I should be fine.",
|
||||
))
|
||||
.chain(std::iter::repeat("</div>").take(100))
|
||||
.collect();
|
||||
|
||||
let sanitized = sanitizer.clean(&deeply_nested_html).to_string();
|
||||
|
||||
assert!(sanitized.contains("I should be fine."));
|
||||
assert!(!sanitized.contains("I am in too deep!"));
|
||||
}
|
||||
}
|
310
crates/ruma-html/src/sanitizer_config.rs
Normal file
310
crates/ruma-html/src/sanitizer_config.rs
Normal file
@ -0,0 +1,310 @@
|
||||
use html5ever::{tendril::StrTendril, Attribute};
|
||||
use phf::{phf_map, phf_set, Map, Set};
|
||||
use wildmatch::WildMatch;
|
||||
|
||||
use crate::html::{ElementData, Html, NodeData};
|
||||
|
||||
/// Configuration to sanitize HTML tags and attributes.
|
||||
#[derive(Debug, Default, Clone)]
|
||||
pub struct SanitizerConfig {
|
||||
/// The allowed HTML tags.
|
||||
///
|
||||
/// If this is `None`, all tags are allowed.
|
||||
allowed_tags: Option<&'static Set<&'static str>>,
|
||||
|
||||
/// The allowed attributes per tag.
|
||||
///
|
||||
/// If this is `None`, all attributes are allowed.
|
||||
allowed_attrs: Option<&'static Map<&'static str, &'static Set<&'static str>>>,
|
||||
|
||||
/// The allowed URI schemes per tag.
|
||||
///
|
||||
/// If this is `None`, all schemes are allowed.
|
||||
allowed_schemes: Option<&'static Map<&'static str, &'static Set<&'static str>>>,
|
||||
|
||||
/// The allowed classes per tag.
|
||||
///
|
||||
/// If this is `None`, all classes are allowed.
|
||||
allowed_classes: Option<&'static Map<&'static str, &'static Set<&'static str>>>,
|
||||
|
||||
/// The maximum nesting level of the tags.
|
||||
max_depth: Option<u32>,
|
||||
|
||||
/// Whether to remove rich reply fallback.
|
||||
remove_reply_fallback: bool,
|
||||
}
|
||||
|
||||
impl SanitizerConfig {
|
||||
/// Constructs an empty `SanitizerConfig` that will not filter any tag or attribute.
|
||||
pub fn new() -> Self {
|
||||
Self::default()
|
||||
}
|
||||
|
||||
/// Constructs a `SanitizerConfig` that will filter tags or attributes not [listed in the
|
||||
/// Matrix specification].
|
||||
///
|
||||
/// It will not remove the reply fallback by default.
|
||||
///
|
||||
/// [listed in the Matrix specification]: https://spec.matrix.org/latest/client-server-api/#mroommessage-msgtypes
|
||||
pub fn strict() -> Self {
|
||||
Self {
|
||||
allowed_tags: Some(&ALLOWED_TAGS_WITHOUT_REPLY_STRICT),
|
||||
allowed_attrs: Some(&ALLOWED_ATTRIBUTES_STRICT),
|
||||
allowed_schemes: Some(&ALLOWED_SCHEMES_STRICT),
|
||||
allowed_classes: Some(&ALLOWED_CLASSES_STRICT),
|
||||
max_depth: Some(MAX_DEPTH_STRICT),
|
||||
remove_reply_fallback: false,
|
||||
}
|
||||
}
|
||||
|
||||
/// Constructs a `SanitizerConfig` that will filter tags or attributes not [listed in the
|
||||
/// Matrix specification], except a few for improved compatibility:
|
||||
///
|
||||
/// - The `matrix` scheme is allowed in links.
|
||||
///
|
||||
/// It will not remove the reply fallback by default.
|
||||
///
|
||||
/// [listed in the Matrix specification]: https://spec.matrix.org/latest/client-server-api/#mroommessage-msgtypes
|
||||
pub fn compat() -> Self {
|
||||
Self { allowed_schemes: Some(&ALLOWED_SCHEMES_COMPAT), ..Self::strict() }
|
||||
}
|
||||
|
||||
/// Remove the [rich reply fallback].
|
||||
///
|
||||
/// [rich reply fallback]: https://spec.matrix.org/latest/client-server-api/#fallbacks-for-rich-replies
|
||||
pub fn remove_reply_fallback(mut self) -> Self {
|
||||
self.remove_reply_fallback = true;
|
||||
self
|
||||
}
|
||||
|
||||
/// Clean the given HTML with this sanitizer.
|
||||
pub(crate) fn clean(self, html: &mut Html) {
|
||||
let root = html.nodes[0].first_child.unwrap();
|
||||
let mut next_child = html.nodes[root].first_child;
|
||||
|
||||
while let Some(child) = next_child {
|
||||
next_child = html.nodes[child].next_sibling;
|
||||
self.clean_node(html, child, 0);
|
||||
}
|
||||
}
|
||||
|
||||
fn clean_node(&self, html: &mut Html, node_id: usize, depth: u32) {
|
||||
let action = self.node_action(html, node_id, depth);
|
||||
|
||||
if action != NodeAction::Remove {
|
||||
let mut next_child = html.nodes[node_id].first_child;
|
||||
while let Some(child) = next_child {
|
||||
next_child = html.nodes[child].next_sibling;
|
||||
|
||||
if action == NodeAction::Ignore {
|
||||
html.insert_before(node_id, child);
|
||||
}
|
||||
|
||||
self.clean_node(html, child, depth + 1);
|
||||
}
|
||||
}
|
||||
|
||||
if matches!(action, NodeAction::Ignore | NodeAction::Remove) {
|
||||
html.detach(node_id);
|
||||
} else if let Some(data) = html.nodes[node_id].as_element_mut() {
|
||||
self.clean_element_attributes(data);
|
||||
}
|
||||
}
|
||||
|
||||
fn node_action(&self, html: &Html, node_id: usize, depth: u32) -> NodeAction {
|
||||
match &html.nodes[node_id].data {
|
||||
NodeData::Element(ElementData { name, attrs, .. }) => {
|
||||
let tag: &str = &name.local;
|
||||
|
||||
if (self.remove_reply_fallback && tag == RICH_REPLY_TAG)
|
||||
|| self.max_depth.is_some_and(|max| depth >= max)
|
||||
{
|
||||
NodeAction::Remove
|
||||
} else if self
|
||||
.allowed_tags
|
||||
.is_some_and(|allowed| tag != RICH_REPLY_TAG && !allowed.contains(tag))
|
||||
{
|
||||
NodeAction::Ignore
|
||||
} else if let Some(allowed_schemes) = self.allowed_schemes {
|
||||
for attr in attrs.iter() {
|
||||
let value = &attr.value;
|
||||
let attr: &str = &attr.name.local;
|
||||
|
||||
// Check if there is a (tag, attr) tuple entry.
|
||||
if let Some(schemes) = allowed_schemes.get(&*format!("{tag}:{attr}")) {
|
||||
// Check if the scheme is allowed.
|
||||
if !schemes
|
||||
.iter()
|
||||
.any(|scheme| value.starts_with(&format!("{scheme}:")))
|
||||
{
|
||||
return NodeAction::Ignore;
|
||||
}
|
||||
}
|
||||
}
|
||||
NodeAction::None
|
||||
} else {
|
||||
NodeAction::None
|
||||
}
|
||||
}
|
||||
NodeData::Text(_) => NodeAction::None,
|
||||
_ => NodeAction::Remove,
|
||||
}
|
||||
}
|
||||
|
||||
fn clean_element_attributes(&self, data: &mut ElementData) {
|
||||
let ElementData { name, attrs } = data;
|
||||
let tag: &str = &name.local;
|
||||
|
||||
let actions: Vec<_> = attrs
|
||||
.iter()
|
||||
.filter_map(|attr| {
|
||||
let value = &attr.value;
|
||||
let name: &str = &attr.name.local;
|
||||
|
||||
if self
|
||||
.allowed_attrs
|
||||
.is_some_and(|m| !m.get(tag).is_some_and(|attrs| attrs.contains(name)))
|
||||
{
|
||||
return Some(AttributeAction::Remove(attr.to_owned()));
|
||||
}
|
||||
|
||||
if name == "class" {
|
||||
if let Some(classes) = self.allowed_classes.and_then(|m| m.get(tag)) {
|
||||
let mut changed = false;
|
||||
let attr_classes = value.split_whitespace().filter(|attr_class| {
|
||||
for class in classes.iter() {
|
||||
if WildMatch::new(class).matches(attr_class) {
|
||||
return true;
|
||||
}
|
||||
}
|
||||
changed = true;
|
||||
false
|
||||
});
|
||||
|
||||
let folded_classes = attr_classes.fold(String::new(), |mut a, b| {
|
||||
a.reserve(b.len() + 1);
|
||||
a.push_str(b);
|
||||
a.push('\n');
|
||||
a
|
||||
});
|
||||
let final_classes = folded_classes.trim_end();
|
||||
|
||||
if changed {
|
||||
if final_classes.is_empty() {
|
||||
return Some(AttributeAction::Remove(attr.to_owned()));
|
||||
} else {
|
||||
return Some(AttributeAction::ReplaceValue(
|
||||
attr.to_owned(),
|
||||
final_classes.to_owned().into(),
|
||||
));
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
None
|
||||
})
|
||||
.collect();
|
||||
|
||||
for action in actions {
|
||||
match action {
|
||||
AttributeAction::ReplaceValue(attr, value) => {
|
||||
if let Some(mut attr) = attrs.take(&attr) {
|
||||
attr.value = value;
|
||||
attrs.insert(attr);
|
||||
}
|
||||
}
|
||||
AttributeAction::Remove(attr) => {
|
||||
attrs.remove(&attr);
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/// The possible actions to apply to an element node.
|
||||
#[derive(Debug, PartialEq, Eq)]
|
||||
enum NodeAction {
|
||||
/// Don't do anything.
|
||||
None,
|
||||
|
||||
/// Remove the element but keep its children.
|
||||
Ignore,
|
||||
|
||||
/// Remove the element and its children.
|
||||
Remove,
|
||||
}
|
||||
|
||||
/// The possible actions to apply to an attribute.
|
||||
#[derive(Debug)]
|
||||
enum AttributeAction {
|
||||
/// Replace the value of the attribute.
|
||||
ReplaceValue(Attribute, StrTendril),
|
||||
|
||||
/// Remove the attribute.
|
||||
Remove(Attribute),
|
||||
}
|
||||
|
||||
/// List of HTML tags allowed in the Matrix specification, without the rich reply fallback tag.
|
||||
static ALLOWED_TAGS_WITHOUT_REPLY_STRICT: Set<&str> = phf_set! {
|
||||
"font", "del", "h1", "h2", "h3", "h4", "h5", "h6", "blockquote", "p", "a",
|
||||
"ul", "ol", "sup", "sub", "li", "b", "i", "u", "strong", "em", "strike",
|
||||
"code", "hr", "br", "div", "table", "thead", "tbody", "tr", "th", "td",
|
||||
"caption", "pre", "span", "img", "details", "summary",
|
||||
};
|
||||
|
||||
/// The HTML tag name for a rich reply fallback.
|
||||
const RICH_REPLY_TAG: &str = "mx-reply";
|
||||
|
||||
/// Allowed attributes per HTML tag according to the Matrix specification.
|
||||
static ALLOWED_ATTRIBUTES_STRICT: Map<&str, &Set<&str>> = phf_map! {
|
||||
"font" => &ALLOWED_ATTRIBUTES_FONT_STRICT,
|
||||
"span" => &ALLOWED_ATTRIBUTES_SPAN_STRICT,
|
||||
"a" => &ALLOWED_ATTRIBUTES_A_STRICT,
|
||||
"img" => &ALLOWED_ATTRIBUTES_IMG_STRICT,
|
||||
"ol" => &ALLOWED_ATTRIBUTES_OL_STRICT,
|
||||
"code" => &ALLOWED_ATTRIBUTES_CODE_STRICT,
|
||||
};
|
||||
static ALLOWED_ATTRIBUTES_FONT_STRICT: Set<&str> =
|
||||
phf_set! { "data-mx-bg-color", "data-mx-color", "color" };
|
||||
static ALLOWED_ATTRIBUTES_SPAN_STRICT: Set<&str> =
|
||||
phf_set! { "data-mx-bg-color", "data-mx-color", "data-mx-spoiler" };
|
||||
static ALLOWED_ATTRIBUTES_A_STRICT: Set<&str> = phf_set! { "name", "target", "href" };
|
||||
static ALLOWED_ATTRIBUTES_IMG_STRICT: Set<&str> =
|
||||
phf_set! { "width", "height", "alt", "title", "src" };
|
||||
static ALLOWED_ATTRIBUTES_OL_STRICT: Set<&str> = phf_set! { "start" };
|
||||
static ALLOWED_ATTRIBUTES_CODE_STRICT: Set<&str> = phf_set! { "class" };
|
||||
|
||||
/// Allowed schemes of URIs per HTML tag and attribute tuple according to the Matrix specification.
|
||||
static ALLOWED_SCHEMES_STRICT: Map<&str, &Set<&str>> = phf_map! {
|
||||
"a:href" => &ALLOWED_SCHEMES_A_HREF_STRICT,
|
||||
"img:src" => &ALLOWED_SCHEMES_IMG_SRC_STRICT,
|
||||
};
|
||||
static ALLOWED_SCHEMES_A_HREF_STRICT: Set<&str> =
|
||||
phf_set! { "http", "https", "ftp", "mailto", "magnet" };
|
||||
static ALLOWED_SCHEMES_IMG_SRC_STRICT: Set<&str> = phf_set! { "mxc" };
|
||||
|
||||
/// Extra allowed schemes of URIs per HTML tag and attribute tuple.
|
||||
///
|
||||
/// This is a convenience list to add schemes that can be encountered but are not listed in the
|
||||
/// Matrix specification. It consists of:
|
||||
///
|
||||
/// * The `matrix` scheme for `a` tags (see [matrix-org/matrix-spec#1108]).
|
||||
///
|
||||
/// To get a complete list, add these to `ALLOWED_SCHEMES_STRICT`.
|
||||
///
|
||||
/// [matrix-org/matrix-spec#1108]: https://github.com/matrix-org/matrix-spec/issues/1108
|
||||
static ALLOWED_SCHEMES_COMPAT: Map<&str, &Set<&str>> = phf_map! {
|
||||
"a:href" => &ALLOWED_SCHEMES_A_HREF_COMPAT,
|
||||
"img:src" => &ALLOWED_SCHEMES_IMG_SRC_STRICT,
|
||||
};
|
||||
static ALLOWED_SCHEMES_A_HREF_COMPAT: Set<&str> =
|
||||
phf_set! { "http", "https", "ftp", "mailto", "magnet", "matrix" };
|
||||
|
||||
/// Allowed classes per HTML tag according to the Matrix specification.
|
||||
static ALLOWED_CLASSES_STRICT: Map<&str, &Set<&str>> =
|
||||
phf_map! { "code" => &ALLOWED_CLASSES_CODE_STRICT };
|
||||
static ALLOWED_CLASSES_CODE_STRICT: Set<&str> = phf_set! { "language-*" };
|
||||
|
||||
/// Max depth of nested HTML tags allowed by the Matrix specification.
|
||||
const MAX_DEPTH_STRICT: u32 = 100;
|
93
crates/ruma-html/tests/it/helpers.rs
Normal file
93
crates/ruma-html/tests/it/helpers.rs
Normal file
@ -0,0 +1,93 @@
|
||||
use ruma_html::{
|
||||
remove_html_reply_fallback, sanitize_html, HtmlSanitizerMode, RemoveReplyFallback,
|
||||
};
|
||||
|
||||
#[test]
|
||||
fn sanitize() {
|
||||
let sanitized = sanitize_html(
|
||||
"\
|
||||
<mx-reply>\
|
||||
<blockquote>\
|
||||
<a href=\"https://matrix.to/#/!n8f893n9:example.com/$1598361704261elfgc:localhost\">In reply to</a> \
|
||||
<a href=\"https://matrix.to/#/@alice:example.com\">@alice:example.com</a>\
|
||||
<br>\
|
||||
Previous message\
|
||||
</blockquote>\
|
||||
</mx-reply>\
|
||||
<removed>This has no tag</removed>\
|
||||
<p>But this is inside a tag</p>\
|
||||
",
|
||||
HtmlSanitizerMode::Strict,
|
||||
RemoveReplyFallback::No,
|
||||
);
|
||||
|
||||
assert_eq!(
|
||||
sanitized,
|
||||
"\
|
||||
<mx-reply>\
|
||||
<blockquote>\
|
||||
<a href=\"https://matrix.to/#/!n8f893n9:example.com/$1598361704261elfgc:localhost\">In reply to</a> \
|
||||
<a href=\"https://matrix.to/#/@alice:example.com\">@alice:example.com</a>\
|
||||
<br>\
|
||||
Previous message\
|
||||
</blockquote>\
|
||||
</mx-reply>\
|
||||
This has no tag\
|
||||
<p>But this is inside a tag</p>\
|
||||
"
|
||||
);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn sanitize_without_reply() {
|
||||
let sanitized = sanitize_html(
|
||||
"\
|
||||
<mx-reply>\
|
||||
<blockquote>\
|
||||
<a href=\"https://matrix.to/#/!n8f893n9:example.com/$1598361704261elfgc:localhost\">In reply to</a> \
|
||||
<a href=\"https://matrix.to/#/@alice:example.com\">@alice:example.com</a>\
|
||||
<br>\
|
||||
Previous message\
|
||||
</blockquote>\
|
||||
</mx-reply>\
|
||||
<removed>This has no tag</removed>\
|
||||
<p>But this is inside a tag</p>\
|
||||
",
|
||||
HtmlSanitizerMode::Strict,
|
||||
RemoveReplyFallback::Yes,
|
||||
);
|
||||
|
||||
assert_eq!(
|
||||
sanitized,
|
||||
"\
|
||||
This has no tag\
|
||||
<p>But this is inside a tag</p>\
|
||||
"
|
||||
);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn remove_html_reply() {
|
||||
let without_reply = remove_html_reply_fallback(
|
||||
"\
|
||||
<mx-reply>\
|
||||
<blockquote>\
|
||||
<a href=\"https://matrix.to/#/!n8f893n9:example.com/$1598361704261elfgc:localhost\">In reply to</a> \
|
||||
<a href=\"https://matrix.to/#/@alice:example.com\">@alice:example.com</a>\
|
||||
<br>\
|
||||
Previous message\
|
||||
</blockquote>\
|
||||
</mx-reply>\
|
||||
<keep-me>This keeps its tag</keep-me>\
|
||||
<p>But this is inside a tag</p>\
|
||||
",
|
||||
);
|
||||
|
||||
assert_eq!(
|
||||
without_reply,
|
||||
"\
|
||||
<keep-me>This keeps its tag</keep-me>\
|
||||
<p>But this is inside a tag</p>\
|
||||
"
|
||||
);
|
||||
}
|
1
crates/ruma-html/tests/it/html.rs
Normal file
1
crates/ruma-html/tests/it/html.rs
Normal file
@ -0,0 +1 @@
|
||||
mod sanitize;
|
248
crates/ruma-html/tests/it/html/sanitize.rs
Normal file
248
crates/ruma-html/tests/it/html/sanitize.rs
Normal file
@ -0,0 +1,248 @@
|
||||
use ruma_html::{Html, SanitizerConfig};
|
||||
|
||||
#[test]
|
||||
fn valid_input() {
|
||||
let config = SanitizerConfig::strict().remove_reply_fallback();
|
||||
let mut html = Html::parse(
|
||||
"\
|
||||
<ul><li>This</li><li>has</li><li>no</li><li>tag</li></ul>\
|
||||
<p>This is a paragraph <span data-mx-color=\"green\">with some color</span></p>\
|
||||
<img src=\"mxc://notareal.hs/abcdef\">\
|
||||
<code class=\"language-html\"><mx-reply>This is a fake reply</mx-reply></code>\
|
||||
",
|
||||
);
|
||||
html.sanitize_with(config);
|
||||
|
||||
assert_eq!(
|
||||
html.to_string(),
|
||||
"\
|
||||
<ul><li>This</li><li>has</li><li>no</li><li>tag</li></ul>\
|
||||
<p>This is a paragraph <span data-mx-color=\"green\">with some color</span></p>\
|
||||
<img src=\"mxc://notareal.hs/abcdef\">\
|
||||
<code class=\"language-html\"><mx-reply>This is a fake reply</mx-reply></code>\
|
||||
"
|
||||
);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn tags_remove() {
|
||||
let config = SanitizerConfig::strict();
|
||||
let mut html = Html::parse(
|
||||
"\
|
||||
<mx-reply>\
|
||||
<blockquote>\
|
||||
<a href=\"https://matrix.to/#/!n8f893n9:example.com/$1598361704261elfgc:localhost\">In reply to</a> \
|
||||
<a href=\"https://matrix.to/#/@alice:example.com\">@alice:example.com</a>\
|
||||
<br>\
|
||||
Previous message\
|
||||
</blockquote>\
|
||||
</mx-reply>\
|
||||
<removed>This has no tag</removed>\
|
||||
<p>But this is inside a tag</p>\
|
||||
",
|
||||
);
|
||||
html.sanitize_with(config);
|
||||
|
||||
assert_eq!(
|
||||
html.to_string(),
|
||||
"\
|
||||
<mx-reply>\
|
||||
<blockquote>\
|
||||
<a href=\"https://matrix.to/#/!n8f893n9:example.com/$1598361704261elfgc:localhost\">In reply to</a> \
|
||||
<a href=\"https://matrix.to/#/@alice:example.com\">@alice:example.com</a>\
|
||||
<br>\
|
||||
Previous message\
|
||||
</blockquote>\
|
||||
</mx-reply>\
|
||||
This has no tag\
|
||||
<p>But this is inside a tag</p>\
|
||||
"
|
||||
);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn tags_remove_without_reply() {
|
||||
let config = SanitizerConfig::strict().remove_reply_fallback();
|
||||
let mut html = Html::parse(
|
||||
"\
|
||||
<mx-reply>\
|
||||
<blockquote>\
|
||||
<a href=\"https://matrix.to/#/!n8f893n9:example.com/$1598361704261elfgc:localhost\">In reply to</a> \
|
||||
<a href=\"https://matrix.to/#/@alice:example.com\">@alice:example.com</a>\
|
||||
<br>\
|
||||
Previous message\
|
||||
</blockquote>\
|
||||
</mx-reply>\
|
||||
<removed>This has no tag</removed>\
|
||||
<p>But this is inside a tag</p>\
|
||||
",
|
||||
);
|
||||
html.sanitize_with(config);
|
||||
|
||||
assert_eq!(
|
||||
html.to_string(),
|
||||
"\
|
||||
This has no tag\
|
||||
<p>But this is inside a tag</p>\
|
||||
"
|
||||
);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn tags_remove_only_reply_fallback() {
|
||||
let config = SanitizerConfig::new().remove_reply_fallback();
|
||||
let mut html = Html::parse(
|
||||
"\
|
||||
<mx-reply>\
|
||||
<blockquote>\
|
||||
<a href=\"https://matrix.to/#/!n8f893n9:example.com/$1598361704261elfgc:localhost\">In reply to</a> \
|
||||
<a href=\"https://matrix.to/#/@alice:example.com\">@alice:example.com</a>\
|
||||
<br>\
|
||||
Previous message\
|
||||
</blockquote>\
|
||||
</mx-reply>\
|
||||
<keep-me>This keeps its tag</keep-me>\
|
||||
<p>But this is inside a tag</p>\
|
||||
",
|
||||
);
|
||||
html.sanitize_with(config);
|
||||
|
||||
assert_eq!(
|
||||
html.to_string(),
|
||||
"\
|
||||
<keep-me>This keeps its tag</keep-me>\
|
||||
<p>But this is inside a tag</p>\
|
||||
"
|
||||
);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn attrs_remove() {
|
||||
let config = SanitizerConfig::strict();
|
||||
let mut html = Html::parse(
|
||||
"\
|
||||
<h1 id=\"anchor1\">Title for important stuff</h1>\
|
||||
<p class=\"important\">Look at <font color=\"blue\" size=20>me!</font></p>\
|
||||
",
|
||||
);
|
||||
html.sanitize_with(config);
|
||||
|
||||
assert_eq!(
|
||||
html.to_string(),
|
||||
"\
|
||||
<h1>Title for important stuff</h1>\
|
||||
<p>Look at <font color=\"blue\">me!</font></p>\
|
||||
"
|
||||
);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn img_remove_scheme() {
|
||||
let config = SanitizerConfig::strict();
|
||||
let mut html = Html::parse(
|
||||
"\
|
||||
<p>Look at that picture:</p>\
|
||||
<img src=\"https://notareal.hs/abcdef\">\
|
||||
",
|
||||
);
|
||||
html.sanitize_with(config);
|
||||
|
||||
assert_eq!(html.to_string(), "<p>Look at that picture:</p>");
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn link_remove_scheme() {
|
||||
let config = SanitizerConfig::strict();
|
||||
let mut html = Html::parse(
|
||||
"\
|
||||
<p>Go see <a href=\"file://local/file.html\">my local website</a></p>\
|
||||
",
|
||||
);
|
||||
html.sanitize_with(config);
|
||||
|
||||
assert_eq!(
|
||||
html.to_string(),
|
||||
"\
|
||||
<p>Go see my local website</p>\
|
||||
"
|
||||
);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn link_compat_scheme() {
|
||||
let config = SanitizerConfig::strict();
|
||||
let mut html = Html::parse(
|
||||
"\
|
||||
<p>Join <a href=\"matrix:r/myroom:notareal.hs\">my room</a></p>\
|
||||
<p>To talk about <a href=\"https://mycat.org\">my cat</a></p>\
|
||||
",
|
||||
);
|
||||
html.sanitize_with(config);
|
||||
assert_eq!(
|
||||
html.to_string(),
|
||||
"\
|
||||
<p>Join my room</p>\
|
||||
<p>To talk about <a href=\"https://mycat.org\">my cat</a></p>\
|
||||
"
|
||||
);
|
||||
|
||||
let config = SanitizerConfig::compat();
|
||||
let mut html = Html::parse(
|
||||
"\
|
||||
<p>Join <a href=\"matrix:r/myroom:notareal.hs\">my room</a></p>\
|
||||
<p>To talk about <a href=\"https://mycat.org\">my cat</a></p>\
|
||||
",
|
||||
);
|
||||
html.sanitize_with(config);
|
||||
assert_eq!(
|
||||
html.to_string(),
|
||||
"\
|
||||
<p>Join <a href=\"matrix:r/myroom:notareal.hs\">my room</a></p>\
|
||||
<p>To talk about <a href=\"https://mycat.org\">my cat</a></p>\
|
||||
"
|
||||
);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn class_remove() {
|
||||
let config = SanitizerConfig::strict();
|
||||
let mut html = Html::parse(
|
||||
"\
|
||||
<pre><code class=\"language-rust custom-class\">
|
||||
type StringList = Vec<String>;
|
||||
</code></pre>\
|
||||
<p>What do you think of the name <code class=\"fake-language-rust\">StringList</code>?</p>\
|
||||
",
|
||||
);
|
||||
html.sanitize_with(config);
|
||||
|
||||
assert_eq!(
|
||||
html.to_string(),
|
||||
"\
|
||||
<pre><code class=\"language-rust\">
|
||||
type StringList = Vec<String>;
|
||||
</code></pre>\
|
||||
<p>What do you think of the name <code>StringList</code>?</p>\
|
||||
"
|
||||
);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn depth_remove() {
|
||||
let config = SanitizerConfig::strict();
|
||||
let deeply_nested_html: String = std::iter::repeat("<div>")
|
||||
.take(100)
|
||||
.chain(Some(
|
||||
"<span>I am in too deep!</span>\
|
||||
I should be fine.",
|
||||
))
|
||||
.chain(std::iter::repeat("</div>").take(100))
|
||||
.collect();
|
||||
|
||||
let mut html = Html::parse(&deeply_nested_html);
|
||||
html.sanitize_with(config);
|
||||
|
||||
let res = html.to_string();
|
||||
assert!(res.contains("I should be fine."));
|
||||
assert!(!res.contains("I am in too deep!"));
|
||||
}
|
2
crates/ruma-html/tests/it/main.rs
Normal file
2
crates/ruma-html/tests/it/main.rs
Normal file
@ -0,0 +1,2 @@
|
||||
mod helpers;
|
||||
mod html;
|
Loading…
x
Reference in New Issue
Block a user