Cache and reuse SSH passwords in the current session (#9654)

* Cache and reuse SSH passwords in the current session

Author: xisui-MSFT

Extension/src/Debugger/configurationProvider.ts

@@ -332,7 +332,12 @@ export class DebugConfigurationProvider implements vscode.DebugConfigurationProv
                 logger.getOutputChannelLogger().showErrorMessage(localize("vs.code.1.69+.required", "'deploySteps' require VS Code 1.69+."));
                 return undefined;
             }
-            const deploySucceeded: boolean = await this.deploySteps(config, token);
+
+            const deploySucceeded: boolean = await vscode.window.withProgress({
+                location: vscode.ProgressLocation.Notification,
+                title: localize("running.deploy.steps", "Running deploy steps...")
+            }, async () => this.deploySteps(config, token));
+
             if (!deploySucceeded || token?.isCancellationRequested) {
                 return undefined;
             }

Extension/src/SSH/commandInteractors.ts

@@ -4,7 +4,14 @@
  * ------------------------------------------------------------------------------------------ */
 
 import * as vscode from 'vscode';
-import { stripEscapeSequences, isWindows, escapeStringForRegex } from '../common';
+import { stripEscapeSequences, isWindows, escapeStringForRegex, ISshHostInfo, getFullHostAddress, extensionContext } from '../common';
+
+/**
+ * The users that we autofilled their passwords.
+ * If a user's password is already used and yet we still get the same prompt, we probably got a wrong password.
+ * Needs to be reset for each command.
+ */
+export const autoFilledPasswordForUsers: Set<string> = new Set<string>();
 
 export type IDifferingHostConfirmationProvider =
     (message: string, cancelToken?: vscode.CancellationToken) => Promise<string | undefined>;
@@ -208,7 +215,7 @@ function getPasswordPrompt(data: string, details?: IInteractorDataDetails): { us
 export class PasswordInteractor implements IInteractor {
     static ID = 'password';
 
-    constructor(private readonly passwordProvider: IStringProvider) { }
+    constructor(private readonly host: ISshHostInfo, private readonly passwordProvider: IStringProvider) { }
 
     get id(): string {
         return PasswordInteractor.ID;
@@ -219,12 +226,23 @@ export class PasswordInteractor implements IInteractor {
         const pwPrompt: { user?: string; message?: string } | undefined = getPasswordPrompt(data, extraDetails);
         if (pwPrompt && typeof pwPrompt.user === 'string') {
             result.postAction = 'consume';
-            const password: string | undefined = await this.passwordProvider(pwPrompt.user, pwPrompt.message, cancelToken);
-            if (typeof password === 'string') {
-                result.response = password;
+            const actualUser: string = pwPrompt.user === '' ? getFullHostAddress(this.host) : pwPrompt.user;
+            const passwordCacheKey: string = `SSH:${actualUser}`;
+            const cachedPassword: string | undefined = await extensionContext?.secrets?.get(passwordCacheKey);
+            if (cachedPassword !== undefined && !autoFilledPasswordForUsers.has(actualUser)) {
+                autoFilledPasswordForUsers.add(actualUser);
+                result.response = cachedPassword;
                 result.isPassword = true;
             } else {
-                result.canceled = true;
+                const password: string | undefined = await this.passwordProvider(pwPrompt.user, pwPrompt.message, cancelToken);
+                if (typeof password === 'string') {
+                    await extensionContext?.secrets?.store(passwordCacheKey, password);
+                    autoFilledPasswordForUsers.add(actualUser);
+                    result.response = password;
+                    result.isPassword = true;
+                } else {
+                    result.canceled = true;
+                }
             }
         }
 

Extension/src/SSH/commands.ts

@@ -5,7 +5,7 @@
 
 import * as vscode from 'vscode';
 import * as nls from 'vscode-nls';
-import { ISshHostInfo, ISshLocalForwardInfo, ProcessReturnType } from '../common';
+import { getFullHostAddress, getFullHostAddressNoPort, ISshHostInfo, ISshLocalForwardInfo, ProcessReturnType } from '../common';
 import { defaultSystemInteractor } from './commandInteractors';
 import { runSshTerminalCommandWithLogin } from './sshCommandRunner';
 
@@ -86,13 +86,3 @@ function localForwardToArgs(localForward: ISshLocalForwardInfo): string[] {
 
     return ['-L', arg];
 }
-
-/** user@host */
-function getFullHostAddressNoPort(host: ISshHostInfo): string {
-    return host.user ? `${host.user}@${host.hostName}` : `${host.hostName}`;
-}
-
-function getFullHostAddress(host: ISshHostInfo): string {
-    const fullHostName: string = getFullHostAddressNoPort(host);
-    return host.port ? `${fullHostName}:${host.port}` : fullHostName;
-}

Extension/src/SSH/sshCommandRunner.ts

@@ -18,7 +18,8 @@ import {
     TwoFacInteractor,
     ContinueOnInteractor,
     ISystemInteractor,
-    IInteraction
+    IInteraction,
+    autoFilledPasswordForUsers
 } from './commandInteractors';
 import { isWindows, ISshHostInfo, splitLines, stripEscapeSequences, ProcessReturnType } from '../common';
 import { getOutputChannelLogger } from '../logger';
@@ -194,12 +195,13 @@ export async function runSshTerminalCommandWithLogin(
     }
 
     if (!showLoginTerminal) {
+        autoFilledPasswordForUsers.clear();
         interactors.push(
             new MitmInteractor(),
             new FingerprintInteractor(host.hostName, showHostKeyConfirmation),
             new PassphraseInteractor(showPassphraseInputBox),
             new DifferingHostKeyInteractor(showDifferingHostConfirmation),
-            new PasswordInteractor(showPasswordInputBox),
+            new PasswordInteractor(host, showPasswordInputBox),
             new TwoFacInteractor(showVerificationCodeInputBox),
             new DuoTwoFacInteractor(showVerificationCodeInputBox)
         );

Extension/src/common.ts

@@ -1489,6 +1489,16 @@ export interface ISshHostInfo {
     port?: number | string;
 }
 
+/** user@host */
+export function getFullHostAddressNoPort(host: ISshHostInfo): string {
+    return host.user ? `${host.user}@${host.hostName}` : `${host.hostName}`;
+}
+
+export function getFullHostAddress(host: ISshHostInfo): string {
+    const fullHostName: string = getFullHostAddressNoPort(host);
+    return host.port ? `${fullHostName}:${host.port}` : fullHostName;
+}
+
 export interface ISshLocalForwardInfo {
     bindAddress?: string;
     port?: number | string;