1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
//! # HTML Purifier
//!
//! HTML Purifier is a standard HTML filter library.
//!
//! > HTML Purifier will not only remove all malicious code (better known as XSS) with a thoroughly audited, secure yet permissive whitelist, it will also make sure your documents are standards compliant, something only achievable with a comprehensive knowledge of W3C's specifications. [HTML Purifier](http://htmlpurifier.org)
//!
//! ## Example
//!
//! ```
//! use html_purifier::{purifier, Settings};
//!
//! let settings = Settings {
//!     ..Settings::default()
//! };
//! let input = r#"<a href="/test" style="color: black;"><img src="/logo.png" onerror="javascript:;"/>Rust</a>"#;
//! let output = purifier(input, settings);
//! ```
//!
//! Input HTML
//!
//! ```notrust
//! <a href="/test" style="color: black;"
//!   ><img src="/logo.png" onerror="javascript:;" />Rust</a
//! >
//! ```
//!
//! Output HTML
//!
//! ```notrust
//! <a href="/test"><img src="/logo.png" />Rust</a>
//! ```

use lol_html::html_content::{Comment, Element};
use lol_html::{comments, element, rewrite_str, RewriteStrSettings};

pub struct AllowedElement {
    pub name: String,
    pub attributes: Vec<String>,
}

pub struct Settings {
    pub allowed: Vec<AllowedElement>,
    pub remove_comments: bool,
}

impl Default for Settings {
    #[inline]
    fn default() -> Self {
        Settings {
            allowed: vec![
                AllowedElement {
                    name: "div".to_string(),
                    attributes: vec![],
                },
                AllowedElement {
                    name: "b".to_string(),
                    attributes: vec![],
                },
                AllowedElement {
                    name: "strong".to_string(),
                    attributes: vec![],
                },
                AllowedElement {
                    name: "i".to_string(),
                    attributes: vec![],
                },
                AllowedElement {
                    name: "em".to_string(),
                    attributes: vec![],
                },
                AllowedElement {
                    name: "u".to_string(),
                    attributes: vec![],
                },
                AllowedElement {
                    name: "a".to_string(),
                    attributes: vec!["href".to_string(), "title".to_string()],
                },
                AllowedElement {
                    name: "ul".to_string(),
                    attributes: vec![],
                },
                AllowedElement {
                    name: "ol".to_string(),
                    attributes: vec![],
                },
                AllowedElement {
                    name: "li".to_string(),
                    attributes: vec![],
                },
                AllowedElement {
                    name: "p".to_string(),
                    attributes: vec!["style".to_string()],
                },
                AllowedElement {
                    name: "br".to_string(),
                    attributes: vec![],
                },
                AllowedElement {
                    name: "span".to_string(),
                    attributes: vec!["style".to_string()],
                },
                AllowedElement {
                    name: "img".to_string(),
                    attributes: vec![
                        "width".to_string(),
                        "height".to_string(),
                        "alt".to_string(),
                        "src".to_string(),
                    ],
                },
            ],
            remove_comments: true,
        }
    }
}

/// HTML Purifier
///
/// # Example
///
/// ```
/// use html_purifier::{purifier, Settings};
///
/// let settings = Settings {
///     ..Settings::default()
/// };
/// let input = r#"<a href="/test" style="color: black;"><img src="/logo.png" onerror="javascript:;"/>Rust</a>"#;
/// let output = purifier(input, settings);
/// ```
pub fn purifier(input: &str, settings: Settings) -> String {
    let element_handler = |el: &mut Element| {
        let find = settings.allowed.iter().find(|e| e.name.eq(&el.tag_name()));
        match find {
            Some(find) => {
                let remove_attributes = el
                    .attributes()
                    .iter()
                    .filter(|e| find.attributes.iter().any(|a| a.eq(&e.name())) == false)
                    .map(|m| m.name())
                    .collect::<Vec<String>>();
                for attr in remove_attributes {
                    el.remove_attribute(&attr);
                }
            }
            None => {
                el.remove_and_keep_content();
            }
        }
        Ok(())
    };
    let comment_handler = |c: &mut Comment| {
        if settings.remove_comments {
            c.remove();
        }
        Ok(())
    };
    let output = rewrite_str(
        input,
        RewriteStrSettings {
            element_content_handlers: vec![
                element!("*", element_handler),
                comments!("*", comment_handler),
            ],
            ..RewriteStrSettings::default()
        },
    )
    .unwrap();
    return output;
}

#[cfg(test)]
mod tests {
    use super::*;
    #[test]
    fn test_purifier() {
        let settings = Settings {
            ..Settings::default()
        };
        let input = r#"<div style="display: block;"><span style="color: black;"><a href="/test" onclick="javascript:;"><img src="/logo.png" onerror="javascript:;"/>Rust</a></span></div>"#;
        let output = purifier(input, settings);
        assert_eq!(
            output,
            r#"<div><span style="color: black;"><a href="/test"><img src="/logo.png" />Rust</a></span></div>"#
        );
    }
    #[test]
    fn test_purifier_remove_comments() {
        let settings = Settings {
            ..Settings::default()
        };
        let input = r#"<div style="display: block;"><!--Comment 1--><span style="color: black;"><a href="/test" onclick="javascript:;"><img src="/logo.png" onerror="javascript:;"/>Rust</a></span></div>"#;
        let output = purifier(input, settings);
        assert_eq!(
            output,
            r#"<div><span style="color: black;"><a href="/test"><img src="/logo.png" />Rust</a></span></div>"#
        );
    }
    #[test]
    fn test_purifier_show_comments() {
        let settings = Settings {
            remove_comments: false,
            ..Settings::default()
        };
        let input = r#"<div style="display: block;"><span style="color: black;"><!--Comment 1--><a href="/test" onclick="javascript:;"><img src="/logo.png" onerror="javascript:;"/>Rust</a></span></div>"#;
        let output = purifier(input, settings);
        assert_eq!(
            output,
            r#"<div><span style="color: black;"><!--Comment 1--><a href="/test"><img src="/logo.png" />Rust</a></span></div>"#
        );
    }
}