Modify rule S5144: Add HTTPX support (APPSEC-1247) (#3365)

## Review

A dedicated reviewer checked the rule description successfully for:

- [ ] logical errors and incorrect information
- [ ] information gaps and missing content
- [ ] text style and tone
- [ ] PR summary and labels follow [the
guidelines](https://github.com/SonarSource/rspec/#to-modify-an-existing-rule)
This commit is contained in:
Egon Okerman 2023-10-27 09:47:43 +02:00 committed by GitHub
parent effc29754f
commit 75e4b4815d
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 55 additions and 0 deletions

View File

@ -87,6 +87,7 @@
* Python Standard Library
* PyYAML
* Requests
* HTTPX
* SQLAlchemy
* Amazon DynamoDB
* python-ldap

View File

@ -0,0 +1,52 @@
== How to fix it in HTTPX
=== Code examples
include::../../common/fix/code-rationale.adoc[]
==== Noncompliant code example
[source,python,diff-id=21,diff-type=noncompliant]
----
from fastapi import FastAPI
import httpx
app = FastAPI()
@app.get('/example')
def example(url: str):
r = httpx.get(url) # Noncompliant
return {"response": r.text}
----
==== Compliant solution
[source,python,diff-id=21,diff-type=compliant]
----
from fastapi import FastAPI
from fastapi.responses import JSONResponse
import httpx
from urllib.parse import urlparse
DOMAINS_ALLOWLIST = ['trusted1.example.com', 'trusted2.example.com']
app = FastAPI()
@app.get('/example')
def example(url: str):
if not urlparse(url).hostname in DOMAINS_ALLOWLIST:
return JSONResponse({"error": f"URL {url} is not whitelisted."}, 400)
r = httpx.get(url)
return {"response": r.text}
----
=== How does this work?
include::../../common/fix/pre-approved-list.adoc[]
The compliant code example uses such an approach.
HTTPX implicitly validates the scheme as it only allows `http` and `https` by default.
=== Pitfalls
include::../../common/pitfalls/starts-with.adoc[]

View File

@ -10,6 +10,8 @@ include::how-to-fix-it/python.adoc[]
include::how-to-fix-it/requests.adoc[]
include::how-to-fix-it/httpx.adoc[]
== Resources
include::../common/resources/standards.adoc[]