synapse-product/synapse/storage/registration.py

147 lines
4.8 KiB
Python
Raw Normal View History

2014-08-12 10:10:52 -04:00
# -*- coding: utf-8 -*-
2015-01-06 08:21:39 -05:00
# Copyright 2014, 2015 OpenMarket Ltd
2014-08-12 10:10:52 -04:00
#
# 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.
2014-08-12 10:10:52 -04:00
from twisted.internet import defer
from sqlite3 import IntegrityError
from synapse.api.errors import StoreError, Codes
2014-08-12 10:10:52 -04:00
from ._base import SQLBaseStore, cached
2014-08-12 10:10:52 -04:00
class RegistrationStore(SQLBaseStore):
def __init__(self, hs):
super(RegistrationStore, self).__init__(hs)
self.clock = hs.get_clock()
@defer.inlineCallbacks
def add_access_token_to_user(self, user_id, token):
"""Adds an access token for the given user.
Args:
user_id (str): The user ID.
token (str): The new access token to add.
Raises:
StoreError if there was a problem adding this.
"""
row = yield self._simple_select_one(
"users", {"name": user_id}, ["id"],
desc="add_access_token_to_user",
)
2014-08-12 10:10:52 -04:00
if not row:
raise StoreError(400, "Bad user ID supplied.")
row_id = row["id"]
yield self._simple_insert(
"access_tokens",
{
"user_id": row_id,
"token": token
},
desc="add_access_token_to_user",
2014-08-12 10:10:52 -04:00
)
@defer.inlineCallbacks
def register(self, user_id, token, password_hash):
"""Attempts to register an account.
Args:
user_id (str): The desired user ID to register.
token (str): The desired access token to use for this user.
password_hash (str): Optional. The password hash for this user.
Raises:
StoreError if the user_id could not be registered.
"""
yield self.runInteraction(
"register",
self._register, user_id, token, password_hash
)
2014-08-12 10:10:52 -04:00
def _register(self, txn, user_id, token, password_hash):
now = int(self.clock.time())
try:
txn.execute("INSERT INTO users(name, password_hash, creation_ts) "
"VALUES (?,?,?)",
[user_id, password_hash, now])
except IntegrityError:
2014-11-20 12:26:36 -05:00
raise StoreError(
400, "User ID already taken.", errcode=Codes.USER_IN_USE
)
2014-08-12 10:10:52 -04:00
# it's possible for this to get a conflict, but only for a single user
# since tokens are namespaced based on their user ID
txn.execute("INSERT INTO access_tokens(user_id, token) " +
"VALUES (?,?)", [txn.lastrowid, token])
def get_user_by_id(self, user_id):
2014-11-20 12:26:36 -05:00
query = ("SELECT users.name, users.password_hash FROM users"
" WHERE users.name = ?")
2014-08-12 10:10:52 -04:00
return self._execute(
2015-03-11 13:19:17 -04:00
"get_user_by_id", self.cursor_to_dict, query, user_id
2014-08-12 10:10:52 -04:00
)
@cached()
# TODO(paul): Currently there's no code to invalidate this cache. That
# means if/when we ever add internal ways to invalidate access tokens or
# change whether a user is a server admin, those will need to invoke
# store.get_user_by_token.invalidate(token)
2014-08-12 10:10:52 -04:00
def get_user_by_token(self, token):
"""Get a user from the given access token.
Args:
token (str): The access token of a user.
Returns:
2014-09-29 10:35:54 -04:00
dict: Including the name (user_id), device_id and whether they are
an admin.
2014-08-12 10:10:52 -04:00
Raises:
StoreError if no user was found.
"""
2014-09-29 09:59:52 -04:00
return self.runInteraction(
"get_user_by_token",
2014-09-29 09:59:52 -04:00
self._query_for_auth,
token
)
2014-08-12 10:10:52 -04:00
@defer.inlineCallbacks
def is_server_admin(self, user):
res = yield self._simple_select_one_onecol(
table="users",
keyvalues={"name": user.to_string()},
retcol="admin",
allow_none=True,
desc="is_server_admin",
)
defer.returnValue(res if res else False)
2014-08-12 10:10:52 -04:00
def _query_for_auth(self, txn, token):
2014-09-29 09:59:52 -04:00
sql = (
"SELECT users.name, users.admin,"
" access_tokens.device_id, access_tokens.id as token_id"
2014-11-20 12:26:36 -05:00
" FROM users"
" INNER JOIN access_tokens on users.id = access_tokens.user_id"
" WHERE token = ?"
2014-09-29 09:59:52 -04:00
)
cursor = txn.execute(sql, (token,))
rows = self.cursor_to_dict(cursor)
if rows:
return rows[0]
2014-08-12 10:10:52 -04:00
raise StoreError(404, "Token not found.")