Skip to content

Commit 9807caf

Browse files
authored
docs: update audit docs with provenance info (#7304)
Adds a note to the `audit` docs discussing the verification of provenance attestations. Per: npm/documentation#1010 Signed-off-by: Brian DeHamer <bdehamer@github.com>
1 parent 9d4e85f commit 9807caf

File tree

1 file changed

+7
-0
lines changed

1 file changed

+7
-0
lines changed

docs/lib/content/commands/npm-audit.md

+7
Original file line numberDiff line numberDiff line change
@@ -47,6 +47,13 @@ Registry signatures can be verified using the following `audit` command:
4747
$ npm audit signatures
4848
```
4949

50+
The `audit signatures` command will also verify the provenance attestations of
51+
downloaded packages. Because provenance attestations are such a new feature,
52+
security features may be added to (or changed in) the attestation format over
53+
time. To ensure that you're always able to verify attestation signatures check
54+
that you're running the latest version of the npm CLI. Please note this often
55+
means updating npm beyond the version that ships with Node.js.
56+
5057
The npm CLI supports registry signatures and signing keys provided by any registry if the following conventions are followed:
5158

5259
1. Signatures are provided in the package's `packument` in each published version within the `dist` object:

0 commit comments

Comments
 (0)