2014-09-29 09:59:52 -04:00
|
|
|
# -*- coding: utf-8 -*-
|
2016-01-06 23:26:29 -05:00
|
|
|
# Copyright 2014-2016 OpenMarket Ltd
|
2019-05-01 10:32:38 -04:00
|
|
|
# Copyright 2018-2019 New Vector Ltd
|
2014-09-29 09:59:52 -04:00
|
|
|
#
|
|
|
|
# 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.
|
|
|
|
|
2018-07-20 08:41:13 -04:00
|
|
|
import hashlib
|
|
|
|
import hmac
|
2018-07-09 02:09:20 -04:00
|
|
|
import logging
|
2019-02-28 22:05:47 -05:00
|
|
|
import platform
|
2019-05-01 10:18:58 -04:00
|
|
|
import re
|
2014-09-29 09:59:52 -04:00
|
|
|
|
2018-08-01 10:54:06 -04:00
|
|
|
from six import text_type
|
2018-06-26 05:26:54 -04:00
|
|
|
from six.moves import http_client
|
|
|
|
|
2018-07-09 02:09:20 -04:00
|
|
|
from twisted.internet import defer
|
|
|
|
|
2019-02-28 22:05:47 -05:00
|
|
|
import synapse
|
2018-12-14 13:20:59 -05:00
|
|
|
from synapse.api.constants import Membership, UserTypes
|
2018-07-09 02:09:20 -04:00
|
|
|
from synapse.api.errors import AuthError, Codes, NotFoundError, SynapseError
|
2019-05-01 10:18:58 -04:00
|
|
|
from synapse.http.server import JsonResource
|
2018-07-13 15:40:14 -04:00
|
|
|
from synapse.http.servlet import (
|
2019-05-01 05:40:33 -04:00
|
|
|
RestServlet,
|
2018-07-13 15:53:01 -04:00
|
|
|
assert_params_in_dict,
|
2018-07-13 15:40:14 -04:00
|
|
|
parse_integer,
|
2018-07-16 07:46:49 -04:00
|
|
|
parse_json_object_from_request,
|
|
|
|
parse_string,
|
2018-07-13 15:40:14 -04:00
|
|
|
)
|
2019-05-02 05:45:52 -04:00
|
|
|
from synapse.rest.admin._base import assert_requester_is_admin, assert_user_is_admin
|
2018-07-09 02:09:20 -04:00
|
|
|
from synapse.types import UserID, create_requester
|
2019-02-28 22:05:47 -05:00
|
|
|
from synapse.util.versionstring import get_version_string
|
2015-01-23 06:47:15 -05:00
|
|
|
|
2014-09-29 09:59:52 -04:00
|
|
|
logger = logging.getLogger(__name__)
|
|
|
|
|
|
|
|
|
2019-05-01 10:18:58 -04:00
|
|
|
def historical_admin_path_patterns(path_regex):
|
|
|
|
"""Returns the list of patterns for an admin endpoint, including historical ones
|
|
|
|
|
|
|
|
This is a backwards-compatibility hack. Previously, the Admin API was exposed at
|
|
|
|
various paths under /_matrix/client. This function returns a list of patterns
|
|
|
|
matching those paths (as well as the new one), so that existing scripts which rely
|
|
|
|
on the endpoints being available there are not broken.
|
|
|
|
|
|
|
|
Note that this should only be used for existing endpoints: new ones should just
|
|
|
|
register for the /_synapse/admin path.
|
|
|
|
"""
|
|
|
|
return list(
|
|
|
|
re.compile(prefix + path_regex)
|
|
|
|
for prefix in (
|
|
|
|
"^/_synapse/admin/v1",
|
|
|
|
"^/_matrix/client/api/v1/admin",
|
|
|
|
"^/_matrix/client/unstable/admin",
|
|
|
|
"^/_matrix/client/r0/admin"
|
|
|
|
)
|
|
|
|
)
|
|
|
|
|
|
|
|
|
2019-05-01 05:40:33 -04:00
|
|
|
class UsersRestServlet(RestServlet):
|
2019-05-01 10:18:58 -04:00
|
|
|
PATTERNS = historical_admin_path_patterns("/users/(?P<user_id>[^/]*)")
|
2017-02-02 08:02:26 -05:00
|
|
|
|
|
|
|
def __init__(self, hs):
|
2019-05-01 05:40:33 -04:00
|
|
|
self.hs = hs
|
|
|
|
self.auth = hs.get_auth()
|
2017-02-02 08:02:26 -05:00
|
|
|
self.handlers = hs.get_handlers()
|
|
|
|
|
|
|
|
@defer.inlineCallbacks
|
|
|
|
def on_GET(self, request, user_id):
|
|
|
|
target_user = UserID.from_string(user_id)
|
2019-05-02 05:45:52 -04:00
|
|
|
yield assert_requester_is_admin(self.auth, request)
|
2017-02-02 08:02:26 -05:00
|
|
|
|
|
|
|
if not self.hs.is_mine(target_user):
|
|
|
|
raise SynapseError(400, "Can only users a local user")
|
|
|
|
|
|
|
|
ret = yield self.handlers.admin_handler.get_users()
|
|
|
|
|
|
|
|
defer.returnValue((200, ret))
|
|
|
|
|
|
|
|
|
2019-05-01 05:40:33 -04:00
|
|
|
class VersionServlet(RestServlet):
|
2019-05-01 10:18:58 -04:00
|
|
|
PATTERNS = historical_admin_path_patterns("/server_version")
|
2019-02-28 22:05:47 -05:00
|
|
|
|
2019-05-01 05:40:33 -04:00
|
|
|
def __init__(self, hs):
|
|
|
|
self.auth = hs.get_auth()
|
|
|
|
|
2019-02-28 22:05:47 -05:00
|
|
|
@defer.inlineCallbacks
|
|
|
|
def on_GET(self, request):
|
2019-05-02 05:45:52 -04:00
|
|
|
yield assert_requester_is_admin(self.auth, request)
|
2019-02-28 22:05:47 -05:00
|
|
|
|
|
|
|
ret = {
|
|
|
|
'server_version': get_version_string(synapse),
|
|
|
|
'python_version': platform.python_version(),
|
|
|
|
}
|
|
|
|
|
|
|
|
defer.returnValue((200, ret))
|
|
|
|
|
|
|
|
|
2019-05-01 05:40:33 -04:00
|
|
|
class UserRegisterServlet(RestServlet):
|
2018-07-20 08:41:13 -04:00
|
|
|
"""
|
|
|
|
Attributes:
|
|
|
|
NONCE_TIMEOUT (int): Seconds until a generated nonce won't be accepted
|
|
|
|
nonces (dict[str, int]): The nonces that we will accept. A dict of
|
|
|
|
nonce to the time it was generated, in int seconds.
|
|
|
|
"""
|
2019-05-01 10:18:58 -04:00
|
|
|
PATTERNS = historical_admin_path_patterns("/register")
|
2018-07-20 08:41:13 -04:00
|
|
|
NONCE_TIMEOUT = 60
|
|
|
|
|
|
|
|
def __init__(self, hs):
|
|
|
|
self.handlers = hs.get_handlers()
|
|
|
|
self.reactor = hs.get_reactor()
|
|
|
|
self.nonces = {}
|
|
|
|
self.hs = hs
|
|
|
|
|
|
|
|
def _clear_old_nonces(self):
|
|
|
|
"""
|
|
|
|
Clear out old nonces that are older than NONCE_TIMEOUT.
|
|
|
|
"""
|
|
|
|
now = int(self.reactor.seconds())
|
|
|
|
|
|
|
|
for k, v in list(self.nonces.items()):
|
|
|
|
if now - v > self.NONCE_TIMEOUT:
|
|
|
|
del self.nonces[k]
|
|
|
|
|
|
|
|
def on_GET(self, request):
|
|
|
|
"""
|
|
|
|
Generate a new nonce.
|
|
|
|
"""
|
|
|
|
self._clear_old_nonces()
|
|
|
|
|
|
|
|
nonce = self.hs.get_secrets().token_hex(64)
|
|
|
|
self.nonces[nonce] = int(self.reactor.seconds())
|
2018-09-12 06:41:31 -04:00
|
|
|
return (200, {"nonce": nonce})
|
2018-07-20 08:41:13 -04:00
|
|
|
|
|
|
|
@defer.inlineCallbacks
|
|
|
|
def on_POST(self, request):
|
|
|
|
self._clear_old_nonces()
|
|
|
|
|
|
|
|
if not self.hs.config.registration_shared_secret:
|
|
|
|
raise SynapseError(400, "Shared secret registration is not enabled")
|
|
|
|
|
|
|
|
body = parse_json_object_from_request(request)
|
|
|
|
|
|
|
|
if "nonce" not in body:
|
|
|
|
raise SynapseError(
|
|
|
|
400, "nonce must be specified", errcode=Codes.BAD_JSON,
|
|
|
|
)
|
|
|
|
|
|
|
|
nonce = body["nonce"]
|
|
|
|
|
|
|
|
if nonce not in self.nonces:
|
|
|
|
raise SynapseError(
|
|
|
|
400, "unrecognised nonce",
|
|
|
|
)
|
|
|
|
|
|
|
|
# Delete the nonce, so it can't be reused, even if it's invalid
|
|
|
|
del self.nonces[nonce]
|
|
|
|
|
|
|
|
if "username" not in body:
|
|
|
|
raise SynapseError(
|
|
|
|
400, "username must be specified", errcode=Codes.BAD_JSON,
|
|
|
|
)
|
|
|
|
else:
|
2018-08-01 10:54:06 -04:00
|
|
|
if (
|
|
|
|
not isinstance(body['username'], text_type)
|
|
|
|
or len(body['username']) > 512
|
|
|
|
):
|
2018-07-20 08:41:13 -04:00
|
|
|
raise SynapseError(400, "Invalid username")
|
|
|
|
|
|
|
|
username = body["username"].encode("utf-8")
|
|
|
|
if b"\x00" in username:
|
|
|
|
raise SynapseError(400, "Invalid username")
|
|
|
|
|
|
|
|
if "password" not in body:
|
|
|
|
raise SynapseError(
|
|
|
|
400, "password must be specified", errcode=Codes.BAD_JSON,
|
|
|
|
)
|
|
|
|
else:
|
2018-08-01 10:54:06 -04:00
|
|
|
if (
|
|
|
|
not isinstance(body['password'], text_type)
|
|
|
|
or len(body['password']) > 512
|
|
|
|
):
|
2018-07-20 08:41:13 -04:00
|
|
|
raise SynapseError(400, "Invalid password")
|
|
|
|
|
|
|
|
password = body["password"].encode("utf-8")
|
|
|
|
if b"\x00" in password:
|
|
|
|
raise SynapseError(400, "Invalid password")
|
|
|
|
|
|
|
|
admin = body.get("admin", None)
|
2018-12-14 13:20:59 -05:00
|
|
|
user_type = body.get("user_type", None)
|
|
|
|
|
|
|
|
if user_type is not None and user_type not in UserTypes.ALL_USER_TYPES:
|
|
|
|
raise SynapseError(400, "Invalid user type")
|
|
|
|
|
2018-07-20 08:41:13 -04:00
|
|
|
got_mac = body["mac"]
|
|
|
|
|
|
|
|
want_mac = hmac.new(
|
|
|
|
key=self.hs.config.registration_shared_secret.encode(),
|
|
|
|
digestmod=hashlib.sha1,
|
|
|
|
)
|
2018-09-12 06:41:31 -04:00
|
|
|
want_mac.update(nonce.encode('utf8'))
|
2018-07-20 08:41:13 -04:00
|
|
|
want_mac.update(b"\x00")
|
|
|
|
want_mac.update(username)
|
|
|
|
want_mac.update(b"\x00")
|
|
|
|
want_mac.update(password)
|
|
|
|
want_mac.update(b"\x00")
|
|
|
|
want_mac.update(b"admin" if admin else b"notadmin")
|
2018-12-14 13:20:59 -05:00
|
|
|
if user_type:
|
|
|
|
want_mac.update(b"\x00")
|
|
|
|
want_mac.update(user_type.encode('utf8'))
|
2018-07-20 08:41:13 -04:00
|
|
|
want_mac = want_mac.hexdigest()
|
|
|
|
|
2018-09-12 06:41:31 -04:00
|
|
|
if not hmac.compare_digest(
|
|
|
|
want_mac.encode('ascii'),
|
|
|
|
got_mac.encode('ascii')
|
|
|
|
):
|
2018-08-01 10:54:06 -04:00
|
|
|
raise SynapseError(403, "HMAC incorrect")
|
2018-07-20 08:41:13 -04:00
|
|
|
|
|
|
|
# Reuse the parts of RegisterRestServlet to reduce code duplication
|
|
|
|
from synapse.rest.client.v2_alpha.register import RegisterRestServlet
|
2018-08-01 10:54:06 -04:00
|
|
|
|
2018-07-20 08:41:13 -04:00
|
|
|
register = RegisterRestServlet(self.hs)
|
|
|
|
|
|
|
|
(user_id, _) = yield register.registration_handler.register(
|
2018-08-01 10:54:06 -04:00
|
|
|
localpart=body['username'].lower(),
|
|
|
|
password=body["password"],
|
|
|
|
admin=bool(admin),
|
2018-07-20 08:41:13 -04:00
|
|
|
generate_token=False,
|
2018-12-14 13:20:59 -05:00
|
|
|
user_type=user_type,
|
2018-07-20 08:41:13 -04:00
|
|
|
)
|
|
|
|
|
|
|
|
result = yield register._create_registration_details(user_id, body)
|
|
|
|
defer.returnValue((200, result))
|
|
|
|
|
|
|
|
|
2019-05-01 05:40:33 -04:00
|
|
|
class WhoisRestServlet(RestServlet):
|
2019-05-01 10:18:58 -04:00
|
|
|
PATTERNS = historical_admin_path_patterns("/whois/(?P<user_id>[^/]*)")
|
2014-09-29 09:59:52 -04:00
|
|
|
|
2016-08-12 05:03:19 -04:00
|
|
|
def __init__(self, hs):
|
2019-05-01 05:40:33 -04:00
|
|
|
self.hs = hs
|
|
|
|
self.auth = hs.get_auth()
|
2016-08-12 05:03:19 -04:00
|
|
|
self.handlers = hs.get_handlers()
|
|
|
|
|
2014-09-29 09:59:52 -04:00
|
|
|
@defer.inlineCallbacks
|
|
|
|
def on_GET(self, request, user_id):
|
2015-01-23 06:47:15 -05:00
|
|
|
target_user = UserID.from_string(user_id)
|
2016-01-11 10:29:57 -05:00
|
|
|
requester = yield self.auth.get_user_by_req(request)
|
|
|
|
auth_user = requester.user
|
2014-09-29 09:59:52 -04:00
|
|
|
|
2019-05-02 05:45:52 -04:00
|
|
|
if target_user != auth_user:
|
|
|
|
yield assert_user_is_admin(self.auth, auth_user)
|
2014-09-29 09:59:52 -04:00
|
|
|
|
2014-12-02 05:42:28 -05:00
|
|
|
if not self.hs.is_mine(target_user):
|
2014-09-29 09:59:52 -04:00
|
|
|
raise SynapseError(400, "Can only whois a local user")
|
|
|
|
|
2014-09-29 10:04:04 -04:00
|
|
|
ret = yield self.handlers.admin_handler.get_whois(target_user)
|
2014-09-29 09:59:52 -04:00
|
|
|
|
|
|
|
defer.returnValue((200, ret))
|
|
|
|
|
|
|
|
|
2019-05-01 05:40:33 -04:00
|
|
|
class PurgeMediaCacheRestServlet(RestServlet):
|
2019-05-01 10:18:58 -04:00
|
|
|
PATTERNS = historical_admin_path_patterns("/purge_media_cache")
|
2016-06-29 09:57:59 -04:00
|
|
|
|
|
|
|
def __init__(self, hs):
|
|
|
|
self.media_repository = hs.get_media_repository()
|
2019-05-01 05:40:33 -04:00
|
|
|
self.auth = hs.get_auth()
|
2016-06-29 09:57:59 -04:00
|
|
|
|
|
|
|
@defer.inlineCallbacks
|
|
|
|
def on_POST(self, request):
|
2019-05-02 05:45:52 -04:00
|
|
|
yield assert_requester_is_admin(self.auth, request)
|
2016-06-29 09:57:59 -04:00
|
|
|
|
2018-07-13 15:40:14 -04:00
|
|
|
before_ts = parse_integer(request, "before_ts", required=True)
|
|
|
|
logger.info("before_ts: %r", before_ts)
|
2016-06-29 09:57:59 -04:00
|
|
|
|
|
|
|
ret = yield self.media_repository.delete_old_remote_media(before_ts)
|
|
|
|
|
|
|
|
defer.returnValue((200, ret))
|
|
|
|
|
|
|
|
|
2019-05-01 05:40:33 -04:00
|
|
|
class PurgeHistoryRestServlet(RestServlet):
|
2019-05-01 10:18:58 -04:00
|
|
|
PATTERNS = historical_admin_path_patterns(
|
|
|
|
"/purge_history/(?P<room_id>[^/]*)(/(?P<event_id>[^/]+))?"
|
2016-07-05 05:28:51 -04:00
|
|
|
)
|
|
|
|
|
2016-08-12 05:03:19 -04:00
|
|
|
def __init__(self, hs):
|
2018-03-01 18:20:54 -05:00
|
|
|
"""
|
|
|
|
|
|
|
|
Args:
|
|
|
|
hs (synapse.server.HomeServer)
|
|
|
|
"""
|
2018-07-18 10:22:02 -04:00
|
|
|
self.pagination_handler = hs.get_pagination_handler()
|
2018-03-01 18:20:54 -05:00
|
|
|
self.store = hs.get_datastore()
|
2019-05-01 05:40:33 -04:00
|
|
|
self.auth = hs.get_auth()
|
2016-08-12 05:03:19 -04:00
|
|
|
|
2016-07-05 05:28:51 -04:00
|
|
|
@defer.inlineCallbacks
|
|
|
|
def on_POST(self, request, room_id, event_id):
|
2019-05-02 05:45:52 -04:00
|
|
|
yield assert_requester_is_admin(self.auth, request)
|
2016-07-05 05:28:51 -04:00
|
|
|
|
2018-02-08 13:44:52 -05:00
|
|
|
body = parse_json_object_from_request(request, allow_empty_body=True)
|
|
|
|
|
2018-02-13 08:04:41 -05:00
|
|
|
delete_local_events = bool(body.get("delete_local_events", False))
|
2018-02-08 13:44:52 -05:00
|
|
|
|
2018-03-01 18:20:54 -05:00
|
|
|
# establish the topological ordering we should keep events from. The
|
|
|
|
# user can provide an event_id in the URL or the request body, or can
|
|
|
|
# provide a timestamp in the request body.
|
|
|
|
if event_id is None:
|
|
|
|
event_id = body.get('purge_up_to_event_id')
|
|
|
|
|
|
|
|
if event_id is not None:
|
|
|
|
event = yield self.store.get_event(event_id)
|
|
|
|
|
|
|
|
if event.room_id != room_id:
|
|
|
|
raise SynapseError(400, "Event is for wrong room.")
|
|
|
|
|
2018-05-15 11:06:30 -04:00
|
|
|
token = yield self.store.get_topological_token_for_event(event_id)
|
|
|
|
|
2018-03-01 18:20:54 -05:00
|
|
|
logger.info(
|
2018-05-15 11:06:30 -04:00
|
|
|
"[purge] purging up to token %s (event_id %s)",
|
|
|
|
token, event_id,
|
2018-03-01 18:20:54 -05:00
|
|
|
)
|
|
|
|
elif 'purge_up_to_ts' in body:
|
|
|
|
ts = body['purge_up_to_ts']
|
|
|
|
if not isinstance(ts, int):
|
|
|
|
raise SynapseError(
|
|
|
|
400, "purge_up_to_ts must be an int",
|
|
|
|
errcode=Codes.BAD_JSON,
|
|
|
|
)
|
|
|
|
|
|
|
|
stream_ordering = (
|
|
|
|
yield self.store.find_first_stream_ordering_after_ts(ts)
|
|
|
|
)
|
|
|
|
|
2018-06-06 19:15:49 -04:00
|
|
|
r = (
|
2018-03-01 18:20:54 -05:00
|
|
|
yield self.store.get_room_event_after_stream_ordering(
|
|
|
|
room_id, stream_ordering,
|
|
|
|
)
|
|
|
|
)
|
2018-06-06 19:15:49 -04:00
|
|
|
if not r:
|
2018-04-30 08:29:48 -04:00
|
|
|
logger.warn(
|
|
|
|
"[purge] purging events not possible: No event found "
|
|
|
|
"(received_ts %i => stream_ordering %i)",
|
|
|
|
ts, stream_ordering,
|
|
|
|
)
|
|
|
|
raise SynapseError(
|
|
|
|
404,
|
|
|
|
"there is no event to be purged",
|
|
|
|
errcode=Codes.NOT_FOUND,
|
|
|
|
)
|
2018-06-06 19:15:49 -04:00
|
|
|
(stream, topo, _event_id) = r
|
|
|
|
token = "t%d-%d" % (topo, stream)
|
2018-03-01 18:20:54 -05:00
|
|
|
logger.info(
|
2018-06-06 19:26:38 -04:00
|
|
|
"[purge] purging up to token %s (received_ts %i => "
|
2018-03-01 18:20:54 -05:00
|
|
|
"stream_ordering %i)",
|
2018-05-15 11:06:30 -04:00
|
|
|
token, ts, stream_ordering,
|
2018-03-01 18:20:54 -05:00
|
|
|
)
|
|
|
|
else:
|
|
|
|
raise SynapseError(
|
|
|
|
400,
|
|
|
|
"must specify purge_up_to_event_id or purge_up_to_ts",
|
|
|
|
errcode=Codes.BAD_JSON,
|
|
|
|
)
|
|
|
|
|
2018-07-18 10:22:02 -04:00
|
|
|
purge_id = yield self.pagination_handler.start_purge_history(
|
2018-05-15 11:06:30 -04:00
|
|
|
room_id, token,
|
2018-02-08 13:44:52 -05:00
|
|
|
delete_local_events=delete_local_events,
|
|
|
|
)
|
2016-07-05 05:28:51 -04:00
|
|
|
|
2018-03-08 06:47:28 -05:00
|
|
|
defer.returnValue((200, {
|
|
|
|
"purge_id": purge_id,
|
|
|
|
}))
|
|
|
|
|
|
|
|
|
2019-05-01 05:40:33 -04:00
|
|
|
class PurgeHistoryStatusRestServlet(RestServlet):
|
2019-05-01 10:18:58 -04:00
|
|
|
PATTERNS = historical_admin_path_patterns(
|
|
|
|
"/purge_history_status/(?P<purge_id>[^/]+)"
|
2018-03-08 06:47:28 -05:00
|
|
|
)
|
|
|
|
|
|
|
|
def __init__(self, hs):
|
|
|
|
"""
|
|
|
|
|
|
|
|
Args:
|
|
|
|
hs (synapse.server.HomeServer)
|
|
|
|
"""
|
2018-07-18 10:22:02 -04:00
|
|
|
self.pagination_handler = hs.get_pagination_handler()
|
2019-05-01 05:40:33 -04:00
|
|
|
self.auth = hs.get_auth()
|
2018-03-08 06:47:28 -05:00
|
|
|
|
|
|
|
@defer.inlineCallbacks
|
|
|
|
def on_GET(self, request, purge_id):
|
2019-05-02 05:45:52 -04:00
|
|
|
yield assert_requester_is_admin(self.auth, request)
|
2018-03-08 06:47:28 -05:00
|
|
|
|
2018-07-18 10:22:02 -04:00
|
|
|
purge_status = self.pagination_handler.get_purge_status(purge_id)
|
2018-03-08 06:47:28 -05:00
|
|
|
if purge_status is None:
|
|
|
|
raise NotFoundError("purge id '%s' not found" % purge_id)
|
|
|
|
|
|
|
|
defer.returnValue((200, purge_status.asdict()))
|
2016-07-05 05:28:51 -04:00
|
|
|
|
|
|
|
|
2019-05-01 05:40:33 -04:00
|
|
|
class DeactivateAccountRestServlet(RestServlet):
|
2019-05-01 10:18:58 -04:00
|
|
|
PATTERNS = historical_admin_path_patterns("/deactivate/(?P<target_user_id>[^/]*)")
|
2016-06-30 10:40:58 -04:00
|
|
|
|
|
|
|
def __init__(self, hs):
|
2017-11-29 06:48:43 -05:00
|
|
|
self._deactivate_account_handler = hs.get_deactivate_account_handler()
|
2019-05-01 05:40:33 -04:00
|
|
|
self.auth = hs.get_auth()
|
2016-06-30 10:40:58 -04:00
|
|
|
|
|
|
|
@defer.inlineCallbacks
|
|
|
|
def on_POST(self, request, target_user_id):
|
2019-05-02 05:45:52 -04:00
|
|
|
yield assert_requester_is_admin(self.auth, request)
|
2018-06-26 05:42:50 -04:00
|
|
|
body = parse_json_object_from_request(request, allow_empty_body=True)
|
2018-06-26 05:26:54 -04:00
|
|
|
erase = body.get("erase", False)
|
|
|
|
if not isinstance(erase, bool):
|
|
|
|
raise SynapseError(
|
|
|
|
http_client.BAD_REQUEST,
|
|
|
|
"Param 'erase' must be a boolean, if given",
|
|
|
|
Codes.BAD_JSON,
|
|
|
|
)
|
|
|
|
|
2016-06-30 10:40:58 -04:00
|
|
|
UserID.from_string(target_user_id)
|
|
|
|
|
2018-08-08 06:54:55 -04:00
|
|
|
result = yield self._deactivate_account_handler.deactivate_account(
|
2018-06-26 05:26:54 -04:00
|
|
|
target_user_id, erase,
|
2018-06-25 08:42:55 -04:00
|
|
|
)
|
2018-08-08 06:54:55 -04:00
|
|
|
if result:
|
|
|
|
id_server_unbind_result = "success"
|
|
|
|
else:
|
|
|
|
id_server_unbind_result = "no-support"
|
|
|
|
|
|
|
|
defer.returnValue((200, {
|
|
|
|
"id_server_unbind_result": id_server_unbind_result,
|
|
|
|
}))
|
2016-06-30 10:40:58 -04:00
|
|
|
|
|
|
|
|
2019-05-01 05:40:33 -04:00
|
|
|
class ShutdownRoomRestServlet(RestServlet):
|
2017-06-19 07:36:28 -04:00
|
|
|
"""Shuts down a room by removing all local users from the room and blocking
|
|
|
|
all future invites and joins to the room. Any local aliases will be repointed
|
2017-06-19 09:10:13 -04:00
|
|
|
to a new room created by `new_room_user_id` and kicked users will be auto
|
|
|
|
joined to the new room.
|
2017-06-19 07:36:28 -04:00
|
|
|
"""
|
2019-05-01 10:18:58 -04:00
|
|
|
PATTERNS = historical_admin_path_patterns("/shutdown_room/(?P<room_id>[^/]+)")
|
2017-06-19 07:36:28 -04:00
|
|
|
|
2017-06-19 09:10:13 -04:00
|
|
|
DEFAULT_MESSAGE = (
|
|
|
|
"Sharing illegal content on this server is not permitted and rooms in"
|
2017-08-04 18:44:11 -04:00
|
|
|
" violation will be blocked."
|
2017-06-19 09:10:13 -04:00
|
|
|
)
|
|
|
|
|
2017-06-19 07:36:28 -04:00
|
|
|
def __init__(self, hs):
|
2019-05-01 05:40:33 -04:00
|
|
|
self.hs = hs
|
2017-06-19 07:36:28 -04:00
|
|
|
self.store = hs.get_datastore()
|
|
|
|
self.state = hs.get_state_handler()
|
2018-05-17 04:01:09 -04:00
|
|
|
self._room_creation_handler = hs.get_room_creation_handler()
|
2018-01-15 11:52:07 -05:00
|
|
|
self.event_creation_handler = hs.get_event_creation_handler()
|
2018-03-01 05:54:37 -05:00
|
|
|
self.room_member_handler = hs.get_room_member_handler()
|
2019-05-01 05:40:33 -04:00
|
|
|
self.auth = hs.get_auth()
|
2017-06-19 07:36:28 -04:00
|
|
|
|
|
|
|
@defer.inlineCallbacks
|
|
|
|
def on_POST(self, request, room_id):
|
|
|
|
requester = yield self.auth.get_user_by_req(request)
|
2019-05-02 05:45:52 -04:00
|
|
|
yield assert_user_is_admin(self.auth, requester.user)
|
2017-06-19 07:36:28 -04:00
|
|
|
|
|
|
|
content = parse_json_object_from_request(request)
|
2018-07-13 15:53:01 -04:00
|
|
|
assert_params_in_dict(content, ["new_room_user_id"])
|
2018-07-13 15:40:14 -04:00
|
|
|
new_room_user_id = content["new_room_user_id"]
|
2017-06-19 09:10:13 -04:00
|
|
|
|
|
|
|
room_creator_requester = create_requester(new_room_user_id)
|
|
|
|
|
|
|
|
message = content.get("message", self.DEFAULT_MESSAGE)
|
|
|
|
room_name = content.get("room_name", "Content Violation Notification")
|
|
|
|
|
2018-05-17 04:01:09 -04:00
|
|
|
info = yield self._room_creation_handler.create_room(
|
2017-06-19 09:10:13 -04:00
|
|
|
room_creator_requester,
|
|
|
|
config={
|
|
|
|
"preset": "public_chat",
|
|
|
|
"name": room_name,
|
|
|
|
"power_level_content_override": {
|
|
|
|
"users_default": -10,
|
|
|
|
},
|
|
|
|
},
|
|
|
|
ratelimit=False,
|
|
|
|
)
|
|
|
|
new_room_id = info["room_id"]
|
|
|
|
|
2017-06-19 07:36:28 -04:00
|
|
|
requester_user_id = requester.user.to_string()
|
|
|
|
|
2019-03-20 12:52:28 -04:00
|
|
|
logger.info(
|
|
|
|
"Shutting down room %r, joining to new room: %r",
|
|
|
|
room_id, new_room_id,
|
|
|
|
)
|
2017-06-19 07:36:28 -04:00
|
|
|
|
2019-03-20 12:52:28 -04:00
|
|
|
# This will work even if the room is already blocked, but that is
|
|
|
|
# desirable in case the first attempt at blocking the room failed below.
|
2017-06-19 07:36:28 -04:00
|
|
|
yield self.store.block_room(room_id, requester_user_id)
|
|
|
|
|
2019-04-03 09:32:20 -04:00
|
|
|
users = yield self.state.get_current_users_in_room(room_id)
|
2017-06-19 07:36:28 -04:00
|
|
|
kicked_users = []
|
2019-03-20 12:54:00 -04:00
|
|
|
failed_to_kick_users = []
|
2017-06-19 07:36:28 -04:00
|
|
|
for user_id in users:
|
|
|
|
if not self.hs.is_mine_id(user_id):
|
|
|
|
continue
|
|
|
|
|
|
|
|
logger.info("Kicking %r from %r...", user_id, room_id)
|
|
|
|
|
2019-03-20 12:54:00 -04:00
|
|
|
try:
|
|
|
|
target_requester = create_requester(user_id)
|
|
|
|
yield self.room_member_handler.update_membership(
|
|
|
|
requester=target_requester,
|
|
|
|
target=target_requester.user,
|
|
|
|
room_id=room_id,
|
|
|
|
action=Membership.LEAVE,
|
|
|
|
content={},
|
2019-03-20 13:39:29 -04:00
|
|
|
ratelimit=False,
|
|
|
|
require_consent=False,
|
2019-03-20 12:54:00 -04:00
|
|
|
)
|
2017-06-19 07:36:28 -04:00
|
|
|
|
2019-03-20 12:54:00 -04:00
|
|
|
yield self.room_member_handler.forget(target_requester.user, room_id)
|
2017-06-19 07:40:29 -04:00
|
|
|
|
2019-03-20 12:54:00 -04:00
|
|
|
yield self.room_member_handler.update_membership(
|
|
|
|
requester=target_requester,
|
|
|
|
target=target_requester.user,
|
|
|
|
room_id=new_room_id,
|
|
|
|
action=Membership.JOIN,
|
|
|
|
content={},
|
2019-03-20 13:39:29 -04:00
|
|
|
ratelimit=False,
|
|
|
|
require_consent=False,
|
2019-03-20 12:54:00 -04:00
|
|
|
)
|
2017-06-19 09:10:13 -04:00
|
|
|
|
2019-03-20 12:54:00 -04:00
|
|
|
kicked_users.append(user_id)
|
|
|
|
except Exception:
|
|
|
|
logger.exception(
|
|
|
|
"Failed to leave old room and join new room for %r", user_id,
|
|
|
|
)
|
|
|
|
failed_to_kick_users.append(user_id)
|
2017-06-19 07:36:28 -04:00
|
|
|
|
2019-03-06 12:35:11 -05:00
|
|
|
yield self.event_creation_handler.create_and_send_nonmember_event(
|
|
|
|
room_creator_requester,
|
|
|
|
{
|
|
|
|
"type": "m.room.message",
|
|
|
|
"content": {"body": message, "msgtype": "m.text"},
|
|
|
|
"room_id": new_room_id,
|
|
|
|
"sender": new_room_user_id,
|
|
|
|
},
|
|
|
|
ratelimit=False,
|
|
|
|
)
|
|
|
|
|
2017-06-19 07:36:28 -04:00
|
|
|
aliases_for_room = yield self.store.get_aliases_for_room(room_id)
|
|
|
|
|
|
|
|
yield self.store.update_aliases_for_room(
|
2017-06-19 09:10:13 -04:00
|
|
|
room_id, new_room_id, requester_user_id
|
2017-06-19 07:36:28 -04:00
|
|
|
)
|
|
|
|
|
|
|
|
defer.returnValue((200, {
|
|
|
|
"kicked_users": kicked_users,
|
2019-03-20 12:54:00 -04:00
|
|
|
"failed_to_kick_users": failed_to_kick_users,
|
2017-06-19 07:36:28 -04:00
|
|
|
"local_aliases": aliases_for_room,
|
2017-06-19 09:10:13 -04:00
|
|
|
"new_room_id": new_room_id,
|
2017-06-19 07:36:28 -04:00
|
|
|
}))
|
|
|
|
|
|
|
|
|
2019-05-01 05:40:33 -04:00
|
|
|
class QuarantineMediaInRoom(RestServlet):
|
2017-06-19 12:39:21 -04:00
|
|
|
"""Quarantines all media in a room so that no one can download it via
|
|
|
|
this server.
|
|
|
|
"""
|
2019-05-01 10:18:58 -04:00
|
|
|
PATTERNS = historical_admin_path_patterns("/quarantine_media/(?P<room_id>[^/]+)")
|
2017-06-19 12:39:21 -04:00
|
|
|
|
|
|
|
def __init__(self, hs):
|
|
|
|
self.store = hs.get_datastore()
|
2019-05-01 05:40:33 -04:00
|
|
|
self.auth = hs.get_auth()
|
2017-06-19 12:39:21 -04:00
|
|
|
|
|
|
|
@defer.inlineCallbacks
|
|
|
|
def on_POST(self, request, room_id):
|
|
|
|
requester = yield self.auth.get_user_by_req(request)
|
2019-05-02 05:45:52 -04:00
|
|
|
yield assert_user_is_admin(self.auth, requester.user)
|
2017-06-19 12:39:21 -04:00
|
|
|
|
|
|
|
num_quarantined = yield self.store.quarantine_media_ids_in_room(
|
|
|
|
room_id, requester.user.to_string(),
|
|
|
|
)
|
|
|
|
|
|
|
|
defer.returnValue((200, {"num_quarantined": num_quarantined}))
|
|
|
|
|
|
|
|
|
2019-05-01 05:40:33 -04:00
|
|
|
class ListMediaInRoom(RestServlet):
|
2018-01-21 00:25:23 -05:00
|
|
|
"""Lists all of the media in a given room.
|
|
|
|
"""
|
2019-05-01 10:18:58 -04:00
|
|
|
PATTERNS = historical_admin_path_patterns("/room/(?P<room_id>[^/]+)/media")
|
2018-01-21 00:25:23 -05:00
|
|
|
|
|
|
|
def __init__(self, hs):
|
|
|
|
self.store = hs.get_datastore()
|
|
|
|
|
|
|
|
@defer.inlineCallbacks
|
|
|
|
def on_GET(self, request, room_id):
|
|
|
|
requester = yield self.auth.get_user_by_req(request)
|
|
|
|
is_admin = yield self.auth.is_server_admin(requester.user)
|
|
|
|
if not is_admin:
|
|
|
|
raise AuthError(403, "You are not a server admin")
|
|
|
|
|
|
|
|
local_mxcs, remote_mxcs = yield self.store.get_media_mxcs_in_room(room_id)
|
|
|
|
|
|
|
|
defer.returnValue((200, {"local": local_mxcs, "remote": remote_mxcs}))
|
|
|
|
|
|
|
|
|
2019-05-01 05:40:33 -04:00
|
|
|
class ResetPasswordRestServlet(RestServlet):
|
2017-02-02 08:02:26 -05:00
|
|
|
"""Post request to allow an administrator reset password for a user.
|
2017-08-04 18:56:12 -04:00
|
|
|
This needs user to have administrator access in Synapse.
|
2017-02-02 08:02:26 -05:00
|
|
|
Example:
|
2019-05-01 12:49:11 -04:00
|
|
|
http://localhost:8008/_synapse/admin/v1/reset_password/
|
2017-02-02 08:02:26 -05:00
|
|
|
@user:to_reset_password?access_token=admin_access_token
|
|
|
|
JsonBodyToSend:
|
|
|
|
{
|
|
|
|
"new_password": "secret"
|
|
|
|
}
|
|
|
|
Returns:
|
|
|
|
200 OK with empty object if success otherwise an error.
|
|
|
|
"""
|
2019-05-01 10:18:58 -04:00
|
|
|
PATTERNS = historical_admin_path_patterns("/reset_password/(?P<target_user_id>[^/]*)")
|
2017-02-02 08:02:26 -05:00
|
|
|
|
|
|
|
def __init__(self, hs):
|
|
|
|
self.store = hs.get_datastore()
|
|
|
|
self.hs = hs
|
|
|
|
self.auth = hs.get_auth()
|
2017-11-29 09:10:46 -05:00
|
|
|
self._set_password_handler = hs.get_set_password_handler()
|
2017-02-02 08:02:26 -05:00
|
|
|
|
|
|
|
@defer.inlineCallbacks
|
|
|
|
def on_POST(self, request, target_user_id):
|
|
|
|
"""Post request to allow an administrator reset password for a user.
|
2017-08-04 18:56:12 -04:00
|
|
|
This needs user to have administrator access in Synapse.
|
2017-02-02 08:02:26 -05:00
|
|
|
"""
|
|
|
|
requester = yield self.auth.get_user_by_req(request)
|
2019-05-02 05:45:52 -04:00
|
|
|
yield assert_user_is_admin(self.auth, requester.user)
|
2017-02-02 08:02:26 -05:00
|
|
|
|
2019-05-02 05:45:52 -04:00
|
|
|
UserID.from_string(target_user_id)
|
2017-02-02 08:02:26 -05:00
|
|
|
|
|
|
|
params = parse_json_object_from_request(request)
|
2018-07-13 15:53:01 -04:00
|
|
|
assert_params_in_dict(params, ["new_password"])
|
2017-02-02 08:02:26 -05:00
|
|
|
new_password = params['new_password']
|
|
|
|
|
2017-11-29 09:10:46 -05:00
|
|
|
yield self._set_password_handler.set_password(
|
2017-02-02 08:02:26 -05:00
|
|
|
target_user_id, new_password, requester
|
|
|
|
)
|
|
|
|
defer.returnValue((200, {}))
|
|
|
|
|
|
|
|
|
2019-05-01 05:40:33 -04:00
|
|
|
class GetUsersPaginatedRestServlet(RestServlet):
|
2017-02-02 08:02:26 -05:00
|
|
|
"""Get request to get specific number of users from Synapse.
|
2017-08-04 18:56:12 -04:00
|
|
|
This needs user to have administrator access in Synapse.
|
2017-02-02 08:02:26 -05:00
|
|
|
Example:
|
2019-05-01 12:49:11 -04:00
|
|
|
http://localhost:8008/_synapse/admin/v1/users_paginate/
|
2017-02-02 08:02:26 -05:00
|
|
|
@admin:user?access_token=admin_access_token&start=0&limit=10
|
|
|
|
Returns:
|
|
|
|
200 OK with json object {list[dict[str, Any]], count} or empty object.
|
|
|
|
"""
|
2019-05-01 10:18:58 -04:00
|
|
|
PATTERNS = historical_admin_path_patterns("/users_paginate/(?P<target_user_id>[^/]*)")
|
2017-02-02 08:02:26 -05:00
|
|
|
|
|
|
|
def __init__(self, hs):
|
|
|
|
self.store = hs.get_datastore()
|
|
|
|
self.hs = hs
|
|
|
|
self.auth = hs.get_auth()
|
|
|
|
self.handlers = hs.get_handlers()
|
|
|
|
|
|
|
|
@defer.inlineCallbacks
|
|
|
|
def on_GET(self, request, target_user_id):
|
|
|
|
"""Get request to get specific number of users from Synapse.
|
2017-08-04 18:56:12 -04:00
|
|
|
This needs user to have administrator access in Synapse.
|
2017-02-02 08:02:26 -05:00
|
|
|
"""
|
2019-05-02 05:45:52 -04:00
|
|
|
yield assert_requester_is_admin(self.auth, request)
|
2017-02-02 08:02:26 -05:00
|
|
|
|
2019-05-02 05:45:52 -04:00
|
|
|
target_user = UserID.from_string(target_user_id)
|
2017-02-02 08:02:26 -05:00
|
|
|
|
|
|
|
if not self.hs.is_mine(target_user):
|
|
|
|
raise SynapseError(400, "Can only users a local user")
|
|
|
|
|
|
|
|
order = "name" # order by name in user table
|
2018-07-13 15:40:14 -04:00
|
|
|
start = parse_integer(request, "start", required=True)
|
|
|
|
limit = parse_integer(request, "limit", required=True)
|
|
|
|
|
2017-02-02 08:02:26 -05:00
|
|
|
logger.info("limit: %s, start: %s", limit, start)
|
|
|
|
|
|
|
|
ret = yield self.handlers.admin_handler.get_users_paginate(
|
|
|
|
order, start, limit
|
|
|
|
)
|
|
|
|
defer.returnValue((200, ret))
|
|
|
|
|
|
|
|
@defer.inlineCallbacks
|
|
|
|
def on_POST(self, request, target_user_id):
|
|
|
|
"""Post request to get specific number of users from Synapse..
|
2017-08-04 18:56:12 -04:00
|
|
|
This needs user to have administrator access in Synapse.
|
2017-02-02 08:02:26 -05:00
|
|
|
Example:
|
2019-05-01 12:49:11 -04:00
|
|
|
http://localhost:8008/_synapse/admin/v1/users_paginate/
|
2017-02-02 08:02:26 -05:00
|
|
|
@admin:user?access_token=admin_access_token
|
|
|
|
JsonBodyToSend:
|
|
|
|
{
|
|
|
|
"start": "0",
|
|
|
|
"limit": "10
|
|
|
|
}
|
|
|
|
Returns:
|
|
|
|
200 OK with json object {list[dict[str, Any]], count} or empty object.
|
|
|
|
"""
|
2019-05-02 05:45:52 -04:00
|
|
|
yield assert_requester_is_admin(self.auth, request)
|
2017-02-02 08:02:26 -05:00
|
|
|
UserID.from_string(target_user_id)
|
|
|
|
|
|
|
|
order = "name" # order by name in user table
|
|
|
|
params = parse_json_object_from_request(request)
|
2018-07-13 15:53:01 -04:00
|
|
|
assert_params_in_dict(params, ["limit", "start"])
|
2017-02-02 08:02:26 -05:00
|
|
|
limit = params['limit']
|
|
|
|
start = params['start']
|
|
|
|
logger.info("limit: %s, start: %s", limit, start)
|
|
|
|
|
|
|
|
ret = yield self.handlers.admin_handler.get_users_paginate(
|
|
|
|
order, start, limit
|
|
|
|
)
|
|
|
|
defer.returnValue((200, ret))
|
|
|
|
|
|
|
|
|
2019-05-01 05:40:33 -04:00
|
|
|
class SearchUsersRestServlet(RestServlet):
|
2017-02-02 08:02:26 -05:00
|
|
|
"""Get request to search user table for specific users according to
|
|
|
|
search term.
|
2017-08-04 18:56:12 -04:00
|
|
|
This needs user to have administrator access in Synapse.
|
2017-02-02 08:02:26 -05:00
|
|
|
Example:
|
2019-05-01 12:49:11 -04:00
|
|
|
http://localhost:8008/_synapse/admin/v1/search_users/
|
2017-02-02 08:02:26 -05:00
|
|
|
@admin:user?access_token=admin_access_token&term=alice
|
|
|
|
Returns:
|
|
|
|
200 OK with json object {list[dict[str, Any]], count} or empty object.
|
|
|
|
"""
|
2019-05-01 10:18:58 -04:00
|
|
|
PATTERNS = historical_admin_path_patterns("/search_users/(?P<target_user_id>[^/]*)")
|
2017-02-02 08:02:26 -05:00
|
|
|
|
|
|
|
def __init__(self, hs):
|
|
|
|
self.store = hs.get_datastore()
|
|
|
|
self.hs = hs
|
|
|
|
self.auth = hs.get_auth()
|
|
|
|
self.handlers = hs.get_handlers()
|
|
|
|
|
|
|
|
@defer.inlineCallbacks
|
|
|
|
def on_GET(self, request, target_user_id):
|
|
|
|
"""Get request to search user table for specific users according to
|
|
|
|
search term.
|
2017-08-04 18:56:12 -04:00
|
|
|
This needs user to have a administrator access in Synapse.
|
2017-02-02 08:02:26 -05:00
|
|
|
"""
|
2019-05-02 05:45:52 -04:00
|
|
|
yield assert_requester_is_admin(self.auth, request)
|
2017-02-02 08:02:26 -05:00
|
|
|
|
2019-05-02 05:45:52 -04:00
|
|
|
target_user = UserID.from_string(target_user_id)
|
2017-02-02 08:02:26 -05:00
|
|
|
|
|
|
|
# To allow all users to get the users list
|
|
|
|
# if not is_admin and target_user != auth_user:
|
|
|
|
# raise AuthError(403, "You are not a server admin")
|
|
|
|
|
|
|
|
if not self.hs.is_mine(target_user):
|
|
|
|
raise SynapseError(400, "Can only users a local user")
|
|
|
|
|
2018-07-13 15:40:14 -04:00
|
|
|
term = parse_string(request, "term", required=True)
|
2017-02-02 08:02:26 -05:00
|
|
|
logger.info("term: %s ", term)
|
|
|
|
|
|
|
|
ret = yield self.handlers.admin_handler.search_users(
|
|
|
|
term
|
|
|
|
)
|
|
|
|
defer.returnValue((200, ret))
|
|
|
|
|
|
|
|
|
2019-05-01 05:40:33 -04:00
|
|
|
class DeleteGroupAdminRestServlet(RestServlet):
|
2019-04-03 11:07:34 -04:00
|
|
|
"""Allows deleting of local groups
|
|
|
|
"""
|
2019-05-01 10:18:58 -04:00
|
|
|
PATTERNS = historical_admin_path_patterns("/delete_group/(?P<group_id>[^/]*)")
|
2019-04-03 11:07:34 -04:00
|
|
|
|
|
|
|
def __init__(self, hs):
|
|
|
|
self.group_server = hs.get_groups_server_handler()
|
|
|
|
self.is_mine_id = hs.is_mine_id
|
2019-05-01 05:40:33 -04:00
|
|
|
self.auth = hs.get_auth()
|
2019-04-03 11:07:34 -04:00
|
|
|
|
|
|
|
@defer.inlineCallbacks
|
|
|
|
def on_POST(self, request, group_id):
|
|
|
|
requester = yield self.auth.get_user_by_req(request)
|
2019-05-02 05:45:52 -04:00
|
|
|
yield assert_user_is_admin(self.auth, requester.user)
|
2019-04-03 11:07:34 -04:00
|
|
|
|
|
|
|
if not self.is_mine_id(group_id):
|
|
|
|
raise SynapseError(400, "Can only delete local groups")
|
|
|
|
|
|
|
|
yield self.group_server.delete_group(group_id, requester.user.to_string())
|
|
|
|
defer.returnValue((200, {}))
|
|
|
|
|
|
|
|
|
2019-05-01 05:40:33 -04:00
|
|
|
class AccountValidityRenewServlet(RestServlet):
|
2019-05-01 10:18:58 -04:00
|
|
|
PATTERNS = historical_admin_path_patterns("/account_validity/validity$")
|
2019-04-16 15:13:59 -04:00
|
|
|
|
|
|
|
def __init__(self, hs):
|
|
|
|
"""
|
|
|
|
Args:
|
|
|
|
hs (synapse.server.HomeServer): server
|
|
|
|
"""
|
|
|
|
self.hs = hs
|
|
|
|
self.account_activity_handler = hs.get_account_validity_handler()
|
|
|
|
self.auth = hs.get_auth()
|
|
|
|
|
|
|
|
@defer.inlineCallbacks
|
|
|
|
def on_POST(self, request):
|
2019-05-02 05:45:52 -04:00
|
|
|
yield assert_requester_is_admin(self.auth, request)
|
2019-04-16 15:13:59 -04:00
|
|
|
|
|
|
|
body = parse_json_object_from_request(request)
|
|
|
|
|
|
|
|
if "user_id" not in body:
|
|
|
|
raise SynapseError(400, "Missing property 'user_id' in the request body")
|
|
|
|
|
|
|
|
expiration_ts = yield self.account_activity_handler.renew_account_for_user(
|
|
|
|
body["user_id"], body.get("expiration_ts"),
|
|
|
|
not body.get("enable_renewal_emails", True),
|
|
|
|
)
|
|
|
|
|
|
|
|
res = {
|
|
|
|
"expiration_ts": expiration_ts,
|
|
|
|
}
|
|
|
|
defer.returnValue((200, res))
|
|
|
|
|
|
|
|
|
2019-05-01 10:18:58 -04:00
|
|
|
class AdminRestResource(JsonResource):
|
|
|
|
"""The REST resource which gets mounted at /_synapse/admin"""
|
|
|
|
|
|
|
|
def __init__(self, hs):
|
|
|
|
JsonResource.__init__(self, hs, canonical_json=False)
|
|
|
|
register_servlets(hs, self)
|
|
|
|
|
|
|
|
|
2014-09-29 09:59:52 -04:00
|
|
|
def register_servlets(hs, http_server):
|
|
|
|
WhoisRestServlet(hs).register(http_server)
|
2016-06-29 09:57:59 -04:00
|
|
|
PurgeMediaCacheRestServlet(hs).register(http_server)
|
2018-03-08 06:47:28 -05:00
|
|
|
PurgeHistoryStatusRestServlet(hs).register(http_server)
|
2016-06-30 10:40:58 -04:00
|
|
|
DeactivateAccountRestServlet(hs).register(http_server)
|
2016-07-06 10:56:59 -04:00
|
|
|
PurgeHistoryRestServlet(hs).register(http_server)
|
2017-02-02 08:02:26 -05:00
|
|
|
UsersRestServlet(hs).register(http_server)
|
|
|
|
ResetPasswordRestServlet(hs).register(http_server)
|
|
|
|
GetUsersPaginatedRestServlet(hs).register(http_server)
|
|
|
|
SearchUsersRestServlet(hs).register(http_server)
|
2017-06-19 07:36:28 -04:00
|
|
|
ShutdownRoomRestServlet(hs).register(http_server)
|
2017-06-19 12:39:21 -04:00
|
|
|
QuarantineMediaInRoom(hs).register(http_server)
|
2018-01-21 00:25:23 -05:00
|
|
|
ListMediaInRoom(hs).register(http_server)
|
2018-07-20 08:41:13 -04:00
|
|
|
UserRegisterServlet(hs).register(http_server)
|
2019-02-28 22:05:47 -05:00
|
|
|
VersionServlet(hs).register(http_server)
|
2019-04-03 11:07:34 -04:00
|
|
|
DeleteGroupAdminRestServlet(hs).register(http_server)
|
2019-04-16 15:13:59 -04:00
|
|
|
AccountValidityRenewServlet(hs).register(http_server)
|