{"uuid": "c8f54e1d-96b1-4348-b953-baa69a9f54d4", "vulnerability_lookup_origin": "1a89b78e-f703-45f3-bb86-59eb712668bd", "author": "9f56dd64-161d-43a6-b9c3-555944290a09", "vulnerability": "CVE-2024-12345", "type": "seen", "source": "https://gist.github.com/tu-trinh-scale/722400b4fc433ae9f66cca655969ef27", "content": "diff --git a/README.md b/README.md\nindex 57102d1..ba32226 100644\n--- a/README.md\n+++ b/README.md\n@@ -174,6 +174,19 @@ Vuls has some options to detect the vulnerabilities\n \n ----\n \n+## Quick Start\n+\n+Copy the example configuration and edit it for your environment:\n+\n+```bash\n+cp config.toml.example config.toml\n+vi config.toml\n+```\n+\n+The example config includes settings for all vulnerability dictionary databases\n+including KEV (Known Exploited Vulnerabilities) support for both CISA and\n+VulnCheck sources.\n+\n ## Document\n \n For more information such as Installation, Tutorial, Usage, visit [vuls.io](https://vuls.io/)  \ndiff --git a/config.toml.example b/config.toml.example\nnew file mode 100644\nindex 0000000..81e95a4\n--- /dev/null\n+++ b/config.toml.example\n@@ -0,0 +1,61 @@\n+# Vuls - Vulnerability Scanner\n+# Example configuration file\n+# Copy this file to config.toml and edit as needed.\n+\n+# ----- Default Settings -----\n+[default]\n+port = \"22\"\n+user = \"vuls\"\n+keyPath = \"/home/vuls/.ssh/id_rsa\"\n+# scanMode = [\"fast\"]\n+# scanModules = [\"ospkg\", \"wordpress\", \"lockfile\", \"port\"]\n+\n+# ----- Vulnerability Dictionary Databases -----\n+\n+[cveDict]\n+type = \"sqlite3\"\n+SQLite3Path = \"/path/to/cve.sqlite3\"\n+\n+[ovalDict]\n+type = \"sqlite3\"\n+SQLite3Path = \"/path/to/oval.sqlite3\"\n+\n+[gost]\n+type = \"sqlite3\"\n+SQLite3Path = \"/path/to/gost.sqlite3\"\n+\n+[exploit]\n+type = \"sqlite3\"\n+SQLite3Path = \"/path/to/go-exploitdb.sqlite3\"\n+\n+[metasploit]\n+type = \"sqlite3\"\n+SQLite3Path = \"/path/to/go-msfdb.sqlite3\"\n+\n+# ----- KEV (Known Exploited Vulnerabilities) -----\n+# Supports CISA KEV and VulnCheck KEV sources.\n+# KEV data is promoted to a first-class field on the vulnerability model.\n+[kevuln]\n+type = \"sqlite3\"\n+SQLite3Path = \"/path/to/go-kev.sqlite3\"\n+\n+[cti]\n+type = \"sqlite3\"\n+SQLite3Path = \"/path/to/go-cti.sqlite3\"\n+\n+# ----- Scan Targets -----\n+\n+[servers]\n+\n+[servers.localhost]\n+host = \"localhost\"\n+port = \"local\"\n+\n+# [servers.web-server]\n+# host = \"192.168.0.100\"\n+# port = \"22\"\n+# user = \"vuls\"\n+# keyPath = \"/home/vuls/.ssh/id_rsa\"\n+# scanMode = [\"fast-root\"]\n+# scanModules = [\"ospkg\"]\n+# cpeNames = [\"cpe:/a:example:package\"]\ndiff --git a/models/scanresults.go b/models/scanresults.go\nindex 508b992..4139187 100644\n--- a/models/scanresults.go\n+++ b/models/scanresults.go\n@@ -197,13 +197,14 @@ func (r ScanResult) FormatTextReportHeader() string {\n \t\tpkgs = fmt.Sprintf(\"%s, %d libs\", pkgs, r.LibraryScanners.Total())\n \t}\n \n-\treturn fmt.Sprintf(\"%s\\n%s\\n%s\\n%s, %s, %s, %s\\n%s\\n\",\n+\treturn fmt.Sprintf(\"%s\\n%s\\n%s\\n%s, %s, %s, %s, %s\\n%s\\n\",\n \t\tr.ServerInfo(),\n \t\tbuf.String(),\n \t\tr.ScannedCves.FormatCveSummary(),\n \t\tr.ScannedCves.FormatFixedStatus(r.Packages),\n \t\tr.FormatExploitCveSummary(),\n \t\tr.FormatMetasploitCveSummary(),\n+\t\tr.FormatKEVCveSummary(),\n \t\tr.FormatAlertSummary(),\n \t\tpkgs)\n }\n@@ -251,15 +252,22 @@ func (r ScanResult) FormatMetasploitCveSummary() string {\n \treturn fmt.Sprintf(\"%d exploits\", nMetasploitCve)\n }\n \n+// FormatKEVCveSummary returns a summary of KEV CVEs\n+func (r ScanResult) FormatKEVCveSummary() string {\n+\tnKEVCve := 0\n+\tfor _, vuln := range r.ScannedCves {\n+\t\tif 0 &lt; len(vuln.KEVs) {\n+\t\t\tnKEVCve++\n+\t\t}\n+\t}\n+\treturn fmt.Sprintf(\"%d kevs\", nKEVCve)\n+}\n+\n // FormatAlertSummary returns a summary of CERT alerts\n func (r ScanResult) FormatAlertSummary() string {\n-\tcisaCnt := 0\n \tuscertCnt := 0\n \tjpcertCnt := 0\n \tfor _, vuln := range r.ScannedCves {\n-\t\tif len(vuln.AlertDict.CISA) &gt; 0 {\n-\t\t\tcisaCnt += len(vuln.AlertDict.CISA)\n-\t\t}\n \t\tif len(vuln.AlertDict.USCERT) &gt; 0 {\n \t\t\tuscertCnt += len(vuln.AlertDict.USCERT)\n \t\t}\n@@ -267,7 +275,7 @@ func (r ScanResult) FormatAlertSummary() string {\n \t\t\tjpcertCnt += len(vuln.AlertDict.JPCERT)\n \t\t}\n \t}\n-\treturn fmt.Sprintf(\"cisa: %d, uscert: %d, jpcert: %d alerts\", cisaCnt, uscertCnt, jpcertCnt)\n+\treturn fmt.Sprintf(\"uscert: %d, jpcert: %d alerts\", uscertCnt, jpcertCnt)\n }\n \n func (r ScanResult) isDisplayUpdatableNum(mode config.ScanMode) bool {\n@@ -437,6 +445,12 @@ func (r *ScanResult) SortForJSONOutput() {\n \t\tsort.Slice(v.AlertDict.CISA, func(i, j int) bool {\n \t\t\treturn v.AlertDict.CISA[i].Title &lt; v.AlertDict.CISA[j].Title\n \t\t})\n+\t\tsort.Slice(v.KEVs, func(i, j int) bool {\n+\t\t\tif v.KEVs[i].Type != v.KEVs[j].Type {\n+\t\t\t\treturn v.KEVs[i].Type &lt; v.KEVs[j].Type\n+\t\t\t}\n+\t\t\treturn v.KEVs[i].VulnerabilityName &lt; v.KEVs[j].VulnerabilityName\n+\t\t})\n \t\tr.ScannedCves[k] = v\n \t}\n }\ndiff --git a/models/vulninfos.go b/models/vulninfos.go\nindex 3e85e81..9eaf421 100644\n--- a/models/vulninfos.go\n+++ b/models/vulninfos.go\n@@ -267,6 +267,7 @@ type VulnInfo struct {\n \tMetasploits          []Metasploit         `json:\"metasploits,omitempty\"`\n \tMitigations          []Mitigation         `json:\"mitigations,omitempty\"`\n \tCtis                 []string             `json:\"ctis,omitempty\"`\n+\tKEVs                 []KEV                `json:\"kevs,omitempty\"`\n \tAlertDict            AlertDict            `json:\"alertDict,omitempty\"`\n \tCpeURIs              []string             `json:\"cpeURIs,omitempty\"` // CpeURIs related to this CVE defined in config.toml\n \tGitHubSecurityAlerts GitHubSecurityAlerts `json:\"gitHubSecurityAlerts,omitempty\"`\n@@ -910,6 +911,58 @@ type Mitigation struct {\n \tURL            string         `json:\"url,omitempty\"`\n }\n \n+// KEVType represents the source of a KEV entry\n+type KEVType string\n+\n+const (\n+\t// CISAKEVType is the CISA KEV source\n+\tCISAKEVType KEVType = \"cisa\"\n+\n+\t// VulnCheckKEVType is the VulnCheck KEV source\n+\tVulnCheckKEVType KEVType = \"vulncheck\"\n+)\n+\n+// KEV has Known Exploited Vulnerability information\n+type KEV struct {\n+\tType                       KEVType       `json:\"type\"`\n+\tVendorProject              string        `json:\"vendorProject\"`\n+\tProduct                    string        `json:\"product\"`\n+\tVulnerabilityName          string        `json:\"vulnerabilityName\"`\n+\tShortDescription           string        `json:\"shortDescription\"`\n+\tRequiredAction             string        `json:\"requiredAction\"`\n+\tKnownRansomwareCampaignUse string        `json:\"knownRansomwareCampaignUse\"`\n+\tDateAdded                  time.Time     `json:\"dateAdded\"`\n+\tDueDate                    *time.Time    `json:\"dueDate,omitempty\"`\n+\tCISA                       *CISAKEV      `json:\"cisa,omitempty\"`\n+\tVulnCheck                  *VulnCheckKEV `json:\"vulnCheck,omitempty\"`\n+}\n+\n+// CISAKEV has CISA-specific KEV information\n+type CISAKEV struct {\n+\tNote string `json:\"note\"`\n+}\n+\n+// VulnCheckKEV has VulnCheck-specific KEV information\n+type VulnCheckKEV struct {\n+\tXDB                   []VulnCheckXDB                   `json:\"xdb,omitempty\"`\n+\tReportedExploitation  []VulnCheckReportedExploitation  `json:\"reportedExploitation,omitempty\"`\n+}\n+\n+// VulnCheckXDB has VulnCheck exploit database information\n+type VulnCheckXDB struct {\n+\tXDBID       string    `json:\"xdbID\"`\n+\tXDBURL      string    `json:\"xdbURL\"`\n+\tDateAdded   time.Time `json:\"dateAdded\"`\n+\tExploitType string    `json:\"exploitType\"`\n+\tCloneSSHURL string    `json:\"cloneSSHURL\"`\n+}\n+\n+// VulnCheckReportedExploitation has VulnCheck reported exploitation information\n+type VulnCheckReportedExploitation struct {\n+\tURL       string    `json:\"url\"`\n+\tDateAdded time.Time `json:\"dateAdded\"`\n+}\n+\n // AlertDict has target cve JPCERT, USCERT and CISA alert data\n type AlertDict struct {\n \tCISA   []Alert `json:\"cisa\"`\n@@ -919,15 +972,12 @@ type AlertDict struct {\n \n // IsEmpty checks if the content of AlertDict is empty\n func (a AlertDict) IsEmpty() bool {\n-\treturn len(a.CISA) == 0 &amp;&amp; len(a.JPCERT) == 0 &amp;&amp; len(a.USCERT) == 0\n+\treturn len(a.JPCERT) == 0 &amp;&amp; len(a.USCERT) == 0\n }\n \n // FormatSource returns which source has this alert\n func (a AlertDict) FormatSource() string {\n \tvar s []string\n-\tif len(a.CISA) != 0 {\n-\t\ts = append(s, \"CISA\")\n-\t}\n \tif len(a.USCERT) != 0 || len(a.JPCERT) != 0 {\n \t\ts = append(s, \"CERT\")\n \t}\ndiff --git a/reporter/util.go b/reporter/util.go\nindex d9cfdaa..a2dfbd0 100644\n--- a/reporter/util.go\n+++ b/reporter/util.go\n@@ -204,6 +204,7 @@ func formatOneLineSummary(rs ...models.ScanResult) string {\n \t\t\t\tr.FormatUpdatablePkgsSummary(),\n \t\t\t\tr.FormatExploitCveSummary(),\n \t\t\t\tr.FormatMetasploitCveSummary(),\n+\t\t\t\tr.FormatKEVCveSummary(),\n \t\t\t\tr.FormatAlertSummary(),\n \t\t\t}\n \t\t} else {\n@@ -565,10 +566,6 @@ No CVE-IDs are found in updatable packages.\n \t\t})\n \t\tdata = append(data, ds...)\n \n-\t\tfor _, alert := range vuln.AlertDict.CISA {\n-\t\t\tdata = append(data, []string{\"CISA Alert\", alert.URL})\n-\t\t}\n-\n \t\tfor _, alert := range vuln.AlertDict.JPCERT {\n \t\t\tdata = append(data, []string{\"JPCERT Alert\", alert.URL})\n \t\t}\ndiff --git a/sample_scan_result.json b/sample_scan_result.json\nnew file mode 100644\nindex 0000000..5490b13\n--- /dev/null\n+++ b/sample_scan_result.json\n@@ -0,0 +1,125 @@\n+{\n+  \"jsonVersion\": 4,\n+  \"lang\": \"en\",\n+  \"serverUUID\": \"sample-uuid-1234\",\n+  \"serverName\": \"web-server-01\",\n+  \"family\": \"ubuntu\",\n+  \"release\": \"22.04\",\n+  \"scannedAt\": \"2026-07-03T10:00:00Z\",\n+  \"scannedCves\": {\n+    \"CVE-2024-12345\": {\n+      \"cveID\": \"CVE-2024-12345\",\n+      \"confidences\": [\n+        {\n+          \"score\": 100,\n+          \"detectionMethod\": \"OvalMatch\"\n+        }\n+      ],\n+      \"affectedPackages\": [\n+        {\n+          \"name\": \"libexample\",\n+          \"fixedIn\": \"1.2.4\"\n+        }\n+      ],\n+      \"cveContents\": {\n+        \"nvd\": [\n+          {\n+            \"cvss3Score\": 9.8,\n+            \"cvss3Severity\": \"CRITICAL\",\n+            \"cvss3Vector\": \"CVSS:3.1/AV:N/AC:L/PR:N/UI:N/S:U/C:H/I:H/A:H\",\n+            \"summary\": \"Example vulnerability in libexample allowing remote code execution.\"\n+          }\n+        ]\n+      },\n+      \"kevs\": [\n+        {\n+          \"type\": \"cisa\",\n+          \"vendorProject\": \"ExampleVendor\",\n+          \"product\": \"libexample\",\n+          \"vulnerabilityName\": \"ExampleVendor libexample Remote Code Execution Vulnerability\",\n+          \"shortDescription\": \"ExampleVendor libexample contains a vulnerability that allows remote code execution.\",\n+          \"requiredAction\": \"Apply updates per vendor instructions.\",\n+          \"knownRansomwareCampaignUse\": \"Known\",\n+          \"dateAdded\": \"2024-06-15T00:00:00Z\",\n+          \"dueDate\": \"2024-07-06T00:00:00Z\",\n+          \"cisa\": {\n+            \"note\": \"https://www.cisa.gov/known-exploited-vulnerabilities-catalog\"\n+          }\n+        },\n+        {\n+          \"type\": \"vulncheck\",\n+          \"vendorProject\": \"ExampleVendor\",\n+          \"product\": \"libexample\",\n+          \"vulnerabilityName\": \"ExampleVendor libexample Remote Code Execution Vulnerability\",\n+          \"shortDescription\": \"ExampleVendor libexample contains a vulnerability that allows remote code execution.\",\n+          \"requiredAction\": \"Apply updates per vendor instructions.\",\n+          \"knownRansomwareCampaignUse\": \"Known\",\n+          \"dateAdded\": \"2024-06-10T00:00:00Z\",\n+          \"vulnCheck\": {\n+            \"xdb\": [\n+              {\n+                \"xdbID\": \"XDB-2024-001\",\n+                \"xdbURL\": \"https://vulncheck.com/xdb/XDB-2024-001\",\n+                \"dateAdded\": \"2024-06-10T00:00:00Z\",\n+                \"exploitType\": \"remote\",\n+                \"cloneSSHURL\": \"git@github.com:example/exploit.git\"\n+              }\n+            ],\n+            \"reportedExploitation\": [\n+              {\n+                \"url\": \"https://example.com/threat-report-2024\",\n+                \"dateAdded\": \"2024-06-12T00:00:00Z\"\n+              }\n+            ]\n+          }\n+        }\n+      ],\n+      \"alertDict\": {\n+        \"cisa\": [],\n+        \"jpcert\": [],\n+        \"uscert\": []\n+      }\n+    },\n+    \"CVE-2024-67890\": {\n+      \"cveID\": \"CVE-2024-67890\",\n+      \"confidences\": [\n+        {\n+          \"score\": 100,\n+          \"detectionMethod\": \"OvalMatch\"\n+        }\n+      ],\n+      \"affectedPackages\": [\n+        {\n+          \"name\": \"libwidget\",\n+          \"notFixedYet\": true\n+        }\n+      ],\n+      \"cveContents\": {\n+        \"nvd\": [\n+          {\n+            \"cvss3Score\": 7.5,\n+            \"cvss3Severity\": \"HIGH\",\n+            \"cvss3Vector\": \"CVSS:3.1/AV:N/AC:L/PR:N/UI:N/S:U/C:N/I:N/A:H\",\n+            \"summary\": \"Denial of service vulnerability in libwidget.\"\n+          }\n+        ]\n+      },\n+      \"alertDict\": {\n+        \"cisa\": [],\n+        \"jpcert\": [],\n+        \"uscert\": []\n+      }\n+    }\n+  },\n+  \"packages\": {\n+    \"libexample\": {\n+      \"name\": \"libexample\",\n+      \"version\": \"1.2.3\",\n+      \"newVersion\": \"1.2.4\"\n+    },\n+    \"libwidget\": {\n+      \"name\": \"libwidget\",\n+      \"version\": \"2.0.0\"\n+    }\n+  }\n+}\ndiff --git a/tui/tui.go b/tui/tui.go\nindex 4407f56..80afe95 100644\n--- a/tui/tui.go\n+++ b/tui/tui.go\n@@ -812,16 +812,6 @@ func setChangelogLayout(g *gocui.Gui) error {\n \t\t\t}\n \t\t}\n \n-\t\tif len(vinfo.AlertDict.CISA) &gt; 0 {\n-\t\t\tlines = append(lines, \"\\n\",\n-\t\t\t\t\"CISA Alert\",\n-\t\t\t\t\"===========\",\n-\t\t\t)\n-\t\t\tfor _, alert := range vinfo.AlertDict.CISA {\n-\t\t\t\tlines = append(lines, fmt.Sprintf(\"* [%s](%s)\", alert.Title, alert.URL))\n-\t\t\t}\n-\t\t}\n-\n \t\tif len(vinfo.AlertDict.USCERT) &gt; 0 {\n \t\t\tlines = append(lines, \"\\n\",\n \t\t\t\t\"USCERT Alert\",\n", "creation_timestamp": "2026-07-03T22:03:50.787669Z"}