room_member.py 33 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931
  1. # -*- coding: utf-8 -*-
  2. # Copyright 2016 OpenMarket Ltd
  3. # Copyright 2018 New Vector Ltd
  4. #
  5. # Licensed under the Apache License, Version 2.0 (the "License");
  6. # you may not use this file except in compliance with the License.
  7. # You may obtain a copy of the License at
  8. #
  9. # http://www.apache.org/licenses/LICENSE-2.0
  10. #
  11. # Unless required by applicable law or agreed to in writing, software
  12. # distributed under the License is distributed on an "AS IS" BASIS,
  13. # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14. # See the License for the specific language governing permissions and
  15. # limitations under the License.
  16. import abc
  17. import logging
  18. from signedjson.key import decode_verify_key_bytes
  19. from signedjson.sign import verify_signed_json
  20. from twisted.internet import defer
  21. from unpaddedbase64 import decode_base64
  22. import synapse.types
  23. from synapse.api.constants import (
  24. EventTypes, Membership,
  25. )
  26. from synapse.api.errors import AuthError, SynapseError, Codes
  27. from synapse.types import UserID, RoomID
  28. from synapse.util.async import Linearizer
  29. from synapse.util.distributor import user_left_room, user_joined_room
  30. logger = logging.getLogger(__name__)
  31. id_server_scheme = "https://"
  32. class RoomMemberHandler(object):
  33. # TODO(paul): This handler currently contains a messy conflation of
  34. # low-level API that works on UserID objects and so on, and REST-level
  35. # API that takes ID strings and returns pagination chunks. These concerns
  36. # ought to be separated out a lot better.
  37. __metaclass__ = abc.ABCMeta
  38. def __init__(self, hs):
  39. self.hs = hs
  40. self.store = hs.get_datastore()
  41. self.auth = hs.get_auth()
  42. self.state_handler = hs.get_state_handler()
  43. self.config = hs.config
  44. self.simple_http_client = hs.get_simple_http_client()
  45. self.federation_handler = hs.get_handlers().federation_handler
  46. self.directory_handler = hs.get_handlers().directory_handler
  47. self.registration_handler = hs.get_handlers().registration_handler
  48. self.profile_handler = hs.get_profile_handler()
  49. self.event_creation_hander = hs.get_event_creation_handler()
  50. self.member_linearizer = Linearizer(name="member")
  51. self.clock = hs.get_clock()
  52. self.spam_checker = hs.get_spam_checker()
  53. @abc.abstractmethod
  54. def _remote_join(self, requester, remote_room_hosts, room_id, user, content):
  55. """Try and join a room that this server is not in
  56. Args:
  57. requester (Requester)
  58. remote_room_hosts (list[str]): List of servers that can be used
  59. to join via.
  60. room_id (str): Room that we are trying to join
  61. user (UserID): User who is trying to join
  62. content (dict): A dict that should be used as the content of the
  63. join event.
  64. Returns:
  65. Deferred
  66. """
  67. raise NotImplementedError()
  68. @abc.abstractmethod
  69. def _remote_reject_invite(self, remote_room_hosts, room_id, target):
  70. """Attempt to reject an invite for a room this server is not in. If we
  71. fail to do so we locally mark the invite as rejected.
  72. Args:
  73. requester (Requester)
  74. remote_room_hosts (list[str]): List of servers to use to try and
  75. reject invite
  76. room_id (str)
  77. target (UserID): The user rejecting the invite
  78. Returns:
  79. Deferred[dict]: A dictionary to be returned to the client, may
  80. include event_id etc, or nothing if we locally rejected
  81. """
  82. raise NotImplementedError()
  83. @abc.abstractmethod
  84. def get_or_register_3pid_guest(self, requester, medium, address, inviter_user_id):
  85. """Get a guest access token for a 3PID, creating a guest account if
  86. one doesn't already exist.
  87. Args:
  88. requester (Requester)
  89. medium (str)
  90. address (str)
  91. inviter_user_id (str): The user ID who is trying to invite the
  92. 3PID
  93. Returns:
  94. Deferred[(str, str)]: A 2-tuple of `(user_id, access_token)` of the
  95. 3PID guest account.
  96. """
  97. raise NotImplementedError()
  98. @abc.abstractmethod
  99. def _user_joined_room(self, target, room_id):
  100. """Notifies distributor on master process that the user has joined the
  101. room.
  102. Args:
  103. target (UserID)
  104. room_id (str)
  105. Returns:
  106. Deferred|None
  107. """
  108. raise NotImplementedError()
  109. @abc.abstractmethod
  110. def _user_left_room(self, target, room_id):
  111. """Notifies distributor on master process that the user has left the
  112. room.
  113. Args:
  114. target (UserID)
  115. room_id (str)
  116. Returns:
  117. Deferred|None
  118. """
  119. raise NotImplementedError()
  120. @defer.inlineCallbacks
  121. def _local_membership_update(
  122. self, requester, target, room_id, membership,
  123. prev_event_ids,
  124. txn_id=None,
  125. ratelimit=True,
  126. content=None,
  127. ):
  128. if content is None:
  129. content = {}
  130. content["membership"] = membership
  131. if requester.is_guest:
  132. content["kind"] = "guest"
  133. event, context = yield self.event_creation_hander.create_event(
  134. requester,
  135. {
  136. "type": EventTypes.Member,
  137. "content": content,
  138. "room_id": room_id,
  139. "sender": requester.user.to_string(),
  140. "state_key": target.to_string(),
  141. # For backwards compatibility:
  142. "membership": membership,
  143. },
  144. token_id=requester.access_token_id,
  145. txn_id=txn_id,
  146. prev_event_ids=prev_event_ids,
  147. )
  148. # Check if this event matches the previous membership event for the user.
  149. duplicate = yield self.event_creation_hander.deduplicate_state_event(
  150. event, context,
  151. )
  152. if duplicate is not None:
  153. # Discard the new event since this membership change is a no-op.
  154. defer.returnValue(duplicate)
  155. yield self.event_creation_hander.handle_new_client_event(
  156. requester,
  157. event,
  158. context,
  159. extra_users=[target],
  160. ratelimit=ratelimit,
  161. )
  162. prev_member_event_id = context.prev_state_ids.get(
  163. (EventTypes.Member, target.to_string()),
  164. None
  165. )
  166. if event.membership == Membership.JOIN:
  167. # Only fire user_joined_room if the user has acutally joined the
  168. # room. Don't bother if the user is just changing their profile
  169. # info.
  170. newly_joined = True
  171. if prev_member_event_id:
  172. prev_member_event = yield self.store.get_event(prev_member_event_id)
  173. newly_joined = prev_member_event.membership != Membership.JOIN
  174. if newly_joined:
  175. yield self._user_joined_room(target, room_id)
  176. elif event.membership == Membership.LEAVE:
  177. if prev_member_event_id:
  178. prev_member_event = yield self.store.get_event(prev_member_event_id)
  179. if prev_member_event.membership == Membership.JOIN:
  180. yield self._user_left_room(target, room_id)
  181. defer.returnValue(event)
  182. @defer.inlineCallbacks
  183. def update_membership(
  184. self,
  185. requester,
  186. target,
  187. room_id,
  188. action,
  189. txn_id=None,
  190. remote_room_hosts=None,
  191. third_party_signed=None,
  192. ratelimit=True,
  193. content=None,
  194. ):
  195. key = (room_id,)
  196. with (yield self.member_linearizer.queue(key)):
  197. result = yield self._update_membership(
  198. requester,
  199. target,
  200. room_id,
  201. action,
  202. txn_id=txn_id,
  203. remote_room_hosts=remote_room_hosts,
  204. third_party_signed=third_party_signed,
  205. ratelimit=ratelimit,
  206. content=content,
  207. )
  208. defer.returnValue(result)
  209. @defer.inlineCallbacks
  210. def _update_membership(
  211. self,
  212. requester,
  213. target,
  214. room_id,
  215. action,
  216. txn_id=None,
  217. remote_room_hosts=None,
  218. third_party_signed=None,
  219. ratelimit=True,
  220. content=None,
  221. ):
  222. content_specified = bool(content)
  223. if content is None:
  224. content = {}
  225. else:
  226. # We do a copy here as we potentially change some keys
  227. # later on.
  228. content = dict(content)
  229. effective_membership_state = action
  230. if action in ["kick", "unban"]:
  231. effective_membership_state = "leave"
  232. # if this is a join with a 3pid signature, we may need to turn a 3pid
  233. # invite into a normal invite before we can handle the join.
  234. if third_party_signed is not None:
  235. yield self.federation_handler.exchange_third_party_invite(
  236. third_party_signed["sender"],
  237. target.to_string(),
  238. room_id,
  239. third_party_signed,
  240. )
  241. if not remote_room_hosts:
  242. remote_room_hosts = []
  243. if effective_membership_state not in ("leave", "ban",):
  244. is_blocked = yield self.store.is_room_blocked(room_id)
  245. if is_blocked:
  246. raise SynapseError(403, "This room has been blocked on this server")
  247. if effective_membership_state == "invite":
  248. block_invite = False
  249. is_requester_admin = yield self.auth.is_server_admin(
  250. requester.user,
  251. )
  252. if not is_requester_admin:
  253. if self.config.block_non_admin_invites:
  254. logger.info(
  255. "Blocking invite: user is not admin and non-admin "
  256. "invites disabled"
  257. )
  258. block_invite = True
  259. if not self.spam_checker.user_may_invite(
  260. requester.user.to_string(), target.to_string(), room_id,
  261. ):
  262. logger.info("Blocking invite due to spam checker")
  263. block_invite = True
  264. if block_invite:
  265. raise SynapseError(
  266. 403, "Invites have been disabled on this server",
  267. )
  268. latest_event_ids = yield self.store.get_latest_event_ids_in_room(room_id)
  269. current_state_ids = yield self.state_handler.get_current_state_ids(
  270. room_id, latest_event_ids=latest_event_ids,
  271. )
  272. old_state_id = current_state_ids.get((EventTypes.Member, target.to_string()))
  273. if old_state_id:
  274. old_state = yield self.store.get_event(old_state_id, allow_none=True)
  275. old_membership = old_state.content.get("membership") if old_state else None
  276. if action == "unban" and old_membership != "ban":
  277. raise SynapseError(
  278. 403,
  279. "Cannot unban user who was not banned"
  280. " (membership=%s)" % old_membership,
  281. errcode=Codes.BAD_STATE
  282. )
  283. if old_membership == "ban" and action != "unban":
  284. raise SynapseError(
  285. 403,
  286. "Cannot %s user who was banned" % (action,),
  287. errcode=Codes.BAD_STATE
  288. )
  289. if old_state:
  290. same_content = content == old_state.content
  291. same_membership = old_membership == effective_membership_state
  292. same_sender = requester.user.to_string() == old_state.sender
  293. if same_sender and same_membership and same_content:
  294. defer.returnValue(old_state)
  295. is_host_in_room = yield self._is_host_in_room(current_state_ids)
  296. if effective_membership_state == Membership.JOIN:
  297. if requester.is_guest:
  298. guest_can_join = yield self._can_guest_join(current_state_ids)
  299. if not guest_can_join:
  300. # This should be an auth check, but guests are a local concept,
  301. # so don't really fit into the general auth process.
  302. raise AuthError(403, "Guest access not allowed")
  303. if not is_host_in_room:
  304. inviter = yield self._get_inviter(target.to_string(), room_id)
  305. if inviter and not self.hs.is_mine(inviter):
  306. remote_room_hosts.append(inviter.domain)
  307. content["membership"] = Membership.JOIN
  308. profile = self.profile_handler
  309. if not content_specified:
  310. content["displayname"] = yield profile.get_displayname(target)
  311. content["avatar_url"] = yield profile.get_avatar_url(target)
  312. if requester.is_guest:
  313. content["kind"] = "guest"
  314. ret = yield self._remote_join(
  315. requester, remote_room_hosts, room_id, target, content
  316. )
  317. defer.returnValue(ret)
  318. elif effective_membership_state == Membership.LEAVE:
  319. if not is_host_in_room:
  320. # perhaps we've been invited
  321. inviter = yield self._get_inviter(target.to_string(), room_id)
  322. if not inviter:
  323. raise SynapseError(404, "Not a known room")
  324. if self.hs.is_mine(inviter):
  325. # the inviter was on our server, but has now left. Carry on
  326. # with the normal rejection codepath.
  327. #
  328. # This is a bit of a hack, because the room might still be
  329. # active on other servers.
  330. pass
  331. else:
  332. # send the rejection to the inviter's HS.
  333. remote_room_hosts = remote_room_hosts + [inviter.domain]
  334. res = yield self._remote_reject_invite(
  335. requester, remote_room_hosts, room_id, target,
  336. )
  337. defer.returnValue(res)
  338. res = yield self._local_membership_update(
  339. requester=requester,
  340. target=target,
  341. room_id=room_id,
  342. membership=effective_membership_state,
  343. txn_id=txn_id,
  344. ratelimit=ratelimit,
  345. prev_event_ids=latest_event_ids,
  346. content=content,
  347. )
  348. defer.returnValue(res)
  349. @defer.inlineCallbacks
  350. def send_membership_event(
  351. self,
  352. requester,
  353. event,
  354. context,
  355. remote_room_hosts=None,
  356. ratelimit=True,
  357. ):
  358. """
  359. Change the membership status of a user in a room.
  360. Args:
  361. requester (Requester): The local user who requested the membership
  362. event. If None, certain checks, like whether this homeserver can
  363. act as the sender, will be skipped.
  364. event (SynapseEvent): The membership event.
  365. context: The context of the event.
  366. is_guest (bool): Whether the sender is a guest.
  367. room_hosts ([str]): Homeservers which are likely to already be in
  368. the room, and could be danced with in order to join this
  369. homeserver for the first time.
  370. ratelimit (bool): Whether to rate limit this request.
  371. Raises:
  372. SynapseError if there was a problem changing the membership.
  373. """
  374. remote_room_hosts = remote_room_hosts or []
  375. target_user = UserID.from_string(event.state_key)
  376. room_id = event.room_id
  377. if requester is not None:
  378. sender = UserID.from_string(event.sender)
  379. assert sender == requester.user, (
  380. "Sender (%s) must be same as requester (%s)" %
  381. (sender, requester.user)
  382. )
  383. assert self.hs.is_mine(sender), "Sender must be our own: %s" % (sender,)
  384. else:
  385. requester = synapse.types.create_requester(target_user)
  386. prev_event = yield self.event_creation_hander.deduplicate_state_event(
  387. event, context,
  388. )
  389. if prev_event is not None:
  390. return
  391. if event.membership == Membership.JOIN:
  392. if requester.is_guest:
  393. guest_can_join = yield self._can_guest_join(context.prev_state_ids)
  394. if not guest_can_join:
  395. # This should be an auth check, but guests are a local concept,
  396. # so don't really fit into the general auth process.
  397. raise AuthError(403, "Guest access not allowed")
  398. if event.membership not in (Membership.LEAVE, Membership.BAN):
  399. is_blocked = yield self.store.is_room_blocked(room_id)
  400. if is_blocked:
  401. raise SynapseError(403, "This room has been blocked on this server")
  402. yield self.event_creation_hander.handle_new_client_event(
  403. requester,
  404. event,
  405. context,
  406. extra_users=[target_user],
  407. ratelimit=ratelimit,
  408. )
  409. prev_member_event_id = context.prev_state_ids.get(
  410. (EventTypes.Member, event.state_key),
  411. None
  412. )
  413. if event.membership == Membership.JOIN:
  414. # Only fire user_joined_room if the user has acutally joined the
  415. # room. Don't bother if the user is just changing their profile
  416. # info.
  417. newly_joined = True
  418. if prev_member_event_id:
  419. prev_member_event = yield self.store.get_event(prev_member_event_id)
  420. newly_joined = prev_member_event.membership != Membership.JOIN
  421. if newly_joined:
  422. yield self._user_joined_room(target_user, room_id)
  423. elif event.membership == Membership.LEAVE:
  424. if prev_member_event_id:
  425. prev_member_event = yield self.store.get_event(prev_member_event_id)
  426. if prev_member_event.membership == Membership.JOIN:
  427. yield self._user_left_room(target_user, room_id)
  428. @defer.inlineCallbacks
  429. def _can_guest_join(self, current_state_ids):
  430. """
  431. Returns whether a guest can join a room based on its current state.
  432. """
  433. guest_access_id = current_state_ids.get((EventTypes.GuestAccess, ""), None)
  434. if not guest_access_id:
  435. defer.returnValue(False)
  436. guest_access = yield self.store.get_event(guest_access_id)
  437. defer.returnValue(
  438. guest_access
  439. and guest_access.content
  440. and "guest_access" in guest_access.content
  441. and guest_access.content["guest_access"] == "can_join"
  442. )
  443. @defer.inlineCallbacks
  444. def lookup_room_alias(self, room_alias):
  445. """
  446. Get the room ID associated with a room alias.
  447. Args:
  448. room_alias (RoomAlias): The alias to look up.
  449. Returns:
  450. A tuple of:
  451. The room ID as a RoomID object.
  452. Hosts likely to be participating in the room ([str]).
  453. Raises:
  454. SynapseError if room alias could not be found.
  455. """
  456. directory_handler = self.directory_handler
  457. mapping = yield directory_handler.get_association(room_alias)
  458. if not mapping:
  459. raise SynapseError(404, "No such room alias")
  460. room_id = mapping["room_id"]
  461. servers = mapping["servers"]
  462. defer.returnValue((RoomID.from_string(room_id), servers))
  463. @defer.inlineCallbacks
  464. def _get_inviter(self, user_id, room_id):
  465. invite = yield self.store.get_invite_for_user_in_room(
  466. user_id=user_id,
  467. room_id=room_id,
  468. )
  469. if invite:
  470. defer.returnValue(UserID.from_string(invite.sender))
  471. @defer.inlineCallbacks
  472. def do_3pid_invite(
  473. self,
  474. room_id,
  475. inviter,
  476. medium,
  477. address,
  478. id_server,
  479. requester,
  480. txn_id
  481. ):
  482. if self.config.block_non_admin_invites:
  483. is_requester_admin = yield self.auth.is_server_admin(
  484. requester.user,
  485. )
  486. if not is_requester_admin:
  487. raise SynapseError(
  488. 403, "Invites have been disabled on this server",
  489. Codes.FORBIDDEN,
  490. )
  491. invitee = yield self._lookup_3pid(
  492. id_server, medium, address
  493. )
  494. if invitee:
  495. yield self.update_membership(
  496. requester,
  497. UserID.from_string(invitee),
  498. room_id,
  499. "invite",
  500. txn_id=txn_id,
  501. )
  502. else:
  503. yield self._make_and_store_3pid_invite(
  504. requester,
  505. id_server,
  506. medium,
  507. address,
  508. room_id,
  509. inviter,
  510. txn_id=txn_id
  511. )
  512. @defer.inlineCallbacks
  513. def _lookup_3pid(self, id_server, medium, address):
  514. """Looks up a 3pid in the passed identity server.
  515. Args:
  516. id_server (str): The server name (including port, if required)
  517. of the identity server to use.
  518. medium (str): The type of the third party identifier (e.g. "email").
  519. address (str): The third party identifier (e.g. "foo@example.com").
  520. Returns:
  521. str: the matrix ID of the 3pid, or None if it is not recognized.
  522. """
  523. try:
  524. data = yield self.simple_http_client.get_json(
  525. "%s%s/_matrix/identity/api/v1/lookup" % (id_server_scheme, id_server,),
  526. {
  527. "medium": medium,
  528. "address": address,
  529. }
  530. )
  531. if "mxid" in data:
  532. if "signatures" not in data:
  533. raise AuthError(401, "No signatures on 3pid binding")
  534. yield self._verify_any_signature(data, id_server)
  535. defer.returnValue(data["mxid"])
  536. except IOError as e:
  537. logger.warn("Error from identity server lookup: %s" % (e,))
  538. defer.returnValue(None)
  539. @defer.inlineCallbacks
  540. def _verify_any_signature(self, data, server_hostname):
  541. if server_hostname not in data["signatures"]:
  542. raise AuthError(401, "No signature from server %s" % (server_hostname,))
  543. for key_name, signature in data["signatures"][server_hostname].items():
  544. key_data = yield self.simple_http_client.get_json(
  545. "%s%s/_matrix/identity/api/v1/pubkey/%s" %
  546. (id_server_scheme, server_hostname, key_name,),
  547. )
  548. if "public_key" not in key_data:
  549. raise AuthError(401, "No public key named %s from %s" %
  550. (key_name, server_hostname,))
  551. verify_signed_json(
  552. data,
  553. server_hostname,
  554. decode_verify_key_bytes(key_name, decode_base64(key_data["public_key"]))
  555. )
  556. return
  557. @defer.inlineCallbacks
  558. def _make_and_store_3pid_invite(
  559. self,
  560. requester,
  561. id_server,
  562. medium,
  563. address,
  564. room_id,
  565. user,
  566. txn_id
  567. ):
  568. room_state = yield self.state_handler.get_current_state(room_id)
  569. inviter_display_name = ""
  570. inviter_avatar_url = ""
  571. member_event = room_state.get((EventTypes.Member, user.to_string()))
  572. if member_event:
  573. inviter_display_name = member_event.content.get("displayname", "")
  574. inviter_avatar_url = member_event.content.get("avatar_url", "")
  575. canonical_room_alias = ""
  576. canonical_alias_event = room_state.get((EventTypes.CanonicalAlias, ""))
  577. if canonical_alias_event:
  578. canonical_room_alias = canonical_alias_event.content.get("alias", "")
  579. room_name = ""
  580. room_name_event = room_state.get((EventTypes.Name, ""))
  581. if room_name_event:
  582. room_name = room_name_event.content.get("name", "")
  583. room_join_rules = ""
  584. join_rules_event = room_state.get((EventTypes.JoinRules, ""))
  585. if join_rules_event:
  586. room_join_rules = join_rules_event.content.get("join_rule", "")
  587. room_avatar_url = ""
  588. room_avatar_event = room_state.get((EventTypes.RoomAvatar, ""))
  589. if room_avatar_event:
  590. room_avatar_url = room_avatar_event.content.get("url", "")
  591. token, public_keys, fallback_public_key, display_name = (
  592. yield self._ask_id_server_for_third_party_invite(
  593. requester=requester,
  594. id_server=id_server,
  595. medium=medium,
  596. address=address,
  597. room_id=room_id,
  598. inviter_user_id=user.to_string(),
  599. room_alias=canonical_room_alias,
  600. room_avatar_url=room_avatar_url,
  601. room_join_rules=room_join_rules,
  602. room_name=room_name,
  603. inviter_display_name=inviter_display_name,
  604. inviter_avatar_url=inviter_avatar_url
  605. )
  606. )
  607. yield self.event_creation_hander.create_and_send_nonmember_event(
  608. requester,
  609. {
  610. "type": EventTypes.ThirdPartyInvite,
  611. "content": {
  612. "display_name": display_name,
  613. "public_keys": public_keys,
  614. # For backwards compatibility:
  615. "key_validity_url": fallback_public_key["key_validity_url"],
  616. "public_key": fallback_public_key["public_key"],
  617. },
  618. "room_id": room_id,
  619. "sender": user.to_string(),
  620. "state_key": token,
  621. },
  622. txn_id=txn_id,
  623. )
  624. @defer.inlineCallbacks
  625. def _ask_id_server_for_third_party_invite(
  626. self,
  627. requester,
  628. id_server,
  629. medium,
  630. address,
  631. room_id,
  632. inviter_user_id,
  633. room_alias,
  634. room_avatar_url,
  635. room_join_rules,
  636. room_name,
  637. inviter_display_name,
  638. inviter_avatar_url
  639. ):
  640. """
  641. Asks an identity server for a third party invite.
  642. Args:
  643. requester (Requester)
  644. id_server (str): hostname + optional port for the identity server.
  645. medium (str): The literal string "email".
  646. address (str): The third party address being invited.
  647. room_id (str): The ID of the room to which the user is invited.
  648. inviter_user_id (str): The user ID of the inviter.
  649. room_alias (str): An alias for the room, for cosmetic notifications.
  650. room_avatar_url (str): The URL of the room's avatar, for cosmetic
  651. notifications.
  652. room_join_rules (str): The join rules of the email (e.g. "public").
  653. room_name (str): The m.room.name of the room.
  654. inviter_display_name (str): The current display name of the
  655. inviter.
  656. inviter_avatar_url (str): The URL of the inviter's avatar.
  657. Returns:
  658. A deferred tuple containing:
  659. token (str): The token which must be signed to prove authenticity.
  660. public_keys ([{"public_key": str, "key_validity_url": str}]):
  661. public_key is a base64-encoded ed25519 public key.
  662. fallback_public_key: One element from public_keys.
  663. display_name (str): A user-friendly name to represent the invited
  664. user.
  665. """
  666. is_url = "%s%s/_matrix/identity/api/v1/store-invite" % (
  667. id_server_scheme, id_server,
  668. )
  669. invite_config = {
  670. "medium": medium,
  671. "address": address,
  672. "room_id": room_id,
  673. "room_alias": room_alias,
  674. "room_avatar_url": room_avatar_url,
  675. "room_join_rules": room_join_rules,
  676. "room_name": room_name,
  677. "sender": inviter_user_id,
  678. "sender_display_name": inviter_display_name,
  679. "sender_avatar_url": inviter_avatar_url,
  680. }
  681. if self.config.invite_3pid_guest:
  682. guest_access_token, guest_user_id = yield self.get_or_register_3pid_guest(
  683. requester=requester,
  684. medium=medium,
  685. address=address,
  686. inviter_user_id=inviter_user_id,
  687. )
  688. invite_config.update({
  689. "guest_access_token": guest_access_token,
  690. "guest_user_id": guest_user_id,
  691. })
  692. data = yield self.simple_http_client.post_urlencoded_get_json(
  693. is_url,
  694. invite_config
  695. )
  696. # TODO: Check for success
  697. token = data["token"]
  698. public_keys = data.get("public_keys", [])
  699. if "public_key" in data:
  700. fallback_public_key = {
  701. "public_key": data["public_key"],
  702. "key_validity_url": "%s%s/_matrix/identity/api/v1/pubkey/isvalid" % (
  703. id_server_scheme, id_server,
  704. ),
  705. }
  706. else:
  707. fallback_public_key = public_keys[0]
  708. if not public_keys:
  709. public_keys.append(fallback_public_key)
  710. display_name = data["display_name"]
  711. defer.returnValue((token, public_keys, fallback_public_key, display_name))
  712. @defer.inlineCallbacks
  713. def _is_host_in_room(self, current_state_ids):
  714. # Have we just created the room, and is this about to be the very
  715. # first member event?
  716. create_event_id = current_state_ids.get(("m.room.create", ""))
  717. if len(current_state_ids) == 1 and create_event_id:
  718. defer.returnValue(self.hs.is_mine_id(create_event_id))
  719. for etype, state_key in current_state_ids:
  720. if etype != EventTypes.Member or not self.hs.is_mine_id(state_key):
  721. continue
  722. event_id = current_state_ids[(etype, state_key)]
  723. event = yield self.store.get_event(event_id, allow_none=True)
  724. if not event:
  725. continue
  726. if event.membership == Membership.JOIN:
  727. defer.returnValue(True)
  728. defer.returnValue(False)
  729. class RoomMemberMasterHandler(RoomMemberHandler):
  730. def __init__(self, hs):
  731. super(RoomMemberMasterHandler, self).__init__(hs)
  732. self.distributor = hs.get_distributor()
  733. self.distributor.declare("user_joined_room")
  734. self.distributor.declare("user_left_room")
  735. @defer.inlineCallbacks
  736. def _remote_join(self, requester, remote_room_hosts, room_id, user, content):
  737. """Implements RoomMemberHandler._remote_join
  738. """
  739. if len(remote_room_hosts) == 0:
  740. raise SynapseError(404, "No known servers")
  741. # We don't do an auth check if we are doing an invite
  742. # join dance for now, since we're kinda implicitly checking
  743. # that we are allowed to join when we decide whether or not we
  744. # need to do the invite/join dance.
  745. yield self.federation_handler.do_invite_join(
  746. remote_room_hosts,
  747. room_id,
  748. user.to_string(),
  749. content,
  750. )
  751. yield self._user_joined_room(user, room_id)
  752. @defer.inlineCallbacks
  753. def _remote_reject_invite(self, requester, remote_room_hosts, room_id, target):
  754. """Implements RoomMemberHandler._remote_reject_invite
  755. """
  756. fed_handler = self.federation_handler
  757. try:
  758. ret = yield fed_handler.do_remotely_reject_invite(
  759. remote_room_hosts,
  760. room_id,
  761. target.to_string(),
  762. )
  763. defer.returnValue(ret)
  764. except Exception as e:
  765. # if we were unable to reject the exception, just mark
  766. # it as rejected on our end and plough ahead.
  767. #
  768. # The 'except' clause is very broad, but we need to
  769. # capture everything from DNS failures upwards
  770. #
  771. logger.warn("Failed to reject invite: %s", e)
  772. yield self.store.locally_reject_invite(
  773. target.to_string(), room_id
  774. )
  775. defer.returnValue({})
  776. def get_or_register_3pid_guest(self, requester, medium, address, inviter_user_id):
  777. """Implements RoomMemberHandler.get_or_register_3pid_guest
  778. """
  779. rg = self.registration_handler
  780. return rg.get_or_register_3pid_guest(medium, address, inviter_user_id)
  781. def _user_joined_room(self, target, room_id):
  782. """Implements RoomMemberHandler._user_joined_room
  783. """
  784. return user_joined_room(self.distributor, target, room_id)
  785. def _user_left_room(self, target, room_id):
  786. """Implements RoomMemberHandler._user_left_room
  787. """
  788. return user_left_room(self.distributor, target, room_id)
  789. @defer.inlineCallbacks
  790. def forget(self, user, room_id):
  791. user_id = user.to_string()
  792. member = yield self.state_handler.get_current_state(
  793. room_id=room_id,
  794. event_type=EventTypes.Member,
  795. state_key=user_id
  796. )
  797. membership = member.membership if member else None
  798. if membership is not None and membership not in [
  799. Membership.LEAVE, Membership.BAN
  800. ]:
  801. raise SynapseError(400, "User %s in room %s" % (
  802. user_id, room_id
  803. ))
  804. if membership:
  805. yield self.store.forget(user_id, room_id)