comparison mercurial/hgweb/common.py @ 30766:d7bf7d2bd5ab

hgweb: support Content Security Policy Content-Security-Policy (CSP) is a web security feature that allows servers to declare what loaded content is allowed to do. For example, a policy can prevent loading of images, JavaScript, CSS, etc unless the source of that content is whitelisted (by hostname, URI scheme, hashes of content, etc). It's a nifty security feature that provides extra mitigation against some attacks, notably XSS. Mitigation against these attacks is important for Mercurial because hgweb renders repository data, which is commonly untrusted. While we make attempts to escape things, etc, there's the possibility that malicious data could be injected into the site content. If this happens today, the full power of the web browser is available to that malicious content. A restrictive CSP policy (defined by the server operator and sent in an HTTP header which is outside the control of malicious content), could restrict browser capabilities and mitigate security problems posed by malicious data. CSP works by emitting an HTTP header declaring the policy that browsers should apply. Ideally, this header would be emitted by a layer above Mercurial (likely the HTTP server doing the WSGI "proxying"). This works for some CSP policies, but not all. For example, policies to allow inline JavaScript may require setting a "nonce" attribute on <script>. This attribute value must be unique and non-guessable. And, the value must be present in the HTTP header and the HTML body. This means that coordinating the value between Mercurial and another HTTP server could be difficult: it is much easier to generate and emit the nonce in a central location. This commit introduces support for emitting a Content-Security-Policy header from hgweb. A config option defines the header value. If present, the header is emitted. A special "%nonce%" syntax in the value triggers generation of a nonce and inclusion in <script> elements in templates. The inclusion of a nonce does not occur unless "%nonce%" is present. This makes this commit completely backwards compatible and the feature opt-in. The nonce is a type 4 UUID, which is the flavor that is randomly generated. It has 122 random bits, which should be plenty to satisfy the guarantees of a nonce.
author Gregory Szorc <gregory.szorc@gmail.com>
date Tue, 10 Jan 2017 23:37:08 -0800
parents f1c9fafcbf46
children 7dafa8d0e006
comparison
equal deleted inserted replaced
30765:eb7de21b15be 30766:d7bf7d2bd5ab
6 # This software may be used and distributed according to the terms of the 6 # This software may be used and distributed according to the terms of the
7 # GNU General Public License version 2 or any later version. 7 # GNU General Public License version 2 or any later version.
8 8
9 from __future__ import absolute_import 9 from __future__ import absolute_import
10 10
11 import base64
11 import errno 12 import errno
12 import mimetypes 13 import mimetypes
13 import os 14 import os
15 import uuid
14 16
15 from .. import ( 17 from .. import (
16 encoding, 18 encoding,
17 pycompat, 19 pycompat,
18 util, 20 util,
197 def caching(web, req): 199 def caching(web, req):
198 tag = 'W/"%s"' % web.mtime 200 tag = 'W/"%s"' % web.mtime
199 if req.env.get('HTTP_IF_NONE_MATCH') == tag: 201 if req.env.get('HTTP_IF_NONE_MATCH') == tag:
200 raise ErrorResponse(HTTP_NOT_MODIFIED) 202 raise ErrorResponse(HTTP_NOT_MODIFIED)
201 req.headers.append(('ETag', tag)) 203 req.headers.append(('ETag', tag))
204
205 def cspvalues(ui):
206 """Obtain the Content-Security-Policy header and nonce value.
207
208 Returns a 2-tuple of the CSP header value and the nonce value.
209
210 First value is ``None`` if CSP isn't enabled. Second value is ``None``
211 if CSP isn't enabled or if the CSP header doesn't need a nonce.
212 """
213 # Don't allow untrusted CSP setting since it be disable protections
214 # from a trusted/global source.
215 csp = ui.config('web', 'csp', untrusted=False)
216 nonce = None
217
218 if csp and '%nonce%' in csp:
219 nonce = base64.urlsafe_b64encode(uuid.uuid4().bytes).rstrip('=')
220 csp = csp.replace('%nonce%', nonce)
221
222 return csp, nonce