templates: properly escape inline JavaScript values TLDR: Kallithea has issues with escaping values for use in inline JS. Despite judicious poking of the code, no actual security vulnerabilities have been found, just lots of corner-case bugs. This patch fixes those, and hardens the code against actual security issues. The long version: To embed a Python value (typically a 'unicode' plain-text value) in a larger file, it must be escaped in a context specific manner. Example: >>> s = u'<script>alert("It\'s a trap!");</script>' 1) Escaped for insertion into HTML element context >>> print cgi.escape(s) &lt;script&gt;alert("It's a trap!");&lt;/script&gt; 2) Escaped for insertion into HTML element or attribute context >>> print h.escape(s) &lt;script&gt;alert(&#34;It&#39;s a trap!&#34;);&lt;/script&gt; This is the default Mako escaping, as usually used by Kallithea. 3) Encoded as JSON >>> print json.dumps(s) "<script>alert(\"It's a trap!\");</script>" 4) Escaped for insertion into a JavaScript file >>> print '(' + json.dumps(s) + ')' ("<script>alert(\"It's a trap!\");</script>") The parentheses are not actually required for strings, but may be needed to avoid syntax errors if the value is a number or dict (object). 5) Escaped for insertion into a HTML inline <script> element >>> print h.js(s) ("\x3cscript\x3ealert(\"It's a trap!\");\x3c/script\x3e") Here, we need to combine JS and HTML escaping, further complicated by the fact that "<script>" tag contents can either be parsed in XHTML mode (in which case '<', '>' and '&' must additionally be XML escaped) or HTML mode (in which case '</script>' must be escaped, but not using HTML escaping, which is not available in HTML "<script>" tags). Therefore, the XML special characters (which can only occur in string literals) are escaped using JavaScript string literal escape sequences. (This, incidentally, is why modern web security best practices ban all use of inline JavaScript...) Unsurprisingly, Kallithea does not do (5) correctly. In most cases, Kallithea might slap a pair of single quotes around the HTML escaped Python value. A typical benign example: $('#child_link').html('${_('No revisions')}'); This works in English, but if a localized version of the string contains an apostrophe, the result will be broken JavaScript. In the more severe cases, where the text is user controllable, it leaves the door open to injections. In this example, the script inserts the string as HTML, so Mako's implicit HTML escaping makes sense; but in many other cases, HTML escaping is actually an error, because the value is not used by the script in an HTML context. The good news is that the HTML escaping thwarts attempts at XSS, since it's impossible to inject syntactically valid JavaScript of any useful complexity. It does allow JavaScript errors and gibberish to appear on the page, though. In these cases, the escaping has been fixed to use either the new 'h.js' helper, which does JavaScript escaping (but not HTML escaping), OR the new 'h.jshtml' helper (which does both), in those cases where it was unclear if the value might be used (by the script) in an HTML context. Some of these can probably be "relaxed" from h.jshtml to h.js later, but for now, using h.jshtml fixes escaping and doesn't introduce new errors. In a few places, Kallithea JSON encodes values in the controller, then inserts the JSON (without any further escaping) into <script> tags. This is also wrong, and carries actual risk of XSS vulnerabilities. However, in all cases, security vulnerabilities were narrowly avoided due to other filtering in Kallithea. (E.g. many special characters are banned from appearing in usernames.) In these cases, the escaping has been fixed and moved to the template, making it immediately visible that proper escaping has been performed. Mini-FAQ (frequently anticipated questions): Q: Why do everything in one big, hard to review patch? Q: Why add escaping in specific case FOO, it doesn't seem needed? Because the goal here is to have "escape everywhere" as the default policy, rather than identifying individual bugs and fixing them one by one by adding escaping where needed. As such, this patch surely introduces a lot of needless escaping. This is no different from how Mako/Pylons HTML escape everything by default, even when not needed: it's errs on the side of needless work, to prevent erring on the side of skipping required (and security critical) work. As for reviewability, the most important thing to notice is not where escaping has been introduced, but any places where it might have been missed (or where h.jshtml is needed, but h.js is used). Q: The added escaping is kinda verbose/ugly. That is not a question, but yes, I agree. Hopefully it'll encourage us to move away from inline JavaScript altogether. That's a significantly larger job, though; with luck this patch will keep us safe and secure until such a time as we can implement the real fix. Q: Why not use Mako filter syntax ("${val|h.js}")? Because of long-standing Mako bug #140, preventing use of 'h' in filters. Q: Why not work around bug #140, or even use straight "${val|js}"? Because Mako still applies the default h.escape filter before the explicitly specified filters. Q: Where do we go from here? Longer term, we should stop doing variable expansions in script blocks, and instead pass data to JS via e.g. data attributes, or asynchronously using AJAX calls. Once we've done that, we can remove inline JavaScript altogether in favor of separate script files, and set a strict Content Security Policy explicitly blocking inline scripting, and thus also the most common kind of cross-site scripting attack.

<!DOCTYPE html>
<html lang="en">
<!--[if IE]>
    <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
<![endif]-->
<head>
	<meta charset="utf-8" /><title>Mergely License</title>
	<meta http-equiv="content-type" content="text/html; charset=UTF-8"/>
	<meta name="description" content="Mergely license requirements for open source software and commercial software" />
	<meta name="keywords" content="diff,merge,compare,compare documents,js diff,javascript diff,comparison,online diff,difference,file,text,unix,patch,algorithm,saas,longest common subsequence,diff online" />
	<meta name="author" content="Jamie Peabody" />
	<meta name="author" content="Jamie Peabody" />
	<link rel="shortcut icon" href="http://www.mergely.com/favicon.ico" />
    <link href='http://fonts.googleapis.com/css?family=Noto+Sans:400,700' rel='stylesheet' type='text/css' />
    <link href='fonts/berlin-sans-fb-demi.css' rel='stylesheet' type='text/css' />
    <link href='style/mergely.css' rel='stylesheet' type='text/css' />
    <link href='/Mergely/lib/mergely.css' rel='stylesheet' type='text/css' />
	<script type="text/javascript" src="http://ajax.googleapis.com/ajax/libs/jquery/1.9.0/jquery.min.js"></script>
	<script type="text/javascript">
		var _gaq = _gaq || [];
		_gaq.push(['_setAccount', 'UA-85576-5']);
		_gaq.push(['_trackPageview']);
		(function() {
			var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
			ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
			var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
		})();
	</script>
</head>
<body>
    <div id="page">
        <div id="content">
            <div id="header">
                <h1><span>Mergely License - Closed Distribution License</span></h1>
                <div id="options">
                    <a href="/editor" class="button">Online Diff</a>
                    <a href="/download" class="button">Download</a>
                </div>
                <nav>
                    <ul>
                        <li><a href="/">Home</a></li>                        <li><a href="/doc">Documentation</a></li>                        <li><a href="/about">About Mergely</a></li>                        <li><a href="/license">License</a></li>                        <li><a href="#footer">Contact</a></li>                    </ul>
                </nav>
            </div>

            <div id="main">
				<h1>Mergely License</h1>
				<p>
					All Mergely code is Copyright 2014 by Jamie Peabody.
					Mergely is distributed under the 
					<a href="http://www.gnu.org/licenses/gpl.html">GPL</a>, 
					<a href="http://www.gnu.org/licenses/lgpl.html">LGPL</a>
					and 
					<a href="http://www.mozilla.org/MPL/MPL-1.1.html">MPL</a> open source licenses. 
					This triple <b>copyleft</b> licensing model avoids incompatibility with other open 
					source licenses. These open source licenses are specially indicated for:
					<ul>
						<li>Integrating Mergely into Open Source software;</li>
						<li>Personal and educational use of Mergely;</li>
						<li>
							Integrating Mergely in commercial software, taking care of satisfying 
							the Open Source licenses terms, while not able or interested on supporting 
							Mergely and its development.
						</li>
					</ul>
				</p>
				<h2>Mergely Commercial License - Closed Distribution License - CDL</h2>
				<p>
					You may contact <a href="mailto:jamie.peabody@gmail.com">Jamie Peabody</a> to enquire about
					obtaining a CDL license.
				</p>
				<p>
					This license offers a very flexible way to integrate Mergely in your commercial 
					application. These are the main advantages it offers over an Open Source license:
				</p>
				<p>
					Modifications and enhancements do not need to be released under an Open 
					Source license; There is no need to distribute any Open Source license terms 
					along with your product and no reference to it have to be done; You do not have
					to mention any reference to Mergely in your product; Mergely source code does not
					have to be distributed with your product; You can remove any file from Mergely 
					when integrating it with your product.
				</p>
				<p>
					The CDL is a lifetime license valid for all previous releases of Mergely published 
                    prior to the year of purchase, and any releases in the following year. Please select 
                    the license option that best fit your needs above. It includes 1 year of 
                    <b>personal e-mail support</b>.
				</p>
				<h2>Third party codes</h2>
				<p>
					Mergely utilizes <b>CodeMirror</b>, a third-party library released under an 
					<a href="http://en.wikipedia.org/wiki/MIT_License">MIT</a>
					license.  Also used is <b>jQuery</b> and is released under the 
					<a href="http://en.wikipedia.org/wiki/MIT_License">MIT</a> or 
					<a href="http://www.gnu.org/licenses/gpl.html">GPL</a> Version 2 license.
				</p>
            </div>
            
            <div id="footer">
                <a href="/download" class="download">Download</a>
                <ul>
                    <li id="google-plus"><a target="_blank" href="http://groups.google.com/group/mergely">http://groups.google.com/group/mergely</a></li>
                    <li id="github"><a target="_blank" href="https://github.com/wickedest/Mergely">https://github.com/wickedest/Mergely</a></li>
                    <li id="email"><a target="_blank" href="mailto:jamie.peabody@gmail.com">jamie.peabody@gmail.com</a></li>
                </ul>
            </div>
        </div>
        <div id="copyright">By <b>Jamie Peabody</b></div>
    </div>
</body>
</html>