json-writer: add CWE links to mitre.org in SARIF

Author: kdudka

src/json-writer.cc

@@ -165,13 +165,21 @@ void SarifTreeEncoder::serializeCweMap()
 
         PTree cweList;
         const auto cwe = item.second;
-        const auto cweStr = "CWE-" + std::to_string(cwe);
-        appendNode(&cweList, PTree(cweStr));
+        const auto cweStr = std::to_string(cwe);
+        appendNode(&cweList, PTree("CWE-" + cweStr));
 
+        // properties.cwe[]
         PTree props;
         props.put_child("cwe", cweList);
         rule.put_child("properties", props);
 
+        // help.text
+        PTree help;
+        const auto helpText =
+            "https://cwe.mitre.org/data/definitions/" + cweStr + ".html";
+        help.put<std::string>("text", helpText);
+        rule.put_child("help", help);
+
         appendNode(&ruleList, rule);
     }
 

tests/csgrep/81-sarif-writer-stdout.txt

@@ -15,6 +15,9 @@
                                 "cwe": [
                                     "CWE-762"
                                 ]
+                            },
+                            "help": {
+                                "text": "https://cwe.mitre.org/data/definitions/762.html"
                             }
                         },
                         {
@@ -23,6 +26,9 @@
                                 "cwe": [
                                     "CWE-252"
                                 ]
+                            },
+                            "help": {
+                                "text": "https://cwe.mitre.org/data/definitions/252.html"
                             }
                         },
                         {
@@ -31,6 +37,9 @@
                                 "cwe": [
                                     "CWE-569"
                                 ]
+                            },
+                            "help": {
+                                "text": "https://cwe.mitre.org/data/definitions/569.html"
                             }
                         },
                         {
@@ -39,6 +48,9 @@
                                 "cwe": [
                                     "CWE-569"
                                 ]
+                            },
+                            "help": {
+                                "text": "https://cwe.mitre.org/data/definitions/569.html"
                             }
                         },
                         {
@@ -47,6 +59,9 @@
                                 "cwe": [
                                     "CWE-561"
                                 ]
+                            },
+                            "help": {
+                                "text": "https://cwe.mitre.org/data/definitions/561.html"
                             }
                         },
                         {
@@ -55,6 +70,9 @@
                                 "cwe": [
                                     "CWE-561"
                                 ]
+                            },
+                            "help": {
+                                "text": "https://cwe.mitre.org/data/definitions/561.html"
                             }
                         },
                         {
@@ -63,6 +81,9 @@
                                 "cwe": [
                                     "CWE-561"
                                 ]
+                            },
+                            "help": {
+                                "text": "https://cwe.mitre.org/data/definitions/561.html"
                             }
                         },
                         {
@@ -71,6 +92,9 @@
                                 "cwe": [
                                     "CWE-476"
                                 ]
+                            },
+                            "help": {
+                                "text": "https://cwe.mitre.org/data/definitions/476.html"
                             }
                         },
                         {
@@ -79,6 +103,9 @@
                                 "cwe": [
                                     "CWE-687"
                                 ]
+                            },
+                            "help": {
+                                "text": "https://cwe.mitre.org/data/definitions/687.html"
                             }
                         },
                         {
@@ -87,6 +114,9 @@
                                 "cwe": [
                                     "CWE-119"
                                 ]
+                            },
+                            "help": {
+                                "text": "https://cwe.mitre.org/data/definitions/119.html"
                             }
                         },
                         {
@@ -95,6 +125,9 @@
                                 "cwe": [
                                     "CWE-119"
                                 ]
+                            },
+                            "help": {
+                                "text": "https://cwe.mitre.org/data/definitions/119.html"
                             }
                         },
                         {
@@ -103,6 +136,9 @@
                                 "cwe": [
                                     "CWE-125"
                                 ]
+                            },
+                            "help": {
+                                "text": "https://cwe.mitre.org/data/definitions/125.html"
                             }
                         },
                         {
@@ -111,6 +147,9 @@
                                 "cwe": [
                                     "CWE-686"
                                 ]
+                            },
+                            "help": {
+                                "text": "https://cwe.mitre.org/data/definitions/686.html"
                             }
                         },
                         {
@@ -119,6 +158,9 @@
                                 "cwe": [
                                     "CWE-404"
                                 ]
+                            },
+                            "help": {
+                                "text": "https://cwe.mitre.org/data/definitions/404.html"
                             }
                         },
                         {
@@ -127,6 +169,9 @@
                                 "cwe": [
                                     "CWE-404"
                                 ]
+                            },
+                            "help": {
+                                "text": "https://cwe.mitre.org/data/definitions/404.html"
                             }
                         },
                         {
@@ -135,6 +180,9 @@
                                 "cwe": [
                                     "CWE-170"
                                 ]
+                            },
+                            "help": {
+                                "text": "https://cwe.mitre.org/data/definitions/170.html"
                             }
                         },
                         {
@@ -143,6 +191,9 @@
                                 "cwe": [
                                     "CWE-120"
                                 ]
+                            },
+                            "help": {
+                                "text": "https://cwe.mitre.org/data/definitions/120.html"
                             }
                         },
                         {
@@ -151,6 +202,9 @@
                                 "cwe": [
                                     "CWE-367"
                                 ]
+                            },
+                            "help": {
+                                "text": "https://cwe.mitre.org/data/definitions/367.html"
                             }
                         }
                     ]