You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
 
 

779 lines
29 KiB

  1. # Copyright 2015, 2016 OpenMarket Ltd
  2. #
  3. # Licensed under the Apache License, Version 2.0 (the "License");
  4. # you may not use this file except in compliance with the License.
  5. # You may obtain a copy of the License at
  6. #
  7. # http://www.apache.org/licenses/LICENSE-2.0
  8. #
  9. # Unless required by applicable law or agreed to in writing, software
  10. # distributed under the License is distributed on an "AS IS" BASIS,
  11. # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  12. # See the License for the specific language governing permissions and
  13. # limitations under the License.
  14. from unittest.mock import Mock
  15. from synapse.api.auth import Auth
  16. from synapse.api.constants import UserTypes
  17. from synapse.api.errors import (
  18. CodeMessageException,
  19. Codes,
  20. ResourceLimitError,
  21. SynapseError,
  22. )
  23. from synapse.spam_checker_api import RegistrationBehaviour
  24. from synapse.types import RoomAlias, RoomID, UserID, create_requester
  25. from tests.test_utils import make_awaitable
  26. from tests.unittest import override_config
  27. from tests.utils import mock_getRawHeaders
  28. from .. import unittest
  29. class TestSpamChecker:
  30. def __init__(self, config, api):
  31. api.register_spam_checker_callbacks(
  32. check_registration_for_spam=self.check_registration_for_spam,
  33. )
  34. @staticmethod
  35. def parse_config(config):
  36. return config
  37. async def check_registration_for_spam(
  38. self,
  39. email_threepid,
  40. username,
  41. request_info,
  42. auth_provider_id,
  43. ):
  44. pass
  45. class DenyAll(TestSpamChecker):
  46. async def check_registration_for_spam(
  47. self,
  48. email_threepid,
  49. username,
  50. request_info,
  51. auth_provider_id,
  52. ):
  53. return RegistrationBehaviour.DENY
  54. class BanAll(TestSpamChecker):
  55. async def check_registration_for_spam(
  56. self,
  57. email_threepid,
  58. username,
  59. request_info,
  60. auth_provider_id,
  61. ):
  62. return RegistrationBehaviour.SHADOW_BAN
  63. class BanBadIdPUser(TestSpamChecker):
  64. async def check_registration_for_spam(
  65. self, email_threepid, username, request_info, auth_provider_id=None
  66. ):
  67. # Reject any user coming from CAS and whose username contains profanity
  68. if auth_provider_id == "cas" and "flimflob" in username:
  69. return RegistrationBehaviour.DENY
  70. return RegistrationBehaviour.ALLOW
  71. class TestLegacyRegistrationSpamChecker:
  72. def __init__(self, config, api):
  73. pass
  74. async def check_registration_for_spam(
  75. self,
  76. email_threepid,
  77. username,
  78. request_info,
  79. ):
  80. pass
  81. class LegacyAllowAll(TestLegacyRegistrationSpamChecker):
  82. async def check_registration_for_spam(
  83. self,
  84. email_threepid,
  85. username,
  86. request_info,
  87. ):
  88. return RegistrationBehaviour.ALLOW
  89. class LegacyDenyAll(TestLegacyRegistrationSpamChecker):
  90. async def check_registration_for_spam(
  91. self,
  92. email_threepid,
  93. username,
  94. request_info,
  95. ):
  96. return RegistrationBehaviour.DENY
  97. class RegistrationTestCase(unittest.HomeserverTestCase):
  98. """Tests the RegistrationHandler."""
  99. def make_homeserver(self, reactor, clock):
  100. hs_config = self.default_config()
  101. # some of the tests rely on us having a user consent version
  102. hs_config.setdefault("user_consent", {}).update(
  103. {
  104. "version": "test_consent_version",
  105. "template_dir": ".",
  106. }
  107. )
  108. hs_config["max_mau_value"] = 50
  109. hs_config["limit_usage_by_mau"] = True
  110. # Don't attempt to reach out over federation.
  111. self.mock_federation_client = Mock()
  112. self.mock_federation_client.make_query.side_effect = CodeMessageException(
  113. 500, ""
  114. )
  115. hs = self.setup_test_homeserver(
  116. config=hs_config, federation_client=self.mock_federation_client
  117. )
  118. return hs
  119. def prepare(self, reactor, clock, hs):
  120. self.handler = self.hs.get_registration_handler()
  121. self.store = self.hs.get_datastores().main
  122. self.lots_of_users = 100
  123. self.small_number_of_users = 1
  124. self.requester = create_requester("@requester:test")
  125. def test_user_is_created_and_logged_in_if_doesnt_exist(self):
  126. frank = UserID.from_string("@frank:test")
  127. user_id = frank.to_string()
  128. requester = create_requester(user_id)
  129. result_user_id, result_token = self.get_success(
  130. self.get_or_create_user(requester, frank.localpart, "Frankie")
  131. )
  132. self.assertEqual(result_user_id, user_id)
  133. self.assertIsInstance(result_token, str)
  134. self.assertGreater(len(result_token), 20)
  135. def test_if_user_exists(self):
  136. store = self.hs.get_datastores().main
  137. frank = UserID.from_string("@frank:test")
  138. self.get_success(
  139. store.register_user(user_id=frank.to_string(), password_hash=None)
  140. )
  141. local_part = frank.localpart
  142. user_id = frank.to_string()
  143. requester = create_requester(user_id)
  144. result_user_id, result_token = self.get_success(
  145. self.get_or_create_user(requester, local_part, None)
  146. )
  147. self.assertEqual(result_user_id, user_id)
  148. self.assertTrue(result_token is not None)
  149. @override_config({"limit_usage_by_mau": False})
  150. def test_mau_limits_when_disabled(self):
  151. # Ensure does not throw exception
  152. self.get_success(self.get_or_create_user(self.requester, "a", "display_name"))
  153. @override_config({"limit_usage_by_mau": True})
  154. def test_get_or_create_user_mau_not_blocked(self):
  155. self.store.count_monthly_users = Mock(
  156. return_value=make_awaitable(self.hs.config.server.max_mau_value - 1)
  157. )
  158. # Ensure does not throw exception
  159. self.get_success(self.get_or_create_user(self.requester, "c", "User"))
  160. @override_config({"limit_usage_by_mau": True})
  161. def test_get_or_create_user_mau_blocked(self):
  162. self.store.get_monthly_active_count = Mock(
  163. return_value=make_awaitable(self.lots_of_users)
  164. )
  165. self.get_failure(
  166. self.get_or_create_user(self.requester, "b", "display_name"),
  167. ResourceLimitError,
  168. )
  169. self.store.get_monthly_active_count = Mock(
  170. return_value=make_awaitable(self.hs.config.server.max_mau_value)
  171. )
  172. self.get_failure(
  173. self.get_or_create_user(self.requester, "b", "display_name"),
  174. ResourceLimitError,
  175. )
  176. @override_config({"limit_usage_by_mau": True})
  177. def test_register_mau_blocked(self):
  178. self.store.get_monthly_active_count = Mock(
  179. return_value=make_awaitable(self.lots_of_users)
  180. )
  181. self.get_failure(
  182. self.handler.register_user(localpart="local_part"), ResourceLimitError
  183. )
  184. self.store.get_monthly_active_count = Mock(
  185. return_value=make_awaitable(self.hs.config.server.max_mau_value)
  186. )
  187. self.get_failure(
  188. self.handler.register_user(localpart="local_part"), ResourceLimitError
  189. )
  190. @override_config(
  191. {"auto_join_rooms": ["#room:test"], "auto_join_rooms_for_guests": False}
  192. )
  193. def test_auto_join_rooms_for_guests(self):
  194. user_id = self.get_success(
  195. self.handler.register_user(localpart="jeff", make_guest=True),
  196. )
  197. rooms = self.get_success(self.store.get_rooms_for_user(user_id))
  198. self.assertEqual(len(rooms), 0)
  199. @override_config({"auto_join_rooms": ["#room:test"]})
  200. def test_auto_create_auto_join_rooms(self):
  201. room_alias_str = "#room:test"
  202. user_id = self.get_success(self.handler.register_user(localpart="jeff"))
  203. rooms = self.get_success(self.store.get_rooms_for_user(user_id))
  204. directory_handler = self.hs.get_directory_handler()
  205. room_alias = RoomAlias.from_string(room_alias_str)
  206. room_id = self.get_success(directory_handler.get_association(room_alias))
  207. self.assertTrue(room_id["room_id"] in rooms)
  208. self.assertEqual(len(rooms), 1)
  209. @override_config({"auto_join_rooms": []})
  210. def test_auto_create_auto_join_rooms_with_no_rooms(self):
  211. frank = UserID.from_string("@frank:test")
  212. user_id = self.get_success(self.handler.register_user(frank.localpart))
  213. self.assertEqual(user_id, frank.to_string())
  214. rooms = self.get_success(self.store.get_rooms_for_user(user_id))
  215. self.assertEqual(len(rooms), 0)
  216. @override_config({"auto_join_rooms": ["#room:another"]})
  217. def test_auto_create_auto_join_where_room_is_another_domain(self):
  218. frank = UserID.from_string("@frank:test")
  219. user_id = self.get_success(self.handler.register_user(frank.localpart))
  220. self.assertEqual(user_id, frank.to_string())
  221. rooms = self.get_success(self.store.get_rooms_for_user(user_id))
  222. self.assertEqual(len(rooms), 0)
  223. @override_config(
  224. {"auto_join_rooms": ["#room:test"], "autocreate_auto_join_rooms": False}
  225. )
  226. def test_auto_create_auto_join_where_auto_create_is_false(self):
  227. user_id = self.get_success(self.handler.register_user(localpart="jeff"))
  228. rooms = self.get_success(self.store.get_rooms_for_user(user_id))
  229. self.assertEqual(len(rooms), 0)
  230. @override_config({"auto_join_rooms": ["#room:test"]})
  231. def test_auto_create_auto_join_rooms_when_user_is_not_a_real_user(self):
  232. room_alias_str = "#room:test"
  233. self.store.is_real_user = Mock(return_value=make_awaitable(False))
  234. user_id = self.get_success(self.handler.register_user(localpart="support"))
  235. rooms = self.get_success(self.store.get_rooms_for_user(user_id))
  236. self.assertEqual(len(rooms), 0)
  237. directory_handler = self.hs.get_directory_handler()
  238. room_alias = RoomAlias.from_string(room_alias_str)
  239. self.get_failure(directory_handler.get_association(room_alias), SynapseError)
  240. @override_config({"auto_join_rooms": ["#room:test"]})
  241. def test_auto_create_auto_join_rooms_when_user_is_the_first_real_user(self):
  242. room_alias_str = "#room:test"
  243. self.store.count_real_users = Mock(return_value=make_awaitable(1))
  244. self.store.is_real_user = Mock(return_value=make_awaitable(True))
  245. user_id = self.get_success(self.handler.register_user(localpart="real"))
  246. rooms = self.get_success(self.store.get_rooms_for_user(user_id))
  247. directory_handler = self.hs.get_directory_handler()
  248. room_alias = RoomAlias.from_string(room_alias_str)
  249. room_id = self.get_success(directory_handler.get_association(room_alias))
  250. self.assertTrue(room_id["room_id"] in rooms)
  251. self.assertEqual(len(rooms), 1)
  252. @override_config({"auto_join_rooms": ["#room:test"]})
  253. def test_auto_create_auto_join_rooms_when_user_is_not_the_first_real_user(self):
  254. self.store.count_real_users = Mock(return_value=make_awaitable(2))
  255. self.store.is_real_user = Mock(return_value=make_awaitable(True))
  256. user_id = self.get_success(self.handler.register_user(localpart="real"))
  257. rooms = self.get_success(self.store.get_rooms_for_user(user_id))
  258. self.assertEqual(len(rooms), 0)
  259. @override_config(
  260. {
  261. "auto_join_rooms": ["#room:test"],
  262. "autocreate_auto_join_rooms_federated": False,
  263. }
  264. )
  265. def test_auto_create_auto_join_rooms_federated(self):
  266. """
  267. Auto-created rooms that are private require an invite to go to the user
  268. (instead of directly joining it).
  269. """
  270. room_alias_str = "#room:test"
  271. user_id = self.get_success(self.handler.register_user(localpart="jeff"))
  272. # Ensure the room was created.
  273. directory_handler = self.hs.get_directory_handler()
  274. room_alias = RoomAlias.from_string(room_alias_str)
  275. room_id = self.get_success(directory_handler.get_association(room_alias))
  276. # Ensure the room is properly not federated.
  277. room = self.get_success(self.store.get_room_with_stats(room_id["room_id"]))
  278. self.assertFalse(room["federatable"])
  279. self.assertFalse(room["public"])
  280. self.assertEqual(room["join_rules"], "public")
  281. self.assertIsNone(room["guest_access"])
  282. # The user should be in the room.
  283. rooms = self.get_success(self.store.get_rooms_for_user(user_id))
  284. self.assertIn(room_id["room_id"], rooms)
  285. @override_config(
  286. {"auto_join_rooms": ["#room:test"], "auto_join_mxid_localpart": "support"}
  287. )
  288. def test_auto_join_mxid_localpart(self):
  289. """
  290. Ensure the user still needs up in the room created by a different user.
  291. """
  292. # Ensure the support user exists.
  293. inviter = "@support:test"
  294. room_alias_str = "#room:test"
  295. user_id = self.get_success(self.handler.register_user(localpart="jeff"))
  296. # Ensure the room was created.
  297. directory_handler = self.hs.get_directory_handler()
  298. room_alias = RoomAlias.from_string(room_alias_str)
  299. room_id = self.get_success(directory_handler.get_association(room_alias))
  300. # Ensure the room is properly a public room.
  301. room = self.get_success(self.store.get_room_with_stats(room_id["room_id"]))
  302. self.assertEqual(room["join_rules"], "public")
  303. # Both users should be in the room.
  304. rooms = self.get_success(self.store.get_rooms_for_user(inviter))
  305. self.assertIn(room_id["room_id"], rooms)
  306. rooms = self.get_success(self.store.get_rooms_for_user(user_id))
  307. self.assertIn(room_id["room_id"], rooms)
  308. # Register a second user, which should also end up in the room.
  309. user_id = self.get_success(self.handler.register_user(localpart="bob"))
  310. rooms = self.get_success(self.store.get_rooms_for_user(user_id))
  311. self.assertIn(room_id["room_id"], rooms)
  312. @override_config(
  313. {
  314. "auto_join_rooms": ["#room:test"],
  315. "autocreate_auto_join_room_preset": "private_chat",
  316. "auto_join_mxid_localpart": "support",
  317. }
  318. )
  319. def test_auto_create_auto_join_room_preset(self):
  320. """
  321. Auto-created rooms that are private require an invite to go to the user
  322. (instead of directly joining it).
  323. """
  324. # Ensure the support user exists.
  325. inviter = "@support:test"
  326. room_alias_str = "#room:test"
  327. user_id = self.get_success(self.handler.register_user(localpart="jeff"))
  328. # Ensure the room was created.
  329. directory_handler = self.hs.get_directory_handler()
  330. room_alias = RoomAlias.from_string(room_alias_str)
  331. room_id = self.get_success(directory_handler.get_association(room_alias))
  332. # Ensure the room is properly a private room.
  333. room = self.get_success(self.store.get_room_with_stats(room_id["room_id"]))
  334. self.assertFalse(room["public"])
  335. self.assertEqual(room["join_rules"], "invite")
  336. self.assertEqual(room["guest_access"], "can_join")
  337. # Both users should be in the room.
  338. rooms = self.get_success(self.store.get_rooms_for_user(inviter))
  339. self.assertIn(room_id["room_id"], rooms)
  340. rooms = self.get_success(self.store.get_rooms_for_user(user_id))
  341. self.assertIn(room_id["room_id"], rooms)
  342. # Register a second user, which should also end up in the room.
  343. user_id = self.get_success(self.handler.register_user(localpart="bob"))
  344. rooms = self.get_success(self.store.get_rooms_for_user(user_id))
  345. self.assertIn(room_id["room_id"], rooms)
  346. @override_config(
  347. {
  348. "auto_join_rooms": ["#room:test"],
  349. "autocreate_auto_join_room_preset": "private_chat",
  350. "auto_join_mxid_localpart": "support",
  351. }
  352. )
  353. def test_auto_create_auto_join_room_preset_guest(self):
  354. """
  355. Auto-created rooms that are private require an invite to go to the user
  356. (instead of directly joining it).
  357. This should also work for guests.
  358. """
  359. inviter = "@support:test"
  360. room_alias_str = "#room:test"
  361. user_id = self.get_success(
  362. self.handler.register_user(localpart="jeff", make_guest=True)
  363. )
  364. # Ensure the room was created.
  365. directory_handler = self.hs.get_directory_handler()
  366. room_alias = RoomAlias.from_string(room_alias_str)
  367. room_id = self.get_success(directory_handler.get_association(room_alias))
  368. # Ensure the room is properly a private room.
  369. room = self.get_success(self.store.get_room_with_stats(room_id["room_id"]))
  370. self.assertFalse(room["public"])
  371. self.assertEqual(room["join_rules"], "invite")
  372. self.assertEqual(room["guest_access"], "can_join")
  373. # Both users should be in the room.
  374. rooms = self.get_success(self.store.get_rooms_for_user(inviter))
  375. self.assertIn(room_id["room_id"], rooms)
  376. rooms = self.get_success(self.store.get_rooms_for_user(user_id))
  377. self.assertIn(room_id["room_id"], rooms)
  378. @override_config(
  379. {
  380. "auto_join_rooms": ["#room:test"],
  381. "autocreate_auto_join_room_preset": "private_chat",
  382. "auto_join_mxid_localpart": "support",
  383. }
  384. )
  385. def test_auto_create_auto_join_room_preset_invalid_permissions(self):
  386. """
  387. Auto-created rooms that are private require an invite, check that
  388. registration doesn't completely break if the inviter doesn't have proper
  389. permissions.
  390. """
  391. inviter = "@support:test"
  392. # Register an initial user to create the room and such (essentially this
  393. # is a subset of test_auto_create_auto_join_room_preset).
  394. room_alias_str = "#room:test"
  395. user_id = self.get_success(self.handler.register_user(localpart="jeff"))
  396. # Ensure the room was created.
  397. directory_handler = self.hs.get_directory_handler()
  398. room_alias = RoomAlias.from_string(room_alias_str)
  399. room_id = self.get_success(directory_handler.get_association(room_alias))
  400. # Ensure the room exists.
  401. self.get_success(self.store.get_room_with_stats(room_id["room_id"]))
  402. # Both users should be in the room.
  403. rooms = self.get_success(self.store.get_rooms_for_user(inviter))
  404. self.assertIn(room_id["room_id"], rooms)
  405. rooms = self.get_success(self.store.get_rooms_for_user(user_id))
  406. self.assertIn(room_id["room_id"], rooms)
  407. # Lower the permissions of the inviter.
  408. event_creation_handler = self.hs.get_event_creation_handler()
  409. requester = create_requester(inviter)
  410. event, context = self.get_success(
  411. event_creation_handler.create_event(
  412. requester,
  413. {
  414. "type": "m.room.power_levels",
  415. "state_key": "",
  416. "room_id": room_id["room_id"],
  417. "content": {"invite": 100, "users": {inviter: 0}},
  418. "sender": inviter,
  419. },
  420. )
  421. )
  422. self.get_success(
  423. event_creation_handler.handle_new_client_event(
  424. requester, events_and_context=[(event, context)]
  425. )
  426. )
  427. # Register a second user, which won't be be in the room (or even have an invite)
  428. # since the inviter no longer has the proper permissions.
  429. user_id = self.get_success(self.handler.register_user(localpart="bob"))
  430. # This user should not be in any rooms.
  431. rooms = self.get_success(self.store.get_rooms_for_user(user_id))
  432. invited_rooms = self.get_success(
  433. self.store.get_invited_rooms_for_local_user(user_id)
  434. )
  435. self.assertEqual(rooms, set())
  436. self.assertEqual(invited_rooms, [])
  437. @override_config(
  438. {
  439. "user_consent": {
  440. "block_events_error": "Error",
  441. "require_at_registration": True,
  442. },
  443. "form_secret": "53cr3t",
  444. "public_baseurl": "http://test",
  445. "auto_join_rooms": ["#room:test"],
  446. },
  447. )
  448. def test_auto_create_auto_join_where_no_consent(self):
  449. """Test to ensure that the first user is not auto-joined to a room if
  450. they have not given general consent.
  451. """
  452. # Given:-
  453. # * a user must give consent,
  454. # * they have not given that consent
  455. # * The server is configured to auto-join to a room
  456. # (and autocreate if necessary)
  457. # When:-
  458. # * the user is registered
  459. user_id = self.get_success(self.handler.register_user(localpart="jeff"))
  460. # Then:-
  461. # * Ensure that they have not been joined to the room
  462. rooms = self.get_success(self.store.get_rooms_for_user(user_id))
  463. self.assertEqual(len(rooms), 0)
  464. # The user provides consent; ensure they are now in the rooms.
  465. self.get_success(self.handler.post_consent_actions(user_id))
  466. rooms = self.get_success(self.store.get_rooms_for_user(user_id))
  467. self.assertEqual(len(rooms), 1)
  468. def test_register_support_user(self):
  469. user_id = self.get_success(
  470. self.handler.register_user(localpart="user", user_type=UserTypes.SUPPORT)
  471. )
  472. d = self.store.is_support_user(user_id)
  473. self.assertTrue(self.get_success(d))
  474. def test_register_not_support_user(self):
  475. user_id = self.get_success(self.handler.register_user(localpart="user"))
  476. d = self.store.is_support_user(user_id)
  477. self.assertFalse(self.get_success(d))
  478. def test_invalid_user_id_length(self):
  479. invalid_user_id = "x" * 256
  480. self.get_failure(
  481. self.handler.register_user(localpart=invalid_user_id), SynapseError
  482. )
  483. @override_config(
  484. {
  485. "modules": [
  486. {
  487. "module": TestSpamChecker.__module__ + ".DenyAll",
  488. }
  489. ]
  490. }
  491. )
  492. def test_spam_checker_deny(self):
  493. """A spam checker can deny registration, which results in an error."""
  494. self.get_failure(self.handler.register_user(localpart="user"), SynapseError)
  495. @override_config(
  496. {
  497. "spam_checker": [
  498. {
  499. "module": TestSpamChecker.__module__ + ".LegacyAllowAll",
  500. }
  501. ]
  502. }
  503. )
  504. def test_spam_checker_legacy_allow(self):
  505. """Tests that a legacy spam checker implementing the legacy 3-arg version of the
  506. check_registration_for_spam callback is correctly called.
  507. In this test and the following one we test both success and failure to make sure
  508. any failure comes from the spam checker (and not something else failing in the
  509. call stack) and any success comes from the spam checker (and not because a
  510. misconfiguration prevented it from being loaded).
  511. """
  512. self.get_success(self.handler.register_user(localpart="user"))
  513. @override_config(
  514. {
  515. "spam_checker": [
  516. {
  517. "module": TestSpamChecker.__module__ + ".LegacyDenyAll",
  518. }
  519. ]
  520. }
  521. )
  522. def test_spam_checker_legacy_deny(self):
  523. """Tests that a legacy spam checker implementing the legacy 3-arg version of the
  524. check_registration_for_spam callback is correctly called.
  525. In this test and the previous one we test both success and failure to make sure
  526. any failure comes from the spam checker (and not something else failing in the
  527. call stack) and any success comes from the spam checker (and not because a
  528. misconfiguration prevented it from being loaded).
  529. """
  530. self.get_failure(self.handler.register_user(localpart="user"), SynapseError)
  531. @override_config(
  532. {
  533. "modules": [
  534. {
  535. "module": TestSpamChecker.__module__ + ".BanAll",
  536. }
  537. ]
  538. }
  539. )
  540. def test_spam_checker_shadow_ban(self):
  541. """A spam checker can choose to shadow-ban a user, which allows registration to succeed."""
  542. user_id = self.get_success(self.handler.register_user(localpart="user"))
  543. # Get an access token.
  544. token = "testtok"
  545. self.get_success(
  546. self.store.add_access_token_to_user(
  547. user_id=user_id, token=token, device_id=None, valid_until_ms=None
  548. )
  549. )
  550. # Ensure the user was marked as shadow-banned.
  551. request = Mock(args={})
  552. request.args[b"access_token"] = [token.encode("ascii")]
  553. request.requestHeaders.getRawHeaders = mock_getRawHeaders()
  554. auth = Auth(self.hs)
  555. requester = self.get_success(auth.get_user_by_req(request))
  556. self.assertTrue(requester.shadow_banned)
  557. @override_config(
  558. {
  559. "modules": [
  560. {
  561. "module": TestSpamChecker.__module__ + ".BanBadIdPUser",
  562. }
  563. ]
  564. }
  565. )
  566. def test_spam_checker_receives_sso_type(self):
  567. """Test rejecting registration based on SSO type"""
  568. f = self.get_failure(
  569. self.handler.register_user(localpart="bobflimflob", auth_provider_id="cas"),
  570. SynapseError,
  571. )
  572. exception = f.value
  573. # We return 429 from the spam checker for denied registrations
  574. self.assertIsInstance(exception, SynapseError)
  575. self.assertEqual(exception.code, 429)
  576. # Check the same username can register using SAML
  577. self.get_success(
  578. self.handler.register_user(localpart="bobflimflob", auth_provider_id="saml")
  579. )
  580. async def get_or_create_user(
  581. self, requester, localpart, displayname, password_hash=None
  582. ):
  583. """Creates a new user if the user does not exist,
  584. else revokes all previous access tokens and generates a new one.
  585. XXX: this used to be in the main codebase, but was only used by this file,
  586. so got moved here. TODO: get rid of it, probably
  587. Args:
  588. localpart : The local part of the user ID to register. If None,
  589. one will be randomly generated.
  590. Returns:
  591. A tuple of (user_id, access_token).
  592. """
  593. if localpart is None:
  594. raise SynapseError(400, "Request must include user id")
  595. await self.hs.get_auth_blocking().check_auth_blocking()
  596. need_register = True
  597. try:
  598. await self.handler.check_username(localpart)
  599. except SynapseError as e:
  600. if e.errcode == Codes.USER_IN_USE:
  601. need_register = False
  602. else:
  603. raise
  604. user = UserID(localpart, self.hs.hostname)
  605. user_id = user.to_string()
  606. token = self.hs.get_auth_handler().generate_access_token(user)
  607. if need_register:
  608. await self.handler.register_with_store(
  609. user_id=user_id,
  610. password_hash=password_hash,
  611. create_profile_with_displayname=user.localpart,
  612. )
  613. else:
  614. await self.hs.get_auth_handler().delete_access_tokens_for_user(user_id)
  615. await self.store.add_access_token_to_user(
  616. user_id=user_id, token=token, device_id=None, valid_until_ms=None
  617. )
  618. if displayname is not None:
  619. # logger.info("setting user display name: %s -> %s", user_id, displayname)
  620. await self.hs.get_profile_handler().set_displayname(
  621. user, requester, displayname, by_admin=True
  622. )
  623. return user_id, token
  624. class RemoteAutoJoinTestCase(unittest.HomeserverTestCase):
  625. """Tests auto-join on remote rooms."""
  626. def make_homeserver(self, reactor, clock):
  627. self.room_id = "!roomid:remotetest"
  628. async def update_membership(*args, **kwargs):
  629. pass
  630. async def lookup_room_alias(*args, **kwargs):
  631. return RoomID.from_string(self.room_id), ["remotetest"]
  632. self.room_member_handler = Mock(spec=["update_membership", "lookup_room_alias"])
  633. self.room_member_handler.update_membership.side_effect = update_membership
  634. self.room_member_handler.lookup_room_alias.side_effect = lookup_room_alias
  635. hs = self.setup_test_homeserver(room_member_handler=self.room_member_handler)
  636. return hs
  637. def prepare(self, reactor, clock, hs):
  638. self.handler = self.hs.get_registration_handler()
  639. self.store = self.hs.get_datastores().main
  640. @override_config({"auto_join_rooms": ["#room:remotetest"]})
  641. def test_auto_create_auto_join_remote_room(self):
  642. """Tests that we don't attempt to create remote rooms, and that we don't attempt
  643. to invite ourselves to rooms we're not in."""
  644. # Register a first user; this should call _create_and_join_rooms
  645. self.get_success(self.handler.register_user(localpart="jeff"))
  646. _, kwargs = self.room_member_handler.update_membership.call_args
  647. self.assertEqual(kwargs["room_id"], self.room_id)
  648. self.assertEqual(kwargs["action"], "join")
  649. self.assertEqual(kwargs["remote_room_hosts"], ["remotetest"])
  650. # Register a second user; this should call _join_rooms
  651. self.get_success(self.handler.register_user(localpart="jeff2"))
  652. _, kwargs = self.room_member_handler.update_membership.call_args
  653. self.assertEqual(kwargs["room_id"], self.room_id)
  654. self.assertEqual(kwargs["action"], "join")
  655. self.assertEqual(kwargs["remote_room_hosts"], ["remotetest"])