Add models for HTTP::ResponseBody

github · smowton · Apr 9, 2021 · Dec 20, 2020 · Dec 20, 2020 · Jan 5, 2021
commit 0fe7050e7e843c5edfdf9d9364db30c7e8ec02e8
diff --git a/ql/src/semmle/go/frameworks/CleverGo.qll b/ql/src/semmle/go/frameworks/CleverGo.qll
@@ -172,4 +172,93 @@ private module CleverGo {
 
     override HTTP::ResponseWriter getResponseWriter() { none() }
   }
+
+  // Models HTTP ResponseBody.
+  private class HttpResponseBody extends HTTP::ResponseBody::Range {
+    string package;
+    DataFlow::CallNode call;
+    string contentType;
+
+    HttpResponseBody() {
+      // HTTP ResponseBody models for package: clevergo.tech/[email protected]
+      package = packagePath() and
+      // Receiver type: Context
+      (
+        // signature: func (*Context).Error(code int, msg string) error
+        call = any(Method m | m.hasQualifiedName(package, "Context", "Error")).getACall() and
+        this = call.getArgument(1) and
+        contentType = "text/plain"
+        or
+        // signature: func (*Context).HTML(code int, html string) error
+        call = any(Method m | m.hasQualifiedName(package, "Context", "HTML")).getACall() and
+        this = call.getArgument(1) and
+        contentType = "text/html"
+        or
+        // signature: func (*Context).HTMLBlob(code int, bs []byte) error
+        call = any(Method m | m.hasQualifiedName(package, "Context", "HTMLBlob")).getACall() and
+        this = call.getArgument(1) and
+        contentType = "text/html"
+        or
+        // signature: func (*Context).JSON(code int, data interface{}) error
+        call = any(Method m | m.hasQualifiedName(package, "Context", "JSON")).getACall() and
+        this = call.getArgument(1) and
+        contentType = "application/json"
+        or
+        // signature: func (*Context).JSONBlob(code int, bs []byte) error
+        call = any(Method m | m.hasQualifiedName(package, "Context", "JSONBlob")).getACall() and
+        this = call.getArgument(1) and
+        contentType = "application/json"
+        or
+        // signature: func (*Context).JSONP(code int, data interface{}) error
+        call = any(Method m | m.hasQualifiedName(package, "Context", "JSONP")).getACall() and
+        this = call.getArgument(1) and
+        contentType = "application/javascript"
+        or
+        // signature: func (*Context).JSONPBlob(code int, bs []byte) error
+        call = any(Method m | m.hasQualifiedName(package, "Context", "JSONPBlob")).getACall() and
+        this = call.getArgument(1) and
+        contentType = "application/javascript"
+        or
+        // signature: func (*Context).JSONPCallback(code int, callback string, data interface{}) error
+        call = any(Method m | m.hasQualifiedName(package, "Context", "JSONPCallback")).getACall() and
+        this = call.getArgument(2) and
+        contentType = "application/javascript"
+        or
+        // signature: func (*Context).JSONPCallbackBlob(code int, callback string, bs []byte) (err error)
+        call =
+          any(Method m | m.hasQualifiedName(package, "Context", "JSONPCallbackBlob")).getACall() and
+        this = call.getArgument(2) and
+        contentType = "application/javascript"
+        or
+        // signature: func (*Context).String(code int, s string) error
+        call = any(Method m | m.hasQualifiedName(package, "Context", "String")).getACall() and
+        this = call.getArgument(1) and
+        contentType = "text/plain"
+        or
+        // signature: func (*Context).StringBlob(code int, bs []byte) error
+        call = any(Method m | m.hasQualifiedName(package, "Context", "StringBlob")).getACall() and
+        this = call.getArgument(1) and
+        contentType = "text/plain"
+        or
+        // signature: func (*Context).Stringf(code int, format string, a ...interface{}) error
+        call = any(Method m | m.hasQualifiedName(package, "Context", "Stringf")).getACall() and
+        this = call.getArgument([1, any(int i | i >= 2)]) and
+        contentType = "text/plain"
+        or
+        // signature: func (*Context).XML(code int, data interface{}) error
+        call = any(Method m | m.hasQualifiedName(package, "Context", "XML")).getACall() and
+        this = call.getArgument(1) and
+        contentType = "text/xml"
+        or
+        // signature: func (*Context).XMLBlob(code int, bs []byte) error
+        call = any(Method m | m.hasQualifiedName(package, "Context", "XMLBlob")).getACall() and
+        this = call.getArgument(1) and
+        contentType = "text/xml"
+      )
+    }
+
+    override string getAContentType() { result = contentType }
+
+    override HTTP::ResponseWriter getResponseWriter() { none() }
+  }
 }
