Java: Automodel Fr Mode: add return value endpoint type

Stephan Brandauer · Stephan Brandauer · commit b2578f0e302b · 2023-09-26T10:45:52.000+02:00
diff --git a/java/ql/automodel/src/AutomodelFrameworkModeCharacteristics.qll b/java/ql/automodel/src/AutomodelFrameworkModeCharacteristics.qll
@@ -25,7 +25,8 @@ newtype JavaRelatedLocationType =
 
 newtype TFrameworkModeEndpoint =
   TExplicitParameter(Parameter p) or
-  TQualifier(Callable c)
+  TQualifier(Callable c) or
+  TReturnValue(Callable c)
 
 /**
  * A framework mode endpoint.
@@ -48,9 +49,7 @@ abstract class FrameworkModeEndpoint extends TFrameworkModeEndpoint {
 
   abstract Top asTop();
 
-  string getExtensibleType() {
-    result = "sinkModel"
-  }
+  abstract string getExtensibleType();
 
   string toString() { result = this.asTop().toString() }
 
@@ -69,6 +68,8 @@ class ExplicitParameterEndpoint extends FrameworkModeEndpoint, TExplicitParamete
   override Callable getEnclosingCallable() { result = param.getCallable() }
 
   override Top asTop() { result = param }
+
+  override string getExtensibleType() { result = "sinkModel" }
 }
 
 class QualifierEndpoint extends FrameworkModeEndpoint, TQualifier {
@@ -85,6 +86,30 @@ class QualifierEndpoint extends FrameworkModeEndpoint, TQualifier {
   override Callable getEnclosingCallable() { result = callable }
 
   override Top asTop() { result = callable }
+
+  override string getExtensibleType() { result = "sinkModel" }
+}
+
+class ReturnValue extends FrameworkModeEndpoint, TReturnValue {
+  Callable callable;
+
+  ReturnValue() { this = TReturnValue(callable) and callable.fromSource() }
+
+  override int getIndex() {
+    // FIXME bogus value
+    result = -1
+  }
+
+  override string getParamName() {
+    // FIXME bogus value
+    result = "return value"
+  }
+
+  override Callable getEnclosingCallable() { result = callable }
+
+  override Top asTop() { result = callable }
+
+  override string getExtensibleType() { result = "sourceModel" }
 }
 
 /**
diff --git a/java/ql/automodel/test/AutomodelFrameworkModeExtraction/com/github/codeql/test/PublicClass.java b/java/ql/automodel/test/AutomodelFrameworkModeExtraction/com/github/codeql/test/PublicClass.java
@@ -3,11 +3,11 @@
 public class PublicClass {
   public void stuff(String arg) { // `arg` is a candidate, `this` is a candidate
     System.out.println(arg);
-  }
+  } // method stuff is a candidate source
 
   public static void staticStuff(String arg) { // `arg` is a candidate, `this` is not a candidate (static method)
     System.out.println(arg);
-  }
+  } // method staticStuff is a candidate source
 
   // `arg` and `this` are not a candidate because the method is not public:
   protected void nonPublicStuff(String arg) {
diff --git a/java/ql/automodel/test/AutomodelFrameworkModeExtraction/com/github/codeql/test/PublicInterface.java b/java/ql/automodel/test/AutomodelFrameworkModeExtraction/com/github/codeql/test/PublicInterface.java
@@ -1,9 +1,9 @@
 package com.github.codeql.test;
 
 public interface PublicInterface {
-    public void stuff(String arg); // `arg` is a candidate, `this` is a candidate
+    public void stuff(String arg); // `arg` is a candidate, `this` is a candidate, method stuff is a candidate source
 
     public static void staticStuff(String arg) { // `arg` is a candidate, `this` is not a candidate (static method)
       System.out.println(arg);
-    }
+    } // method staticStuff is a candidate source
 }
diff --git a/java/ql/automodel/test/AutomodelFrameworkModeExtraction/java/nio/file/Files.java b/java/ql/automodel/test/AutomodelFrameworkModeExtraction/java/nio/file/Files.java
@@ -19,12 +19,12 @@ public static void copy(
          */
     ) throws IOException {
         // ...
-    }
+    } // method copy is a candidate source
 
     public static InputStream newInputStream(
         Path openPath ,// positive example (known sink), candidate (ai-modeled, and useful as a candidate in regression testing)
         OpenOption... options 
     ) throws IOException {
         return  new FileInputStream(openPath.toFile());
-    } 
+    } // method newInputStream is a candidate source
 }
