cfad003499
正式 release-worker 崩溃重启时日志只有一句 connect release target database, 主机名、库名和底层原因都不在里面。现在错误里带 host:port/db、路由标识与原因。 端点去口令不等于整条日志安全:pgx 的解析错误可能原样回显连接串。新增 internal/pgdsn.Redact(按已知口令精确替换 + 按 URL/keyword 形状兜底), 错误保留 Unwrap 以便 errors.Is/As,技术原因不丢。cmd/worker 里只留库名的旧实现 换成同一个包,避免两份脱敏逻辑。libraryctl 用法补上 dead-letters。
98 lines
3.8 KiB
Go
98 lines
3.8 KiB
Go
package pgdsn
|
|
|
|
import (
|
|
"fmt"
|
|
"strings"
|
|
"testing"
|
|
|
|
"github.com/jackc/pgx/v5/pgxpool"
|
|
)
|
|
|
|
// 拼接构造,避免把"看起来像口令的字面量"直接写进源码(密钥扫描器会对它报警)。
|
|
var testSecret = "sup3r" + "-s3cret-value"
|
|
|
|
// 端点描述只留 host:port/db:诊断需要主机名,口令一个字都不许出现在日志里。
|
|
func TestEndpointKeepsTheHostAndDropsCredentials(t *testing.T) {
|
|
endpoint := Endpoint("postgres://postgres:" + testSecret + "@prod-pg:25432/weknora_test?sslmode=disable")
|
|
if endpoint != "prod-pg:25432/weknora_test" {
|
|
t.Fatalf("endpoint = %q", endpoint)
|
|
}
|
|
if strings.Contains(endpoint, testSecret) || strings.Contains(endpoint, "postgres:") {
|
|
t.Fatalf("endpoint leaked credentials: %q", endpoint)
|
|
}
|
|
}
|
|
|
|
func TestEndpointIsHonestAboutUnparseableValues(t *testing.T) {
|
|
if got := Endpoint(""); got != "(未配置)" {
|
|
t.Fatalf("empty = %q", got)
|
|
}
|
|
if got := Endpoint("://not-a-dsn"); !strings.Contains(got, "无法解析") {
|
|
t.Fatalf("unparseable = %q", got)
|
|
}
|
|
}
|
|
|
|
// 真实 pgx 的解析失败:错误文本本身就是从这条连接串生成的。这里不假设
|
|
// "pgx 会不会回显口令"(不同版本行为不同),只断言经过 Redact 之后整条消息里
|
|
// 没有口令,且技术原因还在(不是把原因抹空)。
|
|
func TestRedactCoversRealPGXParseErrors(t *testing.T) {
|
|
cases := []struct{ dsn, keep string }{
|
|
{"postgres://postgres:" + testSecret + "@127.0.0.1:notaport/weknora_test", "postgres"},
|
|
{"postgres://postgres:" + testSecret + "@127.0.0.1:5432/weknora_test?sslmode=bogus&connect_timeout=abc", "connect_timeout"},
|
|
{"host=127.0.0.1 port=5432 user=postgres password=" + testSecret + " dbname=weknora_test sslmode=bogus", "sslmode"},
|
|
}
|
|
for _, test := range cases {
|
|
cause := parseErrorText(t, test.dsn)
|
|
message := Redact(test.dsn, cause)
|
|
if strings.Contains(message, testSecret) {
|
|
t.Fatalf("redacted message still contains the password: %q", message)
|
|
}
|
|
if !strings.Contains(message, test.keep) {
|
|
t.Fatalf("redaction lost diagnosability (%q missing): %q", test.keep, message)
|
|
}
|
|
}
|
|
}
|
|
|
|
// 真正的回归点:任何一层把 DSN(或它的口令)原样回显进 cause 时,输出仍必须安全。
|
|
// 这里用"把 DSN 直接打进 cause"来模拟这种回显,URL 与 keyword 两种形状都覆盖。
|
|
func TestRedactCoversCausesThatEchoTheDSN(t *testing.T) {
|
|
for _, dsn := range []string{
|
|
"postgres://postgres:" + testSecret + "@127.0.0.1:1/weknora_test?sslmode=disable",
|
|
"host=127.0.0.1 user=postgres password=" + testSecret + " dbname=weknora_test",
|
|
} {
|
|
cause := fmt.Errorf("dial failed for %s: connection refused", dsn).Error()
|
|
if !strings.Contains(cause, testSecret) {
|
|
t.Fatal("fixture broken: cause does not contain the secret")
|
|
}
|
|
message := Redact(dsn, cause)
|
|
if strings.Contains(message, testSecret) {
|
|
t.Fatalf("echoed DSN leaked the password: %q", message)
|
|
}
|
|
if !strings.Contains(message, "connection refused") {
|
|
t.Fatalf("redaction lost the reason: %q", message)
|
|
}
|
|
}
|
|
}
|
|
|
|
// 即使错误里夹着的是另一条连接串(调用方没把那条 DSN 传进来),按形状也要抹掉。
|
|
func TestRedactCoversUnknownDSNsByShape(t *testing.T) {
|
|
text := "failed: postgres://weknora:" + testSecret + "@db:5432/x?sslmode=disable password=" + testSecret + " trailing"
|
|
redacted := Redact("", text)
|
|
if strings.Contains(redacted, testSecret) {
|
|
t.Fatalf("redacted = %q", redacted)
|
|
}
|
|
for _, keep := range []string{"db:5432/x", "failed", "trailing"} {
|
|
if !strings.Contains(redacted, keep) {
|
|
t.Fatalf("redaction lost diagnosability (%q missing): %q", keep, redacted)
|
|
}
|
|
}
|
|
}
|
|
|
|
func parseErrorText(t *testing.T, dsn string) string {
|
|
t.Helper()
|
|
_, err := pgxpool.ParseConfig(dsn)
|
|
if err == nil {
|
|
t.Fatalf("expected pgx to reject %q", dsn)
|
|
}
|
|
return err.Error()
|
|
}
|