forked from extern/egroupware
2104 lines
190 KiB
HTML
2104 lines
190 KiB
HTML
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
|
||
|
|
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
|
||
|
|
<head>
|
||
|
|
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||
|
|
<meta http-equiv="Content-Language" content="en" />
|
||
|
|
<meta name="description" content="htmLawed PHP software is a free, open-source, customizable HTML input purifier and filter - htmLawed_README.txt - presented with rTxt2htm, a PHP Labware utility" />
|
||
|
|
<meta name="keywords" content="htmLawed, HTM, HTML, HTML Tidy, converter, filter, formatter, purifier, sanitizer, XSS, input, PHP, software, code, script, security, cross-site scripting, hack, sanitize, remove, standards, tags, attributes, elements, htmLawed_README.txt, rTxt2htm, PHP Labware" />
|
||
|
|
<style type="text/css" media="all">
|
||
|
|
<!--/*--><![CDATA[/*><!--*/
|
||
|
|
a {text-decoration:none; color: blue;}
|
||
|
|
a:hover {color: red;}
|
||
|
|
a:visited {color: blue;}
|
||
|
|
body {margin: 0; padding: 0;}
|
||
|
|
body, div, html, p {font-family: Georgia, 'Times new roman', Times;}
|
||
|
|
code.code {font-family: 'Bitstream vera sans mono', 'Courier New', 'Courier', monospace;}
|
||
|
|
div.comment {padding: 5px; color: #999999; font-size: 80%;}
|
||
|
|
div.comment a {color: #6699cc;}
|
||
|
|
div#body {width: 70%; margin: 5px; padding: 5px;} /* holds non-toc content */
|
||
|
|
div#toc {position: fixed; top: 5px; left: 73%; z-index: 2; margin-top: 5px; margin-left: 5px; border: 1px solid gray; padding: 5px; background-color: #ededed; width: 23%; overflow: auto; max-height:94%; font-size: 90%;} /* holds content table (toc) */
|
||
|
|
div#top {font-size: 14px; margin: 5px; padding: 5px;} /* holds all content */
|
||
|
|
div.monospace {overflow: auto; font-family: 'Bitstream vera sans mono', 'Courier New', 'Courier', monospace;}
|
||
|
|
div.sub-section {padding-left: 15px;}
|
||
|
|
div.sub-sub-section {padding-left: 30px;}
|
||
|
|
h1 {font-size: 22px; margin-top: 5px; margin-bottom: 5px;}
|
||
|
|
h2 {font-size: 20px; float: left; margin-top: 15px; margin-bottom: 5px;}
|
||
|
|
h3 {font-size: 18px; float: left; margin-top: 15px; margin-bottom: 5px;}
|
||
|
|
h4 {font-size: 16px; float: left; margin-top: 15px; margin-bottom: 5px;}
|
||
|
|
hr {margin-top: 15px; margin-bottom: 5px;}
|
||
|
|
input, textarea {font-family: 'Bitstream vera sans mono', 'Courier New', 'Courier', monospace;}
|
||
|
|
p.subtle {color: gray; padding: 0; padding-top: 10px; margin: 0;}
|
||
|
|
p.subtle a, p.subtle a:visited {color: #6699cc;}
|
||
|
|
span.item-no {color: black;}
|
||
|
|
span.subtle {color: gray; margin: 0; padding:0;}
|
||
|
|
span.subtle a, span.subtle a:visited {color: #6699cc;}
|
||
|
|
span.term {font-family: 'Bitstream vera sans mono', 'Courier New', 'Courier', monospace;}
|
||
|
|
span.toc-item {color: black;}
|
||
|
|
span.totop {float: right; margin-top: 15px; margin-bottom: 5px;}
|
||
|
|
span.totop a, span.totop a:visited {color: #6699cc;}
|
||
|
|
@media screen { /* fixes for old IE */
|
||
|
|
* html, * html body {overflow-y: auto!important; height: 100%; margin: 0; padding: 0;}
|
||
|
|
* html div#body {height: 100%; overflow-y: auto; position: relative;}
|
||
|
|
* html div#toc {position: absolute;}
|
||
|
|
}
|
||
|
|
/*]]>*/-->
|
||
|
|
</style>
|
||
|
|
<title>htmLawed documentation | htmLawed PHP software is a free, open-source, customizable HTML input purifier and filter</title>
|
||
|
|
</head>
|
||
|
|
<body>
|
||
|
|
<div id="top">
|
||
|
|
<h1><a id="peak" name="peak"></a>htmLawed documentation</h1>
|
||
|
|
|
||
|
|
<div id="toc"><span class="toc-item"><a href="#s1"><span class="item-no">1</span>  About htmLawed</a></span><br />
|
||
|
|
  <span class="toc-item"><a href="#s1.1"><span class="item-no">1.1</span>  Example uses</a></span><br />
|
||
|
|
  <span class="toc-item"><a href="#s1.2"><span class="item-no">1.2</span>  Features</a></span><br />
|
||
|
|
  <span class="toc-item"><a href="#s1.3"><span class="item-no">1.3</span>  History</a></span><br />
|
||
|
|
  <span class="toc-item"><a href="#s1.4"><span class="item-no">1.4</span>  License & copyright</a></span><br />
|
||
|
|
  <span class="toc-item"><a href="#s1.5"><span class="item-no">1.5</span>  Terms used here</a></span><br />
|
||
|
|
<span class="toc-item"><a href="#s2"><span class="item-no">2</span>  Usage</a></span><br />
|
||
|
|
  <span class="toc-item"><a href="#s2.1"><span class="item-no">2.1</span>  Simple</a></span><br />
|
||
|
|
  <span class="toc-item"><a href="#s2.2"><span class="item-no">2.2</span>  Configuring htmLawed using the <span class="term">$config</span> parameter</a></span><br />
|
||
|
|
  <span class="toc-item"><a href="#s2.3"><span class="item-no">2.3</span>  Extra HTML specifications using the <span class="term">$spec</span> parameter</a></span><br />
|
||
|
|
  <span class="toc-item"><a href="#s2.4"><span class="item-no">2.4</span>  Performance time & memory usage</a></span><br />
|
||
|
|
  <span class="toc-item"><a href="#s2.5"><span class="item-no">2.5</span>  Some security risks to keep in mind</a></span><br />
|
||
|
|
  <span class="toc-item"><a href="#s2.6"><span class="item-no">2.6</span>  Use without modifying old <span class="term">kses()</span> code</a></span><br />
|
||
|
|
  <span class="toc-item"><a href="#s2.7"><span class="item-no">2.7</span>  Tolerance for ill-written HTML</a></span><br />
|
||
|
|
  <span class="toc-item"><a href="#s2.8"><span class="item-no">2.8</span>  Limitations & work-arounds</a></span><br />
|
||
|
|
  <span class="toc-item"><a href="#s2.9"><span class="item-no">2.9</span>  Examples of usage</a></span><br />
|
||
|
|
<span class="toc-item"><a href="#s3"><span class="item-no">3</span>  Details</a></span><br />
|
||
|
|
  <span class="toc-item"><a href="#s3.1"><span class="item-no">3.1</span>  Invalid/dangerous characters</a></span><br />
|
||
|
|
  <span class="toc-item"><a href="#s3.2"><span class="item-no">3.2</span>  Character references/entities</a></span><br />
|
||
|
|
  <span class="toc-item"><a href="#s3.3"><span class="item-no">3.3</span>  HTML elements</a></span><br />
|
||
|
|
    <span class="toc-item"><a href="#s3.3.1"><span class="item-no">3.3.1</span>  HTML comments and <span class="term">CDATA</span> sections</a></span><br />
|
||
|
|
    <span class="toc-item"><a href="#s3.3.2"><span class="item-no">3.3.2</span>  Tag-transformation for better XHTML-Strict</a></span><br />
|
||
|
|
    <span class="toc-item"><a href="#s3.3.3"><span class="item-no">3.3.3</span>  Tag balancing and proper nesting</a></span><br />
|
||
|
|
    <span class="toc-item"><a href="#s3.3.4"><span class="item-no">3.3.4</span>  Elements requiring child elements</a></span><br />
|
||
|
|
    <span class="toc-item"><a href="#s3.3.5"><span class="item-no">3.3.5</span>  Beautify or compact HTML</a></span><br />
|
||
|
|
  <span class="toc-item"><a href="#s3.4"><span class="item-no">3.4</span>  Attributes</a></span><br />
|
||
|
|
    <span class="toc-item"><a href="#s3.4.1"><span class="item-no">3.4.1</span>  Auto-addition of XHTML-required attributes</a></span><br />
|
||
|
|
    <span class="toc-item"><a href="#s3.4.2"><span class="item-no">3.4.2</span>  Duplicate/invalid <span class="term">id</span> values</a></span><br />
|
||
|
|
    <span class="toc-item"><a href="#s3.4.3"><span class="item-no">3.4.3</span>  URL schemes (protocols) and scripts in attribute values</a></span><br />
|
||
|
|
    <span class="toc-item"><a href="#s3.4.4"><span class="item-no">3.4.4</span>  Absolute & relative URLs</a></span><br />
|
||
|
|
    <span class="toc-item"><a href="#s3.4.5"><span class="item-no">3.4.5</span>  Lower-cased, standard attribute values</a></span><br />
|
||
|
|
    <span class="toc-item"><a href="#s3.4.6"><span class="item-no">3.4.6</span>  Transformation of deprecated attributes</a></span><br />
|
||
|
|
    <span class="toc-item"><a href="#s3.4.7"><span class="item-no">3.4.7</span>  Anti-spam & <span class="term">href</span></a></span><br />
|
||
|
|
    <span class="toc-item"><a href="#s3.4.8"><span class="item-no">3.4.8</span>  Inline style properties</a></span><br />
|
||
|
|
    <span class="toc-item"><a href="#s3.4.9"><span class="item-no">3.4.9</span>  Hook function for tag content</a></span><br />
|
||
|
|
  <span class="toc-item"><a href="#s3.5"><span class="item-no">3.5</span>  Simple configuration directive for most valid XHTML</a></span><br />
|
||
|
|
  <span class="toc-item"><a href="#s3.6"><span class="item-no">3.6</span>  Simple configuration directive for most <em>safe</em> HTML</a></span><br />
|
||
|
|
  <span class="toc-item"><a href="#s3.7"><span class="item-no">3.7</span>  Using a hook function</a></span><br />
|
||
|
|
  <span class="toc-item"><a href="#s3.8"><span class="item-no">3.8</span>  Obtaining <em>finalized</em> parameter values</a></span><br />
|
||
|
|
  <span class="toc-item"><a href="#s3.9"><span class="item-no">3.9</span>  Retaining non-HTML tags in input with mixed markup</a></span><br />
|
||
|
|
<span class="toc-item"><a href="#s4"><span class="item-no">4</span>  Other</a></span><br />
|
||
|
|
  <span class="toc-item"><a href="#s4.1"><span class="item-no">4.1</span>  Support</a></span><br />
|
||
|
|
  <span class="toc-item"><a href="#s4.2"><span class="item-no">4.2</span>  Known issues</a></span><br />
|
||
|
|
  <span class="toc-item"><a href="#s4.3"><span class="item-no">4.3</span>  Change-log</a></span><br />
|
||
|
|
  <span class="toc-item"><a href="#s4.4"><span class="item-no">4.4</span>  Testing</a></span><br />
|
||
|
|
  <span class="toc-item"><a href="#s4.5"><span class="item-no">4.5</span>  Upgrade, & old versions</a></span><br />
|
||
|
|
  <span class="toc-item"><a href="#s4.6"><span class="item-no">4.6</span>  Comparison with <span class="term">HTMLPurifier</span></a></span><br />
|
||
|
|
  <span class="toc-item"><a href="#s4.7"><span class="item-no">4.7</span>  Use through application plug-ins/modules</a></span><br />
|
||
|
|
  <span class="toc-item"><a href="#s4.8"><span class="item-no">4.8</span>  Use in non-PHP applications</a></span><br />
|
||
|
|
  <span class="toc-item"><a href="#s4.9"><span class="item-no">4.9</span>  Donate</a></span><br />
|
||
|
|
  <span class="toc-item"><a href="#s4.10"><span class="item-no">4.10</span>  Acknowledgements</a></span><br />
|
||
|
|
<span class="toc-item"><a href="#s5"><span class="item-no">5</span>  Appendices</a></span><br />
|
||
|
|
  <span class="toc-item"><a href="#s5.1"><span class="item-no">5.1</span>  Characters discouraged in HTML</a></span><br />
|
||
|
|
  <span class="toc-item"><a href="#s5.2"><span class="item-no">5.2</span>  Valid attribute-element combinations</a></span><br />
|
||
|
|
  <span class="toc-item"><a href="#s5.3"><span class="item-no">5.3</span>  CSS 2.1 properties accepting URLs</a></span><br />
|
||
|
|
  <span class="toc-item"><a href="#s5.4"><span class="item-no">5.4</span>  Microsoft Windows 1252 character replacements</a></span><br />
|
||
|
|
  <span class="toc-item"><a href="#s5.5"><span class="item-no">5.5</span>  URL format</a></span><br />
|
||
|
|
  <span class="toc-item"><a href="#s5.6"><span class="item-no">5.6</span>  Brief on htmLawed code</a></span></div><!-- ended div toc -->
|
||
|
|
|
||
|
|
<div id="body">
|
||
|
|
<br />
|
||
|
|
<div class="comment">htmLawed_README.txt, 5 April 2012<br />
|
||
|
|
htmLawed 1.1.10, 5 April 2012<br />
|
||
|
|
Copyright Santosh Patnaik<br />
|
||
|
|
Dual licensed with LGPL 3 and GPL 2 or later<br />
|
||
|
|
A PHP Labware internal utility - <a href="http://www.bioinformatics.org/phplabware/internal_utilities/htmLawed">http://www.bioinformatics.org/phplabware/internal_utilities/htmLawed</a> </div>
|
||
|
|
<br />
|
||
|
|
|
||
|
|
<div class="section"><h2>
|
||
|
|
<a name="s1" id="s1"></a><span class="item-no">1</span>  About htmLawed
|
||
|
|
</h2><span class="totop"><a href="#peak">(to top)</a></span><br style="clear: both;" />
|
||
|
|
<br />
|
||
|
|
  htmLawed is a highly customizable single-file PHP script to make text secure, and standard- and admin policy-compliant for use in the body of HTML 4, XHTML 1 or 1.1, or generic XML documents. It is thus a configurable input (X)HTML filter, processor, purifier, sanitizer, beautifier, etc., and an alternative to the <a href="http://tidy.sourceforge.net">HTMLTidy</a> application.<br />
|
||
|
|
<br />
|
||
|
|
  The <em>lawing in</em> of input text is needed to ensure that HTML code in the text is standard-compliant, does not introduce security vulnerabilities, and does not break the aesthetics, design or layout of web-pages. htmLawed tries to do this by, for example, making HTML well-formed with balanced and properly nested tags, neutralizing code that may be used for cross-site scripting (<span class="term">XSS</span>) attacks, and allowing only specified HTML elements/tags and attributes.<br />
|
||
|
|
|
||
|
|
<div class="sub-section"><h3>
|
||
|
|
<a name="s1.1" id="s1.1"></a><span class="item-no">1.1</span>  Example uses
|
||
|
|
</h3><span class="totop"><a href="#peak">(to top)</a></span><br style="clear: both;" />
|
||
|
|
<br />
|
||
|
|
  *  Filtering of text submitted as comments on blogs to allow only certain HTML elements<br />
|
||
|
|
<br />
|
||
|
|
  *  Making RSS/Atom newsfeed item-content standard-compliant: often one uses an excerpt from an HTML document for the content, and with unbalanced tags, non-numerical entities, etc., such excerpts may not be XML-compliant<br />
|
||
|
|
<br />
|
||
|
|
  *  Text processing for stricter XML standard-compliance: e.g., to have lowercased <span class="term">x</span> in hexadecimal numeric entities becomes necessary if an XHTML document with MathML content needs to be served as <span class="term">application/xml</span><br />
|
||
|
|
<br />
|
||
|
|
  *  Scraping text or data from web-pages<br />
|
||
|
|
<br />
|
||
|
|
  *  Pretty-printing HTML code<br />
|
||
|
|
|
||
|
|
</div>
|
||
|
|
<div class="sub-section"><h3>
|
||
|
|
<a name="s1.2" id="s1.2"></a><span class="item-no">1.2</span>  Features
|
||
|
|
</h3><span class="totop"><a href="#peak">(to top)</a></span><br style="clear: both;" />
|
||
|
|
<br />
|
||
|
|
  Key: <span class="term">*</span> security feature, <span class="term">^</span> standard compliance, <span class="term">~</span> requires setting right options, <span class="term">`</span> different from <span class="term">Kses</span><br />
|
||
|
|
<br />
|
||
|
|
  *  make input more <strong>secure</strong> and <strong>standard-compliant</strong><br />
|
||
|
|
  *  use for HTML 4, XHTML 1.0 or 1.1, or even generic <strong>XML</strong> documents  ^~`<br />
|
||
|
|
<br />
|
||
|
|
  *  <strong>beautify</strong> or <strong>compact</strong> HTML  ^~`<br />
|
||
|
|
<br />
|
||
|
|
  *  <strong>restrict elements</strong>  ^~`<br />
|
||
|
|
  *  proper closure of empty elements like <span class="term">img</span>  ^`<br />
|
||
|
|
  *  <strong>transform deprecated elements</strong> like <span class="term">u</span>  ^~`<br />
|
||
|
|
  *  HTML <strong>comments</strong> and <span class="term">CDATA</span> sections can be permitted  ^~`<br />
|
||
|
|
  *  elements like <span class="term">script</span>, <span class="term">object</span> and <span class="term">form</span> can be permitted  ~<br />
|
||
|
|
<br />
|
||
|
|
  *  <strong>restrict attributes</strong>, including <strong>element-specifically</strong>  ^~`<br />
|
||
|
|
  *  remove <strong>invalid attributes</strong>  ^`<br />
|
||
|
|
  *  element and attribute names are <strong>lower-cased</strong>  ^<br />
|
||
|
|
  *  provide <strong>required attributes</strong>, like <span class="term">alt</span> for <span class="term">image</span>  ^`<br />
|
||
|
|
  *  <strong>transform deprecated attributes</strong>  ^~`<br />
|
||
|
|
  *  attributes <strong>declared only once</strong>  ^`<br />
|
||
|
|
<br />
|
||
|
|
  *  <strong>restrict attribute values</strong>, including <strong>element-specifically</strong>  ^~`<br />
|
||
|
|
  *  a value is declared for <em>empty</em> (<em>minimized</em>) attributes like <span class="term">checked</span>  ^<br />
|
||
|
|
  *  check for potentially dangerous attribute values  *~<br />
|
||
|
|
  *  ensure <strong>unique</strong> <span class="term">id</span> attribute values  ^~`<br />
|
||
|
|
  *  <strong>double-quote</strong> attribute values  ^<br />
|
||
|
|
  *  lower-case <strong>standard attribute values</strong> like <span class="term">password</span>  ^`<br />
|
||
|
|
<br />
|
||
|
|
  *  <strong>attribute-specific URL protocol/scheme restriction</strong>  *~`<br />
|
||
|
|
  *  disable <strong>dynamic expressions</strong> in <span class="term">style</span> values  *~`<br />
|
||
|
|
<br />
|
||
|
|
  *  neutralize invalid named character entities  ^`<br />
|
||
|
|
  *  <strong>convert</strong> hexadecimal numeric entities to decimal ones, or vice versa  ^~`<br />
|
||
|
|
  *  convert named entities to numeric ones for generic XML use  ^~`<br />
|
||
|
|
<br />
|
||
|
|
  *  remove <strong>null</strong> characters  *<br />
|
||
|
|
  *  neutralize potentially dangerous proprietary Netscape <strong>Javascript entities</strong>  *<br />
|
||
|
|
  *  replace potentially dangerous <strong>soft-hyphen</strong> character in URL-accepting attribute values with spaces  *<br />
|
||
|
|
<br />
|
||
|
|
  *  remove common <strong>invalid characters</strong> not allowed in HTML or XML  ^`<br />
|
||
|
|
  *  replace <strong>characters from Microsoft applications</strong> like <span class="term">Word</span> that are discouraged in HTML or XML  ^~`<br />
|
||
|
|
  *  neutralize entities for characters invalid or discouraged in HTML or XML  ^`<br />
|
||
|
|
  *  appropriately neutralize <span class="term"><</span>, <span class="term">&</span>, <span class="term">"</span>, and <span class="term">></span> characters  ^*`<br />
|
||
|
|
<br />
|
||
|
|
  *  understands improperly spaced tag content (like, spread over more than a line) and properly spaces them  `<br />
|
||
|
|
  *  attempts to <strong>balance tags</strong> for well-formedness  ^~`<br />
|
||
|
|
  *  understands when <strong>omitable closing tags</strong> like <span class="term"></p></span> (allowed in HTML 4, transitional, e.g.) are missing  ^~`<br />
|
||
|
|
  *  attempts to permit only <strong>validly nested tags</strong>  ^~`<br />
|
||
|
|
  *  option to <strong>remove or neutralize bad content</strong> ^~`<br />
|
||
|
|
  *  attempts to <strong>rectify common errors of plain-text misplacement</strong> (e.g., directly inside <span class="term">blockquote</span>) ^~`<br />
|
||
|
|
<br />
|
||
|
|
  *  fast, <strong>non-OOP</strong> code of ~45 kb incurring peak basal memory usage of ~0.5 MB<br />
|
||
|
|
  *  <strong>compatible</strong> with pre-existing code using <span class="term">Kses</span> (the filter used by <span class="term">WordPress</span>)<br />
|
||
|
|
<br />
|
||
|
|
  *  optional <strong>anti-spam</strong> measures such as addition of <span class="term">rel="nofollow"</span> and link-disabling  ~`<br />
|
||
|
|
  *  optionally makes <strong>relative URLs absolute</strong>, and vice versa  ~`<br />
|
||
|
|
<br />
|
||
|
|
  *  optionally mark <span class="term">&</span> to identify the entities for <span class="term">&</span>, <span class="term"><</span> and <span class="term">></span> introduced by htmLawed  ~`<br />
|
||
|
|
<br />
|
||
|
|
  *  allows deployment of powerful <strong>hook functions</strong> to <strong>inject</strong> HTML, <strong>consolidate</strong> <span class="term">style</span> attributes to <span class="term">class</span>, finely check attribute values, etc.  ~`<br />
|
||
|
|
<br />
|
||
|
|
  *  <strong>independent of character encoding</strong> of input and does not affect it<br />
|
||
|
|
<br />
|
||
|
|
  *  <strong>tolerance for ill-written HTML</strong> to a certain degree<br />
|
||
|
|
|
||
|
|
</div>
|
||
|
|
<div class="sub-section"><h3>
|
||
|
|
<a name="s1.3" id="s1.3"></a><span class="item-no">1.3</span>  History
|
||
|
|
</h3><span class="totop"><a href="#peak">(to top)</a></span><br style="clear: both;" />
|
||
|
|
<br />
|
||
|
|
  htmLawed was developed for use with <span class="term">LabWiki</span>, a wiki software developed at PHP Labware, as a suitable software could not be found. Existing PHP software like <span class="term">Kses</span> and <span class="term">HTMLPurifier</span> were deemed inadequate, slow, resource-intensive, or dependent on external applications like <span class="term">HTML Tidy</span>.<br />
|
||
|
|
<br />
|
||
|
|
  htmLawed started as a modification of Ulf Harnhammar's <span class="term">Kses</span> (version 0.2.2) software, and is compatible with code that uses <span class="term">Kses</span>; see <a href="#s2.6">section 2.6</a>.<br />
|
||
|
|
|
||
|
|
</div>
|
||
|
|
<div class="sub-section"><h3>
|
||
|
|
<a name="s1.4" id="s1.4"></a><span class="item-no">1.4</span>  License & copyright
|
||
|
|
</h3><span class="totop"><a href="#peak">(to top)</a></span><br style="clear: both;" />
|
||
|
|
<br />
|
||
|
|
  htmLawed is free and open-source software dual licensed under LGPL license version <a href="http://www.gnu.org/licenses/lgpl-3.0.txt">3</a> and GPL license version <a href="http://www.gnu.org/licenses/gpl-2.0.txt">2</a> or later, and copyrighted by Santosh Patnaik, MD, PhD.<br />
|
||
|
|
|
||
|
|
</div>
|
||
|
|
<div class="sub-section"><h3>
|
||
|
|
<a name="s1.5" id="s1.5"></a><span class="item-no">1.5</span>  Terms used here
|
||
|
|
</h3><span class="totop"><a href="#peak">(to top)</a></span><br style="clear: both;" />
|
||
|
|
<br />
|
||
|
|
  *  <em>administrator</em> - or admin; person setting up the code to pass input through htmLawed; also, <em>user</em><br />
|
||
|
|
  *  <em>attributes</em> - name-value pairs like <span class="term">href="http://x.com"</span> in opening tags<br />
|
||
|
|
  *  <em>author</em> - <em>writer</em><br />
|
||
|
|
  *  <em>character</em> - atomic unit of text; internally represented by a numeric <em>code-point</em> as specified by the <em>encoding</em> or <em>charset</em> in use<br />
|
||
|
|
  *  <em>entity</em> - markup like <span class="term">&gt;</span> and <span class="term">&#160;</span> used to refer to a character<br />
|
||
|
|
  *  <em>element</em> - HTML element like <span class="term">a</span> and <span class="term">img</span><br />
|
||
|
|
  *  <em>element content</em> -  content between the opening and closing tags of an element, like <span class="term">click</span> of <span class="term"><a href="x">click</a></span><br />
|
||
|
|
  *  <em>HTML</em> - implies XHTML unless specified otherwise<br />
|
||
|
|
  *  <em>input</em> - text string given to htmLawed to process<br />
|
||
|
|
  *  <em>processing</em> - involves filtering, correction, etc., of input<br />
|
||
|
|
  *  <em>safe</em> - absence or reduction of certain characters and HTML elements and attributes in the input that can otherwise potentially and circumstantially expose web-site users to security vulnerabilities like cross-site scripting attacks (XSS)<br />
|
||
|
|
  *  <em>scheme</em> - URL protocol like <span class="term">http</span> and <span class="term">ftp</span><br />
|
||
|
|
  *  <em>specs</em> - standard specifications<br />
|
||
|
|
  *  <em>style property</em> - terms like <span class="term">border</span> and <span class="term">height</span> for which declarations are made in values for the <span class="term">style</span> attribute of elements<br />
|
||
|
|
  *  <em>tag</em> - markers like <span class="term"><a href="x"></span> and <span class="term"></a></span> delineating element content; the opening tag can contain attributes<br />
|
||
|
|
  *  <em>tag content</em> - consists of tag markers <span class="term"><</span> and <span class="term">></span>, element names like <span class="term">div</span>, and possibly attributes<br />
|
||
|
|
  *  <em>user</em> - administrator<br />
|
||
|
|
  *  <em>writer</em> - end-user like a blog commenter providing the input that is to be processed; also, <em>author</em><br />
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<div class="section"><h2>
|
||
|
|
<a name="s2" id="s2"></a><span class="item-no">2</span>  Usage
|
||
|
|
</h2><span class="totop"><a href="#peak">(to top)</a></span><br style="clear: both;" />
|
||
|
|
<br />
|
||
|
|
  htmLawed should work with PHP 4.4 and higher. Either <span class="term">include()</span> the <span class="term">htmLawed.php</span> file or copy-paste the entire code.<br />
|
||
|
|
<br />
|
||
|
|
  To easily <strong>test</strong> htmLawed using a form-based interface, use the provided <a href="htmLawedTest.php">demo</a> (<span class="term">htmLawed.php</span> and <span class="term">htmLawedTest.php</span> should be in the same directory on the web-server).<br />
|
||
|
|
<br />
|
||
|
|
  <strong>Note</strong>: For code for usage of the htmLawed class (for htmLawed in OOP), please refer to the <a href="http://www.bioinformatics.org/phplabware/internal_utilities/htmLawed">htmLawed</a> website; the filtering itself can be configured, etc., as described here.<br />
|
||
|
|
|
||
|
|
<div class="sub-section"><h3>
|
||
|
|
<a name="s2.1" id="s2.1"></a><span class="item-no">2.1</span>  Simple
|
||
|
|
</h3><span class="totop"><a href="#peak">(to top)</a></span><br style="clear: both;" />
|
||
|
|
<br />
|
||
|
|
  The input text to be processed, <span class="term">$text</span>, is passed as an argument of type string; <span class="term">htmLawed()</span> returns the processed string:<br />
|
||
|
|
<br />
|
||
|
|
|
||
|
|
<code class="code">    $processed = htmLawed($text);</code>
|
||
|
|
<br />
|
||
|
|
<br />
|
||
|
|
  <strong>Note</strong>: If input is from a <span class="term">$_GET</span> or <span class="term">$_POST</span> value, and <span class="term">magic quotes</span> are enabled on the PHP setup, run <span class="term">stripslashes()</span> on the input before passing to htmLawed.<br />
|
||
|
|
<br />
|
||
|
|
  By default, htmLawed will process the text allowing all valid HTML elements/tags, secure URL scheme/CSS style properties, etc. It will allow <span class="term">CDATA</span> sections and HTML comments, balance tags, and ensure proper nesting of elements. Such actions can be configured using two other optional arguments -- <span class="term">$config</span> and <span class="term">$spec</span>:<br />
|
||
|
|
<br />
|
||
|
|
|
||
|
|
<code class="code">    $processed = htmLawed($text, $config, $spec);</code>
|
||
|
|
<br />
|
||
|
|
<br />
|
||
|
|
  These extra parameters are detailed below. Some examples are shown in <a href="#s2.9">section 2.9</a>.<br />
|
||
|
|
<br />
|
||
|
|
  <strong>Note</strong>: For maximum protection against <span class="term">XSS</span> and other scripting attacks (e.g., by disallowing Javascript code), consider using the <span class="term">safe</span> parameter; see <a href="#s3.6">section 3.6</a>.<br />
|
||
|
|
|
||
|
|
</div>
|
||
|
|
<div class="sub-section"><h3>
|
||
|
|
<a name="s2.2" id="s2.2"></a><span class="item-no">2.2</span>  Configuring htmLawed using the <span class="term">$config</span> parameter
|
||
|
|
</h3><span class="totop"><a href="#peak">(to top)</a></span><br style="clear: both;" />
|
||
|
|
<br />
|
||
|
|
  <span class="term">$config</span> instructs htmLawed on how to tackle certain tasks. When <span class="term">$config</span> is not specified, or not set as an array (e.g., <span class="term">$config = 1</span>), htmLawed will take default actions. One or many of the task-action or value-specification pairs can be specified in <span class="term">$config</span> as array key-value pairs. If a parameter is not specified, htmLawed will use the default value/action indicated further below.<br />
|
||
|
|
<br />
|
||
|
|
|
||
|
|
<code class="code">    $config = array('comment'=>0, 'cdata'=>1);</code>
|
||
|
|
<br />
|
||
|
|
|
||
|
|
<code class="code">    $processed = htmLawed($text, $config);</code>
|
||
|
|
<br />
|
||
|
|
<br />
|
||
|
|
  Or,<br />
|
||
|
|
<br />
|
||
|
|
|
||
|
|
<code class="code">    $processed = htmLawed($text, array('comment'=>0, 'cdata'=>1));</code>
|
||
|
|
<br />
|
||
|
|
<br />
|
||
|
|
  Below are the possible value-specification combinations. In PHP code, values that are integers should not be quoted and should be used as numeric types (unless meant as string/text).<br />
|
||
|
|
<br />
|
||
|
|
  Key: <span class="term">*</span> default, <span class="term">^</span> different default when htmLawed is used in the Kses-compatible mode (see <a href="#s2.6">section 2.6</a>), <span class="term">~</span> different default when <span class="term">valid_xhtml</span> is set to <span class="term">1</span> (see <a href="#s3.5">section 3.5</a>), <span class="term">"</span> different default when <span class="term">safe</span> is set to <span class="term">1</span> (see <a href="#s3.6">section 3.6</a>)<br />
|
||
|
|
<br />
|
||
|
|
  <strong>abs_url</strong><br />
|
||
|
|
  Make URLs absolute or relative; <span class="term">$config["base_url"]</span> needs to be set; see <a href="#s3.4.4">section 3.4.4</a><br />
|
||
|
|
<br />
|
||
|
|
  <span class="term">-1</span> - make relative<br />
|
||
|
|
  <span class="term">0</span> - no action  *<br />
|
||
|
|
  <span class="term">1</span> - make absolute<br />
|
||
|
|
<br />
|
||
|
|
  <strong>and_mark</strong><br />
|
||
|
|
  Mark <span class="term">&</span> characters in the original input; see <a href="#s3.2">section 3.2</a><br />
|
||
|
|
<br />
|
||
|
|
  <strong>anti_link_spam</strong><br />
|
||
|
|
  Anti-link-spam measure; see <a href="#s3.4.7">section 3.4.7</a><br />
|
||
|
|
<br />
|
||
|
|
  <span class="term">0</span> - no measure taken  *<br />
|
||
|
|
  <span class="term">array("regex1", "regex2")</span> - will ensure a <span class="term">rel</span> attribute with <span class="term">nofollow</span> in its value in case the <span class="term">href</span> attribute value matches the regular expression pattern <span class="term">regex1</span>, and/or will remove <span class="term">href</span> if its value matches the regular expression pattern <span class="term">regex2</span>. E.g., <span class="term">array("/./", "/://\W*(?!(abc\.com|xyz\.org))/")</span>; see <a href="#s3.4.7">section 3.4.7</a> for more.<br />
|
||
|
|
<br />
|
||
|
|
  <strong>anti_mail_spam</strong><br />
|
||
|
|
  Anti-mail-spam measure; see <a href="#s3.4.7">section 3.4.7</a><br />
|
||
|
|
<br />
|
||
|
|
  <span class="term">0</span> - no measure taken  *<br />
|
||
|
|
  <span class="term">word</span> - <span class="term">@</span> in mail address in <span class="term">href</span> attribute value is replaced with specified <span class="term">word</span><br />
|
||
|
|
<br />
|
||
|
|
  <strong>balance</strong><br />
|
||
|
|
  Balance tags for well-formedness and proper nesting; see <a href="#s3.3.3">section 3.3.3</a><br />
|
||
|
|
<br />
|
||
|
|
  <span class="term">0</span> - no<br />
|
||
|
|
  <span class="term">1</span> - yes  *<br />
|
||
|
|
<br />
|
||
|
|
  <strong>base_url</strong><br />
|
||
|
|
  Base URL value that needs to be set if <span class="term">$config["abs_url"]</span> is not <span class="term">0</span>; see <a href="#s3.4.4">section 3.4.4</a><br />
|
||
|
|
<br />
|
||
|
|
  <strong>cdata</strong><br />
|
||
|
|
  Handling of <span class="term">CDATA</span> sections; see <a href="#s3.3.1">section 3.3.1</a><br />
|
||
|
|
<br />
|
||
|
|
  <span class="term">0</span> - don't consider <span class="term">CDATA</span> sections as markup and proceed as if plain text  ^"<br />
|
||
|
|
  <span class="term">1</span> - remove<br />
|
||
|
|
  <span class="term">2</span> - allow, but neutralize any <span class="term"><</span>, <span class="term">></span>, and <span class="term">&</span> inside by converting them to named entities<br />
|
||
|
|
  <span class="term">3</span> - allow  *<br />
|
||
|
|
<br />
|
||
|
|
  <strong>clean_ms_char</strong><br />
|
||
|
|
  Replace discouraged characters introduced by Microsoft Word, etc.; see <a href="#s3.1">section 3.1</a><br />
|
||
|
|
<br />
|
||
|
|
  <span class="term">0</span> - no  *<br />
|
||
|
|
  <span class="term">1</span> - yes<br />
|
||
|
|
  <span class="term">2</span> - yes, but replace special single & double quotes with ordinary ones<br />
|
||
|
|
<br />
|
||
|
|
  <strong>comment</strong><br />
|
||
|
|
  Handling of HTML comments; see <a href="#s3.3.1">section 3.3.1</a><br />
|
||
|
|
<br />
|
||
|
|
  <span class="term">0</span> - don't consider comments as markup and proceed as if plain text  ^"<br />
|
||
|
|
  <span class="term">1</span> - remove<br />
|
||
|
|
  <span class="term">2</span> - allow, but neutralize any <span class="term"><</span>, <span class="term">></span>, and <span class="term">&</span> inside by converting to named entities<br />
|
||
|
|
  <span class="term">3</span> - allow  *<br />
|
||
|
|
<br />
|
||
|
|
  <strong>css_expression</strong><br />
|
||
|
|
  Allow dynamic CSS expression by not removing the expression from CSS property values in <span class="term">style</span> attributes; see <a href="#s3.4.8">section 3.4.8</a><br />
|
||
|
|
<br />
|
||
|
|
  <span class="term">0</span> - remove  *<br />
|
||
|
|
  <span class="term">1</span> - allow<br />
|
||
|
|
<br />
|
||
|
|
  <strong>deny_attribute</strong><br />
|
||
|
|
  Denied HTML attributes; see <a href="#s3.4">section 3.4</a><br />
|
||
|
|
<br />
|
||
|
|
  <span class="term">0</span> - none  *<br />
|
||
|
|
  <span class="term">string</span> - dictated by values in <span class="term">string</span><br />
|
||
|
|
  <span class="term">on*</span> (like <span class="term">onfocus</span>) attributes not allowed - "<br />
|
||
|
|
<br />
|
||
|
|
  <strong>direct_nest_list</strong><br />
|
||
|
|
  Allow direct nesting of a list within another without requiring it to be a list item; see <a href="#s3.3.4">section 3.3.4</a><br />
|
||
|
|
<br />
|
||
|
|
  <span class="term">0</span> - no  *<br />
|
||
|
|
  <span class="term">1</span> - yes<br />
|
||
|
|
<br />
|
||
|
|
  <strong>elements</strong><br />
|
||
|
|
  Allowed HTML elements; see <a href="#s3.3">section 3.3</a><br />
|
||
|
|
<br />
|
||
|
|
  <span class="term">* -center -dir -font -isindex -menu -s -strike -u</span> -  ~<br />
|
||
|
|
  <span class="term">applet, embed, iframe, object, script</span> not allowed - "<br />
|
||
|
|
<br />
|
||
|
|
  <strong>hexdec_entity</strong><br />
|
||
|
|
  Allow hexadecimal numeric entities and do not convert to the more widely accepted decimal ones, or convert decimal to hexadecimal ones; see <a href="#s3.2">section 3.2</a><br />
|
||
|
|
<br />
|
||
|
|
  <span class="term">0</span> - no<br />
|
||
|
|
  <span class="term">1</span> - yes  *<br />
|
||
|
|
  <span class="term">2</span> - convert decimal to hexadecimal ones<br />
|
||
|
|
<br />
|
||
|
|
  <strong>hook</strong><br />
|
||
|
|
  Name of an optional hook function to alter the input string, <span class="term">$config</span> or <span class="term">$spec</span> before htmLawed starts its main work; see <a href="#s3.7">section 3.7</a><br />
|
||
|
|
<br />
|
||
|
|
  <span class="term">0</span> - no hook function  *<br />
|
||
|
|
  <span class="term">name</span> - <span class="term">name</span> is name of the hook function (<span class="term">kses_hook</span>  ^)<br />
|
||
|
|
<br />
|
||
|
|
  <strong>hook_tag</strong><br />
|
||
|
|
  Name of an optional hook function to alter tag content finalized by htmLawed; see <a href="#s3.4.9">section 3.4.9</a><br />
|
||
|
|
<br />
|
||
|
|
  <span class="term">0</span> - no hook function  *<br />
|
||
|
|
  <span class="term">name</span> - <span class="term">name</span> is name of the hook function<br />
|
||
|
|
<br />
|
||
|
|
  <strong>keep_bad</strong><br />
|
||
|
|
  Neutralize bad tags by converting <span class="term"><</span> and <span class="term">></span> to entities, or remove them; see <a href="#s3.3.3">section 3.3.3</a><br />
|
||
|
|
<br />
|
||
|
|
  <span class="term">0</span> - remove  ^<br />
|
||
|
|
  <span class="term">1</span> - neutralize both tags and element content<br />
|
||
|
|
  <span class="term">2</span> - remove tags but neutralize element content<br />
|
||
|
|
  <span class="term">3</span> and <span class="term">4</span> - like <span class="term">1</span> and <span class="term">2</span> but remove if text (<span class="term">pcdata</span>) is invalid in parent element<br />
|
||
|
|
  <span class="term">5</span> and <span class="term">6</span> * -  like <span class="term">3</span> and <span class="term">4</span> but line-breaks, tabs and spaces are left<br />
|
||
|
|
<br />
|
||
|
|
  <strong>lc_std_val</strong><br />
|
||
|
|
  For XHTML compliance, predefined, standard attribute values, like <span class="term">get</span> for the <span class="term">method</span> attribute of <span class="term">form</span>, must be lowercased; see <a href="#s3.4.5">section 3.4.5</a><br />
|
||
|
|
<br />
|
||
|
|
  <span class="term">0</span> - no<br />
|
||
|
|
  <span class="term">1</span> - yes  *<br />
|
||
|
|
<br />
|
||
|
|
  <strong>make_tag_strict</strong><br />
|
||
|
|
  Transform/remove these non-strict XHTML elements, even if they are allowed by the admin: <span class="term">applet</span> <span class="term">center</span> <span class="term">dir</span> <span class="term">embed</span> <span class="term">font</span> <span class="term">isindex</span> <span class="term">menu</span> <span class="term">s</span> <span class="term">strike</span> <span class="term">u</span>; see <a href="#s3.3.2">section 3.3.2</a><br />
|
||
|
|
<br />
|
||
|
|
  <span class="term">0</span> - no  ^<br />
|
||
|
|
  <span class="term">1</span> - yes, but leave <span class="term">applet</span>, <span class="term">embed</span> and <span class="term">isindex</span> elements that currently can't be transformed  *<br />
|
||
|
|
  <span class="term">2</span> - yes, removing <span class="term">applet</span>, <span class="term">embed</span> and <span class="term">isindex</span> elements and their contents (nested elements remain)  ~<br />
|
||
|
|
<br />
|
||
|
|
  <strong>named_entity</strong><br />
|
||
|
|
  Allow non-universal named HTML entities, or convert to numeric ones; see <a href="#s3.2">section 3.2</a><br />
|
||
|
|
<br />
|
||
|
|
  <span class="term">0</span> - convert<br />
|
||
|
|
  <span class="term">1</span> - allow  *<br />
|
||
|
|
<br />
|
||
|
|
  <strong>no_deprecated_attr</strong><br />
|
||
|
|
  Allow deprecated attributes or transform them; see <a href="#s3.4.6">section 3.4.6</a><br />
|
||
|
|
<br />
|
||
|
|
  <span class="term">0</span> - allow  ^<br />
|
||
|
|
  <span class="term">1</span> - transform, but <span class="term">name</span> attributes for <span class="term">a</span> and <span class="term">map</span> are retained  *<br />
|
||
|
|
  <span class="term">2</span> - transform<br />
|
||
|
|
<br />
|
||
|
|
  <strong>parent</strong><br />
|
||
|
|
  Name of the parent element, possibly imagined, that will hold the input; see <a href="#s3.3">section 3.3</a><br />
|
||
|
|
<br />
|
||
|
|
  <strong>safe</strong><br />
|
||
|
|
  Magic parameter to make input the most secure against XSS without needing to specify other relevant <span class="term">$config</span> parameters; see <a href="#s3.6">section 3.6</a><br />
|
||
|
|
<br />
|
||
|
|
  <span class="term">0</span> - no  *<br />
|
||
|
|
  <span class="term">1</span> - will auto-adjust other relevant <span class="term">$config</span> parameters (indicated by <span class="term">"</span> in this list)<br />
|
||
|
|
<br />
|
||
|
|
  <strong>schemes</strong><br />
|
||
|
|
  Array of attribute-specific, comma-separated, lower-cased list of schemes (protocols) allowed in attributes accepting URLs (or <span class="term">!</span> to <em>deny</em> any URL); <span class="term">*</span> covers all unspecified attributes; see <a href="#s3.4.3">section 3.4.3</a><br />
|
||
|
|
<br />
|
||
|
|
  <span class="term">href: aim, feed, file, ftp, gopher, http, https, irc, mailto, news, nntp, sftp, ssh, telnet; *:file, http, https</span>  *<br />
|
||
|
|
  <span class="term">*: ftp, gopher, http, https, mailto, news, nntp, telnet</span>  ^<br />
|
||
|
|
  <span class="term">href: aim, feed, file, ftp, gopher, http, https, irc, mailto, news, nntp, sftp, ssh, telnet; style: !; *:file, http, https</span>  "<br />
|
||
|
|
<br />
|
||
|
|
  <strong>show_setting</strong><br />
|
||
|
|
  Name of a PHP variable to assign the <em>finalized</em> <span class="term">$config</span> and <span class="term">$spec</span> values; see <a href="#s3.8">section 3.8</a><br />
|
||
|
|
<br />
|
||
|
|
  <strong>style_pass</strong><br />
|
||
|
|
  Do not look at <span class="term">style</span> attribute values, letting them through without any alteration<br />
|
||
|
|
<br />
|
||
|
|
  <span class="term">0</span> - no *<br />
|
||
|
|
  <span class="term">1</span> - htmLawed will let through any <span class="term">style</span> value; see <a href="#s3.4.8">section 3.4.8</a><br />
|
||
|
|
<br />
|
||
|
|
  <strong>tidy</strong><br />
|
||
|
|
  Beautify or compact HTML code; see <a href="#s3.3.5">section 3.3.5</a><br />
|
||
|
|
<br />
|
||
|
|
  <span class="term">-1</span> - compact<br />
|
||
|
|
  <span class="term">0</span> - no  *<br />
|
||
|
|
  <span class="term">1</span> or <span class="term">string</span> - beautify (custom format specified by <span class="term">string</span>)<br />
|
||
|
|
<br />
|
||
|
|
  <strong>unique_ids</strong><br />
|
||
|
|
  <span class="term">id</span> attribute value checks; see <a href="#s3.4.2">section 3.4.2</a><br />
|
||
|
|
<br />
|
||
|
|
  <span class="term">0</span> - no  ^<br />
|
||
|
|
  <span class="term">1</span> - remove duplicate and/or invalid ones  *<br />
|
||
|
|
  <span class="term">word</span> - remove invalid ones and replace duplicate ones with new and unique ones based on the <span class="term">word</span>; the admin-specified <span class="term">word</span>, like <span class="term">my_</span>, should begin with a letter (a-z) and can contain letters, digits, <span class="term">.</span>, <span class="term">_</span>, <span class="term">-</span>, and <span class="term">:</span>.<br />
|
||
|
|
<br />
|
||
|
|
  <strong>valid_xhtml</strong><br />
|
||
|
|
  Magic parameter to make input the most valid XHTML without needing to specify other relevant <span class="term">$config</span> parameters; see <a href="#s3.5">section 3.5</a><br />
|
||
|
|
<br />
|
||
|
|
  <span class="term">0</span> - no  *<br />
|
||
|
|
  <span class="term">1</span> - will auto-adjust other relevant <span class="term">$config</span> parameters (indicated by <span class="term">~</span> in this list)<br />
|
||
|
|
<br />
|
||
|
|
  <strong>xml:lang</strong><br />
|
||
|
|
  Auto-adding <span class="term">xml:lang</span> attribute; see <a href="#s3.4.1">section 3.4.1</a><br />
|
||
|
|
<br />
|
||
|
|
  <span class="term">0</span> - no  *<br />
|
||
|
|
  <span class="term">1</span> - add if <span class="term">lang</span> attribute is present<br />
|
||
|
|
  <span class="term">2</span> - add if <span class="term">lang</span> attribute is present, and remove <span class="term">lang</span>  ~<br />
|
||
|
|
|
||
|
|
</div>
|
||
|
|
<div class="sub-section"><h3>
|
||
|
|
<a name="s2.3" id="s2.3"></a><span class="item-no">2.3</span>  Extra HTML specifications using the $spec parameter
|
||
|
|
</h3><span class="totop"><a href="#peak">(to top)</a></span><br style="clear: both;" />
|
||
|
|
<br />
|
||
|
|
  The <span class="term">$spec</span> argument can be used to disallow an otherwise legal attribute for an element, or to restrict the attribute's values. This can also be helpful as a security measure (e.g., in certain versions of browsers, certain values can cause buffer overflows and denial of service attacks), or in enforcing admin policy compliance. <span class="term">$spec</span> is specified as a string of text containing one or more <em>rules</em>, with multiple rules separated from each other by a semi-colon (<span class="term">;</span>). E.g.,<br />
|
||
|
|
<br />
|
||
|
|
|
||
|
|
<code class="code">    $spec = 'i=-*; td, tr=style, id, -*; a=id(match="/[a-z][a-z\d.:\-`"]*/i"/minval=2), href(maxlen=100/minlen=34); img=-width,-alt';</code>
|
||
|
|
<br />
|
||
|
|
|
||
|
|
<code class="code">    $processed = htmLawed($text, $config, $spec);</code>
|
||
|
|
<br />
|
||
|
|
<br />
|
||
|
|
  Or,<br />
|
||
|
|
<br />
|
||
|
|
|
||
|
|
<code class="code">    $processed = htmLawed($text, $config, 'i=-*; td, tr=style, id, -*; a=id(match="/[a-z][a-z\d.:\-`"]*/i"/minval=2), href(maxlen=100/minlen=34); img=-width,-alt');</code>
|
||
|
|
<br />
|
||
|
|
<br />
|
||
|
|
  A rule begins with an HTML <strong>element</strong> name(s) (<em>rule-element</em>), for which the rule applies, followed by an equal (<span class="term">=</span>) sign. A rule-element may represent multiple elements if comma (,)-separated element names are used. E.g., <span class="term">th,td,tr=</span>.<br />
|
||
|
|
<br />
|
||
|
|
  Rest of the rule consists of comma-separated HTML <strong>attribute names</strong>. A minus (<span class="term">-</span>) character before an attribute means that the attribute is not permitted inside the rule-element. E.g., <span class="term">-width</span>. To deny all attributes, <span class="term">-*</span> can be used.<br />
|
||
|
|
<br />
|
||
|
|
  Following shows examples of rule excerpts with rule-element <span class="term">a</span> and the attributes that are being permitted:<br />
|
||
|
|
<br />
|
||
|
|
  *  <span class="term">a=</span> - all<br />
|
||
|
|
  *  <span class="term">a=id</span> - all<br />
|
||
|
|
  *  <span class="term">a=href, title, -id, -onclick</span> - all except <span class="term">id</span> and <span class="term">onclick</span><br />
|
||
|
|
  *  <span class="term">a=*, id, -id</span> - all except <span class="term">id</span><br />
|
||
|
|
  *  <span class="term">a=-*</span> - none<br />
|
||
|
|
  *  <span class="term">a=-*, href, title</span> - none except <span class="term">href</span> and <span class="term">title</span><br />
|
||
|
|
  *  <span class="term">a=-*, -id, href, title</span> - none except <span class="term">href</span> and <span class="term">title</span><br />
|
||
|
|
<br />
|
||
|
|
  Rules regarding <strong>attribute values</strong> are optionally specified inside round brackets after attribute names in slash ('/')-separated <em>parameter = value</em> pairs. E.g., <span class="term">title(maxlen=30/minlen=5)</span>. None, or one or more of the following parameters may be specified:<br />
|
||
|
|
<br />
|
||
|
|
  *  <span class="term">oneof</span> - one or more choices separated by <span class="term">|</span> that the value should match; if only one choice is provided, then the value must match that choice<br />
|
||
|
|
<br />
|
||
|
|
  *  <span class="term">noneof</span> - one or more choices separated by <span class="term">|</span> that the value should not match<br />
|
||
|
|
<br />
|
||
|
|
  *  <span class="term">maxlen</span> and <span class="term">minlen</span> - upper and lower limits for the number of characters in the attribute value; specified in numbers<br />
|
||
|
|
<br />
|
||
|
|
  *  <span class="term">maxval</span> and <span class="term">minval</span> - upper and lower limits for the numerical value specified in the attribute value; specified in numbers<br />
|
||
|
|
<br />
|
||
|
|
  *  <span class="term">match</span> and <span class="term">nomatch</span> - pattern that the attribute value should or should not match; specified as PHP/PCRE-compatible regular expressions with delimiters and possibly modifiers<br />
|
||
|
|
<br />
|
||
|
|
  *  <span class="term">default</span> - a value to force on the attribute if the value provided by the writer does not fit any of the specified parameters<br />
|
||
|
|
<br />
|
||
|
|
  If <span class="term">default</span> is not set and the attribute value does not satisfy any of the specified parameters, then the attribute is removed. The <span class="term">default</span> value can also be used to force all attribute declarations to take the same value (by getting the values declared illegal by setting, e.g., <span class="term">maxlen</span> to <span class="term">-1</span>).<br />
|
||
|
|
<br />
|
||
|
|
  Examples with <em>input</em> <span class="term"><input title="WIDTH" value="10em" /><input title="length" value="5" /></span> are shown below.<br />
|
||
|
|
<br />
|
||
|
|
  <em>Rule</em>: <span class="term">input=title(maxlen=60/minlen=6), value</span><br />
|
||
|
|
  <em>Output</em>: <span class="term"><input value="10em" /><input title="length" value="5" /></span><br />
|
||
|
|
<br />
|
||
|
|
  <em>Rule</em>: <span class="term">input=title(), value(maxval=8/default=6)</span><br />
|
||
|
|
  <em>Output</em>: <span class="term"><input title="WIDTH" value="6" /><input title="length" value="5" /></span><br />
|
||
|
|
<br />
|
||
|
|
  <em>Rule</em>: <span class="term">input=title(nomatch=%w.d%i), value(match=%em%/default=6em)</span><br />
|
||
|
|
  <em>Output</em>: <span class="term"><input value="10em" /><input title="length" value="6em" /></span><br />
|
||
|
|
<br />
|
||
|
|
  <em>Rule</em>: <span class="term">input=title(oneof=height|depth/default=depth), value(noneof=5|6)</span><br />
|
||
|
|
  <em>Output</em>: <span class="term"><input title="depth" value="10em" /><input title="depth" /></span><br />
|
||
|
|
<br />
|
||
|
|
  <strong>Special characters</strong>: The characters <span class="term">;</span>, <span class="term">,</span>, <span class="term">/</span>, <span class="term">(</span>, <span class="term">)</span>, <span class="term">|</span>, <span class="term">~</span> and space have special meanings in the rules. Words in the rules that use such characters, or the characters themselves, should be <em>escaped</em> by enclosing in pairs of double-quotes (<span class="term">"</span>). A back-tick (<span class="term">`</span>) can be used to escape a literal <span class="term">"</span>. An example rule illustrating this is <span class="term">input=value(maxlen=30/match="/^\w/"/default="your `"ID`"")</span>.<br />
|
||
|
|
<br />
|
||
|
|
  <strong>Note</strong>: To deny an attribute for all elements for which it is legal, <span class="term">$config["deny_attribute"]</span> (see <a href="#s3.4">section 3.4</a>) can be used instead of <span class="term">$spec</span>. Also, attributes can be allowed element-specifically through <span class="term">$spec</span> while being denied globally through <span class="term">$config["deny_attribute"]</span>. The <span class="term">hook_tag</span> parameter (<a href="#s3.4.9">section 3.4.9</a>) can also be used to implement the <span class="term">$spec</span> functionality.<br />
|
||
|
|
|
||
|
|
</div>
|
||
|
|
<div class="sub-section"><h3>
|
||
|
|
<a name="s2.4" id="s2.4"></a><span class="item-no">2.4</span>  Performance time & memory usage
|
||
|
|
</h3><span class="totop"><a href="#peak">(to top)</a></span><br style="clear: both;" />
|
||
|
|
<br />
|
||
|
|
  The time and memory used by htmLawed depends on its configuration and the size of the input, and the amount, nestedness and well-formedness of the HTML markup within it. In particular, tag balancing and beautification each can increase the processing time by about a quarter.<br />
|
||
|
|
<br />
|
||
|
|
  The htmLawed <a href="htmLawedTest.php">demo</a> can be used to evaluate the performance and effects of different types of input and <span class="term">$config</span>.<br />
|
||
|
|
|
||
|
|
</div>
|
||
|
|
<div class="sub-section"><h3>
|
||
|
|
<a name="s2.5" id="s2.5"></a><span class="item-no">2.5</span>  Some security risks to keep in mind
|
||
|
|
</h3><span class="totop"><a href="#peak">(to top)</a></span><br style="clear: both;" />
|
||
|
|
<br />
|
||
|
|
  When setting the parameters/arguments (like those to allow certain HTML elements) for use with htmLawed, one should bear in mind that the setting may let through potentially <em>dangerous</em> HTML code which is meant to steal user-data, deface a website, render a page non-functional, etc.<br />
|
||
|
|
<br />
|
||
|
|
  Unless end-users, either people or software, supplying the content are completely trusted, security issues arising from the degree of HTML usage permission has to be kept in mind. For example, following increase security risks:<br />
|
||
|
|
<br />
|
||
|
|
  *  Allowing <span class="term">script</span>, <span class="term">applet</span>, <span class="term">embed</span>, <span class="term">iframe</span> or <span class="term">object</span> elements, or certain of their attributes like <span class="term">allowscriptaccess</span><br />
|
||
|
|
<br />
|
||
|
|
  *  Allowing HTML comments (some Internet Explorer versions are vulnerable with, e.g., <span class="term"><!--[if gte IE 4]><script>alert("xss");</script><![endif]--></span><br />
|
||
|
|
<br />
|
||
|
|
  *  Allowing dynamic CSS expressions (a feature of the IE browser)<br />
|
||
|
|
<br />
|
||
|
|
  *  Allowing the <span class="term">style</span> attribute<br />
|
||
|
|
<br />
|
||
|
|
  To remove <em>unsecure</em> HTML, code-developers using htmLawed must set <span class="term">$config</span> appropriately. E.g., <span class="term">$config["elements"] = "* -script"</span> to deny the <span class="term">script</span> element (<a href="#s3.3">section 3.3</a>), <span class="term">$config["safe"] = 1</span> to auto-configure ceratin htmLawed parameters for maximizing security (<a href="#s3.6">section 3.6</a>), etc.<br />
|
||
|
|
<br />
|
||
|
|
  Permitting the <span class="term">*style*</span> attribute brings in risks of <em>click-jacking</em>, <em>phishing</em>, web-page overlays, etc., <em>even</em> when the <span class="term">safe</span> parameter is enabled (see <a href="#s3.6">section 3.6</a>). Except for URLs and a few other things like CSS dynamic expressions, htmLawed currently does not check every CSS style property. It does provide ways for the code-developer implementing htmLawed to do such checks through htmLawed's <span class="term">$spec</span> argument, and through the <span class="term">hook_tag</span> parameter (see <a href="#s3.4.8">section 3.4.8</a> for more). Disallowing <span class="term">style</span> completely and relying on CSS classes and stylesheet files is recommended.<br />
|
||
|
|
<br />
|
||
|
|
  htmLawed does not check or correct the character <strong>encoding</strong> of the input it receives. In conjunction with permitting circumstances such as when the character encoding is left undefined through HTTP headers or HTML <span class="term">meta</span> tags, this can permit an exploit (like Google's UTF-7/XSS vulnerability of the past).<br />
|
||
|
|
|
||
|
|
</div>
|
||
|
|
<div class="sub-section"><h3>
|
||
|
|
<a name="s2.6" id="s2.6"></a><span class="item-no">2.6</span>  Use without modifying old <span class="term">kses()</span> code
|
||
|
|
</h3><span class="totop"><a href="#peak">(to top)</a></span><br style="clear: both;" />
|
||
|
|
<br />
|
||
|
|
  The <span class="term">Kses</span> PHP script is used by many applications (like <span class="term">WordPress</span>). It is possible to have such applications use htmLawed instead, since it is compatible with code that calls the <span class="term">kses()</span> function declared in the <span class="term">Kses</span> file (usually named <span class="term">kses.php</span>). E.g., application code like this will continue to work after replacing <span class="term">Kses</span> with htmLawed:<br />
|
||
|
|
<br />
|
||
|
|
|
||
|
|
<code class="code">    $comment_filtered = kses($comment_input, array('a'=>array(), 'b'=>array(), 'i'=>array()));</code>
|
||
|
|
<br />
|
||
|
|
<br />
|
||
|
|
  For some of the <span class="term">$config</span> parameters, htmLawed will use values other than the default ones. These are indicated by <span class="term">^</span> in <a href="#s2.2">section 2.2</a>. To force htmLawed to use other values, function <span class="term">kses()</span> in the htmLawed code should be edited -- a few configurable parameters/variables need to be changed.<br />
|
||
|
|
<br />
|
||
|
|
  If the application uses a <span class="term">Kses</span> file that has the <span class="term">kses()</span> function declared, then, to have the application use htmLawed instead of <span class="term">Kses</span>, simply rename <span class="term">htmLawed.php</span> (to <span class="term">kses.php</span>, e.g.) and replace the <span class="term">Kses</span> file (or just replace the code in the <span class="term">Kses</span> file with the htmLawed code). If the <span class="term">kses()</span> function in the <span class="term">Kses</span> file had been renamed by the application developer (e.g., in <span class="term">WordPress</span>, it is named <span class="term">wp_kses()</span>), then appropriately rename the <span class="term">kses()</span> function in the htmLawed code.<br />
|
||
|
|
<br />
|
||
|
|
  If the <span class="term">Kses</span> file used by the application has been highly altered by the application developers, then one may need a different approach. E.g., with <span class="term">WordPress</span>, it is best to copy the htmLawed code to <span class="term">wp_includes/kses.php</span>, rename the newly added function <span class="term">kses()</span> to <span class="term">wp_kses()</span>, and delete the code for the original <span class="term">wp_kses()</span> function.<br />
|
||
|
|
<br />
|
||
|
|
  If the <span class="term">Kses</span> code has a non-empty hook function (e.g., <span class="term">wp_kses_hook()</span> in case of <span class="term">WordPress</span>), then the code for htmLawed's <span class="term">kses_hook()</span> function should be appropriately edited. However, the requirement of the hook function should be re-evaluated considering that htmLawed has extra capabilities. With <span class="term">WordPress</span>, the hook function is an essential one. The following code is suggested for the htmLawed <span class="term">kses_hook()</span> in case of <span class="term">WordPress</span>:<br />
|
||
|
|
<br />
|
||
|
|
|
||
|
|
<code class="code">    function kses_hook($string, &$cf, &$spec){</code>
|
||
|
|
<br />
|
||
|
|
|
||
|
|
<code class="code">    // kses compatibility</code>
|
||
|
|
<br />
|
||
|
|
|
||
|
|
<code class="code">    $allowed_html = $spec;</code>
|
||
|
|
<br />
|
||
|
|
|
||
|
|
<code class="code">    $allowed_protocols = array();</code>
|
||
|
|
<br />
|
||
|
|
|
||
|
|
<code class="code">    foreach($cf['schemes'] as $v){</code>
|
||
|
|
<br />
|
||
|
|
|
||
|
|
<code class="code">     foreach($v as $k2=>$v2){</code>
|
||
|
|
<br />
|
||
|
|
|
||
|
|
<code class="code">      if(!in_array($k2, $allowed_protocols)){</code>
|
||
|
|
<br />
|
||
|
|
|
||
|
|
<code class="code">       $allowed_protocols[] = $k2;</code>
|
||
|
|
<br />
|
||
|
|
|
||
|
|
<code class="code">      }</code>
|
||
|
|
<br />
|
||
|
|
|
||
|
|
<code class="code">     }</code>
|
||
|
|
<br />
|
||
|
|
|
||
|
|
<code class="code">    }</code>
|
||
|
|
<br />
|
||
|
|
|
||
|
|
<code class="code">    return wp_kses_hook($string, $allowed_html, $allowed_protocols);</code>
|
||
|
|
<br />
|
||
|
|
|
||
|
|
<code class="code">    // eof</code>
|
||
|
|
<br />
|
||
|
|
|
||
|
|
<code class="code">    }</code>
|
||
|
|
<br />
|
||
|
|
|
||
|
|
</div>
|
||
|
|
<div class="sub-section"><h3>
|
||
|
|
<a name="s2.7" id="s2.7"></a><span class="item-no">2.7</span>  Tolerance for ill-written HTML
|
||
|
|
</h3><span class="totop"><a href="#peak">(to top)</a></span><br style="clear: both;" />
|
||
|
|
<br />
|
||
|
|
  htmLawed can work with ill-written HTML code in the input. However, HTML that is too ill-written may not be <em>read</em> as HTML, and be considered mere plain text instead. Following statements indicate the degree of <em>looseness</em> that htmLawed can work with, and can be provided in instructions to writers:<br />
|
||
|
|
<br />
|
||
|
|
  *  Tags must be flanked by <span class="term"><</span> and <span class="term">></span> with no <span class="term">></span> inside -- any needed <span class="term">></span> should be put in as <span class="term">&gt;</span>. It is possible for tag content (element name and attributes) to be spread over many lines instead of being on one. A space may be present between the tag content and <span class="term">></span>, like <span class="term"><div ></span> and <span class="term"><img / ></span>, but not after the <span class="term"><</span>.<br />
|
||
|
|
<br />
|
||
|
|
  *  Element and attribute names need not be lower-cased.<br />
|
||
|
|
<br />
|
||
|
|
  *  Attribute string of elements may be liberally spaced with tabs, line-breaks, etc.<br />
|
||
|
|
<br />
|
||
|
|
  *  Attribute values may not be double-quoted, or may be single-quoted.<br />
|
||
|
|
<br />
|
||
|
|
  *  Left-padding of numeric entities (like, <span class="term">&#0160;</span>, <span class="term">&x07ff;</span>) with <span class="term">0</span> is okay as long as the number of characters between between the <span class="term">&</span> and the <span class="term">;</span> does not exceed 8. All entities must end with <span class="term">;</span> though.<br />
|
||
|
|
<br />
|
||
|
|
  *  Named character entities must be properly cased. E.g., <span class="term">&Lt;</span> or <span class="term">&TILDE;</span> will not be let through without modification.<br />
|
||
|
|
<br />
|
||
|
|
  *  HTML comments should not be inside element tags (okay between tags), and should begin with <span class="term"><!--</span> and end with <span class="term">--></span>. Characters like <span class="term"><</span>, <span class="term">></span>, and <span class="term">&</span> may be allowed inside depending on <span class="term">$config</span>, but any <span class="term">--></span> inside should be put in as <span class="term">--&gt;</span>. Any <span class="term">--</span> inside will be automatically converted to <span class="term">-</span>, and a space will be added before the comment delimiter <span class="term">--></span>.<br />
|
||
|
|
<br />
|
||
|
|
  *  <span class="term">CDATA</span> sections should not be inside element tags, and can be in element content only if plain text is allowed for that element. They should begin with <span class="term"><[CDATA[</span> and end with <span class="term">]]></span>. Characters like <span class="term"><</span>, <span class="term">></span>, and <span class="term">&</span> may be allowed inside depending on <span class="term">$config</span>, but any <span class="term">]]></span> inside should be put in as <span class="term">]]&gt;</span>.<br />
|
||
|
|
<br />
|
||
|
|
  *  For attribute values, character entities <span class="term">&lt;</span>, <span class="term">&gt;</span> and <span class="term">&amp;</span> should be used instead of characters <span class="term"><</span> and <span class="term">></span>, and <span class="term">&</span> (when <span class="term">&</span> is not part of a character entity). This applies even for Javascript code in values of attributes like <span class="term">onclick</span>.<br />
|
||
|
|
<br />
|
||
|
|
  *  Characters <span class="term"><</span>, <span class="term">></span>, <span class="term">&</span> and <span class="term">"</span> that are part of actual Javascript, etc., code in <span class="term">script</span> elements should be used as such and not be put in as entities like <span class="term">&gt;</span>. Otherwise, though the HTML will be valid, the code may fail to work. Further, if such characters have to be used, then they should be put inside <span class="term">CDATA</span> sections.<br />
|
||
|
|
<br />
|
||
|
|
  *  Simple instructions like "an opening tag cannot be present between two closing tags" and "nested elements should be closed in the reverse order of how they were opened" can help authors write balanced HTML. If tags are imbalanced, htmLawed will try to balance them, but in the process, depending on <span class="term">$config["keep_bad"]</span>, some code/text may be lost.<br />
|
||
|
|
<br />
|
||
|
|
  *  Input authors should be notified of admin-specified allowed elements, attributes, configuration values (like conversion of named entities to numeric ones), etc.<br />
|
||
|
|
<br />
|
||
|
|
  *  With <span class="term">$config["unique_ids"]</span> not <span class="term">0</span> and the <span class="term">id</span> attribute being permitted, writers should carefully avoid using duplicate or invalid <span class="term">id</span> values as even though htmLawed will correct/remove the values, the final output may not be the one desired. E.g., when <span class="term"><a id="home"></a><input id="home" /><label for="home"></label></span> is processed into<br />
|
||
|
|
<span class="term"><a id="home"></a><input id="prefix_home" /><label for="home"></label></span>.<br />
|
||
|
|
<br />
|
||
|
|
  *  Note that even if intended HTML is lost in a highly ill-written input, the processed output will be more secure and standard-compliant.<br />
|
||
|
|
<br />
|
||
|
|
  *  For URLs, unless <span class="term">$config["scheme"]</span> is appropriately set, writers should avoid using escape characters or entities in schemes. E.g., <span class="term">htt&#112;</span> (which many browsers will read as the harmless <span class="term">http</span>) may be considered bad by htmLawed.<br />
|
||
|
|
<br />
|
||
|
|
  *  htmLawed will attempt to put plain text present directly inside <span class="term">blockquote</span>, <span class="term">form</span>, <span class="term">map</span> and <span class="term">noscript</span> elements (illegal as per the specs) inside auto-generated <span class="term">div</span> elements.<br />
|
||
|
|
|
||
|
|
</div>
|
||
|
|
<div class="sub-section"><h3>
|
||
|
|
<a name="s2.8" id="s2.8"></a><span class="item-no">2.8</span>  Limitations & work-arounds
|
||
|
|
</h3><span class="totop"><a href="#peak">(to top)</a></span><br style="clear: both;" />
|
||
|
|
<br />
|
||
|
|
  htmLawed's main objective is to make the input text <em>more</em> standard-compliant, secure for web-page readers, and free of HTML elements and attributes considered undesirable by the administrator. Some of its current limitations, regardless of this objective, are noted below along with work-arounds.<br />
|
||
|
|
<br />
|
||
|
|
  It should be borne in mind that no browser application is 100% standard-compliant, and that some of the standard specs (like asking for normalization of white-spacing within <span class="term">textarea</span> elements) are clearly wrong. Regarding security, note that <em>unsafe</em> HTML code is not necessarily legally invalid.<br />
|
||
|
|
<br />
|
||
|
|
  *  htmLawed is meant for input that goes into the <span class="term">body</span> of HTML documents. HTML's head-level elements are not supported, nor are the frameset elements <span class="term">frameset</span>, <span class="term">frame</span> and <span class="term">noframes</span>.<br />
|
||
|
|
<br />
|
||
|
|
  *  It cannot transform the non-standard <span class="term">embed</span> elements to the standard-compliant <span class="term">object</span> elements. Yet, it can allow <span class="term">embed</span> elements if permitted (<span class="term">embed</span> is widely used and supported). Admins can certainly use the <span class="term">hook_tag</span> parameter (<a href="#s3.4.9">section 3.4.9</a>) to deploy a custom embed-to-object converter function.<br />
|
||
|
|
<br />
|
||
|
|
  *  The only non-standard element that may be permitted is <span class="term">embed</span>; others like <span class="term">noembed</span> and <span class="term">nobr</span> cannot be permitted without modifying the htmLawed code.<br />
|
||
|
|
<br />
|
||
|
|
  *  It cannot handle input that has non-HTML code like <span class="term">SVG</span> and <span class="term">MathML</span>. One way around is to break the input into pieces and passing only those without non-HTML code to htmLawed. Another is described in <a href="#s3.9">section 3.9</a>. A third way may be to some how take advantage of the <span class="term">$config["and_mark"]</span> parameter (see <a href="#s3.2">section 3.2</a>).<br />
|
||
|
|
<br />
|
||
|
|
  *  By default, htmLawed won't check many attribute values for standard compliance. E.g., <span class="term">width="20m"</span> with the dimension in non-standard <span class="term">m</span> is let through. Implementing universal and strict attribute value checks can make htmLawed slow and resource-intensive. Admins should look at the <span class="term">hook_tag</span> parameter (<a href="#s3.4.9">section 3.4.9</a>) or <span class="term">$spec</span> to enforce finer checks.<br />
|
||
|
|
<br />
|
||
|
|
  *  The attributes, deprecated (which can be transformed too) or not, that it supports are largely those that are in the specs. Only a few of the proprietary attributes are supported.<br />
|
||
|
|
<br />
|
||
|
|
  *  Except for contained URLs and dynamic expressions (also optional), htmLawed does not check CSS style property values. Admins should look at using the <span class="term">hook_tag</span> parameter (<a href="#s3.4.9">section 3.4.9</a>) or <span class="term">$spec</span> for finer checks. Perhaps the best option is to disallow <span class="term">style</span> but allow <span class="term">class</span> attributes with the right <span class="term">oneof</span> or <span class="term">match</span> values for <span class="term">class</span>, and have the various class style properties in <span class="term">.css</span> CSS stylesheet files.<br />
|
||
|
|
<br />
|
||
|
|
  *  htmLawed does not parse emoticons, decode <em>BBcode</em>, or <em>wikify</em>, auto-converting text to proper HTML. Similarly, it won't convert line-breaks to <span class="term">br</span> elements. Such functions are beyond its purview. Admins should use other code to pre- or post-process the input for such purposes.<br />
|
||
|
|
<br />
|
||
|
|
  *  htmLawed cannot be used to have links force-opened in new windows (by auto-adding appropriate <span class="term">target</span> and <span class="term">onclick</span> attributes to <span class="term">a</span>). Admins should look at Javascript-based DOM-modifying solutions for this. Admins may also be able to use a custom hook function to enforce such checks (<span class="term">hook_tag</span> parameter; see <a href="#s3.4.9">section 3.4.9</a>).<br />
|
||
|
|
<br />
|
||
|
|
  *  Nesting-based checks are not possible. E.g., one cannot disallow <span class="term">p</span> elements specifically inside <span class="term">td</span> while permitting it elsewhere. Admins may be able to use a custom hook function to enforce such checks (<span class="term">hook_tag</span> parameter; see <a href="#s3.4.9">section 3.4.9</a>).<br />
|
||
|
|
<br />
|
||
|
|
  *  Except for optionally converting absolute or relative URLs to the other type, htmLawed will not alter URLs (e.g., to change the value of query strings or to convert <span class="term">http</span> to <span class="term">https</span>. Having absolute URLs may be a standard-requirement, e.g., when HTML is embedded in email messages, whereas altering URLs for other purposes is beyond htmLawed's goals. Admins may be able to use a custom hook function to enforce such checks (<span class="term">hook_tag</span> parameter; see <a href="#s3.4.9">section 3.4.9</a>).<br />
|
||
|
|
<br />
|
||
|
|
  *  Pairs of opening and closing tags that do not enclose any content (like <span class="term"><em></em></span>) are not removed. This may be against the standard specs for certain elements (e.g., <span class="term">table</span>). However, presence of such standard-incompliant code will not break the display or layout of content. Admins can also use simple regex-based code to filter out such code.<br />
|
||
|
|
<br />
|
||
|
|
  *  htmLawed does not check for certain element orderings described in the standard specs (e.g., in a <span class="term">table</span>, <span class="term">tbody</span> is allowed before <span class="term">tfoot</span>). Admins may be able to use a custom hook function to enforce such checks (<span class="term">hook_tag</span> parameter; see <a href="#s3.4.9">section 3.4.9</a>).<br />
|
||
|
|
<br />
|
||
|
|
  *  htmLawed does not check the number of nested elements. E.g., it will allow two <span class="term">caption</span> elements in a <span class="term">table</span> element, illegal as per the specs. Admins may be able to use a custom hook function to enforce such checks (<span class="term">hook_tag</span> parameter; see <a href="#s3.4.9">section 3.4.9</a>).<br />
|
||
|
|
<br />
|
||
|
|
  *  htmLawed might convert certain entities to actual characters and remove backslashes and CSS comment-markers (<span class="term">/*</span>) in <span class="term">style</span> attribute values in order to detect malicious HTML like crafted IE-specific dynamic expressions like <span class="term">&#101;xpression...</span>. If this is too harsh, admins can allow CSS expressions through htmLawed core but then use a custom function through the <span class="term">hook_tag</span> parameter (<a href="#s3.4.9">section 3.4.9</a>) to more specifically identify CSS expressions in the <span class="term">style</span> attribute values. Also, using <span class="term">$config["style_pass"]</span>, it is possible to have htmLawed pass <span class="term">style</span> attribute values without even looking at them (<a href="#s3.4.8">section 3.4.8</a>).<br />
|
||
|
|
<br />
|
||
|
|
  *  htmLawed does not correct certain possible attribute-based security vulnerabilities (e.g., <span class="term"><a href="http://x%22+style=%22background-image:xss">x</a></span>). These arise when browsers mis-identify markup in <em>escaped</em> text, defeating the very purpose of escaping text (a bad browser will read the given example as <span class="term"><a href="http://x" style="background-image:xss">x</a></span>).<br />
|
||
|
|
<br />
|
||
|
|
  *  Because of poor Unicode support in PHP, htmLawed does not remove the <em>high value</em> HTML-invalid characters with multi-byte code-points. Such characters however are extremely unlikely to be in the input. (see <a href="#s3.1">section 3.1</a>).<br />
|
||
|
|
<br />
|
||
|
|
  *  htmLawed does not check or correct the character encoding of the input it receives. In conjunction with permitting circumstances such as when the character encoding is left undefined through HTTP headers or HTML <span class="term">meta</span> tags, this can permit an exploit (like Google's UTF-7/XSS vulnerability of the past).<br />
|
||
|
|
<br />
|
||
|
|
  *  Like any script using PHP's PCRE regex functions, PHP setup-specific low PCRE limit values can cause htmLawed to at least partially fail with very long input texts.<br />
|
||
|
|
|
||
|
|
</div>
|
||
|
|
<div class="sub-section"><h3>
|
||
|
|
<a name="s2.9" id="s2.9"></a><span class="item-no">2.9</span>  Examples of usage
|
||
|
|
</h3><span class="totop"><a href="#peak">(to top)</a></span><br style="clear: both;" />
|
||
|
|
<br />
|
||
|
|
  Safest, allowing only <em>safe</em> HTML markup --<br />
|
||
|
|
<br />
|
||
|
|
|
||
|
|
<code class="code">    $config = array('safe'=>1);</code>
|
||
|
|
<br />
|
||
|
|
|
||
|
|
<code class="code">    $out = htmLawed($in);</code>
|
||
|
|
<br />
|
||
|
|
<br />
|
||
|
|
  Simplest, allowing all valid HTML markup except <span class="term">javascript:</span> --<br />
|
||
|
|
<br />
|
||
|
|
|
||
|
|
<code class="code">    $out = htmLawed($in);</code>
|
||
|
|
<br />
|
||
|
|
<br />
|
||
|
|
  Allowing all valid HTML markup including <span class="term">javascript:</span> --<br />
|
||
|
|
<br />
|
||
|
|
|
||
|
|
<code class="code">    $config = array('schemes'=>'*:*');</code>
|
||
|
|
<br />
|
||
|
|
|
||
|
|
<code class="code">    $out = htmLawed($in, $config);</code>
|
||
|
|
<br />
|
||
|
|
<br />
|
||
|
|
  Allowing only <span class="term">safe</span> HTML and the elements <span class="term">a</span>, <span class="term">em</span>, and <span class="term">strong</span> --<br />
|
||
|
|
<br />
|
||
|
|
|
||
|
|
<code class="code">    $config = array('safe'=>1, 'elements'=>'a, em, strong');</code>
|
||
|
|
<br />
|
||
|
|
|
||
|
|
<code class="code">    $out = htmLawed($in, $config);</code>
|
||
|
|
<br />
|
||
|
|
<br />
|
||
|
|
  Not allowing elements <span class="term">script</span> and <span class="term">object</span> --<br />
|
||
|
|
<br />
|
||
|
|
|
||
|
|
<code class="code">    $config = array('elements'=>'* -script -object');</code>
|
||
|
|
<br />
|
||
|
|
|
||
|
|
<code class="code">    $out = htmLawed($in, $config);</code>
|
||
|
|
<br />
|
||
|
|
<br />
|
||
|
|
  Not allowing attributes <span class="term">id</span> and <span class="term">style</span> --<br />
|
||
|
|
<br />
|
||
|
|
|
||
|
|
<code class="code">    $config = array('deny_attribute'=>'id, style');</code>
|
||
|
|
<br />
|
||
|
|
|
||
|
|
<code class="code">    $out = htmLawed($in, $config);</code>
|
||
|
|
<br />
|
||
|
|
<br />
|
||
|
|
  Permitting only attributes <span class="term">title</span> and <span class="term">href</span> --<br />
|
||
|
|
<br />
|
||
|
|
|
||
|
|
<code class="code">    $config = array('deny_attribute'=>'* -title -href');</code>
|
||
|
|
<br />
|
||
|
|
|
||
|
|
<code class="code">    $out = htmLawed($in, $config);</code>
|
||
|
|
<br />
|
||
|
|
<br />
|
||
|
|
  Remove bad/disallowed tags altogether instead of converting them to entities --<br />
|
||
|
|
<br />
|
||
|
|
|
||
|
|
<code class="code">    $config = array('keep_bad'=>0);</code>
|
||
|
|
<br />
|
||
|
|
|
||
|
|
<code class="code">    $out = htmLawed($in, $config);</code>
|
||
|
|
<br />
|
||
|
|
<br />
|
||
|
|
  Allowing attribute <span class="term">title</span> only in <span class="term">a</span> and not allowing attributes <span class="term">id</span>, <span class="term">style</span>, or scriptable <em>on*</em> attributes like <span class="term">onclick</span> --<br />
|
||
|
|
<br />
|
||
|
|
|
||
|
|
<code class="code">    $config = array('deny_attribute'=>'title, id, style, on*');</code>
|
||
|
|
<br />
|
||
|
|
|
||
|
|
<code class="code">    $spec = 'a=title';</code>
|
||
|
|
<br />
|
||
|
|
|
||
|
|
<code class="code">    $out = htmLawed($in, $config, $spec);</code>
|
||
|
|
<br />
|
||
|
|
<br />
|
||
|
|
  Some case-studies are presented below.<br />
|
||
|
|
<br />
|
||
|
|
  <strong>1.</strong> A blog administrator wants to allow only <span class="term">a</span>, <span class="term">em</span>, <span class="term">strike</span>, <span class="term">strong</span> and <span class="term">u</span> in comments, but needs <span class="term">strike</span> and <span class="term">u</span> transformed to <span class="term">span</span> for better XHTML 1-strict compliance, and, he wants the <span class="term">a</span> links to be to <span class="term">http</span> or <span class="term">https</span> resources:<br />
|
||
|
|
<br />
|
||
|
|
|
||
|
|
<code class="code">    $processed = htmLawed($in, array('elements'=>'a, em, strike, strong, u', 'make_tag_strict'=>1, 'safe'=>1, 'schemes'=>'*:http, https'), 'a=href');</code>
|
||
|
|
<br />
|
||
|
|
<br />
|
||
|
|
  <strong>2.</strong> An author uses a custom-made web application to load content on his web-site. He is the only one using that application and the content he generates has all types of HTML, including scripts. The web application uses htmLawed primarily as a tool to correct errors that creep in while writing HTML and to take care of the occasional <em>bad</em> characters in copy-paste text introduced by Microsoft Office. The web application provides a preview before submitted input is added to the content. For the previewing process, htmLawed is set up as follows:<br />
|
||
|
|
<br />
|
||
|
|
|
||
|
|
<code class="code">    $processed = htmLawed($in, array('css_expression'=>1, 'keep_bad'=>1, 'make_tag_strict'=>1, 'schemes'=>'*:*', 'valid_xhtml'=>1));</code>
|
||
|
|
<br />
|
||
|
|
<br />
|
||
|
|
  For the final submission process, <span class="term">keep_bad</span> is set to <span class="term">6</span>. A value of <span class="term">1</span> for the preview process allows the author to note and correct any HTML mistake without losing any of the typed text.<br />
|
||
|
|
<br />
|
||
|
|
  <strong>3.</strong> A data-miner is scraping information in a specific table of similar web-pages and is collating the data rows, and uses htmLawed to reduce unnecessary markup and white-spaces:<br />
|
||
|
|
<br />
|
||
|
|
|
||
|
|
<code class="code">    $processed = htmLawed($in, array('elements'=>'tr, td', 'tidy'=>-1), 'tr, td =');</code>
|
||
|
|
<br />
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<div class="section"><h2>
|
||
|
|
<a name="s3" id="s3"></a><span class="item-no">3</span>  Details
|
||
|
|
</h2><span class="totop"><a href="#peak">(to top)</a></span><br style="clear: both;" />
|
||
|
|
<div class="sub-section"><h3>
|
||
|
|
<a name="s3.1" id="s3.1"></a><span class="item-no">3.1</span>  Invalid/dangerous characters
|
||
|
|
</h3><span class="totop"><a href="#peak">(to top)</a></span><br style="clear: both;" />
|
||
|
|
<br />
|
||
|
|
  Valid characters (more correctly, their code-points) in HTML or XML are, hexadecimally, <span class="term">9</span>, <span class="term">a</span>, <span class="term">d</span>, <span class="term">20</span> to <span class="term">d7ff</span>, and <span class="term">e000</span> to <span class="term">10ffff</span>, except <span class="term">fffe</span> and <span class="term">ffff</span> (decimally, <span class="term">9</span>, <span class="term">10</span>, <span class="term">13</span>, <span class="term">32</span> to <span class="term">55295</span>, and <span class="term">57344</span> to <span class="term">1114111</span>, except <span class="term">65534</span> and <span class="term">65535</span>). htmLawed removes the invalid characters <span class="term">0</span> to <span class="term">8</span>, <span class="term">b</span>, <span class="term">c</span>, and <span class="term">e</span> to <span class="term">1f</span>.<br />
|
||
|
|
<br />
|
||
|
|
  Because of PHP's poor native support for multi-byte characters, htmLawed cannot check for the remaining invalid code-points. However, for various reasons, it is very unlikely for any of those characters to be in the input.<br />
|
||
|
|
<br />
|
||
|
|
  Characters that are discouraged (see <a href="#s5.1">section 5.1</a>) but not invalid are not removed by htmLawed.<br />
|
||
|
|
<br />
|
||
|
|
  It (function <span class="term">hl_tag()</span>) also replaces the potentially dangerous (in some Mozilla [Firefox] and Opera browsers) soft-hyphen character (code-point, hexadecimally, <span class="term">ad</span>, or decimally, <span class="term">173</span>) in attribute values with spaces. Where required, the characters <span class="term"><</span>, <span class="term">></span>, <span class="term">&</span>, and <span class="term">"</span> are converted to entities.<br />
|
||
|
|
<br />
|
||
|
|
  With <span class="term">$config["clean_ms_char"]</span> set as <span class="term">1</span> or <span class="term">2</span>, many of the discouraged characters (decimal code-points <span class="term">127</span> to <span class="term">159</span> except <span class="term">133</span>) that many Microsoft applications incorrectly use (as per the <span class="term">Windows 1252</span> [<span class="term">Cp-1252</span>] or a similar encoding system), and the character for decimal code-point <span class="term">133</span>, are converted to appropriate decimal numerical entities (or removed for a few cases)-- see appendix in <a href="#s5.4">section 5.4</a>. This can help avoid some display issues arising from copying-pasting of content.<br />
|
||
|
|
<br />
|
||
|
|
  With <span class="term">$config["clean_ms_char"]</span> set as <span class="term">2</span>, characters for the hexadecimal code-points <span class="term">82</span>, <span class="term">91</span>, and <span class="term">92</span> (for special single-quotes), and <span class="term">84</span>, <span class="term">93</span>, and <span class="term">94</span> (for special double-quotes) are converted to ordinary single and double quotes respectively and not to entities.<br />
|
||
|
|
<br />
|
||
|
|
  The character values are replaced with entities/characters and not character values referred to by the entities/characters to keep this task independent of the character-encoding of input text.<br />
|
||
|
|
<br />
|
||
|
|
  The <span class="term">$config["clean_ms_char"]</span> parameter should not be used if authors do not copy-paste Microsoft-created text, or if the input text is not believed to use the <span class="term">Windows 1252</span> (<span class="term">Cp-1252</span>) or a similar encoding like <span class="term">Cp-1251</span>. Further, the input form and the web-pages displaying it or its content should have the character encoding appropriately marked-up.<br />
|
||
|
|
|
||
|
|
</div>
|
||
|
|
<div class="sub-section"><h3>
|
||
|
|
<a name="s3.2" id="s3.2"></a><span class="item-no">3.2</span>  Character references/entities
|
||
|
|
</h3><span class="totop"><a href="#peak">(to top)</a></span><br style="clear: both;" />
|
||
|
|
<br />
|
||
|
|
  Valid character entities take the form <span class="term">&*;</span> where <span class="term">*</span> is <span class="term">#x</span> followed by a hexadecimal number (hexadecimal numeric entity; like <span class="term">&#xA0;</span> for non-breaking space), or alphanumeric like <span class="term">gt</span> (external or named entity; like <span class="term">&nbsp;</span> for non-breaking space), or <span class="term">#</span> followed by a number (decimal numeric entity; like <span class="term">&#160;</span> for non-breaking space). Character entities referring to the soft-hyphen character (the <span class="term">&shy;</span> or <span class="term">\xad</span> character; hexadecimal code-point <span class="term">ad</span> [decimal <span class="term">173</span>]) in URL-accepting attribute values are always replaced with spaces; soft-hyphens in attribute values introduce vulnerabilities in some older versions of the Opera and Mozilla [Firefox] browsers.<br />
|
||
|
|
<br />
|
||
|
|
  htmLawed (function <span class="term">hl_ent()</span>):<br />
|
||
|
|
<br />
|
||
|
|
  *  Neutralizes entities with multiple leading zeroes or missing semi-colons (potentially dangerous)<br />
|
||
|
|
<br />
|
||
|
|
  *  Lowercases the <span class="term">X</span> (for XML-compliance) and <span class="term">A-F</span> of hexadecimal numeric entities<br />
|
||
|
|
<br />
|
||
|
|
  *  Neutralizes entities referring to characters that are HTML-invalid (see <a href="#s3.1">section 3.1</a>)<br />
|
||
|
|
<br />
|
||
|
|
  *  Neutralizes entities referring to characters that are HTML-discouraged (code-points, hexadecimally, <span class="term">7f</span> to <span class="term">84</span>, <span class="term">86</span> to <span class="term">9f</span>, and <span class="term">fdd0</span> to <span class="term">fddf</span>, or decimally, <span class="term">127</span> to <span class="term">132</span>, <span class="term">134</span> to <span class="term">159</span>, and <span class="term">64991</span> to <span class="term">64976</span>). Entities referring to the remaining discouraged characters (see <a href="#s5.1">section 5.1</a> for a full list) are let through.<br />
|
||
|
|
<br />
|
||
|
|
  *  Neutralizes named entities that are not in the specs.<br />
|
||
|
|
<br />
|
||
|
|
  *  Optionally converts valid HTML-specific named entities except <span class="term">&gt;</span>, <span class="term">&lt;</span>, <span class="term">&quot;</span>, and <span class="term">&amp;</span> to decimal numeric ones (hexadecimal if $config["hexdec_entity"] is <span class="term">2</span>) for generic XML-compliance. For this, <span class="term">$config["named_entity"]</span> should be <span class="term">1</span>.<br />
|
||
|
|
<br />
|
||
|
|
  *  Optionally converts hexadecimal numeric entities to the more widely supported decimal ones. For this, <span class="term">$config["hexdec_entity"]</span> should be <span class="term">0</span>.<br />
|
||
|
|
<br />
|
||
|
|
  *  Optionally converts decimal numeric entities to the hexadecimal ones. For this, <span class="term">$config["hexdec_entity"]</span> should be <span class="term">2</span>.<br />
|
||
|
|
<br />
|
||
|
|
  <em>Neutralization</em> refers to the <em>entitification</em> of <span class="term">&</span> to <span class="term">&amp;</span>.<br />
|
||
|
|
<br />
|
||
|
|
  <strong>Note</strong>: htmLawed does not convert entities to the actual characters represented by them; one can pass the htmLawed output through PHP's <span class="term">html_entity_decode</span> <a href="http://www.php.net/html_entity_decode">function</a> for that.<br />
|
||
|
|
<br />
|
||
|
|
  <strong>Note</strong>: If <span class="term">$config["and_mark"]</span> is set, and set to a value other than <span class="term">0</span>, then the <span class="term">&</span> characters in the original input are replaced with the control character for the hexadecimal code-point <span class="term">6</span> (<span class="term">\x06</span>; <span class="term">&</span> characters introduced by htmLawed, e.g., after converting <span class="term"><</span> to <span class="term">&lt;</span>, are not affected). This allows one to distinguish, say, an <span class="term">&gt;</span> introduced by htmLawed and an <span class="term">&gt;</span> put in by the input writer, and can be helpful in further processing of the htmLawed-processed text (e.g., to identify the character sequence <span class="term">o(><)o</span> to generate an emoticon image). When this feature is active, admins should ensure that the htmLawed output is not directly used in web pages or XML documents as the presence of the <span class="term">\x06</span> can break documents. Before use in such documents, and preferably before any storage, any remaining <span class="term">\x06</span> should be changed back to <span class="term">&</span>, e.g., with:<br />
|
||
|
|
<br />
|
||
|
|
|
||
|
|
<code class="code">    $final = str_replace("\x06", '&', $prelim);</code>
|
||
|
|
<br />
|
||
|
|
<br />
|
||
|
|
  Also, see <a href="#s3.9">section 3.9</a>.<br />
|
||
|
|
|
||
|
|
</div>
|
||
|
|
<div class="sub-section"><h3>
|
||
|
|
<a name="s3.3" id="s3.3"></a><span class="item-no">3.3</span>  HTML elements
|
||
|
|
</h3><span class="totop"><a href="#peak">(to top)</a></span><br style="clear: both;" />
|
||
|
|
<br />
|
||
|
|
  htmLawed can be configured to allow only certain HTML elements (tags) in the input. Disallowed elements (just tag-content, and not element-content), based on <span class="term">$config["keep_bad"]</span>, are either <em>neutralized</em> (converted to plain text by entitification of <span class="term"><</span> and <span class="term">></span>) or removed.<br />
|
||
|
|
<br />
|
||
|
|
  E.g., with only <span class="term">em</span> permitted:<br />
|
||
|
|
<br />
|
||
|
|
  Input:<br />
|
||
|
|
<br />
|
||
|
|
|
||
|
|
<code class="code">      <em>My</em> website is <a href="http://a.com>a.com</a>.</code>
|
||
|
|
<br />
|
||
|
|
<br />
|
||
|
|
  Output, with <span class="term">$config["keep_bad"] = 0</span>:<br />
|
||
|
|
<br />
|
||
|
|
|
||
|
|
<code class="code">      <em>My</em> website is a.com.</code>
|
||
|
|
<br />
|
||
|
|
<br />
|
||
|
|
  Output, with <span class="term">$config["keep_bad"]</span> not <span class="term">0</span>:<br />
|
||
|
|
<br />
|
||
|
|
|
||
|
|
<code class="code">      <em>My</em> website is &lt;a href=""&gt;a.com&lt;/a&gt;.</code>
|
||
|
|
<br />
|
||
|
|
<br />
|
||
|
|
  See <a href="#s3.3.3">section 3.3.3</a> for differences between the various non-zero <span class="term">$config["keep_bad"]</span> values.<br />
|
||
|
|
<br />
|
||
|
|
  htmLawed by default permits these 86 elements:<br />
|
||
|
|
<br />
|
||
|
|
|
||
|
|
<code class="code">    a, abbr, acronym, address, applet, area, b, bdo, big, blockquote, br, button, caption, center, cite, code, col, colgroup, dd, del, dfn, dir, div, dl, dt, em, embed, fieldset, font, form, h1, h2, h3, h4, h5, h6, hr, i, iframe, img, input, ins, isindex, kbd, label, legend, li, map, menu, noscript, object, ol, optgroup, option, p, param, pre, q, rb, rbc, rp, rt, rtc, ruby, s, samp, script, select, small, span, strike, strong, sub, sup, table, tbody, td, textarea, tfoot, th, thead, tr, tt, u, ul, var</code>
|
||
|
|
<br />
|
||
|
|
<br />
|
||
|
|
  Except for <span class="term">embed</span> (included because of its wide-spread use) and the Ruby elements (<span class="term">rb</span>, <span class="term">rbc</span>, <span class="term">rp</span>, <span class="term">rt</span>, <span class="term">rtc</span>, <span class="term">ruby</span>; part of XHTML 1.1), these are all the elements in the HTML 4/XHTML 1 specs. Strict-specific specs. exclude <span class="term">center</span>, <span class="term">dir</span>, <span class="term">font</span>, <span class="term">isindex</span>, <span class="term">menu</span>, <span class="term">s</span>, <span class="term">strike</span>, and <span class="term">u</span>.<br />
|
||
|
|
<br />
|
||
|
|
  With <span class="term">$config["safe"] = 1</span>, the default set will exclude <span class="term">applet</span>, <span class="term">embed</span>, <span class="term">iframe</span>, <span class="term">object</span> and <span class="term">script</span>; see <a href="#s3.6">section 3.6</a>.<br />
|
||
|
|
<br />
|
||
|
|
  When <span class="term">$config["elements"]</span>, which specifies allowed elements, is <em>properly</em> defined, and neither empty nor set to <span class="term">0</span> or <span class="term">*</span>, the default set is not used. To have elements added to or removed from the default set, a <span class="term">+/-</span> notation is used. E.g., <span class="term">*-script-object</span> implies that only <span class="term">script</span> and <span class="term">object</span> are disallowed, whereas <span class="term">*+embed</span> means that <span class="term">noembed</span> is also allowed. Elements can also be specified as comma separated names. E.g., <span class="term">a, b, i</span> means only <span class="term">a</span>, <span class="term">b</span> and <span class="term">i</span> are permitted. In this notation, <span class="term">*</span>, <span class="term">+</span> and <span class="term">-</span> have no significance and can actually cause a mis-reading.<br />
|
||
|
|
<br />
|
||
|
|
  Some more examples of <span class="term">$config["elements"]</span> values indicating permitted elements (note that empty spaces are liberally allowed for clarity):<br />
|
||
|
|
<br />
|
||
|
|
  *  <span class="term">a, blockquote, code, em, strong</span> -- only <span class="term">a</span>, <span class="term">blockquote</span>, <span class="term">code</span>, <span class="term">em</span>, and <span class="term">strong</span><br />
|
||
|
|
  *  <span class="term">*-script</span> -- all excluding <span class="term">script</span><br />
|
||
|
|
  *  <span class="term">* -center -dir -font -isindex -menu -s -strike -u</span> -- only XHTML-Strict elements<br />
|
||
|
|
  *  <span class="term">*+noembed-script</span> -- all including <span class="term">noembed</span> excluding <span class="term">script</span><br />
|
||
|
|
<br />
|
||
|
|
  Some mis-usages (and the resulting permitted elements) that can be avoided:<br />
|
||
|
|
<br />
|
||
|
|
  *  <span class="term">-*</span> -- none; instead of htmLawed, one might just use, e.g., the <span class="term">htmlspecialchars()</span> PHP function<br />
|
||
|
|
  *  <span class="term">*, -script</span> -- all except <span class="term">script</span>; admin probably meant <span class="term">*-script</span><br />
|
||
|
|
  *  <span class="term">-*, a, em, strong</span> -- all; admin probably meant <span class="term">a, em, strong</span><br />
|
||
|
|
  *  <span class="term">*</span> -- all; admin need not have set <span class="term">elements</span><br />
|
||
|
|
  *  <span class="term">*-form+form</span> -- all; a <span class="term">+</span> will always over-ride any <span class="term">-</span><br />
|
||
|
|
  *  <span class="term">*, noembed</span> -- only <span class="term">noembed</span>; admin probably meant <span class="term">*+noembed</span><br />
|
||
|
|
  *  <span class="term">a, +b, i</span> -- only <span class="term">a</span> and <span class="term">i</span>; admin probably meant <span class="term">a, b, i</span><br />
|
||
|
|
<br />
|
||
|
|
  Basically, when using the <span class="term">+/-</span> notation, commas (<span class="term">,</span>) should not be used, and vice versa, and <span class="term">*</span> should be used with the former but not the latter.<br />
|
||
|
|
<br />
|
||
|
|
  <strong>Note</strong>: Even if an element that is not in the default set is allowed through <span class="term">$config["elements"]</span>, like <span class="term">noembed</span> in the last example, it will eventually be removed during tag balancing unless such balancing is turned off (<span class="term">$config["balance"]</span> set to <span class="term">0</span>). Currently, the only way around this, which actually is simple, is to edit the various arrays in the function <span class="term">hl_bal()</span> to accommodate the element and its nesting properties.<br />
|
||
|
|
<br />
|
||
|
|
  <strong>A possibly second way to specify allowed elements</strong> is to set <span class="term">$config["parent"]</span> to an element name that supposedly will hold the input, and to set <span class="term">$config["balance"]</span> to <span class="term">1</span>. During tag balancing (see <a href="#s3.3.3">section 3.3.3</a>), all elements that cannot legally nest inside the parent element will be removed. The parent element is auto-reset to <span class="term">div</span> if <span class="term">$config["parent"]</span> is empty, <span class="term">body</span>, or an element not in htmLawed's default set of 86 elements.<br />
|
||
|
|
<br />
|
||
|
|
  <em>Tag transformation</em> is possible for improving XHTML-Strict compliance -- most of the deprecated elements are removed or converted to valid XHTML-Strict ones; see <a href="#s3.3.2">section 3.3.2</a>.<br />
|
||
|
|
|
||
|
|
<div class="sub-sub-section"><h4>
|
||
|
|
<a name="s3.3.1" id="s3.3.1"></a><span class="item-no">3.3.1</span>  Handling of comments and CDATA sections
|
||
|
|
</h4><span class="totop"><a href="#peak">(to top)</a></span><br style="clear: both;" />
|
||
|
|
<br />
|
||
|
|
  <span class="term">CDATA</span> sections have the format <span class="term"><![CDATA[...anything but not "]]>"...]]></span>, and HTML comments, <span class="term"><!--...anything but not "-->"... --></span>. Neither HTML comments nor <span class="term">CDATA</span> sections can reside inside tags. HTML comments can exist anywhere else, but <span class="term">CDATA</span> sections can exist only where plain text is allowed (e.g., immediately inside <span class="term">td</span> element content but not immediately inside <span class="term">tr</span> element content).<br />
|
||
|
|
<br />
|
||
|
|
  htmLawed (function <span class="term">hl_cmtcd()</span>) handles HTML comments or <span class="term">CDATA</span> sections depending on the values of <span class="term">$config["comment"]</span> or <span class="term">$config["cdata"]</span>. If <span class="term">0</span>, such markup is not looked for and the text is processed like plain text. If <span class="term">1</span>, it is removed completely. If <span class="term">2</span>, it is preserved but any <span class="term"><</span>, <span class="term">></span> and <span class="term">&</span> inside are changed to entities. If <span class="term">3</span>, they are left as such.<br />
|
||
|
|
<br />
|
||
|
|
  Note that for the last two cases, HTML comments and <span class="term">CDATA</span> sections will always be removed from tag content (function <span class="term">hl_tag()</span>).<br />
|
||
|
|
<br />
|
||
|
|
  Examples:<br />
|
||
|
|
<br />
|
||
|
|
  Input:<br />
|
||
|
|
|
||
|
|
<code class="code">    <!-- home link --><a href="home.htm"><![CDATA[x=&y]]>Home</a></code>
|
||
|
|
<br />
|
||
|
|
  Output (<span class="term">$config["comment"] = 0, $config["cdata"] = 2</span>):<br />
|
||
|
|
|
||
|
|
<code class="code">    &lt;-- home link --&gt;<a href="home.htm"><![CDATA[x=&amp;y]]>Home</a></code>
|
||
|
|
<br />
|
||
|
|
  Output (<span class="term">$config["comment"] = 1, $config["cdata"] = 2</span>):<br />
|
||
|
|
|
||
|
|
<code class="code">    <a href="home.htm"><![CDATA[x=&amp;y]]>Home</a></code>
|
||
|
|
<br />
|
||
|
|
  Output (<span class="term">$config["comment"] = 2, $config["cdata"] = 2</span>):<br />
|
||
|
|
|
||
|
|
<code class="code">    <!-- home link --><a href="home.htm"><![CDATA[x=&amp;y]]>Home</a></code>
|
||
|
|
<br />
|
||
|
|
  Output (<span class="term">$config["comment"] = 2, $config["cdata"] = 1</span>):<br />
|
||
|
|
|
||
|
|
<code class="code">    <!-- home link --><a href="home.htm">Home</a></code>
|
||
|
|
<br />
|
||
|
|
  Output (<span class="term">$config["comment"] = 3, $config["cdata"] = 3</span>):<br />
|
||
|
|
|
||
|
|
<code class="code">    <!-- home link --><a href="home.htm"><![CDATA[x=&y]]>Home</a></code>
|
||
|
|
<br />
|
||
|
|
<br />
|
||
|
|
  For standard-compliance, comments are given the form <span class="term"><!--comment --></span>, and any <span class="term">--</span> in the content is made <span class="term">-</span>.<br />
|
||
|
|
<br />
|
||
|
|
  When <span class="term">$config["safe"] = 1</span>, CDATA sections and comments are considered plain text unless <span class="term">$config["comment"]</span> or <span class="term">$config["cdata"]</span> is explicitly specified; see <a href="#s3.6">section 3.6</a>.<br />
|
||
|
|
|
||
|
|
</div>
|
||
|
|
<div class="sub-sub-section"><h4>
|
||
|
|
<a name="s3.3.2" id="s3.3.2"></a><span class="item-no">3.3.2</span>  Tag-transformation for better XHTML-Strict
|
||
|
|
</h4><span class="totop"><a href="#peak">(to top)</a></span><br style="clear: both;" />
|
||
|
|
<br />
|
||
|
|
  If <span class="term">$config["make_tag_strict"]</span> is set and not <span class="term">0</span>, following non-XHTML-Strict elements (and attributes), even if admin-permitted, are mutated as indicated (element content remains intact; function <span class="term">hl_tag2()</span>):<br />
|
||
|
|
<br />
|
||
|
|
  *  applet - (based on <span class="term">$config["make_tag_strict"]</span>, unchanged (<span class="term">1</span>) or removed (<span class="term">2</span>))<br />
|
||
|
|
  *  center - <span class="term">div style="text-align: center;"</span><br />
|
||
|
|
  *  dir - <span class="term">ul</span><br />
|
||
|
|
  *  embed - (based on <span class="term">$config["make_tag_strict"]</span>, unchanged (<span class="term">1</span>) or removed (<span class="term">2</span>))<br />
|
||
|
|
  *  font (face, size, color) -    <span class="term">span style="font-family: ; font-size: ; color: ;"</span> (size transformation <a href="http://style.cleverchimp.com/font_size_intervals/altintervals.html">reference</a>)<br />
|
||
|
|
  *  isindex - (based on <span class="term">$config["make_tag_strict"]</span>, unchanged (<span class="term">1</span>) or removed (<span class="term">2</span>))<br />
|
||
|
|
  *  menu - <span class="term">ul</span><br />
|
||
|
|
  *  s - <span class="term">span style="text-decoration: line-through;"</span><br />
|
||
|
|
  *  strike - <span class="term">span style="text-decoration: line-through;"</span><br />
|
||
|
|
  *  u - <span class="term">span style="text-decoration: underline;"</span><br />
|
||
|
|
<br />
|
||
|
|
  For an element with a pre-existing <span class="term">style</span> attribute value, the extra style properties are appended.<br />
|
||
|
|
<br />
|
||
|
|
  Example input:<br />
|
||
|
|
<br />
|
||
|
|
|
||
|
|
<code class="code">    <center></code>
|
||
|
|
<br />
|
||
|
|
|
||
|
|
<code class="code">     The PHP <s>software</s> script used for this <strike>web-page</strike> web-page is <font style="font-weight: bold " face=arial size='+3' color   =  "red  ">htmLawedTest.php</font>, from <u style= 'color:green'>PHP Labware</u>.</code>
|
||
|
|
<br />
|
||
|
|
|
||
|
|
<code class="code">    </center></code>
|
||
|
|
<br />
|
||
|
|
<br />
|
||
|
|
  The output:<br />
|
||
|
|
<br />
|
||
|
|
|
||
|
|
<code class="code">    <div style="text-align: center;"></code>
|
||
|
|
<br />
|
||
|
|
|
||
|
|
<code class="code">     The PHP <span style="text-decoration: line-through;">software</span> script used for this <span style="text-decoration: line-through;">web-page</span> web-page is <span style="font-weight: bold; font-family: arial; color: red; font-size: 200%;">htmLawedTest.php</span>, from <span style="color:green; text-decoration: underline;">PHP Labware</span>.</code>
|
||
|
|
<br />
|
||
|
|
|
||
|
|
<code class="code">    </div></code>
|
||
|
|
<br />
|
||
|
|
|
||
|
|
</div>
|
||
|
|
<div class="sub-section"><h3>
|
||
|
|
<a name="s3.3.3" id="s3.3.3"></a><span class="item-no">3.3.3</span>  Tag balancing and proper nesting
|
||
|
|
</h3><span class="totop"><a href="#peak">(to top)</a></span><br style="clear: both;" />
|
||
|
|
<br />
|
||
|
|
  If <span class="term">$config["balance"]</span> is set to <span class="term">1</span>, htmLawed (function <span class="term">hl_bal()</span>) checks and corrects the input to have properly balanced tags and legal element content (i.e., any element nesting should be valid, and plain text may be present only in the content of elements that allow them).<br />
|
||
|
|
<br />
|
||
|
|
  Depending on the value of <span class="term">$config["keep_bad"]</span> (see <a href="#s2.2">section 2.2</a> and <a href="#s3.3">section 3.3</a>), illegal content may be removed or neutralized to plain text by converting < and > to entities:<br />
|
||
|
|
<br />
|
||
|
|
  <span class="term">0</span> - remove; this option is available only to maintain Kses-compatibility and should not be used otherwise (see <a href="#s2.6">section 2.6</a>)<br />
|
||
|
|
  <span class="term">1</span> - neutralize tags and keep element content<br />
|
||
|
|
  <span class="term">2</span> - remove tags but keep element content<br />
|
||
|
|
  <span class="term">3</span> and <span class="term">4</span> - like <span class="term">1</span> and <span class="term">2</span>, but keep element content only if text (<span class="term">pcdata</span>) is valid in parent element as per specs<br />
|
||
|
|
  <span class="term">5</span> and <span class="term">6</span> -  like <span class="term">3</span> and <span class="term">4</span>, but line-breaks, tabs and spaces are left<br />
|
||
|
|
<br />
|
||
|
|
  Example input (disallowing the <span class="term">p</span> element):<br />
|
||
|
|
<br />
|
||
|
|
|
||
|
|
<code class="code">    <*> Pseudo-tags <*></code>
|
||
|
|
<br />
|
||
|
|
|
||
|
|
<code class="code">    <xml>Non-HTML tag xml</xml></code>
|
||
|
|
<br />
|
||
|
|
|
||
|
|
<code class="code">    <p></code>
|
||
|
|
<br />
|
||
|
|
|
||
|
|
<code class="code">    Disallowed tag p</code>
|
||
|
|
<br />
|
||
|
|
|
||
|
|
<code class="code">    </p></code>
|
||
|
|
<br />
|
||
|
|
|
||
|
|
<code class="code">    <ul>Bad<li>OK</li></ul></code>
|
||
|
|
<br />
|
||
|
|
<br />
|
||
|
|
  The output with <span class="term">$config["keep_bad"] = 1</span>:<br />
|
||
|
|
<br />
|
||
|
|
|
||
|
|
<code class="code">    &lt;*&gt; Pseudo-tags &lt;*&gt;</code>
|
||
|
|
<br />
|
||
|
|
|
||
|
|
<code class="code">    &lt;xml&gt;Non-HTML tag xml&lt;/xml&gt;</code>
|
||
|
|
<br />
|
||
|
|
|
||
|
|
<code class="code">    &lt;p&gt;</code>
|
||
|
|
<br />
|
||
|
|
|
||
|
|
<code class="code">    Disallowed tag p</code>
|
||
|
|
<br />
|
||
|
|
|
||
|
|
<code class="code">    &lt;/p&gt;</code>
|
||
|
|
<br />
|
||
|
|
|
||
|
|
<code class="code">    <ul>Bad<li>OK</li></ul></code>
|
||
|
|
<br />
|
||
|
|
<br />
|
||
|
|
  The output with <span class="term">$config["keep_bad"] = 3</span>:<br />
|
||
|
|
<br />
|
||
|
|
|
||
|
|
<code class="code">    &lt;*&gt; Pseudo-tags &lt;*&gt;</code>
|
||
|
|
<br />
|
||
|
|
|
||
|
|
<code class="code">    &lt;xml&gt;Non-HTML tag xml&lt;/xml&gt;</code>
|
||
|
|
<br />
|
||
|
|
|
||
|
|
<code class="code">    &lt;p&gt;</code>
|
||
|
|
<br />
|
||
|
|
|
||
|
|
<code class="code">    Disallowed tag p</code>
|
||
|
|
<br />
|
||
|
|
|
||
|
|
<code class="code">    &lt;/p&gt;</code>
|
||
|
|
<br />
|
||
|
|
|
||
|
|
<code class="code">    <ul><li>OK</li></ul></code>
|
||
|
|
<br />
|
||
|
|
<br />
|
||
|
|
  The output with <span class="term">$config["keep_bad"] = 6</span>:<br />
|
||
|
|
<br />
|
||
|
|
|
||
|
|
<code class="code">    &lt;*&gt; Pseudo-tags &lt;*&gt;</code>
|
||
|
|
<br />
|
||
|
|
|
||
|
|
<code class="code">    Non-HTML tag xml</code>
|
||
|
|
<br />
|
||
|
|
<br />
|
||
|
|
|
||
|
|
<code class="code">    Disallowed tag p</code>
|
||
|
|
<br />
|
||
|
|
<br />
|
||
|
|
|
||
|
|
<code class="code">    <ul><li>OK</li></ul></code>
|
||
|
|
<br />
|
||
|
|
<br />
|
||
|
|
  An option like <span class="term">1</span> is useful, e.g., when a writer previews his submission, whereas one like <span class="term">3</span> is useful before content is finalized and made available to all.<br />
|
||
|
|
<br />
|
||
|
|
  <strong>Note:</strong> In the example above, unlike <span class="term"><*></span>, <span class="term"><xml></span> gets considered as a tag (even though there is no HTML element named <span class="term">xml</span>). In general, text matching the regular expression pattern <span class="term"><(/?)([a-zA-Z][a-zA-Z1-6]*)([^>]*?)\s?></span> is considered a tag (phrase enclosed by the angled brackets <span class="term"><</span> and <span class="term">></span>, and starting [with an optional slash preceding] with an alphanumeric word that starts with an alphabet...).<br />
|
||
|
|
<br />
|
||
|
|
  Nesting/content rules for each of the 86 elements in htmLawed's default set (see <a href="#s3.3">section 3.3</a>) are defined in function <span class="term">hl_bal()</span>. This means that if a non-standard element besides <span class="term">embed</span> is being permitted through <span class="term">$config["elements"]</span>, the element's tag content will end up getting removed if <span class="term">$config["balance"]</span> is set to <span class="term">1</span>.<br />
|
||
|
|
<br />
|
||
|
|
  Plain text and/or certain elements nested inside <span class="term">blockquote</span>, <span class="term">form</span>, <span class="term">map</span> and <span class="term">noscript</span> need to be in block-level elements. This point is often missed during manual writing of HTML code. htmLawed attempts to address this during balancing. E.g., if the parent container is set as <span class="term">form</span>, the input <span class="term">B:<input type="text" value="b" />C:<input type="text" value="c" /></span> is converted to <span class="term"><div>B:<input type="text" value="b" />C:<input type="text" value="c" /></div></span>.<br />
|
||
|
|
|
||
|
|
</div>
|
||
|
|
<div class="sub-section"><h3>
|
||
|
|
<a name="s3.3.4" id="s3.3.4"></a><span class="item-no">3.3.4</span>  Elements requiring child elements
|
||
|
|
</h3><span class="totop"><a href="#peak">(to top)</a></span><br style="clear: both;" />
|
||
|
|
<br />
|
||
|
|
  As per specs, the following elements require legal child elements nested inside them:<br />
|
||
|
|
<br />
|
||
|
|
|
||
|
|
<code class="code">    blockquote, dir, dl, form, map, menu, noscript, ol, optgroup, rbc, rtc, ruby, select, table, tbody, tfoot, thead, tr, ul</code>
|
||
|
|
<br />
|
||
|
|
<br />
|
||
|
|
  In some cases, the specs stipulate the number and/or the ordering of the child elements. A <span class="term">table</span> can have 0 or 1 <span class="term">caption</span>, <span class="term">tbody</span>, <span class="term">tfoot</span>, and <span class="term">thead</span>, but they must be in this order: <span class="term">caption</span>, <span class="term">thead</span>, <span class="term">tfoot</span>, <span class="term">tbody</span>.<br />
|
||
|
|
<br />
|
||
|
|
  htmLawed currently does not check for conformance to these rules. Note that any non-compliance in this regard will not introduce security vulnerabilities, crash browser applications, or affect the rendering of web-pages.<br />
|
||
|
|
<br />
|
||
|
|
  With <span class="term">$config["direct_list_nest"]</span> set to <span class="term">1</span>, htmLawed will allow direct nesting of an <span class="term">ol</span> or <span class="term">ul</span> list within another <span class="term">ol</span> or <span class="term">ul</span> without requiring the child list to be within an <span class="term">li</span> of the parent list. While this is not standard-compliant, directly nested lists are rendered properly by almost all browsers. The parameter <span class="term">$config["direct_list_nest"]</span> has no effect if tag-balancing (<a href="#s3.3.3">section 3.3.3</a>) is turned off.<br />
|
||
|
|
|
||
|
|
</div>
|
||
|
|
<div class="sub-section"><h3>
|
||
|
|
<a name="s3.3.5" id="s3.3.5"></a><span class="item-no">3.3.5</span>  Beautify or compact HTML
|
||
|
|
</h3><span class="totop"><a href="#peak">(to top)</a></span><br style="clear: both;" />
|
||
|
|
<br />
|
||
|
|
  By default, htmLawed will neither <em>beautify</em> HTML code by formatting it with indentations, etc., nor will it make it compact by removing un-needed white-space.(It does always properly white-space tag content.)<br />
|
||
|
|
<br />
|
||
|
|
  As per the HTML standards, spaces, tabs and line-breaks in web-pages (except those inside <span class="term">pre</span> elements) are all considered equivalent, and referred to as <em>white-spaces</em>. Browser applications are supposed to consider contiguous white-spaces as just a single space, and to disregard white-spaces trailing opening tags or preceding closing tags. This white-space <em>normalization</em> allows the use of text/code beautifully formatted with indentations and line-spacings for readability. Such <em>pretty</em> HTML can, however, increase the size of web-pages, or make the extraction or scraping of plain text cumbersome.<br />
|
||
|
|
<br />
|
||
|
|
  With the <span class="term">$config</span> parameter <span class="term">tidy</span>, htmLawed can be used to beautify or compact the input text. Input with just plain text and no HTML markup is also subject to this. Besides <span class="term">pre</span>, the <span class="term">script</span> and <span class="term">textarea</span> elements, CDATA sections, and HTML comments are not subjected to the tidying process.<br />
|
||
|
|
<br />
|
||
|
|
  To <em>compact</em>, use <span class="term">$config["tidy"] = -1</span>; single instances or runs of white-spaces are replaced with a single space, and white-spaces trailing and leading open and closing tags, respectively, are removed.<br />
|
||
|
|
<br />
|
||
|
|
  To <em>beautify</em>, <span class="term">$config["tidy"]</span> is set as <span class="term">1</span>, or for customized tidying, as a string like <span class="term">2s2n</span>. The <span class="term">s</span> or <span class="term">t</span> character specifies the use of spaces or tabs for indentation. The first and third characters, any of the digits 0-9, specify the number of spaces or tabs per indentation, and any parental lead spacing (extra indenting of the whole block of input text). The <span class="term">r</span> and <span class="term">n</span> characters are used to specify line-break characters: <span class="term">n</span> for <span class="term">\n</span> (Unix/Mac OS X line-breaks), <span class="term">rn</span> or <span class="term">nr</span> for <span class="term">\r\n</span> (Windows/DOS line-breaks), or <span class="term">r</span> for <span class="term">\r</span>.<br />
|
||
|
|
<br />
|
||
|
|
  The <span class="term">$config["tidy"]</span> value of <span class="term">1</span> is equivalent to <span class="term">2s0n</span>. Other <span class="term">$config["tidy"]</span> values are read loosely: a value of <span class="term">4</span> is equivalent to <span class="term">4s0n</span>; <span class="term">t2</span>, to <span class="term">1t2n</span>; <span class="term">s</span>, to <span class="term">2s0n</span>; <span class="term">2TR</span>, to <span class="term">2t0r</span>; <span class="term">T1</span>, to <span class="term">1t1n</span>; <span class="term">nr3</span>, to <span class="term">3s0nr</span>, and so on. Except in the indentations and line-spacings, runs of white-spaces are replaced with a single space during beautification.<br />
|
||
|
|
<br />
|
||
|
|
  Input formatting using <span class="term">$config["tidy"]</span> is not recommended when input text has mixed markup (like HTML + PHP).<br />
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<div class="sub-section"><h3>
|
||
|
|
<a name="s3.4" id="s3.4"></a><span class="item-no">3.4</span>  Attributes
|
||
|
|
</h3><span class="totop"><a href="#peak">(to top)</a></span><br style="clear: both;" />
|
||
|
|
<br />
|
||
|
|
  htmLawed will only permit attributes described in the HTML specs (including deprecated ones). It also permits some attributes for use with the <span class="term">embed</span> element (the non-standard <span class="term">embed</span> element is supported in htmLawed because of its widespread use), and the the <span class="term">xml:space</span> attribute (valid only in XHTML 1.1). A list of such 111 attributes and the elements they are allowed in is in <a href="#s5.2">section 5.2</a>.<br />
|
||
|
|
<br />
|
||
|
|
  When <span class="term">$config["deny_attribute"]</span> is not set, or set to <span class="term">0</span>, or empty (<span class="term">""</span>), all the 111 attributes are permitted. Otherwise, <span class="term">$config["deny_attribute"]</span> can be set as a list of comma-separated names of the denied attributes. <span class="term">on*</span> can be used to refer to the group of potentially dangerous, script-accepting attributes: <span class="term">onblur</span>, <span class="term">onchange</span>, <span class="term">onclick</span>, <span class="term">ondblclick</span>, <span class="term">onfocus</span>, <span class="term">onkeydown</span>, <span class="term">onkeypress</span>, <span class="term">onkeyup</span>, <span class="term">onmousedown</span>, <span class="term">onmousemove</span>, <span class="term">onmouseout</span>, <span class="term">onmouseover</span>, <span class="term">onmouseup</span>, <span class="term">onreset</span>, <span class="term">onselect</span> and <span class="term">onsubmit</span>.<br />
|
||
|
|
<br />
|
||
|
|
  Note that attributes specified in <span class="term">$config["deny_attribute"]</span> are denied globally, for all elements. To deny attributes for only specific elements, <span class="term">$spec</span> (see <a href="#s2.3">section 2.3</a>) can be used. <span class="term">$spec</span> can also be used to element-specifically permit an attribute otherwise denied through <span class="term">$config["deny_attribute"]</span>.<br />
|
||
|
|
<br />
|
||
|
|
  With <span class="term">$config["safe"] = 1</span> (<a href="#s3.6">section 3.6</a>), the <span class="term">on*</span> attributes are automatically disallowed.<br />
|
||
|
|
<br />
|
||
|
|
  <strong>Note</strong>: To deny all but a few attributes globally, a simpler way to specify <span class="term">$config["deny_attribute"]</span> would be to use the notation <span class="term">* -attribute1 -attribute2 ...</span>. Thus, a value of <span class="term">* -title -href</span> implies that except <span class="term">href</span> and <span class="term">title</span> (where allowed as per standards) all other attributes are to be removed. With this notation, the value for the parameter <span class="term">safe</span> (<a href="#s3.6">section 3.6</a>) will have no effect on <span class="term">deny_attribute</span>.<br />
|
||
|
|
<br />
|
||
|
|
  htmLawed (function <span class="term">hl_tag()</span>) also:<br />
|
||
|
|
<br />
|
||
|
|
  *  Lower-cases attribute names<br />
|
||
|
|
  *  Removes duplicate attributes (last one stays)<br />
|
||
|
|
  *  Gives attributes the form <span class="term">name="value"</span> and single-spaces them, removing unnecessary white-spacing<br />
|
||
|
|
  *  Provides <em>required</em> attributes (see <a href="#s3.4.1">section 3.4.1</a>)<br />
|
||
|
|
  *  Double-quotes values and escapes any <span class="term">"</span> inside them<br />
|
||
|
|
  *  Replaces the possibly dangerous soft-hyphen characters (hexadecimal code-point <span class="term">ad</span>) in the values with spaces<br />
|
||
|
|
  *  Allows custom function to additionally filter/modify attribute values (see <a href="#s3.4.9">section 3.4.9</a>)<br />
|
||
|
|
|
||
|
|
<div class="sub-sub-section"><h4>
|
||
|
|
<a name="s3.4.1" id="s3.4.1"></a><span class="item-no">3.4.1</span>  Auto-addition of XHTML-required attributes
|
||
|
|
</h4><span class="totop"><a href="#peak">(to top)</a></span><br style="clear: both;" />
|
||
|
|
<br />
|
||
|
|
  If indicated attributes for the following elements are found missing, htmLawed (function <span class="term">hl_tag()</span>) will add them (with values same as attribute names unless indicated otherwise below):<br />
|
||
|
|
<br />
|
||
|
|
  *  area - alt (<span class="term">area</span>)<br />
|
||
|
|
  *  area, img - src, alt (<span class="term">image</span>)<br />
|
||
|
|
  *  bdo - dir (<span class="term">ltr</span>)<br />
|
||
|
|
  *  form - action<br />
|
||
|
|
  *  map - name<br />
|
||
|
|
  *  optgroup - label<br />
|
||
|
|
  *  param - name<br />
|
||
|
|
  *  script - type (<span class="term">text/javascript</span>)<br />
|
||
|
|
  *  textarea - rows (<span class="term">10</span>), cols (<span class="term">50</span>)<br />
|
||
|
|
<br />
|
||
|
|
  Additionally, with <span class="term">$config["xml:lang"]</span> set to <span class="term">1</span> or <span class="term">2</span>, if the <span class="term">lang</span> but not the <span class="term">xml:lang</span> attribute is declared, then the latter is added too, with a value copied from that of <span class="term">lang</span>. This is for better standard-compliance. With <span class="term">$config["xml:lang"]</span> set to <span class="term">2</span>, the <span class="term">lang</span> attribute is removed (XHTML 1.1 specs).<br />
|
||
|
|
<br />
|
||
|
|
  Note that the <span class="term">name</span> attribute for <span class="term">map</span>, invalid in XHTML 1.1, is also transformed if required -- see <a href="#s3.4.6">section 3.4.6</a>.<br />
|
||
|
|
|
||
|
|
</div>
|
||
|
|
<div class="sub-sub-section"><h4>
|
||
|
|
<a name="s3.4.2" id="s3.4.2"></a><span class="item-no">3.4.2</span>  Duplicate/invalid <span class="term">id</span> values
|
||
|
|
</h4><span class="totop"><a href="#peak">(to top)</a></span><br style="clear: both;" />
|
||
|
|
<br />
|
||
|
|
  If <span class="term">$config["unique_ids"]</span> is <span class="term">1</span>, htmLawed (function <span class="term">hl_tag()</span>) removes <span class="term">id</span> attributes with values that are not XHTML-compliant (must begin with a letter and can contain letters, digits, <span class="term">:</span>, <span class="term">.</span>, <span class="term">-</span> and <span class="term">_</span>) or duplicate. If <span class="term">$config["unique_ids"]</span> is a word, any duplicate but otherwise valid value will be appropriately prefixed with the word to ensure its uniqueness. The word should begin with a letter and should contain only letters, numbers, <span class="term">:</span>, <span class="term">.</span>, <span class="term">_</span> and <span class="term">-</span>.<br />
|
||
|
|
<br />
|
||
|
|
  Even if multiple inputs need to be filtered (through multiple calls to htmLawed), htmLawed ensures uniqueness of <span class="term">id</span> values as it uses a global variable (<span class="term">$GLOBALS["hl_Ids"]</span> array). Further, an admin can restrict the use of certain <span class="term">id</span> values by presetting this variable before htmLawed is called into use. E.g.:<br />
|
||
|
|
<br />
|
||
|
|
|
||
|
|
<code class="code">    $GLOBALS['hl_Ids'] = array('top'=>1, 'bottom'=>1, 'myform'=>1); // id values not allowed in input</code>
|
||
|
|
<br />
|
||
|
|
|
||
|
|
<code class="code">    $processed = htmLawed($text); // filter input</code>
|
||
|
|
<br />
|
||
|
|
|
||
|
|
</div>
|
||
|
|
<div class="sub-sub-section"><h4>
|
||
|
|
<a name="s3.4.3" id="s3.4.3"></a><span class="item-no">3.4.3</span>  URL schemes (protocols) and scripts in attribute values
|
||
|
|
</h4><span class="totop"><a href="#peak">(to top)</a></span><br style="clear: both;" />
|
||
|
|
<br />
|
||
|
|
  htmLawed edits attributes that take URLs as values if they are found to contain un-permitted schemes. E.g., if the <span class="term">afp</span> scheme is not permitted, then <span class="term"><a href="afp://domain.org"></span> becomes <span class="term"><a href="denied:afp://domain.org"></span>, and if Javascript is not permitted <span class="term"><a onclick="javascript:xss();"></span> becomes <span class="term"><a onclick="denied:javascript:xss();"></span>.<br />
|
||
|
|
<br />
|
||
|
|
  By default htmLawed permits these schemes in URLs for the <span class="term">href</span> attribute:<br />
|
||
|
|
<br />
|
||
|
|
|
||
|
|
<code class="code">    aim, feed, file, ftp, gopher, http, https, irc, mailto, news, nntp, sftp, ssh, telnet</code>
|
||
|
|
<br />
|
||
|
|
<br />
|
||
|
|
  Also, only <span class="term">file</span>, <span class="term">http</span> and <span class="term">https</span> are permitted in attributes whose names start with <span class="term">o</span> (like <span class="term">onmouseover</span>), and in these attributes that accept URLs:<br />
|
||
|
|
<br />
|
||
|
|
|
||
|
|
<code class="code">    action, cite, classid, codebase, data, href, longdesc, model, pluginspage, pluginurl, src, style, usemap</code>
|
||
|
|
<br />
|
||
|
|
<br />
|
||
|
|
  These default sets are used when <span class="term">$config["schemes"]</span> is not set (see <a href="#s2.2">section 2.2</a>). To over-ride the defaults, <span class="term">$config["schemes"]</span> is defined as a string of semi-colon-separated sub-strings of type <span class="term">attribute: comma-separated schemes</span>. E.g., <span class="term">href: mailto, http, https; onclick: javascript; src: http, https</span>. For unspecified attributes, <span class="term">file</span>, <span class="term">http</span> and <span class="term">https</span> are permitted. This can be changed by passing schemes for <span class="term">*</span> in <span class="term">$config["schemes"]</span>. E.g., <span class="term">href: mailto, http, https; *: https, https</span>.<br />
|
||
|
|
<br />
|
||
|
|
  <span class="term">*</span> can be put in the list of schemes to permit all protocols. E.g., <span class="term">style: *; img: http, https</span> results in protocols not being checked in <span class="term">style</span> attribute values. However, in such cases, any relative-to-absolute URL conversion, or vice versa, (<a href="#s3.4.4">section 3.4.4</a>) is not done.<br />
|
||
|
|
<br />
|
||
|
|
  Thus, <em>to allow Javascript</em>, one can set <span class="term">$config["schemes"]</span> as <span class="term">href: mailto, http, https; *: http, https, javascript</span>, or <span class="term">href: mailto, http, https, javascript; *: http, https, javascript</span>, or <span class="term">*: *</span>, and so on.<br />
|
||
|
|
<br />
|
||
|
|
  As a side-note, one may find <span class="term">style: *</span> useful as URLs in <span class="term">style</span> attributes can be specified in a variety of ways, and the patterns that htmLawed uses to identify URLs may mistakenly identify non-URL text.<br />
|
||
|
|
<br />
|
||
|
|
  <span class="term">!</span> can be put in the list of schemes to disallow all protocols as well as <em>local</em> URLs. Thus, with <span class="term">href: http, style: !</span>, '<a href="http://cnn.com" style="background-image: url('local.jpg');">CNN</a>' will become '<a href="http://cnn.com" style="background-image: url('denied:local.jpg');">CNN</a>'.<br />
|
||
|
|
<br />
|
||
|
|
  <strong>Note</strong>: If URL-accepting attributes other than those listed above are being allowed, then the scheme will not be checked unless the attribute name contains the string <span class="term">src</span> (e.g., <span class="term">dynsrc</span>) or starts with <span class="term">o</span> (e.g., <span class="term">onbeforecopy</span>).<br />
|
||
|
|
<br />
|
||
|
|
  With <span class="term">$config["safe"] = 1</span>, all URLs are disallowed in the <span class="term">style</span> attribute values.<br />
|
||
|
|
|
||
|
|
</div>
|
||
|
|
<div class="sub-sub-section"><h4>
|
||
|
|
<a name="s3.4.4" id="s3.4.4"></a><span class="item-no">3.4.4</span>  Absolute & relative URLs in attribute values
|
||
|
|
</h4><span class="totop"><a href="#peak">(to top)</a></span><br style="clear: both;" />
|
||
|
|
<br />
|
||
|
|
  htmLawed can make absolute URLs in attributes like <span class="term">href</span> relative (<span class="term">$config["abs_url"]</span> is <span class="term">-1</span>), and vice versa (<span class="term">$config["abs_url"]</span> is <span class="term">1</span>). URLs in scripts are not considered for this, and so are URLs like <span class="term">#section_6</span> (fragment), <span class="term">?name=Tim#show</span> (starting with query string), and <span class="term">;var=1?name=Tim#show</span> (starting with parameters). Further, this requires that <span class="term">$config["base_url"]</span> be set properly, with the <span class="term">://</span> and a trailing slash (<span class="term">/</span>), with no query string, etc. E.g., <span class="term">file:///D:/page/</span>, <span class="term">https://abc.com/x/y/</span>, or <span class="term">http://localhost/demo/</span> are okay, but <span class="term">file:///D:/page/?help=1</span>, <span class="term">abc.com/x/y/</span> and <span class="term">http://localhost/demo/index.htm</span> are not.<br />
|
||
|
|
<br />
|
||
|
|
  For making absolute URLs relative, only those URLs that have the <span class="term">$config["base_url"]</span> string at the beginning are converted. E.g., with <span class="term">$config["base_url"] = "https://abc.com/x/y/"</span>, <span class="term">https://abc.com/x/y/a.gif</span> and <span class="term">https://abc.com/x/y/z/b.gif</span> become <span class="term">a.gif</span> and <span class="term">z/b.gif</span> respectively, while <span class="term">https://abc.com/x/c.gif</span> is not changed.<br />
|
||
|
|
<br />
|
||
|
|
  When making relative URLs absolute, only values for scheme, network location (host-name) and path values in the base URL are inherited. See <a href="#s5.5">section 5.5</a> for more about the URL specification as per RFC <a href="http://www.ietf.org/rfc/rfc1808.txt">1808</a>.<br />
|
||
|
|
|
||
|
|
</div>
|
||
|
|
<div class="sub-sub-section"><h4>
|
||
|
|
<a name="s3.4.5" id="s3.4.5"></a><span class="item-no">3.4.5</span>  Lower-cased, standard attribute values
|
||
|
|
</h4><span class="totop"><a href="#peak">(to top)</a></span><br style="clear: both;" />
|
||
|
|
<br />
|
||
|
|
  Optionally, for standard-compliance, htmLawed (function <span class="term">hl_tag()</span>) lower-cases standard attribute values to give, e.g., <span class="term">input type="password"</span> instead of <span class="term">input type="Password"</span>, if <span class="term">$config["lc_std_val"]</span> is <span class="term">1</span>. Attribute values matching those listed below for any of the elements (plus those for the <span class="term">type</span> attribute of <span class="term">button</span> or <span class="term">input</span>) are lower-cased:<br />
|
||
|
|
<br />
|
||
|
|
|
||
|
|
<code class="code">    all, baseline, bottom, button, center, char, checkbox, circle, col, colgroup, cols, data, default, file, get, groups, hidden, image, justify, left, ltr, middle, none, object, password, poly, post, preserve, radio, rect, ref, reset, right, row, rowgroup, rows, rtl, submit, text, top</code>
|
||
|
|
<br />
|
||
|
|
<br />
|
||
|
|
|
||
|
|
<code class="code">    a, area, bdo, button, col, form, img, input, object, option, optgroup, param, script, select, table, td, tfoot, th, thead, tr, xml:space</code>
|
||
|
|
<br />
|
||
|
|
<br />
|
||
|
|
  The following <em>empty</em> (<em>minimized</em>) attributes are always assigned lower-cased values (same as the names):<br />
|
||
|
|
<br />
|
||
|
|
|
||
|
|
<code class="code">    checked, compact, declare, defer, disabled, ismap, multiple, nohref, noresize, noshade, nowrap, readonly, selected</code>
|
||
|
|
<br />
|
||
|
|
|
||
|
|
</div>
|
||
|
|
<div class="sub-sub-section"><h4>
|
||
|
|
<a name="s3.4.6" id="s3.4.6"></a><span class="item-no">3.4.6</span>  Transformation of deprecated attributes
|
||
|
|
</h4><span class="totop"><a href="#peak">(to top)</a></span><br style="clear: both;" />
|
||
|
|
<br />
|
||
|
|
  If <span class="term">$config["no_deprecated_attr"]</span> is <span class="term">0</span>, then deprecated attributes (see appendix in <a href="#s5.2">section 5.2</a>) are removed and, in most cases, their values are transformed to CSS style properties and added to the <span class="term">style</span> attributes (function <span class="term">hl_tag()</span>). Except for <span class="term">bordercolor</span> for <span class="term">table</span>, <span class="term">tr</span> and <span class="term">td</span>, the scores of proprietary attributes that were never part of any cross-browser standard are not supported.<br />
|
||
|
|
<br />
|
||
|
|
  <strong>Note</strong>: The attribute <span class="term">target</span> for <span class="term">a</span> is allowed even though it is not in XHTML 1.0 specs. This is because of the attribute's wide-spread use and browser-support, and because the attribute is valid in XHTML 1.1 onwards.<br />
|
||
|
|
<br />
|
||
|
|
  *  align - for <span class="term">img</span> with value of <span class="term">left</span> or <span class="term">right</span>, becomes, e.g., <span class="term">float: left</span>; for <span class="term">div</span> and <span class="term">table</span> with value <span class="term">center</span>, becomes <span class="term">margin: auto</span>; all others become, e.g., <span class="term">text-align: right</span><br />
|
||
|
|
<br />
|
||
|
|
  *  bgcolor - E.g., <span class="term">bgcolor="#ffffff"</span> becomes <span class="term">background-color: #ffffff</span><br />
|
||
|
|
  *  border - E.g., <span class="term">height= "10"</span> becomes <span class="term">height: 10px</span><br />
|
||
|
|
  *  bordercolor - E.g., <span class="term">bordercolor=#999999</span> becomes <span class="term">border-color: #999999;</span><br />
|
||
|
|
  *  compact - <span class="term">font-size: 85%</span><br />
|
||
|
|
  *  clear - E.g., 'clear="all" becomes <span class="term">clear: both</span><br />
|
||
|
|
<br />
|
||
|
|
  *  height - E.g., <span class="term">height= "10"</span> becomes <span class="term">height: 10px</span> and <span class="term">height="*"</span> becomes <span class="term">height: auto</span><br />
|
||
|
|
<br />
|
||
|
|
  *  hspace - E.g., <span class="term">hspace="10"</span> becomes <span class="term">margin-left: 10px; margin-right: 10px</span><br />
|
||
|
|
  *  language - <span class="term">language="VBScript"</span> becomes <span class="term">type="text/vbscript"</span><br />
|
||
|
|
  *  name - E.g., <span class="term">name="xx"</span> becomes <span class="term">id="xx"</span><br />
|
||
|
|
  *  noshade - <span class="term">border-style: none; border: 0; background-color: gray; color: gray</span><br />
|
||
|
|
  *  nowrap - <span class="term">white-space: nowrap</span><br />
|
||
|
|
  *  size - E.g., <span class="term">size="10"</span> becomes <span class="term">height: 10px</span><br />
|
||
|
|
  *  start - removed<br />
|
||
|
|
  *  type - E.g., <span class="term">type="i"</span> becomes <span class="term">list-style-type: lower-roman</span><br />
|
||
|
|
  *  value - removed<br />
|
||
|
|
  *  vspace - E.g., <span class="term">vspace="10"</span> becomes <span class="term">margin-top: 10px; margin-bottom: 10px</span><br />
|
||
|
|
  *  width - like <span class="term">height</span><br />
|
||
|
|
<br />
|
||
|
|
  Example input:<br />
|
||
|
|
<br />
|
||
|
|
|
||
|
|
<code class="code">    <img src="j.gif" alt="image" name="dad's" /><img src="k.gif" alt="image" id="dad_off" name="dad" /></code>
|
||
|
|
<br />
|
||
|
|
|
||
|
|
<code class="code">    <br clear="left" /></code>
|
||
|
|
<br />
|
||
|
|
|
||
|
|
<code class="code">    <hr noshade size="1" /></code>
|
||
|
|
<br />
|
||
|
|
|
||
|
|
<code class="code">    <img name="img" src="i.gif" align="left" alt="image" hspace="10" vspace="10" width="10em" height="20" border="1" style="padding:5px;" /></code>
|
||
|
|
<br />
|
||
|
|
|
||
|
|
<code class="code">    <table width="50em" align="center" bgcolor="red"></code>
|
||
|
|
<br />
|
||
|
|
|
||
|
|
<code class="code">     <tr></code>
|
||
|
|
<br />
|
||
|
|
|
||
|
|
<code class="code">      <td width="20%"></code>
|
||
|
|
<br />
|
||
|
|
|
||
|
|
<code class="code">       <div align="center"></code>
|
||
|
|
<br />
|
||
|
|
|
||
|
|
<code class="code">        <h3 align="right">Section</h3></code>
|
||
|
|
<br />
|
||
|
|
|
||
|
|
<code class="code">        <p align="right">Para</p></code>
|
||
|
|
<br />
|
||
|
|
|
||
|
|
<code class="code">        <ol type="a" start="e"><li value="x">First item</li></ol></code>
|
||
|
|
<br />
|
||
|
|
|
||
|
|
<code class="code">       </div></code>
|
||
|
|
<br />
|
||
|
|
|
||
|
|
<code class="code">      </td></code>
|
||
|
|
<br />
|
||
|
|
|
||
|
|
<code class="code">      <td width="*"></code>
|
||
|
|
<br />
|
||
|
|
|
||
|
|
<code class="code">       <ol type="1"><li>First item</li></ol></code>
|
||
|
|
<br />
|
||
|
|
|
||
|
|
<code class="code">      </td></code>
|
||
|
|
<br />
|
||
|
|
|
||
|
|
<code class="code">     </tr></code>
|
||
|
|
<br />
|
||
|
|
|
||
|
|
<code class="code">    </table></code>
|
||
|
|
<br />
|
||
|
|
|
||
|
|
<code class="code">    <br clear="all" /></code>
|
||
|
|
<br />
|
||
|
|
<br />
|
||
|
|
  And the output with <span class="term">$config["no_deprecated_attr"] = 1</span>:<br />
|
||
|
|
<br />
|
||
|
|
|
||
|
|
<code class="code">    <img src="j.gif" alt="image" /><img src="k.gif" alt="image" id="dad_off" /></code>
|
||
|
|
<br />
|
||
|
|
|
||
|
|
<code class="code">    <br style="clear: left;" /></code>
|
||
|
|
<br />
|
||
|
|
|
||
|
|
<code class="code">    <hr style="border-style: none; border: 0; background-color: gray; color: gray; size: 1px;" /></code>
|
||
|
|
<br />
|
||
|
|
|
||
|
|
<code class="code">    <img src="i.gif" alt="image" width="10em" height="20" style="padding:5px; float: left; margin-left: 10px; margin-right: 10px; margin-top: 10px; margin-bottom: 10px; border: 1px;" id="img" /></code>
|
||
|
|
<br />
|
||
|
|
|
||
|
|
<code class="code">    <table width="50em" style="margin: auto; background-color: red;"></code>
|
||
|
|
<br />
|
||
|
|
|
||
|
|
<code class="code">     <tr></code>
|
||
|
|
<br />
|
||
|
|
|
||
|
|
<code class="code">      <td style="width: 20%;"></code>
|
||
|
|
<br />
|
||
|
|
|
||
|
|
<code class="code">       <div style="margin: auto;"></code>
|
||
|
|
<br />
|
||
|
|
|
||
|
|
<code class="code">        <h3 style="text-align: right;">Section</h3></code>
|
||
|
|
<br />
|
||
|
|
|
||
|
|
<code class="code">        <p style="text-align: right;">Para</p></code>
|
||
|
|
<br />
|
||
|
|
|
||
|
|
<code class="code">        <ol style="list-style-type: lower-latin;"><li>First item</li></ol></code>
|
||
|
|
<br />
|
||
|
|
|
||
|
|
<code class="code">       </div></code>
|
||
|
|
<br />
|
||
|
|
|
||
|
|
<code class="code">      </td></code>
|
||
|
|
<br />
|
||
|
|
|
||
|
|
<code class="code">      <td style="width: auto;"></code>
|
||
|
|
<br />
|
||
|
|
|
||
|
|
<code class="code">       <ol style="list-style-type: decimal;"><li>First item</li></ol></code>
|
||
|
|
<br />
|
||
|
|
|
||
|
|
<code class="code">      </td></code>
|
||
|
|
<br />
|
||
|
|
|
||
|
|
<code class="code">     </tr></code>
|
||
|
|
<br />
|
||
|
|
|
||
|
|
<code class="code">    </table></code>
|
||
|
|
<br />
|
||
|
|
|
||
|
|
<code class="code">    <br style="clear: both;" /></code>
|
||
|
|
<br />
|
||
|
|
<br />
|
||
|
|
  For <span class="term">lang</span>, deprecated in XHTML 1.1, transformation is taken care of through <span class="term">$config["xml:lang"]</span>; see <a href="#s3.4.1">section 3.4.1</a>.<br />
|
||
|
|
<br />
|
||
|
|
  The attribute <span class="term">name</span> is deprecated in <span class="term">form</span>, <span class="term">iframe</span>, and <span class="term">img</span>, and is replaced with <span class="term">id</span> if an <span class="term">id</span> attribute doesn't exist and if the <span class="term">name</span> value is appropriate for <span class="term">id</span>. For such replacements for <span class="term">a</span> and <span class="term">map</span>, for which the <span class="term">name</span> attribute is deprecated in XHTML 1.1, <span class="term">$config["no_deprecated_attr"]</span> should be set to <span class="term">2</span> (when set to <span class="term">1</span>, for these two elements, the <span class="term">name</span> attribute is retained).<br />
|
||
|
|
|
||
|
|
</div>
|
||
|
|
<div class="sub-section"><h3>
|
||
|
|
<a name="s3.4.7" id="s3.4.7"></a><span class="item-no">3.4.7</span>  Anti-spam & <span class="term">href</span>
|
||
|
|
</h3><span class="totop"><a href="#peak">(to top)</a></span><br style="clear: both;" />
|
||
|
|
<br />
|
||
|
|
  htmLawed (function <span class="term">hl_tag()</span>) can check the <span class="term">href</span> attribute values (link addresses) as an anti-spam (email or link spam) measure.<br />
|
||
|
|
<br />
|
||
|
|
  If <span class="term">$config["anti_mail_spam"]</span> is not <span class="term">0</span>, the <span class="term">@</span> of email addresses in <span class="term">href</span> values like <span class="term">mailto:a@b.com</span> is replaced with text specified by <span class="term">$config["anti_mail_spam"]</span>. The text should be of a form that makes it clear to others that the address needs to be edited before a mail is sent; e.g., <span class="term"><remove_this_antispam>@</span> (makes the example address <span class="term">a<remove_this_antispam>@b.com</span>).<br />
|
||
|
|
<br />
|
||
|
|
  For regular links, one can choose to have a <span class="term">rel</span> attribute with <span class="term">nofollow</span> in its value (which tells some search engines to not follow a link). This can discourage link spammers. Additionally, or as an alternative, one can choose to empty the <span class="term">href</span> value altogether (disable the link).<br />
|
||
|
|
<br />
|
||
|
|
  For use of these options, <span class="term">$config["anti_link_spam"]</span> should be set as an array with values <span class="term">regex1</span> and <span class="term">regex2</span>, both or one of which can be empty (like <span class="term">array("", "regex2")</span>) to indicate that that option is not to be used. Otherwise, <span class="term">regex1</span> or <span class="term">regex2</span> should be PHP- and PCRE-compatible regular expression patterns: <span class="term">href</span> values will be matched against them and those matching the pattern will accordingly be treated.<br />
|
||
|
|
<br />
|
||
|
|
  Note that the regular expressions should have <em>delimiters</em>, and be well-formed and preferably fast. Absolute efficiency/accuracy is often not needed.<br />
|
||
|
|
<br />
|
||
|
|
  An example, to have a <span class="term">rel</span> attribute with <span class="term">nofollow</span> for all links, and to disable links that do not point to domains <span class="term">abc.com</span> and <span class="term">xyz.org</span>:<br />
|
||
|
|
<br />
|
||
|
|
|
||
|
|
<code class="code">    $config["anti_link_spam"] = array('`.`', '`://\W*(?!(abc\.com|xyz\.org))`');</code>
|
||
|
|
<br />
|
||
|
|
|
||
|
|
</div>
|
||
|
|
<div class="sub-section"><h3>
|
||
|
|
<a name="s3.4.8" id="s3.4.8"></a><span class="item-no">3.4.8</span>  Inline style properties
|
||
|
|
</h3><span class="totop"><a href="#peak">(to top)</a></span><br style="clear: both;" />
|
||
|
|
<br />
|
||
|
|
  htmLawed can check URL schemes and dynamic expressions (to guard against Javascript, etc., script-based insecurities) in inline CSS style property values in the <span class="term">style</span> attributes. (CSS properties like <span class="term">background-image</span> that accept URLs in their values are noted in <a href="#s5.3">section 5.3</a>.) Dynamic CSS expressions that allow scripting in the IE browser, and can be a vulnerability, can be removed from property values by setting <span class="term">$config["css_expression"]</span> to <span class="term">1</span> (default setting). Note that when <span class="term">$config["css_expression"]</span> is set to <span class="term">1</span>, htmLawed will remove <span class="term">/*</span> from the <span class="term">style</span> values.<br />
|
||
|
|
<br />
|
||
|
|
  <strong>Note</strong>: Because of the various ways of representing characters in attribute values (URL-escapement, entitification, etc.), htmLawed might alter the values of the <span class="term">style</span> attribute values, and may even falsely identify dynamic CSS expressions and URL schemes in them. If this is an important issue, checking of URLs and dynamic expressions can be turned off (<span class="term">$config["schemes"] = "...style:*..."</span>, see <a href="#s3.4.3">section 3.4.3</a>, and <span class="term">$config["css_expression"] = 0</span>). Alternately, admins can use their own custom function for finer handling of <span class="term">style</span> values through the <span class="term">hook_tag</span> parameter (see <a href="#s3.4.9">section 3.4.9</a>).<br />
|
||
|
|
<br />
|
||
|
|
  It is also possible to have htmLawed let through any <span class="term">style</span> value by setting <span class="term">$config["style_pass"]</span> to <span class="term">1</span>.<br />
|
||
|
|
<br />
|
||
|
|
  As such, it is better to set up a CSS file with class declarations, disallow the <span class="term">style</span> attribute, set a <span class="term">$spec</span> rule (see <a href="#s2.3">section 2.3</a>) for <span class="term">class</span> for the <span class="term">oneof</span> or <span class="term">match</span> parameter, and ask writers to make use of the <span class="term">class</span> attribute.<br />
|
||
|
|
|
||
|
|
</div>
|
||
|
|
<div class="sub-section"><h3>
|
||
|
|
<a name="s3.4.9" id="s3.4.9"></a><span class="item-no">3.4.9</span>  Hook function for tag content
|
||
|
|
</h3><span class="totop"><a href="#peak">(to top)</a></span><br style="clear: both;" />
|
||
|
|
<br />
|
||
|
|
  It is possible to utilize a custom hook function to alter the tag content htmLawed has finalized (i.e., after it has checked/corrected for required attributes, transformed attributes, lower-cased attribute names, etc.).<br />
|
||
|
|
<br />
|
||
|
|
  When <span class="term">$config</span> parameter <span class="term">hook_tag</span> is set to the name of a function, htmLawed (function <span class="term">hl_tag()</span>) will pass on the element name, and the <em>finalized</em> attribute name-value pairs as array elements to the function. The function is expected to return the full opening tag string like <span class="term"><element_name attribute_1_name="attribute_1_value"...></span> (for empty elements like <span class="term">img</span> and <span class="term">input</span>, the element-closing slash <span class="term">/</span> should also be included).<br />
|
||
|
|
<br />
|
||
|
|
  This is a <strong>powerful functionality</strong> that can be exploited for various objectives: consolidate-and-convert inline <span class="term">style</span> attributes to <span class="term">class</span>, convert <span class="term">embed</span> elements to <span class="term">object</span>, permit only one <span class="term">caption</span> element in a <span class="term">table</span> element, disallow embedding of certain types of media, <strong>inject HTML</strong>, use <a href="http://csstidy.sourceforge.net">CSSTidy</a> to sanitize <span class="term">style</span> attribute values, etc.<br />
|
||
|
|
<br />
|
||
|
|
  As an example, the custom hook code below can be used to force a series of specifically ordered <span class="term">id</span> attributes on all elements, and a specific <span class="term">param</span> element inside all <span class="term">object</span> elements:<br />
|
||
|
|
<br />
|
||
|
|
|
||
|
|
<code class="code">    function my_tag_function($element, $attribute_array){</code>
|
||
|
|
<br />
|
||
|
|
|
||
|
|
<code class="code">      static $id = 0;</code>
|
||
|
|
<br />
|
||
|
|
|
||
|
|
<code class="code">      // Remove any duplicate element</code>
|
||
|
|
<br />
|
||
|
|
|
||
|
|
<code class="code">      if($element == 'param' && isset($attribute_array['allowscriptaccess'])){</code>
|
||
|
|
<br />
|
||
|
|
|
||
|
|
<code class="code">        return '';</code>
|
||
|
|
<br />
|
||
|
|
|
||
|
|
<code class="code">      }</code>
|
||
|
|
<br />
|
||
|
|
<br />
|
||
|
|
|
||
|
|
<code class="code">      $new_element = '';</code>
|
||
|
|
<br />
|
||
|
|
<br />
|
||
|
|
|
||
|
|
<code class="code">      // Force a serialized ID number</code>
|
||
|
|
<br />
|
||
|
|
|
||
|
|
<code class="code">      $attribute_array['id'] = 'my_'. $id;</code>
|
||
|
|
<br />
|
||
|
|
|
||
|
|
<code class="code">      ++$id;</code>
|
||
|
|
<br />
|
||
|
|
<br />
|
||
|
|
|
||
|
|
<code class="code">      // Inject param for allowscriptaccess</code>
|
||
|
|
<br />
|
||
|
|
|
||
|
|
<code class="code">      if($element == 'object'){</code>
|
||
|
|
<br />
|
||
|
|
|
||
|
|
<code class="code">        $new_element = '<param id='my_'. $id; allowscriptaccess="never" />';</code>
|
||
|
|
<br />
|
||
|
|
|
||
|
|
<code class="code">        ++$id;</code>
|
||
|
|
<br />
|
||
|
|
|
||
|
|
<code class="code">      }</code>
|
||
|
|
<br />
|
||
|
|
<br />
|
||
|
|
|
||
|
|
<code class="code">      $string = '';</code>
|
||
|
|
<br />
|
||
|
|
|
||
|
|
<code class="code">      foreach($attribute_array as $k=>$v){</code>
|
||
|
|
<br />
|
||
|
|
|
||
|
|
<code class="code">        $string .= " {$k}=\"{$v}\"";</code>
|
||
|
|
<br />
|
||
|
|
|
||
|
|
<code class="code">      }</code>
|
||
|
|
<br />
|
||
|
|
<br />
|
||
|
|
|
||
|
|
<code class="code">      static $empty_elements = array('area'=>1, 'br'=>1, 'col'=>1, 'embed'=>1, 'hr'=>1, 'img'=>1, 'input'=>1, 'isindex'=>1, 'param'=>1);</code>
|
||
|
|
<br />
|
||
|
|
<br />
|
||
|
|
|
||
|
|
<code class="code">      return "<{$element}{$string}". (isset($in_array($element, $empty_elements) ? ' /' : ''). '>'. $new_element;</code>
|
||
|
|
<br />
|
||
|
|
|
||
|
|
<code class="code">    }</code>
|
||
|
|
<br />
|
||
|
|
<br />
|
||
|
|
  The <span class="term">hook_tag</span> parameter is different from the <span class="term">hook</span> parameter (<a href="#s3.7">section 3.7</a>).<br />
|
||
|
|
<br />
|
||
|
|
  Snippets of hook function code developed by others may be available on the <a href="http://www.bioinformatics.org/phplabware/internal_utilities/htmLawed">htmLawed</a> website.<br />
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<div class="sub-section"><h3>
|
||
|
|
<a name="s3.5" id="s3.5"></a><span class="item-no">3.5</span>  Simple configuration directive for most valid XHTML
|
||
|
|
</h3><span class="totop"><a href="#peak">(to top)</a></span><br style="clear: both;" />
|
||
|
|
<br />
|
||
|
|
  If <span class="term">$config["valid_xhtml"]</span> is set to <span class="term">1</span>, some relevant <span class="term">$config</span> parameters (indicated by <span class="term">~</span> in <a href="#s2.2">section 2.2</a>) are auto-adjusted. This allows one to pass the <span class="term">$config</span> argument with a simpler value. If a value for a parameter auto-set through <span class="term">valid_xhtml</span> is still manually provided, then that value will over-ride the auto-set value.<br />
|
||
|
|
|
||
|
|
</div>
|
||
|
|
<div class="sub-section"><h3>
|
||
|
|
<a name="s3.6" id="s3.6"></a><span class="item-no">3.6</span>  Simple configuration directive for most <em>safe</em> HTML
|
||
|
|
</h3><span class="totop"><a href="#peak">(to top)</a></span><br style="clear: both;" />
|
||
|
|
<br />
|
||
|
|
  <em>Safe</em> HTML refers to HTML that is restricted to reduce the vulnerability for scripting attacks (such as XSS) based on HTML code which otherwise may still be legal and compliant with the HTML standard specs. When elements such as <span class="term">script</span> and <span class="term">object</span>, and attributes such as <span class="term">onmouseover</span> and <span class="term">style</span> are allowed in the input text, an input writer can introduce malevolent HTML code. Note that what is considered <span class="term">safe</span> depends on the nature of the web application and the trust-level accorded to its users.<br />
|
||
|
|
<br />
|
||
|
|
  htmLawed allows an admin to use <span class="term">$config["safe"]</span> to auto-adjust multiple <span class="term">$config</span> parameters (such as <span class="term">elements</span> which declares the allowed element-set), which otherwise would have to be manually set. The relevant parameters are indicated by <span class="term">"</span> in <a href="#s2.2">section 2.2</a>). Thus, one can pass the <span class="term">$config</span> argument with a simpler value.<br />
|
||
|
|
<br />
|
||
|
|
  With the value of <span class="term">1</span>, htmLawed considers <span class="term">CDATA</span> sections and HTML comments as plain text, and prohibits the <span class="term">applet</span>, <span class="term">embed</span>, <span class="term">iframe</span>, <span class="term">object</span> and <span class="term">script</span> elements, and the <span class="term">on*</span> attributes like <span class="term">onclick</span>. ( There are <span class="term">$config</span> parameters like <span class="term">css_expression</span> that are not affected by the value set for <span class="term">safe</span> but whose default values still contribute towards a more <em>safe</em> output.) Further, URLs with schemes (see <a href="#s3.4.3">section 3.4.3</a>) are neutralized so that, e.g., <span class="term">style="moz-binding:url(http://danger)"</span> becomes <span class="term">style="moz-binding:url(denied:http://danger)"</span>.<br />
|
||
|
|
<br />
|
||
|
|
  Admins, however, may still want to completely deny the <span class="term">style</span> attribute, e.g., with code like<br />
|
||
|
|
<br />
|
||
|
|
|
||
|
|
<code class="code">    $processed = htmLawed($text, array('safe'=>1, 'deny_attribute'=>'style'));</code>
|
||
|
|
<br />
|
||
|
|
<br />
|
||
|
|
  Permitting the <span class="term">style</span> attribute brings in risks of <em>click-jacking</em>, etc. CSS property values can render a page non-functional or be used to deface it. Except for URLs, dynamic expressions, and some other things, htmLawed does not completely check <span class="term">style</span> values. It does provide ways for the code-developer implementing htmLawed to do such checks through the <span class="term">$spec</span> argument, and through the <span class="term">hook_tag</span> parameter (see <a href="#s3.4.8">section 3.4.8</a> for more). Disallowing style completely and relying on CSS classes and stylesheet files is recommended.<br />
|
||
|
|
<br />
|
||
|
|
  If a value for a parameter auto-set through <span class="term">safe</span> is still manually provided, then that value can over-ride the auto-set value. E.g., with <span class="term">$config["safe"] = 1</span> and <span class="term">$config["elements"] = "*+script"</span>, <span class="term">script</span>, but not <span class="term">applet</span>, is allowed.<br />
|
||
|
|
<br />
|
||
|
|
  A page illustrating the efficacy of htmLawed's anti-XSS abilities with <span class="term">safe</span> set to <span class="term">1</span> against XSS vectors listed by <a href="http://ha.ckers.org/xss.html">RSnake</a> may be available <a href="http://www.bioinformatics.org/phplabware/internal_utilities/htmLawed/rsnake/RSnakeXSSTest.htm">here</a>.<br />
|
||
|
|
|
||
|
|
</div>
|
||
|
|
<div class="sub-section"><h3>
|
||
|
|
<a name="s3.7" id="s3.7"></a><span class="item-no">3.7</span>  Using a hook function
|
||
|
|
</h3><span class="totop"><a href="#peak">(to top)</a></span><br style="clear: both;" />
|
||
|
|
<br />
|
||
|
|
  If <span class="term">$config["hook"]</span> is not set to <span class="term">0</span>, then htmLawed will allow preliminarily processed input to be altered by a hook function named by <span class="term">$config["hook"]</span> before starting the main work (but after handling of characters, entities, HTML comments and <span class="term">CDATA</span> sections -- see code for function <span class="term">htmLawed()</span>).<br />
|
||
|
|
<br />
|
||
|
|
  The hook function also allows one to alter the <em>finalized</em> values of <span class="term">$config</span> and <span class="term">$spec</span>.<br />
|
||
|
|
<br />
|
||
|
|
  Note that the <span class="term">hook</span> parameter is different from the <span class="term">hook_tag</span> parameter (<a href="#s3.4.9">section 3.4.9</a>).<br />
|
||
|
|
<br />
|
||
|
|
  Snippets of hook function code developed by others may be available on the <a href="http://www.bioinformatics.org/phplabware/internal_utilities/htmLawed">htmLawed</a> website.<br />
|
||
|
|
|
||
|
|
</div>
|
||
|
|
<div class="sub-section"><h3>
|
||
|
|
<a name="s3.8" id="s3.8"></a><span class="item-no">3.8</span>  Obtaining <em>finalized</em> parameter values
|
||
|
|
</h3><span class="totop"><a href="#peak">(to top)</a></span><br style="clear: both;" />
|
||
|
|
<br />
|
||
|
|
  htmLawed can assign the <em>finalized</em> <span class="term">$config</span> and <span class="term">$spec</span> values to a variable named by <span class="term">$config["show_setting"]</span>. The variable, made global by htmLawed, is set as an array with three keys: <span class="term">config</span>, with the <span class="term">$config</span> value, <span class="term">spec</span>, with the <span class="term">$spec</span> value, and <span class="term">time</span>, with a value that is the Unix time (the output of PHP's <span class="term">microtime()</span> function) when the value was assigned. Admins should use a PHP-compliant variable name (e.g., one that does not begin with a numerical digit) that does not conflict with variable names in their non-htmLawed code.<br />
|
||
|
|
<br />
|
||
|
|
  The values, which are also post-hook function (if any), can be used to auto-generate information (on, e.g., the elements that are permitted) for input writers.<br />
|
||
|
|
|
||
|
|
</div>
|
||
|
|
<div class="sub-section"><h3>
|
||
|
|
<a name="s3.9" id="s3.9"></a><span class="item-no">3.9</span>  Retaining non-HTML tags in input with mixed markup
|
||
|
|
</h3><span class="totop"><a href="#peak">(to top)</a></span><br style="clear: both;" />
|
||
|
|
<br />
|
||
|
|
  htmLawed does not remove certain characters that though invalid are nevertheless discouraged in HTML documents as per the specs (see <a href="#s5.1">section 5.1</a>). This can be utilized to deal with input that contains mixed markup. Input that may have HTML markup as well as some other markup that is based on the <span class="term"><</span>, <span class="term">></span> and <span class="term">&</span> characters is considered to have mixed markup. The non-HTML markup can be rather proprietary (like markup for emoticons/smileys), or standard (like MathML or SVG). Or it can be programming code meant for execution/evaluation (such as embedded PHP code).<br />
|
||
|
|
<br />
|
||
|
|
  To deal with such mixed markup, the input text can be pre-processed to hide the non-HTML markup by specifically replacing the <span class="term"><</span>, <span class="term">></span> and <span class="term">&</span> characters with some of the HTML-discouraged characters (see <a href="#s3.1.2">section 3.1.2</a>). Post-htmLawed processing, the replacements are reverted.<br />
|
||
|
|
<br />
|
||
|
|
  An example (mixed HTML and PHP code in input text):<br />
|
||
|
|
<br />
|
||
|
|
|
||
|
|
<code class="code">    $text = preg_replace('`<\?php(.+?)\?>`sm', "\x83?php\\1?\x84", $text);</code>
|
||
|
|
<br />
|
||
|
|
|
||
|
|
<code class="code">    $processed = htmLawed($text);</code>
|
||
|
|
<br />
|
||
|
|
|
||
|
|
<code class="code">    $processed = preg_replace('`\x83\?php(.+?)\?\x84`sm', '<?php$1?>', $processed);</code>
|
||
|
|
<br />
|
||
|
|
<br />
|
||
|
|
  This code will not work if <span class="term">$config["clean_ms_char"]</span> is set to <span class="term">1</span> (<a href="#s3.1">section 3.1</a>), in which case one should instead deploy a hook function (<a href="#s3.7">section 3.7</a>). (htmLawed internally uses certain control characters, code-points <span class="term">1</span> to <span class="term">7</span>, and use of these characters as markers in the logic of hook functions may cause issues.)<br />
|
||
|
|
<br />
|
||
|
|
  Admins may also be able to use <span class="term">$config["and_mark"]</span> to deal with such mixed markup; see <a href="#s3.2">section 3.2</a>.<br />
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<div class="section"><h2>
|
||
|
|
<a name="s4" id="s4"></a><span class="item-no">4</span>  Other
|
||
|
|
</h2><span class="totop"><a href="#peak">(to top)</a></span><br style="clear: both;" />
|
||
|
|
<div class="sub-section"><h3>
|
||
|
|
<a name="s4.1" id="s4.1"></a><span class="item-no">4.1</span>  Support
|
||
|
|
</h3><span class="totop"><a href="#peak">(to top)</a></span><br style="clear: both;" />
|
||
|
|
<br />
|
||
|
|
  A careful re-reading of this documentation will very likely answer your questions.<br />
|
||
|
|
<br />
|
||
|
|
  Software updates and forum-based community-support may be found at <a href="http://www.bioinformatics.org/phplabware/internal_utilities/htmLawed">http://www.bioinformatics.org/phplabware/internal_utilities/htmLawed</a>. For general PHP issues (not htmLawed-specific), support may be found through internet searches and at <a href="http://php.net">http://php.net</a>.<br />
|
||
|
|
|
||
|
|
</div>
|
||
|
|
<div class="sub-section"><h3>
|
||
|
|
<a name="s4.2" id="s4.2"></a><span class="item-no">4.2</span>  Known issues
|
||
|
|
</h3><span class="totop"><a href="#peak">(to top)</a></span><br style="clear: both;" />
|
||
|
|
<br />
|
||
|
|
  See <a href="#s2.8">section 2.8</a>.<br />
|
||
|
|
<br />
|
||
|
|
  Readers are advised to cross-check information given in this document.<br />
|
||
|
|
|
||
|
|
</div>
|
||
|
|
<div class="sub-section"><h3>
|
||
|
|
<a name="s4.3" id="s4.3"></a><span class="item-no">4.3</span>  Change-log
|
||
|
|
</h3><span class="totop"><a href="#peak">(to top)</a></span><br style="clear: both;" />
|
||
|
|
<br />
|
||
|
|
  (The release date for the downloadable package of files containing documentation, demo script, test-cases, etc., besides the <span class="term">htmLawed.php</span> file may be updated independently if the secondary files are revised.)<br />
|
||
|
|
<br />
|
||
|
|
  <em>Version number - Release date. Notes</em><br />
|
||
|
|
<br />
|
||
|
|
  1.1.10 - 22 October 2011. Fix for a bug in the <span class="term">tidy</span> functionality that caused the entire input to be replaced with a single space; new parameter, <span class="term">$config["direct_list_nest"]</span> to allow direct descendance of a list in a list. (5 April 2012. Dual licensing from LGPLv3 to LGPLv3 and GPLv2+.)<br />
|
||
|
|
<br />
|
||
|
|
  1.1.9.5 - 6 July 2011. Minor correction of a rule for nesting of <span class="term">li</span> within <span class="term">dir</span><br />
|
||
|
|
<br />
|
||
|
|
  1.1.9.4 - 3 July 2010. Parameter <span class="term">schemes</span> now accepts <span class="term">!</span> so any URL, even a local one, can be <em>denied</em>. An issue in which a second URL value in <span class="term">style</span> properties was not checked was fixed.<br />
|
||
|
|
<br />
|
||
|
|
  1.1.9.3 - 17 May 2010. Checks for correct nesting of <span class="term">param</span><br />
|
||
|
|
<br />
|
||
|
|
  1.1.9.2 - 26 April 2010. Minor fix regarding rendering of denied URL schemes<br />
|
||
|
|
<br />
|
||
|
|
  1.1.9.1 - 26 February 2010. htmLawed now uses the LGPL version 3 license; support for <span class="term">flashvars</span> attribute for <span class="term">embed</span><br />
|
||
|
|
<br />
|
||
|
|
  1.1.9 - 22 December 2009. Soft-hyphens are now removed only from URL-accepting attribute values<br />
|
||
|
|
<br />
|
||
|
|
  1.1.8.1 - 16 July 2009. Minor code-change to fix a PHP error notice<br />
|
||
|
|
<br />
|
||
|
|
  1.1.8 - 23 April 2009. Parameter <span class="term">deny_attribute</span> now accepts the wild-card <span class="term">*</span>, making it simpler to specify its value when all but a few attributes are being denied; fixed a bug in interpreting <span class="term">$spec</span><br />
|
||
|
|
<br />
|
||
|
|
  1.1.7 - 11-12 March 2009. Attributes globally denied through <span class="term">deny_attribute</span> can be allowed element-specifically through <span class="term">$spec</span>; <span class="term">$config["style_pass"]</span> allowing letting through any <span class="term">style</span> value introduced; altered logic to catch certain types of dynamic crafted CSS expressions<br />
|
||
|
|
<br />
|
||
|
|
  1.1.3-6 - 28-31 January - 4 February 2009. Altered logic to catch certain types of dynamic crafted CSS expressions<br />
|
||
|
|
<br />
|
||
|
|
  1.1.2 - 22 January 2009. Fixed bug in parsing of <span class="term">font</span> attributes during tag transformation<br />
|
||
|
|
<br />
|
||
|
|
  1.1.1 - 27 September 2008. Better nesting correction when omitable closing tags are absent<br />
|
||
|
|
<br />
|
||
|
|
  1.1 - 29 June 2008. <span class="term">$config["hook_tag"]</span> and <span class="term">$config["format"]</span> introduced for custom tag/attribute check/modification/injection and output compaction/beautification; fixed a regex-in-$spec parsing bug<br />
|
||
|
|
<br />
|
||
|
|
  1.0.9 - 11 June 2008. Fixed bug in invalid HTML code-point entity check<br />
|
||
|
|
<br />
|
||
|
|
  1.0.8 - 15 May 2008. <span class="term">bordercolor</span> attribute for <span class="term">table</span>, <span class="term">td</span> and <span class="term">tr</span><br />
|
||
|
|
<br />
|
||
|
|
  1.0.7 - 1 May 2008. Support for <span class="term">wmode</span> attribute for <span class="term">embed</span>; <span class="term">$config["show_setting"]</span> introduced; improved <span class="term">$config["elements"]</span> evaluation<br />
|
||
|
|
<br />
|
||
|
|
  1.0.6 - 20 April 2008. <span class="term">$config["and_mark"]</span> introduced<br />
|
||
|
|
<br />
|
||
|
|
  1.0.5 - 12 March 2008. <span class="term">style</span> URL schemes essentially disallowed when $config <span class="term">safe</span> is on; improved regex for CSS expression search<br />
|
||
|
|
<br />
|
||
|
|
  1.0.4 - 10 March 2008. Improved corrections for <span class="term">blockquote</span>, <span class="term">form</span>, <span class="term">map</span> and <span class="term">noscript</span><br />
|
||
|
|
<br />
|
||
|
|
  1.0.3 - 3 March 2008. Character entities for soft-hyphens are now replaced with spaces (instead of being removed); a bug allowing <span class="term">td</span> directly inside <span class="term">table</span> fixed; <span class="term">safe</span> <span class="term">$config</span> parameter added<br />
|
||
|
|
<br />
|
||
|
|
  1.0.2 - 13 February 2008. Improved implementation of <span class="term">$config["keep_bad"]</span><br />
|
||
|
|
<br />
|
||
|
|
  1.0.1 - 7 November 2007. Improved regex for identifying URLs, protocols and dynamic expressions (<span class="term">hl_tag()</span> and <span class="term">hl_prot()</span>); no error display with <span class="term">hl_regex()</span><br />
|
||
|
|
<br />
|
||
|
|
  1.0 - 2 November 2007. First release<br />
|
||
|
|
|
||
|
|
</div>
|
||
|
|
<div class="sub-section"><h3>
|
||
|
|
<a name="s4.4" id="s4.4"></a><span class="item-no">4.4</span>  Testing
|
||
|
|
</h3><span class="totop"><a href="#peak">(to top)</a></span><br style="clear: both;" />
|
||
|
|
<br />
|
||
|
|
  To test htmLawed using a form interface, a <a href="htmLawedTest.php">demo</a> web-page is provided with the htmLawed distribution (<span class="term">htmLawed.php</span> and <span class="term">htmLawedTest.php</span> should be in the same directory on the web-server). A file with <a href="htmLawed_TESTCASE.txt">test-cases</a> is also provided.<br />
|
||
|
|
|
||
|
|
</div>
|
||
|
|
<div class="sub-section"><h3>
|
||
|
|
<a name="s4.5" id="s4.5"></a><span class="item-no">4.5</span>  Upgrade, & old versions
|
||
|
|
</h3><span class="totop"><a href="#peak">(to top)</a></span><br style="clear: both;" />
|
||
|
|
<br />
|
||
|
|
  Upgrading is as simple as replacing the previous version of <span class="term">htmLawed.php</span> (assuming it was not modified for customized features). As htmLawed output is almost always used in static documents, upgrading should not affect old, finalized content.<br />
|
||
|
|
<br />
|
||
|
|
  Old versions of htmLawed may be available online. E.g., for version 1.0, check <a href="http://www.bioinformatics.org/phplabware/downloads/htmLawed1.zip">http://www.bioinformatics.org/phplabware/downloads/htmLawed1.zip</a>, for 1.1.1, htmLawed111.zip, and for 1.1.10, htmLawed1110.zip.<br />
|
||
|
|
|
||
|
|
</div>
|
||
|
|
<div class="sub-section"><h3>
|
||
|
|
<a name="s4.6" id="s4.6"></a><span class="item-no">4.6</span>  Comparison with <span class="term">HTMLPurifier</span>
|
||
|
|
</h3><span class="totop"><a href="#peak">(to top)</a></span><br style="clear: both;" />
|
||
|
|
<br />
|
||
|
|
  The HTMLPurifier PHP library by Edward Yang is a very good HTML filtering script that uses object oriented PHP code. Compared to htmLawed, it (as of mid-2009):<br />
|
||
|
|
<br />
|
||
|
|
  *  does not support PHP versions older than 5.0 (HTMLPurifier dropped PHP 4 support after version 2)<br />
|
||
|
|
<br />
|
||
|
|
  *  is 15-20 times bigger (scores of files totalling more than 750 kb)<br />
|
||
|
|
<br />
|
||
|
|
  *  consumes 10-15 times more RAM memory (just including the HTMLPurifier files without calling the filter requires a few MBs of memory)<br />
|
||
|
|
<br />
|
||
|
|
  *  is expectedly slower<br />
|
||
|
|
<br />
|
||
|
|
  *  does not allow admins to fully allow all valid HTML (because of incomplete HTML support, it always considers elements like <span class="term">script</span> illegal)<br />
|
||
|
|
<br />
|
||
|
|
  *  lacks many of the extra features of htmLawed (like entity conversions and code compaction/beautification)<br />
|
||
|
|
<br />
|
||
|
|
  *  has poor documentation<br />
|
||
|
|
<br />
|
||
|
|
  However, HTMLPurifier has finer checks for character encodings and attribute values, and can log warnings and errors. Visit the HTMLPurifier <a href="http://htmlpurifier.org">website</a> for updated information.<br />
|
||
|
|
|
||
|
|
</div>
|
||
|
|
<div class="sub-section"><h3>
|
||
|
|
<a name="s4.7" id="s4.7"></a><span class="item-no">4.7</span>  Use through application plug-ins/modules
|
||
|
|
</h3><span class="totop"><a href="#peak">(to top)</a></span><br style="clear: both;" />
|
||
|
|
<br />
|
||
|
|
  Plug-ins/modules to implement htmLawed in applications such as Drupal and DokuWiki may have been developed. Please check the application websites and the forum on the htmLawed <a href="http://www.bioinformatics.org/phplabware/internal_utilities/htmLawed">site</a>.<br />
|
||
|
|
|
||
|
|
</div>
|
||
|
|
<div class="sub-section"><h3>
|
||
|
|
<a name="s4.8" id="s4.8"></a><span class="item-no">4.8</span>  Use in non-PHP applications
|
||
|
|
</h3><span class="totop"><a href="#peak">(to top)</a></span><br style="clear: both;" />
|
||
|
|
<br />
|
||
|
|
  Non-PHP applications written in Python, Ruby, etc., may be able to use htmLawed through system calls to the PHP engine. Such code may have been documented on the internet. Also check the forum on the htmLawed <a href="http://www.bioinformatics.org/phplabware/internal_utilities/htmLawed">site</a>.<br />
|
||
|
|
|
||
|
|
</div>
|
||
|
|
<div class="sub-section"><h3>
|
||
|
|
<a name="s4.9" id="s4.9"></a><span class="item-no">4.9</span>  Donate
|
||
|
|
</h3><span class="totop"><a href="#peak">(to top)</a></span><br style="clear: both;" />
|
||
|
|
<br />
|
||
|
|
  A donation in any currency and amount to appreciate or support this software can be sent by <a href="http://paypal.com">PayPal</a> to this email address: drpatnaik at yahoo dot com.<br />
|
||
|
|
|
||
|
|
</div>
|
||
|
|
<div class="sub-section"><h3>
|
||
|
|
<a name="s4.10" id="s4.10"></a><span class="item-no">4.10</span>  Acknowledgements
|
||
|
|
</h3><span class="totop"><a href="#peak">(to top)</a></span><br style="clear: both;" />
|
||
|
|
<br />
|
||
|
|
  Nicholas Alipaz, Bryan Blakey, Pádraic Brady, Ulf Harnhammer, Gareth Heyes, Lukasz Pilorz, Shelley Powers, Edward Yang, and many anonymous users.<br />
|
||
|
|
<br />
|
||
|
|
  Thank you!<br />
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<div class="section"><h2>
|
||
|
|
<a name="s5" id="s5"></a><span class="item-no">5</span>  Appendices
|
||
|
|
</h2><span class="totop"><a href="#peak">(to top)</a></span><br style="clear: both;" />
|
||
|
|
<div class="sub-section"><h3>
|
||
|
|
<a name="s5.1" id="s5.1"></a><span class="item-no">5.1</span>  Characters discouraged in XHTML
|
||
|
|
</h3><span class="totop"><a href="#peak">(to top)</a></span><br style="clear: both;" />
|
||
|
|
<br />
|
||
|
|
  Characters represented by the following hexadecimal code-points are <em>not</em> invalid, even though some validators may issue messages stating otherwise.<br />
|
||
|
|
<br />
|
||
|
|
  <span class="term">7f</span> to <span class="term">84</span>, <span class="term">86</span> to <span class="term">9f</span>, <span class="term">fdd0</span> to <span class="term">fddf</span>, <span class="term">1fffe</span>, <span class="term">1ffff</span>, <span class="term">2fffe</span>, <span class="term">2ffff</span>, <span class="term">3fffe</span>, <span class="term">3ffff</span>, <span class="term">4fffe</span>, <span class="term">4ffff</span>, <span class="term">5fffe</span>, <span class="term">5ffff</span>, <span class="term">6fffe</span>, <span class="term">6ffff</span>, <span class="term">7fffe</span>, <span class="term">7ffff</span>, <span class="term">8fffe</span>, <span class="term">8ffff</span>, <span class="term">9fffe</span>, <span class="term">9ffff</span>, <span class="term">afffe</span>, <span class="term">affff</span>, <span class="term">bfffe</span>, <span class="term">bffff</span>, <span class="term">cfffe</span>, <span class="term">cffff</span>, <span class="term">dfffe</span>, <span class="term">dffff</span>, <span class="term">efffe</span>, <span class="term">effff</span>, <span class="term">ffffe</span>, <span class="term">fffff</span>, <span class="term">10fffe</span> and <span class="term">10ffff</span><br />
|
||
|
|
|
||
|
|
</div>
|
||
|
|
<div class="sub-section"><h3>
|
||
|
|
<a name="s5.2" id="s5.2"></a><span class="item-no">5.2</span>  Valid attribute-element combinations
|
||
|
|
</h3><span class="totop"><a href="#peak">(to top)</a></span><br style="clear: both;" />
|
||
|
|
<br />
|
||
|
|
  Valid attribute-element combinations as per W3C specs.<br />
|
||
|
|
<br />
|
||
|
|
  *  includes deprecated attributes (marked <span class="term">^</span>), attributes for the non-standard <span class="term">embed</span> element (marked <span class="term">*</span>), and the proprietary <span class="term">bordercolor</span> (marked <span class="term">~</span>)<br />
|
||
|
|
  *  only non-frameset, HTML body elements<br />
|
||
|
|
  *  <span class="term">name</span> for <span class="term">a</span> and <span class="term">map</span>, and <span class="term">lang</span> are invalid in XHTML 1.1<br />
|
||
|
|
  *  <span class="term">target</span> is valid for <span class="term">a</span> in XHTML 1.1 and higher<br />
|
||
|
|
  *  <span class="term">xml:space</span> is only for XHTML 1.1<br />
|
||
|
|
<br />
|
||
|
|
  abbr - td, th<br />
|
||
|
|
  accept - form, input<br />
|
||
|
|
  accept-charset - form<br />
|
||
|
|
  accesskey - a, area, button, input, label, legend, textarea<br />
|
||
|
|
  action - form<br />
|
||
|
|
  align - caption^, embed, applet, iframe, img^, input^, object^, legend^, table^, hr^, div^, h1^, h2^, h3^, h4^, h5^, h6^, p^, col, colgroup, tbody, td, tfoot, th, thead, tr<br />
|
||
|
|
  alt - applet, area, img, input<br />
|
||
|
|
  archive - applet, object<br />
|
||
|
|
  axis - td, th<br />
|
||
|
|
  bgcolor - embed, table^, tr^, td^, th^<br />
|
||
|
|
  border - table, img^, object^<br />
|
||
|
|
  bordercolor~ - table, td, tr<br />
|
||
|
|
  cellpadding - table<br />
|
||
|
|
  cellspacing - table<br />
|
||
|
|
  char - col, colgroup, tbody, td, tfoot, th, thead, tr<br />
|
||
|
|
  charoff - col, colgroup, tbody, td, tfoot, th, thead, tr<br />
|
||
|
|
  charset - a, script<br />
|
||
|
|
  checked - input<br />
|
||
|
|
  cite - blockquote, q, del, ins<br />
|
||
|
|
  classid - object<br />
|
||
|
|
  clear - br^<br />
|
||
|
|
  code - applet<br />
|
||
|
|
  codebase - object, applet<br />
|
||
|
|
  codetype - object<br />
|
||
|
|
  color - font<br />
|
||
|
|
  cols - textarea<br />
|
||
|
|
  colspan - td, th<br />
|
||
|
|
  compact - dir, dl^, menu, ol^, ul^<br />
|
||
|
|
  coords - area, a<br />
|
||
|
|
  data - object<br />
|
||
|
|
  datetime - del, ins<br />
|
||
|
|
  declare - object<br />
|
||
|
|
  defer - script<br />
|
||
|
|
  dir - bdo<br />
|
||
|
|
  disabled - button, input, optgroup, option, select, textarea<br />
|
||
|
|
  enctype - form<br />
|
||
|
|
  face - font<br />
|
||
|
|
  flashvars* - embed<br />
|
||
|
|
  for - label<br />
|
||
|
|
  frame - table<br />
|
||
|
|
  frameborder - iframe<br />
|
||
|
|
  headers - td, th<br />
|
||
|
|
  height - embed, iframe, td^, th^, img, object, applet<br />
|
||
|
|
  href - a, area<br />
|
||
|
|
  hreflang - a<br />
|
||
|
|
  hspace - applet, img^, object^<br />
|
||
|
|
  ismap - img, input<br />
|
||
|
|
  label - option, optgroup<br />
|
||
|
|
  language - script^<br />
|
||
|
|
  longdesc - img, iframe<br />
|
||
|
|
  marginheight - iframe<br />
|
||
|
|
  marginwidth - iframe<br />
|
||
|
|
  maxlength - input<br />
|
||
|
|
  method - form<br />
|
||
|
|
  model* - embed<br />
|
||
|
|
  multiple - select<br />
|
||
|
|
  name - button, embed, textarea, applet^, select, form^, iframe^, img^, a^, input, object, map^, param<br />
|
||
|
|
  nohref - area<br />
|
||
|
|
  noshade - hr^<br />
|
||
|
|
  nowrap - td^, th^<br />
|
||
|
|
  object - applet<br />
|
||
|
|
  onblur - a, area, button, input, label, select, textarea<br />
|
||
|
|
  onchange - input, select, textarea<br />
|
||
|
|
  onfocus - a, area, button, input, label, select, textarea<br />
|
||
|
|
  onreset - form<br />
|
||
|
|
  onselect - input, textarea<br />
|
||
|
|
  onsubmit - form<br />
|
||
|
|
  pluginspage* - embed<br />
|
||
|
|
  pluginurl* - embed<br />
|
||
|
|
  prompt - isindex<br />
|
||
|
|
  readonly - textarea, input<br />
|
||
|
|
  rel - a<br />
|
||
|
|
  rev - a<br />
|
||
|
|
  rows - textarea<br />
|
||
|
|
  rowspan - td, th<br />
|
||
|
|
  rules - table<br />
|
||
|
|
  scope - td, th<br />
|
||
|
|
  scrolling - iframe<br />
|
||
|
|
  selected - option<br />
|
||
|
|
  shape - area, a<br />
|
||
|
|
  size - hr^, font, input, select<br />
|
||
|
|
  span - col, colgroup<br />
|
||
|
|
  src - embed, script, input, iframe, img<br />
|
||
|
|
  standby - object<br />
|
||
|
|
  start - ol^<br />
|
||
|
|
  summary - table<br />
|
||
|
|
  tabindex - a, area, button, input, object, select, textarea<br />
|
||
|
|
  target - a^, area, form<br />
|
||
|
|
  type - a, embed, object, param, script, input, li^, ol^, ul^, button<br />
|
||
|
|
  usemap - img, input, object<br />
|
||
|
|
  valign - col, colgroup, tbody, td, tfoot, th, thead, tr<br />
|
||
|
|
  value - input, option, param, button, li^<br />
|
||
|
|
  valuetype - param<br />
|
||
|
|
  vspace - applet, img^, object^<br />
|
||
|
|
  width - embed, hr^, iframe, img, object, table, td^, th^, applet, col, colgroup, pre^<br />
|
||
|
|
  wmode - embed<br />
|
||
|
|
  xml:space - pre, script, style<br />
|
||
|
|
<br />
|
||
|
|
  These are allowed in all but the shown elements:<br />
|
||
|
|
<br />
|
||
|
|
  class - param, script<br />
|
||
|
|
  dir - applet, bdo, br, iframe, param, script<br />
|
||
|
|
  id - script<br />
|
||
|
|
  lang - applet, br, iframe, param, script<br />
|
||
|
|
  onclick - applet, bdo, br, font, iframe, isindex, param, script<br />
|
||
|
|
  ondblclick - applet, bdo, br, font, iframe, isindex, param, script<br />
|
||
|
|
  onkeydown - applet, bdo, br, font, iframe, isindex, param, script<br />
|
||
|
|
  onkeypress - applet, bdo, br, font, iframe, isindex, param, script<br />
|
||
|
|
  onkeyup - applet, bdo, br, font, iframe, isindex, param, script<br />
|
||
|
|
  onmousedown - applet, bdo, br, font, iframe, isindex, param, script<br />
|
||
|
|
  onmousemove - applet, bdo, br, font, iframe, isindex, param, script<br />
|
||
|
|
  onmouseout - applet, bdo, br, font, iframe, isindex, param, script<br />
|
||
|
|
  onmouseover - applet, bdo, br, font, iframe, isindex, param, script<br />
|
||
|
|
  onmouseup - applet, bdo, br, font, iframe, isindex, param, script<br />
|
||
|
|
  style - param, script<br />
|
||
|
|
  title - param, script<br />
|
||
|
|
  xml:lang - applet, br, iframe, param, script<br />
|
||
|
|
|
||
|
|
</div>
|
||
|
|
<div class="sub-section"><h3>
|
||
|
|
<a name="s5.3" id="s5.3"></a><span class="item-no">5.3</span>  CSS 2.1 properties accepting URLs
|
||
|
|
</h3><span class="totop"><a href="#peak">(to top)</a></span><br style="clear: both;" />
|
||
|
|
<br />
|
||
|
|
  background<br />
|
||
|
|
  background-image<br />
|
||
|
|
  content<br />
|
||
|
|
  cue-after<br />
|
||
|
|
  cue-before<br />
|
||
|
|
  cursor<br />
|
||
|
|
  list-style<br />
|
||
|
|
  list-style-image<br />
|
||
|
|
  play-during<br />
|
||
|
|
|
||
|
|
</div>
|
||
|
|
<div class="sub-section"><h3>
|
||
|
|
<a name="s5.4" id="s5.4"></a><span class="item-no">5.4</span>  Microsoft Windows 1252 character replacements
|
||
|
|
</h3><span class="totop"><a href="#peak">(to top)</a></span><br style="clear: both;" />
|
||
|
|
<br />
|
||
|
|
  Key: <span class="term">d</span> double, <span class="term">l</span> left, <span class="term">q</span> quote, <span class="term">r</span> right, <span class="term">s.</span> single<br />
|
||
|
|
<br />
|
||
|
|
  Code-point (decimal) - hexadecimal value - replacement entity - represented character<br />
|
||
|
|
<br />
|
||
|
|
  127 - 7f - (removed) - (not used)<br />
|
||
|
|
  128 - 80 - &#8364; - euro<br />
|
||
|
|
  129 - 81 - (removed) - (not used)<br />
|
||
|
|
  130 - 82 - &#8218; - baseline s. q<br />
|
||
|
|
  131 - 83 - &#402; - florin<br />
|
||
|
|
  132 - 84 - &#8222; - baseline d q<br />
|
||
|
|
  133 - 85 - &#8230; - ellipsis<br />
|
||
|
|
  134 - 86 - &#8224; - dagger<br />
|
||
|
|
  135 - 87 - &#8225; - d dagger<br />
|
||
|
|
  136 - 88 - &#710; - circumflex accent<br />
|
||
|
|
  137 - 89 - &#8240; - permile<br />
|
||
|
|
  138 - 8a - &#352; - S Hacek<br />
|
||
|
|
  139 - 8b - &#8249; - l s. guillemet<br />
|
||
|
|
  140 - 8c - &#338; - OE ligature<br />
|
||
|
|
  141 - 8d - (removed) - (not used)<br />
|
||
|
|
  142 - 8e - &#381; - Z dieresis<br />
|
||
|
|
  143 - 8f - (removed) - (not used)<br />
|
||
|
|
  144 - 90 - (removed) - (not used)<br />
|
||
|
|
  145 - 91 - &#8216; - l s. q<br />
|
||
|
|
  146 - 92 - &#8217; - r s. q<br />
|
||
|
|
  147 - 93 - &#8220; - l d q<br />
|
||
|
|
  148 - 94 - &#8221; - r d q<br />
|
||
|
|
  149 - 95 - &#8226; - bullet<br />
|
||
|
|
  150 - 96 - &#8211; - en dash<br />
|
||
|
|
  151 - 97 - &#8212; - em dash<br />
|
||
|
|
  152 - 98 - &#732; - tilde accent<br />
|
||
|
|
  153 - 99 - &#8482; - trademark<br />
|
||
|
|
  154 - 9a - &#353; - s Hacek<br />
|
||
|
|
  155 - 9b - &#8250; - r s. guillemet<br />
|
||
|
|
  156 - 9c - &#339; - oe ligature<br />
|
||
|
|
  157 - 9d - (removed) - (not used)<br />
|
||
|
|
  158 - 9e - &#382; - z dieresis<br />
|
||
|
|
  159 - 9f - &#376; - Y dieresis<br />
|
||
|
|
|
||
|
|
</div>
|
||
|
|
<div class="sub-section"><h3>
|
||
|
|
<a name="s5.5" id="s5.5"></a><span class="item-no">5.5</span>  URL format
|
||
|
|
</h3><span class="totop"><a href="#peak">(to top)</a></span><br style="clear: both;" />
|
||
|
|
<br />
|
||
|
|
  An <em>absolute</em> URL has a <span class="term">protocol</span> or <span class="term">scheme</span>, a <span class="term">network location</span> or <span class="term">hostname</span>, and, optional <span class="term">path</span>, <span class="term">parameters</span>, <span class="term">query</span> and <span class="term">fragment</span> segments. Thus, an absolute URL has this generic structure:<br />
|
||
|
|
<br />
|
||
|
|
|
||
|
|
<code class="code">    (scheme) : (//network location) /(path) ;(parameters) ?(query) #(fragment)</code>
|
||
|
|
<br />
|
||
|
|
<br />
|
||
|
|
  The schemes can only contain letters, digits, <span class="term">+</span>, <span class="term">.</span> and <span class="term">-</span>. Hostname is the portion after the <span class="term">//</span> and up to the first <span class="term">/</span> (if any; else, up to the end) when <span class="term">:</span> is followed by a <span class="term">//</span> (e.g., <span class="term">abc.com</span> in <span class="term">ftp://abc.com/def</span>); otherwise, it consists of everything after the <span class="term">:</span> (e.g., <span class="term">def@abc.com</span> in mailto:def@abc.com').<br />
|
||
|
|
<br />
|
||
|
|
  <em>Relative</em> URLs do not have explicit schemes and network locations; such values are inherited from a <em>base</em> URL.<br />
|
||
|
|
|
||
|
|
</div>
|
||
|
|
<div class="sub-section"><h3>
|
||
|
|
<a name="s5.6" id="s5.6"></a><span class="item-no">5.6</span>  Brief on htmLawed code
|
||
|
|
</h3><span class="totop"><a href="#peak">(to top)</a></span><br style="clear: both;" />
|
||
|
|
<br />
|
||
|
|
  Much of the code's logic and reasoning can be understood from the documentation above.<br />
|
||
|
|
<br />
|
||
|
|
  The <strong>output</strong> of htmLawed is a text string containing the processed input. There is no custom error tracking.<br />
|
||
|
|
<br />
|
||
|
|
  <strong>Function arguments</strong> for htmLawed are:<br />
|
||
|
|
<br />
|
||
|
|
  *  <span class="term">$in</span> - 1st argument; a text string; the <strong>input text</strong> to be processed. Any extraneous slashes added by PHP when <em>magic quotes</em> are enabled should be removed beforehand using PHP's <span class="term">stripslashes()</span> function.<br />
|
||
|
|
<br />
|
||
|
|
  *  <span class="term">$config</span> - 2nd argument; an associative array; optional (named <span class="term">$C</span> in htmLawed code). The array has keys with names like <span class="term">balance</span> and <span class="term">keep_bad</span>, and the values, which can be boolean, string, or array, depending on the key, are read to accordingly set the <strong>configurable parameters</strong> (indicated by the keys). All configurable parameters receive some default value if the value to be used is not specified by the user through <span class="term">$config</span>. <em>Finalized</em> <span class="term">$config</span> is thus a filtered and possibly larger array.<br />
|
||
|
|
<br />
|
||
|
|
  *  <span class="term">$spec</span> - 3rd argument; a text string; optional. The string has rules, written in an htmLawed-designated format, <strong>specifying</strong> element-specific attribute and attribute value restrictions. Function <span class="term">hl_spec()</span> is used to convert the string to an associative-array for internal use. <em>Finalized</em> <span class="term">$spec</span> is thus an array.<br />
|
||
|
|
<br />
|
||
|
|
  <em>Finalized</em> <span class="term">$config</span> and <span class="term">$spec</span> are made <strong>global variables</strong> while htmLawed is at work. Values of any pre-existing global variables with same names are noted, and their values are restored after htmLawed finishes processing the input (to capture the <em>finalized</em> values, the <span class="term">show_settings</span> parameter of <span class="term">$config</span> should be used). Depending on <span class="term">$config</span>, another global variable <span class="term">hl_Ids</span>, to track <span class="term">id</span> attribute values for uniqueness, may be set. Unlike the other two variables, this one is not reset (or unset) post-processing.<br />
|
||
|
|
<br />
|
||
|
|
  Except for the main function <span class="term">htmLawed()</span> and the functions <span class="term">kses()</span> and <span class="term">kses_hook()</span>, htmLawed's functions are <strong>name-spaced</strong> using the <span class="term">hl_</span> prefix. The <strong>functions</strong> and their roles are:<br />
|
||
|
|
<br />
|
||
|
|
  *  <span class="term">hl_attrval</span> - checking attribute values against $spec<br />
|
||
|
|
  *  <span class="term">hl_bal</span> - tag balancing<br />
|
||
|
|
  *  <span class="term">hl_cmtcd</span> - handling CDATA sections and HTML comments<br />
|
||
|
|
  *  <span class="term">hl_ent</span> - entity handling<br />
|
||
|
|
  *  <span class="term">hl_prot</span> - checking a URL scheme/protocol<br />
|
||
|
|
  *  <span class="term">hl_regex</span> - checking syntax of a regular expression<br />
|
||
|
|
  *  <span class="term">hl_spec</span> - converting user-supplied $spec value to one used by htmLawed internally<br />
|
||
|
|
  *  <span class="term">hl_tag</span> - handling tags<br />
|
||
|
|
  *  <span class="term">hl_tag2</span> - transforming tags<br />
|
||
|
|
  *  <span class="term">hl_tidy</span> - compact/beautify HTML<br />
|
||
|
|
  *  <span class="term">hl_version</span> - reporting htmLawed version<br />
|
||
|
|
  *  <span class="term">htmLawed</span> - main function<br />
|
||
|
|
  *  <span class="term">kses</span> - main function of <span class="term">kses</span><br />
|
||
|
|
  *  <span class="term">kses_hook</span> - hook function of <span class="term">kses</span><br />
|
||
|
|
<br />
|
||
|
|
  The last two are for compatibility with pre-existing code using the <span class="term">kses</span> script. htmLawed's <span class="term">kses()</span> basically passes on the filtering task to <span class="term">htmLawed()</span> function after deciphering <span class="term">$config</span> and <span class="term">$spec</span> from the argument values supplied to it. <span class="term">kses_hook()</span> is an empty function and is meant for being filled with custom code if the <span class="term">kses</span> script users were using one.<br />
|
||
|
|
<br />
|
||
|
|
  <span class="term">htmLawed()</span> finalizes <span class="term">$spec</span> (with the help of <span class="term">hl_spec()</span>) and <span class="term">$config</span>, and globalizes them. Finalization of <span class="term">$config</span> involves setting default values if an inappropriate or invalid one is supplied. This includes calling <span class="term">hl_regex()</span> to check well-formedness of regular expression patterns if such expressions are user-supplied through <span class="term">$config</span>. <span class="term">htmLawed()</span> then removes invalid characters like nulls and <span class="term">x01</span> and appropriately handles entities using <span class="term">hl_ent()</span>. HTML comments and CDATA sections are identified and treated as per <span class="term">$config</span> with the help of <span class="term">hl_cmtcd()</span>. When retained, the <span class="term"><</span> and <span class="term">></span> characters identifying them, and the <span class="term"><</span>, <span class="term">></span> and <span class="term">&</span> characters inside them, are replaced with control characters (code-points <span class="term">1</span> to <span class="term">5</span>) till any tag balancing is completed.<br />
|
||
|
|
<br />
|
||
|
|
  After this <em>initial processing</em> <span class="term">htmLawed()</span> identifies tags using regex and processes them with the help of <span class="term">hl_tag()</span> --  a large function that analyzes tag content, filtering it as per HTML standards, <span class="term">$config</span> and <span class="term">$spec</span>. Among other things, <span class="term">hl_tag()</span> transforms deprecated elements using <span class="term">hl_tag2()</span>, removes attributes from closing tags, checks attribute values as per <span class="term">$spec</span> rules using <span class="term">hl_attrval()</span>, and checks URL protocols using <span class="term">hl_prot()</span>. <span class="term">htmLawed()</span> performs tag balancing and nesting checks with a call to <span class="term">hl_bal()</span>, and optionally compacts/beautifies the output with proper white-spacing with a call to <span class="term">hl_tidy()</span>. The latter temporarily replaces white-space, and <span class="term"><</span>, <span class="term">></span> and <span class="term">&</span> characters inside <span class="term">pre</span>, <span class="term">script</span> and <span class="term">textarea</span> elements, and HTML comments and CDATA sections with control characters (code-points <span class="term">1</span> to <span class="term">5</span>, and <span class="term">7</span>).<br />
|
||
|
|
<br />
|
||
|
|
  htmLawed permits the use of custom code or <strong>hook functions</strong> at two stages. The first, called inside <span class="term">htmLawed()</span>, allows the input text as well as the finalized $config and $spec values to be altered right after the initial processing (see <a href="#s3.7">section 3.7</a>). The second is called by <span class="term">hl_tag()</span> once the tag content is finalized (see <a href="#s3.4.9">section 3.4.9</a>).<br />
|
||
|
|
<br />
|
||
|
|
  Being dictated by the external and stable HTML standard, htmLawed's objective is very clear-cut and less concerned with tweakability. The code is only minimally annotated with comments -- it is not meant to instruct; PHP developers familiar with the HTML specs will see the logic, and others can always refer to the htmLawed documentation. The compact structuring of the statements is meant to aid in quickly grasping the logic, at least when viewed with code syntax highlighted.
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<br />
|
||
|
|
<hr /><br /><br /><span class="subtle"><small>HTM version of <em><a href="htmLawed_README.txt">htmLawed_README.txt</a></em> generated on 05 Apr, 2012 using <a href="http://www.bioinformatics.org/phplabware/internal_utilities">rTxt2htm</a> from PHP Labware</small></span>
|
||
|
|
</div><!-- ended div body -->
|
||
|
|
</div><!-- ended div top -->
|
||
|
|
</body>
|
||
|
|
</html>
|