]> git.vanrenterghem.biz Git - git.ikiwiki.info.git/blobdiff - doc/plugins/htmlscrubber.mdwn
web commit by http://mem.myopenid.com/: Add first cut at implementation
[git.ikiwiki.info.git] / doc / plugins / htmlscrubber.mdwn
index 252fcd5d24d74ff2c4ed6fc1fa2f018a5f906082..0aa0ab3c0a7ed9a17f5beb2fabf703df220a28c0 100644 (file)
@@ -1,6 +1,5 @@
-[[template id=plugin name=htmlscrubber core=1 included=1
-author="""[[Joey]]"""]]
-[[tag type/html type/core]]
+[[template id=plugin name=htmlscrubber core=1 author="[[Joey]]"]]
+[[tag type/html]]
 
 This plugin is enabled by default. It sanitizes the html on pages it renders
 to avoid XSS attacks and the like.
@@ -10,7 +9,7 @@ whitelisted using the same lists as used by Mark Pilgrim's Universal Feed
 Parser, documented at <http://feedparser.org/docs/html-sanitization.html>.
 Notably it strips `style`, `link`, and the `style` attribute.
 
-It uses the HTML::Scrubber perl module to perform its html
+It uses the [[cpan HTML::Scrubber]] perl module to perform its html
 sanitisation, and this perl module also deals with various entity encoding
 tricks.
 
@@ -18,12 +17,16 @@ While I believe that this makes ikiwiki as resistant to malicious html
 content as anything else on the web, I cannot guarantee that it will
 actually protect every user of every browser from every browser security
 hole, badly designed feature, etc. I can provide NO WARRANTY, like it says
-in ikiwiki's [GPL](GPL) license. 
+in ikiwiki's [[GPL]] license. 
 
 The web's security model is *fundamentally broken*; ikiwiki's html
 sanitisation is only a patch on the underlying gaping hole that is your web
 browser.
 
+Note that enabling or disabling the htmlscrubber plugin also affects some other
+HTML-related functionality, such as whether [[meta]] allows potentially unsafe
+HTML tags.
+
 ----
 
 Some examples of embedded javascript that won't be let through when this