认证与访问控制¶

from langgraph_sdk import Auth

auth = Auth()

@auth.authenticate
async def authenticate(headers: dict) -> Auth.types.MinimalUserDict:
    # 验证凭证（例如 API 密钥、JWT 令牌）
    api_key = headers.get("x-api-key")
    if not api_key or not is_valid_key(api_key):
        raise Auth.exceptions.HTTPException(
            status_code=401,
            detail="Invalid API key"
        )

    # 返回用户信息 - 仅 identity 和 is_authenticated 是必需的
    # 添加任何你用于授权的额外字段
    return {
        "identity": "user-123",        # 必需：唯一的用户标识符
        "is_authenticated": True,      # 可选：默认为 True
        "permissions": ["read", "write"] # 可选：基于权限的认证
        # 你可以添加更多自定义字段以实现其他认证模式
        "role": "admin",
        "org_id": "org-456"

    }

@auth.on
async def add_owner(
    ctx: Auth.types.AuthContext,
    value: dict  # 发送到此访问方法的负载
) -> dict:  # 返回一个限制资源访问的过滤字典
    """授权对线程、运行、定时任务和助手的所有访问。

    此处理程序执行以下两项操作：
        - 向资源元数据中添加值（以便与资源一起保存，以便以后进行过滤）
        - 返回一个过滤器（以限制对现有资源的访问）

    参数：
        ctx: 包含用户信息、权限、路径的认证上下文
        value: 发送到端点的请求负载。对于创建操作，这包含资源参数。对于读取操作，这包含正在访问的资源。

    返回：
        LangGraph 使用的过滤字典，用于限制对资源的访问。
        有关支持的操作符，请参见 [过滤操作](#filter-operations)。
    """
    # 创建过滤器，仅限制访问该用户的资源
    filters = {"owner": ctx.user.identity}

    # 获取或在负载中创建元数据字典
    # 这里我们存储关于资源的持久信息
    metadata = value.setdefault("metadata", {})

    # 向元数据中添加所有者 - 如果这是创建或更新操作，
    # 这些信息将与资源一起保存
    # 因此，我们可以在读取操作中通过它进行过滤
    metadata.update(filters)

    # 返回过滤器以限制访问
    # 这些过滤器应用于所有操作（创建、读取、更新、搜索等）
    # 以确保用户只能访问自己的资源
    return filters

# 通用 / 全局处理程序捕获未被更具体处理程序处理的请求
@auth.on
async def reject_unhandled_requests(ctx: Auth.types.AuthContext, value: Any) -> False:
    print(f"请求 {ctx.path} 由 {ctx.user.identity}")
    raise Auth.exceptions.HTTPException(
        status_code=403,
        detail="Forbidden"
    )

# 匹配 "thread" 资源和所有操作 - 创建、读取、更新、删除、搜索
# 由于这个处理程序比通用的 @auth.on 处理程序更具体，
# 它将在所有 "threads" 资源的操作中优先于通用处理程序
@auth.on.threads
async def on_thread_create(
    ctx: Auth.types.AuthContext,
    value: Auth.types.threads.create.value
):
    if "write" not in ctx.permissions:
        raise Auth.exceptions.HTTPException(
            status_code=403,
            detail="User lacks the required permissions."
        )
    # 在创建的线程上设置元数据
    # 将确保资源包含一个 "owner" 字段
    # 然后每次用户尝试访问此线程或线程内的运行时，
    # 我们都可以按所有者进行过滤
    metadata = value.setdefault("metadata", {})
    metadata["owner"] = ctx.user.identity
    return {"owner": ctx.user.identity}

# 线程创建。这将只匹配线程创建操作
# 由于这个处理程序比通用的 @auth.on 处理程序和 @auth.on.threads 处理程序都更具体，
# 它将在所有 "threads" 资源的 "create" 操作中优先于这两个处理程序
@auth.on.threads.create
async def on_thread_create(
    ctx: Auth.types.AuthContext,
    value: Auth.types.threads.create.value
):
    # 在创建的线程上设置元数据
    # 将确保资源包含一个 "owner" 字段
    # 然后每次用户尝试访问此线程或线程内的运行时，
    # 我们都可以按所有者进行过滤
    metadata = value.setdefault("metadata", {})
    metadata["owner"] = ctx.user.identity
    return {"owner": ctx.user.identity}

# 读取线程。由于这也比通用的 @auth.on 处理程序和 @auth.on.threads 处理程序更具体，
# 它将在所有 "threads" 资源的 "read" 操作中优先于这两个处理程序
@auth.on.threads.read
async def on_thread_read(
    ctx: Auth.types.AuthContext,
    value: Auth.types.threads.read.value
):
    # 由于我们正在读取（而不是创建）线程，
    # 我们不需要设置元数据。我们只需要
    # 返回一个过滤器，以确保用户只能看到他们自己的线程
    return {"owner": ctx.user.identity}

# 运行创建、流式传输、更新等
# 这个处理程序将优先于通用的 @auth.on 处理程序和 @auth.on.threads 处理程序
@auth.on.threads.create_run
async def on_run_create(
    ctx: Auth.types.AuthContext,
    value: Auth.types.threads.create_run.value
):
    metadata = value.setdefault("metadata", {})
    metadata["owner"] = ctx.user.identity
    # 继承线程的访问控制
    return {"owner": ctx.user.identity}

# 助手创建
@auth.on.assistants.create
async def on_assistant_create(
    ctx: Auth.types.AuthContext,
    value: Auth.types.assistants.create.value
):
    if "assistants:create" not in ctx.permissions:
        raise Auth.exceptions.HTTPException(
            status_code=403,
            detail="User lacks the required permissions."
        )

@auth.on
async def owner_only(ctx: Auth.types.AuthContext, value: dict):
    metadata = value.setdefault("metadata", {})
    metadata["owner"] = ctx.user.identity
    return {"owner": ctx.user.identity}

# 在你的认证处理程序中：
@auth.authenticate
async def authenticate(headers: dict) -> Auth.types.MinimalUserDict:
    ...
    return {
        "identity": "user-123",
        "is_authenticated": True,
        "permissions": ["threads:write", "threads:read"]  # 在认证中定义权限
    }

def _default(ctx: Auth.types.AuthContext, value: dict):
    metadata = value.setdefault("metadata", {})
    metadata["owner"] = ctx.user.identity
    return {"owner": ctx.user.identity}

@auth.on.threads.create
async def create_thread(ctx: Auth.types.AuthContext, value: dict):
    if "threads:write" not in ctx.permissions:
        raise Auth.exceptions.HTTPException(
            status_code=403,
            detail="Unauthorized"
        )
    return _default(ctx, value)


@auth.on.threads.read
async def rbac_create(ctx: Auth.types.AuthContext, value: dict):
    if "threads:read" not in ctx.permissions and "threads:write" not in ctx.permissions:
        raise Auth.exceptions.HTTPException(
            status_code=403,
            detail="Unauthorized"
        )
    return _default(ctx, value)