mirror of
https://mau.dev/maunium/synapse.git
synced 2024-08-25 11:45:30 +00:00
c0e0740bef
This commit adds two config options: * `restrict_public_rooms_to_local_users` Requires auth to fetch the public rooms directory through the CS API and disables fetching it through the federation API. * `require_auth_for_profile_requests` When set to `true`, requires that requests to `/profile` over the CS API are authenticated, and only returns the user's profile if the requester shares a room with the profile's owner, as per MSC1301. MSC1301 also specifies a behaviour for federation (only returning the profile if the server asking for it shares a room with the profile's owner), but that's currently really non-trivial to do in a not too expensive way. Next step is writing down a MSC that allows a HS to specify which user sent the profile query. In this implementation, Synapse won't send a profile query over federation if it doesn't believe it already shares a room with the profile's owner, though. Groups have been intentionally omitted from this commit.
157 lines
5.1 KiB
Python
157 lines
5.1 KiB
Python
# -*- coding: utf-8 -*-
|
|
# Copyright 2014-2016 OpenMarket Ltd
|
|
#
|
|
# Licensed under the Apache License, Version 2.0 (the "License");
|
|
# you may not use this file except in compliance with the License.
|
|
# You may obtain a copy of the License at
|
|
#
|
|
# http://www.apache.org/licenses/LICENSE-2.0
|
|
#
|
|
# Unless required by applicable law or agreed to in writing, software
|
|
# distributed under the License is distributed on an "AS IS" BASIS,
|
|
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
# See the License for the specific language governing permissions and
|
|
# limitations under the License.
|
|
|
|
""" This module contains REST servlets to do with profile: /profile/<paths> """
|
|
from twisted.internet import defer
|
|
|
|
from synapse.http.servlet import parse_json_object_from_request
|
|
from synapse.types import UserID
|
|
|
|
from .base import ClientV1RestServlet, client_path_patterns
|
|
|
|
|
|
class ProfileDisplaynameRestServlet(ClientV1RestServlet):
|
|
PATTERNS = client_path_patterns("/profile/(?P<user_id>[^/]*)/displayname")
|
|
|
|
def __init__(self, hs):
|
|
super(ProfileDisplaynameRestServlet, self).__init__(hs)
|
|
self.profile_handler = hs.get_profile_handler()
|
|
|
|
@defer.inlineCallbacks
|
|
def on_GET(self, request, user_id):
|
|
requester_user = None
|
|
|
|
if self.hs.config.require_auth_for_profile_requests:
|
|
requester = yield self.auth.get_user_by_req(request)
|
|
requester_user = requester.user
|
|
|
|
user = UserID.from_string(user_id)
|
|
|
|
yield self.profile_handler.check_profile_query_allowed(user, requester_user)
|
|
|
|
displayname = yield self.profile_handler.get_displayname(user)
|
|
|
|
ret = {}
|
|
if displayname is not None:
|
|
ret["displayname"] = displayname
|
|
|
|
defer.returnValue((200, ret))
|
|
|
|
@defer.inlineCallbacks
|
|
def on_PUT(self, request, user_id):
|
|
requester = yield self.auth.get_user_by_req(request, allow_guest=True)
|
|
user = UserID.from_string(user_id)
|
|
is_admin = yield self.auth.is_server_admin(requester.user)
|
|
|
|
content = parse_json_object_from_request(request)
|
|
|
|
try:
|
|
new_name = content["displayname"]
|
|
except Exception:
|
|
defer.returnValue((400, "Unable to parse name"))
|
|
|
|
yield self.profile_handler.set_displayname(
|
|
user, requester, new_name, is_admin)
|
|
|
|
defer.returnValue((200, {}))
|
|
|
|
def on_OPTIONS(self, request, user_id):
|
|
return (200, {})
|
|
|
|
|
|
class ProfileAvatarURLRestServlet(ClientV1RestServlet):
|
|
PATTERNS = client_path_patterns("/profile/(?P<user_id>[^/]*)/avatar_url")
|
|
|
|
def __init__(self, hs):
|
|
super(ProfileAvatarURLRestServlet, self).__init__(hs)
|
|
self.profile_handler = hs.get_profile_handler()
|
|
|
|
@defer.inlineCallbacks
|
|
def on_GET(self, request, user_id):
|
|
requester_user = None
|
|
|
|
if self.hs.config.require_auth_for_profile_requests:
|
|
requester = yield self.auth.get_user_by_req(request)
|
|
requester_user = requester.user
|
|
|
|
user = UserID.from_string(user_id)
|
|
|
|
yield self.profile_handler.check_profile_query_allowed(user, requester_user)
|
|
|
|
avatar_url = yield self.profile_handler.get_avatar_url(user)
|
|
|
|
ret = {}
|
|
if avatar_url is not None:
|
|
ret["avatar_url"] = avatar_url
|
|
|
|
defer.returnValue((200, ret))
|
|
|
|
@defer.inlineCallbacks
|
|
def on_PUT(self, request, user_id):
|
|
requester = yield self.auth.get_user_by_req(request)
|
|
user = UserID.from_string(user_id)
|
|
is_admin = yield self.auth.is_server_admin(requester.user)
|
|
|
|
content = parse_json_object_from_request(request)
|
|
try:
|
|
new_name = content["avatar_url"]
|
|
except Exception:
|
|
defer.returnValue((400, "Unable to parse name"))
|
|
|
|
yield self.profile_handler.set_avatar_url(
|
|
user, requester, new_name, is_admin)
|
|
|
|
defer.returnValue((200, {}))
|
|
|
|
def on_OPTIONS(self, request, user_id):
|
|
return (200, {})
|
|
|
|
|
|
class ProfileRestServlet(ClientV1RestServlet):
|
|
PATTERNS = client_path_patterns("/profile/(?P<user_id>[^/]*)")
|
|
|
|
def __init__(self, hs):
|
|
super(ProfileRestServlet, self).__init__(hs)
|
|
self.profile_handler = hs.get_profile_handler()
|
|
|
|
@defer.inlineCallbacks
|
|
def on_GET(self, request, user_id):
|
|
requester_user = None
|
|
|
|
if self.hs.config.require_auth_for_profile_requests:
|
|
requester = yield self.auth.get_user_by_req(request)
|
|
requester_user = requester.user
|
|
|
|
user = UserID.from_string(user_id)
|
|
|
|
yield self.profile_handler.check_profile_query_allowed(user, requester_user)
|
|
|
|
displayname = yield self.profile_handler.get_displayname(user)
|
|
avatar_url = yield self.profile_handler.get_avatar_url(user)
|
|
|
|
ret = {}
|
|
if displayname is not None:
|
|
ret["displayname"] = displayname
|
|
if avatar_url is not None:
|
|
ret["avatar_url"] = avatar_url
|
|
|
|
defer.returnValue((200, ret))
|
|
|
|
|
|
def register_servlets(hs, http_server):
|
|
ProfileDisplaynameRestServlet(hs).register(http_server)
|
|
ProfileAvatarURLRestServlet(hs).register(http_server)
|
|
ProfileRestServlet(hs).register(http_server)
|