-
Notifications
You must be signed in to change notification settings - Fork 3.3k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
This will require npm/query#65 before it will work
- Loading branch information
Showing
3 changed files
with
73 additions
and
27 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -62,7 +62,7 @@ The [`npm query`](/commands/npm-query) command exposes a new dependency selector | |
- `:path(<path>)` [glob](https://www.npmjs.com/package/glob) matching based on dependencies path relative to the project | ||
- `:type(<type>)` [based on currently recognized types](https://github.com/npm/npm-package-arg#result-object) | ||
- `:outdated(<type>)` when a dependency is outdated | ||
- `:vuln` when a dependency has a known vulnerability | ||
- `:vuln(<selector>)` when a dependency has a known vulnerability | ||
|
||
##### `:semver(<spec>, [selector], [function])` | ||
|
||
|
@@ -106,8 +106,17 @@ Some examples: | |
|
||
The `:vuln` pseudo selector retrieves data from the registry and returns information about which if your dependencies has a known vulnerability. Only dependencies whose current version matches a vulnerability will be returned. For example if you have `[email protected]` in your tree, a vulnerability for `semver` which affects versions `<=6.3.1` will not match. | ||
|
||
You can also filter results by certain attributes in advisories. Currently that includes `severity` and `cwe`. Note that severity filtering is done per severity, it does not include severities "higher" or "lower" than the one specified. | ||
|
||
In addition to the filtering performed by the pseudo selector, info about each relevant advisory will be added to the `queryContext` attribute of each node under the `advisories` attribute. | ||
|
||
Some examples: | ||
|
||
- `:root > .prod:vuln` returns direct production dependencies with any known vulnerability | ||
- `:vuln([severity=high])` returns only dependencies with a vulnerability with a `high` severity. | ||
- `:vuln([severity=high],[severity=moderate])` returns only dependencies with a vulnerability with a `high` or `moderate` severity. | ||
- `:vuln([cwe=1333])` returns only dependencies with a vulnerability that includes CWE-1333 (ReDoS) | ||
|
||
#### [Attribute Selectors](https://developer.mozilla.org/en-US/docs/Web/CSS/Attribute_selectors) | ||
|
||
The attribute selector evaluates the key/value pairs in `package.json` if they are `String`s. | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -100,9 +100,11 @@ t.test('query-selector-all', async t => { | |
}) | ||
|
||
nock('https://registry.npmjs.org') | ||
.persist() | ||
.post('/-/npm/v1/security/advisories/bulk') | ||
.reply(200, { | ||
foo: [{ id: 'test-vuln', vulnerable_versions: '*' }], | ||
foo: [{ id: 'test-vuln', vulnerable_versions: '*', severity: 'high', cwe: [] }], | ||
sive: [{ id: 'test-vuln', vulnerable_versions: '*', severity: 'low', cwe: ['CWE-123'] }], | ||
moo: [{ id: 'test-vuln', vulnerable_versions: '<1.0.0' }], | ||
}) | ||
for (const [pkg, versions] of Object.entries(packumentStubs)) { | ||
|
@@ -849,7 +851,11 @@ t.test('query-selector-all', async t => { | |
[':outdated(nonsense)', [], { before: yesterday }], // again, no results here ever | ||
|
||
// vuln pseudo | ||
[':vuln', ['[email protected]']], | ||
[':vuln', ['[email protected]', '[email protected]']], | ||
[':vuln([severity=high])', ['[email protected]']], | ||
[':vuln([cwe])', ['[email protected]']], | ||
[':vuln([cwe=123])', ['[email protected]']], | ||
[':vuln([severity=critical])', []], | ||
['#nomatch:vuln', []], // no network requests are made if the result set is empty | ||
|
||
// attr pseudo | ||
|