Release 4.10.0
[htmlpurifier-web.git] / index.xhtml
blob15617bbe703451233d5bc68460a259d14b29e332
1 <?xml version="1.0" encoding="UTF-8"?>
2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
3 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
4 <html
5 xmlns="http://www.w3.org/1999/xhtml"
6 xmlns:xi="http://www.w3.org/2001/XInclude"
7 xmlns:xc="urn:xhtml-compiler"
8 xmlns:news="urn:xhtml-compiler:News"
9 xc:rss-from-git="yes"
10 xml:lang="en">
11 <head>
12 <title>HTML Purifier - Filter your HTML the standards-compliant way!</title>
13 <xi:include href="common-meta.xml" xpointer="xpointer(/*/node())" />
14 <meta name="description"
15 content="HTML filter that guards against XSS and ensures standards-compliant output." />
16 <meta name="keywords"
17 content="HTMLPurifier, HTML Purifier, HTML, filter, filtering, standards, compliant, w3c, XSS, PHP, security, library, open source, LGPL, whitelist" />
18 <!-- See news.xhtml for definition -->
19 <link rel="alternate" type="application/rss+xml" title="News - HTML Purifier" href="news.rss" />
20 <script defer="defer" type="text/javascript" src="del.icio.us.js" xc:absolute="src"></script>
21 <!-- OpenID for Edward Z. Yang -->
22 <link rel="openid.server" href="https://pip.verisignlabs.com/server" />
23 <link rel="openid.delegate" href="http://edwardzyang.pip.verisignlabs.com/" />
24 <!-- Google OpenSearch -->
25 <link rel="search" href="opensearchdescription.xml"
26 type="application/opensearchdescription+xml"
27 title="HTML Purifier" />
28 </head>
29 <body>
31 <div id="branding">
32 <h1>
33 <span class="html">HTML</span>
34 <span class="purifier">Purifier</span>
35 </h1>
36 <blockquote>
37 <p>
38 Standards-Compliant HTML Filtering
39 </p>
40 </blockquote>
41 </div>
43 <xi:include href="common-navigation.xml" xpointer="xpointer(/*/node())" />
45 <div id="main">
46 <div id="content">
48 <div id="summary">
49 <h2>Summary</h2>
50 <div id="summary-safe">
51 <h3>Safe</h3>
52 <p>
53 HTML Purifier defeats XSS with an audited whitelist
54 </p>
55 </div>
56 <div id="summary-clean">
57 <h3>Clean</h3>
58 <p>
59 HTML Purifier ensures standards-compliant output
60 </p>
61 </div>
62 <div id="summary-open">
63 <h3>Open</h3>
64 <p>
65 HTML Purifier is open-source and highly customizable
66 </p>
67 </div>
68 </div>
70 <div id="intro">
71 <p><strong>HTML Purifier</strong> is a standards-compliant
72 <abbr>HTML</abbr> filter library written in
73 <abbr>PHP</abbr>. HTML Purifier will not only remove all malicious
74 code (better known as <abbr>XSS</abbr>) with a thoroughly audited,
75 secure <em>yet</em> permissive <strong><a
76 href="live/smoketests/printDefinition.php">whitelist</a></strong>,
77 it will also make sure your documents are
78 <strong>standards compliant</strong>, something only achievable with a
79 comprehensive knowledge of <abbr>W3C</abbr>'s specifications.
80 Tired of using BBCode due to the current landscape of deficient or
81 insecure <abbr>HTML</abbr> filters? Have a
82 <strong><acronym>WYSIWYG</acronym></strong> editor but never been able to use it? Looking
83 for high-quality, standards-compliant, open-source components for that
84 application you're building? HTML Purifier is for you!</p>
86 <blockquote class="fancy">
87 <div class="quote">
88 I'd just like to say we use HTML Purifier in <a href="http://www.iris.ac/">IRIS</a> for
89 filtering emails against XSS attacks and we've been more than impressed.
90 </div>
91 <div class="origin">&mdash; Chris Corbyn, <em>Senior IRIS Developer</em></div>
92 </blockquote>
94 <xi:include href="download-box.xml" xpointer="xpointer(/*/node())" />
96 </div>
98 <div class="clear">
100 <div id="BackgroundContainer">
101 <h2 id="Background">Background</h2>
103 <p>There are a number of open-source <abbr>HTML</abbr> filtering solutions out
104 there on the web already. What sets HTML Purifier apart from them?
105 Aren't all of these choices <q>secure</q>?</p>
107 <p>When it comes to <abbr>HTML</abbr>, <strong>attention to
108 detail</strong> is key. Does it perform its filtering off a
109 whitelist rather than an out-of-date blacklist? Does it filter every
110 attribute in the document? Does it actually understand <abbr>HTML</abbr>?</p>
112 <p><strong>Know thy enemy.</strong> Hackers have a huge arsenal of
113 <abbr>XSS</abbr> vectors hidden within the depths of the
114 <abbr>HTML</abbr> specification. HTML Purifier is
115 effective because it decomposes the whole document
116 into tokens and removing
117 non-whitelisted elements, checking the well-formedness and nesting of tags, and
118 validating all attributes according to their <abbr>RFC</abbr>s.
119 HTML Purifier's comprehensive algorithms are complemented by a
120 <strong>breadth of knowledge</strong>, ensuring that richly formatted
121 documents pass through unstripped.</p>
123 <p>To my knowledge, there is nothing else in the wild that offers
124 protection from <abbr>XSS</abbr>, standards-compliance, and
125 corrective processing of poorly formed <abbr>HTML</abbr>. HTML
126 Purifier is not perfect; it can interact poorly with existing
127 JavaScript on websites, which can introduces vulnerabilities after the
128 fact. However, it is pretty damn good.
129 Do your research and try out the <a href="demo.php">demo</a>.</p>
131 <p>To find out more, you can read the
132 <a href="comparison"><strong>Comparison</strong></a>
133 for a analysis of HTML Purifier and the other major filters. Or you
134 can chat with other HTML Purifier users on our
135 <a href="http://groups.google.com/group/htmlpurifier">mailing
136 list</a> and our <a href="phorum">forum</a>.</p>
138 <blockquote class="fancy">
139 <div class="quote">
140 [Y]ou save my day by allowing me not to write another damned HTML parser.
141 </div>
142 <div class="origin">
143 &mdash; Joseph Halter, <em>Technical Director at Akira Web</em>
144 </div>
145 </blockquote>
146 </div>
148 <div id="NewsContainer">
149 <h2 id="News">Recent News</h2>
151 <div class="news" news:source="news" news:limit="1" news:header="h3" />
154 <a href="news">Read earlier news...</a>
155 </p>
156 </div>
158 </div>
160 <div class="clear"></div>
162 <h2 id="Ports">Ports</h2>
164 <p>HTML Purifier has been <a href="https://github.com/Mynigma/HTMLPurifier">partially ported to Objective C</a> by Roman Priebe and Lukas Neumann.</p>
166 <h2 id="Plugins">Plugins</h2>
168 <p>HTML Purifier is a great library to integrate with existing
169 <abbr>CMS</abbr>es and other applications or <acronym>WYSIWYG</acronym>
170 editors. Currently, we have plugins for these applications:</p>
172 <ul>
173 <li><a href="http://www.phorum.org/phorum5/read.php?62,127035">Phorum</a> (in use at our very own forums!)</li>
174 <li><a href="http://htmlpurifier.org/dev/plugins/modx.txt">MODx</a></li>
175 <li><a href="http://bart.motd.be/projects/html-purifier-drupal-module">Drupal</a> by Bart Jansens</li>
176 <li><a href="http://urbangiraffe.com/plugins/html-purified/">Wordpress and bbPress</a> by John Godley</li>
177 <li><a href="http://extensions.joomla.org/component/option,com_mtree/task,viewlink/link_id,4094/Itemid,35/">Joomla</a> by Double D</li>
178 <li><a href="https://github.com/refringe/codeigniter-htmlpurifier">CodeIgniter</a> by Tyler Brownell (there is also an older plugin <a href="http://mindloop.be/htmlpurifier-and-the-codeigniter-framework/">CodeIgniter</a> by Andy Mathijs)</li>
179 <li><a href="http://www.symfony-project.org/plugins/sfXssSafePlugin">Symfony</a> by Alexandre Mogère</li>
180 <li><a href="http://github.com/josegonzalez/purifiable">CakePHP</a> by Jose Diaz-Gonzalez</li>
181 <li><a href="http://nemesisdesign.net/blog/coding/html-purifier-plugin-joomla/">Joomla</a> by Federico Capoano</li>
182 <li><a href="https://github.com/harikt/li3_htmlpurifier">Lithium</a> by Hari K T</li>
183 <li><a href="http://community.elgg.org/pg/plugins/project/725191/developer/ewinslow/html-purifier-for-elgg-18">Elgg</a> by Evan Winslow</li>
184 <li><a href="http://addons.silverstripe.org/add-ons/zirak/htmlpurifier">SilverStripe CMS</a> by Gabriele Brosulo</li>
185 </ul>
188 HTML Purifier is also now in print! Martin Brampton's new book
189 <a href="http://packt.aliro.org/">PHP 5 CMS Framework Development</a>
190 includes a discussion of using HTML Purifier in your content management
191 system. Go check it out!
192 </p>
195 <strong>Notice:</strong>
196 Any plugin provided by a third party has not been vetted by us: use
197 them at your own risk. If you are having a problem with the plugin,
198 please consult the plugin author before asking for help here (we'll
199 be more than happy to help, but it might be a problem with the
200 plugin rather than HTML Purifier.)
201 </p>
203 <blockquote class="fancy">
204 <div class="quote">
205 This plugin is on top of my favorite list[.] I am going to heavily
206 depend on it since my clients insist on having <acronym>WYSIWYG</acronym> and I insist on
207 having pages that validate and are semantically sound.
208 </div>
209 <div class="origin">
210 &mdash; David Molliere, <em>MODx Marketing &amp; Design Team</em>
211 </div>
212 </blockquote>
214 <p>Plugins for other major applications gladly accepted!</p>
217 <h2 id="Propaganda">Spread the Word!</h2>
219 <p>Help spread awareness about HTML Purifier by:</p>
221 <ul>
222 <li><a
223 href="http://del.icio.us/post?v=4&amp;noui&amp;url=http://htmlpurifier.org/&amp;title=HTML%20Purifier%20-%20Filter%20your%20HTML%20the%20standards-compliant%20way!"
224 id="delicious">Bookmarking this website</a> on your <strong>del.icio.us</strong> account, and/or</li>
225 <li>
226 <div>Including this little <strong>label</strong> on your website:
227 <a href="http://htmlpurifier.org/"><img
228 src="live/art/powered.png"
229 alt="Powered by HTML Purifier" border="0" /></a>, with this code:
230 </div>
231 <pre class="long">&lt;a href=&quot;http://htmlpurifier.org/&quot;&gt;&lt;img
232 src=&quot;http://htmlpurifier.org/live/art/powered.png&quot;
233 alt=&quot;Powered by HTML Purifier&quot; border=&quot;0&quot; /&gt;&lt;/a&gt;</pre>
234 </li>
235 </ul>
237 </div>
238 </div>
240 </body>
241 </html>