Merge pull request #13728 from owen-mc/go/minor-cleanup-Twirp-models

Go: minor cleanup to Twirp models

Author: owen-mc

go/ql/lib/semmle/go/frameworks/Twirp.qll

@@ -35,83 +35,59 @@ module Twirp {
     }
   }
 
-  /**
-   * A type representing a protobuf message.
-   */
+  /** A type representing a protobuf message. */
   class ProtobufMessageType extends Type {
     ProtobufMessageType() {
-      exists(TypeEntity te |
-        te.getType() = this and
-        te.getDeclaration().getLocation().getFile() instanceof ProtobufGeneratedFile
-      )
+      this.hasLocationInfo(any(ProtobufGeneratedFile f).getAbsolutePath(), _, _, _, _)
     }
   }
 
-  /**
-   * An interface type representing a Twirp service.
-   */
+  /** An interface type representing a Twirp service. */
   class ServiceInterfaceType extends InterfaceType {
     NamedType namedType;
 
     ServiceInterfaceType() {
-      exists(TypeEntity te |
-        te.getType() = namedType and
-        namedType.getUnderlyingType() = this and
-        te.getDeclaration().getLocation().getFile() instanceof ServicesGeneratedFile
-      )
+      namedType.getUnderlyingType() = this and
+      namedType.hasLocationInfo(any(ServicesGeneratedFile f).getAbsolutePath(), _, _, _, _)
     }
 
-    /**
-     * Gets the name of the interface.
-     */
+    /** Gets the name of the interface. */
     override string getName() { result = namedType.getName() }
 
-    /**
-     * Gets the named type on top of this interface type.
-     */
+    /** Gets the named type on top of this interface type. */
     NamedType getNamedType() { result = namedType }
   }
 
-  /**
-   * A Twirp client.
-   */
+  /** A Twirp client. */
   class ServiceClientType extends NamedType {
     ServiceClientType() {
-      exists(ServiceInterfaceType i, PointerType p, TypeEntity te |
+      exists(ServiceInterfaceType i, PointerType p |
         p.implements(i) and
         this = p.getBaseType() and
         this.getName().regexpMatch("(?i)" + i.getName() + "(protobuf|json)client") and
-        te.getType() = this and
-        te.getDeclaration().getLocation().getFile() instanceof ServicesGeneratedFile
+        this.hasLocationInfo(any(ServicesGeneratedFile f).getAbsolutePath(), _, _, _, _)
       )
     }
   }
 
-  /**
-   * A Twirp server.
-   */
+  /** A Twirp server. */
   class ServiceServerType extends NamedType {
     ServiceServerType() {
-      exists(ServiceInterfaceType i, TypeEntity te |
+      exists(ServiceInterfaceType i |
         this.implements(i) and
         this.getName().regexpMatch("(?i)" + i.getName() + "server") and
-        te.getType() = this and
-        te.getDeclaration().getLocation().getFile() instanceof ServicesGeneratedFile
+        this.hasLocationInfo(any(ServicesGeneratedFile f).getAbsolutePath(), _, _, _, _)
       )
     }
   }
 
-  /**
-   * A Twirp function to construct a Client.
-   */
+  /** A Twirp function to construct a Client. */
   class ClientConstructor extends Function {
     ClientConstructor() {
-      exists(ServiceClientType c |
-        this.getName().regexpMatch("(?i)new" + c.getName()) and
-        this.getParameterType(0) instanceof StringType and
-        this.getParameterType(1).getName() = "HTTPClient" and
-        this.getDeclaration().getLocation().getFile() instanceof ServicesGeneratedFile
-      )
+      this.getName().regexpMatch("(?i)new" + any(ServiceClientType c).getName()) and
+      this.getParameterType(0) instanceof StringType and
+      this.getParameterType(1).getName() = "HTTPClient" and
+      this.hasLocationInfo(any(ServicesGeneratedFile f).getAbsolutePath(), _, _, _, _)
     }
   }
 
@@ -122,17 +98,13 @@ module Twirp {
    */
   class ServerConstructor extends Function {
     ServerConstructor() {
-      exists(ServiceServerType c, ServiceInterfaceType i |
-        this.getName().regexpMatch("(?i)new" + c.getName()) and
-        this.getParameterType(0) = i.getNamedType() and
-        this.getDeclaration().getLocation().getFile() instanceof ServicesGeneratedFile
-      )
+      this.getName().regexpMatch("(?i)new" + any(ServiceServerType c).getName()) and
+      this.getParameterType(0) = any(ServiceInterfaceType i).getNamedType() and
+      this.hasLocationInfo(any(ServicesGeneratedFile f).getAbsolutePath(), _, _, _, _)
     }
   }
 
-  /**
-   * An SSRF sink for the Client constructor.
-   */
+  /** An SSRF sink for the Client constructor. */
   class ClientRequestUrlAsSink extends RequestForgery::Sink {
     ClientRequestUrlAsSink() {
       exists(DataFlow::CallNode call |
@@ -146,27 +118,22 @@ module Twirp {
     override string getKind() { result = "URL" }
   }
 
-  /**
-   * A service handler.
-   */
+  /** A service handler. */
   class ServiceHandler extends Method {
     ServiceHandler() {
-      exists(DataFlow::CallNode call, Type handlerType, ServiceInterfaceType i |
+      exists(DataFlow::CallNode call |
         call.getTarget() instanceof ServerConstructor and
-        call.getArgument(0).getType() = handlerType and
-        this = handlerType.getMethod(_) and
-        this.implements(i.getNamedType().getMethod(_))
+        this = call.getArgument(0).getType().getMethod(_) and
+        this.implements(any(ServiceInterfaceType i).getNamedType().getMethod(_))
       )
     }
   }
 
-  /**
-   * A request coming to the service handler.
-   */
+  /** A request coming to the service handler. */
   class Request extends UntrustedFlowSource::Range instanceof DataFlow::ParameterNode {
     Request() {
-      exists(FuncDef c, ServiceHandler handler | handler.getFuncDecl() = c |
-        this.asParameter().isParameterOf(c, 1) and
+      exists(ServiceHandler handler |
+        this.asParameter().isParameterOf(handler.getFuncDecl(), 1) and
         handler.getParameterType(0).hasQualifiedName("context", "Context") and
         this.getType().(PointerType).getBaseType() instanceof ProtobufMessageType
       )