github / github/codeql

Go: go/log-injection produces false positives for logrus when sanitising formatters are used

未关闭
#11,657 4 条评论 1 个 reaction 已指派 1 人 已被 @mbg 认领 在 GitHub 查看
false-positive Go
主要语言
CodeQL
星标
10.1k
派生
2.1k
平均合并
2 天 15 小时
30 天内合并 PR
141

描述

**Description of the false positive**

The `go/log-injection` ([CWE-117](https://cwe.mitre.org/data/definitions/117.html)) query identifies log entries that are created from user input without proper sanitisation. The `logrus` library is vulnerable to this when the default output formatter is used. However, different output formatters, such as `JSONFormatter`, may sanitise log entries themselves. The `go/log-injection` query is not currently aware of this behaviour and will report false positives whenever `logrus` is used for logging and log entries are based on unsanitised user data, even if a sanitising output formatter is used.

**Code samples or links to source code**

In the following example, `go/log-injection` will report that the log entry constructed using `logrus.Fields` depends on a user-provided value that has not been sanitised:

```go
func example(req *http.Request, ctx *goproxy.ProxyCtx) {
username := req.URL.Query()["username"][0]
logrus.SetFormatter(&logrus.JSONFormatter{})
logrus.WithFields(logrus.Fields{
"USERNAME": username,
})
}
```

贡献指南

打开贡献指南

评估

这个 Issue 还没有评估数据。

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。