fix(middleware): mask camelCase secret fields in request logs

The request logger's sanitizeBody only matched lowercase / snake_case
field names (api_key, apikey, access_token, ...), so values for the
camelCase JSON fields actually used by the API (apiKey, secretKey,
refreshToken, accessToken, ...) were written to logs in clear text.

Replace the per-field patterns with a single case-insensitive regex
that tolerates optional `_`/`-` separators, covering snake_case,
camelCase and PascalCase variants, and extend coverage to id_token,
client_secret, private_key, auth_token, api_secret and passwd. The
field name is preserved; only its value is replaced with "***".

Add unit tests for sanitizeBody covering the previously-leaking
camelCase fields and common variants.

Fixes #1287
This commit is contained in:
wizardchen
2026-05-12 19:24:34 +08:00
committed by lyingbug
parent cacca049d9
commit 86b05d923e
2 changed files with 70 additions and 23 deletions
+9 -23
View File
@@ -39,31 +39,17 @@ func (r loggerResponseBodyWriter) Write(b []byte) (int, error) {
return r.ResponseWriter.Write(b)
}
// sensitiveFieldRegex 匹配 JSON 中的敏感字段(不区分大小写,兼容 snake_case / camelCase / PascalCase)。
// $1 捕获原始字段名(包括两侧引号),保持日志中的字段名不变,仅将值替换为 "***"。
var sensitiveFieldRegex = regexp.MustCompile(
`(?i)("(?:password|passwd|token|access[_-]?token|refresh[_-]?token|id[_-]?token|` +
`authorization|auth[_-]?token|api[_-]?key|api[_-]?secret|secret[_-]?key|` +
`client[_-]?secret|private[_-]?key|secret)")\s*:\s*"[^"]*"`,
)
// sanitizeBody 清理敏感信息
func sanitizeBody(body string) string {
result := body
// 替换常见的敏感字段(JSON格式)
sensitivePatterns := []struct {
pattern string
replacement string
}{
{`"password"\s*:\s*"[^"]*"`, `"password":"***"`},
{`"token"\s*:\s*"[^"]*"`, `"token":"***"`},
{`"access_token"\s*:\s*"[^"]*"`, `"access_token":"***"`},
{`"refresh_token"\s*:\s*"[^"]*"`, `"refresh_token":"***"`},
{`"authorization"\s*:\s*"[^"]*"`, `"authorization":"***"`},
{`"api_key"\s*:\s*"[^"]*"`, `"api_key":"***"`},
{`"secret"\s*:\s*"[^"]*"`, `"secret":"***"`},
{`"apikey"\s*:\s*"[^"]*"`, `"apikey":"***"`},
{`"apisecret"\s*:\s*"[^"]*"`, `"apisecret":"***"`},
}
for _, p := range sensitivePatterns {
re := regexp.MustCompile(p.pattern)
result = re.ReplaceAllString(result, p.replacement)
}
return result
return sensitiveFieldRegex.ReplaceAllString(body, `$1:"***"`)
}
// readRequestBody 读取请求体(限制大小用于日志,但完整读取用于重置)
+61
View File
@@ -0,0 +1,61 @@
package middleware
import "testing"
func TestSanitizeBody(t *testing.T) {
cases := []struct {
name string
in string
want string
}{
{
name: "camelCase apiKey",
in: `{"modelName":"gpt-5.2","apiKey":"sk-secret-123","provider":"azure_openai"}`,
want: `{"modelName":"gpt-5.2","apiKey":"***","provider":"azure_openai"}`,
},
{
name: "snake_case api_key",
in: `{"api_key":"sk-secret-123"}`,
want: `{"api_key":"***"}`,
},
{
name: "PascalCase APIKey",
in: `{"APIKey":"sk-secret-123"}`,
want: `{"APIKey":"***"}`,
},
{
name: "secretKey camelCase",
in: `{"secretKey":"abc","accessKeyId":"id"}`,
want: `{"secretKey":"***","accessKeyId":"id"}`,
},
{
name: "refreshToken / accessToken camelCase",
in: `{"refreshToken":"rt","accessToken":"at"}`,
want: `{"refreshToken":"***","accessToken":"***"}`,
},
{
name: "password and token preserved as masked",
in: `{"password":"p","token":"t"}`,
want: `{"password":"***","token":"***"}`,
},
{
name: "extra whitespace around colon",
in: `{"apiKey" : "leak"}`,
want: `{"apiKey":"***"}`,
},
{
name: "non sensitive fields untouched",
in: `{"baseUrl":"https://example.com","modelName":"gpt"}`,
want: `{"baseUrl":"https://example.com","modelName":"gpt"}`,
},
}
for _, tc := range cases {
t.Run(tc.name, func(t *testing.T) {
got := sanitizeBody(tc.in)
if got != tc.want {
t.Errorf("sanitizeBody(%q)\n got: %s\nwant: %s", tc.in, got, tc.want)
}
})
}
}