annotate init.d/supervisord.conf @ 6532:33b71a130b16

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.
author Søren Løvborg <sorenl@unity3d.com>
date Tue, 28 Feb 2017 17:19:00 +0100
parents e285bb7abb28
children 2c3d30095d5e
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
4212
24c0d584ba86 General renaming to Kallithea
Bradley M. Kuhn <bkuhn@sfconservancy.org>
parents: 4190
diff changeset
1 ; Kallithea Supervisord
2483
e4eabd2558b6 added example supervisord config to init scripts
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
2 ; ##########################
e4eabd2558b6 added example supervisord config to init scripts
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
3 ; for help see http://supervisord.org/configuration.html
e4eabd2558b6 added example supervisord config to init scripts
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
4 ; ##########################
e4eabd2558b6 added example supervisord config to init scripts
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
5
e4eabd2558b6 added example supervisord config to init scripts
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
6 [inet_http_server] ; inet (TCP) server disabled by default
e4eabd2558b6 added example supervisord config to init scripts
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
7 port=127.0.0.1:9001 ; (ip_address:port specifier, *:port for all iface)
e4eabd2558b6 added example supervisord config to init scripts
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
8 ;username=user ; (default is no username (open server))
e4eabd2558b6 added example supervisord config to init scripts
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
9 ;password=123 ; (default is no password (open server))
e4eabd2558b6 added example supervisord config to init scripts
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
10
e4eabd2558b6 added example supervisord config to init scripts
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
11 [supervisord]
4190
99ad9d0af1a3 Rename init scripts and fix references inside them
Bradley M. Kuhn <bkuhn@sfconservancy.org>
parents: 2483
diff changeset
12 logfile=/%(here)s/supervisord_kallithea.log ; (main log file;default $CWD/supervisord.log)
2483
e4eabd2558b6 added example supervisord config to init scripts
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
13 logfile_maxbytes=50MB ; (max main logfile bytes b4 rotation;default 50MB)
e4eabd2558b6 added example supervisord config to init scripts
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
14 logfile_backups=10 ; (num of main logfile rotation backups;default 10)
e4eabd2558b6 added example supervisord config to init scripts
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
15 loglevel=info ; (log level;default info; others: debug,warn,trace)
4190
99ad9d0af1a3 Rename init scripts and fix references inside them
Bradley M. Kuhn <bkuhn@sfconservancy.org>
parents: 2483
diff changeset
16 pidfile=/%(here)s/supervisord_kallithea.pid ; (supervisord pidfile;default supervisord.pid)
2483
e4eabd2558b6 added example supervisord config to init scripts
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
17 nodaemon=true ; (start in foreground if true;default false)
e4eabd2558b6 added example supervisord config to init scripts
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
18 minfds=1024 ; (min. avail startup file descriptors;default 1024)
e4eabd2558b6 added example supervisord config to init scripts
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
19 minprocs=200 ; (min. avail process descriptors;default 200)
e4eabd2558b6 added example supervisord config to init scripts
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
20 umask=022 ; (process file creation umask;default 022)
4190
99ad9d0af1a3 Rename init scripts and fix references inside them
Bradley M. Kuhn <bkuhn@sfconservancy.org>
parents: 2483
diff changeset
21 user=username ; (default is current user, required if root)
2483
e4eabd2558b6 added example supervisord config to init scripts
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
22 ;identifier=supervisor ; (supervisord identifier, default is 'supervisor')
e4eabd2558b6 added example supervisord config to init scripts
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
23 ;directory=/tmp ; (default is not to cd during start)
e4eabd2558b6 added example supervisord config to init scripts
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
24 ;nocleanup=true ; (don't clean up tempfiles at start;default false)
e4eabd2558b6 added example supervisord config to init scripts
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
25 ;childlogdir=/tmp ; ('AUTO' child log dir, default $TEMP)
4902
03bbd33bc084 docs: rework stuff
Mads Kiilerich <madski@unity3d.com>
parents: 4212
diff changeset
26 environment=HOME=/srv/kallithea ; (key value pairs to add to environment)
2483
e4eabd2558b6 added example supervisord config to init scripts
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
27 ;strip_ansi=false ; (strip ansi escape codes in logs; def. false)
e4eabd2558b6 added example supervisord config to init scripts
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
28
e4eabd2558b6 added example supervisord config to init scripts
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
29 ; the below section must remain in the config file for RPC
e4eabd2558b6 added example supervisord config to init scripts
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
30 ; (supervisorctl/web interface) to work, additional interfaces may be
e4eabd2558b6 added example supervisord config to init scripts
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
31 ; added by defining them in separate rpcinterface: sections
e4eabd2558b6 added example supervisord config to init scripts
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
32 [rpcinterface:supervisor]
e4eabd2558b6 added example supervisord config to init scripts
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
33 supervisor.rpcinterface_factory = supervisor.rpcinterface:make_main_rpcinterface
e4eabd2558b6 added example supervisord config to init scripts
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
34
e4eabd2558b6 added example supervisord config to init scripts
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
35 [supervisorctl]
e4eabd2558b6 added example supervisord config to init scripts
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
36 serverurl=http://127.0.0.1:9001 ; use an http:// url to specify an inet socket
e4eabd2558b6 added example supervisord config to init scripts
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
37 ;username=user ; should be same as http_username if set
e4eabd2558b6 added example supervisord config to init scripts
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
38 ;password=123 ; should be same as http_password if set
e4eabd2558b6 added example supervisord config to init scripts
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
39 ;prompt=mysupervisor ; cmd line prompt (default "supervisor")
e4eabd2558b6 added example supervisord config to init scripts
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
40 ;history_file=~/.sc_history ; use readline history if available
e4eabd2558b6 added example supervisord config to init scripts
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
41
e4eabd2558b6 added example supervisord config to init scripts
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
42
4190
99ad9d0af1a3 Rename init scripts and fix references inside them
Bradley M. Kuhn <bkuhn@sfconservancy.org>
parents: 2483
diff changeset
43 ; restart with supervisorctl restart kallithea:*
99ad9d0af1a3 Rename init scripts and fix references inside them
Bradley M. Kuhn <bkuhn@sfconservancy.org>
parents: 2483
diff changeset
44 [program:kallithea]
2483
e4eabd2558b6 added example supervisord config to init scripts
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
45 numprocs = 1
e4eabd2558b6 added example supervisord config to init scripts
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
46 numprocs_start = 5000 # possible should match ports
4902
03bbd33bc084 docs: rework stuff
Mads Kiilerich <madski@unity3d.com>
parents: 4212
diff changeset
47 directory=/srv/kallithea
03bbd33bc084 docs: rework stuff
Mads Kiilerich <madski@unity3d.com>
parents: 4212
diff changeset
48 command = /srv/kallithea/venv/bin/paster serve my.ini
2483
e4eabd2558b6 added example supervisord config to init scripts
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
49 process_name = %(program_name)s_%(process_num)04d
6370
e285bb7abb28 scripts: apply whitespace cleanup to more files - opt out instead of opt in
Mads Kiilerich <mads@kiilerich.com>
parents: 4902
diff changeset
50 redirect_stderr=true
e285bb7abb28 scripts: apply whitespace cleanup to more files - opt out instead of opt in
Mads Kiilerich <mads@kiilerich.com>
parents: 4902
diff changeset
51 stdout_logfile=/%(here)s/kallithea.log