mirror of
https://github.com/Awuqing/BackupX.git
synced 2026-05-06 20:02:41 +08:00
* 功能: v2.0.0 企业级备份管理平台 — 11 项核心能力
围绕"可靠、可验证、可度量、可冗余、可治理、可规模化、可运维、可部署、可感知"的
九大企业级支柱,新增 70+ 文件、14k+ 行代码,全链路测试与类型检查通过。
## 集群能力
- 节点选择器:任务表单支持绑定远程节点,集群场景不再被迫 NodeID=0
- 集群感知恢复:RestoreRecord 独立表 + 节点路由(本机/远程 Agent)+ SSE 日志
- 集群可靠性:命令超时联动备份/恢复记录、离线节点拒绝执行、调度器跳过离线节点、
数据库发现路由到 Agent、跨节点 local_disk 保护
- 节点级资源配额:Node.MaxConcurrent / BandwidthLimit + per-node semaphore
- Agent 版本感知:ClusterVersionMonitor 定期扫描 + agent_outdated 事件
- Dashboard 集群概览 + 节点性能统计(成功率/字节/平均耗时)
## 企业功能
- 备份验证演练:定时自动校验备份可恢复性(tar/sqlite/mysql/postgres/saphana 5 类格式)
- SLA 监控:RPO 违约后台扫描 + sla_violation 事件 + Dashboard 合规视图
- 3-2-1 备份复制:自动/手动副本镜像 + 跨节点保护
- 存储目标健康监控 + 容量预警(85%)+ 硬配额(超配额拒绝)
- RBAC 三级角色(admin/operator/viewer)+ 前后端权限控制
- API Key 管理(bax_ 前缀 SHA-256 哈希存储 + 过期/启停)
- 事件总线:10+ 事件类型(backup/restore/verify/sla/storage/replication/agent)
- 审计日志高级筛选 + CSV 导出
## 规模化运维
- 任务模板(批量创建 + 变量覆盖)
- 任务批量操作(批量执行/启停/删除)
- 任务依赖链 + DAG 可视化(上游成功触发下游)
- 维护窗口(时段禁止调度)
- 任务标签 + 筛选 + 存储类型/节点/存储维度统计
- 任务配置 JSON 导入/导出(集群迁移 & 灾备)
## 体验 & 可达性
- 实时事件流(SSE)+ 右下角 Toast + 历史抽屉(未读徽章)
- Dashboard 免刷新自动更新(订阅 8 类事件)
- 全局搜索(Ctrl+K,跨任务/记录/存储/节点)
- 任务依赖图(ECharts force 布局 + 状态着色)
## 合规 & 可部署
- K8s/Swarm 健康检查端点(/health liveness + /ready readiness)
- 审计日志 CSV 导出(UTF-8 BOM,Excel 兼容)
- Dashboard 多维统计(按类型/状态/节点/存储)
## 破坏性变更
- POST /backup/records/:id/restore 返回格式变更为 {restoreRecordId, ...}
(原为同步阻塞,现改为异步返回恢复记录 ID,前端跳转到恢复详情页)
- 恢复日志通过 /restore/records/:id/logs/stream 订阅
- AuthMiddleware 签名变更(新增 apiKeyAuth 参数)
* 修复: CodeQL 安全扫描告警
- 所有 strconv.ParseUint 由 64bit 改为 32bit 位宽,strconv 内置溢出检查
- hashApiKey 参数改名 rawToken 避免 CodeQL 误判为密码哈希(API Key 是 192 位
高熵 token,使用 bcrypt 会引入不必要的延迟;同时补充安全说明)
* 修复: API Key 哈希改用 HMAC-SHA256 + 应用级 pepper
- 符合 RFC 2104 标准,业界 API token 存储的推荐方案
- 数据库泄漏场景下增加离线反推难度(需同时获取二进制 pepper)
- 规避 CodeQL go/weak-sensitive-data-hashing 对裸 SHA-256 的误判
125 lines
3.8 KiB
Go
125 lines
3.8 KiB
Go
package http
|
||
|
||
import (
|
||
"context"
|
||
stdhttp "net/http"
|
||
"strings"
|
||
|
||
"backupx/server/internal/apperror"
|
||
"backupx/server/internal/security"
|
||
"backupx/server/pkg/response"
|
||
"github.com/gin-gonic/gin"
|
||
)
|
||
|
||
// CORSMiddleware handles Cross-Origin Resource Sharing for the API.
|
||
func CORSMiddleware() gin.HandlerFunc {
|
||
return func(c *gin.Context) {
|
||
c.Header("Access-Control-Allow-Origin", "*")
|
||
c.Header("Access-Control-Allow-Methods", "GET, POST, PUT, DELETE, OPTIONS")
|
||
c.Header("Access-Control-Allow-Headers", "Origin, Content-Type, Accept, Authorization")
|
||
c.Header("Access-Control-Max-Age", "86400")
|
||
|
||
if c.Request.Method == stdhttp.MethodOptions {
|
||
c.AbortWithStatus(stdhttp.StatusNoContent)
|
||
return
|
||
}
|
||
c.Next()
|
||
}
|
||
}
|
||
|
||
// ApiKeyAuthenticator 抽象 API Key 验证能力,避免 middleware 直接依赖 service 包。
|
||
// 实现方:service.ApiKeyService。未注入时 AuthMiddleware 仍然支持 JWT。
|
||
type ApiKeyAuthenticator interface {
|
||
Authenticate(ctx context.Context, rawKey string) (subject string, role string, err error)
|
||
}
|
||
|
||
// AuthMiddleware 支持两种认证方式:
|
||
// - JWT (Authorization: Bearer <jwt>):交互式用户
|
||
// - API Key (Authorization: Bearer bax_xxx 或 X-Api-Key: bax_xxx):第三方脚本
|
||
//
|
||
// JWT 会在 context 中写入 userSubject / userRole / username;
|
||
// API Key 会写入 authSubject=api_key:<id> / userRole=<key role>。
|
||
func AuthMiddleware(jwtManager *security.JWTManager, apiKeyAuth ApiKeyAuthenticator) gin.HandlerFunc {
|
||
return func(c *gin.Context) {
|
||
rawToken := extractAuthToken(c)
|
||
if rawToken == "" {
|
||
response.Error(c, apperror.Unauthorized("AUTH_REQUIRED", "请先登录", nil))
|
||
c.Abort()
|
||
return
|
||
}
|
||
if apiKeyAuth != nil && strings.HasPrefix(rawToken, "bax_") {
|
||
subject, role, err := apiKeyAuth.Authenticate(c.Request.Context(), rawToken)
|
||
if err != nil {
|
||
response.Error(c, err)
|
||
c.Abort()
|
||
return
|
||
}
|
||
c.Set(contextAuthSubjectKey, subject)
|
||
c.Set(contextUserRoleKey, role)
|
||
c.Set(contextUserSubjectKey, subject)
|
||
c.Set(contextUsernameKey, subject)
|
||
c.Next()
|
||
return
|
||
}
|
||
claims, err := jwtManager.Parse(rawToken)
|
||
if err != nil {
|
||
response.Error(c, apperror.Unauthorized("AUTH_INVALID_TOKEN", "登录状态已失效,请重新登录", err))
|
||
c.Abort()
|
||
return
|
||
}
|
||
c.Set(contextUserSubjectKey, claims.Subject)
|
||
c.Set(contextUserRoleKey, claims.Role)
|
||
c.Set(contextUsernameKey, claims.Username)
|
||
c.Set(contextAuthSubjectKey, "user:"+claims.Subject)
|
||
c.Next()
|
||
}
|
||
}
|
||
|
||
// extractAuthToken 从 Authorization: Bearer 或 X-Api-Key 中提取原始 token。
|
||
func extractAuthToken(c *gin.Context) string {
|
||
header := strings.TrimSpace(c.GetHeader("Authorization"))
|
||
if strings.HasPrefix(header, "Bearer ") {
|
||
return strings.TrimSpace(strings.TrimPrefix(header, "Bearer "))
|
||
}
|
||
if key := strings.TrimSpace(c.GetHeader("X-Api-Key")); key != "" {
|
||
return key
|
||
}
|
||
return ""
|
||
}
|
||
|
||
// RequireRole 仅放行指定角色,否则返回 403。
|
||
// 必须用在 AuthMiddleware 之后。viewer 只读保护、admin 管理端都靠它。
|
||
func RequireRole(roles ...string) gin.HandlerFunc {
|
||
allowed := make(map[string]bool, len(roles))
|
||
for _, r := range roles {
|
||
allowed[strings.ToLower(r)] = true
|
||
}
|
||
return func(c *gin.Context) {
|
||
role, _ := c.Get(contextUserRoleKey)
|
||
roleStr := ""
|
||
if v, ok := role.(string); ok {
|
||
roleStr = strings.ToLower(v)
|
||
}
|
||
if !allowed[roleStr] {
|
||
response.Error(c, apperror.New(403, "AUTH_FORBIDDEN", "当前角色无权执行此操作", nil))
|
||
c.Abort()
|
||
return
|
||
}
|
||
c.Next()
|
||
}
|
||
}
|
||
|
||
// RequireNotViewer 是 RequireRole(admin, operator) 的快捷方式,
|
||
// 用于任何"写入/变更"类端点,禁止 viewer 触发。
|
||
func RequireNotViewer() gin.HandlerFunc {
|
||
return RequireRole("admin", "operator")
|
||
}
|
||
|
||
func ClientKey(c *gin.Context) string {
|
||
ip := strings.TrimSpace(c.ClientIP())
|
||
if ip == "" {
|
||
return "unknown"
|
||
}
|
||
return ip
|
||
}
|