Skip to content

Commit fd5c51a

Browse files
readme: description of :security/nvd- aliases
1 parent 089201f commit fd5c51a

File tree

1 file changed

+9
-9
lines changed

1 file changed

+9
-9
lines changed

README.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -599,18 +599,18 @@ Web servers and other standalone services run with Clojure CLI
599599
600600
## Security
601601

602-
> DEPRECATED: `:security/nvd`
603-
> Using clojure-nvd via an alias [checks for security issues in clojure-nvd and its dependencies as they merged into the classpath](https://github.com/practicalli/clojure-cli-config/pull/31).
604-
>
605-
> The maintainer of clojure-nvd [suggested several ways to avoid classpath interference](https://github.com/rm-hull/nvd-clojure#avoiding-classpath-interference)
602+
`:security/nvd-scan` and `:security/ndv-fix` adds [clj-watson](https://github.com/clj-holmes/clj-watson) tool
606603

607-
* `:service/nvd` - check library dependencies of a project against the [National Vulnerability Database](https://nvd.nist.gov/) using [nvd-clojure](https://github.com/rm-hull/nvd-clojure)
604+
The alias requires an [API Key to access the NIST National Vulnerability Database (NVD)](https://nvd.nist.gov/developers/request-an-api-key).
608605

609-
| Command | Description |
610-
|--------------------------------------------------|--------------------------------------------------------------------|
611-
| `clojure -T:security/nvd "" "$(clojure -Spath)"` | check all jar files on the class path for security vulnerabilities |
606+
`CLJ_WATSON_NVD_API_KEY` environment variable should be set to the value of the API Key, e.g via `.bashrc` or `.zshenv` file.
612607

613-
> The first "" is required argument and can contain a filename to a json file of additional configuration. The second argument, `"$(clojure -Spath)"`, passes the project classpath to be analysed as a string.
608+
| Command | Description |
609+
|------------------------------- | ------------------------------------------------------------------- |
610+
| `clojure -T:security/nvd-scan` | check all libraries on the class path for security vulnerabilities |
611+
| `clojure -T:security/nvd-fix` | update all libraries on the class path for security vulnerabilities |
612+
613+
> [clj-watson-action](https://github.com/clj-holmes/clj-watson-action) can be used in a GitHub workflow to run security vulnerability checks
614614
615615

616616
## Community activities

0 commit comments

Comments
 (0)