Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix nodejs breaking change CVE-2024-27980 #973

Merged
merged 11 commits into from
May 3, 2024
42 changes: 38 additions & 4 deletions src/package.ts
Original file line number Diff line number Diff line change
Expand Up @@ -395,25 +395,59 @@ export async function versionBump(options: IVersionBumpOptions): Promise<void> {
}
}


// call `npm version` to do our dirty work
const args = ['version', options.version];

if (options.commitMessage) {
args.push('-m', options.commitMessage);
const isWindows = process.platform === 'win32';

const commitMessage = isWindows ? sanitizeCommitMessage(options.commitMessage) : options.commitMessage;
if (commitMessage) {
args.push('-m', commitMessage);
}

if (!(options.gitTagVersion ?? true)) {
args.push('--no-git-tag-version');
}

const { stdout, stderr } = await promisify(cp.execFile)(process.platform === 'win32' ? 'npm.cmd' : 'npm', args, { cwd });

const { stdout, stderr } = await promisify(cp.execFile)(isWindows ? 'npm.cmd' : 'npm', args, { cwd, shell: isWindows /* https://nodejs.org/en/blog/vulnerability/april-2024-security-releases-2 */ });
if (!process.env['VSCE_TESTS']) {
process.stdout.write(stdout);
process.stderr.write(stderr);
}
}

function sanitizeCommitMessage(message?: string): string | undefined {
joaomoreno marked this conversation as resolved.
Show resolved Hide resolved
if (!message) {
return undefined;
}

// Check for characters that might escape quotes or introduce shell commands.
// Don't allow: ', ", `, $, \ (except for \n)
const unsafeRegex = /(?<!\\)\\(?!n)|['"`$]/g;
joaomoreno marked this conversation as resolved.
Show resolved Hide resolved

// Remove any unsafe characters found by the unsafeRegex
const sanitizedMessage = message.replace(unsafeRegex, '');

// Additional check to make sure nothing potentially dangerous is still in the string
if ([`'`, `"`, '`', '$'].some(char => sanitizedMessage.includes(char))) {
benibenj marked this conversation as resolved.
Show resolved Hide resolved
throw new Error('Commit message contains potentially dangerous characters after initial sanitization.');
}

for (let index = 0; index < sanitizedMessage.length; index++) {
const char = sanitizedMessage[index];
if (char === '\\' && sanitizedMessage[index + 1] !== 'n') {
throw new Error('Commit message contains potentially dangerous characters after initial sanitization.');
}
}

if (sanitizedMessage.length === 0) {
return undefined;
}

return `"${sanitizedMessage}"`;
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Make sure that explicit quotes are really necessary when using shell: true, since I didn't find any reference to that in the docs.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

With shell: false the arguments are passed directly to the executable as an array compared to shell; true for which they are pasted into the shell. To make sure that strings with spaces in them are considered as a single argument, quotes have to be added.

}

export const Targets = new Set([
'win32-x64',
'win32-arm64',
Expand Down
2 changes: 1 addition & 1 deletion src/test/package.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2940,7 +2940,7 @@ describe('version', function () {
const fixtureFolder = fixture('vsixmanifest');
let cwd: string;

const git = (args: string[]) => spawnSync('git', args, { cwd, encoding: 'utf-8' });
const git = (args: string[]) => spawnSync('git', args, { cwd, encoding: 'utf-8', shell: true });

beforeEach(() => {
dir = tmp.dirSync({ unsafeCleanup: true });
Expand Down