fix: retrieve registry keys via TUF (#6418)

bdehamer · web-flow · commit 37cc79734110 · 2023-05-18T12:20:38.000-07:00
diff --git a/DEPENDENCIES.md b/DEPENDENCIES.md
@@ -569,13 +569,15 @@ graph LR;
   npm-->remark-github;
   npm-->remark;
   npm-->semver;
+  npm-->sigstore;
   npm-->spawk;
   npm-->ssri;
   npm-->tap;
   npm-->tar;
   npm-->text-table;
   npm-->tiny-relative-date;
   npm-->treeverse;
+  npm-->tufjs-repo-mock["@tufjs/repo-mock"];
   npm-->validate-npm-package-name;
   npm-->which;
   npm-->write-file-atomic;
diff --git a/lib/commands/audit.js b/lib/commands/audit.js
@@ -4,6 +4,7 @@ const localeCompare = require('@isaacs/string-locale-compare')('en')
 const npa = require('npm-package-arg')
 const pacote = require('pacote')
 const pMap = require('p-map')
+const { sigstore } = require('sigstore')
 
 const ArboristWorkspaceCmd = require('../arborist-cmd.js')
 const auditError = require('../utils/audit-error.js')
@@ -37,7 +38,12 @@ class VerifySignatures {
       throw new Error('found no installed dependencies to audit')
     }
 
-    await Promise.all([...registries].map(registry => this.setKeys({ registry })))
+    const tuf = await sigstore.tuf.client({
+      tufCachePath: this.opts.tufCache,
+      retry: this.opts.retry,
+      timeout: this.opts.timeout,
+    })
+    await Promise.all([...registries].map(registry => this.setKeys({ registry, tuf })))
 
     const progress = log.newItem('verifying registry signatures', edges.size)
     const mapper = async (edge) => {
@@ -187,20 +193,42 @@ class VerifySignatures {
     return { edges, registries }
   }
 
-  async setKeys ({ registry }) {
-    const keys = await fetch.json('/-/npm/v1/keys', {
-      ...this.npm.flatOptions,
-      registry,
-    }).then(({ keys: ks }) => ks.map((key) => ({
-      ...key,
-      pemkey: `-----BEGIN PUBLIC KEY-----\n${key.key}\n-----END PUBLIC KEY-----`,
-    }))).catch(err => {
-      if (err.code === 'E404' || err.code === 'E400') {
-        return null
-      } else {
-        throw err
-      }
-    })
+  async setKeys ({ registry, tuf }) {
+    const { host, pathname } = new URL(registry)
+    // Strip any trailing slashes from pathname
+    const regKey = `${host}${pathname.replace(/\/$/, '')}/keys.json`
+    let keys = await tuf.getTarget(regKey)
+      .then((target) => JSON.parse(target))
+      .then(({ keys: ks }) => ks.map((key) => ({
+        ...key,
+        keyid: key.keyId,
+        pemkey: `-----BEGIN PUBLIC KEY-----\n${key.publicKey.rawBytes}\n-----END PUBLIC KEY-----`,
+        expires: key.publicKey.validFor.end || null,
+      }))).catch(err => {
+        if (err.code === 'TUF_FIND_TARGET_ERROR') {
+          return null
+        } else {
+          throw err
+        }
+      })
+
+    // If keys not found in Sigstore TUF repo, fallback to registry keys API
+    if (!keys) {
+      keys = await fetch.json('/-/npm/v1/keys', {
+        ...this.npm.flatOptions,
+        registry,
+      }).then(({ keys: ks }) => ks.map((key) => ({
+        ...key,
+        pemkey: `-----BEGIN PUBLIC KEY-----\n${key.key}\n-----END PUBLIC KEY-----`,
+      }))).catch(err => {
+        if (err.code === 'E404' || err.code === 'E400') {
+          return null
+        } else {
+          throw err
+        }
+      })
+    }
+
     if (keys) {
       this.keys.set(registry, keys)
     }
diff --git a/lib/utils/config/definitions.js b/lib/utils/config/definitions.js
@@ -331,6 +331,7 @@ define('cache', {
   flatten (key, obj, flatOptions) {
     flatOptions.cache = join(obj.cache, '_cacache')
     flatOptions.npxCache = join(obj.cache, '_npx')
+    flatOptions.tufCache = join(obj.cache, '_tuf')
   },
 })
 
diff --git a/package-lock.json b/package-lock.json
@@ -66,6 +66,7 @@
         "read-package-json",
         "read-package-json-fast",
         "semver",
+        "sigstore",
         "ssri",
         "tar",
         "text-table",
@@ -141,6 +142,7 @@
         "read-package-json": "^6.0.3",
         "read-package-json-fast": "^3.0.2",
         "semver": "^7.5.1",
+        "sigstore": "^1.5.0",
         "ssri": "^10.0.4",
         "tar": "^6.1.14",
         "text-table": "~0.2.0",
@@ -162,6 +164,7 @@
         "@npmcli/mock-registry": "^1.0.0",
         "@npmcli/promise-spawn": "^6.0.2",
         "@npmcli/template-oss": "4.14.1",
+        "@tufjs/repo-mock": "^1.3.1",
         "licensee": "^10.0.0",
         "nock": "^13.3.0",
         "npm-packlist": "^7.0.4",
@@ -2642,6 +2645,19 @@
         "node": "^14.17.0 || ^16.13.0 || >=18.0.0"
       }
     },
+    "node_modules/@tufjs/repo-mock": {
+      "version": "1.3.1",
+      "resolved": "https://registry.npmjs.org/@tufjs/repo-mock/-/repo-mock-1.3.1.tgz",
+      "integrity": "sha512-7IDezQbPGReWD3xmgR2pAfG61BZpvW51XnB87OfuiJOe5mkGnziCTTGITtUC3A6htQr9shkk5qIKrhpoMXBwpQ==",
+      "dev": true,
+      "dependencies": {
+        "@tufjs/models": "1.0.4",
+        "nock": "^13.3.1"
+      },
+      "engines": {
+        "node": "^14.17.0 || ^16.13.0 || >=18.0.0"
+      }
+    },
     "node_modules/@types/debug": {
       "version": "4.1.7",
       "resolved": "https://registry.npmjs.org/@types/debug/-/debug-4.1.7.tgz",
diff --git a/package.json b/package.json
@@ -110,6 +110,7 @@
     "read-package-json": "^6.0.3",
     "read-package-json-fast": "^3.0.2",
     "semver": "^7.5.1",
+    "sigstore": "^1.5.0",
     "ssri": "^10.0.4",
     "tar": "^6.1.14",
     "text-table": "~0.2.0",
@@ -178,6 +179,7 @@
     "read-package-json",
     "read-package-json-fast",
     "semver",
+    "sigstore",
     "ssri",
     "tar",
     "text-table",
@@ -195,6 +197,7 @@
     "@npmcli/mock-registry": "^1.0.0",
     "@npmcli/promise-spawn": "^6.0.2",
     "@npmcli/template-oss": "4.14.1",
+    "@tufjs/repo-mock": "^1.3.1",
     "licensee": "^10.0.0",
     "nock": "^13.3.0",
     "npm-packlist": "^7.0.4",
diff --git a/tap-snapshots/test/lib/commands/audit.js.test.cjs b/tap-snapshots/test/lib/commands/audit.js.test.cjs
@@ -175,6 +175,20 @@ audited 1 package in xxx
 
 `
 
+exports[`test/lib/commands/audit.js TAP audit signatures third-party registry with sub-path (trailing slash) > must match snapshot 1`] = `
+audited 1 package in xxx
+
+1 package has a verified registry signature
+
+`
+
+exports[`test/lib/commands/audit.js TAP audit signatures third-party registry with sub-path > must match snapshot 1`] = `
+audited 1 package in xxx
+
+1 package has a verified registry signature
+
+`
+
 exports[`test/lib/commands/audit.js TAP audit signatures with both invalid and missing signatures > must match snapshot 1`] = `
 audited 2 packages in xxx
 
@@ -230,6 +244,13 @@ Someone might have tampered with this package since it was published on the regi
 
 `
 
+exports[`test/lib/commands/audit.js TAP audit signatures with key fallback to legacy API > must match snapshot 1`] = `
+audited 1 package in xxx
+
+1 package has a verified registry signature
+
+`
+
 exports[`test/lib/commands/audit.js TAP audit signatures with keys but missing signature > must match snapshot 1`] = `
 audited 1 package in xxx
 
diff --git a/test/lib/commands/audit.js b/test/lib/commands/audit.js
