Rust: Add a model for unwrap

github · Nov 27, 2024 · 3bb1ae0 · 3bb1ae0
1 parent 5cd9ff4
commit 3bb1ae0
Show file tree

Hide file tree

Showing 4 changed files with 246 additions and 216 deletions.
diff --git a/rust/ql/lib/codeql/rust/dataflow/FlowSummary.qll b/rust/ql/lib/codeql/rust/dataflow/FlowSummary.qll
@@ -7,6 +7,17 @@ private import internal.DataFlowImpl
 // import all instances below
 private module Summaries {
   private import codeql.rust.Frameworks
+
+  // TODO: Used models-as-data when it's available
+  private class UnwrapSummary extends SummarizedCallable::Range {
+    UnwrapSummary() { this = "lang:core::_::<crate::option::Option>::unwrap" }
+
+    override predicate propagatesFlow(string input, string output, boolean preservesValue) {
+      input = "Argument[self].Variant[crate::std::option::Option::Some(0)]" and
+      output = "ReturnValue" and
+      preservesValue = true
+    }
+  }
 }
 
 /** Provides the `Range` class used to define the extent of `LibraryCallable`. */