Skip to content

Rust: Adjust the taint reach metric for better stability. #19718

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
geoffw0 merged 2 commits into from
Jun 11, 2025
Merged

Rust: Adjust the taint reach metric for better stability. #19718

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
50bf246
Rust: Adjust the taint reach metric for better stability.
geoffw0 Jun 10, 2025
e64d083
Rust: Lets also output the total number of nodes to make understandin…
geoffw0 Jun 10, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions rust/ql/src/queries/summary/Stats.qll
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -189,6 +189,8 @@ predicate taintStats(string key, int value) {
or
key = "Taint reach - nodes tainted" and value = getTaintedNodesCount()
or
key = "Taint reach - total non-summary nodes" and value = getTotalNodesCount()
or
key = "Taint reach - per million nodes" and value = getTaintReach().floor()
or
key = "Taint sinks - query sinks" and value = getQuerySinksCount()
Expand Down
21 changes: 19 additions & 2 deletions rust/ql/src/queries/summary/TaintReach.qll
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ import rust
private import codeql.rust.Concepts
private import codeql.rust.dataflow.DataFlow
private import codeql.rust.dataflow.TaintTracking
private import codeql.rust.dataflow.internal.Node

/**
* A taint configuration for taint reach (flow to any node from any modeled source).
Expand All @@ -21,11 +22,27 @@ private module TaintReachFlow = TaintTracking::Global<TaintReachConfig>;

/**
* Gets the total number of data flow nodes that taint reaches (from any source).
*
* We don't include flow summary nodes, as their number is unstable (varies when models
* are added).
*/
int getTaintedNodesCount() { result = count(DataFlow::Node n | TaintReachFlow::flowTo(n)) }
int getTaintedNodesCount() {
result = count(DataFlow::Node n | TaintReachFlow::flowTo(n) and not n instanceof FlowSummaryNode)
}

/**
* Gets the total number of data flow nodes.
*
* We don't include flow summary nodes, as their number is unstable (varies when models
* are added).
*/
int getTotalNodesCount() { result = count(DataFlow::Node n | not n instanceof FlowSummaryNode) }

/**
* Gets the proportion of data flow nodes that taint reaches (from any source),
* expressed as a count per million nodes.
*
* We don't include flow summary nodes, as their number is unstable (varies when models
* are added).
*/
float getTaintReach() { result = (getTaintedNodesCount() * 1000000.0) / count(DataFlow::Node n) }
float getTaintReach() { result = (getTaintedNodesCount() * 1000000.0) / getTotalNodesCount() }