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

Commit

Permalink
Fix existing v2 identity server calls (MSC2140) (#6013)
Browse files Browse the repository at this point in the history
Two things I missed while implementing [MSC2140](https://github.com/matrix-org/matrix-doc/pull/2140/files#diff-c03a26de5ac40fb532de19cb7fc2aaf7R80).

1. Access tokens should be provided to the identity server as `access_token`, not `id_access_token`, even though the homeserver may accept the tokens as `id_access_token`.
2. Access tokens must be sent to the identity server in a query parameter, the JSON body is not allowed.

We now send the access token as part of an `Authorization: ...` header, which fixes both things.

The breaking code was added in #5892

Sytest PR: matrix-org/sytest#697
  • Loading branch information
anoadragon453 committed Sep 13, 2019
1 parent 44d2ca2 commit e0eef47
Show file tree
Hide file tree
Showing 2 changed files with 27 additions and 2 deletions.
1 change: 1 addition & 0 deletions changelog.d/6013.misc
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Compatibility with v2 Identity Service APIs other than /lookup.
28 changes: 26 additions & 2 deletions synapse/handlers/identity.py
Original file line number Diff line number Diff line change
Expand Up @@ -74,6 +74,25 @@ def _extract_items_from_creds_dict(self, creds):
id_access_token = creds.get("id_access_token")
return client_secret, id_server, id_access_token

def create_id_access_token_header(self, id_access_token):
"""Create an Authorization header for passing to SimpleHttpClient as the header value
of an HTTP request.
Args:
id_access_token (str): An identity server access token.
Returns:
list[str]: The ascii-encoded bearer token encased in a list.
"""
# Prefix with Bearer
bearer_token = "Bearer %s" % id_access_token

# Encode headers to standard ascii
bearer_token.encode("ascii")

# Return as a list as that's how SimpleHttpClient takes header values
return [bearer_token]

@defer.inlineCallbacks
def threepid_from_creds(self, id_server, creds):
"""
Expand Down Expand Up @@ -149,15 +168,20 @@ def bind_threepid(self, creds, mxid, use_v2=True):
use_v2 = False

# Decide which API endpoint URLs to use
headers = {}
bind_data = {"sid": creds["sid"], "client_secret": client_secret, "mxid": mxid}
if use_v2:
bind_url = "https://%s/_matrix/identity/v2/3pid/bind" % (id_server,)
bind_data["id_access_token"] = id_access_token
headers["Authorization"] = self.create_id_access_token_header(
id_access_token
)
else:
bind_url = "https://%s/_matrix/identity/api/v1/3pid/bind" % (id_server,)

try:
data = yield self.http_client.post_json_get_json(bind_url, bind_data)
data = yield self.http_client.post_json_get_json(
bind_url, bind_data, headers=headers
)
logger.debug("bound threepid %r to %s", creds, mxid)

# Remember where we bound the threepid
Expand Down

0 comments on commit e0eef47

Please sign in to comment.