Expose minPackageAgeVersionsSuppressed for pypi as well.

This commit is contained in:
Sander Declerck 2026-05-05 13:45:55 +02:00
parent f2479ad866
commit 62a3c1330c
No known key found for this signature in database
4 changed files with 63 additions and 46 deletions

View file

@ -24,7 +24,6 @@ export async function main(args) {
let malwareBlockedEvents = []; let malwareBlockedEvents = [];
/** @type {import("./registryProxy/registryProxy.js").PackageBlockedEvent[]} */ /** @type {import("./registryProxy/registryProxy.js").PackageBlockedEvent[]} */
let minPackageAgeBlocks = []; let minPackageAgeBlocks = [];
/** @type {import("./registryProxy/registryProxy.js").MinPackageAgeSuppressionEvent[]} */ /** @type {import("./registryProxy/registryProxy.js").MinPackageAgeSuppressionEvent[]} */
let suppressedVersionEvents = []; let suppressedVersionEvents = [];

View file

@ -8,6 +8,7 @@ import { getCaCertPath } from "./certUtils.js";
import { readFileSync } from "fs"; import { readFileSync } from "fs";
import EventEmitter from "events"; import EventEmitter from "events";
import { modifyResponseEventEmitter } from "./interceptors/npm/modifyNpmInfo.js"; import { modifyResponseEventEmitter } from "./interceptors/npm/modifyNpmInfo.js";
import { modifyPipResponseEventEmitter } from "./interceptors/pip/modifyPipInfo.js";
import { cleanupCertBundle } from "../certBundle.js"; import { cleanupCertBundle } from "../certBundle.js";
/** * /** *
@ -27,6 +28,10 @@ export function createBuiltInProxyServer() {
emitter.emit("minPackageAgeVersionsSuppressed", ev); emitter.emit("minPackageAgeVersionsSuppressed", ev);
}); });
modifyPipResponseEventEmitter.addListener("versionsRemoved", (ev) => {
emitter.emit("minPackageAgeVersionsSuppressed", ev);
});
const server = http.createServer( const server = http.createServer(
// This handles direct HTTP requests (non-CONNECT requests) // This handles direct HTTP requests (non-CONNECT requests)
// This is normally http-only traffic, but we also handle // This is normally http-only traffic, but we also handle

View file

@ -1,3 +1,4 @@
import { EventEmitter } from "events";
import { ui } from "../../../../environment/userInteraction.js"; import { ui } from "../../../../environment/userInteraction.js";
import { clearCachingHeaders } from "../../http-utils.js"; import { clearCachingHeaders } from "../../http-utils.js";
import { normalizePipPackageName } from "../../../../scanning/packageNameVariants.js"; import { normalizePipPackageName } from "../../../../scanning/packageNameVariants.js";
@ -6,6 +7,9 @@ export { parsePipMetadataUrl, isPipPackageInfoUrl } from "./parsePipPackageUrl.j
import { getPipMetadataContentType, logSuppressedVersion } from "./pipMetadataResponseUtils.js"; import { getPipMetadataContentType, logSuppressedVersion } from "./pipMetadataResponseUtils.js";
import { modifyPipJsonResponse } from "./modifyPipJsonResponse.js"; import { modifyPipJsonResponse } from "./modifyPipJsonResponse.js";
/** @type {EventEmitter<{ versionsRemoved: [{packageName: string, packageVersions: string[]}] }>} */
export const modifyPipResponseEventEmitter = new EventEmitter();
/** /**
* Strip conditional GET headers so PyPI always returns a full 200 response * Strip conditional GET headers so PyPI always returns a full 200 response
* with a body we can rewrite. Without this, pip sends If-None-Match / * with a body we can rewrite. Without this, pip sends If-None-Match /
@ -50,33 +54,42 @@ export function modifyPipInfoResponse(
return body; return body;
} }
/** @type {{ buffer: Buffer, suppressedVersions: string[] } | undefined} */
let result;
if ( if (
contentType.includes("html") || contentType.includes("html") ||
contentType.includes("application/vnd.pypi.simple.v1+html") contentType.includes("application/vnd.pypi.simple.v1+html")
) { ) {
return modifyHtmlSimpleResponse( result = modifyHtmlSimpleResponse(
body, body,
headers, headers,
metadataUrl, metadataUrl,
isNewlyReleasedPackage, isNewlyReleasedPackage,
packageName packageName
); );
} } else if (
if (
contentType.includes("json") || contentType.includes("json") ||
contentType.includes("application/vnd.pypi.simple.v1+json") contentType.includes("application/vnd.pypi.simple.v1+json")
) { ) {
return modifyJsonResponse( result = modifyJsonResponse(
body, body,
headers, headers,
metadataUrl, metadataUrl,
isNewlyReleasedPackage, isNewlyReleasedPackage,
packageName packageName
); );
} else {
return body;
} }
return body; if (result.suppressedVersions.length > 0) {
modifyPipResponseEventEmitter.emit("versionsRemoved", {
packageName,
packageVersions: result.suppressedVersions,
});
}
return result.buffer;
} catch (/** @type {any} */ err) { } catch (/** @type {any} */ err) {
ui.writeVerbose( ui.writeVerbose(
`Safe-chain: PyPI package metadata not in expected format - bypassing modification. Error: ${err.message}` `Safe-chain: PyPI package metadata not in expected format - bypassing modification. Error: ${err.message}`
@ -91,7 +104,7 @@ export function modifyPipInfoResponse(
* @param {string} metadataUrl * @param {string} metadataUrl
* @param {(packageName: string | undefined, version: string | undefined) => boolean} isNewlyReleasedPackage * @param {(packageName: string | undefined, version: string | undefined) => boolean} isNewlyReleasedPackage
* @param {string} packageName * @param {string} packageName
* @returns {Buffer} * @returns {{ buffer: Buffer, suppressedVersions: string[] }}
*/ */
function modifyHtmlSimpleResponse( function modifyHtmlSimpleResponse(
body, body,
@ -101,35 +114,35 @@ function modifyHtmlSimpleResponse(
packageName packageName
) { ) {
const html = body.toString("utf8"); const html = body.toString("utf8");
let modified = false; const suppressedVersions = /** @type {string[]} */ ([]);
const rewriteHtmlAnchor = createHtmlAnchorRewriter( const rewriteHtmlAnchor = createHtmlAnchorRewriter(
metadataUrl, metadataUrl,
isNewlyReleasedPackage, isNewlyReleasedPackage,
packageName, packageName,
() => { (version) => {
modified = true; suppressedVersions.push(version);
} }
); );
const updatedHtml = html.replace(HTML_ANCHOR_HREF_RE, rewriteHtmlAnchor); const updatedHtml = html.replace(HTML_ANCHOR_HREF_RE, rewriteHtmlAnchor);
if (!modified) return body; if (suppressedVersions.length === 0) return { buffer: body, suppressedVersions: [] };
const modifiedBuffer = Buffer.from(updatedHtml); const modifiedBuffer = Buffer.from(updatedHtml);
clearCachingHeaders(headers); clearCachingHeaders(headers);
return modifiedBuffer; return { buffer: modifiedBuffer, suppressedVersions: [...new Set(suppressedVersions)] };
} }
/** /**
* @param {string} metadataUrl * @param {string} metadataUrl
* @param {(packageName: string | undefined, version: string | undefined) => boolean} isNewlyReleasedPackage * @param {(packageName: string | undefined, version: string | undefined) => boolean} isNewlyReleasedPackage
* @param {string} packageName * @param {string} packageName
* @param {() => void} onModified * @param {(version: string) => void} onVersionSuppressed
* @returns {(anchor: string, quote: string, href: string) => string} * @returns {(anchor: string, quote: string, href: string) => string}
*/ */
function createHtmlAnchorRewriter( function createHtmlAnchorRewriter(
metadataUrl, metadataUrl,
isNewlyReleasedPackage, isNewlyReleasedPackage,
packageName, packageName,
onModified onVersionSuppressed
) { ) {
return (anchor, _quote, href) => { return (anchor, _quote, href) => {
const resolvedHref = new URL(href, metadataUrl).toString(); const resolvedHref = new URL(href, metadataUrl).toString();
@ -145,8 +158,8 @@ function createHtmlAnchorRewriter(
version && version &&
isNewlyReleasedPackage(packageName, version) isNewlyReleasedPackage(packageName, version)
) { ) {
onModified();
logSuppressedVersion(packageName, version); logSuppressedVersion(packageName, version);
onVersionSuppressed(version);
return ""; return "";
} }
@ -160,7 +173,7 @@ function createHtmlAnchorRewriter(
* @param {string} metadataUrl * @param {string} metadataUrl
* @param {(packageName: string | undefined, version: string | undefined) => boolean} isNewlyReleasedPackage * @param {(packageName: string | undefined, version: string | undefined) => boolean} isNewlyReleasedPackage
* @param {string} packageName * @param {string} packageName
* @returns {Buffer} * @returns {{ buffer: Buffer, suppressedVersions: string[] }}
*/ */
function modifyJsonResponse( function modifyJsonResponse(
body, body,
@ -170,15 +183,15 @@ function modifyJsonResponse(
packageName packageName
) { ) {
const json = JSON.parse(body.toString("utf8")); const json = JSON.parse(body.toString("utf8"));
const modified = modifyPipJsonResponse( const { suppressedVersions, wasModified } = modifyPipJsonResponse(
json, json,
metadataUrl, metadataUrl,
isNewlyReleasedPackage, isNewlyReleasedPackage,
packageName packageName
); );
if (!modified) return body; if (!wasModified) return { buffer: body, suppressedVersions: [] };
const modifiedBuffer = Buffer.from(JSON.stringify(json)); const modifiedBuffer = Buffer.from(JSON.stringify(json));
clearCachingHeaders(headers); clearCachingHeaders(headers);
return modifiedBuffer; return { buffer: modifiedBuffer, suppressedVersions };
} }

View file

@ -10,7 +10,7 @@ import { logSuppressedVersion } from "./pipMetadataResponseUtils.js";
* @param {string} metadataUrl * @param {string} metadataUrl
* @param {(packageName: string | undefined, version: string | undefined) => boolean} isNewlyReleasedPackage * @param {(packageName: string | undefined, version: string | undefined) => boolean} isNewlyReleasedPackage
* @param {string} packageName * @param {string} packageName
* @returns {boolean} * @returns {{ suppressedVersions: string[], wasModified: boolean }}
*/ */
export function modifyPipJsonResponse( export function modifyPipJsonResponse(
json, json,
@ -18,18 +18,18 @@ export function modifyPipJsonResponse(
isNewlyReleasedPackage, isNewlyReleasedPackage,
packageName packageName
) { ) {
const filesModified = filterJsonMetadataFiles( const filesSuppressed = filterJsonMetadataFiles(
json, json,
metadataUrl, metadataUrl,
isNewlyReleasedPackage, isNewlyReleasedPackage,
packageName packageName
); );
const releasesModified = removeJsonMetadataReleases( const releasesSuppressed = removeJsonMetadataReleases(
json, json,
isNewlyReleasedPackage, isNewlyReleasedPackage,
packageName packageName
); );
const urlsModified = filterJsonMetadataUrls( const urlsSuppressed = filterJsonMetadataUrls(
json, json,
metadataUrl, metadataUrl,
isNewlyReleasedPackage, isNewlyReleasedPackage,
@ -37,7 +37,11 @@ export function modifyPipJsonResponse(
); );
const versionModified = updateJsonInfoVersion(json, metadataUrl); const versionModified = updateJsonInfoVersion(json, metadataUrl);
return filesModified || releasesModified || urlsModified || versionModified; const suppressedVersions = [
...new Set([...filesSuppressed, ...releasesSuppressed, ...urlsSuppressed]),
];
return { suppressedVersions, wasModified: suppressedVersions.length > 0 || versionModified };
} }
/** /**
@ -45,7 +49,7 @@ export function modifyPipJsonResponse(
* @param {string} metadataUrl * @param {string} metadataUrl
* @param {(packageName: string | undefined, version: string | undefined) => boolean} isNewlyReleasedPackage * @param {(packageName: string | undefined, version: string | undefined) => boolean} isNewlyReleasedPackage
* @param {string} packageName * @param {string} packageName
* @returns {boolean} * @returns {string[]}
*/ */
function filterJsonMetadataFiles( function filterJsonMetadataFiles(
json, json,
@ -54,19 +58,17 @@ function filterJsonMetadataFiles(
packageName packageName
) { ) {
if (!Array.isArray(json.files)) { if (!Array.isArray(json.files)) {
return false; return [];
} }
let modified = false; const suppressed = new Set();
const loggedVersions = new Set();
json.files = json.files.filter((/** @type {any} */ file) => { json.files = json.files.filter((/** @type {any} */ file) => {
const version = getPackageVersionFromMetadataFile(file, metadataUrl); const version = getPackageVersionFromMetadataFile(file, metadataUrl);
if (version && isNewlyReleasedPackage(packageName, version)) { if (version && isNewlyReleasedPackage(packageName, version)) {
modified = true; if (!suppressed.has(version)) {
if (!loggedVersions.has(version)) {
logSuppressedVersion(packageName, version); logSuppressedVersion(packageName, version);
loggedVersions.add(version); suppressed.add(version);
} }
return false; return false;
} }
@ -74,21 +76,21 @@ function filterJsonMetadataFiles(
return true; return true;
}); });
return modified; return [...suppressed];
} }
/** /**
* @param {any} json * @param {any} json
* @param {(packageName: string | undefined, version: string | undefined) => boolean} isNewlyReleasedPackage * @param {(packageName: string | undefined, version: string | undefined) => boolean} isNewlyReleasedPackage
* @param {string} packageName * @param {string} packageName
* @returns {boolean} * @returns {string[]}
*/ */
function removeJsonMetadataReleases(json, isNewlyReleasedPackage, packageName) { function removeJsonMetadataReleases(json, isNewlyReleasedPackage, packageName) {
if (!json.releases || typeof json.releases !== "object") { if (!json.releases || typeof json.releases !== "object") {
return false; return [];
} }
let modified = false; const suppressed = [];
for (const [version, files] of Object.entries(json.releases)) { for (const [version, files] of Object.entries(json.releases)) {
if ( if (
@ -96,12 +98,12 @@ function removeJsonMetadataReleases(json, isNewlyReleasedPackage, packageName) {
isNewlyReleasedPackage(packageName, version) isNewlyReleasedPackage(packageName, version)
) { ) {
delete json.releases[version]; delete json.releases[version];
modified = true;
logSuppressedVersion(packageName, version); logSuppressedVersion(packageName, version);
suppressed.push(version);
} }
} }
return modified; return suppressed;
} }
/** /**
@ -109,7 +111,7 @@ function removeJsonMetadataReleases(json, isNewlyReleasedPackage, packageName) {
* @param {string} metadataUrl * @param {string} metadataUrl
* @param {(packageName: string | undefined, version: string | undefined) => boolean} isNewlyReleasedPackage * @param {(packageName: string | undefined, version: string | undefined) => boolean} isNewlyReleasedPackage
* @param {string} packageName * @param {string} packageName
* @returns {boolean} * @returns {string[]}
*/ */
function filterJsonMetadataUrls( function filterJsonMetadataUrls(
json, json,
@ -118,19 +120,17 @@ function filterJsonMetadataUrls(
packageName packageName
) { ) {
if (!Array.isArray(json.urls)) { if (!Array.isArray(json.urls)) {
return false; return [];
} }
let modified = false; const suppressed = new Set();
const loggedVersions = new Set();
json.urls = json.urls.filter((/** @type {any} */ file) => { json.urls = json.urls.filter((/** @type {any} */ file) => {
const version = getPackageVersionFromMetadataFile(file, metadataUrl); const version = getPackageVersionFromMetadataFile(file, metadataUrl);
if (version && isNewlyReleasedPackage(packageName, version)) { if (version && isNewlyReleasedPackage(packageName, version)) {
modified = true; if (!suppressed.has(version)) {
if (!loggedVersions.has(version)) {
logSuppressedVersion(packageName, version); logSuppressedVersion(packageName, version);
loggedVersions.add(version); suppressed.add(version);
} }
return false; return false;
} }
@ -138,7 +138,7 @@ function filterJsonMetadataUrls(
return true; return true;
}); });
return modified; return [...suppressed];
} }
/** /**