room_member.py 35 KB

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