Go: DotDotReplaceAll ignores the replacement value and causes false-negative path-injection alerts
Chưa có ai nhận issue này.
Đánh giá
- Độ khó
- 3/5
- Thời gian dự kiến
- 1-2 ngày
- Mức phù hợp với người mới
- 68/100
Hướng nghiên cứu
Bắt đầu với DotDotReplaceAll trong go/ql/lib/semmle/go/security/TaintedPathCustomizations.qll và model ReplaceAll trong StringOps.qll, sau đó chạy codeql test run go/ql/test/query-tests/Security/CWE-022/TaintedPath.qlref. Kiểm tra các trường hợp bị ảnh hưởng trong TaintedPath.go và cập nhật model hoặc các kỳ vọng để kết quả ReplaceAll không an toàn tạo ra cảnh báo go/path-injection như mong đợi mà không loại bỏ các sanitizer hợp lệ.
Do mô hình lập chỉ mục viết ra từ nội dung của issue.
Mô tả
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:
- The replacement can make the path more dangerous, because the model checks
only the string being replaced and not the replacement value. - 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:
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:
// 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:
TaintedPath.qhelp: absolute paths can point anywhere on the file systemTaintedPath.qhelp: warning about naive traversal-sequence removal
Steps to reproduce using the existing test
-
Run the existing test:
codeql test run go/ql/test/query-tests/Security/CWE-022/TaintedPath.qlrefThe test passes and no alert is reported for the
ReplaceAllresult at
TaintedPath.goline 37. -
Remove only the
DotDotReplaceAllclass from
go/ql/lib/semmle/go/security/TaintedPathCustomizations.qlland rerun the
same test. -
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
mainat commit42843f155e95d25e690aba9ae4620b5a5986a951 - Go 1.22.12 on Linux/amd64
- Ngôn ngữ chính
- CodeQL
- Star
- 10.1k
- Fork
- 2.1k
- Merge trung bình
- 2 ngày 10 giờ
- Pull request đã merge (30 ngày)
- 134
Hướng dẫn đóng góp
Bắt đầu từ đâu
- Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
- Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
- Fork repository và làm thay đổi trên một nhánh.
- Mở pull request có tham chiếu số hiệu của issue.
Issue khác của github/codeql
-
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 84/100
-
C#: cs/simplifiable-boolean-expression false positive on Nullable<bool> compared with a literal Đang mở
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 82/100
-
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 78/100
-
false-positive
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 70/100
-
false-positive
Độ khó 3/5 1-2 ngày Mức phù hợp với người mới 68/100
Tất cả issue của github/codeql
Issue tương tự
-
ZCode 3.14.3 に対応する Đang mở
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 68/100
supermomonga/zcode-acp#24 ·
-
bug
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 90/100
learningequality/ricecooker#747 ·
-
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 84/100
KhronosGroup/glTF-Blender-IO#2769 ·
-
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 68/100
-
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 88/100