Skip to content
This repository has been archived by the owner on Apr 26, 2024. It is now read-only.

Implementation of HTTP 307 response for MSC3886 POST endpoint #14018

Merged
merged 30 commits into from
Oct 18, 2022
Merged
Show file tree
Hide file tree
Changes from 15 commits
Commits
Show all changes
30 commits
Select commit Hold shift + click to select a range
73dace0
Implementation of HTTP 307 endpoint for MSC3886
hughns Oct 3, 2022
4294327
Linting
hughns Oct 3, 2022
923bcbd
Merge remote-tracking branch 'upstream/develop' into hughns/msc3886-r…
hughns Oct 6, 2022
f330b0f
Changelog
hughns Oct 6, 2022
81ff46d
Lint fixes
hughns Oct 6, 2022
b5eb427
Fix docs
hughns Oct 6, 2022
e190693
Merge branch 'develop' into hughns/msc3886-redirect
hughns Oct 6, 2022
21e9d50
Merge branch 'matrix-org:develop' into hughns/msc3886-redirect
hughns Oct 7, 2022
4656642
FIx passing of experimental_cors_msc3886 around site
hughns Oct 7, 2022
f0218a6
Lint fix
hughns Oct 7, 2022
c838182
Merge branch 'matrix-org:develop' into hughns/msc3886-redirect
hughns Oct 7, 2022
8a81b3c
Actually test for correct response code
hughns Oct 7, 2022
7e9b07d
Merge branch 'develop' into hughns/msc3886-redirect
hughns Oct 7, 2022
d8f927e
Merge branch 'matrix-org:develop' into hughns/msc3886-redirect
hughns Oct 10, 2022
2ea6295
Expand reference to MSC3886
hughns Oct 11, 2022
68887e7
Remove unnecessary usage of getattr
hughns Oct 11, 2022
e3fcdea
Document param
hughns Oct 11, 2022
261d098
Document function args
hughns Oct 11, 2022
208b598
Make handling of "" endpoint explicit
hughns Oct 11, 2022
81fb879
Fix and improve docs
hughns Oct 11, 2022
61e417e
Linting
hughns Oct 11, 2022
441c299
Merge branch 'matrix-org:develop' into hughns/msc3886-redirect
hughns Oct 11, 2022
a6ddd03
Make typing of set_cors_headers explicit
hughns Oct 11, 2022
08aaafc
Fixup more references to SynapseRequest
hughns Oct 11, 2022
fc67315
Satisfy linter
hughns Oct 11, 2022
50ce7e3
Add experimental_cors_msc3886 to FakeSite
hughns Oct 11, 2022
05a516b
Linting
hughns Oct 11, 2022
ae5fd0d
Include experimental_cors_msc3886 in mock site
hughns Oct 11, 2022
26f2804
Update synapse/config/server.py
hughns Oct 12, 2022
ba87974
Merge branch 'develop' of github.com:matrix-org/synapse into hughns/m…
anoadragon453 Oct 18, 2022
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
2 changes: 1 addition & 1 deletion changelog.d/14018.feature
Original file line number Diff line number Diff line change
@@ -1 +1 @@
Support for redirecting to an implementation of [MSC3886](https://github.com/matrix-org/matrix-spec-proposals/pull/3886).
Support for redirecting to an implementation of a [MSC3886](https://github.com/matrix-org/matrix-spec-proposals/pull/3886) HTTP rendezvous service.
2 changes: 2 additions & 0 deletions synapse/config/server.py
Original file line number Diff line number Diff line change
Expand Up @@ -207,6 +207,8 @@ class HttpListenerConfig:
additional_resources: Dict[str, dict] = attr.Factory(dict)
tag: Optional[str] = None
request_id_header: Optional[str] = None
# If true, the listener will return CORS responses compatible with MSC3886:
hughns marked this conversation as resolved.
Show resolved Hide resolved
# https://github.com/matrix-org/matrix-spec-proposals/pull/3886
experimental_cors_msc3886: bool = False
hughns marked this conversation as resolved.
Show resolved Hide resolved


Expand Down
2 changes: 1 addition & 1 deletion synapse/handlers/sso.py
Original file line number Diff line number Diff line change
Expand Up @@ -874,7 +874,7 @@ async def handle_submit_username_request(
)

async def handle_terms_accepted(
self, request: Request, session_id: str, terms_version: str
self, request: SynapseRequest, session_id: str, terms_version: str
) -> None:
"""Handle a request to the new-user 'consent' endpoint

Expand Down
22 changes: 15 additions & 7 deletions synapse/http/server.py
Original file line number Diff line number Diff line change
Expand Up @@ -340,7 +340,7 @@ async def _async_render(self, request: SynapseRequest) -> Optional[Tuple[int, An

return callback_return

_unrecognised_request_handler(request)
return _unrecognised_request_handler(request)

@abc.abstractmethod
def _send_response(
Expand Down Expand Up @@ -599,7 +599,7 @@ def getChild(self, name: str, request: Request) -> resource.Resource:
class OptionsResource(resource.Resource):
"""Responds to OPTION requests for itself and all children."""

def render_OPTIONS(self, request: Request) -> bytes:
def render_OPTIONS(self, request: SynapseRequest) -> bytes:
request.setResponseCode(204)
request.setHeader(b"Content-Length", b"0")

Expand Down Expand Up @@ -764,7 +764,7 @@ def respond_with_json(


def respond_with_json_bytes(
request: Request,
request: SynapseRequest,
code: int,
json_bytes: bytes,
send_cors: bool = False,
Expand Down Expand Up @@ -860,7 +860,7 @@ def _write_bytes_to_request(request: Request, bytes_to_write: bytes) -> None:
_ByteProducer(request, bytes_generator)


def set_cors_headers(request: Request) -> None:
def set_cors_headers(request: SynapseRequest) -> None:
"""Set the CORS headers so that javascript running in a web browsers can
use this API

Expand All @@ -871,7 +871,7 @@ def set_cors_headers(request: Request) -> None:
request.setHeader(
b"Access-Control-Allow-Methods", b"GET, HEAD, POST, PUT, DELETE, OPTIONS"
)
if getattr(request, "experimental_cors_msc3886", False):
if request.experimental_cors_msc3886:
request.setHeader(
b"Access-Control-Allow-Headers",
b"X-Requested-With, Content-Type, Authorization, Date, If-Match, If-None-Match",
Expand Down Expand Up @@ -954,9 +954,17 @@ def set_clickjacking_protection_headers(request: Request) -> None:


def respond_with_redirect(
request: Request, url: bytes, statusCode: int = FOUND, cors: bool = False
request: SynapseRequest, url: bytes, statusCode: int = FOUND, cors: bool = False
) -> None:
"""Write a 302 (or other specified status code) response to the request, if it is still alive."""
"""
Write a 302 (or other specified status code) response to the request, if it is still alive.

Args:
request: The http request to respond to.
url: The URL to redirect to.
statusCode: The HTTP status code to use for the redirect (defaults to 302).
cors: Whether to set CORS headers on the response.
"""
logger.debug("Redirect to %s", url.decode("utf-8"))

if cors:
Expand Down
4 changes: 1 addition & 3 deletions synapse/http/site.py
Original file line number Diff line number Diff line change
Expand Up @@ -82,9 +82,7 @@ def __init__(
self.reactor = site.reactor
self._channel = channel # this is used by the tests
self.start_time = 0.0
self.experimental_cors_msc3886 = getattr(
site, "experimental_cors_msc3886", False
)
self.experimental_cors_msc3886 = site.experimental_cors_msc3886

# The requester, if authenticated. For federation requests this is the
# server name, for client requests this is the Requester object.
Expand Down
17 changes: 13 additions & 4 deletions synapse/rest/client/rendezvous.py
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@

import logging
from http.client import TEMPORARY_REDIRECT
from typing import TYPE_CHECKING
from typing import TYPE_CHECKING, Optional

from synapse.http.server import HttpServer, respond_with_redirect
from synapse.http.servlet import RestServlet
Expand All @@ -29,8 +29,12 @@

class RendezvousServlet(RestServlet):
"""
Get a token that can be used with `m.login.token` to log in a second device.
This implementation is a stub that redirects to another configured endpoint.
This is a placeholder implementation of [MSC3886](https://github.com/matrix-org/matrix-spec-proposals/pull/3886)
simple client rendezvous capability that is used by the "Sign in with QR" functionality.

This implementation only serves as a 307 redirect to a configured server rather than being a full implementation.

A module that implements the full functionality is available at: https://pypi.org/project/matrix-http-rendezvous-synapse/.

Request:

Expand All @@ -51,14 +55,19 @@ class RendezvousServlet(RestServlet):

def __init__(self, hs: "HomeServer"):
super().__init__()
redirection_target: str = hs.config.experimental.msc3886_endpoint or ""
redirection_target: Optional[str] = hs.config.experimental.msc3886_endpoint
assert (
redirection_target is not None
), "Servlet is only registered if there is a redirection target"
self.endpoint = redirection_target.encode("utf-8")

async def on_POST(self, request: SynapseRequest) -> None:
hughns marked this conversation as resolved.
Show resolved Hide resolved
respond_with_redirect(
request, self.endpoint, statusCode=TEMPORARY_REDIRECT, cors=True
)

# PUT, GET and DELETE are not implemented as they should be fulfilled by the redirect target.


def register_servlets(hs: "HomeServer", http_server: HttpServer) -> None:
if hs.config.experimental.msc3886_endpoint is not None:
Expand Down
4 changes: 2 additions & 2 deletions synapse/rest/key/v2/local_key_resource.py
Original file line number Diff line number Diff line change
Expand Up @@ -20,9 +20,9 @@
from unpaddedbase64 import encode_base64

from twisted.web.resource import Resource
from twisted.web.server import Request

from synapse.http.server import respond_with_json_bytes
from synapse.http.site import SynapseRequest
from synapse.types import JsonDict

if TYPE_CHECKING:
Expand Down Expand Up @@ -99,7 +99,7 @@ def response_json_object(self) -> JsonDict:
json_object = sign_json(json_object, self.config.server.server_name, key)
return json_object

def render_GET(self, request: Request) -> Optional[int]:
def render_GET(self, request: SynapseRequest) -> Optional[int]:
time_now = self.clock.time_msec()
# Update the expiry time if less than half the interval remains.
if time_now + self.config.key.key_refresh_interval / 2 > self.valid_until_ts:
Expand Down
3 changes: 2 additions & 1 deletion synapse/rest/synapse/client/new_user_consent.py
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@
from synapse.handlers.sso import get_username_mapping_session_cookie_from_request
from synapse.http.server import DirectServeHtmlResource, respond_with_html
from synapse.http.servlet import parse_string
from synapse.http.site import SynapseRequest
from synapse.types import UserID
from synapse.util.templates import build_jinja_env

Expand Down Expand Up @@ -88,7 +89,7 @@ async def _async_render_GET(self, request: Request) -> None:
html = template.render(template_params)
respond_with_html(request, 200, html)

async def _async_render_POST(self, request: Request) -> None:
async def _async_render_POST(self, request: SynapseRequest) -> None:
try:
session_id = get_username_mapping_session_cookie_from_request(request)
except SynapseError as e:
Expand Down
3 changes: 2 additions & 1 deletion synapse/rest/well_known.py
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@
from twisted.web.server import Request

from synapse.http.server import set_cors_headers
from synapse.http.site import SynapseRequest
from synapse.types import JsonDict
from synapse.util import json_encoder
from synapse.util.stringutils import parse_server_name
Expand Down Expand Up @@ -63,7 +64,7 @@ def __init__(self, hs: "HomeServer"):
Resource.__init__(self)
self._well_known_builder = WellKnownBuilder(hs)

def render_GET(self, request: Request) -> bytes:
def render_GET(self, request: SynapseRequest) -> bytes:
set_cors_headers(request)
r = self._well_known_builder.get_well_known()
if not r:
Expand Down
1 change: 1 addition & 0 deletions tests/logging/test_terse_json.py
Original file line number Diff line number Diff line change
Expand Up @@ -153,6 +153,7 @@ def test_with_request_context(self):
site.site_tag = "test-site"
site.server_version_string = "Server v1"
site.reactor = Mock()
site.experimental_cors_msc3886 = False
request = SynapseRequest(FakeChannel(site, None), site)
# Call requestReceived to finish instantiating the object.
request.content = BytesIO()
Expand Down
8 changes: 7 additions & 1 deletion tests/server.py
Original file line number Diff line number Diff line change
Expand Up @@ -266,14 +266,20 @@ class FakeSite:
site_tag = "test"
access_logger = logging.getLogger("synapse.access.http.fake")

def __init__(self, resource: IResource, reactor: IReactorTime):
def __init__(
self,
resource: IResource,
reactor: IReactorTime,
experimental_cors_msc3886: bool = False,
):
"""

Args:
resource: the resource to be used for rendering all requests
"""
self._resource = resource
self.reactor = reactor
self.experimental_cors_msc3886 = experimental_cors_msc3886

def getResourceFor(self, request):
return self._resource
Expand Down