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 的误判
208 lines
5.7 KiB
Go
208 lines
5.7 KiB
Go
package http
|
||
|
||
import (
|
||
"encoding/json"
|
||
"fmt"
|
||
"io"
|
||
"strconv"
|
||
"strings"
|
||
"time"
|
||
|
||
"backupx/server/internal/apperror"
|
||
"backupx/server/internal/backup"
|
||
"backupx/server/internal/service"
|
||
"backupx/server/pkg/response"
|
||
|
||
"github.com/gin-gonic/gin"
|
||
)
|
||
|
||
// VerificationHandler 提供验证记录列表/详情/SSE,以及手动触发入口。
|
||
type VerificationHandler struct {
|
||
service *service.VerificationService
|
||
auditService *service.AuditService
|
||
}
|
||
|
||
func NewVerificationHandler(verifyService *service.VerificationService, auditService *service.AuditService) *VerificationHandler {
|
||
return &VerificationHandler{service: verifyService, auditService: auditService}
|
||
}
|
||
|
||
// TriggerByTask 接收任务级手动触发。使用最新成功备份为源。
|
||
func (h *VerificationHandler) TriggerByTask(c *gin.Context) {
|
||
taskID, ok := parseUintParam(c, "id")
|
||
if !ok {
|
||
return
|
||
}
|
||
var input struct {
|
||
Mode string `json:"mode"`
|
||
}
|
||
_ = c.ShouldBindJSON(&input)
|
||
triggeredBy := ""
|
||
if subject, exists := c.Get(contextUserSubjectKey); exists {
|
||
triggeredBy = strings.TrimSpace(fmt.Sprintf("%v", subject))
|
||
}
|
||
if triggeredBy == "" {
|
||
triggeredBy = "manual"
|
||
}
|
||
detail, err := h.service.StartByTask(c.Request.Context(), taskID, input.Mode, triggeredBy)
|
||
if err != nil {
|
||
response.Error(c, err)
|
||
return
|
||
}
|
||
recordAudit(c, h.auditService, "backup_verify", "manual_run", "backup_task", fmt.Sprintf("%d", taskID), "",
|
||
fmt.Sprintf("手动触发验证(任务 ID: %d, 验证记录 ID: %d, 模式: %s)", taskID, detail.ID, detail.Mode))
|
||
response.Success(c, detail)
|
||
}
|
||
|
||
// TriggerByRecord 基于指定备份记录触发验证(允许验证历史备份)。
|
||
func (h *VerificationHandler) TriggerByRecord(c *gin.Context) {
|
||
recordID, ok := parseUintParam(c, "id")
|
||
if !ok {
|
||
return
|
||
}
|
||
var input struct {
|
||
Mode string `json:"mode"`
|
||
}
|
||
_ = c.ShouldBindJSON(&input)
|
||
triggeredBy := ""
|
||
if subject, exists := c.Get(contextUserSubjectKey); exists {
|
||
triggeredBy = strings.TrimSpace(fmt.Sprintf("%v", subject))
|
||
}
|
||
if triggeredBy == "" {
|
||
triggeredBy = "manual"
|
||
}
|
||
detail, err := h.service.Start(c.Request.Context(), recordID, input.Mode, triggeredBy)
|
||
if err != nil {
|
||
response.Error(c, err)
|
||
return
|
||
}
|
||
recordAudit(c, h.auditService, "backup_verify", "manual_run", "backup_record", fmt.Sprintf("%d", recordID), "",
|
||
fmt.Sprintf("手动触发验证(备份记录 ID: %d, 验证记录 ID: %d, 模式: %s)", recordID, detail.ID, detail.Mode))
|
||
response.Success(c, detail)
|
||
}
|
||
|
||
func (h *VerificationHandler) List(c *gin.Context) {
|
||
filter, err := buildVerifyFilter(c)
|
||
if err != nil {
|
||
response.Error(c, err)
|
||
return
|
||
}
|
||
items, err := h.service.List(c.Request.Context(), filter)
|
||
if err != nil {
|
||
response.Error(c, err)
|
||
return
|
||
}
|
||
response.Success(c, items)
|
||
}
|
||
|
||
func (h *VerificationHandler) Get(c *gin.Context) {
|
||
id, ok := parseUintParam(c, "id")
|
||
if !ok {
|
||
return
|
||
}
|
||
item, err := h.service.Get(c.Request.Context(), id)
|
||
if err != nil {
|
||
response.Error(c, err)
|
||
return
|
||
}
|
||
response.Success(c, item)
|
||
}
|
||
|
||
func (h *VerificationHandler) StreamLogs(c *gin.Context) {
|
||
id, ok := parseUintParam(c, "id")
|
||
if !ok {
|
||
return
|
||
}
|
||
detail, err := h.service.Get(c.Request.Context(), id)
|
||
if err != nil {
|
||
response.Error(c, err)
|
||
return
|
||
}
|
||
events := detail.LogEvents
|
||
completed := detail.Status != "running"
|
||
channel, cancel, err := h.service.SubscribeLogs(c.Request.Context(), id, 64)
|
||
if err != nil {
|
||
response.Error(c, err)
|
||
return
|
||
}
|
||
defer cancel()
|
||
c.Writer.Header().Set("Content-Type", "text/event-stream")
|
||
c.Writer.Header().Set("Cache-Control", "no-cache")
|
||
c.Writer.Header().Set("Connection", "keep-alive")
|
||
flusher, ok := c.Writer.(interface{ Flush() })
|
||
if !ok {
|
||
response.Error(c, apperror.Internal("VERIFY_STREAM_UNSUPPORTED", "当前连接不支持日志流", nil))
|
||
return
|
||
}
|
||
for _, event := range events {
|
||
if err := writeVerifySSEEvent(c.Writer, event); err != nil {
|
||
return
|
||
}
|
||
flusher.Flush()
|
||
}
|
||
if completed {
|
||
return
|
||
}
|
||
for {
|
||
select {
|
||
case <-c.Request.Context().Done():
|
||
return
|
||
case event, ok := <-channel:
|
||
if !ok {
|
||
return
|
||
}
|
||
if err := writeVerifySSEEvent(c.Writer, event); err != nil {
|
||
return
|
||
}
|
||
flusher.Flush()
|
||
if event.Completed {
|
||
return
|
||
}
|
||
}
|
||
}
|
||
}
|
||
|
||
func buildVerifyFilter(c *gin.Context) (service.VerificationRecordListInput, error) {
|
||
var filter service.VerificationRecordListInput
|
||
if value := strings.TrimSpace(c.Query("taskId")); value != "" {
|
||
parsed, err := strconv.ParseUint(value, 10, 32)
|
||
if err != nil {
|
||
return filter, apperror.BadRequest("VERIFY_RECORD_FILTER_INVALID", "taskId 不合法", err)
|
||
}
|
||
v := uint(parsed)
|
||
filter.TaskID = &v
|
||
}
|
||
if value := strings.TrimSpace(c.Query("backupRecordId")); value != "" {
|
||
parsed, err := strconv.ParseUint(value, 10, 32)
|
||
if err != nil {
|
||
return filter, apperror.BadRequest("VERIFY_RECORD_FILTER_INVALID", "backupRecordId 不合法", err)
|
||
}
|
||
v := uint(parsed)
|
||
filter.BackupRecordID = &v
|
||
}
|
||
filter.Status = strings.TrimSpace(c.Query("status"))
|
||
if dateFrom := strings.TrimSpace(c.Query("dateFrom")); dateFrom != "" {
|
||
parsed, err := time.Parse(time.RFC3339, dateFrom)
|
||
if err != nil {
|
||
return filter, apperror.BadRequest("VERIFY_RECORD_FILTER_INVALID", "dateFrom 必须为 RFC3339 时间格式", err)
|
||
}
|
||
filter.DateFrom = &parsed
|
||
}
|
||
if dateTo := strings.TrimSpace(c.Query("dateTo")); dateTo != "" {
|
||
parsed, err := time.Parse(time.RFC3339, dateTo)
|
||
if err != nil {
|
||
return filter, apperror.BadRequest("VERIFY_RECORD_FILTER_INVALID", "dateTo 必须为 RFC3339 时间格式", err)
|
||
}
|
||
filter.DateTo = &parsed
|
||
}
|
||
return filter, nil
|
||
}
|
||
|
||
func writeVerifySSEEvent(writer io.Writer, event backup.LogEvent) error {
|
||
payload, err := json.Marshal(event)
|
||
if err != nil {
|
||
return err
|
||
}
|
||
_, err = fmt.Fprintf(writer, "event: log\ndata: %s\n\n", payload)
|
||
return err
|
||
}
|