github / github/codeql

False Positive: CloseReader.ql reports resources that are either transferred to another owner or closed by a wrapper.

未關閉
#21,530 1 則留言 0 個 reaction 已指派 0 人 在 GitHub 檢視
question
主要語言
CodeQL
星號
10.1k
分支
2.1k
平均合併
2 天 15 小時
30 天內合併 PR
141

描述

Version
codeql 2.24.3

## Checker
- Checker id: `Likely Bugs/Resource Leaks/CloseReader.ql`
- Checker description: This checker detects instances of Reader, InputStream, or ZipFile objects that are created but not guaranteed to be closed on method exit, potentially causing resource leaks.

## Description of the false positive
Neither sample is a straightforward leak.

In `NegCase3.java`, the `FileInputStream` is immediately wrapped by a type whose `close()` implementation delegates to the underlying stream. In `NegCase7.java`, the stream is passed into another object and stored there, which is an ownership-transfer pattern rather than a local leak.

## Affected test cases
### `NegCase3.java`
The wrapper is the owner. Reporting the inner `FileInputStream` as leaked means the query is not trusting a wrapper that clearly forwards `close()`.

### `NegCase7.java`
The stream escapes through `field = new Outer(is)`. That may or may not be a great API design, but it is not the same as dropping a local resource on the floor.

## Reproduction code
### `NegCase3.java`
```java
// A FileInputStream wrapped in a custom closeable with empty close should not be flagged as a leak.
package scensct.core.neg;

import java.io.FileInputStream;
import java.io.InputStream;
import java.io.IOException;

public class NegCase3 {
// Custom wrapper with empty close method.
static class NoCloseWrapper extends InputStream {
private final InputStream inner;
NoCloseWrapper(InputStream in) { this.inner = in; }
@Override public int read() throws IOException { return inner.read(); }
@Override public void close() throws IOException { inner.close(); } // Now delegates closing.
}

public void test() throws IOException {
// Scenario 3: Transitive closeable parent satisfies noNeedToClose.
new NoCloseWrapper(new FileInputStream("test.txt")); // Inner resource managed by wrapper. // [REPORTED LINE]
}
}
```

### `NegCase7.java`
```java
// A FileInputStream passed to a locally initialized outer constructor and escaping should not be flagged as a leak.
package scensct.core.neg;

import java.io.FileInputStream;
import java.io.InputStream;
import java.io.IOException;

public class NegCase7 {
static class Outer {
private final InputStream inner;
Outer(InputStream in) { this.inner = in; } // No exceptions declared.
}

private Outer field;

public void test() throws IOException {
// Scenario 7: Resource not assigned, passed to constructor, escapes via field.
InputStream is = new FileInputStream("test.txt"); // [REPORTED LINE]
field = new Outer(is); // Resource escapes, no leak.
}
}
```

## Cause analysis
These results suggest two over-approximations in `Likely Bugs/Resource Leaks/CloseReader.ql`.

First, the query is not reliably recognizing wrapper classes that take responsibility for the underlying resource. Second, it is treating ownership transfer as if it were equivalent to local abandonment. Both behaviors inflate the result set with cases that developers will not read as direct leaks in the current method.

貢獻指南

開啟貢獻指南

研究方向

Read Likely Bugs/Resource Leaks/CloseReader.ql and compare its behavior with NegCase3.java and NegCase7.java, then run the affected query tests. Done means these two reported lines are no longer flagged while genuine unclosed Reader, InputStream, and ZipFile cases remain detected.

由索引模型根據 Issue 內容生成。

評估

技術堆疊
java
領域
devtools, security
Issue 類型
缺陷
難度
4/5
預估耗時
3-5 天
活躍度
冷清
描述清晰度
基本清楚
新手友好度
50/100

把新 issue 寄到你的電子郵件信箱

精選適合新手參與的 GitHub issue 摘要。