diff --git a/changelog.d/3687.feature b/changelog.d/3687.feature
new file mode 100644
index 0000000000..93b24d1acb
--- /dev/null
+++ b/changelog.d/3687.feature
@@ -0,0 +1 @@
+set admin email via config, to be used in error messages where the user should contact the administrator
diff --git a/synapse/api/auth.py b/synapse/api/auth.py
index c31c6a6a08..a9cc322d7e 100644
--- a/synapse/api/auth.py
+++ b/synapse/api/auth.py
@@ -784,7 +784,9 @@ class Auth(object):
"""
if self.hs.config.hs_disabled:
raise AuthError(
- 403, self.hs.config.hs_disabled_message, errcode=Codes.HS_DISABLED
+ 403, self.hs.config.hs_disabled_message,
+ errcode=Codes.HS_DISABLED,
+ admin_email=self.hs.config.admin_email,
)
if self.hs.config.limit_usage_by_mau is True:
# If the user is already part of the MAU cohort
@@ -796,5 +798,7 @@ class Auth(object):
current_mau = yield self.store.get_monthly_active_count()
if current_mau >= self.hs.config.max_mau_value:
raise AuthError(
- 403, "MAU Limit Exceeded", errcode=Codes.MAU_LIMIT_EXCEEDED
+ 403, "MAU Limit Exceeded",
+ admin_email=self.hs.config.admin_email,
+ errcode=Codes.MAU_LIMIT_EXCEEDED
)
diff --git a/synapse/api/errors.py b/synapse/api/errors.py
index dc3bed5fcb..d74848159e 100644
--- a/synapse/api/errors.py
+++ b/synapse/api/errors.py
@@ -225,11 +225,20 @@ class NotFoundError(SynapseError):
class AuthError(SynapseError):
"""An error raised when there was a problem authorising an event."""
-
def __init__(self, *args, **kwargs):
if "errcode" not in kwargs:
kwargs["errcode"] = Codes.FORBIDDEN
- super(AuthError, self).__init__(*args, **kwargs)
+ self.admin_email = kwargs.get('admin_email')
+ self.msg = kwargs.get('msg')
+ self.errcode = kwargs.get('errcode')
+ super(AuthError, self).__init__(*args, errcode=kwargs["errcode"])
+
+ def error_dict(self):
+ return cs_error(
+ self.msg,
+ self.errcode,
+ admin_email=self.admin_email,
+ )
class EventSizeError(SynapseError):
diff --git a/synapse/config/server.py b/synapse/config/server.py
index 3b078d72ca..64a5121a45 100644
--- a/synapse/config/server.py
+++ b/synapse/config/server.py
@@ -82,6 +82,10 @@ class ServerConfig(Config):
self.hs_disabled = config.get("hs_disabled", False)
self.hs_disabled_message = config.get("hs_disabled_message", "")
+ # Admin email to direct users at should their instance become blocked
+ # due to resource constraints
+ self.admin_email = config.get("admin_email", None)
+
# FIXME: federation_domain_whitelist needs sytests
self.federation_domain_whitelist = None
federation_domain_whitelist = config.get(
diff --git a/synapse/handlers/register.py b/synapse/handlers/register.py
index 3526b20d5a..ef7222d7b8 100644
--- a/synapse/handlers/register.py
+++ b/synapse/handlers/register.py
@@ -144,7 +144,8 @@ class RegistrationHandler(BaseHandler):
Raises:
RegistrationError if there was a problem registering.
"""
- yield self._check_mau_limits()
+
+ yield self.auth.check_auth_blocking()
password_hash = None
if password:
password_hash = yield self.auth_handler().hash(password)
@@ -289,7 +290,7 @@ class RegistrationHandler(BaseHandler):
400,
"User ID can only contain characters a-z, 0-9, or '=_-./'",
)
- yield self._check_mau_limits()
+ yield self.auth.check_auth_blocking()
user = UserID(localpart, self.hs.hostname)
user_id = user.to_string()
@@ -439,7 +440,7 @@ class RegistrationHandler(BaseHandler):
"""
if localpart is None:
raise SynapseError(400, "Request must include user id")
- yield self._check_mau_limits()
+ yield self.auth.check_auth_blocking()
need_register = True
try:
@@ -534,13 +535,13 @@ class RegistrationHandler(BaseHandler):
action="join",
)
- @defer.inlineCallbacks
- def _check_mau_limits(self):
- """
- Do not accept registrations if monthly active user limits exceeded
- and limiting is enabled
- """
- try:
- yield self.auth.check_auth_blocking()
- except AuthError as e:
- raise RegistrationError(e.code, str(e), e.errcode)
+ # @defer.inlineCallbacks
+ # def _s(self):
+ # """
+ # Do not accept registrations if monthly active user limits exceeded
+ # and limiting is enabled
+ # """
+ # try:
+ # yield self.auth.check_auth_blocking()
+ # except AuthError as e:
+ # raise RegistrationError(e.code, str(e), e.errcode)
diff --git a/tests/api/test_auth.py b/tests/api/test_auth.py
index a65689ba89..e8a1894e65 100644
--- a/tests/api/test_auth.py
+++ b/tests/api/test_auth.py
@@ -455,8 +455,11 @@ class AuthTestCase(unittest.TestCase):
return_value=defer.succeed(lots_of_users)
)
- with self.assertRaises(AuthError):
+ with self.assertRaises(AuthError) as e:
yield self.auth.check_auth_blocking()
+ self.assertEquals(e.exception.admin_email, self.hs.config.admin_email)
+ self.assertEquals(e.exception.errcode, Codes.MAU_LIMIT_EXCEEDED)
+ self.assertEquals(e.exception.code, 403)
# Ensure does not throw an error
self.store.get_monthly_active_count = Mock(
@@ -470,5 +473,6 @@ class AuthTestCase(unittest.TestCase):
self.hs.config.hs_disabled_message = "Reason for being disabled"
with self.assertRaises(AuthError) as e:
yield self.auth.check_auth_blocking()
+ self.assertEquals(e.exception.admin_email, self.hs.config.admin_email)
self.assertEquals(e.exception.errcode, Codes.HS_DISABLED)
self.assertEquals(e.exception.code, 403)
diff --git a/tests/handlers/test_register.py b/tests/handlers/test_register.py
index d48d40c8dd..35d1bcab3e 100644
--- a/tests/handlers/test_register.py
+++ b/tests/handlers/test_register.py
@@ -17,7 +17,7 @@ from mock import Mock
from twisted.internet import defer
-from synapse.api.errors import RegistrationError
+from synapse.api.errors import AuthError
from synapse.handlers.register import RegistrationHandler
from synapse.types import UserID, create_requester
@@ -109,7 +109,7 @@ class RegistrationTestCase(unittest.TestCase):
self.store.get_monthly_active_count = Mock(
return_value=defer.succeed(self.lots_of_users)
)
- with self.assertRaises(RegistrationError):
+ with self.assertRaises(AuthError):
yield self.handler.get_or_create_user("requester", 'b', "display_name")
@defer.inlineCallbacks
@@ -118,7 +118,7 @@ class RegistrationTestCase(unittest.TestCase):
self.store.get_monthly_active_count = Mock(
return_value=defer.succeed(self.lots_of_users)
)
- with self.assertRaises(RegistrationError):
+ with self.assertRaises(AuthError):
yield self.handler.register(localpart="local_part")
@defer.inlineCallbacks
@@ -127,5 +127,5 @@ class RegistrationTestCase(unittest.TestCase):
self.store.get_monthly_active_count = Mock(
return_value=defer.succeed(self.lots_of_users)
)
- with self.assertRaises(RegistrationError):
+ with self.assertRaises(AuthError):
yield self.handler.register_saml2(localpart="local_part")
diff --git a/tests/utils.py b/tests/utils.py
index 90378326f8..4af81624eb 100644
--- a/tests/utils.py
+++ b/tests/utils.py
@@ -139,6 +139,7 @@ def setup_test_homeserver(
config.hs_disabled_message = ""
config.max_mau_value = 50
config.mau_limits_reserved_threepids = []
+ config.admin_email = None
# we need a sane default_room_version, otherwise attempts to create rooms will
# fail.
|
