Merge pull request #19134 from hvitved/rust/canonical-path

Rust: Compute canonical paths in QL

Author: hvitved

rust/ql/.generated.list

@@ -29,3 +29,25 @@ private module Input implements InputSig<Location, RustDataFlow> {
 }
 
 import MakeConsistency<Location, RustDataFlow, RustTaintTracking, Input>
+private import codeql.rust.dataflow.internal.ModelsAsData
+
+query predicate missingMadSummaryCanonicalPath(string crate, string path, Addressable a) {
+  summaryModel(crate, path, _, _, _, _, _) and
+  a.getCrateOrigin() = crate and
+  a.getExtendedCanonicalPath() = path and
+  not exists(a.getCanonicalPath())
+}
+
+query predicate missingMadSourceCanonicalPath(string crate, string path, Addressable a) {
+  sourceModel(crate, path, _, _, _, _) and
+  a.getCrateOrigin() = crate and
+  a.getExtendedCanonicalPath() = path and
+  not exists(a.getCanonicalPath())
+}
+
+query predicate missingMadSinkCanonicalPath(string crate, string path, Addressable a) {
+  sinkModel(crate, path, _, _, _, _) and
+  a.getCrateOrigin() = crate and
+  a.getExtendedCanonicalPath() = path and
+  not exists(a.getCanonicalPath())
+}

rust/ql/.gitattributes

@@ -1,4 +1,3 @@
-// generated by codegen, remove this comment if you wish to edit this file
 /**
  * This module provides a hand-modifiable wrapper around the generated class `Addressable`.
  *
@@ -12,10 +11,43 @@ private import codeql.rust.elements.internal.generated.Addressable
  * be referenced directly.
  */
 module Impl {
+  private import rust
+  private import codeql.rust.internal.PathResolution
+
+  // the following QLdoc is generated: if you need to edit it, do it in the schema file
   /**
    * Something that can be addressed by a path.
    *
    * TODO: This does not yet include all possible cases.
    */
-  class Addressable extends Generated::Addressable { }
+  class Addressable extends Generated::Addressable {
+    /**
+     * Gets the canonical path of this item, if any.
+     *
+     * The crate `c` is the root of the path.
+     *
+     * See [The Rust Reference][1] for more details.
+     *
+     * [1]: https://doc.rust-lang.org/reference/paths.html#canonical-paths
+     */
+    string getCanonicalPath(Crate c) { result = this.(ItemNode).getCanonicalPath(c) }
+
+    /**
+     * Gets the canonical path of this item, if any.
+     *
+     * See [The Rust Reference][1] for more details.
+     *
+     * [1]: https://doc.rust-lang.org/reference/paths.html#canonical-paths
+     */
+    string getCanonicalPath() { result = this.getCanonicalPath(_) }
+
+    /**
+     * Holds if this item has a canonical path.
+     *
+     * See [The Rust Reference][1] for more details.
+     *
+     * [1]: https://doc.rust-lang.org/reference/paths.html#canonical-paths
+     */
+    predicate hasCanonicalPath() { exists(this.getCanonicalPath()) }
+  }
 }

rust/ql/lib/codeql/rust/dataflow/internal/DataFlowConsistency.qll

@@ -28,16 +28,7 @@ private class StartswithCall extends Path::SafeAccessCheck::Range, CfgNodes::Met
  * [1]: https://doc.rust-lang.org/std/option/enum.Option.html
  */
 class OptionEnum extends Enum {
-  OptionEnum() {
-    // todo: replace with canonical path, once calculated in QL
-    exists(Crate core, Module m |
-      core.getName() = "core" and
-      m = core.getModule().getItemList().getAnItem() and
-      m.getName().getText() = "option" and
-      this = m.getItemList().getAnItem() and
-      this.getName().getText() = "Option"
-    )
-  }
+  OptionEnum() { this.getCanonicalPath() = "core::option::Option" }
 
   /** Gets the `Some` variant. */
   Variant getSome() { result = this.getVariant("Some") }
@@ -49,16 +40,7 @@ class OptionEnum extends Enum {
  * [1]: https://doc.rust-lang.org/stable/std/result/enum.Result.html
  */
 class ResultEnum extends Enum {
-  ResultEnum() {
-    // todo: replace with canonical path, once calculated in QL
-    exists(Crate core, Module m |
-      core.getName() = "core" and
-      m = core.getModule().getItemList().getAnItem() and
-      m.getName().getText() = "result" and
-      this = m.getItemList().getAnItem() and
-      this.getName().getText() = "Result"
-    )
-  }
+  ResultEnum() { this.getCanonicalPath() = "core::result::Result" }
 
   /** Gets the `Ok` variant. */
   Variant getOk() { result = this.getVariant("Ok") }