a3fc55943b
Fixing a typo in the noncompliant code example. I think this is now right, but please double-check me. ## Review A dedicated reviewer checked the rule description successfully for: - [x] logical errors and incorrect information - [x] information gaps and missing content - [x] text style and tone
71 lines
2.2 KiB
Plaintext
71 lines
2.2 KiB
Plaintext
== How to fix it in Express.js
|
|
|
|
=== Code examples
|
|
|
|
The following code is vulnerable to cross-site scripting because it returns an HTML response that contains unsanitized user input.
|
|
|
|
If you do not intend to send HTML code to clients, the vulnerability can be fixed by specifying the type of data returned in the response.
|
|
For example, you can use the `JsonResponse` class to safely return JSON messages.
|
|
|
|
==== Noncompliant code example
|
|
|
|
[source,javascript,diff-id=1,diff-type=noncompliant]
|
|
----
|
|
function (req, res) {
|
|
json = JSON.stringify({ "data": req.query.input });
|
|
res.send(json);
|
|
};
|
|
----
|
|
|
|
==== Compliant solution
|
|
|
|
[source,javascript,diff-id=1,diff-type=compliant]
|
|
----
|
|
function (req, res) {
|
|
res.json({ "data": req.query.input });
|
|
};
|
|
----
|
|
|
|
It is also possible to set the content-type header manually using the `content_type` parameter when creating an `HttpResponse` object.
|
|
|
|
==== Noncompliant code example
|
|
|
|
[source,javascript,diff-id=2,diff-type=noncompliant]
|
|
----
|
|
function (req, res) {
|
|
res.send(req.query.input);
|
|
};
|
|
----
|
|
|
|
==== Compliant solution
|
|
|
|
[source,javascript,diff-id=2,diff-type=compliant]
|
|
----
|
|
function (req, res) {
|
|
res.set('Content-Type', 'text/plain');
|
|
res.send(req.query.input);
|
|
};
|
|
----
|
|
|
|
=== How does this work?
|
|
|
|
In case the response consists of HTML code, it is highly recommended to use a template engine like https://ejs.co/[ejs] to generate it.
|
|
This template engine separates the view from the business logic and automatically encodes the output of variables, drastically reducing the risk of cross-site scripting vulnerabilities.
|
|
|
|
If you do not intend to send HTML code to clients, the vulnerability can be resolved by telling them what data they are receiving with the `content-type` HTTP header.
|
|
This header tells the browser that the response does not contain HTML code and should not be parsed and interpreted as HTML.
|
|
Thus, the HTTP response is not vulnerable to reflected Cross-Site Scripting.
|
|
|
|
For example, setting the content-type header to `text/plain` allows to safely reflect user input since browsers will not try to parse and execute the response.
|
|
|
|
=== Pitfalls
|
|
|
|
include::../../common/pitfalls/content-types.adoc[]
|
|
|
|
include::../../common/pitfalls/validation.adoc[]
|
|
|
|
=== Going the extra mile
|
|
|
|
include::../../common/extra-mile/csp.adoc[]
|
|
|