@aikidosec/safe-chain 1.4.9 → 1.5.0

package/src/shell-integration/supported-shells/fish.js

@@ -3,7 +3,9 @@ import {
   doesExecutableExistOnSystem,
   removeLinesMatchingPattern,
 } from "../helpers.js";
+import { getScriptsDir } from "../../config/safeChainDir.js";
 import { execSync } from "child_process";
+import path from "path";
 
 const shellName = "Fish";
 const executableName = "fish";
@@ -31,10 +33,10 @@ function teardown(tools) {
     );
   }
 
-  // Removes the line that sources the safe-chain fish initialization script (~/.safe-chain/scripts/init-fish.fish)
+  // Remove sourcing line to prevent safe-chain initialization in future shell sessions
   removeLinesMatchingPattern(
     startupFile,
-    /^source\s+~\/\.safe-chain\/scripts\/init-fish\.fish/,
+    /^source\s+.*init-fish\.fish.*#\s*Safe-chain/,
     eol
   );
 
@@ -46,7 +48,7 @@ function setup() {
 
   addLineToFile(
     startupFile,
-    `source ~/.safe-chain/scripts/init-fish.fish # Safe-chain Fish initialization script`,
+    `source ${path.join(getScriptsDir(), "init-fish.fish")} # Safe-chain Fish initialization script`,
     eol
   );
 
@@ -69,7 +71,7 @@ function getStartupFile() {
 function getManualTeardownInstructions() {
   return [
     `Remove the following line from your ~/.config/fish/config.fish file:`,
-    `  source ~/.safe-chain/scripts/init-fish.fish`,
+    `  source ${path.join(getScriptsDir(), "init-fish.fish")}`,
     `Then restart your terminal or run: source ~/.config/fish/config.fish`,
   ];
 }
@@ -77,7 +79,7 @@ function getManualTeardownInstructions() {
 function getManualSetupInstructions() {
   return [
     `Add the following line to your ~/.config/fish/config.fish file:`,
-    `  source ~/.safe-chain/scripts/init-fish.fish`,
+    `  source ${path.join(getScriptsDir(), "init-fish.fish")}`,
     `Then restart your terminal or run: source ~/.config/fish/config.fish`,
   ];
 }

package/src/shell-integration/supported-shells/powershell.js

@@ -4,7 +4,9 @@ import {
   removeLinesMatchingPattern,
   validatePowerShellExecutionPolicy,
 } from "../helpers.js";
+import { getScriptsDir } from "../../config/safeChainDir.js";
 import { execSync } from "child_process";
+import path from "path";
 
 const shellName = "PowerShell Core";
 const executableName = "pwsh";
@@ -30,10 +32,10 @@ function teardown(tools) {
     );
   }
 
-  // Remove the line that sources the safe-chain PowerShell initialization script
+  // Remove sourcing line to prevent shell from loading safe-chain after uninstallation
   removeLinesMatchingPattern(
     startupFile,
-    /^\.\s+["']?\$HOME[/\\].safe-chain[/\\]scripts[/\\]init-pwsh\.ps1["']?/,
+    /^\.\s+["']?.*init-pwsh\.ps1["']?.*#\s*Safe-chain/,
   );
 
   return true;
@@ -52,7 +54,7 @@ async function setup() {
 
   addLineToFile(
     startupFile,
-    `. "$HOME\\.safe-chain\\scripts\\init-pwsh.ps1" # Safe-chain PowerShell initialization script`,
+    `. "${path.join(getScriptsDir(), "init-pwsh.ps1")}" # Safe-chain PowerShell initialization script`,
   );
 
   return true;
@@ -74,7 +76,7 @@ function getStartupFile() {
 function getManualTeardownInstructions() {
   return [
     `Remove the following line from your PowerShell profile (run "echo $PROFILE" to find its location):`,
-    `  . "$HOME\\.safe-chain\\scripts\\init-pwsh.ps1"`,
+    `  . "${path.join(getScriptsDir(), "init-pwsh.ps1")}"`,
     `Then restart your terminal or run: . $PROFILE`,
   ];
 }
@@ -82,7 +84,7 @@ function getManualTeardownInstructions() {
 function getManualSetupInstructions() {
   return [
     `Add the following line to your PowerShell profile (run "echo $PROFILE" to find its location):`,
-    `  . "$HOME\\.safe-chain\\scripts\\init-pwsh.ps1"`,
+    `  . "${path.join(getScriptsDir(), "init-pwsh.ps1")}"`,
     `Then restart your terminal or run: . $PROFILE`,
   ];
 }

package/src/shell-integration/supported-shells/windowsPowershell.js

@@ -4,7 +4,9 @@ import {
   removeLinesMatchingPattern,
   validatePowerShellExecutionPolicy,
 } from "../helpers.js";
+import { getScriptsDir } from "../../config/safeChainDir.js";
 import { execSync } from "child_process";
+import path from "path";
 
 const shellName = "Windows PowerShell";
 const executableName = "powershell";
@@ -30,10 +32,10 @@ function teardown(tools) {
     );
   }
 
-  // Remove the line that sources the safe-chain PowerShell initialization script
+  // Remove sourcing line to clean up safe-chain integration from the shell profile
   removeLinesMatchingPattern(
     startupFile,
-    /^\.\s+["']?\$HOME[/\\].safe-chain[/\\]scripts[/\\]init-pwsh\.ps1["']?/,
+    /^\.\s+["']?.*init-pwsh\.ps1["']?.*#\s*Safe-chain/,
   );
 
   return true;
@@ -52,7 +54,7 @@ async function setup() {
 
   addLineToFile(
     startupFile,
-    `. "$HOME\\.safe-chain\\scripts\\init-pwsh.ps1" # Safe-chain PowerShell initialization script`,
+    `. "${path.join(getScriptsDir(), "init-pwsh.ps1")}" # Safe-chain PowerShell initialization script`,
   );
 
   return true;
@@ -74,7 +76,7 @@ function getStartupFile() {
 function getManualTeardownInstructions() {
   return [
     `Remove the following line from your PowerShell profile (run "echo $PROFILE" to find its location):`,
-    `  . "$HOME\\.safe-chain\\scripts\\init-pwsh.ps1"`,
+    `  . "${path.join(getScriptsDir(), "init-pwsh.ps1")}"`,
     `Then restart your terminal or run: . $PROFILE`,
   ];
 }
@@ -82,7 +84,7 @@ function getManualTeardownInstructions() {
 function getManualSetupInstructions() {
   return [
     `Add the following line to your PowerShell profile (run "echo $PROFILE" to find its location):`,
-    `  . "$HOME\\.safe-chain\\scripts\\init-pwsh.ps1"`,
+    `  . "${path.join(getScriptsDir(), "init-pwsh.ps1")}"`,
     `Then restart your terminal or run: . $PROFILE`,
   ];
 }

package/src/shell-integration/supported-shells/zsh.js

@@ -3,7 +3,9 @@ import {
   doesExecutableExistOnSystem,
   removeLinesMatchingPattern,
 } from "../helpers.js";
+import { getScriptsDir } from "../../config/safeChainDir.js";
 import { execSync } from "child_process";
+import path from "path";
 
 const shellName = "Zsh";
 const executableName = "zsh";
@@ -31,10 +33,10 @@ function teardown(tools) {
     );
   }
 
-  // Removes the line that sources the safe-chain zsh initialization script (~/.safe-chain/scripts/init-posix.sh)
+  // Remove sourcing line to complete shell integration cleanup
   removeLinesMatchingPattern(
     startupFile,
-    /^source\s+~\/\.safe-chain\/scripts\/init-posix\.sh/,
+    /^source\s+.*init-posix\.sh.*#\s*Safe-chain/,
     eol
   );
 
@@ -46,7 +48,7 @@ function setup() {
 
   addLineToFile(
     startupFile,
-    `source ~/.safe-chain/scripts/init-posix.sh # Safe-chain Zsh initialization script`,
+    `source ${path.join(getScriptsDir(), "init-posix.sh")} # Safe-chain Zsh initialization script`,
     eol
   );
 
@@ -69,7 +71,7 @@ function getStartupFile() {
 function getManualTeardownInstructions() {
   return [
     `Remove the following line from your ~/.zshrc file:`,
-    `  source ~/.safe-chain/scripts/init-posix.sh`,
+    `  source ${path.join(getScriptsDir(), "init-posix.sh")}`,
     `Then restart your terminal or run: source ~/.zshrc`,
   ];
 }
@@ -77,7 +79,7 @@ function getManualTeardownInstructions() {
 function getManualSetupInstructions() {
   return [
     `Add the following line to your ~/.zshrc file:`,
-    `  source ~/.safe-chain/scripts/init-posix.sh`,
+    `  source ${path.join(getScriptsDir(), "init-posix.sh")}`,
     `Then restart your terminal or run: source ~/.zshrc`,
   ];
 }

package/src/shell-integration/teardown.js

@@ -1,7 +1,8 @@
 import chalk from "chalk";
 import { ui } from "../environment/userInteraction.js";
 import { detectShells } from "./shellDetection.js";
-import { knownAikidoTools, getPackageManagerList, getShimsDir, getScriptsDir } from "./helpers.js";
+import { knownAikidoTools, getPackageManagerList } from "./helpers.js";
+import { getShimsDir, getScriptsDir } from "../config/safeChainDir.js";
 import fs from "fs";
 
 /**
@@ -109,4 +110,5 @@ export async function teardownDirectories() {
       );
     }
   }
+
 }

package/src/ultimate/ultimateTroubleshooting.js

@@ -1,111 +0,0 @@
-import { platform } from 'os';
-import { ui } from "../environment/userInteraction.js";
-import { readFileSync, existsSync } from "node:fs";
-import {randomUUID} from "node:crypto";
-import {createWriteStream} from "fs";
-import archiver from 'archiver';
-import path from "node:path";
-
-export async function printUltimateLogs() {
-  const { proxyLogPath, ultimateLogPath, proxyErrLogPath, ultimateErrLogPath } = getPathsPerPlatform();
-
-  await printLogs(
-    "SafeChain Proxy",
-    proxyLogPath,
-    proxyErrLogPath
-  );
-
-  await printLogs(
-    "SafeChain Ultimate",
-    ultimateLogPath,
-    ultimateErrLogPath
-  );
-}
-
-export async function troubleshootingExport() {
-  const { logDir } = getPathsPerPlatform();
-  return new Promise((resolve, reject) => {
-    if (!existsSync(logDir)) {
-      ui.writeError(`Log directory not found: ${logDir}`);
-      reject(new Error(`Log directory not found: ${logDir}`));
-      return;
-    }
-
-    const date = new Date().toISOString().split('T')[0];
-    const uuid = randomUUID();
-    const zipFileName = `safechain-ultimate-${date}-${uuid}.zip`;
-    const output = createWriteStream(zipFileName);
-    const archive = archiver('zip', { zlib: { level: 9 } });
-
-    output.on('close', () => {
-      ui.writeInformation(`Logs collected and zipped as: ${path.resolve(zipFileName)}`);
-      resolve(zipFileName);
-    });
-
-    archive.on('error', (/** @type {Error} */ err) => {
-      ui.writeError(`Failed to zip logs: ${err.message}`);
-      reject(err);
-    });
-
-    archive.pipe(output);
-    archive.directory(logDir, false);
-    archive.finalize();
-  });
-}
-
-
-function getPathsPerPlatform() {
-  const os = platform();
-  if (os === 'win32') {
-    const logDir = `C:\\ProgramData\\AikidoSecurity\\SafeChainUltimate\\logs`;
-    return {
-      logDir,
-      proxyLogPath: `${logDir}\\SafeChainProxy.log`,
-      ultimateLogPath: `${logDir}\\SafeChainUltimate.log`,
-      proxyErrLogPath: `${logDir}\\SafeChainProxy.err`,
-      ultimateErrLogPath: `${logDir}\\SafeChainUltimate.err`,
-    };
-  } else if (os === 'darwin') {
-    const logDir = `/Library/Logs/AikidoSecurity/SafeChainUltimate`;
-    return {
-      logDir,
-      proxyLogPath: `${logDir}/safechain-proxy.log`,
-      ultimateLogPath: `${logDir}/safechain-ultimate.log`,
-      proxyErrLogPath: `${logDir}/safechain-proxy.error.log`,
-      ultimateErrLogPath: `${logDir}/safechain-ultimate.error.log`,
-    };
-  } else {
-    throw new Error('Unsupported platform for log printing.');
-  }
-}
-
-/**
- * @param {string} appName
- * @param {string} logPath
- * @param {string} errLogPath
- */
-async function printLogs(appName, logPath, errLogPath) {
-  ui.writeInformation(`=== ${appName} Logs ===`);
-  try {
-    if (existsSync(logPath)) {
-      const logs = readFileSync(logPath, "utf-8");
-      ui.writeInformation(logs);
-    } else {
-      ui.writeWarning(`${appName} log file not found: ${logPath}`);
-    }
-  } catch (error) {
-    ui.writeError(`Failed to read ${appName} logs: ${error}`);
-  }
-
-  ui.writeInformation(`=== ${appName} Error Logs ===`);
-  try {
-    if (existsSync(errLogPath)) {
-      const errLogs = readFileSync(errLogPath, "utf-8");
-      ui.writeInformation(errLogs);
-    } else {
-      ui.writeInformation(`No error log file found for ${appName}.`);
-    }
-  } catch (error) {
-    ui.writeError(`Failed to read ${appName} error logs: ${error}`);
-  }
-}