Nuxeo Core Developer Guide

Cross Site Scripting

Updated: October 22, 2018 Page Information Edit on GitHub

About Cross Site Scripting (XSS)

The problem occurs when some data entered by the user get's injected inside the web page. If the input is not correctly escaped this can allow to inject malicious JavaScript that will be executed in the context of the page.

Typically, any server side variable initialized by a user input should be properly escaped before being written in the page.

Escaping depends on the context:

  • escape tags for HTML injection,
  • escape quotes and closing tags for JavaScript injection.

Avoiding XSS inside Nuxeo

Stored Fields

Fields stored inside the Nuxeo Platform and that may contain HTML/JS that could be integrated inside a page should be escaped.

For that, the Nuxeo Platform provide a built-in sanitizer that is plugged to a Core EventListener: it can be run to check / escape content each time a field is updated.

This is controlled by HtmlSanitizerService. You can use the sanitizer extension point to define what fields you want to be automatically sanitized.

See: HtmlSanitizerService--sanitizer

Query Params

When the data directly comes from a parameter of the request (or similar), the data must be properly escaped.

Java Code

If you want to do the escaping on the pure server side, in Java, you can use org.apache.commons.lang.StringEscapeUtils:

  • StringEscapeUtils.escapeHtml(data);
  • StringEscapeUtils.escapeJavaScript(data);JSF / XHTML

By default JSF automatically does HTML escaping unless told not to. The Nuxeo Platform provides escaping functions for both HTML and JavaScript:

  • #{nxu:javaScriptEscape(data)}
  • #{nxu:htmlEscape(data)}

FreeMarker

In FreeMarker you can use the two built-in escapes:

  • ${data?html}
  • ${data?js_string}

Cross-Site Request Forgery (CSRF)

JSF UI 

Thanks to the JSF ViewState management, all active (POST) requests have to be associated with a correct (non guessable) ViewState id : this makes a built-in CSRF protection.

Automation API

Automation API is by default exposed via JAX-RS and it does not include any specific filtering related to CSRF.

However, the Binding extension point of AutomationServer allows to define filtering rules on a per Operation basis.

In addition, most CSRF issues are related to users having valid authentication sessions : a simple protection can be to limit access to REST API to some specific authentication methods. Typically, you can easily define a custom Authentication chain that will be dedicated to REST Calls : this is actually the case by default with a configuration like :  

<specificAuthenticationChain name="Automation">
        <urlPatterns>
            <url>(.*)/automation.*</url>
        </urlPatterns>

        <replacementChain>
            <plugin>AUTOMATION_BASIC_AUTH</plugin>
            <plugin>ANONYMOUS_AUTH</plugin>
        </replacementChain>
    </specificAuthenticationChain>

Using a similar approach to can restrict this authenticator to "safe authenticators" like the Nuxeo Token Authentication.

NB : This is not done by default to avoid creating compatibility issues.

Alternatively, we are working on adding a dedicated filter that will allow to define more specific filters on API calls (see NXP-13644).

 

 

 

 

 

 

 

 

 

 

2 months ago manonlumeau NXDOC-1650 fix about integrating changes, add mention on multiple attempts
5 years ago Florent Guillaume 7 | SRF -> CSR
5 years ago Florent Guillaume 6 | explorer current -> latest
5 years ago Thierry Delprat 5
5 years ago Thierry Delprat 4
5 years ago Solen Guitter 3
5 years ago Solen Guitter 2 | Typos and formatting
5 years ago Thierry Delprat 1
History: Created by Thierry Delprat

We'd love to hear your thoughts!

All fields required