Dify进阶：插件开发

brew tap langgenius/dify
brew install dify

dify version

我要开发一个dify插件，以下是我的需求文档。

以下是一份面向开发团队和产品负责人的 Dify 脱敏插件需求文档（PRD），内容涵盖背景、目标、功能需求、非功能需求、接口设计、安全合规等关键要素，适用于金融、医疗、政务等强监管场景。

Dify 敏感数据脱敏插件需求文档（PRD）


1. 背景与问题描述

在企业级 AI 应用中，Dify 常被用于构建智能客服、内部知识助手、业务查询机器人等场景。这些应用通常需要调用外部系统（如 CRM、ERP、数据库 API）获取用户数据，并将结果交由大语言模型（LLM）生成自然语言回答。

然而，外部系统返回的数据常包含个人敏感信息（PII），例如：
身份证号
手机号
银行卡号
家庭住址
医疗记录编号

根据《中华人民共和国个人信息保护法》《GDPR》《金融行业数据安全规范》等法规，原始敏感数据不得未经处理直接传入 LLM，否则将导致：
数据泄露风险
合规审计失败
法律责任与声誉损失

当前 Dify 平台缺乏在“工具调用 → LLM 输入”之间对结构化数据进行自动脱敏的能力，必须通过插件扩展实现该关键安全控制点。

2. 目标

开发一个 通用、可配置、高性能的敏感数据脱敏插件，集成到 Dify 工作流中，实现以下目标：
✅ 在 LLM 接收外部工具返回数据前，自动识别并脱敏敏感字段；
✅ 支持主流敏感字段类型（身份证、手机号、银行卡等）；
✅ 保证脱敏过程不破坏原始数据结构，确保 LLM 能正常理解上下文；
✅ 满足金融、医疗等行业合规要求；
✅ 插件可复用、可配置、低侵入，适用于多租户 SaaS 环境。

3. 功能需求
3.1 核心功能

功能 描述
------ ------
自动字段识别 根据预定义字段名关键词（如 phone, id_card）匹配敏感字段
结构化数据脱敏 支持对 JSON 对象、普通字符串、数组递归遍历并脱敏
多种脱敏策略 支持掩码（masking）方式，保留部分可见字符（如 138*5678）
输入输出透明 输入为包含敏感信息字符串，输出为脱敏后的字符串，结构不变
3.2 支持的敏感字段类型（初始版本）

字段类型 示例原始值 脱敏后示例 匹配字段名关键词（不区分大小写）
-------- ---------- ---------- ---------------------------
手机号 13812345678 1385678 phone, mobile, telephone
身份证号 110101199003072316 110101**2316 id_card, identity_card, citizen_id
银行卡号 6222081234567890123 6222******0123 bank_card, card_number, account_no
姓名（可选） 张三 张 或 name, full_name（默认关闭）
注：姓名脱敏默认不启用，因可能影响语义理解，需通过配置开关控制。
3.3 配置能力（未来扩展）
支持通过插件参数动态开启/关闭某类脱敏；
支持自定义正则表达式匹配字段值（如识别未命名但含身份证格式的字段）；
支持租户级脱敏策略配置（高级功能，v2.0 考虑）。

4. 非功能需求

类别 要求
------ ------
性能 单次脱敏处理延迟 ≤ 50ms（95% 分位），支持并发 ≥ 100 QPS
可靠性 脱敏失败时应 fallback 到返回原始数据（或可配置为报错），不得中断工作流
安全性 插件本身不得记录、缓存、传输原始敏感数据；所有处理在内存中完成
兼容性 输入必须为字符串；非法输入应原样返回并记录警告日志
可观测性 提供基础日志（如脱敏字段数量、异常次数），便于监控

5. 插件接口设计（Dify 兼容）
5.1 插件元信息（YAML 示例）

yaml
name: sensitive_data_masker
description: 自动脱敏外部工具返回中的敏感个人信息（手机号、身份证、银行卡等）
version: 1.0.0
type: function
input_params:
name: input_string
type: string
required: true
description: 上游工具返回的原始字符串
output:
type: string
description: 脱敏后的字符串，结构与输入一致
5.2 函数签名（Python 示例）

python
def main(input_string: str) -> str:
"""
输入：字符串（如 '{"user": {"phone": "13812345678", "id_card": "110101199003072316"}}'）
输出：脱敏后 字符串（如 '{"user": {"phone": "1385678", "id_card": "110101***2316"}}'）
"""

6. 使用场景示例

场景：客户询问“我的账户绑定手机号是多少？”

1. Dify 调用内部用户查询 API，返回：
json
{"phone": "13812345678", "id_card": "110101199003072316"}

2. 工作流自动调用 sensitive_data_masker 插件；
3. 插件返回：
json
{"phone": "1385678", "id_card": "110101**2316"}

4. LLM 基于脱敏数据生成回答：“您绑定的手机号是 1385678。”

✅ 整个过程无原始敏感数据进入 LLM，满足合规要求。

INSTALL_METHOD=remote
REMOTE_INSTALL_URL=debug.dify.ai:5003
REMOTE_INSTALL_KEY=********-****-****-****-************

dify plugin package ./sensitive_data_masker