Files
@ 33b71a130b16
Branch filter:
Location: kallithea/docs/usage/general.rst - annotation
33b71a130b16
6.7 KiB
text/prs.fallenstein.rst
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)
<script>alert("It's a trap!");</script>
2) Escaped for insertion into HTML element or attribute context
>>> print h.escape(s)
<script>alert("It's a trap!");</script>
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.
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)
<script>alert("It's a trap!");</script>
2) Escaped for insertion into HTML element or attribute context
>>> print h.escape(s)
<script>alert("It's a trap!");</script>
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.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 | bbd499c7b55e bbd499c7b55e 17c9393e9645 e73a69cb98dc bbd499c7b55e bbd499c7b55e bbd499c7b55e 5ae8e644aa88 9472a0150bf0 bbd499c7b55e 4e6dfdb3fa01 4e6dfdb3fa01 4e6dfdb3fa01 35d560f0f842 35d560f0f842 5ae8e644aa88 2d4e1f5e854e 03bbd33bc084 2d4e1f5e854e 35d560f0f842 35d560f0f842 35d560f0f842 35d560f0f842 4e6dfdb3fa01 bbd499c7b55e 35d560f0f842 35d560f0f842 35d560f0f842 35d560f0f842 fbbe80e3322b a144d15488db a144d15488db bbd499c7b55e a144d15488db a144d15488db a144d15488db a144d15488db a144d15488db a144d15488db a144d15488db bbd499c7b55e bbd499c7b55e 543bf62d06c7 543bf62d06c7 543bf62d06c7 543bf62d06c7 543bf62d06c7 543bf62d06c7 543bf62d06c7 543bf62d06c7 543bf62d06c7 543bf62d06c7 bbd499c7b55e 543bf62d06c7 543bf62d06c7 543bf62d06c7 543bf62d06c7 bbd499c7b55e 543bf62d06c7 543bf62d06c7 543bf62d06c7 543bf62d06c7 543bf62d06c7 543bf62d06c7 bbd499c7b55e 543bf62d06c7 543bf62d06c7 543bf62d06c7 543bf62d06c7 543bf62d06c7 543bf62d06c7 543bf62d06c7 bbd499c7b55e 5ae8e644aa88 4185f87f0ee0 4185f87f0ee0 a8c66e870bd0 4e6dfdb3fa01 4185f87f0ee0 8b8edfc25856 12b47803189f 4185f87f0ee0 4185f87f0ee0 4185f87f0ee0 12b47803189f 8b8edfc25856 4185f87f0ee0 4185f87f0ee0 4185f87f0ee0 4185f87f0ee0 4185f87f0ee0 4185f87f0ee0 4185f87f0ee0 4185f87f0ee0 4185f87f0ee0 a8c66e870bd0 12b47803189f 8b8edfc25856 4185f87f0ee0 4185f87f0ee0 a8c66e870bd0 5ae8e644aa88 2079e864ce51 2079e864ce51 bbd499c7b55e 5ae8e644aa88 2079e864ce51 4e6dfdb3fa01 bbd499c7b55e 2079e864ce51 667b5cea6d4f 667b5cea6d4f 667b5cea6d4f 926f55b038bc 926f55b038bc bbd499c7b55e 9472a0150bf0 bbd499c7b55e 584693b3deb0 584693b3deb0 584693b3deb0 584693b3deb0 22f79562836c 22f79562836c 22f79562836c 22f79562836c 22f79562836c e5ab200892e3 4e6dfdb3fa01 22f79562836c 22f79562836c 22f79562836c 22f79562836c 22f79562836c e5ab200892e3 e5ab200892e3 22f79562836c e5ab200892e3 e5ab200892e3 12b47803189f e5ab200892e3 e5ab200892e3 e5ab200892e3 9f5a4e785823 9f5a4e785823 daa83b2dd1f4 daa83b2dd1f4 9f5a4e785823 daa83b2dd1f4 daa83b2dd1f4 daa83b2dd1f4 9f5a4e785823 daa83b2dd1f4 ed2fb6e84a02 0b6982223baa 5ae8e644aa88 5ae8e644aa88 5ae8e644aa88 5ae8e644aa88 5ae8e644aa88 584ec42af63d daa83b2dd1f4 daa83b2dd1f4 daa83b2dd1f4 daa83b2dd1f4 9f5a4e785823 22a3fa3c4254 ed2fb6e84a02 9f5a4e785823 5ae8e644aa88 5ae8e644aa88 5ae8e644aa88 9f5a4e785823 9f5a4e785823 9f5a4e785823 9f5a4e785823 9f5a4e785823 9f5a4e785823 9f5a4e785823 9f5a4e785823 9f5a4e785823 | .. _general:
=======================
General Kallithea usage
=======================
Repository deletion
-------------------
Currently when an admin or owner deletes a repository, Kallithea does
not physically delete said repository from the filesystem, but instead
renames it in a special way so that it is not possible to push, clone
or access the repository.
There is a special command for cleaning up such archived repositories::
paster cleanup-repos --older-than=30d my.ini
This command scans for archived repositories that are older than
30 days, displays them, and asks if you want to delete them (unless given
the ``--dont-ask`` flag). If you host a large amount of repositories with
forks that are constantly being deleted, it is recommended that you run this
command via crontab.
It is worth noting that even if someone is given administrative access to
Kallithea and deletes a repository, you can easily restore such an action by
renaming the repository directory, removing the ``rm__<date>`` prefix.
File view: follow current branch
--------------------------------
In the file view, left and right arrows allow to jump to the previous and next
revision. Depending on the way revisions were created in the repository, this
could jump to a different branch. When the checkbox ``Follow current branch``
is checked, these arrows will only jump to revisions on the same branch as the
currently visible revision. So for example, if someone is viewing files in the
``beta`` branch and marks the `Follow current branch` checkbox, the < and >
arrows will only show revisions on the ``beta`` branch.
Changelog features
------------------
The core feature of a repository's ``changelog`` page is to show the revisions
in a repository. However, there are several other features available from the
changelog.
Branch filter
By default, the changelog shows revisions from all branches in the
repository. Use the branch filter to restrict to a given branch.
Viewing a changeset
A particular changeset can be opened by clicking on either the changeset
hash or the commit message, or by ticking the checkbox and clicking the
``Show selected changeset`` button at the top.
Viewing all changes between two changesets
To get a list of all changesets between two selected changesets, along with
the changes in each one of them, tick the checkboxes of the first and
last changeset in the desired range and click the ``Show selected changesets``
button at the top. You can only show the range between the first and last
checkbox (no cherry-picking).
From that page, you can proceed to viewing the overall delta between the
selected changesets, by clicking the ``Compare revisions`` button.
Creating a pull request
You can create a new pull request for the changes of a particular changeset
(and its ancestors) by selecting it and clicking the ``Open new pull request
for selected changesets`` button.
Permanent repository URLs
-------------------------
Due to the complicated nature of repository grouping, URLs of repositories
can often change. For example, a repository originally accessible from::
http://kallithea.example.com/repo_name
would get a new URL after moving it to test_group::
http://kallithea.example.com/test_group/repo_name
Such moving of a repository to a group can be an issue for build systems and
other scripts where the repository paths are hardcoded. To mitigate this,
Kallithea provides permanent URLs using the repository ID prefixed with an
underscore. In all Kallithea URLs, for example those for the changelog and the
file view, a repository name can be replaced by this ``_ID`` string. Since IDs
are always the same, moving the repository to a different group will not affect
such URLs.
In the example, the repository could also be accessible as::
http://kallithea.example.com/_<ID>
The ID of a given repository can be shown from the repository ``Summary`` page,
by selecting the ``Show by ID`` button next to ``Clone URL``.
Email notifications
-------------------
With email settings properly configured in the Kallithea
configuration file, Kallithea will send emails on user registration and when
errors occur.
Emails are also sent for comments on changesets. In this case, an email is sent
to the committer of the changeset (if known to Kallithea), to all reviewers of
the pull request (if applicable) and to all people mentioned in the comment
using @mention notation.
Trending source files
---------------------
Trending source files are calculated based on a predefined dictionary of known
types and extensions. If an extension is missing or you would like to scan
custom files, it is possible to extend the ``LANGUAGES_EXTENSIONS_MAP``
dictionary located in ``kallithea/config/conf.py`` with new types.
Cloning remote repositories
---------------------------
Kallithea has the ability to clone repositories from given remote locations.
Currently it supports the following options:
- hg -> hg clone
- svn -> hg clone
- git -> git clone
.. note:: svn -> hg cloning requires the ``hgsubversion`` library to be
installed.
If you need to clone repositories that are protected via basic authentication,
you can pass the credentials in the URL, e.g.
``http://user:passw@remote.example.com/repo``. Kallithea will then try to login and
clone using the given credentials. Please note that the given credentials will
be stored as plaintext inside the database. However, the authentication
information will not be shown in the clone URL on the summary page.
Specific features configurable in the Admin settings
----------------------------------------------------
In general, the Admin settings should be self-explanatory and will not be
described in more detail in this documentation. However, there are a few
features that merit further explanation.
Repository extra fields
^^^^^^^^^^^^^^^^^^^^^^^
In the *Visual* tab, there is an option "Use repository extra
fields", which allows to set custom fields for each repository in the system.
Once enabled site-wide, the custom fields can be edited per-repository under
*Options* | *Settings* | *Extra Fields*.
Example usage of such fields would be to define company-specific information
into repositories, e.g., defining a ``repo_manager`` key that would give info
about a manager of each repository. There's no limit for adding custom fields.
Newly created fields are accessible via the API.
Meta tagging
^^^^^^^^^^^^
In the *Visual* tab, option "Stylify recognised meta tags" will cause Kallithea
to turn certain text fragments in repository and repository group
descriptions into colored tags. Currently recognised tags are::
[featured]
[stale]
[dead]
[lang => lang]
[license => License]
[requires => Repo]
[recommends => Repo]
[see => URI]
|