Adapt per review

This commit is contained in:
Reinier Criel 2025-11-17 10:03:38 -08:00
parent 7039961d4c
commit 87fcb7239a
2 changed files with 34 additions and 36 deletions

View file

@ -32,8 +32,7 @@ export async function runPip(command, args) {
const tmpDir = os.tmpdir(); const tmpDir = os.tmpdir();
const pipConfigPath = path.join(tmpDir, `safe-chain-pip-${Date.now()}.ini`); const pipConfigPath = path.join(tmpDir, `safe-chain-pip-${Date.now()}.ini`);
if (!env.PIP_CONFIG_FILE) { if (!env.PIP_CONFIG_FILE) { // Build pip config INI
// Build pip config INI
/** @type {{ global: { cert: string, proxy?: string } }} */ /** @type {{ global: { cert: string, proxy?: string } }} */
const configObj = { global: { cert: combinedCaPath } }; const configObj = { global: { cert: combinedCaPath } };
if (proxy) { if (proxy) {
@ -43,9 +42,7 @@ export async function runPip(command, args) {
await fs.writeFile(pipConfigPath, pipConfig); await fs.writeFile(pipConfigPath, pipConfig);
env.PIP_CONFIG_FILE = pipConfigPath; env.PIP_CONFIG_FILE = pipConfigPath;
} else if (fsSync.existsSync(env.PIP_CONFIG_FILE)) { } else if (fsSync.existsSync(env.PIP_CONFIG_FILE)) { // Merge pip config INI
// Existing pip config file present and exists on disk.
// Lets merge in our cert and proxy settings if not already present
ui.writeVerbose("Safe-chain: Merging user provided PIP_CONFIG_FILE with safe-chain certificate and proxy settings."); ui.writeVerbose("Safe-chain: Merging user provided PIP_CONFIG_FILE with safe-chain certificate and proxy settings.");
const userConfig = env.PIP_CONFIG_FILE; const userConfig = env.PIP_CONFIG_FILE;
@ -56,22 +53,18 @@ export async function runPip(command, args) {
// Ensure [global] section exists // Ensure [global] section exists
parsed.global = parsed.global || {}; parsed.global = parsed.global || {};
// Adding CERT and PROXY
// If either is already set, there's no neeed to throw an error
// MITM might fail and throw later if the proxy config is invalid
// Cert // Cert
if (typeof parsed.global.cert === "undefined") { if (typeof parsed.global.cert !== "undefined") {
ui.writeVerbose("Safe-chain: Adding cert to temporary PIP_CONFIG_FILE."); ui.writeWarning("Safe-chain: User defined cert found in PIP_CONFIG_FILE. It will be overwritten in the temporary config.");
parsed.global.cert = combinedCaPath;
} }
parsed.global.cert = combinedCaPath;
// Proxy // Proxy
if (typeof parsed.global.proxy === "undefined") { if (typeof parsed.global.proxy !== "undefined") {
if (proxy) { ui.writeWarning("Safe-chain: User defined proxy found in PIP_CONFIG_FILE. It will be overwritten in the temporary config.");
ui.writeVerbose("Safe-chain: Adding proxy to temporary PIP_CONFIG_FILE.");
parsed.global.proxy = proxy;
} }
if (proxy) {
parsed.global.proxy = proxy;
} }
const updated = ini.stringify(parsed); const updated = ini.stringify(parsed);
@ -86,15 +79,20 @@ export async function runPip(command, args) {
} }
// REQUESTS_CA_BUNDLE, SSL_CERT_FILE and PIP_CERT as extra safety nets. // REQUESTS_CA_BUNDLE, SSL_CERT_FILE and PIP_CERT as extra safety nets.
if (!env.REQUESTS_CA_BUNDLE) { if (env.REQUESTS_CA_BUNDLE) {
ui.writeWarning("Safe-chain: User defined REQUESTS_CA_BUNDLE found in environment. It will be overwritten.");
}
env.REQUESTS_CA_BUNDLE = combinedCaPath; env.REQUESTS_CA_BUNDLE = combinedCaPath;
if (env.SSL_CERT_FILE) {
ui.writeWarning("Safe-chain: User defined SSL_CERT_FILE found in environment. It will be overwritten.");
} }
if (!env.SSL_CERT_FILE) {
env.SSL_CERT_FILE = combinedCaPath; env.SSL_CERT_FILE = combinedCaPath;
if (env.PIP_CERT) {
ui.writeWarning("Safe-chain: User defined PIP_CERT found in environment. It will be overwritten.");
} }
if (!env.PIP_CERT) {
env.PIP_CERT = combinedCaPath; env.PIP_CERT = combinedCaPath;
}
const result = await safeSpawn(command, args, { const result = await safeSpawn(command, args, {
stdio: "inherit", stdio: "inherit",

View file

@ -217,10 +217,10 @@ describe("runPipCommand environment variable handling", () => {
assert.strictEqual(originalParsed.global.cert, undefined, "original file should not gain cert"); assert.strictEqual(originalParsed.global.cert, undefined, "original file should not gain cert");
assert.strictEqual(originalParsed.global.proxy, "http://original:9999", "original proxy remains"); assert.strictEqual(originalParsed.global.proxy, "http://original:9999", "original proxy remains");
// New file merged: cert added (was missing), proxy preserved (was present) // New file: cert and proxy always overwritten
const newParsed = ini.parse(await fs.readFile(newCfgPath, "utf-8")); const newParsed = ini.parse(await fs.readFile(newCfgPath, "utf-8"));
assert.strictEqual(newParsed.global.cert, "/tmp/test-combined-ca.pem", "new cert injected"); assert.strictEqual(newParsed.global.cert, "/tmp/test-combined-ca.pem", "cert always overwritten in temp config");
assert.strictEqual(newParsed.global.proxy, "http://original:9999", "existing proxy should be preserved in new file"); assert.strictEqual(newParsed.global.proxy, "http://localhost:8080", "proxy always overwritten in temp config");
customEnv = null; customEnv = null;
}); });
@ -247,11 +247,11 @@ describe("runPipCommand environment variable handling", () => {
assert.strictEqual(originalParsed.global.cert, "/path/to/existing.pem", "original cert preserved"); assert.strictEqual(originalParsed.global.cert, "/path/to/existing.pem", "original cert preserved");
assert.strictEqual(originalParsed.global.proxy, "http://original:9999", "original proxy preserved"); assert.strictEqual(originalParsed.global.proxy, "http://original:9999", "original proxy preserved");
// New temp config preserves existing values (no override when already set) // New temp config: cert and proxy always overwritten
const newContent = await fs.readFile(newCfgPath, "utf-8"); const newContent = await fs.readFile(newCfgPath, "utf-8");
const newParsed = ini.parse(newContent); const newParsed = ini.parse(newContent);
assert.strictEqual(newParsed.global.cert, "/path/to/existing.pem", "existing cert preserved in new temp config"); assert.strictEqual(newParsed.global.cert, "/tmp/test-combined-ca.pem", "cert always overwritten in temp config");
assert.strictEqual(newParsed.global.proxy, "http://original:9999", "existing proxy preserved in new temp config"); assert.strictEqual(newParsed.global.proxy, "http://localhost:8080", "proxy always overwritten in temp config");
customEnv = null; customEnv = null;
}); });
@ -272,10 +272,10 @@ describe("runPipCommand environment variable handling", () => {
assert.strictEqual(originalParsed.global.cert, "/path/to/existing.pem", "original cert unchanged"); assert.strictEqual(originalParsed.global.cert, "/path/to/existing.pem", "original cert unchanged");
assert.strictEqual(originalParsed.global.proxy, undefined, "original proxy still missing"); assert.strictEqual(originalParsed.global.proxy, undefined, "original proxy still missing");
// New file preserves existing cert and adds proxy (since it was missing) // New file: cert and proxy always overwritten
const newParsed = ini.parse(await fs.readFile(newCfgPath, "utf-8")); const newParsed = ini.parse(await fs.readFile(newCfgPath, "utf-8"));
assert.strictEqual(newParsed.global.cert, "/path/to/existing.pem", "existing cert preserved (not overridden)"); assert.strictEqual(newParsed.global.cert, "/tmp/test-combined-ca.pem", "cert always overwritten in temp config");
assert.strictEqual(newParsed.global.proxy, "http://localhost:8080", "proxy added from env"); assert.strictEqual(newParsed.global.proxy, "http://localhost:8080", "proxy always overwritten in temp config");
customEnv = null; customEnv = null;
}); });
}); });