Deprecate execTainted

Author: egregius313

java/ql/lib/change-notes/2023-03-28-deprecated-exectainted.md

@@ -0,0 +1,5 @@
+---
+category: deprecated
+---
+* The `execTainted` predicate in `CommandLineQuery.qll` has been deprecated and replaced with the predicate `execIsTainted`.
+

java/ql/lib/semmle/code/java/security/CommandLineQuery.qll

@@ -54,12 +54,27 @@ module RemoteUserInputToArgumentToExecFlowConfig implements DataFlow::ConfigSig
 module RemoteUserInputToArgumentToExecFlow =
   TaintTracking::Global<RemoteUserInputToArgumentToExecFlowConfig>;
 
+/**
+ * DEPRECATED: Use `execIsTainted` instead.
+ *
+ * Implementation of `ExecTainted.ql`. It is extracted to a QLL
+ * so that it can be excluded from `ExecUnescaped.ql` to avoid
+ * reporting overlapping results.
+ */
+deprecated predicate execTainted(
+  DataFlow::PathNode source, DataFlow::PathNode sink, ArgumentToExec execArg
+) {
+  exists(RemoteUserInputToArgumentToExecFlowConfig conf |
+    conf.hasFlowPath(source, sink) and sink.getNode() = DataFlow::exprNode(execArg)
+  )
+}
+
 /**
  * Implementation of `ExecTainted.ql`. It is extracted to a QLL
  * so that it can be excluded from `ExecUnescaped.ql` to avoid
  * reporting overlapping results.
  */
-predicate execTainted(
+predicate execIsTainted(
   RemoteUserInputToArgumentToExecFlow::PathNode source,
   RemoteUserInputToArgumentToExecFlow::PathNode sink, ArgumentToExec execArg
 ) {

java/ql/src/Security/CWE/CWE-078/ExecTainted.ql

@@ -21,6 +21,6 @@ import RemoteUserInputToArgumentToExecFlow::PathGraph
 from
   RemoteUserInputToArgumentToExecFlow::PathNode source,
   RemoteUserInputToArgumentToExecFlow::PathNode sink, ArgumentToExec execArg
-where execTainted(source, sink, execArg)
+where execIsTainted(source, sink, execArg)
 select execArg, source, sink, "This command line depends on a $@.", source.getNode(),
   "user-provided value"

java/ql/src/experimental/Security/CWE/CWE-078/ExecTainted.ql

@@ -23,6 +23,6 @@ import RemoteUserInputToArgumentToExecFlow::PathGraph
 from
   RemoteUserInputToArgumentToExecFlow::PathNode source,
   RemoteUserInputToArgumentToExecFlow::PathNode sink, ArgumentToExec execArg
-where execTainted(source, sink, execArg)
+where execIsTainted(source, sink, execArg)
 select execArg, source, sink, "This command line depends on a $@.", source.getNode(),
   "user-provided value"