2022-11-16 17:12:38 +00:00
|
|
|
"""
|
|
|
|
Token repository using Redis as backend.
|
|
|
|
"""
|
2022-12-14 14:29:19 +00:00
|
|
|
from typing import Optional
|
|
|
|
from datetime import datetime
|
|
|
|
|
2022-11-16 17:12:38 +00:00
|
|
|
from selfprivacy_api.repositories.tokens.abstract_tokens_repository import (
|
|
|
|
AbstractTokensRepository,
|
|
|
|
)
|
2022-12-14 14:29:19 +00:00
|
|
|
from selfprivacy_api.utils.redis_pool import RedisPool
|
|
|
|
from selfprivacy_api.models.tokens.token import Token
|
|
|
|
from selfprivacy_api.models.tokens.recovery_key import RecoveryKey
|
|
|
|
from selfprivacy_api.models.tokens.new_device_key import NewDeviceKey
|
|
|
|
|
|
|
|
TOKENS_PREFIX = "token_repo:tokens:"
|
2022-11-16 17:12:38 +00:00
|
|
|
|
|
|
|
|
|
|
|
class RedisTokensRepository(AbstractTokensRepository):
|
|
|
|
"""
|
|
|
|
Token repository using Redis as a backend
|
|
|
|
"""
|
|
|
|
|
2022-12-14 14:29:19 +00:00
|
|
|
def __init__(self):
|
|
|
|
self.connection = RedisPool().get_connection()
|
|
|
|
|
2022-12-14 15:21:32 +00:00
|
|
|
@staticmethod
|
2022-12-14 14:29:19 +00:00
|
|
|
def token_key_for_device(device_name: str):
|
|
|
|
return TOKENS_PREFIX + str(hash(device_name))
|
|
|
|
|
|
|
|
def get_tokens(self) -> list[Token]:
|
|
|
|
"""Get the tokens"""
|
2022-12-14 14:48:43 +00:00
|
|
|
r = self.connection
|
|
|
|
token_keys = r.keys(TOKENS_PREFIX + "*")
|
|
|
|
return [self._token_from_hash(key) for key in token_keys]
|
2022-12-14 14:29:19 +00:00
|
|
|
|
|
|
|
def delete_token(self, input_token: Token) -> None:
|
|
|
|
"""Delete the token"""
|
2022-12-14 16:16:55 +00:00
|
|
|
r = self.connection
|
|
|
|
key = RedisTokensRepository._token_redis_key(input_token)
|
|
|
|
r.delete(key)
|
2022-12-14 14:29:19 +00:00
|
|
|
|
|
|
|
def get_recovery_key(self) -> Optional[RecoveryKey]:
|
|
|
|
"""Get the recovery key"""
|
|
|
|
raise NotImplementedError
|
|
|
|
|
|
|
|
def create_recovery_key(
|
|
|
|
self,
|
|
|
|
expiration: Optional[datetime],
|
|
|
|
uses_left: Optional[int],
|
|
|
|
) -> RecoveryKey:
|
|
|
|
"""Create the recovery key"""
|
|
|
|
raise NotImplementedError
|
|
|
|
|
|
|
|
def get_new_device_key(self) -> NewDeviceKey:
|
|
|
|
"""Creates and returns the new device key"""
|
|
|
|
raise NotImplementedError
|
|
|
|
|
|
|
|
def delete_new_device_key(self) -> None:
|
|
|
|
"""Delete the new device key"""
|
|
|
|
raise NotImplementedError
|
|
|
|
|
2022-12-14 15:34:25 +00:00
|
|
|
@staticmethod
|
|
|
|
def _token_redis_key(token: Token) -> str:
|
|
|
|
return RedisTokensRepository.token_key_for_device(token.device_name)
|
|
|
|
|
2022-12-14 14:29:19 +00:00
|
|
|
def _store_token(self, new_token: Token):
|
|
|
|
"""Store a token directly"""
|
2022-12-14 15:34:25 +00:00
|
|
|
key = RedisTokensRepository._token_redis_key(new_token)
|
2022-12-14 15:21:32 +00:00
|
|
|
self._store_token_as_hash(key, new_token)
|
2022-12-14 14:29:19 +00:00
|
|
|
|
|
|
|
def _decrement_recovery_token(self):
|
|
|
|
"""Decrement recovery key use count by one"""
|
|
|
|
raise NotImplementedError
|
|
|
|
|
|
|
|
def _get_stored_new_device_key(self) -> Optional[NewDeviceKey]:
|
|
|
|
"""Retrieves new device key that is already stored."""
|
2022-11-16 17:12:38 +00:00
|
|
|
raise NotImplementedError
|
2022-12-14 14:48:43 +00:00
|
|
|
|
2022-12-14 17:03:22 +00:00
|
|
|
@staticmethod
|
|
|
|
def _prepare_model_dict(d: dict):
|
|
|
|
for date in [
|
|
|
|
"created_at",
|
|
|
|
]:
|
|
|
|
if d[date] != "None":
|
|
|
|
d[date] = datetime.fromisoformat(d[date])
|
|
|
|
for key in d.keys():
|
|
|
|
if d[key] == "None":
|
|
|
|
d[key] = None
|
|
|
|
|
2022-12-14 17:10:32 +00:00
|
|
|
def _model_dict_from_hash(self, redis_key: str) -> Optional[dict]:
|
2022-12-14 14:48:43 +00:00
|
|
|
r = self.connection
|
|
|
|
if r.exists(redis_key):
|
|
|
|
token_dict = r.hgetall(redis_key)
|
2022-12-14 17:03:22 +00:00
|
|
|
RedisTokensRepository._prepare_model_dict(token_dict)
|
2022-12-14 17:10:32 +00:00
|
|
|
return token_dict
|
|
|
|
return None
|
2022-12-14 14:48:43 +00:00
|
|
|
|
2022-12-14 17:10:32 +00:00
|
|
|
def _token_from_hash(self, redis_key: str) -> Optional[Token]:
|
|
|
|
token_dict = self._model_dict_from_hash(redis_key)
|
|
|
|
if token_dict is not None:
|
2022-12-14 14:48:43 +00:00
|
|
|
return Token(**token_dict)
|
|
|
|
return None
|
|
|
|
|
2022-12-14 15:21:32 +00:00
|
|
|
def _store_token_as_hash(self, redis_key, model):
|
|
|
|
r = self.connection
|
|
|
|
for key, value in model.dict().items():
|
|
|
|
if isinstance(value, datetime):
|
|
|
|
value = value.isoformat()
|
|
|
|
r.hset(redis_key, key, str(value))
|