fix: removed unsafe shell when executing process

Ref: PNX-3671 Signed-off-by: Akos Kitta <a.kitta@arduino.cc>

Author: Akos Kitta

arduino-ide-extension/package.json

@@ -110,11 +110,9 @@
  "devDependencies": {
  "@octokit/rest": "^18.12.0",
  "@types/chai": "^4.2.7",
- "@types/chai-string": "^1.4.2",
  "@types/mocha": "^5.2.7",
  "@types/react-window": "^1.8.5",
  "chai": "^4.2.0",
- "chai-string": "^1.5.0",
  "decompress": "^4.2.0",
  "decompress-tarbz2": "^4.1.1",
  "decompress-targz": "^4.1.1",

arduino-ide-extension/src/common/protocol/executable-service.ts

@@ -5,6 +5,5 @@ export interface ExecutableService {
  clangdUri: string;
  cliUri: string;
  lsUri: string;
- fwuploaderUri: string;
  }>;
 }

arduino-ide-extension/src/node/arduino-daemon-impl.ts

@@ -44,7 +44,6 @@ export class ArduinoDaemonImpl
 
  private _running = false;
  private _port = new Deferred<string>();
- private _execPath: string | undefined;
 
  // Backend application lifecycle.
 
@@ -68,7 +67,7 @@ export class ArduinoDaemonImpl
  async start(): Promise<string> {
  try {
  this.toDispose.dispose(); // This will `kill` the previously started daemon process, if any.
- const cliPath = await this.getExecPath();
+ const cliPath = this.getExecPath();
  this.onData(`Starting daemon from ${cliPath}...`);
  const { daemon, port } = await this.spawnDaemonProcess();
  // Watchdog process for terminating the daemon process when the backend app terminates.
@@ -132,12 +131,8 @@ export class ArduinoDaemonImpl
  return this.onDaemonStoppedEmitter.event;
  }
 
- async getExecPath(): Promise<string> {
- if (this._execPath) {
- return this._execPath;
- }
- this._execPath = await getExecPath('arduino-cli', this.onError.bind(this));
- return this._execPath;
+ getExecPath(): string {
+ return getExecPath('arduino-cli');
  }
 
  protected async getSpawnArgs(): Promise<string[]> {
@@ -151,7 +146,7 @@ export class ArduinoDaemonImpl
  '--port',
  '0',
  '--config-file',
- `"${cliConfigPath}"`,
+ cliConfigPath,
  '-v',
  ];
  if (debug) {
@@ -173,10 +168,8 @@ export class ArduinoDaemonImpl
  daemon: ChildProcess;
  port: string;
  }> {
- const [cliPath, args] = await Promise.all([
- this.getExecPath(),
- this.getSpawnArgs(),
- ]);
+ const args = await this.getSpawnArgs();
+ const cliPath = this.getExecPath();
  const ready = new Deferred<{ daemon: ChildProcess; port: string }>();
  const options = { shell: true };
  const daemon = spawn(`"${cliPath}"`, args, options);

arduino-ide-extension/src/node/arduino-firmware-uploader-impl.ts

@@ -1,45 +1,22 @@
+import { ILogger } from '@theia/core/lib/common/logger';
+import { inject, injectable, named } from '@theia/core/shared/inversify';
+import type { Port } from '../common/protocol';
 import {
  ArduinoFirmwareUploader,
  FirmwareInfo,
 } from '../common/protocol/arduino-firmware-uploader';
-import { injectable, inject, named } from '@theia/core/shared/inversify';
-import { ExecutableService, Port } from '../common/protocol';
 import { getExecPath, spawnCommand } from './exec-util';
-import { ILogger } from '@theia/core/lib/common/logger';
 import { MonitorManager } from './monitor-manager';
 
 @injectable()
 export class ArduinoFirmwareUploaderImpl implements ArduinoFirmwareUploader {
- @inject(ExecutableService)
- protected executableService: ExecutableService;
-
- protected _execPath: string | undefined;
-
  @inject(ILogger)
  @named('fwuploader')
- protected readonly logger: ILogger;
-
+ private readonly logger: ILogger;
  @inject(MonitorManager)
- protected readonly monitorManager: MonitorManager;
-
- protected onError(error: any): void {
- this.logger.error(error);
- }
-
- async getExecPath(): Promise<string> {
- if (this._execPath) {
- return this._execPath;
- }
- this._execPath = await getExecPath('arduino-fwuploader');
- return this._execPath;
- }
-
- async runCommand(args: string[]): Promise<any> {
- const execPath = await this.getExecPath();
- return await spawnCommand(`"${execPath}"`, args, this.onError.bind(this));
- }
+ private readonly monitorManager: MonitorManager;
 
- async uploadCertificates(command: string): Promise<any> {
+ async uploadCertificates(command: string): Promise<string> {
  return await this.runCommand(['certificates', 'flash', command]);
  }
 
@@ -70,14 +47,13 @@ export class ArduinoFirmwareUploaderImpl implements ArduinoFirmwareUploader {
  }
 
  async flash(firmware: FirmwareInfo, port: Port): Promise<string> {
- let output;
  const board = {
  name: firmware.board_name,
  fqbn: firmware.board_fqbn,
  };
  try {
  await this.monitorManager.notifyUploadStarted(board.fqbn, port);
- output = await this.runCommand([
+ const output = await this.runCommand([
  'firmware',
  'flash',
  '--fqbn',
@@ -87,11 +63,18 @@ export class ArduinoFirmwareUploaderImpl implements ArduinoFirmwareUploader {
  '--module',
  `${firmware.module}@${firmware.firmware_version}`,
  ]);
- } catch (e) {
- throw e;
+ return output;
  } finally {
  await this.monitorManager.notifyUploadFinished(board.fqbn, port);
- return output;
  }
  }
+
+ private onError(error: Error): void {
+ this.logger.error(error);
+ }
+
+ private async runCommand(args: string[]): Promise<string> {
+ const execPath = getExecPath('arduino-fwuploader');
+ return await spawnCommand(execPath, args, this.onError.bind(this));
+ }
 }

arduino-ide-extension/src/node/clang-formatter.ts

@@ -31,21 +31,16 @@ export class ClangFormatter implements Formatter {
  this.style(formatterConfigFolderUris, options),
  ]);
  const formatted = await spawnCommand(
- `"${execPath}"`,
+ execPath,
  [style],
  console.error,
  content
  );
  return formatted;
  }
 
- private _execPath: string | undefined;
  private async execPath(): Promise<string> {
- if (this._execPath) {
- return this._execPath;
- }
- this._execPath = await getExecPath('clang-format');
- return this._execPath;
+ return getExecPath('clang-format');
  }
 
  /**

arduino-ide-extension/src/node/config-service-impl.ts

@@ -222,8 +222,8 @@ export class ConfigServiceImpl
  }
 
  private async getFallbackCliConfig(): Promise<DefaultCliConfig> {
- const cliPath = await this.daemon.getExecPath();
- const rawJson = await spawnCommand(`"${cliPath}"`, [
+ const cliPath = this.daemon.getExecPath();
+ const rawJson = await spawnCommand(cliPath, [
  'config',
  'dump',
  'format',
@@ -233,13 +233,8 @@ export class ConfigServiceImpl
  }
 
  private async initCliConfigTo(fsPathToDir: string): Promise<void> {
- const cliPath = await this.daemon.getExecPath();
- await spawnCommand(`"${cliPath}"`, [
- 'config',
- 'init',
- '--dest-dir',
- `"${fsPathToDir}"`,
- ]);
+ const cliPath = this.daemon.getExecPath();
+ await spawnCommand(cliPath, ['config', 'init', '--dest-dir', fsPathToDir]);
  }
 
  private async mapCliConfigToAppConfig(

arduino-ide-extension/src/node/exec-util.ts

@@ -1,51 +1,17 @@
+import { spawn } from 'node:child_process';
 import os from 'node:os';
-import which from 'which';
-import semver from 'semver';
 import { join } from 'node:path';
-import { spawn } from 'node:child_process';
 
-export async function getExecPath(
- commandName: string,
- onError: (error: Error) => void = (error) => console.log(error),
- versionArg?: string | undefined,
- inBinDir?: boolean
-): Promise<string> {
- const execName = `${commandName}${os.platform() === 'win32' ? '.exe' : ''}`;
- const relativePath = ['..', '..', 'build'];
- if (inBinDir) {
- relativePath.push('bin');
- }
- const buildCommand = join(__dirname, ...relativePath, execName);
- if (!versionArg) {
- return buildCommand;
- }
- const versionRegexp = /\d+\.\d+\.\d+/;
- const buildVersion = await spawnCommand(
- `"${buildCommand}"`,
- [versionArg],
- onError
- );
- const buildShortVersion = (buildVersion.match(versionRegexp) || [])[0];
- const pathCommand = await new Promise<string | undefined>((resolve) =>
- which(execName, (error, path) => resolve(error ? undefined : path))
- );
- if (!pathCommand) {
- return buildCommand;
- }
- const pathVersion = await spawnCommand(
- `"${pathCommand}"`,
- [versionArg],
- onError
- );
- const pathShortVersion = (pathVersion.match(versionRegexp) || [])[0];
- if (
- pathShortVersion &&
- buildShortVersion &&
- semver.gt(pathShortVersion, buildShortVersion)
- ) {
- return pathCommand;
- }
- return buildCommand;
+export type ArduinoBinaryName =
+ | 'arduino-cli'
+ | 'arduino-fwuploader'
+ | 'arduino-language-server';
+export type ClangBinaryName = 'clangd' | 'clang-format';
+export type BinaryName = ArduinoBinaryName | ClangBinaryName;
+
+export function getExecPath(binaryName: BinaryName): string {
+ const filename = `${binaryName}${os.platform() === 'win32' ? '.exe' : ''}`;
+ return join(__dirname, '..', '..', 'build', filename);
 }
 
 export function spawnCommand(
@@ -55,7 +21,7 @@ export function spawnCommand(
  stdIn?: string
 ): Promise<string> {
  return new Promise<string>((resolve, reject) => {
- const cp = spawn(command, args, { windowsHide: true, shell: true });
+ const cp = spawn(command, args, { windowsHide: true });
  const outBuffers: Buffer[] = [];
  const errBuffers: Buffer[] = [];
  cp.stdout.on('data', (b: Buffer) => outBuffers.push(b));

arduino-ide-extension/src/node/executable-service-impl.ts

@@ -1,35 +1,19 @@
-import { injectable, inject } from '@theia/core/shared/inversify';
-import { ILogger } from '@theia/core/lib/common/logger';
 import { FileUri } from '@theia/core/lib/node/file-uri';
-import { getExecPath } from './exec-util';
+import { injectable } from '@theia/core/shared/inversify';
 import { ExecutableService } from '../common/protocol/executable-service';
+import { getExecPath } from './exec-util';
 
 @injectable()
 export class ExecutableServiceImpl implements ExecutableService {
- @inject(ILogger)
- protected logger: ILogger;
-
  async list(): Promise<{
  clangdUri: string;
  cliUri: string;
  lsUri: string;
- fwuploaderUri: string;
  }> {
- const [ls, clangd, cli, fwuploader] = await Promise.all([
- getExecPath('arduino-language-server', this.onError.bind(this)),
- getExecPath('clangd', this.onError.bind(this), undefined),
- getExecPath('arduino-cli', this.onError.bind(this)),
- getExecPath('arduino-fwuploader', this.onError.bind(this)),
- ]);
  return {
- clangdUri: FileUri.create(clangd).toString(),
- cliUri: FileUri.create(cli).toString(),
- lsUri: FileUri.create(ls).toString(),
- fwuploaderUri: FileUri.create(fwuploader).toString(),
+ clangdUri: FileUri.create(getExecPath('clangd')).toString(),
+ cliUri: FileUri.create(getExecPath('arduino-cli')).toString(),
+ lsUri: FileUri.create(getExecPath('arduino-language-server')).toString(),
  };
  }
-
- protected onError(error: Error): void {
- this.logger.error(error);
- }
 }

arduino-ide-extension/src/test/node/arduino-daemon-impl.test.ts

@@ -43,19 +43,13 @@ class SilentArduinoDaemonImpl extends ArduinoDaemonImpl {
  }
 
  private async initCliConfig(): Promise<string> {
- const cliPath = await this.getExecPath();
+ const cliPath = this.getExecPath();
  const destDir = track.mkdirSync();
- await spawnCommand(`"${cliPath}"`, [
- 'config',
- 'init',
- '--dest-dir',
- destDir,
- ]);
+ await spawnCommand(cliPath, ['config', 'init', '--dest-dir', destDir]);
  const content = fs.readFileSync(path.join(destDir, CLI_CONFIG), {
  encoding: 'utf8',
  });
- const cliConfig = safeLoad(content) as any;
- // cliConfig.daemon.port = String(this.port);
+ const cliConfig = safeLoad(content);
  const modifiedContent = safeDump(cliConfig);
  fs.writeFileSync(path.join(destDir, CLI_CONFIG), modifiedContent, {
  encoding: 'utf8',