Don't push if an user account has expired (#58)

Author: MatMaul

changelog.d/58.misc

@@ -0,0 +1 @@
+Don't push if an user account has expired.

synapse/api/auth.py

@@ -222,11 +222,10 @@ def get_user_by_req(
             # Deny the request if the user account has expired.
             if self._account_validity.enabled and not allow_expired:
                 user_id = user.to_string()
-                expiration_ts = yield self.store.get_expiration_ts_for_user(user_id)
-                if (
-                    expiration_ts is not None
-                    and self.clock.time_msec() >= expiration_ts
-                ):
+                expired = yield self.store.is_account_expired(
+                    user_id, self.clock.time_msec()
+                )
+                if expired:
                     raise AuthError(
                         403, "User account has expired", errcode=Codes.EXPIRED_ACCOUNT
                     )

synapse/push/pusherpool.py

@@ -66,6 +66,8 @@ def __init__(self, hs: "HomeServer"):
         self._pusher_shard_config = hs.config.push.pusher_shard_config
         self._instance_name = hs.get_instance_name()
 
+        self._account_validity = hs.config.account_validity
+
         # map from user id to app_id:pushkey to pusher
         self.pushers = {}  # type: Dict[str, Dict[str, Union[HttpPusher, EmailPusher]]]
 
@@ -196,6 +198,14 @@ def on_new_notifications(self, min_stream_id, max_stream_id):
 
             for u in users_affected:
                 if u in self.pushers:
+                    # Don't push if the user account has expired
+                    if self._account_validity.enabled:
+                        expired = yield self.store.is_account_expired(
+                            u, self.clock.time_msec()
+                        )
+                        if expired:
+                            continue
+
                     for p in self.pushers[u].values():
                         p.on_new_notifications(min_stream_id, max_stream_id)
 
@@ -217,6 +227,14 @@ def on_new_receipts(self, min_stream_id, max_stream_id, affected_room_ids):
 
             for u in users_affected:
                 if u in self.pushers:
+                    # Don't push if the user account has expired
+                    if self._account_validity.enabled:
+                        expired = yield self.store.is_account_expired(
+                            u, self.clock.time_msec()
+                        )
+                        if expired:
+                            continue
+
                     for p in self.pushers[u].values():
                         p.on_new_receipts(min_stream_id, max_stream_id)
 

synapse/storage/data_stores/main/registration.py

@@ -125,6 +125,23 @@ def get_expiration_ts_for_user(self, user_id):
         )
         return res
 
+    @defer.inlineCallbacks
+    def is_account_expired(self, user_id: str, current_ts: int):
+        """
+        Returns whether an user account is expired.
+
+        Args:
+            user_id: The user's ID
+            current_ts: The current timestamp
+
+        Returns:
+            Deferred[bool]: whether the user account has expired
+        """
+        expiration_ts = yield self.get_expiration_ts_for_user(user_id)
+        if expiration_ts is not None and current_ts >= expiration_ts:
+            return True
+        return False
+
     @defer.inlineCallbacks
     def set_account_validity_for_user(
         self, user_id, expiration_ts, email_sent, renewal_token=None