@cryptotaxi247 / documentation-1
Code Commits Issues Pulls Sessions CI/CD
dhei/classic-tokens
@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 339 lines 14.4 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/v8
7 github_path: docs/lib/content/commands/npm-audit.md
8 redirect_from:
9 - /cli-documentation/v8/audit
10 - /cli-documentation/v8/cli-commands/audit
11 - /cli-documentation/v8/cli-commands/npm-audit
12 - /cli-documentation/v8/commands/audit
13 - /cli-documentation/v8/commands/npm-audit
14 - /cli-documentation/v8/npm-audit
15 - /cli/v8/audit
16 - /cli/v8/cli-commands/audit
17 - /cli/v8/cli-commands/npm-audit
18 - /cli/v8/commands/audit
19 - /cli/v8/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 ### Audit Signatures
39
40 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.
41
42 Registry signatures can be verified using the following `audit` command:
43
44 ```bash
45 $ npm audit signatures
46 ```
47
48 The npm CLI supports registry signatures and signing keys provided by any registry if the following conventions are followed:
49
50 1. Signatures are provided in the package's `packument` in each published version within the `dist` object:
51
52 ```json
53 "dist":{
54 "..omitted..": "..omitted..",
55 "signatures": [{
56 "keyid": "SHA256:{{SHA256_PUBLIC_KEY}}",
57 "sig": "a312b9c3cb4a1b693e8ebac5ee1ca9cc01f2661c14391917dcb111517f72370809..."
58 }]
59 }
60 ```
61
62 See this [example](https://registry.npmjs.org/light-cycle/1.4.3) of a signed package from the public npm registry.
63
64 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.
65
66 2. Public signing keys are provided at `registry-host.tld/-/npm/v1/keys` in the following format:
67
68 ```
69 {
70 "keys": [{
71 "expires": null,
72 "keyid": "SHA256:{{SHA256_PUBLIC_KEY}}",
73 "keytype": "ecdsa-sha2-nistp256",
74 "scheme": "ecdsa-sha2-nistp256",
75 "key": "{{B64_PUBLIC_KEY}}"
76 }]
77 }
78 ```
79
80 Keys response:
81
82 - `expires`: null or a simplified extended [https://en.wikipedia.org/wiki/ISO_8601](ISO 8601 format): `YYYY-MM-DDTHH:mm:ss.sssZ`
83 - `keydid`: sha256 fingerprint of the public key
84 - `keytype`: only `ecdsa-sha2-nistp256` is currently supported by the npm CLI
85 - `scheme`: only `ecdsa-sha2-nistp256` is currently supported by the npm CLI
86 - `key`: base64 encoded public key
87
88 See this [https://registry.npmjs.org/-/npm/v1/keys](example key's response from the public npm registry).
89
90 ### Audit Endpoints
91
92 There are two audit endpoints that npm may use to fetch vulnerability information: the `Bulk Advisory` endpoint and the `Quick Audit` endpoint.
93
94 #### Bulk Advisory Endpoint
95
96 As of version 7, npm uses the much faster `Bulk Advisory` endpoint to optimize the speed of calculating audit results.
97
98 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`.
99
100 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, or one of the shorthands such as `--production`, `--only=dev`, and so on), then packages will be omitted from the submitted payload as appropriate.
101
102 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.
103
104 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`.
105
106 npm then uses these advisory objects to calculate vulnerabilities and meta-vulnerabilities of the dependencies within the tree.
107
108 #### Quick Audit Endpoint
109
110 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.
111
112 The full package tree as found in `package-lock.json` is submitted, along with the following pieces of additional metadata:
113
114 - `npm_version`
115 - `node_version`
116 - `platform`
117 - `arch`
118 - `node_env`
119
120 All packages in the tree are submitted to the Quick Audit endpoint. Omitted dependency types are skipped when generating the report.
121
122 #### Scrubbing
123
124 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.
125
126 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.
127
128 This scrubbing has been removed from npm as of version 7.
129
130 #### Calculating Meta-Vulnerabilities and Remediations
131
132 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.
133
134 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".
135
136 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).
137
138 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.
139
140 ### Exit Code
141
142 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.
143
144 If vulnerabilities were found the exit code will depend on the `audit-level` configuration setting.
145
146 ### Examples
147
148 Scan your project for vulnerabilities and automatically install any compatible updates to vulnerable dependencies:
149
150 ```bash
151 $ npm audit fix
152 ```
153
154 Run `audit fix` without modifying `node_modules`, but still updating the pkglock:
155
156 ```bash
157 $ npm audit fix --package-lock-only
158 ```
159
160 Skip updating `devDependencies`:
161
162 ```bash
163 $ npm audit fix --only=prod
164 ```
165
166 Have `audit fix` install SemVer-major updates to toplevel dependencies, not just SemVer-compatible ones:
167
168 ```bash
169 $ npm audit fix --force
170 ```
171
172 Do a dry run to get an idea of what `audit fix` will do, and _also_ output install information in JSON format:
173
174 ```bash
175 $ npm audit fix --dry-run --json
176 ```
177
178 Scan your project for vulnerabilities and just show the details, without fixing anything:
179
180 ```bash
181 $ npm audit
182 ```
183
184 Get the detailed audit report in JSON format:
185
186 ```bash
187 $ npm audit --json
188 ```
189
190 Fail an audit only if the results include a vulnerability with a level of moderate or higher:
191
192 ```bash
193 $ npm audit --audit-level=moderate
194 ```
195
196 ### Configuration
197
198 #### `audit-level`
199
200 - Default: null
201 - Type: null, "info", "low", "moderate", "high", "critical", or "none"
202
203 The minimum level of vulnerability for `npm audit` to exit with a non-zero exit code.
204
205 #### `dry-run`
206
207 - Default: false
208 - Type: Boolean
209
210 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`.
211
212 Note: This is NOT honored by other network related commands, eg `dist-tags`, `owner`, etc.
213
214 #### `force`
215
216 - Default: false
217 - Type: Boolean
218
219 Removes various protections against unfortunate side effects, common mistakes, unnecessary performance degradation, and malicious input.
220
221 - Allow clobbering non-npm files in global installs.
222 - Allow the `npm version` command to work on an unclean git repository.
223 - Allow deleting the cache folder with `npm cache clean`.
224 - Allow installing packages that have an `engines` declaration requiring a different version of npm.
225 - Allow installing packages that have an `engines` declaration requiring a different version of `node`, even if `--engine-strict` is enabled.
226 - Allow `npm audit fix` to install modules outside your stated dependency range (including SemVer-major changes).
227 - Allow unpublishing all versions of a published package.
228 - Allow conflicting peerDependencies to be installed in the root project.
229 - Implicitly set `--yes` during `npm init`.
230 - Allow clobbering existing values in `npm pkg`
231 - Allow unpublishing of entire packages (not just a single version).
232
233 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!
234
235 #### `json`
236
237 - Default: false
238 - Type: Boolean
239
240 Whether or not to output JSON data, rather than the normal output.
241
242 - In `npm pkg set` it enables parsing set values with JSON.parse() before saving them to your `package.json`.
243
244 Not supported by all npm commands.
245
246 #### `package-lock-only`
247
248 - Default: false
249 - Type: Boolean
250
251 If set to true, the current operation will only use the `package-lock.json`, ignoring `node_modules`.
252
253 For `update` this means only the `package-lock.json` will be updated, instead of checking `node_modules` and downloading dependencies.
254
255 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`.
256
257 #### `omit`
258
259 - Default: 'dev' if the `NODE_ENV` environment variable is set to 'production', otherwise empty.
260 - Type: "dev", "optional", or "peer" (can be set multiple times)
261
262 Dependency types to omit from the installation tree on disk.
263
264 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.
265
266 If a package type appears in both the `--include` and `--omit` lists, then it will be included.
267
268 If the resulting omit list includes `'dev'`, then the `NODE_ENV` environment variable will be set to `'production'` for all lifecycle scripts.
269
270 #### `foreground-scripts`
271
272 - Default: false
273 - Type: Boolean
274
275 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.
276
277 Note that this will generally make installs run slower, and be much noisier, but can be useful for debugging.
278
279 #### `ignore-scripts`
280
281 - Default: false
282 - Type: Boolean
283
284 If true, npm does not run scripts specified in package.json files.
285
286 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.
287
288 #### `workspace`
289
290 - Default:
291 - Type: String (can be set multiple times)
292
293 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.
294
295 Valid values for the `workspace` config are either:
296
297 - Workspace names
298 - Path to a workspace directory
299 - Path to a parent workspace directory (will result in selecting all workspaces within that folder)
300
301 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.
302
303 This value is not exported to the environment for child processes.
304
305 #### `workspaces`
306
307 - Default: null
308 - Type: null or Boolean
309
310 Set to true to run the command in the context of **all** configured workspaces.
311
312 Explicitly setting this to false will cause commands like `install` to ignore workspaces altogether. When not set explicitly:
313
314 - 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.
315
316 This value is not exported to the environment for child processes.
317
318 #### `include-workspace-root`
319
320 - Default: false
321 - Type: Boolean
322
323 Include the workspace root when workspaces are enabled for a command.
324
325 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.
326
327 This value is not exported to the environment for child processes.
328
329 #### `install-links`
330
331 - Default: false
332 - Type: Boolean
333
334 When set file: protocol dependencies that exist outside of the project root will be packed and installed as regular dependencies instead of creating a symlink. This option has no effect on workspaces.
335
336 ### See Also
337
338 - [npm install](/cli/v8/commands/npm-install)
339 - [config](/cli/v8/using-npm/config)