@pnpm/deps.compliance.sbom 1100.3.10 → 1100.4.0

package/CHANGELOG.md

@@ -1,5 +1,79 @@
 # @pnpm/deps.compliance.sbom
 
+## 1100.4.0
+
+### Minor Changes
+
+- **Security fix.** Affects projects using `namedRegistries` on pnpm 11.1.0–11.19.x. It is **semi-breaking** for those projects — see "If you use named registries" below.
+
+  The lockfile recorded no marker for which registry a package came from. Packages were keyed by `name@version` alone, and entry lookup went through `refToRelative(ref, name)`, so a dependency you declared against one registry could be satisfied by an entry that was actually resolved from another. When two registries served the same name and version, both collapsed onto a single `packages:` entry and whichever resolved first decided the tarball every consumer got.
+
+  That is a package-substitution risk: a package you expect from your private registry could be installed from a different registry that publishes the same name and version, and the lockfile recorded nothing that would let you tell.
+
+  Packages resolved from a named registry are now recorded under registry-qualified keys (`<name>@<registryName>:<version>`, e.g. `foo@work:1.0.0`), so each registry gets its own entry and the lockfile pins which one a dependency came from.
+
+  The lockfile format version is unchanged. Registry-qualified keys appear only for packages resolved from a named registry, so a project that does not use `namedRegistries` sees no difference, and older pnpm versions keep reading the file.
+
+  ### If you use named registries
+
+  Your next non-frozen install re-keys those entries, which shows up as a lockfile diff. Commit it — that diff is the fix being applied. Review it: an entry that moves to a registry you did not expect is worth investigating.
+
+  Everyone working on the project should be on this version or newer before you do. An older pnpm reads the re-keyed lockfile fine — frozen installs are unaffected — but it does not produce registry-qualified keys itself, so any install that updates the lockfile writes those entries back to the old shape, and the next install on a current pnpm re-qualifies them. The result is a lockfile that flips back and forth, and while it is in the old shape the project is exposed again. Because the lockfile format version is deliberately unchanged, pnpm cannot detect this and warn you about it.
+
+  There is no setting to keep the old behavior: the old shape is the vulnerability.
+
+  Tarball URLs that follow the standard registry layout are no longer written to the lockfile for named-registry packages; they are recomputed from the `namedRegistries` setting on demand.
+
+  To use named registries, map your aliases in `pnpm-workspace.yaml`:
+
+  ```yaml
+  namedRegistries:
+    work: https://npm.enterprise.example.com/
+  ```
+
+  ### New built-in `npmjs:` alias
+
+  `npmjs:` now resolves to `https://registry.npmjs.org/` with no configuration, alongside the existing `gh:` alias for GitHub Packages. It pins a dependency to the public registry even when `registry` points elsewhere, such as an internal proxy:
+
+  ```json
+  { "dependencies": { "left-pad": "npmjs:^1.3.0" } }
+  ```
+
+  `npm:` cannot do this — it is the alias protocol (`npm:<name>@<range>`) and resolves through whatever `registry` points at.
+
+  **If you mirror or proxy npmjs, point the alias at your mirror:**
+
+  ```yaml
+  namedRegistries:
+    npmjs: https://npm.internal.example.com/
+  ```
+
+  Built-in registry URLs are also the prefixes a lockfile's recorded tarball URL is matched against when pnpm verifies a package. Without the override, an entry whose tarball URL is on `registry.npmjs.org` is verified against the public registry rather than your mirror. This only affects lockfiles that record such URLs — a canonical URL for your configured registry is omitted from the lockfile and unaffected — and only when a tarball-URL, `minimumReleaseAge`, or `trustPolicy` check runs. Overriding the alias is the same escape hatch GHES users already have for `gh`.
+
+  Every alias the lockfile references must stay in `namedRegistries`: reading an entry whose alias is gone fails with `ERR_PNPM_MISSING_NAMED_REGISTRY` rather than silently falling back to the default registry, since that would fetch a different package. Renaming an alias re-resolves the packages that used it.
+
+  Named registry aliases that shadow a reserved dependency specifier prefix (`file`, `link`, `workspace`, `runtime`, `npm`, `jsr`, ...) are now rejected with `ERR_PNPM_RESERVED_NAMED_REGISTRY_NAME` instead of being silently shadowed by the corresponding resolver.
+
+  `pnpm licenses` and `pnpm sbom` now keep the two artifacts apart as well: license records carry the registry alias, and SBOM components carry the purl `repository_url` qualifier.
+
+### Patch Changes
+
+- Fixed the order in which pnpm matches a lockfile's recorded tarball URL against known registry URLs. Two registry URLs of equal length were previously ordered arbitrarily, so which one a tarball URL matched could differ between runs.
+
+- Updated dependencies:
+  - @pnpm/config.normalize-registries@1100.1.0
+  - @pnpm/constants@1101.0.0
+  - @pnpm/error@1100.1.1
+  - @pnpm/lockfile.detect-dep-types@1100.0.19
+  - @pnpm/lockfile.types@1100.0.19
+  - @pnpm/lockfile.utils@1101.0.0
+  - @pnpm/lockfile.walker@1100.0.19
+  - @pnpm/pkg-manifest.reader@1100.0.15
+  - @pnpm/resolving.resolver-base@1101.1.0
+  - @pnpm/store.index@1100.2.3
+  - @pnpm/store.pkg-finder@1100.0.28
+  - @pnpm/types@1101.9.0
+
 ## 1100.3.10
 
 ### Patch Changes

