You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
127 lines
4.4 KiB
127 lines
4.4 KiB
import warnings
|
|
from datetime import datetime
|
|
from datetime import timedelta as TimeDelta
|
|
from decimal import Decimal
|
|
from typing import Optional
|
|
|
|
import boto3
|
|
from mypy_boto3_dynamodb.service_resource import DynamoDBServiceResource
|
|
from flask import Flask
|
|
from itsdangerous import want_bytes
|
|
|
|
from ..base import ServerSideSession, ServerSideSessionInterface
|
|
from ..defaults import Defaults
|
|
|
|
|
|
class DynamoDBSession(ServerSideSession):
|
|
pass
|
|
|
|
|
|
class DynamoDBSessionInterface(ServerSideSessionInterface):
|
|
"""A Session interface that uses dynamodb as backend. (`boto3` required)
|
|
|
|
:param client: A ``DynamoDBServiceResource`` instance.
|
|
:param key_prefix: A prefix that is added to all DynamoDB store keys.
|
|
:param use_signer: Whether to sign the session id cookie or not.
|
|
:param permanent: Whether to use permanent session or not.
|
|
:param sid_length: The length of the generated session id in bytes.
|
|
:param table_name: DynamoDB table name to store the session.
|
|
|
|
.. versionadded:: 0.6
|
|
The `sid_length` parameter was added.
|
|
|
|
.. versionadded:: 0.2
|
|
The `use_signer` parameter was added.
|
|
"""
|
|
|
|
session_class = DynamoDBSession
|
|
|
|
def __init__(
|
|
self,
|
|
app: Flask,
|
|
client: Optional[DynamoDBServiceResource] = Defaults.SESSION_DYNAMODB,
|
|
key_prefix: str = Defaults.SESSION_KEY_PREFIX,
|
|
use_signer: bool = Defaults.SESSION_USE_SIGNER,
|
|
permanent: bool = Defaults.SESSION_PERMANENT,
|
|
sid_length: int = Defaults.SESSION_ID_LENGTH,
|
|
serialization_format: str = Defaults.SESSION_SERIALIZATION_FORMAT,
|
|
table_name: str = Defaults.SESSION_DYNAMODB_TABLE,
|
|
):
|
|
|
|
if client is None:
|
|
warnings.warn(
|
|
"No valid DynamoDBServiceResource instance provided, attempting to create a new instance on localhost:8000.",
|
|
RuntimeWarning,
|
|
stacklevel=1,
|
|
)
|
|
client = boto3.resource(
|
|
"dynamodb",
|
|
endpoint_url="http://localhost:8000",
|
|
region_name="us-west-2",
|
|
aws_access_key_id="dummy",
|
|
aws_secret_access_key="dummy",
|
|
)
|
|
|
|
try:
|
|
client.create_table(
|
|
AttributeDefinitions=[
|
|
{"AttributeName": "id", "AttributeType": "S"},
|
|
],
|
|
TableName=table_name,
|
|
KeySchema=[
|
|
{"AttributeName": "id", "KeyType": "HASH"},
|
|
],
|
|
BillingMode="PAY_PER_REQUEST",
|
|
)
|
|
client.meta.client.get_waiter("table_exists").wait(TableName=table_name)
|
|
client.meta.client.update_time_to_live(
|
|
TableName=self.table_name,
|
|
TimeToLiveSpecification={
|
|
"Enabled": True,
|
|
"AttributeName": "expiration",
|
|
},
|
|
)
|
|
except (AttributeError, client.meta.client.exceptions.ResourceInUseException):
|
|
# TTL already exists, or table already exists
|
|
pass
|
|
|
|
self.client = client
|
|
self.store = client.Table(table_name)
|
|
super().__init__(
|
|
app,
|
|
key_prefix,
|
|
use_signer,
|
|
permanent,
|
|
sid_length,
|
|
serialization_format,
|
|
)
|
|
|
|
def _retrieve_session_data(self, store_id: str) -> Optional[dict]:
|
|
# Get the saved session (document) from the database
|
|
document = self.store.get_item(Key={"id": store_id}).get("Item")
|
|
if document:
|
|
serialized_session_data = want_bytes(document.get("val").value)
|
|
return self.serializer.decode(serialized_session_data)
|
|
return None
|
|
|
|
def _delete_session(self, store_id: str) -> None:
|
|
self.store.delete_item(Key={"id": store_id})
|
|
|
|
def _upsert_session(
|
|
self, session_lifetime: TimeDelta, session: ServerSideSession, store_id: str
|
|
) -> None:
|
|
storage_expiration_datetime = datetime.utcnow() + session_lifetime
|
|
# Serialize the session data
|
|
serialized_session_data = self.serializer.encode(session)
|
|
|
|
self.store.update_item(
|
|
Key={
|
|
"id": store_id,
|
|
},
|
|
UpdateExpression="SET val = :value, expiration = :exp",
|
|
ExpressionAttributeValues={
|
|
":value": serialized_session_data,
|
|
":exp": Decimal(storage_expiration_datetime.timestamp()),
|
|
},
|
|
)
|