-
Notifications
You must be signed in to change notification settings - Fork 3
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
🔧 Add missing Django CORS headers settings
- Loading branch information
Showing
3 changed files
with
206 additions
and
4 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,14 @@ | ||
| import factory | ||
|
|
||
|
|
||
| class UserFactory(factory.django.DjangoModelFactory): | ||
| username = factory.Sequence(lambda n: f"user-{n}") | ||
| password = factory.PostGenerationMethodCall("set_password", "secret") | ||
|
|
||
| class Meta: | ||
| model = "accounts.User" | ||
|
|
||
|
|
||
| class SuperUserFactory(UserFactory): | ||
| is_staff = True | ||
| is_superuser = True |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,156 @@ | ||
| # Documentation on CORS spec, see MDN | ||
| # https://developer.mozilla.org/en-US/docs/Glossary/Preflight_request | ||
| from unittest.mock import patch | ||
|
|
||
| from django.test import override_settings | ||
| from django.urls import path | ||
|
|
||
| from rest_framework import views | ||
| from rest_framework.response import Response | ||
| from rest_framework.test import APITestCase | ||
|
|
||
| from openklant.accounts.tests.factories import SuperUserFactory | ||
|
|
||
|
|
||
| class View(views.APIView): | ||
| def get(self, request, *args, **kwargs): | ||
| return Response({"ok": True}) | ||
|
|
||
| post = get | ||
|
|
||
|
|
||
| urlpatterns = [path("cors", View.as_view())] | ||
|
|
||
|
|
||
| class CorsMixin: | ||
| def setUp(self): | ||
| super().setUp() | ||
| mocker = patch( | ||
| "openklant.utils.middleware.get_version_mapping", | ||
| return_value={"/": "1.0.0"}, | ||
| ) | ||
| mocker.start() | ||
| self.addCleanup(mocker.stop) | ||
|
|
||
|
|
||
| @override_settings(ROOT_URLCONF="openklant.tests.test_cors_configuration") | ||
| class DefaultCORSConfigurationTests(CorsMixin, APITestCase): | ||
| """ | ||
| Test the default CORS settings. | ||
| """ | ||
|
|
||
| def test_preflight_request(self): | ||
| """ | ||
| Test the most basic preflight request. | ||
| """ | ||
| response = self.client.options( | ||
| "/cors", | ||
| HTTP_ACCESS_CONTROL_REQUEST_METHOD="POST", | ||
| HTTP_ACCESS_CONTROL_REQUEST_HEADERS="origin, x-requested-with", | ||
| HTTP_ORIGIN="https://evil.com", | ||
| ) | ||
|
|
||
| self.assertNotIn("Access-Control-Allow-Origin", response) | ||
| self.assertNotIn("Access-Control-Allow-Credentials", response) | ||
|
|
||
| def test_credentialed_request(self): | ||
| user = SuperUserFactory.create(password="secret") | ||
| self.client.force_login(user=user) | ||
|
|
||
| response = self.client.get( | ||
| "/cors", | ||
| HTTP_ORIGIN="https://evil.com", | ||
| ) | ||
|
|
||
| self.assertNotIn("Access-Control-Allow-Origin", response) | ||
| self.assertNotIn("Access-Control-Allow-Credentials", response) | ||
|
|
||
|
|
||
| @override_settings( | ||
| ROOT_URLCONF="openklant.tests.test_cors_configuration", | ||
| CORS_ALLOW_ALL_ORIGINS=True, | ||
| CORS_ALLOW_CREDENTIALS=False, | ||
| ) | ||
| class CORSEnabledWithoutCredentialsTests(CorsMixin, APITestCase): | ||
| """ | ||
| Test the default CORS settings. | ||
| """ | ||
|
|
||
| def test_preflight_request(self): | ||
| """ | ||
| Test the most basic preflight request. | ||
| """ | ||
| response = self.client.options( | ||
| "/cors", | ||
| HTTP_ACCESS_CONTROL_REQUEST_METHOD="POST", | ||
| HTTP_ACCESS_CONTROL_REQUEST_HEADERS="origin, x-requested-with", | ||
| HTTP_ORIGIN="https://evil.com", | ||
| ) | ||
|
|
||
| # wildcard "*" prevents browsers from sending credentials - this is good | ||
| self.assertNotEqual(response["Access-Control-Allow-Origin"], "https://evil.com") | ||
| self.assertEqual(response["Access-Control-Allow-Origin"], "*") | ||
| self.assertNotIn("Access-Control-Allow-Credentials", response) | ||
|
|
||
| def test_simple_request(self): | ||
| response = self.client.get( | ||
| "/cors", | ||
| HTTP_ORIGIN="https://evil.com", | ||
| ) | ||
|
|
||
| # wildcard "*" prevents browsers from sending credentials - this is good | ||
| self.assertNotEqual(response["Access-Control-Allow-Origin"], "https://evil.com") | ||
| self.assertEqual(response["Access-Control-Allow-Origin"], "*") | ||
| self.assertNotIn("Access-Control-Allow-Credentials", response) | ||
|
|
||
| def test_credentialed_request(self): | ||
| user = SuperUserFactory.create(password="secret") | ||
| self.client.force_login(user=user) | ||
|
|
||
| response = self.client.get( | ||
| "/cors", | ||
| HTTP_ORIGIN="https://evil.com", | ||
| ) | ||
|
|
||
| # wildcard "*" prevents browsers from sending credentials - this is good | ||
| self.assertNotEqual(response["Access-Control-Allow-Origin"], "https://evil.com") | ||
| self.assertEqual(response["Access-Control-Allow-Origin"], "*") | ||
| self.assertNotIn("Access-Control-Allow-Credentials", response) | ||
|
|
||
|
|
||
| @override_settings( | ||
| ROOT_URLCONF="openklant.tests.test_cors_configuration", | ||
| CORS_ALLOW_ALL_ORIGINS=True, | ||
| CORS_ALLOW_CREDENTIALS=False, | ||
| ) | ||
| class CORSEnabledWithAuthHeaderTests(CorsMixin, APITestCase): | ||
| def test_preflight_request(self): | ||
| """ | ||
| Test a pre-flight request for requests including the HTTP Authorization header. | ||
| The inclusion of htis header makes it a not-simple request, see | ||
| https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS#Simple_requests | ||
| """ | ||
| response = self.client.options( | ||
| "/cors", | ||
| HTTP_ACCESS_CONTROL_REQUEST_METHOD="GET", | ||
| HTTP_ACCESS_CONTROL_REQUEST_HEADERS="origin, x-requested-with, authorization", | ||
| HTTP_ORIGIN="https://evil.com", | ||
| ) | ||
|
|
||
| self.assertEqual(response["Access-Control-Allow-Origin"], "*") | ||
| self.assertIn( | ||
| "authorization", | ||
| response["Access-Control-Allow-Headers"].lower(), | ||
| ) | ||
| self.assertNotIn("Access-Control-Allow-Credentials", response) | ||
|
|
||
| def test_credentialed_request(self): | ||
| response = self.client.get( | ||
| "/cors", | ||
| HTTP_ORIGIN="http://localhost:3000", | ||
| HTTP_AUTHORIZATION="Bearer foobarbaz", | ||
| ) | ||
|
|
||
| self.assertEqual(response["Access-Control-Allow-Origin"], "*") | ||
| self.assertNotIn("Access-Control-Allow-Credentials", response) |