57 lines
2.0 KiB
Plaintext
57 lines
2.0 KiB
Plaintext
=== How to fix it in Laravel
|
|
|
|
The following code is vulnerable to cross-site scripting because it returns an HTML response that contains 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 `json` method of the `Response` class to safely return JSON messages.
|
|
|
|
==== Noncompliant code example
|
|
|
|
[source,php,diff-id=1,diff-type=noncompliant]
|
|
----
|
|
$response = response(json_encode(['data' => $input]), 200);
|
|
----
|
|
|
|
==== Compliant solution
|
|
|
|
[source,php,diff-id=1,diff-type=compliant]
|
|
----
|
|
$response = response()->json(['data' => $input]);
|
|
----
|
|
|
|
It is also possible to set the content-type header manually using the `header` method of the `Response` class.
|
|
|
|
==== Noncompliant code example
|
|
|
|
[source,php,diff-id=2,diff-type=noncompliant]
|
|
----
|
|
$response = response($input, 200);
|
|
----
|
|
|
|
==== Compliant solution
|
|
|
|
[source,php,diff-id=2,diff-type=compliant]
|
|
----
|
|
$response = response($input, 200)->header('Content-Type', 'text/plain');
|
|
----
|
|
|
|
=== How does this work?
|
|
|
|
If the HTTP response is HTML code, it is highly recommended to use a template engine like https://laravel.com/docs/9.x/blade[Blade] 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 fixed by specifying the type of data returned in the response 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 response is not vulnerable to reflected cross-site scripting.
|
|
|
|
For example, setting the content-type 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[]
|
|
|
|
=== Going the extra mile
|
|
|
|
include::../../common/extra-mile/csp.adoc[]
|
|
|