Add authors field and Crew object (#16)

* Add authors field and `Crew` object

* Document generation of `querydb.json`

README.md

@@ -135,3 +135,12 @@ If you want to test newly created queries with `joern-scan` as follows:
 ```
 ./install.sh && ./joern-scan <src>
 ```
+
+## Exporting the database to JSON
+
+You can launch
+```
+sbt run
+```
+to create a file named `querydb.json` that contains the list of all available queries
+along with its meta information.

src/main/scala/io/joern/scanners/Crew.scala

@@ -0,0 +1,9 @@
+package io.joern.scanners
+
+object Crew {
+
+  val suchakra = "@tuxology"
+  val niko = "@0x4D5A"
+  val fabs = "@fabsx00"
+
+}

src/main/scala/io/joern/scanners/c/CopyLoops.scala

@@ -8,6 +8,7 @@ object CopyLoops extends QueryBundle {
   @q
   def isCopyLoop(): Query = Query(
     name = "copy-loop",
+    author = Crew.fabs,
     title = "Copy loop detected",
     description =
       """

src/main/scala/io/joern/scanners/c/HeapBasedOverflow.scala

@@ -17,6 +17,7 @@ object HeapBasedOverflow extends QueryBundle {
   @q
   def mallocMemcpyIntOverflow()(implicit context: EngineContext): Query = Query(
     name = "malloc-memcpy-int-overflow",
+    author = Crew.fabs,
     title = "Dangerous copy-operation into heap-allocated buffer",
     description = "-",
     score = 4, { cpg =>

src/main/scala/io/joern/scanners/c/InsecureFunctions.scala

@@ -8,6 +8,7 @@ object InsecureFunctions extends QueryBundle {
   @q
   def getsUsed(): Query = Query(
     name = "call-to-gets",
+    author = Crew.suchakra,
     title = "Insecure function gets() used",
     description =
       """

src/main/scala/io/joern/scanners/c/IntegerTruncations.scala

@@ -14,6 +14,7 @@ object IntegerTruncations extends QueryBundle {
   @q
   def strlenAssignmentTruncations(): Query = Query(
     name = "strlen-truncation",
+    author = Crew.fabs,
     title = "Truncation in assigment involving strlen call",
     description = "-",
     score = 2, { cpg =>

src/main/scala/io/joern/scanners/c/Metrics.scala

@@ -8,6 +8,7 @@ object Metrics extends QueryBundle {
   @q
   def tooManyParameters(n: Int = 4): Query = Query(
     name = "too-many-params",
+    author = Crew.fabs,
     title = s"Number of parameters larger than $n",
     description =
       s"This query identifies functions with more than $n formal parameters",
@@ -19,6 +20,7 @@ object Metrics extends QueryBundle {
   @q
   def tooHighComplexity(n: Int = 4): Query = Query(
     name = "too-high-complexity",
+    author = Crew.fabs,
     title = s"Cyclomatic complexity higher than $n",
     description =
       s"This query identifies functions with a cyclomatic complexity higher than $n",
@@ -30,6 +32,7 @@ object Metrics extends QueryBundle {
   @q
   def tooLong(n: Int = 1000): Query = Query(
     name = "too-long",
+    author = Crew.fabs,
     title = s"More than $n lines",
     description =
       s"This query identifies functions that are more than $n lines long",
@@ -41,6 +44,7 @@ object Metrics extends QueryBundle {
   @q
   def multipleReturns(): Query = Query(
     name = "multiple-returns",
+    author = Crew.fabs,
     title = s"Multiple returns",
     description = "This query identifies functions with more than one return",
     score = 2.0, { cpg =>
@@ -51,6 +55,7 @@ object Metrics extends QueryBundle {
   @q
   def tooManyLoops(n: Int = 4): Query = Query(
     name = "too-many-loops",
+    author = Crew.fabs,
     title = s"More than $n loops",
     description = s"This query identifies functions with more than $n loops",
     score = 2, { cpg =>
@@ -63,6 +68,7 @@ object Metrics extends QueryBundle {
   @q
   def tooNested(n: Int = 3): Query = Query(
     name = "too-nested",
+    author = Crew.fabs,
     title = s"Nesting level higher than $n",
     description =
       s"This query identifies functions with a nesting level higher than $n",

src/main/scala/io/joern/scanners/package.scala

@@ -17,6 +17,7 @@ package object scanners {
   }
 
   case class Query(name: String,
+                   author: String,
                    title: String,
                    description: String,
                    score: Double,