summary refs log tree commit diff
diff options
context:
space:
mode:
authorMichael[tm] Smith <mike@w3.org>2021-06-23 19:25:03 +0900
committerGitHub <noreply@github.com>2021-06-23 11:25:03 +0100
commit27c06a6e0699f92bcd02b9e930dc8191ab87305e (patch)
tree4b738f8cb781cc7b0c1d709b9d2c6815f42452cf
parentFix schema delta to not take as long on large servers (#10227) (diff)
downloadsynapse-27c06a6e0699f92bcd02b9e930dc8191ab87305e.tar.xz
Drop Origin & Accept from Access-Control-Allow-Headers value (#10114)
* Drop Origin & Accept from Access-Control-Allow-Headers value

This change drops the Origin and Accept header names from the value of the
Access-Control-Allow-Headers response header sent by Synapse. Per the CORS
protocol, it’s not necessary or useful to include those header names.

Details:

Per-spec at https://fetch.spec.whatwg.org/#forbidden-header-name, Origin
is a “forbidden header name” set by the browser and that frontend
JavaScript code is never allowed to set.

So the value of Access-Control-Allow-Headers isn’t relevant to Origin or
in general to other headers set by the browser itself — the browser
never ever consults the Access-Control-Allow-Headers value to confirm
that it’s OK for the request to include an Origin header.

And per-spec at https://fetch.spec.whatwg.org/#cors-safelisted-request-header,
Accept is a “CORS-safelisted request-header”, which means that browsers
allow requests to contain the Accept header regardless of whether the
Access-Control-Allow-Headers value contains "Accept".

So it’s unnecessary for the Access-Control-Allow-Headers to explicitly
include Accept. Browsers will not perform a CORS preflight for requests
containing an Accept request header.

Related: https://github.com/matrix-org/matrix-doc/pull/3225

Signed-off-by: Michael[tm] Smith <mike@w3.org>

-rw-r--r--changelog.d/10114.misc1
-rw-r--r--synapse/http/server.py2
2 files changed, 2 insertions, 1 deletions
diff --git a/changelog.d/10114.misc b/changelog.d/10114.misc
new file mode 100644
index 0000000000..808548f7c7
--- /dev/null
+++ b/changelog.d/10114.misc
@@ -0,0 +1 @@
+Drop Origin and Accept from the value of the Access-Control-Allow-Headers response header.
diff --git a/synapse/http/server.py b/synapse/http/server.py
index 845651e606..efbc6d5b25 100644
--- a/synapse/http/server.py
+++ b/synapse/http/server.py
@@ -728,7 +728,7 @@ def set_cors_headers(request: Request):
     )
     request.setHeader(
         b"Access-Control-Allow-Headers",
-        b"Origin, X-Requested-With, Content-Type, Accept, Authorization, Date",
+        b"X-Requested-With, Content-Type, Authorization, Date",
     )