README.md (895B)
1 # cve-toolkit 2 3 A lightweight CVE detection toolkit for Linux systems. 4 5 > **Note:** This is currently detection-only. There are no command-line arguments — just run it and it checks everything it knows about. 6 7 ## Build 8 9 ```bash 10 make 11 ``` 12 13 ## Usage 14 15 ```bash 16 ./cve-toolkit 17 ``` 18 19 That's it. The tool runs all bundled detectors, reports pass/fail per check, and prints remediation steps for any detected vulnerabilities. 20 21 ## Adding Detectors 22 23 Detectors live under `src/detector/`. Each `.c` file registers itself at startup via a `__attribute__((constructor))` function: 24 25 ```c 26 int detector_cve_XXXX_XXXXX(int num) { 27 // return 0 for pass, 1 for fail 28 } 29 30 __attribute__((constructor)) 31 void detector_cve_XXXX_XXXXX_setup() { 32 detector_queue_append("CVE-XXXX-XXXXX", "Remediation text here.", detector_cve_XXXX_XXXXX); 33 } 34 ``` 35 36 Then just `make` — the Makefile picks up all `.c` files automatically.