Optional whitespace support in Authorization (#1350)

element-hq · May 7, 2024 · 77711ee · 77711ee
1 parent 1b15536
commit 77711ee
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 1 deletion.
diff --git a/synapse/federation/transport/server/_base.py b/synapse/federation/transport/server/_base.py
@@ -180,7 +180,11 @@ def _parse_auth_header(header_bytes: bytes) -> Tuple[str, str, str, Optional[str
     """
     try:
         header_str = header_bytes.decode("utf-8")
-        params = re.split(" +", header_str)[1].split(",")
+        space_or_tab = "[ \t]"
+        params = re.split(
+            rf"{space_or_tab}*,{space_or_tab}*",
+            re.split(r"^X-Matrix +", header_str, maxsplit=1)[1],
+        )
         param_dict: Dict[str, str] = {
             k.lower(): v for k, v in [param.split("=", maxsplit=1) for param in params]
         }

diff --git a/tests/federation/transport/server/test__base.py b/tests/federation/transport/server/test__base.py
@@ -147,3 +147,10 @@ def test_authorization_header(self) -> None:
             ),
             ("foo", "ed25519:1", "sig", "bar"),
         )
+        # test that "optional whitespace(s)" (space and tabulation) are allowed between comma-separated auth-param components
+        self.assertEqual(
+            _parse_auth_header(
+                b'X-Matrix origin=foo , key="ed25519:1",  sig="sig",	destination="bar",		extra_field=ignored'
+            ),
+            ("foo", "ed25519:1", "sig", "bar"),
+        )