15 KiB
15 KiB
用户认证系统
**本文档引用的文件** - [backend/src/middleware/auth.js](file://backend/src/middleware/auth.js) - [backend/src/utils/jwt.js](file://backend/src/utils/jwt.js) - [backend/src/utils/password.js](file://backend/src/utils/password.js) - [backend/src/routes/auth.js](file://backend/src/routes/auth.js) - [backend/src/models/DashboardUser.js](file://backend/src/models/DashboardUser.js) - [backend/src/utils/response.js](file://backend/src/utils/response.js) - [backend/src/services/userBootstrap.js](file://backend/src/services/userBootstrap.js) - [frontend/src/utils/auth.js](file://frontend/src/utils/auth.js) - [frontend/src/utils/request.js](file://frontend/src/utils/request.js) - [frontend/src/api/auth.js](file://frontend/src/api/auth.js) - [backend/src/app.js](file://backend/src/app.js) - [backend/src/config/env.js](file://backend/src/config/env.js)目录
简介
本项目是一个基于JWT(JSON Web Token)的用户认证系统,采用前后端分离架构设计。系统实现了完整的用户登录、令牌生成、权限验证和超级管理员权限检查功能。该认证系统具有以下特点:
- JWT认证机制:使用HS256算法进行令牌签名,支持12小时有效期
- 密码安全存储:采用PBKDF2算法进行密码哈希,防止明文存储
- 中间件验证:提供通用认证中间件和超级管理员权限检查中间件
- 前后端协作:前端通过localStorage管理令牌,后端通过Authorization头验证
- 错误处理:完善的错误处理机制,支持令牌过期、权限不足等场景
项目结构
认证系统主要分布在后端和前端两个部分:
graph TB
subgraph "后端架构"
A[Express 应用] --> B[认证路由]
A --> C[JWT工具]
A --> D[密码工具]
A --> E[认证中间件]
A --> F[用户模型]
A --> G[响应格式化]
end
subgraph "前端架构"
H[Axios请求] --> I[认证工具]
H --> J[API封装]
I --> K[本地存储]
I --> L[令牌解析]
end
subgraph "数据库"
M[DashboardUser表]
end
B --> M
E --> C
D --> M
图表来源
章节来源
核心组件
JWT认证工具
JWT工具负责令牌的创建、解码和配置管理:
classDiagram
class JWT工具 {
+JWT_SECRET : string
+JWT_ALGORITHM : string
+TOKEN_TTL_HOURS : number
+createAccessToken(user) : string
+decodeToken(token) : object
+getTokenTtlSeconds() : number
}
class 用户对象 {
+id : number
+username : string
+is_super_admin : boolean
+password_hash : string
+status : number
}
JWT工具 --> 用户对象 : "创建令牌时使用"
图表来源
密码加密工具
密码加密工具实现了PBKDF2算法的安全密码存储:
flowchart TD
A[输入密码] --> B[生成随机盐值]
B --> C[PBKDF2哈希计算]
C --> D[组合存储格式]
D --> E[pbkdf2:digest:iterations:salt:hash]
F[验证密码] --> G[解析存储格式]
G --> H[提取参数]
H --> I[PBKDF2重新计算]
I --> J[安全比较]
J --> K{匹配?}
K --> |是| L[返回true]
K --> |否| M[返回false]
图表来源
认证中间件
认证中间件提供了统一的请求验证机制:
sequenceDiagram
participant Client as 客户端
participant Middleware as 认证中间件
participant JWT as JWT工具
participant Next as 下一个中间件
Client->>Middleware : 发送带Authorization头的请求
Middleware->>Middleware : 检查Authorization头格式
Middleware->>JWT : decodeToken(token)
JWT-->>Middleware : 返回用户负载
Middleware->>Middleware : 验证用户ID存在性
Middleware->>Next : 设置req.user并继续
Next-->>Client : 处理后续逻辑
图表来源
章节来源
- backend/src/utils/jwt.js:1-28
- backend/src/utils/password.js:1-37
- backend/src/middleware/auth.js:1-36
架构概览
系统采用分层架构设计,前后端分离:
graph TB
subgraph "前端层"
A[Vue应用] --> B[API封装]
B --> C[Axios请求]
C --> D[认证工具]
end
subgraph "网络层"
E[HTTP请求]
end
subgraph "后端层"
F[Express服务器] --> G[路由层]
G --> H[认证中间件]
G --> I[业务逻辑]
I --> J[数据库访问]
end
subgraph "数据层"
K[MySQL数据库]
end
A --> E
E --> F
F --> K
图表来源
详细组件分析
登录认证流程
登录流程是整个认证系统的核心:
sequenceDiagram
participant User as 用户
participant Frontend as 前端
participant Backend as 后端
participant DB as 数据库
participant JWT as JWT工具
User->>Frontend : 输入用户名密码
Frontend->>Backend : POST /api/auth/login
Backend->>DB : 查询用户信息
DB-->>Backend : 返回用户数据
Backend->>Backend : 验证密码
Backend->>JWT : createAccessToken(user)
JWT-->>Backend : 返回JWT令牌
Backend-->>Frontend : 返回令牌和用户信息
Frontend->>Frontend : 存储令牌到localStorage
图表来源
登录接口实现要点
- 输入验证:检查用户名和密码是否为空
- 用户查询:通过用户名查找用户,确保账户状态为启用
- 密码验证:使用PBKDF2算法验证密码
- 最后登录时间更新:成功登录后更新last_login_at字段
- 令牌生成:为用户创建JWT访问令牌
- 响应格式化:使用统一的ApiResponse格式返回
章节来源
权限验证中间件
系统提供了两层权限控制:
flowchart TD
A[请求到达] --> B{是否有Authorization头}
B --> |否| C[返回401未登录]
B --> |是| D[提取JWT令牌]
D --> E[解码JWT令牌]
E --> F{令牌是否有效}
F --> |否| G[返回401无效凭证]
F --> |是| H[验证用户ID存在]
H --> I{用户是否存在且启用}
I --> |否| J[返回401账号不存在或已禁用]
I --> |是| K[设置req.user并继续]
subgraph "超级管理员检查"
L[调用requireSuperAdmin] --> M{是否超级管理员}
M --> |否| N[返回403权限不足]
M --> |是| O[继续执行]
end
图表来源
中间件配置选项
| 参数 | 类型 | 默认值 | 描述 |
|---|---|---|---|
| Authorization头 | String | 必填 | 格式为"Bearer {token}" |
| JWT_SECRET | String | 'dev-only-change-me-for-production' | 令牌签名密钥 |
| JWT_ALGORITHM | String | 'HS256' | 加密算法 |
| TOKEN_TTL_HOURS | Number | 12 | 令牌有效期(小时) |
章节来源
超级管理员权限检查
超级管理员权限检查是系统的重要安全特性:
sequenceDiagram
participant Client as 客户端
participant AuthMW as 认证中间件
participant SuperMW as 超级管理员中间件
participant Handler as 处理函数
Client->>AuthMW : 带令牌的请求
AuthMW->>AuthMW : 验证令牌有效性
AuthMW->>SuperMW : 设置req.user
SuperMW->>SuperMW : 检查is_super_admin标志
SuperMW->>Handler : 权限验证通过
Handler-->>Client : 执行业务逻辑
图表来源
章节来源
前端认证状态管理
前端通过localStorage管理认证状态:
classDiagram
class 认证工具 {
+getToken() : string
+setToken(token : string) : void
+clearToken() : void
+getUser() : object
+setUser(user : object) : void
+clearUser() : void
+clearAuth() : void
+getUserFromToken(token? : string) : object
+isSuperAdmin(user? : object) : boolean
+getTokenExpiresAt(token? : string) : number
+isTokenExpired(token? : string) : boolean
}
class 本地存储 {
+setItem(key : string, value : string) : void
+getItem(key : string) : string
+removeItem(key : string) : void
}
class JWT解析 {
+base64解码 : string
+JSON解析 : object
+提取payload : object
}
认证工具 --> 本地存储 : "使用localStorage"
认证工具 --> JWT解析 : "解析令牌"
图表来源
章节来源
错误处理机制
系统实现了完善的错误处理:
flowchart TD
A[请求处理] --> B{异常类型}
B --> |401未登录| C[清除认证状态]
B --> |403权限不足| D[显示权限不足消息]
B --> |其他错误| E[显示通用错误消息]
C --> F[重定向到登录页]
D --> G[阻止继续操作]
E --> H[记录日志并提示]
subgraph "前端处理"
I[请求拦截器] --> J[添加Authorization头]
K[响应拦截器] --> L[处理401/403状态]
end
图表来源
章节来源
依赖关系分析
技术栈依赖
graph TB
subgraph "后端依赖"
A[Express] --> B[JWT认证]
A --> C[数据库ORM]
D[Sequelize] --> E[MySQL驱动]
F[jsonwebtoken] --> G[HS256算法]
H[crypto] --> I[PBKDF2算法]
end
subgraph "前端依赖"
J[Axios] --> K[HTTP客户端]
L[Element Plus] --> M[UI组件]
N[Vue 3] --> O[响应式框架]
end
subgraph "开发工具"
P[Nodemon] --> Q[热重载]
R[Vite] --> S[构建工具]
end
图表来源
数据模型关系
erDiagram
DASHBOARD_USER {
int id PK
string username UK
string password_hash
tinyint is_super_admin
tinyint status
datetime last_login_at
datetime create_at
datetime update_at
}
JWT_PAYLOAD {
string sub
string username
boolean is_super_admin
integer iat
integer exp
}
DASHBOARD_USER ||--o{ JWT_PAYLOAD : "生成令牌"
图表来源
章节来源
性能考虑
JWT令牌优化
- 令牌大小控制:JWT负载仅包含必要信息(用户ID、用户名、权限标志)
- 有效期设置:12小时有效期平衡安全性与用户体验
- 算法选择:使用HS256算法确保性能和安全性
密码哈希优化
- 迭代次数:310000次迭代提供良好安全性
- 密钥长度:32字节输出确保足够强度
- 随机盐值:每次哈希使用不同盐值
缓存策略
flowchart LR
A[用户登录] --> B[生成JWT令牌]
B --> C[浏览器缓存]
C --> D[后续请求复用]
D --> E[减少服务器验证开销]
F[令牌过期] --> G[自动刷新机制]
G --> H[重新登录流程]
故障排除指南
常见认证问题及解决方案
令牌过期问题
问题现象:
- 前端收到401状态码
- 页面自动跳转到登录页
- 控制台显示"登录已过期"
解决方案:
- 检查JWT_SECRET配置是否正确
- 验证系统时间同步
- 确认TOKEN_TTL_HOURS设置合理
章节来源
权限不足问题
问题现象:
- 403状态码返回"需要超级管理员权限"
- 特定管理功能无法访问
解决方案:
- 确认用户是否为超级管理员
- 检查数据库中is_super_admin字段
- 验证权限中间件是否正确配置
章节来源
密码验证失败
问题现象:
- 登录时提示用户名或密码错误
- 密码哈希存储格式不正确
解决方案:
- 检查密码哈希存储格式
- 验证PBKDF2参数配置
- 确认密码比较算法正确性
章节来源
前端认证状态异常
问题现象:
- 令牌存储损坏
- 用户信息解析失败
- 自动登出问题
解决方案:
- 清除localStorage中的认证数据
- 检查令牌格式是否正确
- 验证JWT负载结构
章节来源
结论
本用户认证系统采用了现代Web应用的标准实践,实现了安全、可靠的用户认证机制。系统的主要优势包括:
- 安全性:采用JWT令牌和PBKDF2密码哈希,提供多层安全保障
- 易用性:前后端分离设计,提供清晰的API接口和错误处理
- 可维护性:模块化架构,便于扩展和维护
- 性能:合理的令牌配置和密码哈希参数,平衡安全性和性能
建议在生产环境中进一步完善的方面:
- 实现令牌刷新机制
- 添加多因素认证支持
- 增强日志审计功能
- 实施更严格的密码策略