MatrixSynapse/synapse/handlers/identity.py

285 lines
9.9 KiB
Python
Raw Normal View History

2015-04-15 16:50:38 +02:00
# -*- coding: utf-8 -*-
2016-01-07 05:26:29 +01:00
# Copyright 2015, 2016 OpenMarket Ltd
# Copyright 2017 Vector Creations Ltd
# Copyright 2018 New Vector Ltd
2015-04-15 16:50:38 +02:00
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
"""Utilities for interacting with Identity Servers"""
import logging
from canonicaljson import json
2015-04-15 16:50:38 +02:00
from twisted.internet import defer
from synapse.api.errors import (
2018-07-09 08:09:20 +02:00
CodeMessageException,
Codes,
HttpResponseException,
2018-07-09 08:09:20 +02:00
SynapseError,
2015-04-15 16:50:38 +02:00
)
2018-07-09 08:09:20 +02:00
2015-04-15 16:50:38 +02:00
from ._base import BaseHandler
logger = logging.getLogger(__name__)
class IdentityHandler(BaseHandler):
def __init__(self, hs):
super(IdentityHandler, self).__init__(hs)
self.http_client = hs.get_simple_http_client()
self.federation_http_client = hs.get_http_client()
self.trusted_id_servers = set(hs.config.trusted_third_party_id_servers)
self.trust_any_id_server_just_for_testing_do_not_use = (
hs.config.use_insecure_ssl_client_just_for_testing_do_not_use
)
def _should_trust_id_server(self, id_server):
if id_server not in self.trusted_id_servers:
if self.trust_any_id_server_just_for_testing_do_not_use:
logger.warn(
"Trusting untrustworthy ID server %r even though it isn't"
" in the trusted id list for testing because"
" 'use_insecure_ssl_client_just_for_testing_do_not_use'"
" is set in the config",
id_server,
)
else:
return False
return True
2015-04-15 16:50:38 +02:00
@defer.inlineCallbacks
def threepid_from_creds(self, creds):
2019-06-20 11:32:02 +02:00
if "id_server" in creds:
id_server = creds["id_server"]
elif "idServer" in creds:
id_server = creds["idServer"]
else:
raise SynapseError(400, "No id_server in creds")
2019-06-20 11:32:02 +02:00
if "client_secret" in creds:
client_secret = creds["client_secret"]
elif "clientSecret" in creds:
client_secret = creds["clientSecret"]
else:
raise SynapseError(400, "No client_secret in creds")
if not self._should_trust_id_server(id_server):
logger.warn(
2019-06-20 11:32:02 +02:00
"%s is not a trusted ID server: rejecting 3pid " + "credentials",
id_server,
)
defer.returnValue(None)
2015-04-15 16:50:38 +02:00
try:
data = yield self.http_client.get_json(
2019-06-20 11:32:02 +02:00
"https://%s%s"
% (id_server, "/_matrix/identity/api/v1/3pid/getValidated3pid"),
{"sid": creds["sid"], "client_secret": client_secret},
2015-04-15 16:50:38 +02:00
)
except HttpResponseException as e:
logger.info("getValidated3pid failed with Matrix error: %r", e)
raise e.to_synapse_error()
2015-04-15 16:50:38 +02:00
2019-06-20 11:32:02 +02:00
if "medium" in data:
2015-04-15 16:50:38 +02:00
defer.returnValue(data)
defer.returnValue(None)
@defer.inlineCallbacks
def bind_threepid(self, creds, mxid):
logger.debug("binding threepid %r to %s", creds, mxid)
data = None
2019-06-20 11:32:02 +02:00
if "id_server" in creds:
id_server = creds["id_server"]
elif "idServer" in creds:
id_server = creds["idServer"]
else:
raise SynapseError(400, "No id_server in creds")
2019-06-20 11:32:02 +02:00
if "client_secret" in creds:
client_secret = creds["client_secret"]
elif "clientSecret" in creds:
client_secret = creds["clientSecret"]
else:
raise SynapseError(400, "No client_secret in creds")
try:
2019-07-10 16:56:21 +02:00
data = yield self.http_client.post_json_get_json(
2019-06-20 11:32:02 +02:00
"https://%s%s" % (id_server, "/_matrix/identity/api/v1/3pid/bind"),
{"sid": creds["sid"], "client_secret": client_secret, "mxid": mxid},
)
logger.debug("bound threepid %r to %s", creds, mxid)
# Remember where we bound the threepid
yield self.store.add_user_bound_threepid(
user_id=mxid,
medium=data["medium"],
address=data["address"],
id_server=id_server,
)
except CodeMessageException as e:
data = json.loads(e.msg) # XXX WAT?
2015-04-17 17:46:45 +02:00
defer.returnValue(data)
@defer.inlineCallbacks
def try_unbind_threepid(self, mxid, threepid):
"""Removes a binding from an identity server
2018-06-04 13:00:51 +02:00
Args:
mxid (str): Matrix user ID of binding to be removed
2019-04-02 12:15:19 +02:00
threepid (dict): Dict with medium & address of binding to be
removed, and an optional id_server.
2018-06-04 13:00:51 +02:00
Raises:
SynapseError: If we failed to contact the identity server
2018-06-04 13:00:51 +02:00
Returns:
Deferred[bool]: True on success, otherwise False if the identity
2019-04-02 12:15:19 +02:00
server doesn't support unbinding (or no identity server found to
contact).
2018-06-04 13:00:51 +02:00
"""
if threepid.get("id_server"):
id_servers = [threepid["id_server"]]
else:
id_servers = yield self.store.get_id_servers_user_bound(
2019-06-20 11:32:02 +02:00
user_id=mxid, medium=threepid["medium"], address=threepid["address"]
)
# We don't know where to unbind, so we don't have a choice but to return
if not id_servers:
defer.returnValue(False)
2018-05-24 12:19:59 +02:00
changed = True
for id_server in id_servers:
changed &= yield self.try_unbind_threepid_with_id_server(
2019-06-20 11:32:02 +02:00
mxid, threepid, id_server
)
defer.returnValue(changed)
@defer.inlineCallbacks
def try_unbind_threepid_with_id_server(self, mxid, threepid, id_server):
"""Removes a binding from an identity server
Args:
mxid (str): Matrix user ID of binding to be removed
threepid (dict): Dict with medium & address of binding to be removed
id_server (str): Identity server to unbind from
Raises:
SynapseError: If we failed to contact the identity server
Returns:
Deferred[bool]: True on success, otherwise False if the identity
server doesn't support unbinding
"""
url = "https://%s/_matrix/identity/api/v1/3pid/unbind" % (id_server,)
content = {
"mxid": mxid,
2019-06-20 11:32:02 +02:00
"threepid": {"medium": threepid["medium"], "address": threepid["address"]},
}
# we abuse the federation http client to sign the request, but we have to send it
# using the normal http client since we don't want the SRV lookup and want normal
# 'browser-like' HTTPS.
auth_headers = self.federation_http_client.build_auth_headers(
destination=None,
2019-06-20 11:32:02 +02:00
method="POST",
url_bytes="/_matrix/identity/api/v1/3pid/unbind".encode("ascii"),
content=content,
destination_is=id_server,
)
2019-06-20 11:32:02 +02:00
headers = {b"Authorization": auth_headers}
try:
2019-06-20 11:32:02 +02:00
yield self.http_client.post_json_get_json(url, content, headers)
changed = True
except HttpResponseException as e:
changed = False
2019-06-20 11:32:02 +02:00
if e.code in (400, 404, 501):
# The remote server probably doesn't support unbinding (yet)
2018-08-09 11:09:56 +02:00
logger.warn("Received %d response while unbinding threepid", e.code)
else:
2018-08-09 11:09:56 +02:00
logger.error("Failed to unbind threepid on identity server: %s", e)
raise SynapseError(502, "Failed to contact identity server")
yield self.store.remove_user_bound_threepid(
user_id=mxid,
medium=threepid["medium"],
address=threepid["address"],
id_server=id_server,
)
defer.returnValue(changed)
@defer.inlineCallbacks
def requestEmailToken(
2019-06-20 11:32:02 +02:00
self, id_server, email, client_secret, send_attempt, next_link=None
):
if not self._should_trust_id_server(id_server):
raise SynapseError(
2019-06-20 11:32:02 +02:00
400, "Untrusted ID server '%s'" % id_server, Codes.SERVER_NOT_TRUSTED
)
params = {
2019-06-20 11:32:02 +02:00
"email": email,
"client_secret": client_secret,
"send_attempt": send_attempt,
}
if next_link:
2019-06-20 11:32:02 +02:00
params.update({"next_link": next_link})
try:
data = yield self.http_client.post_json_get_json(
2019-06-20 11:32:02 +02:00
"https://%s%s"
% (id_server, "/_matrix/identity/api/v1/validate/email/requestToken"),
params,
)
defer.returnValue(data)
except HttpResponseException as e:
logger.info("Proxied requestToken failed: %r", e)
raise e.to_synapse_error()
@defer.inlineCallbacks
def requestMsisdnToken(
2019-06-20 11:32:02 +02:00
self, id_server, country, phone_number, client_secret, send_attempt, **kwargs
):
if not self._should_trust_id_server(id_server):
raise SynapseError(
2019-06-20 11:32:02 +02:00
400, "Untrusted ID server '%s'" % id_server, Codes.SERVER_NOT_TRUSTED
)
params = {
2019-06-20 11:32:02 +02:00
"country": country,
"phone_number": phone_number,
"client_secret": client_secret,
"send_attempt": send_attempt,
}
params.update(kwargs)
try:
data = yield self.http_client.post_json_get_json(
2019-06-20 11:32:02 +02:00
"https://%s%s"
% (id_server, "/_matrix/identity/api/v1/validate/msisdn/requestToken"),
params,
)
defer.returnValue(data)
except HttpResponseException as e:
logger.info("Proxied requestToken failed: %r", e)
raise e.to_synapse_error()