Packages

  • package root
    Definition Classes
    root
  • package io
    Definition Classes
    root
  • package shiftleft
    Definition Classes
    io
  • package queryprimitives

    Domain specific language for querying code property graphs

    Domain specific language for querying code property graphs

    This is the API reference for the CPG query language, a language to mine code for defects and vulnerabilities both interactively on a code analysis shell (REPL), or using non-interactive scripts.

    Queries written in the CPG query language express graph traversals (see https://en.wikipedia.org/wiki/Graph_traversal). Similar to the standard graph traversal language "Gremlin" (see https://en.wikipedia.org/wiki/Gremlin_(programming_language))) these traversals are formulated as sequences of primitive language elements referred to as "steps". You can think of a step as a small program, similar to a unix shell utility, however, instead of processing lines one by one, the step processes nodes of the graph.

    Starting a traversal

    All traversals begin by selecting a set of start nodes, e.g.,

    cpg.method

    will start the traversal at all methods, while

    cpg.local

    will start at all local variables. The complete list of starting points can be found here: io.shiftleft.queryprimitives.steps.starters.Cpg

    Lazy evaluation

    Queries are lazily evaluated, e.g., cpg.method creates a traversal which you can add more steps to. You can, for example, evaluate the traversal by converting it to a list:

    cpg.method.toList

    Since toList is such a common operation, we provide the shorthand l, meaning that

    cpg.method.l

    provides the same result as the former query.

    Properties

    Nodes have "properties", key-value pairs where keys are strings and values are primitive data types such as strings, integers, or Booleans. Properties of nodes can be selected based on their key, e.g.,

    cpg.method.name

    traverses to all method names. Nodes can also be filtered based on properties, e.g.,

    cpg.method.name(".*exec.*")

    traverse to all methods where name matches the regular expression ".*exec.*". You can see a complete list of properties by browsing to the API documentation of the corresponding step. For example, you can find the properties of method nodes at io.shiftleft.queryprimitives.steps.types.structure.Method.

    Side effects

    Useful if you want to mutate something outside the traversal, or simply debug it: This prints all typeDecl names as it traverses the graph and increments i for each one.

    var i = 0
cpg.typeDecl.sideEffect{typeTemplate => println(typeTemplate.name); i = i + 1}.exec

    [advanced] Selecting multiple things from your traversal

    If you are interested in multiple things along the way of your traversal, you label anything using the as modulator, and use select at the end. Note that the compiler automatically derived the correct return type as a tuple of the labelled steps, in this case with two elements.

    cpg.method.as("method").definingTypeDecl.as("classDef").select.toList
// return type: List[(nodes.Method, nodes.TypeDecl)]

    [advanced] For comprehensions

    You can always start a new traversal from a node, e.g.,

    val someMethod = cpg.method.head
someMethod.start.parameter.toList

    You can use this e.g. in a for comprehension, which is (in this context) essentially an alternative way to select multiple intermediate things. It is more expressive, but more computationally expensive.

    val query = for {
  method <- cpg.method
  param <- method.start.parameter
} yield (method.name, param.name)

query.toList
    Definition Classes
    shiftleft
  • package steps

    Steps for traversing the code property graph

    Steps for traversing the code property graph

    All traversal start at io.shiftleft.queryprimitives.starters.Cpg.

    Definition Classes
    queryprimitives
  • package starters
    Definition Classes
    steps
  • package types
    Definition Classes
    steps
  • CpgSteps
  • ICallResolver
  • Implicits
  • NewNodeSteps
  • NoResolve

object Implicits

Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Implicits
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Type Members

  1. implicit class JavaIteratorDeco[T] extends AnyRef

    This wrapped is used to make sure to throw a proper NoSuchElementException.

    This wrapped is used to make sure to throw a proper NoSuchElementException. Proper in this case means an exception with a stack trace. This is intended to be used as a replacement for next() on the iterators returned from Tinkerpop since those are missing stack traces.

  2. implicit class NodeTypeDeco[NodeType <: StoredNode] extends AnyRef
  3. implicit class NodeTypeDecoForSeq[NodeType <: StoredNode] extends AnyRef

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  8. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  9. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  10. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  11. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  12. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  13. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  14. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  15. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  16. implicit def toCall[Labels <: HList](steps: Steps[Call, Vertex, Labels]): Call[Labels]
  17. implicit def toDeclaration[Labels <: HList](steps: Steps[Declaration, Vertex, Labels]): Declaration[Labels]
  18. implicit def toExpression[Labels <: HList](steps: Steps[Expression, Vertex, Labels]): Expression[Labels]
  19. implicit def toFile[Labels <: HList](steps: Steps[File, Vertex, Labels]): File[Labels]
  20. implicit def toIdentifier[Labels <: HList](steps: Steps[Identifier, Vertex, Labels]): Identifier[Labels]
  21. implicit def toLiteral[Labels <: HList](steps: Steps[Literal, Vertex, Labels]): Literal[Labels]
  22. implicit def toLocal[Labels <: HList](steps: Steps[Local, Vertex, Labels]): Local[Labels]
  23. implicit def toMember[Labels <: HList](steps: Steps[Member, Vertex, Labels]): Member[Labels]
  24. implicit def toMethod[Labels <: HList](steps: Steps[Method, Vertex, Labels]): Method[Labels]
  25. implicit def toMethodInst[Labels <: HList](steps: Steps[MethodInst, Vertex, Labels]): MethodInst[Labels]
  26. implicit def toMethodParameter[Labels <: HList](steps: Steps[MethodParameterIn, Vertex, Labels]): MethodParameter[Labels]
  27. implicit def toMethodParameterOut[Labels <: HList](steps: Steps[MethodParameterOut, Vertex, Labels]): MethodParameterOut[Labels]
  28. implicit def toMethodReturn[Labels <: HList](steps: Steps[MethodReturn, Vertex, Labels]): MethodReturn[Labels]
  29. implicit def toModifier[Labels <: HList](steps: Steps[Modifier, Vertex, Labels]): Modifier[Labels]
  30. implicit def toNamespace[Labels <: HList](steps: Steps[Namespace, Vertex, Labels]): Namespace[Labels]
  31. def toString(): String
    Definition Classes
    AnyRef → Any
  32. implicit def toType[Labels <: HList](steps: Steps[Type, Vertex, Labels]): Type[Labels]
  33. implicit def toTypeDecl[Labels <: HList](steps: Steps[TypeDecl, Vertex, Labels]): TypeDecl[Labels]
  34. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  35. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  36. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )

Inherited from AnyRef

Inherited from Any

Ungrouped