byted-security-llmscanner

Files (22)

• LICENSE
• README.md
• SKILL.md
• config.ts · scripts/
• .gitkeep · scripts/data/
• package-lock.json · scripts/
• package.json · scripts/
• analyze_rt_task.ts · scripts/src/
• analyze_task_data.ts · scripts/src/
• common.ts · scripts/src/
• create_asset_agent.ts · scripts/src/
• create_asset_model.ts · scripts/src/
• create_rt_task.ts · scripts/src/
• create_task.ts · scripts/src/
• fetch_lists.ts · scripts/src/
• list_agent_platforms.ts · scripts/src/
• list_resources.ts · scripts/src/
• list_rt_scenarios.ts · scripts/src/
• run_analysis.ts · scripts/src/
• update_asset_agent.ts · scripts/src/
• update_asset_model.ts · scripts/src/
• tsconfig.json · scripts/

SKILL.md (first lines)

# 大模型安全测评全流程管理技能使用指南

## 触发条件
当用户发送包含"创建资产"、"更新资产"、"发起测评"、"分析测评"、"查询资源"等关键词的指令时，触发本技能。

---

## 脚本位置说明

**脚本目录：** `~/.openclaw/workspace/skills/byted-security-llmscanner/scripts/`

**执行方式：**
```bash
cd ~/.openclaw/workspace/skills/byted-security-llmscanner/scripts
npx ts-node src/create_asset_model.ts <参数...>
```

**以下示例均需先进入脚本目录**

---

## ⚠️ 易错点说明

### 1. 资产ID vs 资产名称
- **`update_asset_model.ts`** 的第一个参数是 `Name`（资产名称），不是 `AssetID`。脚本会自动根据名称和ModelID查询资产ID。
- **`update_asset_agent.ts`** 的参数是 `<AgentID> <Name> <PlatformID>`，需要同时提供资产ID和名称。

### 2. 脚本代码问题
- 部分脚本可能存在重复属性问题（如 `proxy: false` 重复），导致 TypeScript 编译错误。如遇此类错误，需要检查并修复脚本代码。

### 3. 模态类型匹配
- 资产的模态类型必须包含测评集的模态类型，否则无法发起测评。
- 例如：测评集是 `text2text`，资产的模态类型可以是 `text2text` 或 `text2text,image2text`，但不能只有 `image2text`。

### 4. 智能体平台参数
- 不同智能体平台需要不同的参数，必须先用 `list_agent_platforms.ts vars <PlatformID>` 查询该平台需要的参数。

### 5. 安全测评剧本适用范围
- 部分安全测评剧本专门针对 OpenClaw，部分是通用的。查询剧本时会显示 `assetTypes`[] 字段，如果为空则表示通用。

---

## 通用枚举

### 模态类型
- `text2text`：文生文
- `image2text`：图文生文
- `text2image`：文生图

### 资产类型
- `model`：大模型
- `agent`：智能体
- `openclaw`：OpenClaw 资产

### 合规测评任务状态
| 状态码 | 状态名称 | 说明 |
| --- | --- | --- |
| 0 | 待测评 | 任务已创建，等待开始执行 |
| 1 | 测评中 | 任务正在执行 |
| 2 | 测评成功 | 任务执行完成（终态） |
| 3 | 测评异常 | 任务执行失败（终态） |
| 5 | 暂停测评 | 任务被暂停（终态） |
| 6 | 终止测评 | 任务被终止（终态） |

### 安全测评任务状态
| 状态码 | 状态名称 | 说明 |
| --- | --- | --- |
| 10 | 等待处理 | 任务已创建，等待开始执行 |
| 20 | 处理中 | 任务正在执行 |
| 30 | 异常 | 任务执行失败（终态） |
| 40 | 完成 | 任务执行完成（终态） |

---

## 资产管理

### 1. 创建大模型资产

**调用：**
```bash
npx ts-node src/create_asset_model.ts <Name> <ModelID> <BaseUrl> <ApiKey> [ModalTypes]
```

**参数：**
- `Name`：资产名称（如：deepseek-v3）
- `ModelID`：模型 ID（如：ep-20250325142301-ljxvm）
- `BaseUrl`：API 地址（如：https://ark-cn-beijing.bytedance.net/api/v3）
- `ApiKey`：API 密钥（如：sk-xxxxxxxxxxxx）
- `ModalTypes`：模态类型（可选，逗号分隔，默认：text2text）

**示例：**
```bash
npx ts-node src/create_asset_model.ts deepseek-v3 ep-20250325142301-ljxvm https://ark-cn-beijing.bytedance.net/api/v3 sk-xxxxxxxxxxxx text2text
```

---

### 2. 更新大模型资产

**调用：**
```bash
npx ts-node src/update_asset_asset_model.ts <Name> <ModelID> <BaseUrl> <ApiKey> [ModalTypes]
```

**参数：**
- `Name`：资产名称（⚠️ 注意：不是 AssetID，脚本会自动查询）
- `ModelID`：模型 ID
- `BaseUrl`：API 地址
- `ApiKey`：API 密钥
- `ModalTypes`：模态类型（可选，逗号分隔，默认：text2text）

**示例：**
```bash
npx ts-node src/update_asset_model.ts deepseek-v3 ep-new-model-id https://ark-cn-beijing.bytedance.net/api/v3 sk-new-api-key text2text
```

**⚠️ 注意：**
- 第一个参数是 `Name`（资产名称），不是 `AssetID`
- 脚本会根据 `Name` 和 `ModelID` 自动查询资产ID

From bytedance/agentkit-samples, Apache-2.0.

More from bytedance/agentkit-samples