diff --git a/ql/test/library-tests/semmle/go/frameworks/CleverGo/HttpRedirect/Test.ql b/ql/test/library-tests/semmle/go/frameworks/CleverGo/HttpRedirect/Test.ql
@@ -1,17 +1,17 @@
 import go
 import TestUtilities.InlineExpectationsTest
 
-class TaintTrackingTest extends InlineExpectationsTest {
-  TaintTrackingTest() { this = "TaintTrackingTest" }
+class HttpRedirectTest extends InlineExpectationsTest {
+  HttpRedirectTest() { this = "HttpRedirectTest" }
 
   override string getARelevantTag() { result = "redirectUrl" }
 
   override predicate hasActualResult(string file, int line, string element, string tag, string value) {
     tag = "redirectUrl" and
-    exists(HTTP::Redirect q |
-      q.hasLocationInfo(file, line, _, _, _) and
-      element = q.getUrl().toString() and
-      value = q.getUrl().toString()
+    exists(HTTP::Redirect rd |
+      rd.hasLocationInfo(file, line, _, _, _) and
+      element = rd.getUrl().toString() and
+      value = rd.getUrl().toString()
     )
   }
 }
diff --git a/...st/library-tests/semmle/go/frameworks/CleverGo/HttpResponseBody/Model-HttpResponseBody.go b/...st/library-tests/semmle/go/frameworks/CleverGo/HttpResponseBody/Model-HttpResponseBody.go
diff --git a/ql/test/library-tests/semmle/go/frameworks/CleverGo/HttpResponseBody/Test.expected b/ql/test/library-tests/semmle/go/frameworks/CleverGo/HttpResponseBody/Test.expected
diff --git a/ql/test/library-tests/semmle/go/frameworks/CleverGo/HttpResponseBody/Test.ql b/ql/test/library-tests/semmle/go/frameworks/CleverGo/HttpResponseBody/Test.ql
@@ -0,0 +1,23 @@
+import go
+import TestUtilities.InlineExpectationsTest
+
+class HttpResponseBodyTest extends InlineExpectationsTest {
+  HttpResponseBodyTest() { this = "HttpResponseBodyTest" }
+
+  override string getARelevantTag() { result = ["contentType", "responseBody"] }
+
+  override predicate hasActualResult(string file, int line, string element, string tag, string value) {
+    exists(HTTP::ResponseBody rd |
+      rd.hasLocationInfo(file, line, _, _, _) and
+      (
+        element = rd.getAContentType().toString() and
+        value = rd.getAContentType().toString() and
+        tag = "contentType"
+        or
+        element = rd.toString() and
+        value = rd.toString() and
+        tag = "responseBody"
+      )
+    )
+  }
+}
diff --git a/ql/test/library-tests/semmle/go/frameworks/CleverGo/HttpResponseBody/go.mod b/ql/test/library-tests/semmle/go/frameworks/CleverGo/HttpResponseBody/go.mod
@@ -0,0 +1,5 @@
+module example.com/hello/world
+
+go 1.15
+
+require clevergo.tech/clevergo v0.5.2