使对话私有化¶
在本教程中,你将扩展上一个教程中创建的聊天机器人,为每个用户提供他们自己的私有对话。你将添加资源级别的访问控制,以确保用户只能查看他们自己的对话线程。
先决条件¶
在开始本教程之前,请确保您已成功运行第一个教程中的机器人,且没有错误。
1. 添加资源授权¶
回想一下上一个教程中,Auth
对象允许你注册一个认证函数,LangGraph 平台会使用它来验证传入请求中的 bearer token。现在你将使用它来注册一个 授权 处理器。
授权处理器是在认证成功后运行的函数。这些处理器可以为资源添加 元数据(例如谁拥有它们),并过滤每个用户可以看到的内容。
更新你的 src/security/auth.py
文件,并添加一个在每次请求时运行的授权处理器:
from langgraph_sdk import Auth
# 保留我们上一个教程中的测试用户
VALID_TOKENS = {
"user1-token": {"id": "user1", "name": "Alice"},
"user2-token": {"id": "user2", "name": "Bob"},
}
auth = Auth()
@auth.authenticate
async def get_current_user(authorization: str | None) -> Auth.types.MinimalUserDict:
"""我们上一个教程中的认证处理器."""
assert authorization
scheme, token = authorization.split()
assert scheme.lower() == "bearer"
if token not in VALID_TOKENS:
raise Auth.exceptions.HTTPException(status_code=401, detail="Invalid token")
user_data = VALID_TOKENS[token]
return {
"identity": user_data["id"],
}
@auth.on
async def add_owner(
ctx: Auth.types.AuthContext, # 包含当前用户的信息
value: dict, # 正在创建或访问的资源
):
"""使资源仅限于其创建者."""
# 示例:
# ctx: AuthContext(
# permissions=[],
# user=ProxyUser(
# identity='user1',
# is_authenticated=True,
# display_name='user1'
# ),
# resource='threads',
# action='create_run'
# )
# value:
# {
# 'thread_id': UUID('1e1b2733-303f-4dcd-9620-02d370287d72'),
# 'assistant_id': UUID('fe096781-5601-53d2-b2f6-0d3403f7e9ca'),
# 'run_id': UUID('1efbe268-1627-66d4-aa8d-b956b0f02a41'),
# 'status': 'pending',
# 'metadata': {},
# 'prevent_insert_if_inflight': True,
# 'multitask_strategy': 'reject',
# 'if_not_exists': 'reject',
# 'after_seconds': 0,
# 'kwargs': {
# 'input': {'messages': [{'role': 'user', 'content': 'Hello!'}]},
# 'command': None,
# 'config': {
# 'configurable': {
# 'langgraph_auth_user': ... 你的用户对象 ...
# 'langgraph_auth_user_id': 'user1'
# }
# },
# 'stream_mode': ['values'],
# 'interrupt_before': None,
# 'interrupt_after': None,
# 'webhook': None,
# 'feedback_keys': None,
# 'temporary': False,
# 'subgraphs': False
# }
# }
# 主要做两件事:
# 1. 将用户的 ID 添加到资源的元数据中。每个 LangGraph 资源都有一个 `metadata` 字典,与资源一起持久化存储。
# 这个元数据对于读取和更新操作中的过滤非常有用
# 2. 返回一个过滤器,使得用户只能看到他们自己的资源
filters = {"owner": ctx.user.identity}
metadata = value.setdefault("metadata", {})
metadata.update(filters)
# 只允许用户查看他们自己的资源
return filters
该处理程序接收两个参数:
ctx
(AuthContext):包含当前user
的信息、用户的permissions
、resource
("threads", "crons", "assistants") 以及正在执行的action
("create", "read", "update", "delete", "search", "create_run")value
(dict
):正在创建或访问的数据。这个字典的内容取决于所访问的资源和操作。有关如何获取更精确的访问控制,请参见下文的 添加作用域授权处理器。
请注意,这个简单的处理程序做了两件事:
- 将用户的 ID 添加到资源的元数据中。
- 返回一个元数据过滤器,以确保用户只能看到他们拥有的资源。
2. 测试私密对话¶
测试你的授权。如果你已正确设置,你将看到所有 ✅ 消息。确保你的开发服务器正在运行(运行 langgraph dev
):
from langgraph_sdk import get_client
# 为两个用户创建客户端
alice = get_client(
url="http://localhost:2024",
headers={"Authorization": "Bearer user1-token"}
)
bob = get_client(
url="http://localhost:2024",
headers={"Authorization": "Bearer user2-token"}
)
# Alice 创建一个助手
alice_assistant = await alice.assistants.create()
print(f"✅ Alice 创建了助手: {alice_assistant['assistant_id']}")
# Alice 创建一个线程并聊天
alice_thread = await alice.threads.create()
print(f"✅ Alice 创建了线程: {alice_thread['thread_id']}")
await alice.runs.create(
thread_id=alice_thread["thread_id"],
assistant_id="agent",
input={"messages": [{"role": "user", "content": "Hi, this is Alice's private chat"}]}
)
# Bob 尝试访问 Alice 的线程
try:
await bob.threads.get(alice_thread["thread_id"])
print("❌ Bob 不应该看到 Alice 的线程!")
except Exception as e:
print("✅ Bob 正确地被拒绝访问:", e)
# Bob 创建他自己的线程
bob_thread = await bob.threads.create()
await bob.runs.create(
thread_id=bob_thread["thread_id"],
assistant_id="agent",
input={"messages": [{"role": "user", "content": "Hi, this is Bob's private chat"}]}
)
print(f"✅ Bob 创建了自己的线程: {bob_thread['thread_id']}")
# 列出线程 - 每个用户只能看到自己的
alice_threads = await alice.threads.search()
bob_threads = await bob.threads.search()
print(f"✅ Alice 看到 {len(alice_threads)} 个线程")
print(f"✅ Bob 看到 {len(bob_threads)} 个线程")
输出结果:
✅ Alice created assistant: fc50fb08-78da-45a9-93cc-1d3928a3fc37
✅ Alice created thread: 533179b7-05bc-4d48-b47a-a83cbdb5781d
✅ Bob correctly denied access: Client error '404 Not Found' for url 'http://localhost:2024/threads/533179b7-05bc-4d48-b47a-a83cbdb5781d'
For more information check: https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/404
✅ Bob created his own thread: 437c36ed-dd45-4a1e-b484-28ba6eca8819
✅ Alice sees 1 thread
✅ Bob sees 1 thread
这意味着:
- 每个用户都可以创建和在他们自己的线程中聊天
- 用户无法看到彼此的线程
- 列出线程时只显示自己的
3. 添加作用域授权处理器¶
广泛使用的 @auth.on
处理器会匹配所有 授权事件。这种方式简洁,但意味着 value
字典的内容没有很好地限定范围,并且对每个资源都应用了相同的用户级访问控制。如果你想更加细致地控制,也可以针对资源上的特定操作进行管理。
更新 src/security/auth.py
文件以添加针对特定资源类型的处理器:
# 保留之前的处理器...
from langgraph_sdk import Auth
@auth.on.threads.create
async def on_thread_create(
ctx: Auth.types.AuthContext,
value: Auth.types.on.threads.create.value,
):
"""在创建线程时添加所有者信息。
此处理器在创建新线程时运行并执行以下两项操作:
1. 设置正在创建的线程的元数据以跟踪所有权
2. 返回一个过滤器,确保只有创建者可以访问该线程
"""
# 示例 value:
# {'thread_id': UUID('99b045bc-b90b-41a8-b882-dabc541cf740'), 'metadata': {}, 'if_exists': 'raise'}
# 向正在创建的线程添加所有者元数据
# 该元数据将与线程一起存储并持久化
metadata = value.setdefault("metadata", {})
metadata["owner"] = ctx.user.identity
# 返回过滤器以限制仅创建者可访问
return {"owner": ctx.user.identity}
@auth.on.threads.read
async def on_thread_read(
ctx: Auth.types.AuthContext,
value: Auth.types.on.threads.read.value,
):
"""只允许用户读取自己的线程。
此处理器在读取操作时运行。我们不需要设置
元数据,因为线程已经存在 - 我们只需要
返回一个过滤器以确保用户只能看到他们自己的线程。
"""
return {"owner": ctx.user.identity}
@auth.on.assistants
async def on_assistants(
ctx: Auth.types.AuthContext,
value: Auth.types.on.assistants.value,
):
# 为了说明目的,我们将拒绝所有涉及助手资源的请求
# 示例 value:
# {
# 'assistant_id': UUID('63ba56c3-b074-4212-96e2-cc333bbc4eb4'),
# 'graph_id': 'agent',
# 'config': {},
# 'metadata': {},
# 'name': 'Untitled'
# }
raise Auth.exceptions.HTTPException(
status_code=403,
detail="用户缺少所需的权限。",
)
# 假设你按照 (user_id, resource_type, resource_id) 的方式组织存储中的信息
@auth.on.store()
async def authorize_store(ctx: Auth.types.AuthContext, value: dict):
# 每个存储项的 "namespace" 字段是一个你可以视为项目目录的元组。
namespace: tuple = value["namespace"]
assert namespace[0] == ctx.user.identity, "未授权"
请注意,你现在有了针对以下内容的具体处理器,而不是一个全局的处理器:
- 创建线程
- 读取线程
- 访问助手
前三个处理器对应每个资源上的 特定操作(参见 资源操作),而最后一个 (@auth.on.assistants
) 则匹配 assistants
资源上的任何操作。对于每个请求,LangGraph 将运行与所访问资源和操作最匹配的特定处理器。这意味着上述四个处理器将运行,而不是之前广泛作用域的 "@auth.on
" 处理器。
尝试将以下测试代码添加到你的测试文件中:
# ... 与之前相同
# 尝试创建一个助手。这应该失败
try:
await alice.assistants.create("agent")
print("❌ Alice 不应该能够创建助手!")
except Exception as e:
print("✅ Alice 正确被拒绝访问:", e)
# 尝试搜索助手。这也应该失败
try:
await alice.assistants.search()
print("❌ Alice 不应该能够搜索助手!")
except Exception as e:
print("✅ Alice 正确被拒绝访问搜索助手:", e)
# Alice 仍然可以创建线程
alice_thread = await alice.threads.create()
print(f"✅ Alice 创建了线程: {alice_thread['thread_id']}")
输出结果:
✅ Alice 创建了线程: dcea5cd8-eb70-4a01-a4b6-643b14e8f754
✅ Bob 正确被拒绝访问: Client error '404 Not Found' for url 'http://localhost:2024/threads/dcea5cd8-eb70-4a01-a4b6-643b14e8f754'
For more information check: https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/404
✅ Bob 创建了自己的线程: 400f8d41-e946-429f-8f93-4fe395bc3eed
✅ Alice 看到了 1 个线程
✅ Bob 看到了 1 个线程
✅ Alice 正确被拒绝访问:
For more information check: https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/500
✅ Alice 正确被拒绝访问搜索助手:
恭喜!你已经构建了一个聊天机器人,其中每个用户都有自己的私有对话。虽然这个系统使用了简单的基于令牌的认证,但这些授权模式可以与任何实际的认证系统配合使用。在下一个教程中,你将用 OAuth2 实现的真实用户账户替换当前的测试用户。
下一步是什么?¶
现在你已经可以控制对资源的访问权限,你可能想要: