Merge branch 'release-v1.13.0' into matrix-org-hotfixes
commit
ae4f6140f1
|
@ -0,0 +1 @@
|
||||||
|
Prevent methods in `synapse.handlers.auth` from polling the homeserver config every request.
|
|
@ -0,0 +1 @@
|
||||||
|
Add a configuration setting to tweak the threshold for dummy events.
|
|
@ -0,0 +1 @@
|
||||||
|
Clean up some LoggingContext code.
|
|
@ -0,0 +1 @@
|
||||||
|
Add support for running replication over Redis when using workers.
|
|
@ -0,0 +1 @@
|
||||||
|
Run group attestation renewal in series rather than parallel for performance.
|
|
@ -253,6 +253,18 @@ listeners:
|
||||||
# bind_addresses: ['::1', '127.0.0.1']
|
# bind_addresses: ['::1', '127.0.0.1']
|
||||||
# type: manhole
|
# type: manhole
|
||||||
|
|
||||||
|
# Forward extremities can build up in a room due to networking delays between
|
||||||
|
# homeservers. Once this happens in a large room, calculation of the state of
|
||||||
|
# that room can become quite expensive. To mitigate this, once the number of
|
||||||
|
# forward extremities reaches a given threshold, Synapse will send an
|
||||||
|
# org.matrix.dummy_event event, which will reduce the forward extremities
|
||||||
|
# in the room.
|
||||||
|
#
|
||||||
|
# This setting defines the threshold (i.e. number of forward extremities in the
|
||||||
|
# room) at which dummy events are sent. The default value is 10.
|
||||||
|
#
|
||||||
|
#dummy_events_threshold: 5
|
||||||
|
|
||||||
|
|
||||||
## Homeserver blocking ##
|
## Homeserver blocking ##
|
||||||
|
|
||||||
|
|
|
@ -26,16 +26,15 @@ from twisted.internet import defer
|
||||||
import synapse.logging.opentracing as opentracing
|
import synapse.logging.opentracing as opentracing
|
||||||
import synapse.types
|
import synapse.types
|
||||||
from synapse import event_auth
|
from synapse import event_auth
|
||||||
from synapse.api.constants import EventTypes, LimitBlockingTypes, Membership, UserTypes
|
from synapse.api.auth_blocking import AuthBlocking
|
||||||
|
from synapse.api.constants import EventTypes, Membership
|
||||||
from synapse.api.errors import (
|
from synapse.api.errors import (
|
||||||
AuthError,
|
AuthError,
|
||||||
Codes,
|
Codes,
|
||||||
InvalidClientTokenError,
|
InvalidClientTokenError,
|
||||||
MissingClientTokenError,
|
MissingClientTokenError,
|
||||||
ResourceLimitError,
|
|
||||||
)
|
)
|
||||||
from synapse.api.room_versions import KNOWN_ROOM_VERSIONS
|
from synapse.api.room_versions import KNOWN_ROOM_VERSIONS
|
||||||
from synapse.config.server import is_threepid_reserved
|
|
||||||
from synapse.events import EventBase
|
from synapse.events import EventBase
|
||||||
from synapse.types import StateMap, UserID
|
from synapse.types import StateMap, UserID
|
||||||
from synapse.util.caches import CACHE_SIZE_FACTOR, register_cache
|
from synapse.util.caches import CACHE_SIZE_FACTOR, register_cache
|
||||||
|
@ -77,7 +76,11 @@ class Auth(object):
|
||||||
self.token_cache = LruCache(CACHE_SIZE_FACTOR * 10000)
|
self.token_cache = LruCache(CACHE_SIZE_FACTOR * 10000)
|
||||||
register_cache("cache", "token_cache", self.token_cache)
|
register_cache("cache", "token_cache", self.token_cache)
|
||||||
|
|
||||||
|
self._auth_blocking = AuthBlocking(self.hs)
|
||||||
|
|
||||||
self._account_validity = hs.config.account_validity
|
self._account_validity = hs.config.account_validity
|
||||||
|
self._track_appservice_user_ips = hs.config.track_appservice_user_ips
|
||||||
|
self._macaroon_secret_key = hs.config.macaroon_secret_key
|
||||||
|
|
||||||
@defer.inlineCallbacks
|
@defer.inlineCallbacks
|
||||||
def check_from_context(self, room_version: str, event, context, do_sig_check=True):
|
def check_from_context(self, room_version: str, event, context, do_sig_check=True):
|
||||||
|
@ -191,7 +194,7 @@ class Auth(object):
|
||||||
opentracing.set_tag("authenticated_entity", user_id)
|
opentracing.set_tag("authenticated_entity", user_id)
|
||||||
opentracing.set_tag("appservice_id", app_service.id)
|
opentracing.set_tag("appservice_id", app_service.id)
|
||||||
|
|
||||||
if ip_addr and self.hs.config.track_appservice_user_ips:
|
if ip_addr and self._track_appservice_user_ips:
|
||||||
yield self.store.insert_client_ip(
|
yield self.store.insert_client_ip(
|
||||||
user_id=user_id,
|
user_id=user_id,
|
||||||
access_token=access_token,
|
access_token=access_token,
|
||||||
|
@ -454,7 +457,7 @@ class Auth(object):
|
||||||
# access_tokens include a nonce for uniqueness: any value is acceptable
|
# access_tokens include a nonce for uniqueness: any value is acceptable
|
||||||
v.satisfy_general(lambda c: c.startswith("nonce = "))
|
v.satisfy_general(lambda c: c.startswith("nonce = "))
|
||||||
|
|
||||||
v.verify(macaroon, self.hs.config.macaroon_secret_key)
|
v.verify(macaroon, self._macaroon_secret_key)
|
||||||
|
|
||||||
def _verify_expiry(self, caveat):
|
def _verify_expiry(self, caveat):
|
||||||
prefix = "time < "
|
prefix = "time < "
|
||||||
|
@ -663,71 +666,5 @@ class Auth(object):
|
||||||
% (user_id, room_id),
|
% (user_id, room_id),
|
||||||
)
|
)
|
||||||
|
|
||||||
@defer.inlineCallbacks
|
def check_auth_blocking(self, *args, **kwargs):
|
||||||
def check_auth_blocking(self, user_id=None, threepid=None, user_type=None):
|
return self._auth_blocking.check_auth_blocking(*args, **kwargs)
|
||||||
"""Checks if the user should be rejected for some external reason,
|
|
||||||
such as monthly active user limiting or global disable flag
|
|
||||||
|
|
||||||
Args:
|
|
||||||
user_id(str|None): If present, checks for presence against existing
|
|
||||||
MAU cohort
|
|
||||||
|
|
||||||
threepid(dict|None): If present, checks for presence against configured
|
|
||||||
reserved threepid. Used in cases where the user is trying register
|
|
||||||
with a MAU blocked server, normally they would be rejected but their
|
|
||||||
threepid is on the reserved list. user_id and
|
|
||||||
threepid should never be set at the same time.
|
|
||||||
|
|
||||||
user_type(str|None): If present, is used to decide whether to check against
|
|
||||||
certain blocking reasons like MAU.
|
|
||||||
"""
|
|
||||||
|
|
||||||
# Never fail an auth check for the server notices users or support user
|
|
||||||
# This can be a problem where event creation is prohibited due to blocking
|
|
||||||
if user_id is not None:
|
|
||||||
if user_id == self.hs.config.server_notices_mxid:
|
|
||||||
return
|
|
||||||
if (yield self.store.is_support_user(user_id)):
|
|
||||||
return
|
|
||||||
|
|
||||||
if self.hs.config.hs_disabled:
|
|
||||||
raise ResourceLimitError(
|
|
||||||
403,
|
|
||||||
self.hs.config.hs_disabled_message,
|
|
||||||
errcode=Codes.RESOURCE_LIMIT_EXCEEDED,
|
|
||||||
admin_contact=self.hs.config.admin_contact,
|
|
||||||
limit_type=LimitBlockingTypes.HS_DISABLED,
|
|
||||||
)
|
|
||||||
if self.hs.config.limit_usage_by_mau is True:
|
|
||||||
assert not (user_id and threepid)
|
|
||||||
|
|
||||||
# If the user is already part of the MAU cohort or a trial user
|
|
||||||
if user_id:
|
|
||||||
timestamp = yield self.store.user_last_seen_monthly_active(user_id)
|
|
||||||
if timestamp:
|
|
||||||
return
|
|
||||||
|
|
||||||
is_trial = yield self.store.is_trial_user(user_id)
|
|
||||||
if is_trial:
|
|
||||||
return
|
|
||||||
elif threepid:
|
|
||||||
# If the user does not exist yet, but is signing up with a
|
|
||||||
# reserved threepid then pass auth check
|
|
||||||
if is_threepid_reserved(
|
|
||||||
self.hs.config.mau_limits_reserved_threepids, threepid
|
|
||||||
):
|
|
||||||
return
|
|
||||||
elif user_type == UserTypes.SUPPORT:
|
|
||||||
# If the user does not exist yet and is of type "support",
|
|
||||||
# allow registration. Support users are excluded from MAU checks.
|
|
||||||
return
|
|
||||||
# Else if there is no room in the MAU bucket, bail
|
|
||||||
current_mau = yield self.store.get_monthly_active_count()
|
|
||||||
if current_mau >= self.hs.config.max_mau_value:
|
|
||||||
raise ResourceLimitError(
|
|
||||||
403,
|
|
||||||
"Monthly Active User Limit Exceeded",
|
|
||||||
admin_contact=self.hs.config.admin_contact,
|
|
||||||
errcode=Codes.RESOURCE_LIMIT_EXCEEDED,
|
|
||||||
limit_type=LimitBlockingTypes.MONTHLY_ACTIVE_USER,
|
|
||||||
)
|
|
||||||
|
|
|
@ -0,0 +1,104 @@
|
||||||
|
# -*- coding: utf-8 -*-
|
||||||
|
# Copyright 2020 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 logging
|
||||||
|
|
||||||
|
from twisted.internet import defer
|
||||||
|
|
||||||
|
from synapse.api.constants import LimitBlockingTypes, UserTypes
|
||||||
|
from synapse.api.errors import Codes, ResourceLimitError
|
||||||
|
from synapse.config.server import is_threepid_reserved
|
||||||
|
|
||||||
|
logger = logging.getLogger(__name__)
|
||||||
|
|
||||||
|
|
||||||
|
class AuthBlocking(object):
|
||||||
|
def __init__(self, hs):
|
||||||
|
self.store = hs.get_datastore()
|
||||||
|
|
||||||
|
self._server_notices_mxid = hs.config.server_notices_mxid
|
||||||
|
self._hs_disabled = hs.config.hs_disabled
|
||||||
|
self._hs_disabled_message = hs.config.hs_disabled_message
|
||||||
|
self._admin_contact = hs.config.admin_contact
|
||||||
|
self._max_mau_value = hs.config.max_mau_value
|
||||||
|
self._limit_usage_by_mau = hs.config.limit_usage_by_mau
|
||||||
|
self._mau_limits_reserved_threepids = hs.config.mau_limits_reserved_threepids
|
||||||
|
|
||||||
|
@defer.inlineCallbacks
|
||||||
|
def check_auth_blocking(self, user_id=None, threepid=None, user_type=None):
|
||||||
|
"""Checks if the user should be rejected for some external reason,
|
||||||
|
such as monthly active user limiting or global disable flag
|
||||||
|
|
||||||
|
Args:
|
||||||
|
user_id(str|None): If present, checks for presence against existing
|
||||||
|
MAU cohort
|
||||||
|
|
||||||
|
threepid(dict|None): If present, checks for presence against configured
|
||||||
|
reserved threepid. Used in cases where the user is trying register
|
||||||
|
with a MAU blocked server, normally they would be rejected but their
|
||||||
|
threepid is on the reserved list. user_id and
|
||||||
|
threepid should never be set at the same time.
|
||||||
|
|
||||||
|
user_type(str|None): If present, is used to decide whether to check against
|
||||||
|
certain blocking reasons like MAU.
|
||||||
|
"""
|
||||||
|
|
||||||
|
# Never fail an auth check for the server notices users or support user
|
||||||
|
# This can be a problem where event creation is prohibited due to blocking
|
||||||
|
if user_id is not None:
|
||||||
|
if user_id == self._server_notices_mxid:
|
||||||
|
return
|
||||||
|
if (yield self.store.is_support_user(user_id)):
|
||||||
|
return
|
||||||
|
|
||||||
|
if self._hs_disabled:
|
||||||
|
raise ResourceLimitError(
|
||||||
|
403,
|
||||||
|
self._hs_disabled_message,
|
||||||
|
errcode=Codes.RESOURCE_LIMIT_EXCEEDED,
|
||||||
|
admin_contact=self._admin_contact,
|
||||||
|
limit_type=LimitBlockingTypes.HS_DISABLED,
|
||||||
|
)
|
||||||
|
if self._limit_usage_by_mau is True:
|
||||||
|
assert not (user_id and threepid)
|
||||||
|
|
||||||
|
# If the user is already part of the MAU cohort or a trial user
|
||||||
|
if user_id:
|
||||||
|
timestamp = yield self.store.user_last_seen_monthly_active(user_id)
|
||||||
|
if timestamp:
|
||||||
|
return
|
||||||
|
|
||||||
|
is_trial = yield self.store.is_trial_user(user_id)
|
||||||
|
if is_trial:
|
||||||
|
return
|
||||||
|
elif threepid:
|
||||||
|
# If the user does not exist yet, but is signing up with a
|
||||||
|
# reserved threepid then pass auth check
|
||||||
|
if is_threepid_reserved(self._mau_limits_reserved_threepids, threepid):
|
||||||
|
return
|
||||||
|
elif user_type == UserTypes.SUPPORT:
|
||||||
|
# If the user does not exist yet and is of type "support",
|
||||||
|
# allow registration. Support users are excluded from MAU checks.
|
||||||
|
return
|
||||||
|
# Else if there is no room in the MAU bucket, bail
|
||||||
|
current_mau = yield self.store.get_monthly_active_count()
|
||||||
|
if current_mau >= self._max_mau_value:
|
||||||
|
raise ResourceLimitError(
|
||||||
|
403,
|
||||||
|
"Monthly Active User Limit Exceeded",
|
||||||
|
admin_contact=self._admin_contact,
|
||||||
|
errcode=Codes.RESOURCE_LIMIT_EXCEEDED,
|
||||||
|
limit_type=LimitBlockingTypes.MONTHLY_ACTIVE_USER,
|
||||||
|
)
|
|
@ -505,6 +505,9 @@ class ServerConfig(Config):
|
||||||
"cleanup_extremities_with_dummy_events", True
|
"cleanup_extremities_with_dummy_events", True
|
||||||
)
|
)
|
||||||
|
|
||||||
|
# The number of forward extremities in a room needed to send a dummy event.
|
||||||
|
self.dummy_events_threshold = config.get("dummy_events_threshold", 10)
|
||||||
|
|
||||||
self.enable_ephemeral_messages = config.get("enable_ephemeral_messages", False)
|
self.enable_ephemeral_messages = config.get("enable_ephemeral_messages", False)
|
||||||
|
|
||||||
# Inhibits the /requestToken endpoints from returning an error that might leak
|
# Inhibits the /requestToken endpoints from returning an error that might leak
|
||||||
|
@ -823,6 +826,18 @@ class ServerConfig(Config):
|
||||||
# bind_addresses: ['::1', '127.0.0.1']
|
# bind_addresses: ['::1', '127.0.0.1']
|
||||||
# type: manhole
|
# type: manhole
|
||||||
|
|
||||||
|
# Forward extremities can build up in a room due to networking delays between
|
||||||
|
# homeservers. Once this happens in a large room, calculation of the state of
|
||||||
|
# that room can become quite expensive. To mitigate this, once the number of
|
||||||
|
# forward extremities reaches a given threshold, Synapse will send an
|
||||||
|
# org.matrix.dummy_event event, which will reduce the forward extremities
|
||||||
|
# in the room.
|
||||||
|
#
|
||||||
|
# This setting defines the threshold (i.e. number of forward extremities in the
|
||||||
|
# room) at which dummy events are sent. The default value is 10.
|
||||||
|
#
|
||||||
|
#dummy_events_threshold: 5
|
||||||
|
|
||||||
|
|
||||||
## Homeserver blocking ##
|
## Homeserver blocking ##
|
||||||
|
|
||||||
|
|
|
@ -46,7 +46,6 @@ from twisted.internet import defer
|
||||||
from synapse.api.errors import HttpResponseException, RequestSendFailed, SynapseError
|
from synapse.api.errors import HttpResponseException, RequestSendFailed, SynapseError
|
||||||
from synapse.metrics.background_process_metrics import run_as_background_process
|
from synapse.metrics.background_process_metrics import run_as_background_process
|
||||||
from synapse.types import get_domain_from_id
|
from synapse.types import get_domain_from_id
|
||||||
from synapse.util.async_helpers import yieldable_gather_results
|
|
||||||
|
|
||||||
logger = logging.getLogger(__name__)
|
logger = logging.getLogger(__name__)
|
||||||
|
|
||||||
|
@ -208,6 +207,5 @@ class GroupAttestionRenewer(object):
|
||||||
"Error renewing attestation of %r in %r", user_id, group_id
|
"Error renewing attestation of %r in %r", user_id, group_id
|
||||||
)
|
)
|
||||||
|
|
||||||
await yieldable_gather_results(
|
for row in rows:
|
||||||
_renew_attestation, ((row["group_id"], row["user_id"]) for row in rows)
|
await _renew_attestation((row["group_id"], row["user_id"]))
|
||||||
)
|
|
||||||
|
|
|
@ -419,6 +419,8 @@ class EventCreationHandler(object):
|
||||||
|
|
||||||
self._ephemeral_events_enabled = hs.config.enable_ephemeral_messages
|
self._ephemeral_events_enabled = hs.config.enable_ephemeral_messages
|
||||||
|
|
||||||
|
self._dummy_events_threshold = hs.config.dummy_events_threshold
|
||||||
|
|
||||||
@defer.inlineCallbacks
|
@defer.inlineCallbacks
|
||||||
def create_event(
|
def create_event(
|
||||||
self,
|
self,
|
||||||
|
@ -1085,7 +1087,7 @@ class EventCreationHandler(object):
|
||||||
"""
|
"""
|
||||||
self._expire_rooms_to_exclude_from_dummy_event_insertion()
|
self._expire_rooms_to_exclude_from_dummy_event_insertion()
|
||||||
room_ids = await self.store.get_rooms_with_many_extremities(
|
room_ids = await self.store.get_rooms_with_many_extremities(
|
||||||
min_count=10,
|
min_count=self._dummy_events_threshold,
|
||||||
limit=5,
|
limit=5,
|
||||||
room_id_filter=self._rooms_to_exclude_from_dummy_event_insertion.keys(),
|
room_id_filter=self._rooms_to_exclude_from_dummy_event_insertion.keys(),
|
||||||
)
|
)
|
||||||
|
|
|
@ -431,15 +431,7 @@ class LoggingContext(object):
|
||||||
return
|
return
|
||||||
|
|
||||||
utime_delta, stime_delta = self._get_cputime(rusage)
|
utime_delta, stime_delta = self._get_cputime(rusage)
|
||||||
self._resource_usage.ru_utime += utime_delta
|
self.add_cputime(utime_delta, stime_delta)
|
||||||
self._resource_usage.ru_stime += stime_delta
|
|
||||||
|
|
||||||
# if we have a parent, pass our CPU usage stats on
|
|
||||||
if self.parent_context:
|
|
||||||
self.parent_context._resource_usage += self._resource_usage
|
|
||||||
|
|
||||||
# reset them in case we get entered again
|
|
||||||
self._resource_usage.reset()
|
|
||||||
finally:
|
finally:
|
||||||
self.usage_start = None
|
self.usage_start = None
|
||||||
|
|
||||||
|
@ -497,30 +489,52 @@ class LoggingContext(object):
|
||||||
|
|
||||||
return utime_delta, stime_delta
|
return utime_delta, stime_delta
|
||||||
|
|
||||||
|
def add_cputime(self, utime_delta: float, stime_delta: float) -> None:
|
||||||
|
"""Update the CPU time usage of this context (and any parents, recursively).
|
||||||
|
|
||||||
|
Args:
|
||||||
|
utime_delta: additional user time, in seconds, spent in this context.
|
||||||
|
stime_delta: additional system time, in seconds, spent in this context.
|
||||||
|
"""
|
||||||
|
self._resource_usage.ru_utime += utime_delta
|
||||||
|
self._resource_usage.ru_stime += stime_delta
|
||||||
|
if self.parent_context:
|
||||||
|
self.parent_context.add_cputime(utime_delta, stime_delta)
|
||||||
|
|
||||||
def add_database_transaction(self, duration_sec: float) -> None:
|
def add_database_transaction(self, duration_sec: float) -> None:
|
||||||
|
"""Record the use of a database transaction and the length of time it took.
|
||||||
|
|
||||||
|
Args:
|
||||||
|
duration_sec: The number of seconds the database transaction took.
|
||||||
|
"""
|
||||||
if duration_sec < 0:
|
if duration_sec < 0:
|
||||||
raise ValueError("DB txn time can only be non-negative")
|
raise ValueError("DB txn time can only be non-negative")
|
||||||
self._resource_usage.db_txn_count += 1
|
self._resource_usage.db_txn_count += 1
|
||||||
self._resource_usage.db_txn_duration_sec += duration_sec
|
self._resource_usage.db_txn_duration_sec += duration_sec
|
||||||
|
if self.parent_context:
|
||||||
|
self.parent_context.add_database_transaction(duration_sec)
|
||||||
|
|
||||||
def add_database_scheduled(self, sched_sec: float) -> None:
|
def add_database_scheduled(self, sched_sec: float) -> None:
|
||||||
"""Record a use of the database pool
|
"""Record a use of the database pool
|
||||||
|
|
||||||
Args:
|
Args:
|
||||||
sched_sec (float): number of seconds it took us to get a
|
sched_sec: number of seconds it took us to get a connection
|
||||||
connection
|
|
||||||
"""
|
"""
|
||||||
if sched_sec < 0:
|
if sched_sec < 0:
|
||||||
raise ValueError("DB scheduling time can only be non-negative")
|
raise ValueError("DB scheduling time can only be non-negative")
|
||||||
self._resource_usage.db_sched_duration_sec += sched_sec
|
self._resource_usage.db_sched_duration_sec += sched_sec
|
||||||
|
if self.parent_context:
|
||||||
|
self.parent_context.add_database_scheduled(sched_sec)
|
||||||
|
|
||||||
def record_event_fetch(self, event_count: int) -> None:
|
def record_event_fetch(self, event_count: int) -> None:
|
||||||
"""Record a number of events being fetched from the db
|
"""Record a number of events being fetched from the db
|
||||||
|
|
||||||
Args:
|
Args:
|
||||||
event_count (int): number of events being fetched
|
event_count: number of events being fetched
|
||||||
"""
|
"""
|
||||||
self._resource_usage.evt_db_fetch_count += event_count
|
self._resource_usage.evt_db_fetch_count += event_count
|
||||||
|
if self.parent_context:
|
||||||
|
self.parent_context.record_event_fetch(event_count)
|
||||||
|
|
||||||
|
|
||||||
class LoggingContextFilter(logging.Filter):
|
class LoggingContextFilter(logging.Filter):
|
||||||
|
|
|
@ -98,7 +98,9 @@ CONDITIONAL_REQUIREMENTS = {
|
||||||
"sentry": ["sentry-sdk>=0.7.2"],
|
"sentry": ["sentry-sdk>=0.7.2"],
|
||||||
"opentracing": ["jaeger-client>=4.0.0", "opentracing>=2.2.0"],
|
"opentracing": ["jaeger-client>=4.0.0", "opentracing>=2.2.0"],
|
||||||
"jwt": ["pyjwt>=1.6.4"],
|
"jwt": ["pyjwt>=1.6.4"],
|
||||||
"redis": ["txredisapi>=1.4.7"],
|
# hiredis is not a *strict* dependency, but it makes things much faster.
|
||||||
|
# (if it is not installed, we fall back to slow code.)
|
||||||
|
"redis": ["txredisapi>=1.4.7", "hiredis"],
|
||||||
}
|
}
|
||||||
|
|
||||||
ALL_OPTIONAL_REQUIREMENTS = set() # type: Set[str]
|
ALL_OPTIONAL_REQUIREMENTS = set() # type: Set[str]
|
||||||
|
|
|
@ -52,6 +52,10 @@ class AuthTestCase(unittest.TestCase):
|
||||||
self.hs.handlers = TestHandlers(self.hs)
|
self.hs.handlers = TestHandlers(self.hs)
|
||||||
self.auth = Auth(self.hs)
|
self.auth = Auth(self.hs)
|
||||||
|
|
||||||
|
# AuthBlocking reads from the hs' config on initialization. We need to
|
||||||
|
# modify its config instead of the hs'
|
||||||
|
self.auth_blocking = self.auth._auth_blocking
|
||||||
|
|
||||||
self.test_user = "@foo:bar"
|
self.test_user = "@foo:bar"
|
||||||
self.test_token = b"_test_token_"
|
self.test_token = b"_test_token_"
|
||||||
|
|
||||||
|
@ -321,15 +325,15 @@ class AuthTestCase(unittest.TestCase):
|
||||||
|
|
||||||
@defer.inlineCallbacks
|
@defer.inlineCallbacks
|
||||||
def test_blocking_mau(self):
|
def test_blocking_mau(self):
|
||||||
self.hs.config.limit_usage_by_mau = False
|
self.auth_blocking._limit_usage_by_mau = False
|
||||||
self.hs.config.max_mau_value = 50
|
self.auth_blocking._max_mau_value = 50
|
||||||
lots_of_users = 100
|
lots_of_users = 100
|
||||||
small_number_of_users = 1
|
small_number_of_users = 1
|
||||||
|
|
||||||
# Ensure no error thrown
|
# Ensure no error thrown
|
||||||
yield defer.ensureDeferred(self.auth.check_auth_blocking())
|
yield defer.ensureDeferred(self.auth.check_auth_blocking())
|
||||||
|
|
||||||
self.hs.config.limit_usage_by_mau = True
|
self.auth_blocking._limit_usage_by_mau = True
|
||||||
|
|
||||||
self.store.get_monthly_active_count = Mock(
|
self.store.get_monthly_active_count = Mock(
|
||||||
return_value=defer.succeed(lots_of_users)
|
return_value=defer.succeed(lots_of_users)
|
||||||
|
@ -349,8 +353,8 @@ class AuthTestCase(unittest.TestCase):
|
||||||
|
|
||||||
@defer.inlineCallbacks
|
@defer.inlineCallbacks
|
||||||
def test_blocking_mau__depending_on_user_type(self):
|
def test_blocking_mau__depending_on_user_type(self):
|
||||||
self.hs.config.max_mau_value = 50
|
self.auth_blocking._max_mau_value = 50
|
||||||
self.hs.config.limit_usage_by_mau = True
|
self.auth_blocking._limit_usage_by_mau = True
|
||||||
|
|
||||||
self.store.get_monthly_active_count = Mock(return_value=defer.succeed(100))
|
self.store.get_monthly_active_count = Mock(return_value=defer.succeed(100))
|
||||||
# Support users allowed
|
# Support users allowed
|
||||||
|
@ -370,12 +374,12 @@ class AuthTestCase(unittest.TestCase):
|
||||||
|
|
||||||
@defer.inlineCallbacks
|
@defer.inlineCallbacks
|
||||||
def test_reserved_threepid(self):
|
def test_reserved_threepid(self):
|
||||||
self.hs.config.limit_usage_by_mau = True
|
self.auth_blocking._limit_usage_by_mau = True
|
||||||
self.hs.config.max_mau_value = 1
|
self.auth_blocking._max_mau_value = 1
|
||||||
self.store.get_monthly_active_count = lambda: defer.succeed(2)
|
self.store.get_monthly_active_count = lambda: defer.succeed(2)
|
||||||
threepid = {"medium": "email", "address": "reserved@server.com"}
|
threepid = {"medium": "email", "address": "reserved@server.com"}
|
||||||
unknown_threepid = {"medium": "email", "address": "unreserved@server.com"}
|
unknown_threepid = {"medium": "email", "address": "unreserved@server.com"}
|
||||||
self.hs.config.mau_limits_reserved_threepids = [threepid]
|
self.auth_blocking._mau_limits_reserved_threepids = [threepid]
|
||||||
|
|
||||||
with self.assertRaises(ResourceLimitError):
|
with self.assertRaises(ResourceLimitError):
|
||||||
yield defer.ensureDeferred(self.auth.check_auth_blocking())
|
yield defer.ensureDeferred(self.auth.check_auth_blocking())
|
||||||
|
@ -389,8 +393,8 @@ class AuthTestCase(unittest.TestCase):
|
||||||
|
|
||||||
@defer.inlineCallbacks
|
@defer.inlineCallbacks
|
||||||
def test_hs_disabled(self):
|
def test_hs_disabled(self):
|
||||||
self.hs.config.hs_disabled = True
|
self.auth_blocking._hs_disabled = True
|
||||||
self.hs.config.hs_disabled_message = "Reason for being disabled"
|
self.auth_blocking._hs_disabled_message = "Reason for being disabled"
|
||||||
with self.assertRaises(ResourceLimitError) as e:
|
with self.assertRaises(ResourceLimitError) as e:
|
||||||
yield defer.ensureDeferred(self.auth.check_auth_blocking())
|
yield defer.ensureDeferred(self.auth.check_auth_blocking())
|
||||||
self.assertEquals(e.exception.admin_contact, self.hs.config.admin_contact)
|
self.assertEquals(e.exception.admin_contact, self.hs.config.admin_contact)
|
||||||
|
@ -404,10 +408,10 @@ class AuthTestCase(unittest.TestCase):
|
||||||
"""
|
"""
|
||||||
# this should be the default, but we had a bug where the test was doing the wrong
|
# this should be the default, but we had a bug where the test was doing the wrong
|
||||||
# thing, so let's make it explicit
|
# thing, so let's make it explicit
|
||||||
self.hs.config.server_notices_mxid = None
|
self.auth_blocking._server_notices_mxid = None
|
||||||
|
|
||||||
self.hs.config.hs_disabled = True
|
self.auth_blocking._hs_disabled = True
|
||||||
self.hs.config.hs_disabled_message = "Reason for being disabled"
|
self.auth_blocking._hs_disabled_message = "Reason for being disabled"
|
||||||
with self.assertRaises(ResourceLimitError) as e:
|
with self.assertRaises(ResourceLimitError) as e:
|
||||||
yield defer.ensureDeferred(self.auth.check_auth_blocking())
|
yield defer.ensureDeferred(self.auth.check_auth_blocking())
|
||||||
self.assertEquals(e.exception.admin_contact, self.hs.config.admin_contact)
|
self.assertEquals(e.exception.admin_contact, self.hs.config.admin_contact)
|
||||||
|
@ -416,8 +420,8 @@ class AuthTestCase(unittest.TestCase):
|
||||||
|
|
||||||
@defer.inlineCallbacks
|
@defer.inlineCallbacks
|
||||||
def test_server_notices_mxid_special_cased(self):
|
def test_server_notices_mxid_special_cased(self):
|
||||||
self.hs.config.hs_disabled = True
|
self.auth_blocking._hs_disabled = True
|
||||||
user = "@user:server"
|
user = "@user:server"
|
||||||
self.hs.config.server_notices_mxid = user
|
self.auth_blocking._server_notices_mxid = user
|
||||||
self.hs.config.hs_disabled_message = "Reason for being disabled"
|
self.auth_blocking._hs_disabled_message = "Reason for being disabled"
|
||||||
yield defer.ensureDeferred(self.auth.check_auth_blocking(user))
|
yield defer.ensureDeferred(self.auth.check_auth_blocking(user))
|
||||||
|
|
|
@ -39,8 +39,13 @@ class AuthTestCase(unittest.TestCase):
|
||||||
self.hs.handlers = AuthHandlers(self.hs)
|
self.hs.handlers = AuthHandlers(self.hs)
|
||||||
self.auth_handler = self.hs.handlers.auth_handler
|
self.auth_handler = self.hs.handlers.auth_handler
|
||||||
self.macaroon_generator = self.hs.get_macaroon_generator()
|
self.macaroon_generator = self.hs.get_macaroon_generator()
|
||||||
|
|
||||||
# MAU tests
|
# MAU tests
|
||||||
self.hs.config.max_mau_value = 50
|
# AuthBlocking reads from the hs' config on initialization. We need to
|
||||||
|
# modify its config instead of the hs'
|
||||||
|
self.auth_blocking = self.hs.get_auth()._auth_blocking
|
||||||
|
self.auth_blocking._max_mau_value = 50
|
||||||
|
|
||||||
self.small_number_of_users = 1
|
self.small_number_of_users = 1
|
||||||
self.large_number_of_users = 100
|
self.large_number_of_users = 100
|
||||||
|
|
||||||
|
@ -119,7 +124,7 @@ class AuthTestCase(unittest.TestCase):
|
||||||
|
|
||||||
@defer.inlineCallbacks
|
@defer.inlineCallbacks
|
||||||
def test_mau_limits_disabled(self):
|
def test_mau_limits_disabled(self):
|
||||||
self.hs.config.limit_usage_by_mau = False
|
self.auth_blocking._limit_usage_by_mau = False
|
||||||
# Ensure does not throw exception
|
# Ensure does not throw exception
|
||||||
yield defer.ensureDeferred(
|
yield defer.ensureDeferred(
|
||||||
self.auth_handler.get_access_token_for_user_id(
|
self.auth_handler.get_access_token_for_user_id(
|
||||||
|
@ -135,7 +140,7 @@ class AuthTestCase(unittest.TestCase):
|
||||||
|
|
||||||
@defer.inlineCallbacks
|
@defer.inlineCallbacks
|
||||||
def test_mau_limits_exceeded_large(self):
|
def test_mau_limits_exceeded_large(self):
|
||||||
self.hs.config.limit_usage_by_mau = True
|
self.auth_blocking._limit_usage_by_mau = True
|
||||||
self.hs.get_datastore().get_monthly_active_count = Mock(
|
self.hs.get_datastore().get_monthly_active_count = Mock(
|
||||||
return_value=defer.succeed(self.large_number_of_users)
|
return_value=defer.succeed(self.large_number_of_users)
|
||||||
)
|
)
|
||||||
|
@ -159,11 +164,11 @@ class AuthTestCase(unittest.TestCase):
|
||||||
|
|
||||||
@defer.inlineCallbacks
|
@defer.inlineCallbacks
|
||||||
def test_mau_limits_parity(self):
|
def test_mau_limits_parity(self):
|
||||||
self.hs.config.limit_usage_by_mau = True
|
self.auth_blocking._limit_usage_by_mau = True
|
||||||
|
|
||||||
# If not in monthly active cohort
|
# If not in monthly active cohort
|
||||||
self.hs.get_datastore().get_monthly_active_count = Mock(
|
self.hs.get_datastore().get_monthly_active_count = Mock(
|
||||||
return_value=defer.succeed(self.hs.config.max_mau_value)
|
return_value=defer.succeed(self.auth_blocking._max_mau_value)
|
||||||
)
|
)
|
||||||
with self.assertRaises(ResourceLimitError):
|
with self.assertRaises(ResourceLimitError):
|
||||||
yield defer.ensureDeferred(
|
yield defer.ensureDeferred(
|
||||||
|
@ -173,7 +178,7 @@ class AuthTestCase(unittest.TestCase):
|
||||||
)
|
)
|
||||||
|
|
||||||
self.hs.get_datastore().get_monthly_active_count = Mock(
|
self.hs.get_datastore().get_monthly_active_count = Mock(
|
||||||
return_value=defer.succeed(self.hs.config.max_mau_value)
|
return_value=defer.succeed(self.auth_blocking._max_mau_value)
|
||||||
)
|
)
|
||||||
with self.assertRaises(ResourceLimitError):
|
with self.assertRaises(ResourceLimitError):
|
||||||
yield defer.ensureDeferred(
|
yield defer.ensureDeferred(
|
||||||
|
@ -186,7 +191,7 @@ class AuthTestCase(unittest.TestCase):
|
||||||
return_value=defer.succeed(self.hs.get_clock().time_msec())
|
return_value=defer.succeed(self.hs.get_clock().time_msec())
|
||||||
)
|
)
|
||||||
self.hs.get_datastore().get_monthly_active_count = Mock(
|
self.hs.get_datastore().get_monthly_active_count = Mock(
|
||||||
return_value=defer.succeed(self.hs.config.max_mau_value)
|
return_value=defer.succeed(self.auth_blocking._max_mau_value)
|
||||||
)
|
)
|
||||||
yield defer.ensureDeferred(
|
yield defer.ensureDeferred(
|
||||||
self.auth_handler.get_access_token_for_user_id(
|
self.auth_handler.get_access_token_for_user_id(
|
||||||
|
@ -197,7 +202,7 @@ class AuthTestCase(unittest.TestCase):
|
||||||
return_value=defer.succeed(self.hs.get_clock().time_msec())
|
return_value=defer.succeed(self.hs.get_clock().time_msec())
|
||||||
)
|
)
|
||||||
self.hs.get_datastore().get_monthly_active_count = Mock(
|
self.hs.get_datastore().get_monthly_active_count = Mock(
|
||||||
return_value=defer.succeed(self.hs.config.max_mau_value)
|
return_value=defer.succeed(self.auth_blocking._max_mau_value)
|
||||||
)
|
)
|
||||||
yield defer.ensureDeferred(
|
yield defer.ensureDeferred(
|
||||||
self.auth_handler.validate_short_term_login_token_and_get_user_id(
|
self.auth_handler.validate_short_term_login_token_and_get_user_id(
|
||||||
|
@ -207,7 +212,7 @@ class AuthTestCase(unittest.TestCase):
|
||||||
|
|
||||||
@defer.inlineCallbacks
|
@defer.inlineCallbacks
|
||||||
def test_mau_limits_not_exceeded(self):
|
def test_mau_limits_not_exceeded(self):
|
||||||
self.hs.config.limit_usage_by_mau = True
|
self.auth_blocking._limit_usage_by_mau = True
|
||||||
|
|
||||||
self.hs.get_datastore().get_monthly_active_count = Mock(
|
self.hs.get_datastore().get_monthly_active_count = Mock(
|
||||||
return_value=defer.succeed(self.small_number_of_users)
|
return_value=defer.succeed(self.small_number_of_users)
|
||||||
|
|
|
@ -30,28 +30,31 @@ class SyncTestCase(tests.unittest.HomeserverTestCase):
|
||||||
self.sync_handler = self.hs.get_sync_handler()
|
self.sync_handler = self.hs.get_sync_handler()
|
||||||
self.store = self.hs.get_datastore()
|
self.store = self.hs.get_datastore()
|
||||||
|
|
||||||
def test_wait_for_sync_for_user_auth_blocking(self):
|
# AuthBlocking reads from the hs' config on initialization. We need to
|
||||||
|
# modify its config instead of the hs'
|
||||||
|
self.auth_blocking = self.hs.get_auth()._auth_blocking
|
||||||
|
|
||||||
|
def test_wait_for_sync_for_user_auth_blocking(self):
|
||||||
user_id1 = "@user1:test"
|
user_id1 = "@user1:test"
|
||||||
user_id2 = "@user2:test"
|
user_id2 = "@user2:test"
|
||||||
sync_config = self._generate_sync_config(user_id1)
|
sync_config = self._generate_sync_config(user_id1)
|
||||||
|
|
||||||
self.reactor.advance(100) # So we get not 0 time
|
self.reactor.advance(100) # So we get not 0 time
|
||||||
self.hs.config.limit_usage_by_mau = True
|
self.auth_blocking._limit_usage_by_mau = True
|
||||||
self.hs.config.max_mau_value = 1
|
self.auth_blocking._max_mau_value = 1
|
||||||
|
|
||||||
# Check that the happy case does not throw errors
|
# Check that the happy case does not throw errors
|
||||||
self.get_success(self.store.upsert_monthly_active_user(user_id1))
|
self.get_success(self.store.upsert_monthly_active_user(user_id1))
|
||||||
self.get_success(self.sync_handler.wait_for_sync_for_user(sync_config))
|
self.get_success(self.sync_handler.wait_for_sync_for_user(sync_config))
|
||||||
|
|
||||||
# Test that global lock works
|
# Test that global lock works
|
||||||
self.hs.config.hs_disabled = True
|
self.auth_blocking._hs_disabled = True
|
||||||
e = self.get_failure(
|
e = self.get_failure(
|
||||||
self.sync_handler.wait_for_sync_for_user(sync_config), ResourceLimitError
|
self.sync_handler.wait_for_sync_for_user(sync_config), ResourceLimitError
|
||||||
)
|
)
|
||||||
self.assertEquals(e.value.errcode, Codes.RESOURCE_LIMIT_EXCEEDED)
|
self.assertEquals(e.value.errcode, Codes.RESOURCE_LIMIT_EXCEEDED)
|
||||||
|
|
||||||
self.hs.config.hs_disabled = False
|
self.auth_blocking._hs_disabled = False
|
||||||
|
|
||||||
sync_config = self._generate_sync_config(user_id2)
|
sync_config = self._generate_sync_config(user_id2)
|
||||||
|
|
||||||
|
|
|
@ -19,6 +19,7 @@ import json
|
||||||
|
|
||||||
from mock import Mock
|
from mock import Mock
|
||||||
|
|
||||||
|
from synapse.api.auth_blocking import AuthBlocking
|
||||||
from synapse.api.constants import LoginType
|
from synapse.api.constants import LoginType
|
||||||
from synapse.api.errors import Codes, HttpResponseException, SynapseError
|
from synapse.api.errors import Codes, HttpResponseException, SynapseError
|
||||||
from synapse.rest.client.v2_alpha import register, sync
|
from synapse.rest.client.v2_alpha import register, sync
|
||||||
|
@ -45,11 +46,17 @@ class TestMauLimit(unittest.HomeserverTestCase):
|
||||||
self.hs.config.limit_usage_by_mau = True
|
self.hs.config.limit_usage_by_mau = True
|
||||||
self.hs.config.hs_disabled = False
|
self.hs.config.hs_disabled = False
|
||||||
self.hs.config.max_mau_value = 2
|
self.hs.config.max_mau_value = 2
|
||||||
self.hs.config.mau_trial_days = 0
|
|
||||||
self.hs.config.server_notices_mxid = "@server:red"
|
self.hs.config.server_notices_mxid = "@server:red"
|
||||||
self.hs.config.server_notices_mxid_display_name = None
|
self.hs.config.server_notices_mxid_display_name = None
|
||||||
self.hs.config.server_notices_mxid_avatar_url = None
|
self.hs.config.server_notices_mxid_avatar_url = None
|
||||||
self.hs.config.server_notices_room_name = "Test Server Notice Room"
|
self.hs.config.server_notices_room_name = "Test Server Notice Room"
|
||||||
|
self.hs.config.mau_trial_days = 0
|
||||||
|
|
||||||
|
# AuthBlocking reads config options during hs creation. Recreate the
|
||||||
|
# hs' copy of AuthBlocking after we've updated config values above
|
||||||
|
self.auth_blocking = AuthBlocking(self.hs)
|
||||||
|
self.hs.get_auth()._auth_blocking = self.auth_blocking
|
||||||
|
|
||||||
return self.hs
|
return self.hs
|
||||||
|
|
||||||
def test_simple_deny_mau(self):
|
def test_simple_deny_mau(self):
|
||||||
|
@ -121,6 +128,7 @@ class TestMauLimit(unittest.HomeserverTestCase):
|
||||||
self.assertEqual(e.errcode, Codes.RESOURCE_LIMIT_EXCEEDED)
|
self.assertEqual(e.errcode, Codes.RESOURCE_LIMIT_EXCEEDED)
|
||||||
|
|
||||||
def test_trial_users_cant_come_back(self):
|
def test_trial_users_cant_come_back(self):
|
||||||
|
self.auth_blocking._mau_trial_days = 1
|
||||||
self.hs.config.mau_trial_days = 1
|
self.hs.config.mau_trial_days = 1
|
||||||
|
|
||||||
# We should be able to register more than the limit initially
|
# We should be able to register more than the limit initially
|
||||||
|
@ -169,8 +177,8 @@ class TestMauLimit(unittest.HomeserverTestCase):
|
||||||
self.assertEqual(e.errcode, Codes.RESOURCE_LIMIT_EXCEEDED)
|
self.assertEqual(e.errcode, Codes.RESOURCE_LIMIT_EXCEEDED)
|
||||||
|
|
||||||
def test_tracked_but_not_limited(self):
|
def test_tracked_but_not_limited(self):
|
||||||
self.hs.config.max_mau_value = 1 # should not matter
|
self.auth_blocking._max_mau_value = 1 # should not matter
|
||||||
self.hs.config.limit_usage_by_mau = False
|
self.auth_blocking._limit_usage_by_mau = False
|
||||||
self.hs.config.mau_stats_only = True
|
self.hs.config.mau_stats_only = True
|
||||||
|
|
||||||
# Simply being able to create 2 users indicates that the
|
# Simply being able to create 2 users indicates that the
|
||||||
|
|
Loading…
Reference in New Issue