434 lines
15 KiB
Python
434 lines
15 KiB
Python
import base64
|
|
import hashlib
|
|
import re
|
|
import imghdr
|
|
import uuid
|
|
import zlib
|
|
|
|
import bcrypt
|
|
from uuid import UUID
|
|
|
|
import validators
|
|
from fastapi import APIRouter as FastAPI, Depends, Response, Request, UploadFile
|
|
from fastapi.exceptions import HTTPException
|
|
from fastapi.security import OAuth2PasswordRequestForm
|
|
from datetime import timedelta
|
|
from pathlib import Path
|
|
|
|
from config import (
|
|
BCRYPT_ROUNDS,
|
|
LOGGER,
|
|
SESSION_EXPIRE_LIMIT,
|
|
COOKIE_SAMESITE_POLICY,
|
|
COOKIE_DOMAIN,
|
|
MANAGER,
|
|
SESSION_COOKIE_NAME,
|
|
LIMITER,
|
|
VALIDATE_PASSWORD_REGEX,
|
|
VALIDATE_USERNAME_REGEX,
|
|
SECURE_COOKIE,
|
|
COOKIE_PATH,
|
|
COOKIE_HTTPONLY,
|
|
ALLOWED_MEDIA_TYPES,
|
|
ZLIB_COMPRESSION_LEVEL,
|
|
MAX_MEDIA_SIZE,
|
|
STORAGE_ENGINE,
|
|
STORAGE_FOLDER
|
|
)
|
|
from orm.users import UserModel, User
|
|
from orm.media import Media, MediaType
|
|
|
|
router = FastAPI()
|
|
|
|
|
|
async def get_user_by_id(
|
|
public_id: UUID, include_secrets: bool = False, restricted_ok: bool = False,
|
|
deleted_ok: bool = False
|
|
) -> dict | None:
|
|
"""
|
|
Retrieves a user by its public ID
|
|
"""
|
|
|
|
user = (
|
|
await User.select(
|
|
*User.all_columns(exclude=["public_id"]),
|
|
User.public_id.as_alias("id"),
|
|
exclude_secrets=not include_secrets,
|
|
)
|
|
.where(User.public_id == public_id)
|
|
.first()
|
|
)
|
|
if user:
|
|
# Performs validation
|
|
UserModel(**user)
|
|
if (user["deleted"] and not deleted_ok) or (user["restricted"] and not restricted_ok):
|
|
return
|
|
return user
|
|
return
|
|
|
|
|
|
@MANAGER.user_loader()
|
|
async def get_self_by_id(public_id: UUID) -> dict:
|
|
return await get_user_by_id(public_id, include_secrets=True, restricted_ok=True)
|
|
|
|
|
|
async def get_user_by_username(
|
|
username: str, include_secrets: bool = False, restricted_ok: bool = False,
|
|
deleted_ok: bool = False
|
|
) -> dict | None:
|
|
"""
|
|
Retrieves a user by its public username
|
|
"""
|
|
|
|
user = (
|
|
await User.select(
|
|
*User.all_columns(exclude=["public_id"]),
|
|
User.public_id.as_alias("id"),
|
|
exclude_secrets=not include_secrets,
|
|
)
|
|
.where(User.username == username)
|
|
.first()
|
|
)
|
|
if user:
|
|
# Performs validation
|
|
UserModel(**user)
|
|
if (user["deleted"] and not deleted_ok) or (user["restricted"] and not restricted_ok):
|
|
return
|
|
return user
|
|
return
|
|
|
|
|
|
async def get_user_by_email(
|
|
email: str, include_secrets: bool = False, restricted_ok: bool = False,
|
|
deleted_ok: bool = False
|
|
) -> dict | None:
|
|
"""
|
|
Retrieves a user by its email address (meant to
|
|
be used internally)
|
|
"""
|
|
|
|
user = (
|
|
await User.select(
|
|
*User.all_columns(exclude=["public_id"]),
|
|
User.public_id.as_alias("id"),
|
|
exclude_secrets=not include_secrets,
|
|
)
|
|
.where(User.email_address == email)
|
|
.first()
|
|
)
|
|
if user:
|
|
# Performs validation
|
|
UserModel(**user)
|
|
if (user["deleted"] and not deleted_ok) or (user["restricted"] and not restricted_ok):
|
|
return
|
|
return user
|
|
return
|
|
|
|
|
|
@LIMITER.limit("5/minute")
|
|
@router.post("/user")
|
|
async def login(
|
|
request: Request, response: Response, data: OAuth2PasswordRequestForm = Depends()
|
|
) -> dict:
|
|
if request.cookies.get(SESSION_COOKIE_NAME):
|
|
raise HTTPException(status_code=400, detail="Please logout first")
|
|
username = data.username
|
|
if len(username) > 32:
|
|
raise HTTPException(
|
|
status_code=413, detail="Authentication failed: username is too long"
|
|
)
|
|
try:
|
|
password = data.password.encode()
|
|
if len(password) > 72:
|
|
raise HTTPException(
|
|
status_code=413, detail="Authentication failed: password is too long"
|
|
)
|
|
except UnicodeEncodeError as e:
|
|
LOGGER.warning(
|
|
f"An error occurred while attempting to decode password for user {username} -> {type(e).__name__}: {e}"
|
|
)
|
|
raise HTTPException(
|
|
status_code=413,
|
|
detail="Authentication failed: invalid characters in password",
|
|
)
|
|
if not (
|
|
user := await get_user_by_username(
|
|
username, include_secrets=True, restricted_ok=True
|
|
)
|
|
):
|
|
raise HTTPException(
|
|
status_code=413,
|
|
detail="Authentication failed: the user does not exist",
|
|
)
|
|
if not bcrypt.checkpw(password, user["password_hash"]):
|
|
raise HTTPException(
|
|
status_code=413,
|
|
detail="Authentication failed: password mismatch",
|
|
)
|
|
token = MANAGER.create_access_token(
|
|
expires=timedelta(seconds=SESSION_EXPIRE_LIMIT), data={"sub": str(user["id"])}
|
|
)
|
|
response.set_cookie(
|
|
secure=SECURE_COOKIE,
|
|
key=SESSION_COOKIE_NAME,
|
|
max_age=SESSION_EXPIRE_LIMIT,
|
|
value=token,
|
|
httponly=COOKIE_HTTPONLY,
|
|
samesite=COOKIE_SAMESITE_POLICY,
|
|
domain=COOKIE_DOMAIN or None,
|
|
path=COOKIE_PATH or "/",
|
|
)
|
|
return {"status_code": 200, "msg": "Authentication successful"}
|
|
|
|
|
|
@router.get("/user/logout")
|
|
@LIMITER.limit("5/minute")
|
|
async def logout(
|
|
request: Request, response: Response, user: dict = Depends(MANAGER)
|
|
) -> dict:
|
|
"""
|
|
Deletes a user's session cookie, logging them
|
|
out
|
|
"""
|
|
|
|
response.delete_cookie(
|
|
secure=SECURE_COOKIE,
|
|
key=SESSION_COOKIE_NAME,
|
|
httponly=COOKIE_HTTPONLY,
|
|
samesite=COOKIE_SAMESITE_POLICY,
|
|
domain=COOKIE_DOMAIN or None,
|
|
path=COOKIE_PATH or "/",
|
|
)
|
|
return {"status_code": 200, "msg": "Logged out"}
|
|
|
|
|
|
@router.get("/user/me")
|
|
@LIMITER.limit("2/second")
|
|
async def get_self(request: Request, user: dict = Depends(MANAGER)) -> dict:
|
|
"""
|
|
Fetches a user's own info. This returns some
|
|
extra data such as email address, account
|
|
creation date and email verification status,
|
|
which is not available from the regular endpoint
|
|
"""
|
|
|
|
user.pop("password_hash")
|
|
user.pop("internal_id")
|
|
user.pop("deleted")
|
|
return {"status_code": 200, "msg": "Success", "data": user}
|
|
|
|
|
|
@router.get("/user/username/{username}")
|
|
@LIMITER.limit("30/second")
|
|
async def get_user_by_name(
|
|
request: Request, username: str, _auth: dict = Depends(MANAGER)
|
|
) -> dict:
|
|
"""
|
|
Fetches a single user by its public ID
|
|
"""
|
|
|
|
if not (user := await get_user_by_username(username)):
|
|
return {
|
|
"status_code": 404,
|
|
"msg": "Lookup failed: the user does not exist",
|
|
}
|
|
user.pop("restricted")
|
|
user.pop("deleted")
|
|
return {"status_code": 200, "msg": "Lookup successful", "data": user}
|
|
|
|
|
|
@router.get("/user/id/{public_id}")
|
|
@LIMITER.limit("30/second")
|
|
async def get_user_by_public_id(
|
|
request: Request, public_id: str, _auth: dict = Depends(MANAGER)
|
|
) -> dict:
|
|
"""
|
|
Fetches a single user by its public ID
|
|
"""
|
|
|
|
if not (user := await get_user_by_id(UUID(public_id))):
|
|
raise HTTPException(
|
|
status_code=404, detail="Lookup failed: the user does not exist"
|
|
)
|
|
user.pop("restricted")
|
|
user.pop("deleted")
|
|
return {"status_code": 200, "msg": "Lookup successful", "data": user}
|
|
|
|
|
|
async def validate_user(
|
|
first_name: str, last_name: str, username: str, email: str, password: str | None
|
|
) -> tuple[bool, str]:
|
|
"""
|
|
Performs some validation upon user creation. Returns
|
|
a tuple (success, msg) to be used by routes. Values
|
|
set to None are not checked against
|
|
"""
|
|
|
|
if first_name and len(first_name) > 64:
|
|
return False, "first name is too long"
|
|
if first_name and len(first_name) < 5:
|
|
return False, "first name is too short"
|
|
if last_name and len(last_name) > 64:
|
|
return False, "last name is too long"
|
|
if last_name and len(last_name) < 2:
|
|
return False, "last name is too short"
|
|
if username and len(username) < 5:
|
|
return False, "username is too short"
|
|
if username and len(username) > 32:
|
|
return False, "username is too long"
|
|
if username and VALIDATE_USERNAME_REGEX and not re.match(VALIDATE_USERNAME_REGEX, username):
|
|
return False, "username is invalid"
|
|
if email and not validators.email(email):
|
|
return False, "email is not valid"
|
|
if password and len(password) > 72:
|
|
return False, "password is too long"
|
|
if password and VALIDATE_PASSWORD_REGEX and not re.match(VALIDATE_PASSWORD_REGEX, password):
|
|
return False, "password is too weak"
|
|
if username and await get_user_by_username(username, deleted_ok=True, restricted_ok=True):
|
|
return False, "username is already taken"
|
|
if email and await get_user_by_email(email, deleted_ok=True, restricted_ok=True):
|
|
return False, "email is already registered"
|
|
return True, ""
|
|
|
|
|
|
@router.delete("/user")
|
|
@LIMITER.limit("1/minute")
|
|
async def delete(request: Request, response: Response, user: dict = Depends(MANAGER)) -> dict:
|
|
"""
|
|
Sets the user's deleted flag in the database,
|
|
without actually deleting the associated
|
|
data
|
|
"""
|
|
|
|
await User.update({User.deleted: True}).where(User.public_id == user["id"])
|
|
response.delete_cookie(
|
|
secure=SECURE_COOKIE,
|
|
key=SESSION_COOKIE_NAME,
|
|
httponly=COOKIE_HTTPONLY,
|
|
samesite=COOKIE_SAMESITE_POLICY,
|
|
domain=COOKIE_DOMAIN or None,
|
|
path=COOKIE_PATH or "/",)
|
|
return {"status_code": 200, "msg": "Success"}
|
|
|
|
|
|
@router.put("/user")
|
|
@LIMITER.limit("2/minute")
|
|
async def signup(
|
|
request: Request,
|
|
first_name: str,
|
|
last_name: str,
|
|
username: str,
|
|
email: str,
|
|
password: str,
|
|
) -> dict:
|
|
"""
|
|
Endpoint used to create new users
|
|
"""
|
|
|
|
if request.cookies.get(SESSION_COOKIE_NAME):
|
|
raise HTTPException(status_code=400, detail="Please logout first")
|
|
# We don't use FastAPI's validation because we want custom error
|
|
# messages
|
|
result, msg = await validate_user(first_name, last_name, username, email, password)
|
|
if not result:
|
|
return {"status_code": 413, "msg": f"Signup failed: {msg}"}
|
|
else:
|
|
await User.insert(
|
|
User(
|
|
first_name=first_name,
|
|
last_name=last_name,
|
|
username=username,
|
|
email_address=email,
|
|
password_hash=bcrypt.hashpw(
|
|
password.encode(), bcrypt.gensalt(BCRYPT_ROUNDS)
|
|
),
|
|
)
|
|
)
|
|
return {"status_code": 200, "msg": "Success"}
|
|
|
|
|
|
async def validate_profile_picture(file: UploadFile) -> tuple[bool | None, str, bytes, str]:
|
|
"""
|
|
Validates a profile picture's size and content to see if it fits
|
|
our criteria and returns a tuple result, ext, data where result is a
|
|
boolean or none (True = check was passed, False = size too large,
|
|
None = check was failed for other reasons) indicating if the check was successful,
|
|
ext is the file's type and extension, data is a compressed stream of bytes
|
|
representing the original media and hash is the file's SHA256 hash encoded in
|
|
hexadecimal, before the compression. This function never raises an exception
|
|
"""
|
|
|
|
async with file:
|
|
try:
|
|
content = await file.read()
|
|
if len(content) > MAX_MEDIA_SIZE:
|
|
return False, "", b"", ""
|
|
if not (ext := imghdr.what(content.decode())) in ALLOWED_MEDIA_TYPES:
|
|
return None, "", b"", ""
|
|
return True, ext, zlib.compress(content, ZLIB_COMPRESSION_LEVEL), hashlib.sha256(content).hexdigest()
|
|
except (UnicodeDecodeError, zlib.error):
|
|
return None, "", b"", ""
|
|
|
|
|
|
@router.patch("/user")
|
|
async def update(request: Request, user: dict = Depends(MANAGER),
|
|
first_name: str | None = None, last_name: str | None = None,
|
|
username: str | None = None, profile_picture: UploadFile | None = None,
|
|
email_address: str | None = None, bio: str | None = None):
|
|
"""
|
|
Updates a user's profile information. Parameters that are not specified are left unchanged.
|
|
At least one parameter has to be non-null. Setting a new email address is only allowed if the
|
|
old one is verified and will require the user to click a link sent to the current email address
|
|
to authorize the operation, after which the address is modified.
|
|
"""
|
|
|
|
if not any((first_name, last_name, username, profile_picture, email_address, bio)):
|
|
raise HTTPException(status_code=400, detail="At least one value has to be specified")
|
|
result, msg = await validate_user(first_name, last_name, username, email_address, None)
|
|
if not result:
|
|
raise HTTPException(status_code=413, detail=f"Update failed: {msg}")
|
|
orig_user = user.copy()
|
|
if first_name:
|
|
user["first_name"] = first_name
|
|
if last_name:
|
|
user["last_name"] = last_name
|
|
if username:
|
|
user["username"] = username
|
|
if profile_picture:
|
|
result, ext, media, digest = validate_profile_picture(profile_picture)
|
|
if result is False:
|
|
raise HTTPException(status_code=415, detail="The file type is unsupported")
|
|
elif result is None:
|
|
raise HTTPException(status_code=413, detail="The file is too large")
|
|
elif await (old_media := Media.select(Media.media_id).where(Media.media_id == digest).first()) is None:
|
|
# This media hasn't been already uploaded (either by this user or by someone
|
|
# else), so we save it now. If it has been already uploaded, there's no need
|
|
# to do it again (that's what the hash is for)
|
|
match STORAGE_ENGINE:
|
|
case "database":
|
|
await Media.insert(Media(media_id=digest, media_type=MediaType.BLOB,
|
|
content_type=ext, content=base64.b64encode(media)))
|
|
case "local":
|
|
file = Path(STORAGE_FOLDER).resolve(strict=True) / str(digest)
|
|
file.touch(mode=0o644)
|
|
with file.open("wb") as f:
|
|
f.write(media)
|
|
await Media.insert(Media(media_id=digest, media_type=MediaType.FILE,
|
|
content_type=ext, content=file.as_posix()))
|
|
case "url":
|
|
pass # TODO: Use/implement CDN uploading
|
|
else:
|
|
user["media"] = old_media
|
|
if email_address:
|
|
if not user["email_verified"]:
|
|
raise HTTPException(status_code=403, detail="The email address needs to be verified first")
|
|
pass # TODO: Requires email verification
|
|
fields = []
|
|
for field in user:
|
|
if field != "email_address" and orig_user[field] != user[field]:
|
|
fields.append((field, user[field]))
|
|
if fields:
|
|
# If anything has changed, we update our info
|
|
await User.update({field: value for field, value in fields}).where(User.public_id == user["id"])
|
|
return {"status_code": 200, "msg": "Changes saved successfully"}
|