Go: DotDotReplaceAll ignores the replacement value and causes false-negative path-injection alerts

未关闭
#22,184 1 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

还没有人认领这个 Issue。

评估

难度
3/5
预计耗时
1-2 天
新手友好度
68/100
Issue 类型
缺陷
描述清晰度
描述清楚
活跃度
冷清
技术栈
go
领域
devtools, security

调研方向

从 go/ql/lib/semmle/go/security/TaintedPathCustomizations.qll 中的 DotDotReplaceAll 和 StringOps.qll 中的 ReplaceAll 模型开始,然后运行 codeql test run go/ql/test/query-tests/Security/CWE-022/TaintedPath.qlref。检查 TaintedPath.go 中受影响的用例,并更新模型或预期结果,使不安全的 ReplaceAll 结果产生预期的 go/path-injection 告警,同时不抑制有效的 sanitizer。

由索引模型根据 Issue 内容生成。

描述

question

Description of the issue

The Go go/path-injection query treats expressions modeled by
StringOps::ReplaceAll as sanitized when the replaced string is "." or
"..". The sanitizer does not check the replacement string or establish that
the resulting path is relative or contained within a trusted directory.

This causes false negatives for at least two independent reasons:

  1. The replacement can make the path more dangerous, because the model checks
    only the string being replaced and not the replacement value.
  2. Even replacing ".." with the empty string can leave or create an
    attacker-controlled absolute path.

Affected sanitizer

DotDotReplaceAll in TaintedPathCustomizations.qll:

/**
 * A replacement of the form `!strings.ReplaceAll(nd, "..")` or
 * `!strings.ReplaceAll(nd, ".")`, considered as a sanitizer for path traversal.
 */
class DotDotReplaceAll extends StringOps::ReplaceAll, Sanitizer {
  DotDotReplaceAll() { this.getReplacedString() = ["..", "."] }
}

StringOps::ReplaceAll.getReplacedString() represents the old argument. For
strings.ReplaceAll(s, old, new), the model exposes and checks old, but not
new:

StringOps.qll:

class ReplaceAll extends DataFlow::Node instanceof ReplaceAll::Range {
  /** Gets the `old` in `strings.ReplaceAll(s, old, new)`. */
  string getReplacedString() { result = super.getReplacedString() }
}

The standard-library implementation of this range
similarly obtains only argument 1 (old):

override string getReplacedString() { result = this.getArgument(1).getStringValue() }

Consequently, any replacement value is accepted by DotDotReplaceAll.

False negative when the replacement increases traversal

For example:

func handler(w http.ResponseWriter, r *http.Request) {
    taintedPath := r.URL.Query().Get("path")
    path := strings.ReplaceAll(taintedPath, "..", "../..")
    data, _ := os.ReadFile(path) // expected: go/path-injection
    w.Write(data)
}

For taintedPath = "../secret", the replacement produces
"../../secret". It increases the number of parent-directory components, but
CodeQL treats the return value as sanitized because the old argument is
"..".

I also verified this directly in the existing TaintedPath.go test by changing
the replacement at line 37 to "../.." and adding an expected
go/path-injection alert. With DotDotReplaceAll enabled, the test reports:

| TaintedPath.go:37:77:37:105 | comment | Missing result: Alert[go/path-injection] |

False negative with an empty replacement

The existing test uses an empty replacement:

TaintedPath.go lines 36-38:

// GOOD: Sanitized by strings.ReplaceAll and replaces all .. with empty string
data, _ = ioutil.ReadFile(strings.ReplaceAll(tainted_path, "..", ""))
w.Write(data)

Removing ".." does not ensure that the path is safe:

strings.ReplaceAll("..../etc/passwd", "..", "") // "/etc/passwd"
strings.ReplaceAll("/etc/passwd", "..", "")     // "/etc/passwd"

In both cases the result is an attacker-controlled absolute path. This is
consistent with the query help, which says that absolute paths can point
anywhere on the file system and similarly warns that naive removal of traversal
sequences can be insufficient:

Steps to reproduce using the existing test

  1. Run the existing test:

    codeql test run go/ql/test/query-tests/Security/CWE-022/TaintedPath.qlref
    

    The test passes and no alert is reported for the ReplaceAll result at
    TaintedPath.go line 37.

  2. Remove only the DotDotReplaceAll class from
    go/ql/lib/semmle/go/security/TaintedPathCustomizations.qll and rerun the
    same test.

  3. The test fails with the new source-to-sink result:

    | TaintedPath.go:37:28:37:69 | call to ReplaceAll | ... | user-provided value |
    | TaintedPath.go:37:28:37:69 | call to ReplaceAll | Unexpected result: Alert |
    

The individual ablation changes no other alert locations in this test. This
confirms that DotDotReplaceAll suppresses the flow from the URL-derived path
through strings.ReplaceAll to ioutil.ReadFile.

Expected behavior

Replacing "." or ".." should not be treated as an unconditional
path-injection sanitizer. In particular, a replacement operation must not
stop taint without considering the replacement value and the properties of the
resulting path.

Since even an empty replacement does not prove that the result is relative or
contained within a safe directory, a possible fix is to remove
DotDotReplaceAll and update the affected test expectation. Sound validation
can instead rely on checks that establish locality or containment.

Environment

  • CodeQL CLI 2.25.6
  • CodeQL repository test baseline: f6f45d1536
  • Present in main at commit 42843f155e95d25e690aba9ae4620b5a5986a951
  • Go 1.22.12 on Linux/amd64
主要语言
CodeQL
星标
10.1k
派生
2.1k
平均合并
2 天 10 小时
30 天内合并 PR
134

贡献指南

打开贡献指南

从这里开始

  1. 先读完整个 Issue,再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库,在一个分支上完成修改。
  4. 提交 Pull Request,并在描述里引用这个 Issue 编号。

github/codeql 的其他 Issue

查看 github/codeql 的全部 Issue

相似的 Issue

更多 DevTools Issue

把新 issue 发到你的邮箱

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