> ## Documentation Index
> Fetch the complete documentation index at: https://cndoc-langchain.site/llms.txt
> Use this file to discover all available pages before exploring further.

# 添加静态加密

Agent Server 支持对检查点数据和元数据进行静态加密。您可以选择使用单个密钥的基本加密，或针对高级用例的自定义加密。

## 选择加密方法

| 方法        | 加密内容                 | 用例                   |
| --------- | -------------------- | -------------------- |
| **基本加密**  | 检查点 blob，可选 JSON 字段  | 单个静态密钥，自动 AES 加密     |
| **自定义加密** | 检查点、线程、运行、助手、定时任务和存储 | 每租户密钥、KMS 集成、选择性字段加密 |

## 基本加密

要使用单个静态密钥进行简单加密，请设置 `LANGGRAPH_AES_KEY` 环境变量。LangGraph 将自动使用 AES 加密检查点 blob。

1. 在 `langgraph.json` 的依赖项中添加 `pycryptodome`：

   ```json theme={"theme":{"light":"catppuccin-latte","dark":"catppuccin-mocha"}}
   {
     "dependencies": [".", "pycryptodome"],
     "graphs": {
       "agent": "./agent.py:graph"
     }
   }
   ```

2. 将 `LANGGRAPH_AES_KEY` 环境变量设置为 16、24 或 32 字节的密钥（分别对应 AES-128、AES-192 或 AES-256）。

### 加密 JSON 字段

要同时加密特定的 JSON 字段，请将 `LANGGRAPH_AES_JSON_KEYS` 设置为逗号分隔的要加密的键列表：

```bash theme={"theme":{"light":"catppuccin-latte","dark":"catppuccin-mocha"}}
export LANGGRAPH_AES_KEY="your-16-24-or-32-byte-key"
export LANGGRAPH_AES_JSON_KEYS="api_key,secret_token,user_credentials"
```

这些键在它们出现的线程、助手、运行、定时任务和存储数据中都会被加密。

<Warning>加密字段无法被搜索或过滤。</Warning>

系统字段无法加密：`langgraph_version`、`langgraph_api_version`、`langgraph_plan`、`langgraph_host`、`langgraph_api_url`、`langgraph_request_id`、`langgraph_auth_user_id` 和 `langgraph_auth_permissions`。

## 自定义加密

<Note>
  需要 Agent Server 版本 0.6.22+ 和 Python SDK 版本 `langgraph-sdk>=0.3.1`。
</Note>

<Warning>
  Agent Server 版本 0.5.34–0.6.21
  包含了自定义加密的预发布版本。使用这些版本加密的数据在升级到 0.6.22+
  时会损坏。请勿在这些版本上使用自定义加密。
</Warning>

当您需要以下功能时，请使用自定义加密：

* **每租户密钥隔离** —— 为不同客户使用不同的加密密钥
* **KMS 集成** —— 使用 AWS KMS、Google Cloud KMS 或 HashiCorp Vault 进行密钥管理、轮换和审计日志记录
* **选择性字段加密** —— 加密敏感元数据字段，同时保持其他字段可搜索

### 工作原理

