@cryptotaxi247 / documentation
Code Commits Issues Pulls Sessions CI/CD
kartykp/gat-bypass-2fa-docs
@reggi/path-to-regexp dependabot/npm_and_yarn/main/copy-to-clipboard-4.0.2 dependabot/npm_and_yarn/main/eslint-10.4.0 dependabot/npm_and_yarn/main/npmcli/eslint-config-7.0.0 dependabot/npm_and_yarn/main/proc-log-7.0.0 dependabot/npm_and_yarn/npm_and_yarn-826852524d dependabot/npm_and_yarn/npm_and_yarn-ab9a7f4bc2 deprecate-totp-2fa dhei/classic-tokens gat-bypass-2fa-docs jpg619/fix-accessibility-content-flow jpg619/version-bump-tar-2 kartykp/gat-bypass-2fa-docs kartykp/upgrade-path-to-regex main maitxn/version-bump-tar patch-1 reggi/cache-based-on-version reggi/dev-engines reggi/fix-transform-prettier reggi/overrides update-search-sensitivity
mdx 350 lines 14.9 KB
Raw
1 ---
2 title: npm-audit
3 section: 1
4 description: Run a security audit
5 github_repo: npm/cli
6 github_branch: release/v9
7 github_path: docs/lib/content/commands/npm-audit.md
8 redirect_from:
9 - /cli-documentation/v9/audit
10 - /cli-documentation/v9/cli-commands/audit
11 - /cli-documentation/v9/cli-commands/npm-audit
12 - /cli-documentation/v9/commands/audit
13 - /cli-documentation/v9/commands/npm-audit
14 - /cli-documentation/v9/npm-audit
15 - /cli/v9/audit
16 - /cli/v9/cli-commands/audit
17 - /cli/v9/cli-commands/npm-audit
18 - /cli/v9/commands/audit
19 - /cli/v9/npm-audit
20 ---
21
22 ### Synopsis
23
24 ```bash
25 npm audit [fix|signatures]
26 ```
27
28 ### Description
29
30 The audit command submits a description of the dependencies configured in your project to your default registry and asks for a report of known vulnerabilities. If any vulnerabilities are found, then the impact and appropriate remediation will be calculated. If the `fix` argument is provided, then remediations will be applied to the package tree.
31
32 The command will exit with a 0 exit code if no vulnerabilities were found.
33
34 Note that some vulnerabilities cannot be fixed automatically and will require manual intervention or review. Also note that since `npm audit fix` runs a full-fledged `npm install` under the hood, all configs that apply to the installer will also apply to `npm install` -- so things like `npm audit fix --package-lock-only` will work as expected.
35
36 By default, the audit command will exit with a non-zero code if any vulnerability is found. It may be useful in CI environments to include the `--audit-level` parameter to specify the minimum vulnerability level that will cause the command to fail. This option does not filter the report output, it simply changes the command's failure threshold.
37
38 ### Package lock
39
40 By default npm requires a package-lock or shrinkwrap in order to run the audit. You can bypass the package lock with `--no-package-lock` but be aware the results may be different with every run, since npm will re-build the dependency tree each time.
41
42 ### Audit Signatures
43
44 To ensure the integrity of packages you download from the public npm registry, or any registry that supports signatures, you can verify the registry signatures of downloaded packages using the npm CLI.
45
46 Registry signatures can be verified using the following `audit` command:
47
48 ```bash
49 $ npm audit signatures
50 ```
51
52 The npm CLI supports registry signatures and signing keys provided by any registry if the following conventions are followed:
53
54 1. Signatures are provided in the package's `packument` in each published version within the `dist` object:
55
56 ```json
57 "dist":{
58 "..omitted..": "..omitted..",
59 "signatures": [{
60 "keyid": "SHA256:{{SHA256_PUBLIC_KEY}}",
61 "sig": "a312b9c3cb4a1b693e8ebac5ee1ca9cc01f2661c14391917dcb111517f72370809..."
62 }]
63 }
64 ```
65
66 See this [example](https://registry.npmjs.org/light-cycle/1.4.3) of a signed package from the public npm registry.
67
68 The `sig` is generated using the following template: `${package.name}@${package.version}:${package.dist.integrity}` and the `keyid` has to match one of the public signing keys below.
69
70 2. Public signing keys are provided at `registry-host.tld/-/npm/v1/keys` in the following format:
71
72 ```
73 {
74 "keys": [{
75 "expires": null,
76 "keyid": "SHA256:{{SHA256_PUBLIC_KEY}}",
77 "keytype": "ecdsa-sha2-nistp256",
78 "scheme": "ecdsa-sha2-nistp256",
79 "key": "{{B64_PUBLIC_KEY}}"
80 }]
81 }
82 ```
83
84 Keys response:
85
86 - `expires`: null or a simplified extended [ISO 8601 format](https://en.wikipedia.org/wiki/ISO_8601"): `YYYY-MM-DDTHH:mm:ss.sssZ`
87 - `keydid`: sha256 fingerprint of the public key
88 - `keytype`: only `ecdsa-sha2-nistp256` is currently supported by the npm CLI
89 - `scheme`: only `ecdsa-sha2-nistp256` is currently supported by the npm CLI
90 - `key`: base64 encoded public key
91
92 See this [example key's response from the public npm registry](https://registry.npmjs.org/-/npm/v1/keys").
93
94 ### Audit Endpoints
95
96 There are two audit endpoints that npm may use to fetch vulnerability information: the `Bulk Advisory` endpoint and the `Quick Audit` endpoint.
97
98 #### Bulk Advisory Endpoint
99
100 As of version 7, npm uses the much faster `Bulk Advisory` endpoint to optimize the speed of calculating audit results.
101
102 npm will generate a JSON payload with the name and list of versions of each package in the tree, and POST it to the default configured registry at the path `/-/npm/v1/security/advisories/bulk`.
103
104 Any packages in the tree that do not have a `version` field in their package.json file will be ignored. If any `--omit` options are specified (either via the [`--omit` config](/cli/v9/using-npm/config#omit), or one of the shorthands such as `--production`, `--only=dev`, and so on), then packages will be omitted from the submitted payload as appropriate.
105
106 If the registry responds with an error, or with an invalid response, then npm will attempt to load advisory data from the `Quick Audit` endpoint.
107
108 The expected result will contain a set of advisory objects for each dependency that matches the advisory range. Each advisory object contains a `name`, `url`, `id`, `severity`, `vulnerable_versions`, and `title`.
109
110 npm then uses these advisory objects to calculate vulnerabilities and meta-vulnerabilities of the dependencies within the tree.
111
112 #### Quick Audit Endpoint
113
114 If the `Bulk Advisory` endpoint returns an error, or invalid data, npm will attempt to load advisory data from the `Quick Audit` endpoint, which is considerably slower in most cases.
115
116 The full package tree as found in `package-lock.json` is submitted, along with the following pieces of additional metadata:
117
118 - `npm_version`
119 - `node_version`
120 - `platform`
121 - `arch`
122 - `node_env`
123
124 All packages in the tree are submitted to the Quick Audit endpoint. Omitted dependency types are skipped when generating the report.
125
126 #### Scrubbing
127
128 Out of an abundance of caution, npm versions 5 and 6 would "scrub" any packages from the submitted report if their name contained a `/` character, so as to avoid leaking the names of potentially private packages or git URLs.
129
130 However, in practice, this resulted in audits often failing to properly detect meta-vulnerabilities, because the tree would appear to be invalid due to missing dependencies, and prevented the detection of vulnerabilities in package trees that used git dependencies or private modules.
131
132 This scrubbing has been removed from npm as of version 7.
133
134 #### Calculating Meta-Vulnerabilities and Remediations
135
136 npm uses the [`@npmcli/metavuln-calculator`](http://npm.im/@npmcli/metavuln-calculator) module to turn a set of security advisories into a set of "vulnerability" objects. A "meta-vulnerability" is a dependency that is vulnerable by virtue of dependence on vulnerable versions of a vulnerable package.
137
138 For example, if the package `foo` is vulnerable in the range `>=1.0.2 <2.0.0`, and the package `bar` depends on `foo@^1.1.0`, then that version of `bar` can only be installed by installing a vulnerable version of `foo`. In this case, `bar` is a "metavulnerability".
139
140 Once metavulnerabilities for a given package are calculated, they are cached in the `~/.npm` folder and only re-evaluated if the advisory range changes, or a new version of the package is published (in which case, the new version is checked for metavulnerable status as well).
141
142 If the chain of metavulnerabilities extends all the way to the root project, and it cannot be updated without changing its dependency ranges, then `npm audit fix` will require the `--force` option to apply the remediation. If remediations do not require changes to the dependency ranges, then all vulnerable packages will be updated to a version that does not have an advisory or metavulnerability posted against it.
143
144 ### Exit Code
145
146 The `npm audit` command will exit with a 0 exit code if no vulnerabilities were found. The `npm audit fix` command will exit with 0 exit code if no vulnerabilities are found _or_ if the remediation is able to successfully fix all vulnerabilities.
147
148 If vulnerabilities were found the exit code will depend on the [`audit-level` config](/cli/v9/using-npm/config#audit-level).
149
150 ### Examples
151
152 Scan your project for vulnerabilities and automatically install any compatible updates to vulnerable dependencies:
153
154 ```bash
155 $ npm audit fix
156 ```
157
158 Run `audit fix` without modifying `node_modules`, but still updating the pkglock:
159
160 ```bash
161 $ npm audit fix --package-lock-only
162 ```
163
164 Skip updating `devDependencies`:
165
166 ```bash
167 $ npm audit fix --only=prod
168 ```
169
170 Have `audit fix` install SemVer-major updates to toplevel dependencies, not just SemVer-compatible ones:
171
172 ```bash
173 $ npm audit fix --force
174 ```
175
176 Do a dry run to get an idea of what `audit fix` will do, and _also_ output install information in JSON format:
177
178 ```bash
179 $ npm audit fix --dry-run --json
180 ```
181
182 Scan your project for vulnerabilities and just show the details, without fixing anything:
183
184 ```bash
185 $ npm audit
186 ```
187
188 Get the detailed audit report in JSON format:
189
190 ```bash
191 $ npm audit --json
192 ```
193
194 Fail an audit only if the results include a vulnerability with a level of moderate or higher:
195
196 ```bash
197 $ npm audit --audit-level=moderate
198 ```
199
200 ### Configuration
201
202 #### `audit-level`
203
204 - Default: null
205 - Type: null, "info", "low", "moderate", "high", "critical", or "none"
206
207 The minimum level of vulnerability for `npm audit` to exit with a non-zero exit code.
208
209 #### `dry-run`
210
211 - Default: false
212 - Type: Boolean
213
214 Indicates that you don't want npm to make any changes and that it should only report what it would have done. This can be passed into any of the commands that modify your local installation, eg, `install`, `update`, `dedupe`, `uninstall`, as well as `pack` and `publish`.
215
216 Note: This is NOT honored by other network related commands, eg `dist-tags`, `owner`, etc.
217
218 #### `force`
219
220 - Default: false
221 - Type: Boolean
222
223 Removes various protections against unfortunate side effects, common mistakes, unnecessary performance degradation, and malicious input.
224
225 - Allow clobbering non-npm files in global installs.
226 - Allow the `npm version` command to work on an unclean git repository.
227 - Allow deleting the cache folder with `npm cache clean`.
228 - Allow installing packages that have an `engines` declaration requiring a different version of npm.
229 - Allow installing packages that have an `engines` declaration requiring a different version of `node`, even if `--engine-strict` is enabled.
230 - Allow `npm audit fix` to install modules outside your stated dependency range (including SemVer-major changes).
231 - Allow unpublishing all versions of a published package.
232 - Allow conflicting peerDependencies to be installed in the root project.
233 - Implicitly set `--yes` during `npm init`.
234 - Allow clobbering existing values in `npm pkg`
235 - Allow unpublishing of entire packages (not just a single version).
236
237 If you don't have a clear idea of what you want to do, it is strongly recommended that you do not use this option!
238
239 #### `json`
240
241 - Default: false
242 - Type: Boolean
243
244 Whether or not to output JSON data, rather than the normal output.
245
246 - In `npm pkg set` it enables parsing set values with JSON.parse() before saving them to your `package.json`.
247
248 Not supported by all npm commands.
249
250 #### `package-lock-only`
251
252 - Default: false
253 - Type: Boolean
254
255 If set to true, the current operation will only use the `package-lock.json`, ignoring `node_modules`.
256
257 For `update` this means only the `package-lock.json` will be updated, instead of checking `node_modules` and downloading dependencies.
258
259 For `list` this means the output will be based on the tree described by the `package-lock.json`, rather than the contents of `node_modules`.
260
261 #### `package-lock`
262
263 - Default: true
264 - Type: Boolean
265
266 If set to false, then ignore `package-lock.json` files when installing. This will also prevent _writing_ `package-lock.json` if `save` is true.
267
268 #### `omit`
269
270 - Default: 'dev' if the `NODE_ENV` environment variable is set to 'production', otherwise empty.
271 - Type: "dev", "optional", or "peer" (can be set multiple times)
272
273 Dependency types to omit from the installation tree on disk.
274
275 Note that these dependencies _are_ still resolved and added to the `package-lock.json` or `npm-shrinkwrap.json` file. They are just not physically installed on disk.
276
277 If a package type appears in both the `--include` and `--omit` lists, then it will be included.
278
279 If the resulting omit list includes `'dev'`, then the `NODE_ENV` environment variable will be set to `'production'` for all lifecycle scripts.
280
281 #### `foreground-scripts`
282
283 - Default: false
284 - Type: Boolean
285
286 Run all build scripts (ie, `preinstall`, `install`, and `postinstall`) scripts for installed packages in the foreground process, sharing standard input, output, and error with the main npm process.
287
288 Note that this will generally make installs run slower, and be much noisier, but can be useful for debugging.
289
290 #### `ignore-scripts`
291
292 - Default: false
293 - Type: Boolean
294
295 If true, npm does not run scripts specified in package.json files.
296
297 Note that commands explicitly intended to run a particular script, such as `npm start`, `npm stop`, `npm restart`, `npm test`, and `npm run-script` will still run their intended script if `ignore-scripts` is set, but they will _not_ run any pre- or post-scripts.
298
299 #### `workspace`
300
301 - Default:
302 - Type: String (can be set multiple times)
303
304 Enable running a command in the context of the configured workspaces of the current project while filtering by running only the workspaces defined by this configuration option.
305
306 Valid values for the `workspace` config are either:
307
308 - Workspace names
309 - Path to a workspace directory
310 - Path to a parent workspace directory (will result in selecting all workspaces within that folder)
311
312 When set for the `npm init` command, this may be set to the folder of a workspace which does not yet exist, to create the folder and set it up as a brand new workspace within the project.
313
314 This value is not exported to the environment for child processes.
315
316 #### `workspaces`
317
318 - Default: null
319 - Type: null or Boolean
320
321 Set to true to run the command in the context of **all** configured workspaces.
322
323 Explicitly setting this to false will cause commands like `install` to ignore workspaces altogether. When not set explicitly:
324
325 - Commands that operate on the `node_modules` tree (install, update, etc.) will link workspaces into the `node_modules` folder. - Commands that do other things (test, exec, publish, etc.) will operate on the root project, _unless_ one or more workspaces are specified in the `workspace` config.
326
327 This value is not exported to the environment for child processes.
328
329 #### `include-workspace-root`
330
331 - Default: false
332 - Type: Boolean
333
334 Include the workspace root when workspaces are enabled for a command.
335
336 When false, specifying individual workspaces via the `workspace` config, or all workspaces via the `workspaces` flag, will cause npm to operate only on the specified workspaces, and not on the root project.
337
338 This value is not exported to the environment for child processes.
339
340 #### `install-links`
341
342 - Default: false
343 - Type: Boolean
344
345 When set file: protocol dependencies will be packed and installed as regular dependencies instead of creating a symlink. This option has no effect on workspaces.
346
347 ### See Also
348
349 - [npm install](/cli/v9/commands/npm-install)
350 - [config](/cli/v9/using-npm/config)