From e05419ebe9cf1daddc30f7042467262a62748ff1 Mon Sep 17 00:00:00 2001 From: sam Date: Wed, 10 Apr 2024 21:03:01 +0200 Subject: [PATCH] oh no --- .gitignore | 18 +++++------ foxnouns/auth.py | 24 -------------- foxnouns/blueprints/v2/auth/discord.py | 6 ++-- foxnouns/blueprints/v2/members.py | 2 +- foxnouns/blueprints/v2/users.py | 2 +- foxnouns/decorators.py | 45 ++++++++++++++++++++++++++ foxnouns/exceptions.py | 11 +++++++ foxnouns/settings.py | 4 +++ 8 files changed, 75 insertions(+), 37 deletions(-) delete mode 100644 foxnouns/auth.py create mode 100644 foxnouns/decorators.py diff --git a/.gitignore b/.gitignore index 1a4e9b5..d282cad 100644 --- a/.gitignore +++ b/.gitignore @@ -1,9 +1,9 @@ -__pycache__/ -.pytest_cache/ -.env -node_modules -build -.svelte-kit -package -vite.config.js.timestamp-* -vite.config.ts.timestamp-* +__pycache__/ +.pytest_cache/ +.env +node_modules +build +.svelte-kit +package +vite.config.js.timestamp-* +vite.config.ts.timestamp-* diff --git a/foxnouns/auth.py b/foxnouns/auth.py deleted file mode 100644 index 83d2765..0000000 --- a/foxnouns/auth.py +++ /dev/null @@ -1,24 +0,0 @@ -from functools import wraps - -from quart import g - -from foxnouns.exceptions import ErrorCode, ForbiddenError - - -def require_auth(*, scope: str | None = None): - def decorator(func): - @wraps(func) - async def wrapper(*args, **kwargs): - if "user" not in g or "token" not in g: - raise ForbiddenError("Not authenticated", type=ErrorCode.Forbidden) - - if scope and not g.token.has_scope(scope): - raise ForbiddenError( - f"Missing scope '{scope}'", type=ErrorCode.MissingScope - ) - - return await func(*args, **kwargs) - - return wrapper - - return decorator diff --git a/foxnouns/blueprints/v2/auth/discord.py b/foxnouns/blueprints/v2/auth/discord.py index 5f873b7..f641490 100644 --- a/foxnouns/blueprints/v2/auth/discord.py +++ b/foxnouns/blueprints/v2/auth/discord.py @@ -1,14 +1,16 @@ from quart import Blueprint from quart_schema import validate_request, validate_response -from foxnouns.settings import BASE_DOMAIN +from foxnouns import settings +from foxnouns.decorators import require_config_key from . import BaseCallbackResponse, OAuthCallbackRequest bp = Blueprint("discord_v2", __name__) -@bp.post("/api/v2/auth/discord/callback", host=BASE_DOMAIN) +@bp.post("/api/v2/auth/discord/callback", host=settings.BASE_DOMAIN) +@require_config_key(keys=[settings.DISCORD_CLIENT_ID, settings.DISCORD_CLIENT_SECRET]) @validate_request(OAuthCallbackRequest) @validate_response(BaseCallbackResponse) async def discord_callback(data: OAuthCallbackRequest): diff --git a/foxnouns/blueprints/v2/members.py b/foxnouns/blueprints/v2/members.py index 613fa35..b8f541b 100644 --- a/foxnouns/blueprints/v2/members.py +++ b/foxnouns/blueprints/v2/members.py @@ -3,7 +3,7 @@ from quart import Blueprint, g from quart_schema import validate_request, validate_response from foxnouns import tasks -from foxnouns.auth import require_auth +from foxnouns.decorators import require_auth from foxnouns.db import Member from foxnouns.db.aio import async_session from foxnouns.db.util import user_from_ref diff --git a/foxnouns/blueprints/v2/users.py b/foxnouns/blueprints/v2/users.py index 2f42cfd..9bd7042 100644 --- a/foxnouns/blueprints/v2/users.py +++ b/foxnouns/blueprints/v2/users.py @@ -4,7 +4,7 @@ from quart_schema import validate_request, validate_response from sqlalchemy import select from foxnouns import tasks -from foxnouns.auth import require_auth +from foxnouns.decorators import require_auth from foxnouns.db import User from foxnouns.db.aio import async_session from foxnouns.db.snowflake import Snowflake diff --git a/foxnouns/decorators.py b/foxnouns/decorators.py new file mode 100644 index 0000000..61368b6 --- /dev/null +++ b/foxnouns/decorators.py @@ -0,0 +1,45 @@ +from typing import Any +from functools import wraps + +from quart import g + +from foxnouns.exceptions import ErrorCode, ForbiddenError, UnsupportedEndpointError + + +def require_auth(*, scope: str | None = None): + """Decorator that requires a token with the given scopes. + If no token is given or the required scopes aren't set on it, execution is aborted.""" + + def decorator(func): + @wraps(func) + async def wrapper(*args, **kwargs): + if "user" not in g or "token" not in g: + raise ForbiddenError("Not authenticated", type=ErrorCode.Forbidden) + + if scope and not g.token.has_scope(scope): + raise ForbiddenError( + f"Missing scope '{scope}'", type=ErrorCode.MissingScope + ) + + return await func(*args, **kwargs) + + return wrapper + + return decorator + + +def require_config_key(*, keys: list[Any]): + """Decorator that requires one or more config keys to be set. + If any of them are None, execution is aborted.""" + + def decorator(func): + @wraps(func) + async def wrapper(*args, **kwargs): + for key in keys: + if not key: + raise UnsupportedEndpointError() + return await func(*args, **kwargs) + + return wrapper + + return decorator diff --git a/foxnouns/exceptions.py b/foxnouns/exceptions.py index 63739cc..832a3ec 100644 --- a/foxnouns/exceptions.py +++ b/foxnouns/exceptions.py @@ -80,3 +80,14 @@ class ForbiddenError(ExpectedError): def __init__(self, msg: str, type=ErrorCode.Forbidden): self.type = type super().__init__(msg, type) + + +class UnsupportedEndpointError(ExpectedError): + status_code = 404 + + def __init__(self): + self.type = ErrorCode.NotFound + super().__init__( + "Endpoint is not supported on this instance", + type=ErrorCode.NotFound, + ) diff --git a/foxnouns/settings.py b/foxnouns/settings.py index 480243d..b89d796 100644 --- a/foxnouns/settings.py +++ b/foxnouns/settings.py @@ -27,6 +27,10 @@ with env.prefixed("MINIO_"): "REGION": env("REGION", "auto"), } +# Discord OAuth credentials. If these are not set the Discord OAuth endpoints will not work. +DISCORD_CLIENT_ID = env("DISCORD_CLIENT_ID", None) +DISCORD_CLIENT_SECRET = env("DISCORD_CLIENT_SECRET", None) + # The base domain the API is served on. This must be set. BASE_DOMAIN = env("BASE_DOMAIN") # The base domain for short URLs.