add cwe to rule interface

MariusAlbrecht · Jun 18, 2024 · d1f9e99 · d1f9e99
1 parent 03f31b2
commit d1f9e99
Showing 1 changed file with 11 additions and 1 deletion.
diff --git a/cpg-analysis/src/main/kotlin/de/fraunhofer/aisec/cpg/query/Rule.kt b/cpg-analysis/src/main/kotlin/de/fraunhofer/aisec/cpg/query/Rule.kt
@@ -29,7 +29,7 @@ import de.fraunhofer.aisec.cpg.TranslationResult
 
 interface Rule {
     /** the query result, one of the members has to be `null` */
-    var queryResult: Pair<QueryTree<*>?, Pair<Boolean, List<*>>?>?
+    var queryResult: QueryTree<*>? /* Pair<QueryTree<*>?, Pair<Boolean, List<*>>?>? */
 
     // consider
     // https://github.com/microsoft/sarif-tutorials/blob/main/docs/Authoring-rule-metadata-and-result-messages.md
@@ -41,6 +41,16 @@ interface Rule {
 
     /** human readable name of the query */
     val name: String
+    /**
+     * !!only the number!!
+     *
+     * something like "CWE-123" WILL break stuff
+     *
+     * TODO consider validation
+     */
+    val cweId: String?
+        get() = null
+
     val shortDescription: String
     val mdShortDescription: String?
         get() = null