Skip to content

Commit c761c1a

Browse files
authored
Merge pull request #41 from sonukapoor/docs/advisory-driven-malware-detection-note
docs: clarify advisory-driven malware detection limits
2 parents 5c682bb + eeaaf31 commit c761c1a

1 file changed

Lines changed: 17 additions & 0 deletions

File tree

README.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -174,6 +174,21 @@ Support for stricter network-controlled environments is planned on the roadmap,
174174
- custom advisory endpoint support for internal mirrors or proxies
175175
- local advisory database input for controlled or air-gapped workflows
176176

177+
## Detecting malicious package incidents
178+
179+
CVE Lite CLI can help detect malicious package incidents and supply-chain compromises **once the affected versions are represented in OSV or equivalent advisory data available through the configured advisory endpoint**.
180+
181+
In practice, that means the tool can catch incidents such as a compromised npm package **when the exact malicious version appears in your lockfile** and the advisory data has already been published and indexed. This makes the tool useful for real-world release checks after a malicious package disclosure becomes known.
182+
183+
It is important to be precise about the current scope:
184+
185+
- CVE Lite CLI is **advisory-driven**, not a behavioral malware detector
186+
- it does **not** perform static malware analysis on package contents
187+
- it does **not** detect a package compromise before advisory intelligence exists for it
188+
- it works best with lockfiles because they capture the exact resolved version that was actually installed
189+
190+
So the practical model is: **local lockfile scan + advisory matching**. When malicious versions are published to OSV or mirrored through a compatible internal endpoint, CVE Lite CLI can flag those exact versions during a scan.
191+
177192
## How it works
178193

179194
### Architectural Philosophy
@@ -422,6 +437,8 @@ If your goal is a practical developer-first CVE scan right before release, CVE L
422437

423438
To keep the project honest, here is what it does **not** do in the current version:
424439

440+
- it does not detect malicious packages before they are represented in advisory data
441+
- it does not perform behavioral malware detection or package content analysis
425442
- it does not prove exploitability
426443
- it does not verify runtime reachability
427444
- it does not scan container images, binaries, secrets, or IaC

0 commit comments

Comments
 (0)