ssh: Add verbose logging option

sedwards2009 · Jun 9, 2024 · 4b7def7 · 4b7def7
1 parent 41af283
commit 4b7def7
Show file tree

Hide file tree

Showing 3 changed files with 32 additions and 3 deletions.
diff --git a/extensions/SSHSessionBackend/src/SSHPty.ts b/extensions/SSHSessionBackend/src/SSHPty.ts
@@ -26,6 +26,7 @@ export interface PtyOptions {
   username: string;
   privateKeyFilenames?: string[];
   tryPasswordAuth: boolean;
+  verboseLogging?: boolean;
 }
 
 enum PtyState {
@@ -154,11 +155,19 @@ export class SSHPty implements Pty {
       });
     });
 
+    let debugFunction: ssh2.DebugFunction = undefined;
+    if (options.verboseLogging) {
+      debugFunction = (message: string): void => {
+        this.#onDataEventEmitter.fire(`ssh logging: ${message}\n\r`);
+      };
+    }
+
     this.#sshConnection.connect({
+      debug: debugFunction,
       host: options.host,
       port: options.port,
       username: options.username,
-      tryKeyboard: true,
+      tryKeyboard: false,
       authHandler: (
           methodsLeft: ssh2.AuthenticationType[],
           partialSuccess: boolean,

diff --git a/extensions/SSHSessionBackend/src/SSHSessionBackendExtension.ts b/extensions/SSHSessionBackend/src/SSHSessionBackendExtension.ts
@@ -26,6 +26,7 @@ interface SSHSessionConfiguration extends SessionConfiguration {
   username?: string;
   authenicationMethod?: AuthenticationMethod;
   keyFilePath?: string;
+  verboseLogging?: boolean;
 }
 
 class SSHBackend implements SessionBackend {
@@ -82,6 +83,7 @@ class SSHBackend implements SessionBackend {
       username: username,
       privateKeyFilenames,
       tryPasswordAuth,
+      verboseLogging: sessionConfig.verboseLogging,
     };
 
     return new SSHPty(this._log, options);
@@ -122,7 +124,10 @@ class SSHBackend implements SessionBackend {
   }
 }
 
+let log: Logger = null;
+
 export function activate(context: ExtensionContext): any {
+  log = context.logger;
   context.sessions.registerSessionBackend("ssh", new SSHBackend(context.logger));
 }
 

diff --git a/extensions/SSHSessionEditor/src/SSHSessionEditorExtension.ts b/extensions/SSHSessionEditor/src/SSHSessionEditorExtension.ts
@@ -5,7 +5,7 @@
  */
 import {ExtensionContext, Logger, SessionConfiguration, SessionEditorBase} from "@extraterm/extraterm-extension-api";
 import { Direction, FileMode, QFileDialog, QLineEdit, QPushButton, QWidget } from "@nodegui/nodegui";
-import { BoxLayout, ComboBox, GridLayout, LineEdit, SpinBox, Widget, PushButton } from "qt-construct";
+import { BoxLayout, ComboBox, GridLayout, LineEdit, SpinBox, Widget, PushButton, CheckBox } from "qt-construct";
 
 
 let log: Logger = null;
@@ -26,6 +26,7 @@ interface SSHSessionConfiguration extends SessionConfiguration {
   username?: string;
   authenicationMethod?: AuthenticationMethod;
   keyFilePath?: string;
+  verboseLogging?: boolean;
 }
 
 export function activate(context: ExtensionContext): any {
@@ -138,7 +139,16 @@ class EditorUi {
                 }
               ]
             })
-          })
+          }),
+
+          "",
+          CheckBox({
+            text: "Verbose logging",
+            checked: this.#config.verboseLogging ?? false,
+            onStateChanged: (enabled: number) => {
+              this.#handleVerboseLoggingChanged(enabled !== 0);
+            }
+          }),
         ]
       })
     });
@@ -168,6 +178,11 @@ class EditorUi {
     this.#sessionEditorBase.setSessionConfiguration(this.#config);
   }
 
+  #handleVerboseLoggingChanged(enabled: boolean): void {
+    this.#config.verboseLogging = enabled;
+    this.#sessionEditorBase.setSessionConfiguration(this.#config);
+  }
+
   getWidget(): QWidget {
     return this.#widget;
   }