From 00462913762dafbc032ad00a74109b7cdca265c8 Mon Sep 17 00:00:00 2001 From: bincxz <16399091+binaricat@users.noreply.github.com> Date: Sun, 12 Jul 2026 17:49:57 +0800 Subject: [PATCH] fix: honor SSH agent opt-out --- application/state/useApplicationBackend.ts | 9 +++++++-- components/HostDetailsPanel.tsx | 9 +++++++-- domain/sshAuth.test.ts | 11 +++++++++++ domain/sshAuth.ts | 4 +++- electron/bridges/portForwardingBridge.cjs | 1 + electron/bridges/sftpBridge/openConnection.cjs | 2 ++ electron/bridges/sshAuthHelper.cjs | 5 ++++- electron/bridges/sshAuthHelper.systemAgent.test.cjs | 11 +++++++++++ electron/bridges/sshBridge.cjs | 6 ++++-- electron/bridges/sshBridge/execCommand.cjs | 1 + electron/bridges/sshBridge/moshStatsConnection.cjs | 2 +- electron/bridges/sshBridge/startSession.cjs | 2 +- electron/preload/api.cjs | 4 ++-- types/global/netcatty-bridge-session.d.ts | 7 ++++++- 14 files changed, 61 insertions(+), 13 deletions(-) diff --git a/application/state/useApplicationBackend.ts b/application/state/useApplicationBackend.ts index b7b61dcd7..a94a0a27d 100644 --- a/application/state/useApplicationBackend.ts +++ b/application/state/useApplicationBackend.ts @@ -33,9 +33,14 @@ export const useApplicationBackend = () => { return info ?? null; }, []); - const checkSshAgent = useCallback(async (identityAgent?: string): Promise => { + const checkSshAgent = useCallback(async (options?: { + identityAgent?: string; + hostname?: string; + port?: number; + username?: string; + }): Promise => { const bridge = netcattyBridge.get(); - const status = await bridge?.checkSshAgent?.(identityAgent); + const status = await bridge?.checkSshAgent?.(options); return status ?? null; }, []); diff --git a/components/HostDetailsPanel.tsx b/components/HostDetailsPanel.tsx index 66ef4a61d..4f68dcfd1 100644 --- a/components/HostDetailsPanel.tsx +++ b/components/HostDetailsPanel.tsx @@ -189,11 +189,16 @@ const HostDetailsPanel: React.FC = ({ useEffect(() => { if (form.agentForwarding || form.useSshAgent) { - checkSshAgent(form.useSshAgent ? form.identityAgent : undefined).then(setSshAgentStatus); + checkSshAgent({ + identityAgent: form.useSshAgent ? form.identityAgent : undefined, + hostname: form.hostname, + port: form.port, + username: form.username, + }).then(setSshAgentStatus); } else { setSshAgentStatus(null); } - }, [form.agentForwarding, form.useSshAgent, form.identityAgent, checkSshAgent]); + }, [form.agentForwarding, form.useSshAgent, form.identityAgent, form.hostname, form.port, form.username, checkSshAgent]); const [groupInputValue, setGroupInputValue] = useState(form.group || ""); diff --git a/domain/sshAuth.test.ts b/domain/sshAuth.test.ts index dac056ca1..58c759b14 100644 --- a/domain/sshAuth.test.ts +++ b/domain/sshAuth.test.ts @@ -107,6 +107,17 @@ test("resolveBridgeSshAgentAuth keeps certificate authentication independent", ( ); }); +test("resolveBridgeSshAgentAuth preserves an explicit agent opt-out", () => { + assert.deepEqual( + resolveBridgeSshAgentAuth({ + ...autofillBaseHost, + useSshAgent: false, + identityAgent: "none", + }), + { useSshAgent: false }, + ); +}); + test("hasBridgeSshCredentials accepts an agent-only host", () => { assert.equal(hasBridgeSshCredentials({ useSshAgent: true }), true); assert.equal(hasBridgeSshCredentials({}), false); diff --git a/domain/sshAuth.ts b/domain/sshAuth.ts index 3407798c8..164cf4041 100644 --- a/domain/sshAuth.ts +++ b/domain/sshAuth.ts @@ -149,7 +149,9 @@ export const resolveBridgeSshAgentAuth = ( addKeysToAgent?: string; useKeychain?: boolean; } => { - if (host.useSshAgent !== true || Boolean(certificate?.trim())) return {}; + if (certificate?.trim()) return {}; + if (host.useSshAgent === false) return { useSshAgent: false }; + if (host.useSshAgent !== true) return {}; return { useSshAgent: true, identityAgent: host.identityAgent, diff --git a/electron/bridges/portForwardingBridge.cjs b/electron/bridges/portForwardingBridge.cjs index 0949c63d4..04bca9a46 100644 --- a/electron/bridges/portForwardingBridge.cjs +++ b/electron/bridges/portForwardingBridge.cjs @@ -258,6 +258,7 @@ async function startPortForward(event, payload) { username: connectOpts.username, logPrefix: "[PortForward]", defaultKeys, + allowAgentFallback: useSshAgent !== false, }); applyAuthToConnOpts(connectOpts, authConfig); if (isTunnelCancelled(tunnelState)) { diff --git a/electron/bridges/sftpBridge/openConnection.cjs b/electron/bridges/sftpBridge/openConnection.cjs index 4d0dd8b04..a7d838a79 100644 --- a/electron/bridges/sftpBridge/openConnection.cjs +++ b/electron/bridges/sftpBridge/openConnection.cjs @@ -193,6 +193,7 @@ function createOpenConnectionApi(ctx) { unlockedEncryptedKeys: options._unlockedEncryptedKeys || [], defaultKeys, sshAgentSocketOverride: defaultAgentSocket, + allowAgentFallback: jump.useSshAgent !== false, onAuthAttempt: (method) => { sendSftpProgress(sender, connId, hopLabel, 'auth-attempt', method); }, @@ -859,6 +860,7 @@ function createOpenConnectionApi(ctx) { logPrefix: "[SFTP]", defaultKeys: systemAuthAgent && options.identitiesOnly ? [] : defaultKeys, sshAgentSocketOverride: agentSocket, + allowAgentFallback: options.useSshAgent !== false, onAuthAttempt: (method) => { sendSftpProgress(event.sender, connId, options.hostname, 'auth-attempt', method); }, diff --git a/electron/bridges/sshAuthHelper.cjs b/electron/bridges/sshAuthHelper.cjs index 25a6b3c7a..3030855c2 100644 --- a/electron/bridges/sshAuthHelper.cjs +++ b/electron/bridges/sshAuthHelper.cjs @@ -831,6 +831,7 @@ function isPasswordProvided(password) { */ function buildAuthHandler(options) { const { privateKey, password, passphrase, agent, username, logPrefix = "[SSH]", unlockedEncryptedKeys = [], defaultKeys = [], sshAgentSocketOverride, onAuthAttempt } = options; + const allowAgentFallback = options.allowAgentFallback !== false; // Determine what type of explicit auth the user configured const hasExplicitKey = !!privateKey; @@ -845,7 +846,9 @@ function buildAuthHandler(options) { // Allow callers to pass in a pre-validated agent socket (e.g. from async // getAvailableAgentSocket). Fall back to synchronous getSshAgentSocket() // which on Windows always returns the pipe path without checking the service. - const sshAgentSocket = sshAgentSocketOverride !== undefined ? sshAgentSocketOverride : getSshAgentSocket(); + const sshAgentSocket = allowAgentFallback + ? (sshAgentSocketOverride !== undefined ? sshAgentSocketOverride : getSshAgentSocket()) + : null; // Only use system ssh-agent BEFORE user's auth when: // - User explicitly configured agent, OR diff --git a/electron/bridges/sshAuthHelper.systemAgent.test.cjs b/electron/bridges/sshAuthHelper.systemAgent.test.cjs index b5860cf15..9a1bf256a 100644 --- a/electron/bridges/sshAuthHelper.systemAgent.test.cjs +++ b/electron/bridges/sshAuthHelper.systemAgent.test.cjs @@ -9,6 +9,7 @@ const path = require("node:path"); const { Duplex } = require("node:stream"); const { + buildAuthHandler, getAvailableAgentSocket, getNativeOpenSshAgentSocket, cygwinAgentConnectable, @@ -18,6 +19,16 @@ const { resolveIdentityAgentPath, } = require("./sshAuthHelper.cjs"); +test("explicit agent opt-out suppresses automatic socket fallback", () => { + const auth = buildAuthHandler({ + username: "deploy", + allowAgentFallback: false, + sshAgentSocketOverride: "/tmp/agent.sock", + }); + + assert.equal(auth.agent, null); +}); + test("IdentityAgent paths expand standard OpenSSH connection tokens", () => { const resolved = resolveIdentityAgentPath( "%d/.ssh/agent-%h-%p-%r-%u-%l-%L-%i-%%-%C.sock", diff --git a/electron/bridges/sshBridge.cjs b/electron/bridges/sshBridge.cjs index 87ede8a67..4ffad44b3 100644 --- a/electron/bridges/sshBridge.cjs +++ b/electron/bridges/sshBridge.cjs @@ -707,6 +707,7 @@ async function connectThroughChain(event, options, jumpHosts, targetHost, target logPrefix: `[Chain] Hop ${i + 1}`, unlockedEncryptedKeys: options._unlockedEncryptedKeys || [], defaultKeys, + allowAgentFallback: jump.useSshAgent !== false, onAuthAttempt: (method) => { sendProgress(i + 1, totalHops + 1, hopLabel, 'auth-attempt', method); }, @@ -1292,11 +1293,12 @@ function registerHandlers(ipcMain, options = {}) { ipcMain.handle("netcatty:key:generate", generateKeyPair); ipcMain.handle("netcatty:sshDebugLog:info", getSshDebugLogInfo); ipcMain.handle("netcatty:sshDebugLog:openDir", openSshDebugLogDir); - ipcMain.handle("netcatty:ssh:check-agent", async (_event, identityAgent) => { + ipcMain.handle("netcatty:ssh:check-agent", async (_event, options = {}) => { + const identityAgent = typeof options === "string" ? options : options.identityAgent; if (process.platform === "win32" && !identityAgent) { return await checkWindowsSshAgent(); } - const socketPath = await getAvailableSystemAgentSocket(identityAgent); + const socketPath = await getAvailableSystemAgentSocket(identityAgent, typeof options === "string" ? {} : options); return { running: Boolean(socketPath), startupType: socketPath ? "running" : "stopped", diff --git a/electron/bridges/sshBridge/execCommand.cjs b/electron/bridges/sshBridge/execCommand.cjs index 9253a4f24..2fc1e1147 100644 --- a/electron/bridges/sshBridge/execCommand.cjs +++ b/electron/bridges/sshBridge/execCommand.cjs @@ -191,6 +191,7 @@ function createExecCommandApi(ctx) { username: connectOpts.username, logPrefix: "[SSH Exec]", defaultKeys, + allowAgentFallback: payload.useSshAgent !== false, }); applyAuthToConnOpts(connectOpts, authConfig); diff --git a/electron/bridges/sshBridge/moshStatsConnection.cjs b/electron/bridges/sshBridge/moshStatsConnection.cjs index ba4cca4b6..967144a8f 100644 --- a/electron/bridges/sshBridge/moshStatsConnection.cjs +++ b/electron/bridges/sshBridge/moshStatsConnection.cjs @@ -257,7 +257,7 @@ function createMoshStatsConnectionApi(ctx) { // any saved password (ssh2 tries agent before password), so a // public-key host that also happens to have a stored password still // authenticates via the agent instead of failing on password-only. - if (!connectOpts.agent && !agent && !connectOpts.privateKey) { + if (auth.useSshAgent !== false && !connectOpts.agent && !agent && !connectOpts.privateKey) { const agentSocket = getSshAgentSocket(auth.identityAgent); if (agentSocket) { connectOpts.agent = agentSocket; diff --git a/electron/bridges/sshBridge/startSession.cjs b/electron/bridges/sshBridge/startSession.cjs index 6bb94522c..64b75ca33 100644 --- a/electron/bridges/sshBridge/startSession.cjs +++ b/electron/bridges/sshBridge/startSession.cjs @@ -778,7 +778,7 @@ function createStartSessionApi(ctx) { // If no primary auth method configured, try ssh-agent first, then ALL default keys. // Skip default-key primaries when the user explicitly chose a key (inline or // identityFilePaths) even if loading that key failed (issue #1614). - if (!connectOpts.privateKey && !connectOpts.password && !connectOpts.agent) { + if (options.useSshAgent !== false && !connectOpts.privateKey && !connectOpts.password && !connectOpts.agent) { // First, try to use ssh-agent if available (this is what regular SSH does) const sshAgentSocket = await getAvailableAgentSocket(); diff --git a/electron/preload/api.cjs b/electron/preload/api.cjs index 9fde8da01..6d877898a 100644 --- a/electron/preload/api.cjs +++ b/electron/preload/api.cjs @@ -231,8 +231,8 @@ function createPreloadApi(ctx) { generateKeyPair: async (options) => { return ipcRenderer.invoke("netcatty:key:generate", options); }, - checkSshAgent: async (identityAgent) => { - return ipcRenderer.invoke("netcatty:ssh:check-agent", identityAgent); + checkSshAgent: async (options) => { + return ipcRenderer.invoke("netcatty:ssh:check-agent", options); }, getDefaultKeys: async () => { return ipcRenderer.invoke("netcatty:ssh:get-default-keys"); diff --git a/types/global/netcatty-bridge-session.d.ts b/types/global/netcatty-bridge-session.d.ts index f66bb08b7..181c5059b 100644 --- a/types/global/netcatty-bridge-session.d.ts +++ b/types/global/netcatty-bridge-session.d.ts @@ -163,7 +163,12 @@ declare global { bits?: number; comment?: string; }): Promise<{ success: boolean; privateKey?: string; publicKey?: string; error?: string }>; - checkSshAgent?(identityAgent?: string): Promise<{ running: boolean; startupType: string | null; error: string | null }>; + checkSshAgent?(options?: { + identityAgent?: string; + hostname?: string; + port?: number; + username?: string; + }): Promise<{ running: boolean; startupType: string | null; error: string | null }>; getDefaultKeys?(): Promise>; execCommand(options: { hostname: string;