2019-08-27 05:14:00 -04:00
|
|
|
# -*- coding: utf-8 -*-
|
|
|
|
# Copyright 2019 The Matrix.org Foundation C.I.C.
|
|
|
|
#
|
|
|
|
# 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.
|
|
|
|
import re
|
|
|
|
|
|
|
|
from twisted.internet import defer
|
|
|
|
|
|
|
|
from synapse.api.errors import SynapseError
|
|
|
|
from synapse.http.servlet import (
|
|
|
|
RestServlet,
|
|
|
|
assert_params_in_dict,
|
|
|
|
parse_json_object_from_request,
|
|
|
|
)
|
2019-08-27 08:12:27 -04:00
|
|
|
from synapse.rest.admin import assert_requester_is_admin, assert_user_is_admin
|
2019-08-27 05:14:00 -04:00
|
|
|
from synapse.types import UserID
|
|
|
|
|
|
|
|
|
|
|
|
class UserAdminServlet(RestServlet):
|
|
|
|
"""
|
2019-08-27 08:12:27 -04:00
|
|
|
Get or set whether or not a user is a server administrator.
|
2019-08-27 05:14:00 -04:00
|
|
|
|
|
|
|
Note that only local users can be server administrators, and that an
|
|
|
|
administrator may not demote themselves.
|
|
|
|
|
|
|
|
Only server administrators can use this API.
|
|
|
|
|
2019-08-27 08:12:27 -04:00
|
|
|
Examples:
|
|
|
|
* Get
|
|
|
|
GET /_synapse/admin/v1/users/@nonadmin:example.com/admin
|
|
|
|
response on success:
|
|
|
|
{
|
|
|
|
"admin": false
|
|
|
|
}
|
|
|
|
* Set
|
|
|
|
PUT /_synapse/admin/v1/users/@reivilibre:librepush.net/admin
|
|
|
|
request body:
|
|
|
|
{
|
|
|
|
"admin": true
|
|
|
|
}
|
|
|
|
response on success:
|
|
|
|
{}
|
2019-08-27 05:14:00 -04:00
|
|
|
"""
|
|
|
|
|
|
|
|
PATTERNS = (re.compile("^/_synapse/admin/v1/users/(?P<user_id>@[^/]*)/admin$"),)
|
|
|
|
|
|
|
|
def __init__(self, hs):
|
|
|
|
self.hs = hs
|
|
|
|
self.auth = hs.get_auth()
|
|
|
|
self.handlers = hs.get_handlers()
|
|
|
|
|
|
|
|
@defer.inlineCallbacks
|
2019-08-27 08:12:27 -04:00
|
|
|
def on_GET(self, request, user_id):
|
2019-08-27 05:14:00 -04:00
|
|
|
yield assert_requester_is_admin(self.auth, request)
|
2019-08-27 08:12:27 -04:00
|
|
|
|
|
|
|
target_user = UserID.from_string(user_id)
|
|
|
|
|
|
|
|
if not self.hs.is_mine(target_user):
|
|
|
|
raise SynapseError(400, "Only local users can be admins of this homeserver")
|
|
|
|
|
|
|
|
is_admin = yield self.handlers.admin_handler.get_user_server_admin(target_user)
|
|
|
|
is_admin = bool(is_admin)
|
|
|
|
|
2019-08-30 11:28:26 -04:00
|
|
|
return 200, {"admin": is_admin}
|
2019-08-27 08:12:27 -04:00
|
|
|
|
|
|
|
@defer.inlineCallbacks
|
|
|
|
def on_PUT(self, request, user_id):
|
2019-08-27 05:14:00 -04:00
|
|
|
requester = yield self.auth.get_user_by_req(request)
|
2019-08-27 08:12:27 -04:00
|
|
|
yield assert_user_is_admin(self.auth, requester.user)
|
2019-08-27 05:14:00 -04:00
|
|
|
auth_user = requester.user
|
|
|
|
|
|
|
|
target_user = UserID.from_string(user_id)
|
|
|
|
|
|
|
|
body = parse_json_object_from_request(request)
|
|
|
|
|
|
|
|
assert_params_in_dict(body, ["admin"])
|
|
|
|
|
|
|
|
if not self.hs.is_mine(target_user):
|
|
|
|
raise SynapseError(400, "Only local users can be admins of this homeserver")
|
|
|
|
|
|
|
|
set_admin_to = bool(body["admin"])
|
|
|
|
|
|
|
|
if target_user == auth_user and not set_admin_to:
|
|
|
|
raise SynapseError(400, "You may not demote yourself.")
|
|
|
|
|
|
|
|
yield self.handlers.admin_handler.set_user_server_admin(
|
|
|
|
target_user, set_admin_to
|
|
|
|
)
|
|
|
|
|
2019-08-30 11:28:26 -04:00
|
|
|
return 200, {}
|