* Allow simple alphanumeric style attribute values in the htmlscrubber. This
[ikiwiki.git] / doc / plugins / htmlscrubber.mdwn
1 [[template id=plugin name=htmlscrubber core=1 author="[[Joey]]"]]
2 [[tag type/html]]
3
4 This plugin is enabled by default. It sanitizes the html on pages it renders
5 to avoid XSS attacks and the like.
6
7 It excludes all html tags and attributes except for those that are
8 whitelisted using the same lists as used by Mark Pilgrim's Universal Feed
9 Parser, documented at <http://feedparser.org/docs/html-sanitization.html>.
10 Notably it strips `style` and `link`.
11
12 For the `style` attribute, it varys slightly from the Universal Feed
13 Parser, accepting simple alphanumeric style attributes (style="foo"), but
14 stripping anything more complex to avoid any of the ways to insert
15 JavaScript via style attributes.
16
17 It uses the [[cpan HTML::Scrubber]] perl module to perform its html
18 sanitisation, and this perl module also deals with various entity encoding
19 tricks.
20
21 While I believe that this makes ikiwiki as resistant to malicious html
22 content as anything else on the web, I cannot guarantee that it will
23 actually protect every user of every browser from every browser security
24 hole, badly designed feature, etc. I can provide NO WARRANTY, like it says
25 in ikiwiki's [[GPL]] license. 
26
27 The web's security model is *fundamentally broken*; ikiwiki's html
28 sanitisation is only a patch on the underlying gaping hole that is your web
29 browser.
30
31 Note that enabling or disabling the htmlscrubber plugin also affects some other
32 HTML-related functionality, such as whether [[meta]] allows potentially unsafe
33 HTML tags.
34
35 ----
36
37 Some examples of embedded javascript that won't be let through when this
38 plugin is active:
39
40 * script tag test <script>window.location='http://example.org';</script>
41 * <span style="background: url(javascript:window.location='http://example.org/')">CSS script test</span>
42 * <span style="&#x61;&#x6e;&#x79;&#x3a;&#x20;&#x65;&#x78;&#x70;&#x72;&#x65;&#x73;&#x73;&#x69;&#x6f;&#x6e;&#x28;&#x77;&#x69;&#x6e;&#x64;&#x6f;&#x77;&#x2e;&#x6c;&#x6f;&#x63;&#x61;&#x74;&#x69;&#x6f;&#x6e;&#x3d;&#x27;&#x68;&#x74;&#x74;&#x70;&#x3a;&#x2f;&#x2f;&#x65;&#x78;&#x61;&#x6d;&#x70;&#x6c;&#x65;&#x2e;&#x6f;&#x72;&#x67;&#x2f;&#x27;&#x29;">entity-encoded CSS script test</span>
43 * <span style="&#97;&#110;&#121;&#58;&#32;&#101;&#120;&#112;&#114;&#101;&#115;&#115;&#105;&#111;&#110;&#40;&#119;&#105;&#110;&#100;&#111;&#119;&#46;&#108;&#111;&#99;&#97;&#116;&#105;&#111;&#110;&#61;&#39;&#104;&#116;&#116;&#112;&#58;&#47;&#47;&#101;&#120;&#97;&#109;&#112;&#108;&#101;&#46;&#111;&#114;&#103;&#47;&#39;&#41;">entity-encoded CSS script test</span>
44 * <span style="pretty">OTOH, this is ok, and will be accepted</a>