Skip to content

Commit d3e2877

Browse files
committed
Rust/Python improve qldoc of SafeAccessCheck
1 parent 81f954a commit d3e2877

File tree

2 files changed

+4
-4
lines changed

2 files changed

+4
-4
lines changed

python/ql/lib/semmle/python/Concepts.qll

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -181,7 +181,7 @@ module Path {
181181
}
182182
}
183183

184-
/** A data-flow node that checks that a path is safe to access. */
184+
/** A data-flow node that checks that a path is safe to access in some way, for example by having a controlled prefix. */
185185
class SafeAccessCheck extends DataFlow::ExprNode {
186186
SafeAccessCheck() { this = DataFlow::BarrierGuard<safeAccessCheck/3>::getABarrierNode() }
187187
}
@@ -192,7 +192,7 @@ module Path {
192192

193193
/** Provides a class for modeling new path safety checks. */
194194
module SafeAccessCheck {
195-
/** A data-flow node that checks that a path is safe to access. */
195+
/** A data-flow node that checks that a path is safe to access in some way, for example by having a controlled prefix. */
196196
abstract class Range extends DataFlow::GuardNode {
197197
/** Holds if this guard validates `node` upon evaluating to `branch`. */
198198
abstract predicate checks(ControlFlowNode node, boolean branch);

rust/ql/lib/codeql/rust/Concepts.qll

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -290,7 +290,7 @@ module Path {
290290
}
291291
}
292292

293-
/** A data-flow node that checks that a path is safe to access. */
293+
/** A data-flow node that checks that a path is safe to access in some way, for example by having a controlled prefix. */
294294
class SafeAccessCheck extends DataFlow::ExprNode {
295295
SafeAccessCheck() { this = DataFlow::BarrierGuard<safeAccessCheck/3>::getABarrierNode() }
296296
}
@@ -301,7 +301,7 @@ module Path {
301301

302302
/** Provides a class for modeling new path safety checks. */
303303
module SafeAccessCheck {
304-
/** A data-flow node that checks that a path is safe to access. */
304+
/** A data-flow node that checks that a path is safe to access in some way, for example by having a controlled prefix. */
305305
abstract class Range extends CfgNodes::AstCfgNode {
306306
/** Holds if this guard validates `node` upon evaluating to `branch`. */
307307
abstract predicate checks(Cfg::CfgNode node, boolean branch);

0 commit comments

Comments
 (0)