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.

     1

#!/usr/bin/env python

     2

#

     3

# An example hgweb CGI script, edit as necessary

     4

# See also https://mercurial-scm.org/wiki/PublishingRepositories

     5

     6

# Path to repo or hgweb config to serve (see 'hg help hgweb')

     7

config = "/path/to/repo/or/config"

     8

     9

# Uncomment and adjust if Mercurial is not installed system-wide

    10

# (consult "installed modules" path from 'hg debuginstall'):

    11

#import sys; sys.path.insert(0, "/path/to/python/lib")

    12

    13

# Uncomment to send python tracebacks to the browser if an error occurs:

    14

#import cgitb; cgitb.enable()

    15

    16

from mercurial import demandimport; demandimport.enable()

    17

from mercurial.hgweb import hgweb, wsgicgi

    18

application = hgweb(config)

    19

wsgicgi.launch(application)