mirror of
https://github.com/langgenius/dify.git
synced 2026-05-09 04:36:31 +08:00
Type and lint pass over the openapi controllers, auth pipeline, and
oauth bearer/device-flow plumbing. Down from 36 pyright errors and 16
ruff errors to 0/0; 93 openapi unit tests pass.
Logic fixes:
- libs/oauth_bearer.py: drop private-naming on the friend-API methods
consumed by _VariantResolver (cache_get / cache_set_positive /
cache_set_negative / hard_expire / session_factory). They were always
cross-class accessors — leading underscore was misleading. Add public
registry property on BearerAuthenticator. _hard_expire row_id widened
to UUID | str (matches the StringUUID column type).
- libs/oauth_bearer.py: type validate_bearer / bearer_feature_required
with ParamSpec / PEP-695 so wrapped routes preserve their signature.
- libs/rate_limit.py: same — typed rate_limit decorator.
- services/oauth_device_flow.py: mint_oauth_token / _upsert accept
Session | scoped_session (Flask-SQLAlchemy proxy). Guard row-is-None
after upsert.
- controllers/openapi/{chat,completion,workflow}_messages.py: tuple-vs-
Mapping shape narrowing on AppGenerateService.generate return —
production returns Mapping, tests mock as (body, status). Validate
through Pydantic Response model in both shapes.
- controllers/openapi/oauth_device.py: replace flask_restx.reqparse (banned)
with Pydantic Request/Query models — DeviceCodeRequest, DevicePollRequest,
DeviceLookupQuery, DeviceMutateRequest. Two PEP-695 generic helpers
(_validate_json / _validate_query) translate ValidationError to BadRequest.
- controllers/openapi/auth/strategies.py: Protocol param-name match
(subject_type), Optional narrowing on app/tenant/account_id/subject_email.
- controllers/openapi/auth/steps.py: subject_type-is-None guard before
mounter dispatch.
- core/app/apps/workflow/generate_task_pipeline.py + models/workflow.py:
add WorkflowAppLogCreatedFrom.OPENAPI + matching match-case branch.
Fixes match-exhaustiveness and possibly-unbound created_from.
- libs/device_flow_security.py: pyright ignore on flask after_request
hook (registered by the framework, pyright sees as unused).
- services/oauth_device_flow.py: rename Exceptions to *Error suffix
(StateNotFoundError / InvalidTransitionError / UserCodeExhaustedError);
same for libs/oauth_bearer.py (InvalidBearerError / TokenExpiredError).
Update all callers across openapi controllers.
- controllers/openapi/{oauth_device,oauth_device_sso}.py +
services/oauth_device_flow.py: switch logger.error in except blocks
to logger.exception (TRY400) — keeps the traceback for ops.
- configs/feature/__init__.py: OPENAPI_KNOWN_CLIENT_IDS computed_field
needs an @property alongside for pyright to see it as a value, not a
method. Matches the existing line-451 pattern.
Plus ruff format + import-sort across the openapi tree (pure formatting).
116 lines
3.7 KiB
Python
116 lines
3.7 KiB
Python
"""Pipeline steps. Each is one responsibility.
|
|
|
|
BearerCheck is the only step that touches the token registry; downstream
|
|
steps see only the populated Context.
|
|
"""
|
|
|
|
from __future__ import annotations
|
|
|
|
from collections.abc import Callable
|
|
|
|
from werkzeug.exceptions import BadRequest, Forbidden, NotFound, Unauthorized
|
|
|
|
from controllers.openapi.auth.context import Context
|
|
from controllers.openapi.auth.strategies import AppAuthzStrategy, CallerMounter
|
|
from extensions.ext_database import db
|
|
from libs.oauth_bearer import TokenExpiredError, get_authenticator, sha256_hex
|
|
from models import App, Tenant, TenantStatus
|
|
|
|
|
|
def _registry():
|
|
return get_authenticator().registry
|
|
|
|
|
|
def _extract_bearer(req) -> str | None:
|
|
auth = req.headers.get("Authorization")
|
|
if not auth or not auth.lower().startswith("bearer "):
|
|
return None
|
|
return auth.split(None, 1)[1].strip() or None
|
|
|
|
|
|
def _hash_token(token: str) -> str:
|
|
return sha256_hex(token)
|
|
|
|
|
|
class BearerCheck:
|
|
"""Resolve bearer → populate identity fields."""
|
|
|
|
def __call__(self, ctx: Context) -> None:
|
|
token = _extract_bearer(ctx.request)
|
|
if not token:
|
|
raise Unauthorized("bearer required")
|
|
|
|
kind = _registry().find(token)
|
|
if kind is None:
|
|
raise Unauthorized("invalid bearer prefix")
|
|
|
|
try:
|
|
row = kind.resolver.resolve(_hash_token(token))
|
|
except TokenExpiredError:
|
|
raise Unauthorized("token expired")
|
|
if row is None:
|
|
raise Unauthorized("invalid bearer")
|
|
|
|
ctx.subject_type = kind.subject_type
|
|
ctx.subject_email = row.subject_email
|
|
ctx.subject_issuer = row.subject_issuer
|
|
ctx.account_id = row.account_id
|
|
ctx.scopes = kind.scopes
|
|
ctx.source = kind.source
|
|
ctx.token_id = row.token_id
|
|
ctx.expires_at = row.expires_at
|
|
|
|
|
|
class ScopeCheck:
|
|
"""Verify ctx.scopes (already populated by BearerCheck) covers required."""
|
|
|
|
def __call__(self, ctx: Context) -> None:
|
|
if "full" in ctx.scopes or ctx.required_scope in ctx.scopes:
|
|
return
|
|
raise Forbidden("insufficient_scope")
|
|
|
|
|
|
class AppResolver:
|
|
"""Read app_id from request.view_args, populate ctx.app + ctx.tenant.
|
|
|
|
Every endpoint using APP_PIPELINE must declare ``<string:app_id>`` in
|
|
its route — that is the design lock-in (no body / header coupling).
|
|
"""
|
|
|
|
def __call__(self, ctx: Context) -> None:
|
|
app_id = (ctx.request.view_args or {}).get("app_id")
|
|
if not app_id:
|
|
raise BadRequest("app_id is required in path")
|
|
app = db.session.get(App, app_id)
|
|
if not app or app.status != "normal":
|
|
raise NotFound("app not found")
|
|
if not app.enable_api:
|
|
raise Forbidden("service_api_disabled")
|
|
tenant = db.session.get(Tenant, app.tenant_id)
|
|
if tenant is None or tenant.status == TenantStatus.ARCHIVE:
|
|
raise Forbidden("workspace unavailable")
|
|
ctx.app, ctx.tenant = app, tenant
|
|
|
|
|
|
class AppAuthzCheck:
|
|
def __init__(self, resolve_strategy: Callable[[], AppAuthzStrategy]) -> None:
|
|
self._resolve = resolve_strategy
|
|
|
|
def __call__(self, ctx: Context) -> None:
|
|
if not self._resolve().authorize(ctx):
|
|
raise Forbidden("subject_no_app_access")
|
|
|
|
|
|
class CallerMount:
|
|
def __init__(self, *mounters: CallerMounter) -> None:
|
|
self._mounters = mounters
|
|
|
|
def __call__(self, ctx: Context) -> None:
|
|
if ctx.subject_type is None:
|
|
raise Unauthorized("subject_type unset — BearerCheck did not run")
|
|
for m in self._mounters:
|
|
if m.applies_to(ctx.subject_type):
|
|
m.mount(ctx)
|
|
return
|
|
raise Unauthorized("no caller mounter for subject type")
|