1. [配置](#配置) `langgraph.json` 中的加密模块路径
2. [定义您的加密模块](#定义您的加密模块)，包含 blob 和 JSON 加密的处理程序
3. 通过 `X-Encryption-Context` 头 [传递加密上下文](#传递加密上下文)（如租户 ID）
4. LangGraph 在存储数据前和检索数据后调用您的处理程序

有关具有密钥轮换和审计日志记录的生产部署，请参阅 [使用 AWS Encryption SDK 的信封加密](#使用-aws-encryption-sdk-的信封加密)。

### 配置

将您的加密模块添加到 `langgraph.json`：

```json theme={"theme":{"light":"catppuccin-latte","dark":"catppuccin-mocha"}}
{
  "dependencies": ["."],
  "graphs": {
    "agent": "./agent.py:graph"
  },
  "encryption": {
    "path": "./encryption.py:encryption"
  }
}
```

<Note>
  如果您从基本加密迁移过来，请保持 `LANGGRAPH_AES_KEY`
  已配置。自定义加密处理新的写入，而现有的 AES 加密数据仍然可读。
</Note>

### 定义您的加密模块

#### Blob 加密（检查点）

Blob 处理程序加密检查点数据——来自图执行的序列化状态。这是一个使用 [Fernet](https://cryptography.io/en/latest/fernet/)（来自 `cryptography` 库的对称加密方案）的每租户密钥的简化示例：

```python theme={"theme":{"light":"catppuccin-latte","dark":"catppuccin-mocha"}}
import os
from cryptography.fernet import Fernet
from langgraph_sdk import Encryption, EncryptionContext

encryption = Encryption()

# 在生产环境中，从密钥管理器获取
TENANT_KEYS = {
    "tenant-a": Fernet(os.environ["TENANT_A_KEY"]),
    "tenant-b": Fernet(os.environ["TENANT_B_KEY"]),
}


def _get_fernet(ctx: EncryptionContext) -> Fernet:
    tenant_id = ctx.metadata.get("tenant_id")
    if not tenant_id or tenant_id not in TENANT_KEYS:
        raise ValueError(f"Unknown tenant: {tenant_id}")
    return TENANT_KEYS[tenant_id]


@encryption.encrypt.blob
async def encrypt_blob(ctx: EncryptionContext, data: bytes) -> bytes:
    return _get_fernet(ctx).encrypt(data)


@encryption.decrypt.blob
async def decrypt_blob(ctx: EncryptionContext, data: bytes) -> bytes:
    return _get_fernet(ctx).decrypt(data)
```

`ctx.metadata` 字典来自 `X-Encryption-Context` 头，并以明文形式与加密数据一起存储，以便在解密时使用正确的密钥。

#### JSON 加密（元数据）

JSON 处理程序加密结构化数据，如线程元数据、助手上下文和运行 kwargs。与 blob 加密不同，您可以选择要加密哪些字段——保持某些字段未加密以用于搜索和过滤。

```python theme={"theme":{"light":"catppuccin-latte","dark":"catppuccin-mocha"}}
import json
import os
from cryptography.fernet import Fernet
from langgraph_sdk import Encryption, EncryptionContext

encryption = Encryption()

TENANT_KEYS = {
    "tenant-a": Fernet(os.environ["TENANT_A_KEY"]),
    "tenant-b": Fernet(os.environ["TENANT_B_KEY"]),
}

SKIP_FIELDS = {
    "tenant_id", "owner",
    "run_id", "thread_id", "graph_id", "assistant_id", "user_id", "checkpoint_id",
    "source", "step", "parents", "run_attempt",
    "langgraph_version", "langgraph_api_version", "langgraph_plan", "langgraph_host",
    "langgraph_api_url", "langgraph_request_id", "langgraph_auth_user",
    "langgraph_auth_user_id", "langgraph_auth_permissions",
}
ENCRYPTED_PREFIX = "encrypted:"


def _get_fernet(ctx: EncryptionContext) -> Fernet:
    tenant_id = ctx.metadata.get("tenant_id")
    if not tenant_id or tenant_id not in TENANT_KEYS:
        raise ValueError(f"Unknown tenant: {tenant_id}")
    return TENANT_KEYS[tenant_id]


@encryption.encrypt.json
async def encrypt_json(ctx: EncryptionContext, data: dict) -> dict:
    fernet = _get_fernet(ctx)
    result = {}
    for k, v in data.items():
        if k in SKIP_FIELDS or v is None:
            result[k] = v
        else:
            value_json = json.dumps(v)
            encrypted = fernet.encrypt(value_json.encode()).decode()
            result[k] = ENCRYPTED_PREFIX + encrypted
    return result


@encryption.decrypt.json
async def decrypt_json(ctx: EncryptionContext, data: dict) -> dict:
    fernet = _get_fernet(ctx)
    result = {}
    for k, v in data.items():
        if isinstance(v, str) and v.startswith(ENCRYPTED_PREFIX):
            encrypted_value = v[len(ENCRYPTED_PREFIX):]
            decrypted = fernet.decrypt(encrypted_value.encode()).decode()
            result[k] = json.loads(decrypted)
        else:
            result[k] = v
    return result
```

#### JSON 加密注意事项

<Warning>
  **加密字段无法被搜索或过滤。**
  设计您的元数据模式时，请确保需要查询的字段保持未加密。
</Warning>

<Warning>
  **JSON 加密器必须保留键结构。** SQL JSONB
  合并操作在键级别进行。更改键的加密器——无论是通过合并字段（例如，将敏感数据移入
  `__encrypted__`）还是通过加密键名本身——都会在合并期间导致数据丢失。使用每键加密：就地转换值，同时保留键。
</Warning>

<Note>
  **迁移注意事项：**
  在加密值中使用可识别的前缀或格式，以便您的解密器可以检测并跳过未加密的数据。这使您将来可以加密额外的字段，而无需重新加密现有记录。上面的示例使用了这种模式。
</Note>

<Note>
  **性能注意事项：**
  每键加密意味着每个字段一次加密调用。如果您的加密涉及与外部服务（例如
  KMS）的往返，这可能会显著影响延迟。考虑在本地缓存数据密钥，或使用信封加密，您使用
  KMS 加密本地数据密钥并将其用于多个字段。
</Note>

用于授权的用户定义字段（例如 `tenant_id`、`owner`）通常应保持**未加密**，用于搜索和过滤的字段也应如此。此外，**某些系统管理的字段永远不会被加密**：

* 资源标识符（`thread_id`、`run_id`、`assistant_id`、`graph_id`、`checkpoint_id`、`task_id`）
* 大多数以 `langgraph_` 开头的字段（`langgraph_auth_user` 除外）
* 必需的检查点元数据（`source`、`step`、`parents`、`run_attempt`）
* 用于调度和编排的内部字段（`__after_seconds__`、`__request_start_time_ms__`、大多数以 `__pregel` 开头的字段）
* 在运行的 `config` 中指定的运行级执行限制（`max_concurrency`、`recursion_limit`）
* 在运行的 `config.configurable` 中指定的线程 TTL 更新（`ttl`）

#### 加密内容

**JSON 处理程序**（`@encryption.encrypt.json` / `@encryption.decrypt.json`）递归应用于以下字段：

* `thread.metadata`、`thread.values`
* `assistant.metadata`、`assistant.context`
* `run.metadata`、`run.kwargs`
* `cron.metadata`、`cron.payload`
* `store.value`

[某些字段被排除在加密之外。](#加密内容) 除非另有说明，这些排除适用于嵌套 JSON 对象的每个级别，而不仅仅是根级别。

**Blob 处理程序**（`@encryption.encrypt.blob` / `@encryption.decrypt.blob`）应用于检查点 blob（图执行状态）。

#### 从认证派生上下文

无需显式传递 `X-Encryption-Context`，可以从经过身份验证的用户派生加密上下文：

```python theme={"theme":{"light":"catppuccin-latte","dark":"catppuccin-mocha"}}
from langgraph_sdk import Encryption, EncryptionContext
from starlette.authentication import BaseUser

encryption = Encryption()

@encryption.context
async def get_encryption_context(user: BaseUser, ctx: EncryptionContext) -> dict:
    return {
        **ctx.metadata,
        "tenant_id": user["tenant_id"],
    }
```

此处理程序在身份验证后每个请求运行一次。返回的字典成为该请求中所有加密操作的 `ctx.metadata`。

### 传递加密上下文

通过 `X-Encryption-Context` 头传递加密上下文。上下文是您定义的任意数据——您控制模式，并可以包含加密逻辑所需的任何字段（例如 `tenant_id`、`key_version`）。上下文在您的处理程序中作为 `ctx.metadata` 可用，并以明文形式存储以供解密时使用。

```python theme={"theme":{"light":"catppuccin-latte","dark":"catppuccin-mocha"}}
import base64
import json
from langgraph_sdk import get_client

encryption_context = base64.b64encode(
    json.dumps({"tenant_id": "tenant-a"}).encode()
).decode()

client = get_client(url="http://localhost:2024")

result = await client.runs.wait(
    thread_id=None,
    assistant_id="agent",
    input={"messages": [{"role": "user", "content": "Hello"}]},
    headers={"X-Encryption-Context": encryption_context},
)
```

<Note>
  加密上下文以明文形式存储。解密时，它会自动恢复——调用者在读取时不需要传递该头。
</Note>

### 使用 AWS Encryption SDK 的信封加密

对于 AWS 上的生产部署，请使用 [AWS Encryption SDK](https://docs.aws.amazon.com/encryption-sdk/latest/developer-guide/python.html) 与 AWS KMS，或在您的云提供商中使用等效方案。此方法：

* 自动处理信封加密（无需手动打包密钥）
* 提供密钥轮换和审计日志记录
* 将密文绑定到加密上下文（租户隔离）
* 在本地缓存数据密钥以避免重复的 KMS 调用、延迟和速率限制

#### 完整示例

```python theme={"theme":{"light":"catppuccin-latte","dark":"catppuccin-mocha"}}
import base64
import json
import os

import aws_encryption_sdk
from aws_encryption_sdk import (
    CachingCryptoMaterialsManager,
    CommitmentPolicy,
    LocalCryptoMaterialsCache,
    StrictAwsKmsMasterKeyProvider,
)
from langgraph_sdk import Encryption, EncryptionContext

encryption = Encryption()

# SDK 使用信封加密：一次 KMS API 调用生成数据密钥，
# 然后在本地加密/解密。缓存跨操作重用数据密钥。
client = aws_encryption_sdk.EncryptionSDKClient(
    commitment_policy=CommitmentPolicy.REQUIRE_ENCRYPT_REQUIRE_DECRYPT
)
key_provider = StrictAwsKmsMasterKeyProvider(key_ids=[os.environ["KMS_KEY_ARN"]])
cache = LocalCryptoMaterialsCache(capacity=100)
cmm = CachingCryptoMaterialsManager(
    master_key_provider=key_provider,
    cache=cache,
    max_age=300.0,
    max_messages_encrypted=100,
)

SKIP_FIELDS = {
    "tenant_id", "owner",
    "run_id", "thread_id", "graph_id", "assistant_id", "user_id", "checkpoint_id",
    "source", "step", "parents", "run_attempt",
    "langgraph_version", "langgraph_api_version", "langgraph_plan", "langgraph_host",
    "langgraph_api_url", "langgraph_request_id", "langgraph_auth_user",
    "langgraph_auth_user_id", "langgraph_auth_permissions",
}
ENCRYPTED_PREFIX = "encrypted:"


@encryption.encrypt.blob
async def encrypt_blob(ctx: EncryptionContext, data: bytes) -> bytes:
    ciphertext, _ = client.encrypt(
        source=data,
        materials_manager=cmm,
        encryption_context={"tenant_id": ctx.metadata["tenant_id"]},
    )
    return ciphertext


@encryption.decrypt.blob
async def decrypt_blob(ctx: EncryptionContext, data: bytes) -> bytes:
    plaintext, _ = client.decrypt(source=data, key_provider=key_provider)
    return plaintext


@encryption.encrypt.json
async def encrypt_json(ctx: EncryptionContext, data: dict) -> dict:
    tenant_id = ctx.metadata["tenant_id"]
    result = {}
    for k, v in data.items():
        if k in SKIP_FIELDS or v is None:
            result[k] = v
        else:
            ciphertext, _ = client.encrypt(
                source=json.dumps(v).encode(),
                materials_manager=cmm,
                encryption_context={"tenant_id": tenant_id},
            )
            result[k] = ENCRYPTED_PREFIX + base64.b64encode(ciphertext).decode()
    return result


@encryption.decrypt.json
async def decrypt_json(ctx: EncryptionContext, data: dict) -> dict:
    result = {}
    for k, v in data.items():
        if isinstance(v, str) and v.startswith(ENCRYPTED_PREFIX):
            ciphertext = base64.b64decode(v[len(ENCRYPTED_PREFIX):])
            plaintext, _ = client.decrypt(source=ciphertext, key_provider=key_provider)
            result[k] = json.loads(plaintext.decode())
        else:
            result[k] = v
    return result
```

`encryption_context` 通过 KMS 在密码学上绑定到密文——如果上下文不匹配，解密将失败。上下文嵌入在密文中，因此解密处理程序不需要引用 `ctx.metadata`。

#### 密钥轮换

KMS 自动处理主密钥轮换。当您在 KMS 密钥上启用自动轮换时，旧的加密数据密钥仍然可以解密，而新操作使用轮换后的密钥材料。无需重新加密现有数据。

## 相关内容

* [自定义身份验证](/langsmith/custom-auth)

***

<div className="source-links">
  <Callout icon="terminal-2">
    [将这些文档连接](/use-these-docs)到 Claude、VSCode 等，通过 MCP
    获取实时答案。
  </Callout>

  <Callout icon="edit">
    [在 GitHub
    上编辑此页面](https://github.com/langchain-ai/docs/edit/main/src/langsmith/encryption.mdx)
    或 [提交问题](https://github.com/langchain-ai/docs/issues/new/choose)。
  </Callout>
</div>