package/lib/collectComponents.d.ts

@@ -24,6 +24,7 @@ export interface CollectSbomComponentsOptions {
         [dependenciesField in DependenciesField]: boolean;
     };
     registries: Registries;
+    namedRegistries?: Record<string, string>;
     lockfileDir: string;
     includedImporterIds?: ProjectId[];
     lockfileOnly?: boolean;

package/lib/collectComponents.js

@@ -1,4 +1,6 @@
 import path from 'node:path';
+import { normalizeNamedRegistries } from '@pnpm/config.normalize-registries';
+import { PnpmError } from '@pnpm/error';
 import { DepType, detectDepTypes } from '@pnpm/lockfile.detect-dep-types';
 import { nameVerFromPkgSnapshot, pkgSnapshotToResolution } from '@pnpm/lockfile.utils';
 import { lockfileWalkerGroupImporterSteps, } from '@pnpm/lockfile.walker';
@@ -127,19 +129,36 @@ export async function collectSbomComponents(opts) {
 async function walkStep(step, parentPurl, depTypes, componentsMap, relationships, opts, metadataOpts) {
     await Promise.all(step.dependencies.map(async (dep) => {
         const { depPath, pkgSnapshot, next } = dep;
-        const { name, version, nonSemverVersion } = nameVerFromPkgSnapshot(depPath, pkgSnapshot);
+        const { name, version, nonSemverVersion, registryName } = nameVerFromPkgSnapshot(depPath, pkgSnapshot);
         if (!name || !version)
             return;
-        const purl = buildPurl({ name, version, nonSemverVersion: nonSemverVersion ?? undefined });
+        // Resolve the alias before the purl is built. An unknown alias would
+        // otherwise yield an unqualified purl that collides with the same
+        // package from the default registry, and the `componentsMap.has(purl)`
+        // shortcut below would drop this component before
+        // `pkgSnapshotToResolution` ever got to reject it — silently omitting an
+        // artifact from a compliance document.
+        const registryUrl = registryName == null
+            ? undefined
+            : normalizeNamedRegistries(opts.namedRegistries)[registryName];
+        if (registryName != null && registryUrl == null) {
+            throw new PnpmError('MISSING_NAMED_REGISTRY', `Cannot describe package "${depPath}": it was resolved from the named registry '${registryName}:', which is not present in the namedRegistries setting.`, { hint: `Add '${registryName}' to the namedRegistries setting in pnpm-workspace.yaml.` });
+        }
+        const purl = buildPurl({
+            name,
+            version,
+            nonSemverVersion: nonSemverVersion ?? undefined,
+            registryUrl,
+        });
         relationships.push({ from: parentPurl, to: purl });
         if (componentsMap.has(purl))
             return;
         const integrity = pkgSnapshot.resolution.integrity;
-        const resolution = pkgSnapshotToResolution(depPath, pkgSnapshot, opts.registries);
+        const resolution = pkgSnapshotToResolution(depPath, pkgSnapshot, { registries: opts.registries, namedRegistries: opts.namedRegistries });
         const tarballUrl = resolution.tarball ?? gitDownloadUrl(resolution);
         let metadata = {};
         if (metadataOpts) {
-            metadata = await getPkgMetadata(depPath, pkgSnapshot, opts.registries, metadataOpts);
+            metadata = await getPkgMetadata(depPath, pkgSnapshot, { registries: opts.registries, namedRegistries: opts.namedRegistries }, metadataOpts);
         }
         const component = {
             name,

package/lib/getPkgMetadata.d.ts

@@ -1,6 +1,6 @@
-import { type PackageSnapshot } from '@pnpm/lockfile.utils';
+import { type PackageSnapshot, type PkgSnapshotToResolutionOptions } from '@pnpm/lockfile.utils';
 import type { StoreIndex } from '@pnpm/store.index';
-import type { DepPath, Registries } from '@pnpm/types';
+import type { DepPath } from '@pnpm/types';
 export interface PkgMetadata {
     license?: string;
     description?: string;
@@ -15,5 +15,5 @@ export interface GetPkgMetadataOptions {
     lockfileDir: string;
     virtualStoreDirMaxLength: number;
 }
-export declare function getPkgMetadata(depPath: DepPath, snapshot: PackageSnapshot, registries: Registries, opts: GetPkgMetadataOptions): Promise<PkgMetadata>;
+export declare function getPkgMetadata(depPath: DepPath, snapshot: PackageSnapshot, registryOpts: PkgSnapshotToResolutionOptions, opts: GetPkgMetadataOptions): Promise<PkgMetadata>;
 export declare function bugsUrlFromField(field: unknown): string | undefined;

package/lib/getPkgMetadata.js

@@ -4,12 +4,12 @@ import { readPackageJson } from '@pnpm/pkg-manifest.reader';
 import { readPackageFileMap } from '@pnpm/store.pkg-finder';
 import pLimit from 'p-limit';
 const limitMetadataReads = pLimit(4);
-export async function getPkgMetadata(depPath, snapshot, registries, opts) {
-    return limitMetadataReads(() => getPkgMetadataUnclamped(depPath, snapshot, registries, opts));
+export async function getPkgMetadata(depPath, snapshot, registryOpts, opts) {
+    return limitMetadataReads(() => getPkgMetadataUnclamped(depPath, snapshot, registryOpts, opts));
 }
-async function getPkgMetadataUnclamped(depPath, snapshot, registries, opts) {
+async function getPkgMetadataUnclamped(depPath, snapshot, registryOpts, opts) {
     const id = packageIdFromSnapshot(depPath, snapshot);
-    const resolution = pkgSnapshotToResolution(depPath, snapshot, registries);
+    const resolution = pkgSnapshotToResolution(depPath, snapshot, registryOpts);
     let files;
     try {
         const result = await readPackageFileMap(resolution, id, opts);

package/lib/purl.d.ts

@@ -11,4 +11,11 @@ export declare function buildPurl(opts: {
     name: string;
     version: string;
     nonSemverVersion?: string;
+    /**
+     * Registry the package was resolved from, when it is not the default
+     * one. Emitted as the spec's `repository_url` qualifier, which is what
+     * keeps the same name and version served by two registries from
+     * collapsing onto one component.
+     */
+    registryUrl?: string;
 }): string;

package/lib/purl.js

@@ -18,6 +18,40 @@ export function buildPurl(opts) {
         const encodedUrl = encodeURIComponent(opts.nonSemverVersion);
         return `pkg:npm/${encodePurlName(opts.name)}@${encodeURIComponent(opts.version)}?vcs_url=${encodedUrl}`;
     }
+    if (opts.registryUrl) {
+        const repositoryUrl = sanitizeRegistryUrl(opts.registryUrl);
+        return `pkg:npm/${encodePurlName(opts.name)}@${opts.version}?repository_url=${encodeURIComponent(repositoryUrl)}`;
+    }
     return `pkg:npm/${encodePurlName(opts.name)}@${opts.version}`;
 }
+/**
+ * Reduce a registry URL to the parts that identify the registry, dropping
+ * anything that could carry a secret.
+ *
+ * An SBOM is meant to be published, and a `namedRegistries` entry may
+ * legitimately embed credentials — as userinfo
+ * (`https://user:token@npm.example.com/`) or in a query string
+ * (`?api_key=…`). Origin and path are kept because two registries can
+ * differ only by path (`https://npm.example.com/team-a/` vs `/team-b/`),
+ * so trimming to the origin would recreate the very collision this
+ * qualifier exists to prevent.
+ *
+ * A URL that doesn't parse is returned unchanged: it has no userinfo to
+ * strip, and `namedRegistries` values are validated as http(s) URLs when
+ * the resolver is constructed, so this is unreachable in practice.
+ */
+function sanitizeRegistryUrl(url) {
+    let parsed;
+    try {
+        parsed = new URL(url);
+    }
+    catch {
+        return url;
+    }
+    parsed.username = '';
+    parsed.password = '';
+    parsed.search = '';
+    parsed.hash = '';
+    return parsed.toString();
+}
 //# sourceMappingURL=purl.js.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pnpm/deps.compliance.sbom",
-  "version": "1100.3.10",
+  "version": "1100.4.0",
   "description": "Generate SBOM from pnpm lockfile",
   "keywords": [
     "pnpm",
@@ -31,16 +31,19 @@
   ],
   "dependencies": {
     "@cyclonedx/cyclonedx-library": "10.1.0",
+    "@pnpm/config.normalize-registries": "1100.1.0",
+    "@pnpm/constants": "1101.0.0",
     "@pnpm/deps.compliance.license-resolver": "1100.0.1",
-    "@pnpm/lockfile.detect-dep-types": "1100.0.18",
-    "@pnpm/lockfile.types": "1100.0.18",
-    "@pnpm/lockfile.utils": "1100.1.7",
-    "@pnpm/lockfile.walker": "1100.0.18",
-    "@pnpm/pkg-manifest.reader": "1100.0.14",
-    "@pnpm/resolving.resolver-base": "1101.0.0",
-    "@pnpm/store.index": "1100.2.2",
-    "@pnpm/store.pkg-finder": "1100.0.27",
-    "@pnpm/types": "1101.8.0",
+    "@pnpm/error": "1100.1.1",
+    "@pnpm/lockfile.detect-dep-types": "1100.0.19",
+    "@pnpm/lockfile.types": "1100.0.19",
+    "@pnpm/lockfile.utils": "1101.0.0",
+    "@pnpm/lockfile.walker": "1100.0.19",
+    "@pnpm/pkg-manifest.reader": "1100.0.15",
+    "@pnpm/resolving.resolver-base": "1101.1.0",
+    "@pnpm/store.index": "1100.2.3",
+    "@pnpm/store.pkg-finder": "1100.0.28",
+    "@pnpm/types": "1101.9.0",
     "p-limit": "^7.3.1",
     "ssri": "13.0.1"
   },
@@ -49,9 +52,9 @@
   },
   "devDependencies": {
     "@jest/globals": "30.4.1",
-    "@pnpm/deps.compliance.sbom": "1100.3.10",
+    "@pnpm/deps.compliance.sbom": "1100.4.0",
     "@pnpm/logger": "1100.0.0",
-    "@pnpm/store.cafs": "1100.1.17",
+    "@pnpm/store.cafs": "1100.1.18",
     "@types/ssri": "^7.1.5"
   },
   "engines": {