Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Modify rule S5131: Add FastAPI (APPSEC-1250) #3412

Merged
Merged
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Next Next commit
Add FastAPI
egon-okerman-sonarsource committed Jan 4, 2024

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature.
commit 8a85ea3e5b54bb5b5865f89faef85609a1cfa708
82 changes: 82 additions & 0 deletions rules/S5131/python/how-to-fix-it/fastapi.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,82 @@
== How to fix it in FastAPI

=== Code examples

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 `JsonResponse` class to return JSON messages securely.

It is also possible to set the `Content-Type` manually by using the `content_type` parameter of the `Response` constructor.

==== Noncompliant code example

[source,python,diff-id=41,diff-type=noncompliant]
----
from fastapi import FastAPI, Response
import json

app = FastAPI()

@app.get("/example")
def example(input: str):
json = json.dumps({"data": input})
return Response(json) # Noncompliant
----

[source,python,diff-id=42,diff-type=noncompliant]
----
from fastapi import FastAPI, Response

app = FastAPI()

@app.get("/example")
def example(input: str):
return Response(input) # Noncompliant
----

==== Compliant solution

[source,python,diff-id=41,diff-type=compliant]
----
from fastapi import FastAPI
from fastapi.responses import JSONResponse

app = FastAPI()

@app.get("/example")
def example(input: str):
return JSONResponse({"data": input})
----

[source,python,diff-id=42,diff-type=compliant]
----
from fastapi import FastAPI, Response

app = FastAPI()

@app.get("/example")
def example(input: str):
return Response(input, 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://jinja.palletsprojects.com/[Jinja] 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 correctly setting the `Content-Type` HTTP header.
This HTTP header defines which media type the browser can expect from the response, so the browser can parse it correctly. By specifying a type that is not HTML, the browser does not interpret the response as HTML, which in turn prevents cross-site scripting.

For example, when setting the `Content-Type` header to `text/plain`, browsers will interpret the HTTP response as plaintext and will not process it any further. This allows user input to be reflected safely.

=== Pitfalls

include::../../common/pitfalls/content-types.adoc[]

include::../../common/pitfalls/validation.adoc[]

=== Going the extra mile

include::../../common/extra-mile/csp.adoc[]

2 changes: 2 additions & 0 deletions rules/S5131/python/rule.adoc
Original file line number Diff line number Diff line change
@@ -16,6 +16,8 @@ include::how-to-fix-it/flask.adoc[]

include::how-to-fix-it/jinja.adoc[]

include::how-to-fix-it/fastapi.adoc[]

== Resources

include::../common/resources/docs.adoc[]