feat: add supported for listening for ssh events

README.md

@@ -1296,6 +1296,36 @@ async function test() {
 test()
 ```
 
+## Events
+You can listen for any event [provided by SSH2](https://github.com/mscdex/ssh2#client) during an SSH session by passing `events` to `Connection options`
+
+For example:
+```ts
+try {
+  const client = await Client({
+    host: "server_ip",
+    port: 22,
+    username: "username",
+    tryKeyboard: true,
+    events: {
+      "keyboard-interactive": (
+        name,
+        instructions,
+        instructionsLang,
+        prompts,
+        finish
+      ) => {
+        finish(['my_password'])
+      },
+    },
+  });
+
+  client.close(); // remember to close connection after you finish
+} catch (e) {
+  console.log(e);
+}
+```
+
 ## Connection options
 Below are available options you can pass when connecting to server:
 * **agent** - _string_ - Path to ssh-agent's UNIX socket for ssh-agent-based user authentication. **Windows users: set to 'pageant' for authenticating with Pageant or (actual) path to a cygwin "UNIX socket."** **Default:** (none)
@@ -1485,5 +1515,7 @@ Below are available options you can pass when connecting to server:
 * **tryKeyboard** - _boolean_ - Try keyboard-interactive user authentication if primary user authentication method fails. If you set this to `true`, you need to handle the `keyboard-interactive` event. **Default:** `false`
 
 * **username** - _string_ - Username for authentication. **Default:** (none)
+
+* **events** - Object - List of events to listen to. **Default:** (none)
 # Support
 If you like this project, give me 1 ⭐️

package.json

@@ -2,7 +2,7 @@
   "name": "node-scp",
   "title": "SCP module for NodeJS",
   "description": "Lightweight, fast and secure SCP function for NodeJS",
-  "version": "0.0.22",
+  "version": "0.0.23",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",
   "license": "MIT",
@@ -35,13 +35,13 @@
     "release": "standard-version"
   },
   "dependencies": {
-    "ssh2": "^1.11.0"
+    "ssh2": "^1.14.0"
   },
   "devDependencies": {
     "@commitlint/cli": "^12.1.4",
     "@commitlint/config-conventional": "^12.1.4",
     "@types/node": "^16.0.1",
-    "@types/ssh2": "^1.11.5",
+    "@types/ssh2": "^1.11.13",
     "husky": "^7.0.1",
     "standard-version": "^9.3.0",
     "typescript": "^4.3.5"

src/constant.ts

@@ -1,10 +1,10 @@
- export enum errorCode {
-  generic = 'ERR_GENERIC_CLIENT',
-  connect = 'ERR_NOT_CONNECTED',
-  badPath = 'ERR_BAD_PATH',
-  permission = 'EACCES',
-  notexist = 'ENOENT',
-  notdir = 'ENOTDIR'
+export enum errorCode {
+  generic = "ERR_GENERIC_CLIENT",
+  connect = "ERR_NOT_CONNECTED",
+  badPath = "ERR_BAD_PATH",
+  permission = "EACCES",
+  notexist = "ENOENT",
+  notdir = "ENOTDIR",
 }
 
 export enum targetType {
@@ -13,5 +13,23 @@ export enum targetType {
   writeDir = 3,
   readDir = 4,
   readObj = 5,
-  writeObj = 6
-}
+  writeObj = 6,
+}
+
+export const CLIENT_EVENTS = new Set([
+  "banner",
+  "ready",
+  "tcp connection",
+  "x11",
+  "keyboard-interactive",
+  "change password",
+  "error",
+  "end",
+  "close",
+  "timeout",
+  "connect",
+  "greeting",
+  "handshake",
+  "hostkeys",
+  "unix connection",
+]);