npq 2.4.2 → 2.5.1

package/README.md

@@ -100,6 +100,7 @@ Note: `npq` by default will offload all commands and their arguments to the `npm
 | license | Will show a warning if a package has been found without a license field | Checks the latest version for a license
 | expired domains | Will show a warning if a package has been found with one of its maintainers having an email address that includes an expired domain | Checks a dependency version for a maintainer with an expired domain
 | signatures | Will compare the package's signature as it shows on the registry's pakument with the keys published on the npmjs.com registry 
+| provenance | Will verify the package's attestations of provenance metadata for the published package
 
 ### Disabling Marshalls
 

package/lib/marshalls/provenance.marshall.js

@@ -0,0 +1,78 @@
+'use strict'
+
+const BaseMarshall = require('./baseMarshall')
+const pacote = require('pacote')
+
+const MARSHALL_NAME = 'provenance'
+
+class Marshall extends BaseMarshall {
+  constructor (options) {
+    super(options)
+    this.name = MARSHALL_NAME
+  }
+
+  title () {
+    return 'Verifying package provenance'
+  }
+
+  validate (pkg) {
+    const validationMetadata = {}
+
+    return this.packageRepoUtils
+      .getPackageInfo(pkg.packageName)
+      .then((packageInfo) => {
+        const packageName = packageInfo.name
+        const packageVersion =
+          pkg.packageVersion === 'latest'
+            ? packageInfo['dist-tags'] && packageInfo['dist-tags']['latest']
+            : this.packageRepoUtils.parsePackageVersion(pkg.packageVersion).version
+
+        validationMetadata.name = packageName
+        validationMetadata.version = packageVersion
+      })
+      .then(() => {
+        return this.fetchRegistryKeys()
+      })
+      .then((keys) => {
+        // @TODO currently we're hardcoding the official npm registry
+        // this should however allow for local proxies and other registries
+        return pacote.manifest(`${validationMetadata.name}@${validationMetadata.version}`, {
+          verifyAttestations: true,
+          registry: 'https://registry.npmjs.org',
+
+          [`//registry.npmjs.org/:_keys`]: keys
+        })
+      })
+      .then((metadata) => {
+        return metadata
+      })
+  }
+
+  fetchRegistryKeys () {
+    const registryHost = 'https://registry.npmjs.org'
+    const registryKeysEndpoint = '/-/npm/v1/keys'
+
+    const registryKeysUrl = `${registryHost}${registryKeysEndpoint}`
+    // eslint-disable-next-line no-undef
+    return fetch(registryKeysUrl)
+      .then((response) => {
+        return response.json()
+      })
+      .then((response) => {
+        const registryKeys = response.keys
+
+        return registryKeys.map((key) => ({
+          ...key,
+          pemkey: `-----BEGIN PUBLIC KEY-----\n${key.key}\n-----END PUBLIC KEY-----`
+        }))
+      })
+      .then((keys) => {
+        return keys
+      })
+      .catch((error) => {
+        throw new Error(`error fetching registry keys: ${error.message}`)
+      })
+  }
+}
+
+module.exports = Marshall

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "npq",
-  "version": "2.4.2",
+  "version": "2.5.1",
   "description": "marshall your npm/npm package installs with high quality and class 🎖",
   "bin": {
     "npq": "./bin/npq.js",