mirror of
https://git.anonymousland.org/anonymousland/synapse.git
synced 2025-05-07 20:05:06 -04:00
Save login tokens in database (#13844)
* Save login tokens in database Signed-off-by: Quentin Gliech <quenting@element.io> * Add upgrade notes * Track login token reuse in a Prometheus metric Signed-off-by: Quentin Gliech <quenting@element.io>
This commit is contained in:
Quentin Gliech
GitHub
parent
d902181de9
commit
8756d5c87e
11 changed files with 338 additions and 228 deletions
|
|
@ -11,6 +11,7 @@
|
|||
# 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.
|
||||
from typing import Optional
|
||||
from unittest.mock import Mock
|
||||
|
||||
import pymacaroons
|
||||
|
|
@ -19,6 +20,7 @@ from twisted.test.proto_helpers import MemoryReactor
|
|||
|
||||
from synapse.api.errors import AuthError, ResourceLimitError
|
||||
from synapse.rest import admin
|
||||
from synapse.rest.client import login
|
||||
from synapse.server import HomeServer
|
||||
from synapse.util import Clock
|
||||
|
||||
|
|
@ -29,6 +31,7 @@ from tests.test_utils import make_awaitable
|
|||
class AuthTestCase(unittest.HomeserverTestCase):
|
||||
servlets = [
|
||||
admin.register_servlets,
|
||||
login.register_servlets,
|
||||
]
|
||||
|
||||
def prepare(self, reactor: MemoryReactor, clock: Clock, hs: HomeServer) -> None:
|
||||
|
|
@ -46,6 +49,23 @@ class AuthTestCase(unittest.HomeserverTestCase):
|
|||
|
||||
self.user1 = self.register_user("a_user", "pass")
|
||||
|
||||
def token_login(self, token: str) -> Optional[str]:
|
||||
body = {
|
||||
"type": "m.login.token",
|
||||
"token": token,
|
||||
}
|
||||
|
||||
channel = self.make_request(
|
||||
"POST",
|
||||
"/_matrix/client/v3/login",
|
||||
body,
|
||||
)
|
||||
|
||||
if channel.code == 200:
|
||||
return channel.json_body["user_id"]
|
||||
|
||||
return None
|
||||
|
||||
def test_macaroon_caveats(self) -> None:
|
||||
token = self.macaroon_generator.generate_guest_access_token("a_user")
|
||||
macaroon = pymacaroons.Macaroon.deserialize(token)
|
||||
|
|
@ -73,48 +93,61 @@ class AuthTestCase(unittest.HomeserverTestCase):
|
|||
v.satisfy_general(verify_guest)
|
||||
v.verify(macaroon, self.hs.config.key.macaroon_secret_key)
|
||||
|
||||
def test_short_term_login_token_gives_user_id(self) -> None:
|
||||
token = self.macaroon_generator.generate_short_term_login_token(
|
||||
self.user1, "", duration_in_ms=5000
|
||||
def test_login_token_gives_user_id(self) -> None:
|
||||
token = self.get_success(
|
||||
self.auth_handler.create_login_token_for_user_id(
|
||||
self.user1,
|
||||
duration_ms=(5 * 1000),
|
||||
)
|
||||
)
|
||||
res = self.get_success(self.auth_handler.validate_short_term_login_token(token))
|
||||
|
||||
res = self.get_success(self.auth_handler.consume_login_token(token))
|
||||
self.assertEqual(self.user1, res.user_id)
|
||||
self.assertEqual("", res.auth_provider_id)
|
||||
self.assertEqual(None, res.auth_provider_id)
|
||||
|
||||
def test_login_token_reuse_fails(self) -> None:
|
||||
token = self.get_success(
|
||||
self.auth_handler.create_login_token_for_user_id(
|
||||
self.user1,
|
||||
duration_ms=(5 * 1000),
|
||||
)
|
||||
)
|
||||
|
||||
self.get_success(self.auth_handler.consume_login_token(token))
|
||||
|
||||
self.get_failure(
|
||||
self.auth_handler.consume_login_token(token),
|
||||
AuthError,
|
||||
)
|
||||
|
||||
def test_login_token_expires(self) -> None:
|
||||
token = self.get_success(
|
||||
self.auth_handler.create_login_token_for_user_id(
|
||||
self.user1,
|
||||
duration_ms=(5 * 1000),
|
||||
)
|
||||
)
|
||||
|
||||
# when we advance the clock, the token should be rejected
|
||||
self.reactor.advance(6)
|
||||
self.get_failure(
|
||||
self.auth_handler.validate_short_term_login_token(token),
|
||||
self.auth_handler.consume_login_token(token),
|
||||
AuthError,
|
||||
)
|
||||
|
||||
def test_short_term_login_token_gives_auth_provider(self) -> None:
|
||||
token = self.macaroon_generator.generate_short_term_login_token(
|
||||
self.user1, auth_provider_id="my_idp"
|
||||
def test_login_token_gives_auth_provider(self) -> None:
|
||||
token = self.get_success(
|
||||
self.auth_handler.create_login_token_for_user_id(
|
||||
self.user1,
|
||||
auth_provider_id="my_idp",
|
||||
auth_provider_session_id="11-22-33-44",
|
||||
duration_ms=(5 * 1000),
|
||||
)
|
||||
)
|
||||
res = self.get_success(self.auth_handler.validate_short_term_login_token(token))
|
||||
res = self.get_success(self.auth_handler.consume_login_token(token))
|
||||
self.assertEqual(self.user1, res.user_id)
|
||||
self.assertEqual("my_idp", res.auth_provider_id)
|
||||
|
||||
def test_short_term_login_token_cannot_replace_user_id(self) -> None:
|
||||
token = self.macaroon_generator.generate_short_term_login_token(
|
||||
self.user1, "", duration_in_ms=5000
|
||||
)
|
||||
macaroon = pymacaroons.Macaroon.deserialize(token)
|
||||
|
||||
res = self.get_success(
|
||||
self.auth_handler.validate_short_term_login_token(macaroon.serialize())
|
||||
)
|
||||
self.assertEqual(self.user1, res.user_id)
|
||||
|
||||
# add another "user_id" caveat, which might allow us to override the
|
||||
# user_id.
|
||||
macaroon.add_first_party_caveat("user_id = b_user")
|
||||
|
||||
self.get_failure(
|
||||
self.auth_handler.validate_short_term_login_token(macaroon.serialize()),
|
||||
AuthError,
|
||||
)
|
||||
self.assertEqual("11-22-33-44", res.auth_provider_session_id)
|
||||
|
||||
def test_mau_limits_disabled(self) -> None:
|
||||
self.auth_blocking._limit_usage_by_mau = False
|
||||
|
|
@ -125,12 +158,12 @@ class AuthTestCase(unittest.HomeserverTestCase):
|
|||
)
|
||||
)
|
||||
|
||||
self.get_success(
|
||||
self.auth_handler.validate_short_term_login_token(
|
||||
self._get_macaroon().serialize()
|
||||
)
|
||||
token = self.get_success(
|
||||
self.auth_handler.create_login_token_for_user_id(self.user1)
|
||||
)
|
||||
|
||||
self.assertIsNotNone(self.token_login(token))
|
||||
|
||||
def test_mau_limits_exceeded_large(self) -> None:
|
||||
self.auth_blocking._limit_usage_by_mau = True
|
||||
self.hs.get_datastores().main.get_monthly_active_count = Mock(
|
||||
|
|
@ -147,12 +180,10 @@ class AuthTestCase(unittest.HomeserverTestCase):
|
|||
self.hs.get_datastores().main.get_monthly_active_count = Mock(
|
||||
return_value=make_awaitable(self.large_number_of_users)
|
||||
)
|
||||
self.get_failure(
|
||||
self.auth_handler.validate_short_term_login_token(
|
||||
self._get_macaroon().serialize()
|
||||
),
|
||||
ResourceLimitError,
|
||||
token = self.get_success(
|
||||
self.auth_handler.create_login_token_for_user_id(self.user1)
|
||||
)
|
||||
self.assertIsNone(self.token_login(token))
|
||||
|
||||
def test_mau_limits_parity(self) -> None:
|
||||
# Ensure we're not at the unix epoch.
|
||||
|
|
@ -171,12 +202,10 @@ class AuthTestCase(unittest.HomeserverTestCase):
|
|||
),
|
||||
ResourceLimitError,
|
||||
)
|
||||
self.get_failure(
|
||||
self.auth_handler.validate_short_term_login_token(
|
||||
self._get_macaroon().serialize()
|
||||
),
|
||||
ResourceLimitError,
|
||||
token = self.get_success(
|
||||
self.auth_handler.create_login_token_for_user_id(self.user1)
|
||||
)
|
||||
self.assertIsNone(self.token_login(token))
|
||||
|
||||
# If in monthly active cohort
|
||||
self.hs.get_datastores().main.user_last_seen_monthly_active = Mock(
|
||||
|
|
@ -187,11 +216,10 @@ class AuthTestCase(unittest.HomeserverTestCase):
|
|||
self.user1, device_id=None, valid_until_ms=None
|
||||
)
|
||||
)
|
||||
self.get_success(
|
||||
self.auth_handler.validate_short_term_login_token(
|
||||
self._get_macaroon().serialize()
|
||||
)
|
||||
token = self.get_success(
|
||||
self.auth_handler.create_login_token_for_user_id(self.user1)
|
||||
)
|
||||
self.assertIsNotNone(self.token_login(token))
|
||||
|
||||
def test_mau_limits_not_exceeded(self) -> None:
|
||||
self.auth_blocking._limit_usage_by_mau = True
|
||||
|
|
@ -209,14 +237,7 @@ class AuthTestCase(unittest.HomeserverTestCase):
|
|||
self.hs.get_datastores().main.get_monthly_active_count = Mock(
|
||||
return_value=make_awaitable(self.small_number_of_users)
|
||||
)
|
||||
self.get_success(
|
||||
self.auth_handler.validate_short_term_login_token(
|
||||
self._get_macaroon().serialize()
|
||||
)
|
||||
token = self.get_success(
|
||||
self.auth_handler.create_login_token_for_user_id(self.user1)
|
||||
)
|
||||
|
||||
def _get_macaroon(self) -> pymacaroons.Macaroon:
|
||||
token = self.macaroon_generator.generate_short_term_login_token(
|
||||
self.user1, "", duration_in_ms=5000
|
||||
)
|
||||
return pymacaroons.Macaroon.deserialize(token)
|
||||
self.assertIsNotNone(self.token_login(token))
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue