|
| 1 | +import { execFileSync } from "node:child_process"; |
| 2 | +import { resolve } from "node:path"; |
| 3 | +import { pathToFileURL } from "node:url"; |
| 4 | + |
| 5 | +export function assertPublishedPackageSecurityMetadata(metadata, packageSpec) { |
| 6 | + if (!metadata || typeof metadata !== "object") { |
| 7 | + throw new Error( |
| 8 | + `npm view returned no package metadata for ${packageSpec}.`, |
| 9 | + ); |
| 10 | + } |
| 11 | + |
| 12 | + const dist = |
| 13 | + "dist" in metadata && metadata.dist && typeof metadata.dist === "object" |
| 14 | + ? metadata.dist |
| 15 | + : null; |
| 16 | + const attestations = |
| 17 | + dist && |
| 18 | + "attestations" in dist && |
| 19 | + dist.attestations && |
| 20 | + typeof dist.attestations === "object" |
| 21 | + ? dist.attestations |
| 22 | + : null; |
| 23 | + const provenance = |
| 24 | + attestations && |
| 25 | + "provenance" in attestations && |
| 26 | + attestations.provenance && |
| 27 | + typeof attestations.provenance === "object" |
| 28 | + ? attestations.provenance |
| 29 | + : null; |
| 30 | + const signatures = |
| 31 | + dist && "signatures" in dist && Array.isArray(dist.signatures) |
| 32 | + ? dist.signatures |
| 33 | + : []; |
| 34 | + |
| 35 | + if (!attestations || typeof attestations.url !== "string") { |
| 36 | + throw new Error( |
| 37 | + `Published package ${packageSpec} is missing npm attestations metadata.`, |
| 38 | + ); |
| 39 | + } |
| 40 | + |
| 41 | + if (!provenance || typeof provenance.predicateType !== "string") { |
| 42 | + throw new Error( |
| 43 | + `Published package ${packageSpec} is missing provenance details.`, |
| 44 | + ); |
| 45 | + } |
| 46 | + |
| 47 | + if (signatures.length === 0) { |
| 48 | + throw new Error( |
| 49 | + `Published package ${packageSpec} is missing npm registry signatures.`, |
| 50 | + ); |
| 51 | + } |
| 52 | +} |
| 53 | + |
| 54 | +export function verifyPublishedPackage(packageName, packageVersion) { |
| 55 | + const packageSpec = packageVersion |
| 56 | + ? `${packageName}@${packageVersion}` |
| 57 | + : packageName; |
| 58 | + const stdout = fetchPublishedPackageMetadata(packageSpec); |
| 59 | + const metadata = JSON.parse(stdout); |
| 60 | + |
| 61 | + assertPublishedPackageSecurityMetadata(metadata, packageSpec); |
| 62 | +} |
| 63 | + |
| 64 | +export function fetchPublishedPackageMetadata(packageSpec) { |
| 65 | + try { |
| 66 | + return execFileSync("npm", ["view", packageSpec, "--json"], { |
| 67 | + encoding: "utf8", |
| 68 | + stdio: ["ignore", "pipe", "pipe"], |
| 69 | + }); |
| 70 | + } catch (error) { |
| 71 | + const message = |
| 72 | + error instanceof Error && error.message |
| 73 | + ? error.message |
| 74 | + : "Unknown npm view failure."; |
| 75 | + |
| 76 | + throw new Error( |
| 77 | + `Failed to fetch package metadata for ${packageSpec} from npm registry: ${message}`, |
| 78 | + { cause: error }, |
| 79 | + ); |
| 80 | + } |
| 81 | +} |
| 82 | + |
| 83 | +if (import.meta.url === pathToFileURL(resolve(process.argv[1] ?? "")).href) { |
| 84 | + const [, , packageName, packageVersion] = process.argv; |
| 85 | + |
| 86 | + if (!packageName) { |
| 87 | + console.error( |
| 88 | + "Usage: node ./scripts/verify-published-package.mjs <package-name> [version]", |
| 89 | + ); |
| 90 | + process.exitCode = 1; |
| 91 | + } else { |
| 92 | + verifyPublishedPackage(packageName, packageVersion); |
| 93 | + } |
| 94 | +} |
0 commit comments