feat: 主密钥诊断与迁移命令;空/占位主密钥启动警告

渠道上游 key 用 OT_MASTER_KEY 经 AES-GCM 加密落库,主密钥一旦变化,全部渠道在运行时
报 "failed to decrypt channel key"。最常见的成因是历史实例先用了空主密钥(退化为
sha256("")),后来才补上 OT_MASTER_KEY——旧密文从此解不开,看起来像渠道全挂了。

- 新增 `check-channels`:打印主密钥派生路径与指纹(SHA-256 前 4 字节,不泄露密钥)
  + 逐渠道解密结果,区分「全部失败=主密钥不对」与「个别失败=该渠道密文异常」;
  存在失败时退出码为 1,便于脚本告警
- 新增 `rotate-master-key`:旧密钥解密、新密钥重新加密,全部渠道单事务更新,
  任一渠道解不开就整体回滚(--force 可跳过),避免库里新旧密钥混杂;
  写入前对新密文做回读校验;--dry-run 只验证不改库。空主密钥作为默认 --old,
  正是「先空后补」的历史路径;配套迁移无需重新录入任何渠道 key
- crypto 新增 KeyFingerprint / KeyMode:指纹用于比对两个实例是否同一把密钥,
  KeyMode 显式暴露「16/24/32 字节用原始字节、其他长度走 SHA-256 派生」这条
  容易踩的长度陷阱(改长度等于换密钥)
- 启动警告:开发环境不拦空/占位主密钥,但明确提示它等于公开密钥,并给出
  rotate-master-key 指引;生产环境仍由 config.validate 直接拒绝启动
- README 补主密钥与渠道密钥运维小节
- 测试:换密钥必解密失败、长度切换 32↔33 字节必失败、指纹一致性

验证:go vet、go test ./... 全绿;端到端复现「空主密钥建渠道 → 配新主密钥全部解密失败
→ rotate-master-key 迁移 → check-channels 全部正常」,明文长度与前后缀保持一致。
This commit is contained in:
Sakurasan committed 2026-11-08 23:12:17 +08:00
1 parent 531a03c836
commit 5d6e5bdb04
8 files changed
+417 -4

No files matched your search

