browsertrix/backend/users.py

148 lines
3.5 KiB
Python

"""
FastAPI user handling (via fastapi-users)
"""
import os
import uuid
from datetime import datetime
from typing import Dict, Optional
from enum import IntEnum
from pydantic import BaseModel, UUID4
from fastapi_users import FastAPIUsers, models
from fastapi_users.authentication import JWTAuthentication
from fastapi_users.db import MongoDBUserDatabase
PASSWORD_SECRET = os.environ.get("PASSWORD_SECRET", uuid.uuid4().hex)
# ============================================================================
class UserRole(IntEnum):
"""User role"""
VIEWER = 10
CRAWLER = 20
OWNER = 40
# ============================================================================
class InvitePending(BaseModel):
"""Pending Request to join an archive"""
aid: str
created: datetime
role: UserRole = UserRole.VIEWER
# ============================================================================
class User(models.BaseUser):
"""
Base User Model
"""
usage: Dict[str, int] = {}
# ============================================================================
class UserCreate(models.BaseUserCreate):
"""
User Creation Model
"""
inviteToken: Optional[str]
newArchive: bool
# ============================================================================
class UserUpdate(User, models.BaseUserUpdate):
"""
User Update Model
"""
# ============================================================================
class UserDB(User, models.BaseUserDB):
"""
User in DB Model
"""
invites: Dict[str, InvitePending] = {}
usage: Dict[str, int] = {}
# ============================================================================
class UserDBOps(MongoDBUserDatabase):
""" User DB Operations wrapper """
async def inc_usage(self, userid, amount):
""" Increment usage counter by month for this user """
yymm = datetime.utcnow().strftime("%Y-%m")
await self.collection.find_one_and_update(
{"id": UUID4(userid)}, {"$inc": {f"usage.{yymm}": amount}}
)
# ============================================================================
def init_users_api(
app,
mdb,
on_after_register=None,
on_after_forgot_password=None,
after_verification_request=None,
):
"""
Load users table and init /users routes
"""
user_collection = mdb.get_collection("users")
user_db = UserDBOps(UserDB, user_collection)
jwt_authentication = JWTAuthentication(
secret=PASSWORD_SECRET, lifetime_seconds=3600, tokenUrl="/auth/jwt/login"
)
fastapi_users = FastAPIUsers(
user_db,
[jwt_authentication],
User,
UserCreate,
UserUpdate,
UserDB,
)
app.include_router(
fastapi_users.get_auth_router(jwt_authentication),
prefix="/auth/jwt",
tags=["auth"],
)
app.include_router(
fastapi_users.get_register_router(on_after_register),
prefix="/auth",
tags=["auth"],
)
app.include_router(
fastapi_users.get_reset_password_router(
PASSWORD_SECRET, after_forgot_password=on_after_forgot_password
),
prefix="/auth",
tags=["auth"],
)
app.include_router(
fastapi_users.get_verify_router(
PASSWORD_SECRET, after_verification_request=after_verification_request
),
prefix="/auth",
tags=["auth"],
)
app.include_router(
fastapi_users.get_users_router(), prefix="/users", tags=["users"]
)
return fastapi_users