Ruby: configsig rb/request-forgery

alexrford · alexrford · commit ba8ff0710d77 · 2023-09-03T17:20:05.000+01:00
diff --git a/ruby/ql/lib/codeql/ruby/security/ServerSideRequestForgeryQuery.qll b/ruby/ql/lib/codeql/ruby/security/ServerSideRequestForgeryQuery.qll
@@ -2,8 +2,9 @@
  * Provides a taint-tracking configuration for detecting
  * "Server side request forgery" vulnerabilities.
  *
- * Note, for performance reasons: only import this file if `Configuration` is needed,
- * otherwise `ServerSideRequestForgeryCustomizations` should be imported instead.
+ * Note, for performance reasons: only import this file if
+ * `ServerSideRequestForgeryFlow` is needed, otherwise
+ * `ServerSideRequestForgeryCustomizations` should be imported instead.
  */
 
 import codeql.ruby.DataFlow
@@ -14,8 +15,9 @@ import codeql.ruby.dataflow.BarrierGuards
 /**
  * A taint-tracking configuration for detecting
  * "Server side request forgery" vulnerabilities.
+ * DEPRECATED: Use `ServerSideRequestForgeryFlow`
  */
-class Configuration extends TaintTracking::Configuration {
+deprecated class Configuration extends TaintTracking::Configuration {
   Configuration() { this = "ServerSideRequestForgery" }
 
   override predicate isSource(DataFlow::Node source) { source instanceof Source }
@@ -32,3 +34,20 @@ class Configuration extends TaintTracking::Configuration {
     guard instanceof SanitizerGuard
   }
 }
+
+private module ServerSideRequestForgeryConfig implements DataFlow::ConfigSig {
+  predicate isSource(DataFlow::Node source) { source instanceof Source }
+
+  predicate isSink(DataFlow::Node sink) { sink instanceof Sink }
+
+  predicate isBarrier(DataFlow::Node node) {
+    node instanceof Sanitizer or
+    node instanceof StringConstCompareBarrier or
+    node instanceof StringConstArrayInclusionCallBarrier
+  }
+}
+
+/**
+ * Taint-tracking for detecting "Server side request forgery" vulnerabilities.
+ */
+module ServerSideRequestForgeryFlow = TaintTracking::Global<ServerSideRequestForgeryConfig>;
diff --git a/ruby/ql/src/queries/security/cwe-918/ServerSideRequestForgery.ql b/ruby/ql/src/queries/security/cwe-918/ServerSideRequestForgery.ql
@@ -13,9 +13,9 @@
 import codeql.ruby.AST
 import codeql.ruby.DataFlow
 import codeql.ruby.security.ServerSideRequestForgeryQuery
-import DataFlow::PathGraph
+import ServerSideRequestForgeryFlow::PathGraph
 
-from Configuration config, DataFlow::PathNode source, DataFlow::PathNode sink
-where config.hasFlowPath(source, sink)
+from ServerSideRequestForgeryFlow::PathNode source, ServerSideRequestForgeryFlow::PathNode sink
+where ServerSideRequestForgeryFlow::flowPath(source, sink)
 select sink.getNode(), source, sink, "The URL of this request depends on a $@.", source.getNode(),
   "user-provided value"
