We need a config option to limit the public room directory to registered users only (SYN-584)

[matrixbot]

Submitted by @​matthew:matrix.org
Use case is to stop sensitive publicroom data leaking from an otherwise federated HS. This is relevant to our own 'private' HS!

(Imported from https://matrix.org/jira/browse/SYN-584)

[matrixbot]

Jira watchers: @ara4n

[matrixbot]

A workaround patch I did for Charlie on HQ:

(env)sierra:synapse matthew$ git diff
diff --git a/synapse/rest/client/v1/room.py b/synapse/rest/client/v1/room.py
index 926f77d..ed80908 100644
--- a/synapse/rest/client/v1/room.py
+++ b/synapse/rest/client/v1/room.py
@​@​ -284,6 +284,7 @​@​ class PublicRoomListRestServlet(ClientV1RestServlet):

     @​defer.inlineCallbacks
     def on_GET(self, request):
+        user, _, _ = yield self.auth.get_user_by_req(request)
         handler = self.handlers.room_list_handler
         data = yield handler.get_public_room_list()
         defer.returnValue((200, data))

-- @ara4n

[ara4n]

spec bug: https://github.com/matrix-org/matrix-doc/issues/612

[richvdh]

Note that doing this needs a spec change, as per matrix-org/matrix-doc#612

[ara4n]

the specific case of restricting the CS API to registered users is now handled in #5083 (which in turn is a port of matrix-org/matrix-spec#584).

I do not think this has to be blocked on a spec change to enhance CS API's /publicRooms to distinguish "show rooms for the general public" v. "show rooms for registered users" (and migration to use that system, and aligning it with upcoming per-community room directories, etc) - we have a clear need right now for people who simply don't want the /publicRooms endpoint to be available to unregistered users.

Meanwhile, we do need to figure out the semantics for how to restrict access over SS API. I personally would do this as another config option, of the form allow_public_rooms_over_federation or similar, to give admins an easy way to stop their roomdir being queried via fed.

[ara4n]

closed by #5083. thanks @babolivier!