Skip to content

Wire up NVD API key for the owasp Gradle task - #4725

Open
epugh wants to merge 3 commits into
apache:mainfrom
epugh:owasp-nvd-apikey
Open

Wire up NVD API key for the owasp Gradle task#4725
epugh wants to merge 3 commits into
apache:mainfrom
epugh:owasp-nvd-apikey

Conversation

@epugh

@epugh epugh commented Aug 11, 2026

Copy link
Copy Markdown
Contributor

Summary

  • ./gradlew owasp currently fails with an error from NvdApiDataSource because NVD heavily rate-limits its CVE data feed for unauthenticated requests.
  • Wires the dependencyCheck { nvd { apiKey = ... } } extension to a -PnvdApiKey=<key> project property or NVD_API_KEY environment variable, so the task can authenticate against NVD's API.
  • Documents the requirement (and how to get a free key) in dev-docs/FAQ.adoc and dev-docs/gradle-help/workflow.txt.

Test plan

  • ./gradlew help succeeds with no arguments
  • ./gradlew help -PnvdApiKey=<key> succeeds and the property is picked up by the extension
  • ./gradlew owasp -Pvalidation.owasp=true -PnvdApiKey=<a real NVD key> completes an actual scan (not run here — only verified configuration wiring, not a live NVD API call)

The ./gradlew owasp task fails with an error from NvdApiDataSource
because NVD heavily rate-limits its CVE data feed for unauthenticated
requests. Wire the plugin's nvd.apiKey through a -PnvdApiKey property
or NVD_API_KEY env var, and document the requirement.

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
@github-actions github-actions Bot added documentation Improvements or additions to documentation tool:build labels Aug 11, 2026
@github-actions github-actions Bot added the dependencies Dependency upgrades label Aug 11, 2026
@epugh

epugh commented Aug 11, 2026

Copy link
Copy Markdown
Contributor Author

This is paired with #4720, which does the same thing in 9x.

I played around with this, and I think it identified some CVE's that docker scout didn't, but not positive. I do wonder if we just normalize using docker scout if we could eliminate this plugin? It's not well documented, and I don't know if anyone actually uses it.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

dependencies Dependency upgrades documentation Improvements or additions to documentation tool:build

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant