mirror of
https://github.com/element-hq/synapse
synced 2024-07-07 11:22:59 +00:00
f863a52cea
Add a 'devices' table to the storage, as well as a 'device_id' column to refresh_tokens. Allow the client to pass a device_id, and initial_device_display_name, to /login. If login is successful, then register the device in the devices table if it wasn't known already. If no device_id was supplied, make one up. Associate the device_id with the access token and refresh token, so that we can get at it again later. Ensure that the device_id is copied from the refresh token to the access_token when the token is refreshed.
139 lines
4.6 KiB
Python
139 lines
4.6 KiB
Python
# -*- coding: utf-8 -*-
|
|
# Copyright 2014-2016 OpenMarket Ltd
|
|
#
|
|
# 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.
|
|
|
|
|
|
from tests import unittest
|
|
from twisted.internet import defer
|
|
|
|
from synapse.api.errors import StoreError
|
|
from synapse.util import stringutils
|
|
|
|
from tests.utils import setup_test_homeserver
|
|
|
|
|
|
class RegistrationStoreTestCase(unittest.TestCase):
|
|
|
|
@defer.inlineCallbacks
|
|
def setUp(self):
|
|
hs = yield setup_test_homeserver()
|
|
self.db_pool = hs.get_db_pool()
|
|
|
|
self.store = hs.get_datastore()
|
|
|
|
self.user_id = "@my-user:test"
|
|
self.tokens = [
|
|
"AbCdEfGhIjKlMnOpQrStUvWxYz",
|
|
"BcDeFgHiJkLmNoPqRsTuVwXyZa"
|
|
]
|
|
self.pwhash = "{xx1}123456789"
|
|
self.device_id = "akgjhdjklgshg"
|
|
|
|
@defer.inlineCallbacks
|
|
def test_register(self):
|
|
yield self.store.register(self.user_id, self.tokens[0], self.pwhash)
|
|
|
|
self.assertEquals(
|
|
# TODO(paul): Surely this field should be 'user_id', not 'name'
|
|
# Additionally surely it shouldn't come in a 1-element list
|
|
{"name": self.user_id, "password_hash": self.pwhash, "is_guest": 0},
|
|
(yield self.store.get_user_by_id(self.user_id))
|
|
)
|
|
|
|
result = yield self.store.get_user_by_access_token(self.tokens[0])
|
|
|
|
self.assertDictContainsSubset(
|
|
{
|
|
"name": self.user_id,
|
|
},
|
|
result
|
|
)
|
|
|
|
self.assertTrue("token_id" in result)
|
|
|
|
@defer.inlineCallbacks
|
|
def test_add_tokens(self):
|
|
yield self.store.register(self.user_id, self.tokens[0], self.pwhash)
|
|
yield self.store.add_access_token_to_user(self.user_id, self.tokens[1],
|
|
self.device_id)
|
|
|
|
result = yield self.store.get_user_by_access_token(self.tokens[1])
|
|
|
|
self.assertDictContainsSubset(
|
|
{
|
|
"name": self.user_id,
|
|
"device_id": self.device_id,
|
|
},
|
|
result
|
|
)
|
|
|
|
self.assertTrue("token_id" in result)
|
|
|
|
@defer.inlineCallbacks
|
|
def test_exchange_refresh_token_valid(self):
|
|
uid = stringutils.random_string(32)
|
|
device_id = stringutils.random_string(16)
|
|
generator = TokenGenerator()
|
|
last_token = generator.generate(uid)
|
|
|
|
self.db_pool.runQuery(
|
|
"INSERT INTO refresh_tokens(user_id, token, device_id) "
|
|
"VALUES(?,?,?)",
|
|
(uid, last_token, device_id))
|
|
|
|
(found_user_id, refresh_token, device_id) = \
|
|
yield self.store.exchange_refresh_token(last_token,
|
|
generator.generate)
|
|
self.assertEqual(uid, found_user_id)
|
|
|
|
rows = yield self.db_pool.runQuery(
|
|
"SELECT token, device_id FROM refresh_tokens WHERE user_id = ?",
|
|
(uid, ))
|
|
self.assertEqual([(refresh_token, device_id)], rows)
|
|
# We issued token 1, then exchanged it for token 2
|
|
expected_refresh_token = u"%s-%d" % (uid, 2,)
|
|
self.assertEqual(expected_refresh_token, refresh_token)
|
|
|
|
@defer.inlineCallbacks
|
|
def test_exchange_refresh_token_none(self):
|
|
uid = stringutils.random_string(32)
|
|
generator = TokenGenerator()
|
|
last_token = generator.generate(uid)
|
|
|
|
with self.assertRaises(StoreError):
|
|
yield self.store.exchange_refresh_token(last_token, generator.generate)
|
|
|
|
@defer.inlineCallbacks
|
|
def test_exchange_refresh_token_invalid(self):
|
|
uid = stringutils.random_string(32)
|
|
generator = TokenGenerator()
|
|
last_token = generator.generate(uid)
|
|
wrong_token = "%s-wrong" % (last_token,)
|
|
|
|
self.db_pool.runQuery(
|
|
"INSERT INTO refresh_tokens(user_id, token) VALUES(?,?)",
|
|
(uid, wrong_token,))
|
|
|
|
with self.assertRaises(StoreError):
|
|
yield self.store.exchange_refresh_token(last_token, generator.generate)
|
|
|
|
|
|
class TokenGenerator:
|
|
def __init__(self):
|
|
self._last_issued_token = 0
|
|
|
|
def generate(self, user_id):
|
|
self._last_issued_token += 1
|
|
return u"%s-%d" % (user_id, self._last_issued_token,)
|