Simon
facc04aa65
本提交为 .git 对象库损坏后的重建提交，内容等价于原先三个本地提交 （5e2fd4c2 / 57a53c98 / 5d7e1873）的累积结果，未做任何额外改动。 一、docs 结构整改（整改 #14） 根因：重构时新结构为 untracked 文件，执行 git stash（未带 -u）未纳入， 随后 git reset 拉回 HEAD 旧 tracked 树，导致旧树复活、新旧两棵目录 树并存于 docs/，共 791 文件、双分类体系冲突。 修复动作： - b2 同名异主题文件改名迁移保全 9 个 - C 类 39 个孤立文件按主题正确归类 - A/B1 类 222 个重复文件删除（新结构已有内容副本） - 9 个旧独有空目录删除 - 270 处内部引用按 verified 映射改写 - 整改记录 #14 登记于 04-运维文档/部署运维 结果：docs 791 → 569 文件，顶层仅规范 8 类 + 治理文件，单树恢复。 残留：约 20 处指向从未存在文件的陈旧死链，归入独立文档卫生任务。 二、compose 双目录对齐（消除踩坑 A） - docker-compose.yml：nginx 前端挂载全部由根目录 frontend-*/dist 改为 src/frontend-*/dist（h5 / agent / admin / terminal） - docker-compose.dev.yml：dev 服务 build context 与卷同步改 src/ - 效果：本地 docker compose up 不再把根目录 stale dist 挂回， 与线上一致，分叉隐患消除（已 docker compose config 校验通过） 防复发铁律： - 重构须提交；仓库修复须 git stash -u 或先 commit - 新结构须 git add 并提交，避免再次 untracked 复活 - H5 改动只动 src/frontend-h5/，禁改根目录遗留 frontend-*/
89 lines
2.3 KiB
Markdown
89 lines
2.3 KiB
Markdown
# OTP 二次验证实现文档
|
||
|
||
## 功能概述
|
||
|
||
为 IT 支持服务台坐席端增加 OTP 二次验证功能：
|
||
- admin 角色登录时需要输入 Google Authenticator 动态码
|
||
- 首次绑定需要验证一次码才启用
|
||
- OTP 丢失后需管理员重置
|
||
|
||
## 实现方案
|
||
|
||
### 1. 后端修改
|
||
|
||
#### 1.1 安装依赖
|
||
```bash
|
||
pip install pyotp qrcode[pil] pillow
|
||
```
|
||
|
||
#### 1.2 数据库模型
|
||
Agent 模型已有字段：
|
||
- `otp_secret`: OTP 密钥（Base32编码）
|
||
- `otp_enabled`: OTP 是否启用（0=否, 1=是）
|
||
|
||
#### 1.3 Schema 修改
|
||
文件：`backend/app/schemas/agent.py`
|
||
- `AgentLogin` 增加 `otp_code` 可选字段
|
||
- `AgentResponse` 增加 `otp_enabled` 字段
|
||
|
||
#### 1.4 API 修改
|
||
文件：`backend/app/api/agents.py`
|
||
|
||
新增接口：
|
||
- `POST /api/agents/otp-bind` - 生成 OTP 密钥和二维码
|
||
- `POST /api/agents/otp-verify` - 验证并启用 OTP
|
||
- `POST /api/agents/otp-unbind` - 解绑 OTP
|
||
|
||
登录接口修改：
|
||
- admin 角色且 otp_enabled=1 时，检查 otp_code
|
||
- 未提供 otp_code 返回 `require_otp: True`
|
||
- 验证 OTP 码正确后生成 token
|
||
|
||
### 2. 前端修改
|
||
|
||
#### 2.1 坐席端 API
|
||
文件：`frontend-agent/src/api/agent.ts`
|
||
- `login()` 增加 `otpCode` 参数
|
||
|
||
#### 2.2 坐席端 Store
|
||
文件：`frontend-agent/src/stores/agent.ts`
|
||
- `login()` 增加 `otpCode` 参数
|
||
- 返回 `require_otp` 标记让页面处理
|
||
|
||
#### 2.3 坐席端登录页面
|
||
文件：`frontend-agent/src/views/Login.vue`
|
||
- 增加 OTP 输入框（v-if="requireOtp"）
|
||
- 首次登录返回 require_otp 时显示输入框
|
||
- 用户输入 OTP 后再次登录
|
||
|
||
## 使用流程
|
||
|
||
### 首次绑定 OTP
|
||
1. 管理员登录坐席端
|
||
2. 调用 `POST /api/agents/otp-bind`
|
||
3. 获取二维码和密钥
|
||
4. 使用 Google Authenticator 扫描二维码
|
||
5. 调用 `POST /api/agents/otp-verify` 输入动态码验证
|
||
6. 验证成功，otp_enabled 设为 1
|
||
|
||
### 登录流程
|
||
1. 用户输入 user_id 和 name
|
||
2. 后端检查 admin 角色且 otp_enabled=1
|
||
3. 返回 `require_otp: True`
|
||
4. 前端显示 OTP 输入框
|
||
5. 用户输入 6 位动态码
|
||
6. 后端验证通过，生成 token
|
||
|
||
### 解绑流程
|
||
1. 管理员调用 `POST /api/agents/otp-unbind`
|
||
2. otp_secret 和 otp_enabled 清空
|
||
|
||
## 错误码
|
||
|
||
| 错误码 | 说明 |
|
||
|--------|------|
|
||
| 1006 | OTP 验证码错误 |
|
||
| 1007 | OTP 绑定失败 |
|
||
| 1008 | 请先绑定 OTP |
|
||
| 1009 | OTP 验证失败 |
|
||
| 1010 | OTP 解绑失败 | |