+20
View File
@@ -90,6 +90,26 @@ cd server && go test ./...
cd web && pnpm build # vue-tsc 类型检查 + 构建
```
### 主密钥与渠道密钥运维
渠道上游 key 用 `OT_MASTER_KEY` 经 AES-GCM 加密后落库。两个运维命令:
```bash
cd server
go run ./cmd/server check-channels # 诊断:当前主密钥能否解开全部渠道
go run ./cmd/server rotate-master-key # 迁移:旧密钥解密、新密钥重新加密
```
- **`failed to decrypt channel key`**:先跑 `check-channels`。它会打印主密钥派生路径与
密钥指纹(同指纹=同一把密钥)+ 逐渠道结果;全部失败基本就是主密钥变了。
- **从「没配主密钥」升级到「配置了主密钥」**:旧密文是用 `sha256("")` 加密的,
直接配新密钥会全部解不开。用 `rotate-master-key`(`--old` 留空即空密钥)迁移,
不需要重新录入任何渠道 key;全部渠道在一个事务里更新,解不开就整体回滚。
- **主密钥长度陷阱**:16/24/32 字节直接用原始字节,其他长度走 SHA-256 派生。
改长度等于换了一把密钥——轮换请用 `rotate-master-key`,不要直接改 `OT_MASTER_KEY`。
- 生产环境(`OT_ENV=production`)缺失主密钥、少于 16 字节或仍是示例占位值会拒绝启动;
开发环境允许为空,但启动时会打警告(空主密钥等于公开密钥)。
## 仓库结构
```
+8
View File
@@ -53,6 +53,14 @@ func New(cfg *config.Config) (*App, error) {
a.Usage = usage.NewRecorder(db)
a.Limit = ratelimit.New()
// 开发环境不拦空/占位主密钥,但必须让人看见:空主密钥退化为 sha256(""),
// 任何能读到数据库的人都能解出全部上游 key。这类实例后续补上 OT_MASTER_KEY
// 会直接变成「全部渠道解密失败」,所以一并给出迁移命令。
if reason := cfg.InsecureMasterKey(); reason != "" {
log.Printf("WARN: OT_MASTER_KEY %s;任何能读到数据库的人都能解出上游 key。"+
"配置真实主密钥后执行 `openteam rotate-master-key` 迁移已有渠道(无需重填 key)", reason)
}
if err := a.Seed(); err != nil {
return nil, err
}
+115
View File
@@ -0,0 +1,115 @@
// Package cli 命令行入口。
package cli
import (
"fmt"
"log"
"os"
"github.com/openteam/server/internal/config"
"github.com/openteam/server/internal/pkg/crypto"
"github.com/openteam/server/internal/store"
"github.com/spf13/cobra"
)
var checkChannelsCmd = &cobra.Command{
Use: "check-channels",
Short: "诊断渠道上游密钥能否用当前主密钥解密",
Long: `诊断渠道上游密钥能否用当前主密钥(OT_MASTER_KEY)解密。
出现 "failed to decrypt channel key" 时先跑这个:它会把当前主密钥的派生路径和
指纹打出来,并逐个渠道试解密,从而区分两种情况:
1. 主密钥被换过/没加载到(常见:换了 OT_MASTER_KEY、从无 .env 变成有 .env、
密钥长度变化导致从「原始字节」切到「SHA-256 派生」)——需要换回原主密钥;
2. 主密钥对、但个别渠道密文被外部改写——该渠道重填上游 key 即可。
主密钥一旦丢失无法恢复(AES-GCM 没有后门),只能重新录入每个渠道的上游 key。
退出码:全部可解密为 0;存在无法解密的渠道为 1(便于脚本告警)。`,
Run: func(cmd *cobra.Command, args []string) {
runCheckChannels()
},
}
func init() {
rootCmd.AddCommand(checkChannelsCmd)
}
func runCheckChannels() {
cfg, err := config.Load()
if err != nil {
log.Fatalf("加载配置失败: %v", err)
}
db, err := store.Open(cfg.DB.Driver, cfg.DB.DSN)
if err != nil {
log.Fatalf("连接数据库失败: %v", err)
}
enc := crypto.NewEncryptor(cfg.Master)
fmt.Printf("数据库: %s (%s)\n", cfg.DB.DSN, cfg.DB.Driver)
fmt.Printf("主密钥: %s\n", describeMaster(cfg.Master))
fmt.Printf("密钥指纹: %s(同指纹=同一把密钥;换过主密钥后这里会变)\n", enc.KeyFingerprint())
fmt.Printf("运行环境: OT_ENV=%s\n\n", cfg.Env)
var chs []store.Channel
if err := db.Order("id").Find(&chs).Error; err != nil {
log.Fatalf("读取渠道失败: %v", err)
}
if len(chs) == 0 {
fmt.Println("没有渠道。")
return
}
okCount, failCount := 0, 0
for _, ch := range chs {
state := ""
if !ch.Enabled {
state = " [停用]"
}
plain, derr := enc.Decrypt(ch.APIKeyEnc)
switch {
case derr != nil:
failCount++
fmt.Printf(" [失败] #%-3d %-20s%s %v\n", ch.ID, ch.Name, state, derr)
case plain == "":
okCount++
fmt.Printf(" [空值] #%-3d %-20s%s 解密成功但内容为空\n", ch.ID, ch.Name, state)
default:
okCount++
fmt.Printf(" [正常] #%-3d %-20s%s 解密正常(key 长度 %d,前缀 %s)\n",
ch.ID, ch.Name, state, len(plain), maskKey(plain))
}
}
fmt.Printf("\n合计:%d 个渠道,%d 个可解密,%d 个失败\n", len(chs), okCount, failCount)
if failCount > 0 {
fmt.Print(`
诊断建议:
· 如果「全部」渠道都失败:几乎一定是主密钥不对。核对 OT_MASTER_KEY:
- 是否换了值,或者启动目录变了导致 .env 没被读到(.env 按当前工作目录读取);
- 主密钥长度是否变了——16/24/32 字节直接用原始字节,其他长度走 SHA-256 派生,
改长度等于换了一把密钥。
用原主密钥重启即可恢复;原值丢失则只能重新录入各渠道上游 key(AES-GCM 无法逆向)。
· 如果只有「个别」渠道失败:这些渠道的密文被改过或从别的库导入,
在管理后台重新填一次上游 key 即可。
`)
os.Exit(1)
}
}
func describeMaster(master string) string {
if master == "" {
return "未设置!用的是 sha256(\"\") 派生(公开可还原,生产必须配置 OT_MASTER_KEY)"
}
enc := crypto.NewEncryptor(master)
return fmt.Sprintf("已设置,%d 字节,%s", len(master), enc.KeyMode())
}
// maskKey 只露上游 key 的首尾各 4 个字符(排障时确认是不是填错了 key)。
func maskKey(s string) string {
if len(s) <= 8 {
return "****"
}
return s[:4] + "…" + s[len(s)-4:]
}
+2
View File
@@ -19,6 +19,8 @@ var rootCmd = &cobra.Command{
go run ./cmd/server
子命令:
check-channels 诊断渠道上游密钥能否用当前主密钥解密
rotate-master-key 主密钥迁移:旧密钥解密、新密钥重新加密
reset-admin-password 重置管理员密码(交互式,无参数时自动提示)
reset-password 重置任意用户密码`,
RunE: func(c *cobra.Command, args []string) error {
+177
View File
@@ -0,0 +1,177 @@
// Package cli 命令行入口。
package cli
import (
"fmt"
"log"
"os"
"github.com/openteam/server/internal/config"
"github.com/openteam/server/internal/pkg/crypto"
"github.com/openteam/server/internal/store"
"github.com/spf13/cobra"
"gorm.io/gorm"
)
var (
rotateOldKey string
rotateNewKey string
rotateDryRun bool
rotateForce bool
)
var rotateMasterKeyCmd = &cobra.Command{
Use: "rotate-master-key",
Short: "用旧主密钥解密渠道密钥、再用新主密钥重新加密(主密钥迁移)",
Long: `主密钥迁移:把渠道上游 key 从旧主密钥改为用新主密钥加密。
典型场景:实例最初没有配置 OT_MASTER_KEY(用的是 sha256("") 派生的空密钥加密),
后来补上了 OT_MASTER_KEY,于是所有渠道在运行时报 "failed to decrypt channel key"。
运行本命令后重启服务即可恢复,不需要重新录入各渠道的上游 key。
用法:
# 旧密钥为空(历史默认 sha256("")),新密钥取当前配置的 OT_MASTER_KEY
go run ./cmd/server rotate-master-key
# 显式指定旧密钥
go run ./cmd/server rotate-master-key --old "旧主密钥"
# 只验证不改库
go run ./cmd/server rotate-master-key --dry-run
新主密钥默认用当前环境/配置里的 OT_MASTER_KEY(必须非空)。全部渠道在同一个事务里
更新:任一渠道用旧密钥解不开就整体回滚(除非 --force 跳过这些渠道),避免库里
出现新旧密钥混杂、下次还得再猜一遍的状态。
注意:命令成功只改了库,跑完必须用新主密钥重启服务!`,
Run: func(cmd *cobra.Command, args []string) {
runRotateMasterKey()
},
}
func init() {
rootCmd.AddCommand(rotateMasterKeyCmd)
rotateMasterKeyCmd.Flags().StringVar(&rotateOldKey, "old", "", "旧主密钥(留空表示历史默认的空密钥,即 sha256(\"\"))")
rotateMasterKeyCmd.Flags().StringVar(&rotateNewKey, "new", "", "新主密钥(留空则用配置里的 OT_MASTER_KEY)")
rotateMasterKeyCmd.Flags().BoolVar(&rotateDryRun, "dry-run", false, "只验证能否用旧密钥解密,不改库")
rotateMasterKeyCmd.Flags().BoolVar(&rotateForce, "force", false, "跳过旧密钥解不开的渠道(默认整体回滚)")
}
func runRotateMasterKey() {
cfg, err := config.Load()
if err != nil {
log.Fatalf("加载配置失败: %v", err)
}
newMaster := rotateNewKey
if newMaster == "" {
newMaster = cfg.Master
}
if newMaster == "" {
log.Fatal("新主密钥为空:请用 --new 指定,或先配置 OT_MASTER_KEY")
}
oldEnc := crypto.NewEncryptor(rotateOldKey)
newEnc := crypto.NewEncryptor(newMaster)
if oldEnc.KeyFingerprint() == newEnc.KeyFingerprint() {
fmt.Println("旧密钥与新密钥指纹相同(同一把密钥),无需迁移。")
return
}
db, err := store.Open(cfg.DB.Driver, cfg.DB.DSN)
if err != nil {
log.Fatalf("连接数据库失败: %v", err)
}
fmt.Printf("数据库: %s (%s)\n", cfg.DB.DSN, cfg.DB.Driver)
fmt.Printf("旧密钥: %s,指纹 %s\n", describeOldKey(rotateOldKey), oldEnc.KeyFingerprint())
fmt.Printf("新密钥: %s,指纹 %s\n", describeMaster(newMaster), newEnc.KeyFingerprint())
if rotateDryRun {
fmt.Println("模式: dry-run(只验证,不改库)")
}
fmt.Println()
var chs []store.Channel
if err := db.Order("id").Find(&chs).Error; err != nil {
log.Fatalf("读取渠道失败: %v", err)
}
if len(chs) == 0 {
fmt.Println("没有渠道,无需迁移。")
return
}
type pending struct {
id uint64
name string
newEncV string
}
var todo []pending
var failed []string
for _, ch := range chs {
plain, derr := oldEnc.Decrypt(ch.APIKeyEnc)
if derr != nil {
failed = append(failed, fmt.Sprintf("#%d %s: %v", ch.ID, ch.Name, derr))
continue
}
re, eerr := newEnc.Encrypt(plain)
if eerr != nil {
failed = append(failed, fmt.Sprintf("#%d %s: 重新加密失败: %v", ch.ID, ch.Name, eerr))
continue
}
// 回读校验:写进库之前确认新密文能被新密钥解开,避免把渠道写成谁也解不开的状态
if back, berr := newEnc.Decrypt(re); berr != nil || back != plain {
failed = append(failed, fmt.Sprintf("#%d %s: 新密文回读校验失败", ch.ID, ch.Name))
continue
}
todo = append(todo, pending{id: ch.ID, name: ch.Name, newEncV: re})
}
for _, f := range failed {
fmt.Printf(" [失败] %s\n", f)
}
if len(todo) > 0 {
fmt.Printf(" [就绪] %d 个渠道可用旧密钥解密并已用新密钥重新加密\n", len(todo))
}
if len(failed) > 0 && !rotateForce {
fmt.Printf("\n%d 个渠道无法用旧密钥解密,已整体回滚(未改动任何数据)。\n", len(failed))
fmt.Println("如果这些渠道本就该用另一把密钥,可用 --force 跳过它们只迁移其余渠道;")
fmt.Println("如果全部失败,说明 --old 猜错了:用 check-channels 的指纹逐个核对候选旧密钥。")
os.Exit(1)
}
if len(todo) == 0 {
fmt.Println("\n没有可迁移的渠道。")
return
}
if rotateDryRun {
fmt.Printf("\ndry-run:以上 %d 个渠道迁移可行,未改动数据库。\n", len(todo))
return
}
if err := db.Transaction(func(tx *gorm.DB) error {
for _, p := range todo {
if err := tx.Model(&store.Channel{}).Where("id = ?", p.id).
Update("api_key_enc", p.newEncV).Error; err != nil {
return fmt.Errorf("渠道 #%d %s: %w", p.id, p.name, err)
}
}
return nil
}); err != nil {
log.Fatalf("写入失败,已回滚: %v", err)
}
fmt.Printf("\n迁移完成:%d 个渠道已改用新主密钥加密。\n", len(todo))
fmt.Println("现在用新主密钥重启服务,然后运行 check-channels 确认全部「正常」。")
if len(failed) > 0 {
fmt.Printf("仍有 %d 个渠道未迁移(用 --force 跳过的),需要在管理后台重填上游 key。\n", len(failed))
}
}
// describeOldKey 说明旧密钥形态;空值单独提示,因为那正是历史默认行为。
func describeOldKey(master string) string {
if master == "" {
return "空(历史默认:sha256(\"\") 派生)"
}
return describeMaster(master)
}
+13
View File
@@ -302,3 +302,16 @@ func knownSecret(s string) bool {
}
return false
}
// InsecureMasterKey 返回主密钥不可用的原因,安全时返回空串。
// 生产环境由 validate 直接拒绝启动;开发环境不拦,但启动时要打警告——
// 空主密钥会退化成 sha256(""),任何能读到数据库的人都能解出全部上游 key。
func (c *Config) InsecureMasterKey() string {
if c.Master == "" {
return `未设置,渠道密钥用公开可还原的 sha256("") 加密`
}
if knownSecret(c.Master) {
return "仍是仓库示例文件里的占位值,等同于公开密钥"
}
return ""
}
+27 -3
View File
@@ -5,8 +5,10 @@ import (
"crypto/aes"
"crypto/cipher"
"crypto/rand"
"crypto/sha256"
"crypto/subtle"
"encoding/base64"
"encoding/hex"
"errors"
"fmt"
"strings"
@@ -68,18 +70,40 @@ func (h *PasswordHasher) VerifyPassword(encoded, password string) (bool, error)
// Encryptor 用主密钥加解密渠道上游 key。
type Encryptor struct {
key []byte
key []byte
mode string // 派生路径说明(排障用)
}
// NewEncryptor 主密钥必须为 16/24/32 字节;不足时用 SHA-256 派生固定 32 字节。
// 长度陷阱:16/24/32 字节直接用原始字节,其他长度走 SHA-256 派生——把主密钥改成
// 另一个长度(或从 32 字节改成 33 字符)就切换到另一条路径,等价于换了一把密钥,
// 历史密文会全部解不开。
func NewEncryptor(master string) *Encryptor {
key := []byte(master)
mode := ""
switch len(key) {
case 16, 24, 32:
case 16:
mode = "raw-16(AES-128,直接用主密钥原始字节)"
case 24:
mode = "raw-24(AES-192,直接用主密钥原始字节)"
case 32:
mode = "raw-32(AES-256,直接用主密钥原始字节)"
default:
key = sha256Sum(master)
mode = fmt.Sprintf("derived-32(主密钥 %d 字节,经 SHA-256 派生)", len(master))
}
return &Encryptor{key: key}
return &Encryptor{key: key, mode: mode}
}
// KeyMode 说明这把主密钥走的是哪条派生路径(排障用,不泄露密钥)。
func (e *Encryptor) KeyMode() string { return e.mode }
// KeyFingerprint 派生后 AES 密钥的指纹(SHA-256 前 4 字节 hex)。
// 只用于确认「两个实例是不是同一把主密钥」:指纹相同必然能互相解密,
// 不同必然解不开,且不泄露密钥本身。
func (e *Encryptor) KeyFingerprint() string {
sum := sha256.Sum256(e.key)
return hex.EncodeToString(sum[:4])
}
// Encrypt 输出 base64(nonce || ciphertext)
+55 -1
View File
@@ -1,6 +1,9 @@
package crypto
import "testing"
import (
"strings"
"testing"
)
func TestPasswordHashRoundTrip(t *testing.T) {
h := NewPasswordHasher(1, 64*1024, 1, 32, 16)
@@ -43,3 +46,54 @@ func TestEncryptorShortKeyDerived(t *testing.T) {
t.Fatalf("Encrypt with short key: %v", err)
}
}
// 主密钥换过(值不同)必然解不开:这是 "failed to decrypt channel key" 的根因。
func TestEncryptorWrongKeyFails(t *testing.T) {
a := NewEncryptor("master-key-AAAAAAAAAAAAAAAAAAAAAAAA")
b := NewEncryptor("master-key-BBBBBBBBBBBBBBBBBBBBBBBB")
enc, err := a.Encrypt("sk-upstream-secret")
if err != nil {
t.Fatalf("Encrypt: %v", err)
}
if _, err := b.Decrypt(enc); err == nil {
t.Fatal("换了主密钥仍能解密:加解密强度有问题")
}
}
// 长度陷阱:32 字节走原始字节,33 字节走 SHA-256 派生,两者是不同的密钥。
func TestEncryptorKeyLengthModeSwitch(t *testing.T) {
raw32 := "0123456789abcdef0123456789abcdef" // 32 字节
derived := raw32 + "x" // 33 字节 → 派生
enc, err := NewEncryptor(raw32).Encrypt("secret")
if err != nil {
t.Fatalf("Encrypt: %v", err)
}
if _, err := NewEncryptor(derived).Decrypt(enc); err == nil {
t.Fatal("长度变化后仍在用同一把密钥:派生路径切换应导致解密失败")
}
if got := NewEncryptor(raw32).KeyMode(); got == "" || !strings.Contains(got, "raw-32") {
t.Fatalf("32 字节应报 raw-32,实际 %q", got)
}
if got := NewEncryptor(derived).KeyMode(); !strings.Contains(got, "derived-32") {
t.Fatalf("33 字节应报 derived-32,实际 %q", got)
}
}
// 指纹只用于比对,不泄露密钥;同密钥同指纹、异密钥异指纹。
func TestEncryptorKeyFingerprint(t *testing.T) {
a1 := NewEncryptor("same-master-key-1234567890")
a2 := NewEncryptor("same-master-key-1234567890")
b := NewEncryptor("other-master-key-123456789")
if a1.KeyFingerprint() != a2.KeyFingerprint() {
t.Fatal("同一主密钥的指纹应一致")
}
if a1.KeyFingerprint() == b.KeyFingerprint() {
t.Fatal("不同主密钥的指纹不应相同")
}
if len(a1.KeyFingerprint()) != 8 {
t.Fatalf("指纹应为 4 字节 hex(8 字符),实际 %q", a1.KeyFingerprint())
}
if strings.Contains(a1.KeyFingerprint(), "same-master-key") {
t.Fatal("指纹不应包含密钥内容")
}
}