Skip to content

Commit bdfd15d

Browse files
committed
docs: document cve_source and OpenJS CNA configuration
1 parent c2bc03f commit bdfd15d

1 file changed

Lines changed: 31 additions & 0 deletions

File tree

‎docs/git-node.md‎

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -503,6 +503,37 @@ $ ncu-config --global set h1_username $H1_TOKEN
503503
access.
504504
- `h1_username`: HackerOne API Token username.
505505

506+
#### Optional: reserve CVEs through the OpenJS Foundation CNA
507+
508+
By default `--request-cve` reserves CVE ids through HackerOne, which acts as
509+
the Node.js CNA. Set `cve_source` to `openjs-cna` to reserve them through the
510+
OpenJS Foundation CNA instead. HackerOne is still used for the bug-bounty
511+
workflow (triage, `--sync`, disclosure) and is updated with the resulting CVE
512+
id, so reports stay in sync.
513+
514+
```console
515+
$ ncu-config --global set cve_source openjs-cna
516+
$ ncu-config --global set -x openjs_cna_token
517+
$ ncu-config --global set openjs_cna_worker_url https://<deployment>.workers.dev
518+
```
519+
520+
- `cve_source`: `hackerone` (default) or `openjs-cna`.
521+
- `openjs_cna_token`: **secret**, store it encrypted with `-x`. The bucket
522+
token issued by the OpenJS CNA coordinators, in `<bucket>:<secret>` form
523+
(for example `prod_nodejs:<256 hex chars>`).
524+
- `openjs_cna_worker_url`: the OpenJS CNA API base URL.
525+
- `openjs_cna_timeout`: optional, seconds to wait for a reservation before
526+
pausing (default `600`).
527+
528+
Reservations are asynchronous. The command saves the correlation id of each
529+
dispatched reservation to `vulnerabilities.json` (`pendingCve`) before
530+
waiting, so an interrupted or timed-out run never loses a reserved id. On a
531+
supervised bucket the reservation waits for an OpenJS CNA coordinator to
532+
approve it, which can exceed the timeout: re-run
533+
`git node security --request-cve` to resume the pending reservations.
534+
535+
To revert to HackerOne, delete `cve_source` or set it back to `hackerone`.
536+
506537
### `git node security --start`
507538

508539
This command prepares `vulnerabilities.json` and can open the Next Security

0 commit comments

Comments
 (0)