Files
knowledge-governance/internal/pgdsn/dsn.go
T
姚章浩 cfad003499 fix(release-worker): 启动失败带端点与脱敏原因
正式 release-worker 崩溃重启时日志只有一句 connect release target database,
主机名、库名和底层原因都不在里面。现在错误里带 host:port/db、路由标识与原因。

端点去口令不等于整条日志安全:pgx 的解析错误可能原样回显连接串。新增
internal/pgdsn.Redact(按已知口令精确替换 + 按 URL/keyword 形状兜底),
错误保留 Unwrap 以便 errors.Is/As,技术原因不丢。cmd/worker 里只留库名的旧实现
换成同一个包,避免两份脱敏逻辑。libraryctl 用法补上 dead-letters。
2026-10-29 13:01:46 +08:00

82 lines
2.9 KiB
Go

// Package pgdsn 把连接串变成"可以写进日志/维护记录/错误信息"的端点描述。
//
// 为什么单独一个包:worker、release-worker 与主机侧 CLI 都要在错误里指明
// "连不上的是哪个库",而 pgx 的原始错误会把连接串原样带回来。把主机/端口/库名
// 摘出来、并把原因里的口令抹掉是同一件事,只做一份,免得某处漏改又把口令打进日志。
package pgdsn
import (
"net/url"
"regexp"
"strconv"
"strings"
"github.com/jackc/pgx/v5/pgxpool"
)
// Endpoint 返回 host:port/db(不含用户与口令)。解析不了就明确说"无法解析",
// 不把原文回显——原文里可能正好有口令。
func Endpoint(raw string) string {
if raw == "" {
return "(未配置)"
}
config, err := pgxpool.ParseConfig(raw)
if err != nil {
return "(连接串无法解析)"
}
host := config.ConnConfig.Host
if host == "" {
host = "(未指定主机)"
}
return host + ":" + strconv.FormatUint(uint64(config.ConnConfig.Port), 10) + "/" + config.ConnConfig.Database
}
// 兜底用:即使不知道原始 DSN(错误里可能夹着另一条连接串),也把这两类形状抹掉。
var (
userInfoPattern = regexp.MustCompile(`(://[^:/@\s]+:)[^@\s]*@`)
keywordPassPattern = regexp.MustCompile(`(?i)(password\s*=\s*)'?[^\s'&]*'?`)
urlPassPattern = regexp.MustCompile(`(?i)([?&]password=)[^&\s]*`)
)
// Redact 把一段错误文本里可能出现的口令抹掉,保留主机、端口、库名与原因。
//
// 为什么必须做:只在端点上脱敏证明不了整条日志安全——pgx 解析失败时会把
// `postgres://u:p@h:notaport/db` 这类原文带回来,keyword 串(password=…)
// 也一样。这里先按 raw 里能取到的口令精确替换,再按形状兜底。
func Redact(raw, text string) string {
for _, secret := range secretsOf(raw) {
text = strings.ReplaceAll(text, secret, "***")
}
text = userInfoPattern.ReplaceAllString(text, "${1}***@")
text = keywordPassPattern.ReplaceAllString(text, "${1}***")
text = urlPassPattern.ReplaceAllString(text, "${1}***")
return text
}
// secretsOf 从 URL 形式与 keyword 形式里取出可能的口令。
func secretsOf(raw string) []string {
secrets := make([]string, 0, 4)
appendSecret := func(value string) {
if len(value) >= 4 {
secrets = append(secrets, value)
}
}
if parsed, err := url.Parse(raw); err == nil && parsed.User != nil {
if password, ok := parsed.User.Password(); ok {
appendSecret(password)
}
}
if index := strings.Index(raw, "?"); index >= 0 {
if values, err := url.ParseQuery(raw[index+1:]); err == nil {
appendSecret(values.Get("password"))
}
}
for _, field := range strings.Fields(raw) {
key, value, ok := strings.Cut(field, "=")
if ok && strings.EqualFold(strings.TrimSpace(key), "password") {
appendSecret(strings.Trim(value, "'"))
}
}
return secrets
}