Support connections over SSH (#1447)

* Add SSH connection settings and options to IConnection interface

* Add SSH tunneling support to AbstractDriver class

* Bump base-driver version to 0.2.0

* Update README.md to include changelog for SSH tunneling support

Author: d-mato

packages/base-driver/README.md

@@ -12,6 +12,10 @@ Inactive icon: Opacity 50%, no margins and paddings
 
 ## Changelog
 
+### v0.2.0
+
+- Added SSH tunneling support.
+
 ### v0.1.11
 
 - Fix `toAbsolutePath` for Windows by using `vscode-uri`.

packages/base-driver/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sqltools/base-driver",
-  "version": "0.1.11",
+  "version": "0.2.0",
   "description": "SQLTools Base Driver",
   "publishConfig": {
     "access": "public",
@@ -45,6 +45,7 @@
     "env-paths": "^2.2.0",
     "make-dir": "^3.1.0",
     "resolve": "^1.17.0",
+    "tunnel-ssh": "^5.2.0",
     "vscode-languageserver": "6.1.1"
   }
 }

packages/base-driver/src/index.ts

@@ -16,7 +16,9 @@ import sqltoolsRequire, { sqltoolsResolve } from './lib/require';
 import { createLogger } from '@sqltools/log';
 import path from 'path';
 import fs from 'fs';
-import {URI} from 'vscode-uri';
+import { URI } from 'vscode-uri';
+import { createTunnel } from 'tunnel-ssh';
+import { AddressInfo } from 'net';
 
 export default abstract class AbstractDriver<ConnectionType extends any, DriverOptions extends any> implements IConnectionDriver {
   public log: ReturnType<typeof createLogger>;
@@ -129,6 +131,41 @@ export default abstract class AbstractDriver<ConnectionType extends any, DriverO
     return { message: message.toString(), date: new Date() };
   }
 
+  protected async createSshTunnel(
+    ssh: {
+      host: string;
+      port: number;
+      username: string;
+      password?: string;
+      privateKeyPath?: string;
+    },
+    db: {
+      host: string;
+      port: number;
+    }
+  ) {
+    const [sshTunnel] = await createTunnel(
+      {
+        autoClose: true,
+        reconnectOnError: false,
+      },
+      null,
+      {
+        host: ssh.host,
+        port: ssh.port,
+        username: ssh.username,
+        privateKey: fs.readFileSync(ssh.privateKeyPath),
+      },
+      {
+        dstAddr: db.host,
+        dstPort: db.port,
+      }
+    );
+    return {
+      port: (sshTunnel.address() as AddressInfo).port,
+    };
+  }
+
   static readonly CONSTANTS = {
     DEPENDENCY_PACKAGE: 'package' as NodeDependency['type'],
     DEPENDENCY_NPM_SCRIPT: 'npmscript' as NodeDependency['type'],

packages/types/index.d.ts

@@ -200,6 +200,58 @@ export interface IConnection<DriverOptions = any> {
     [key: string]: string
   }
 
+  /**
+   * SSH connection setting, 'Enabled' or 'Disabled'
+   * @type {string}
+   * @default "Disabled"
+   * @memberof IConnection
+   */
+  ssh?: 'Enabled' | 'Disabled';
+  
+  /**
+   * SSH connection options. Required when ssh is 'Enabled'
+   * @type {object}
+   * @memberof IConnection
+   */
+  sshOptions?: {
+    /**
+     * SSH server address
+     * @type {string}
+     * @memberof IConnection.sshOptions
+     */
+    host: string;
+    
+    /**
+     * SSH port
+     * @type {number}
+     * @default 22
+     * @memberof IConnection.sshOptions
+     */
+    port: number;
+    
+    /**
+     * SSH username
+     * @type {string}
+     * @memberof IConnection.sshOptions
+     */
+    username: string;
+    
+    /**
+     * SSH password. You can use option askForPassword to prompt password before connect
+     * @type {string}
+     * @default null
+     * @memberof IConnection.sshOptions
+     */
+    password?: string;
+    
+    /**
+     * Path to private key file
+     * @type {string}
+     * @memberof IConnection.sshOptions
+     */
+    privateKeyPath?: string;
+  };
+
   // WONT BE INCLUDED IN SETTINGS
   /**
   * Connection flag. This is not a setting. It is determined at runtime

yarn.lock

@@ -1844,7 +1844,7 @@
   dependencies:
     "@sinonjs/commons" "^1.7.0"
 
-"@sqltools/base-driver@latest":
+"@sqltools/base-driver@^0.1.11", "@sqltools/base-driver@latest":
   version "0.1.11"
   resolved "https://registry.npmjs.org/@sqltools/base-driver/-/base-driver-0.1.11.tgz"
   integrity sha512-HvmblI2MbdZUkDGIjU87FTiE/Q1NfIM6SFQJGbg5Y2vCHQ8mkUnU8QS+ANbeq3YChDpjLH+b3EHq4zdavIGk5Q==
@@ -2411,6 +2411,13 @@ asap@~2.0.6:
   resolved "https://registry.npmjs.org/asap/-/asap-2.0.6.tgz"
   integrity sha1-5QNHYR1+aQlDIIu9r+vLwvuGbUY=
 
+asn1@^0.2.6:
+  version "0.2.6"
+  resolved "https://registry.yarnpkg.com/asn1/-/asn1-0.2.6.tgz#0d3a7bb6e64e02a90c0303b31f292868ea09a08d"
+  integrity sha512-ix/FxPn0MDjeyJ7i/yoHGFt/EX6LyNbxSEhPPXODPL+KB0VPk86UYfL0lMdy+KCnv+fmvIzySwaK5COwqVbWTQ==
+  dependencies:
+    safer-buffer "~2.1.0"
+
 asn1@~0.2.3:
   version "0.2.4"
   resolved "https://registry.npmjs.org/asn1/-/asn1-0.2.4.tgz"
@@ -2591,7 +2598,7 @@ base@^0.11.1:
     mixin-deep "^1.2.0"
     pascalcase "^0.1.1"
 
-bcrypt-pbkdf@^1.0.0:
+bcrypt-pbkdf@^1.0.0, bcrypt-pbkdf@^1.0.2:
   version "1.0.2"
   resolved "https://registry.npmjs.org/bcrypt-pbkdf/-/bcrypt-pbkdf-1.0.2.tgz"
   integrity sha1-pDAdOJtqQ/m2f/PKEaP2Y342Dp4=
@@ -2753,6 +2760,11 @@ buffers@~0.1.1:
   resolved "https://registry.npmjs.org/buffers/-/buffers-0.1.1.tgz"
   integrity sha1-skV5w77U1tOWru5tmorn9Ugqt7s=
 
+buildcheck@~0.0.6:
+  version "0.0.6"
+  resolved "https://registry.yarnpkg.com/buildcheck/-/buildcheck-0.0.6.tgz#89aa6e417cfd1e2196e3f8fe915eb709d2fe4238"
+  integrity sha512-8f9ZJCUXyT1M35Jx7MkBgmBMo3oHTTBIPLiY9xyL0pl3T5RwcPEY8cUHr5LBNfu/fk6c2T4DJZuVM/8ZZT2D2A==
+
 cacache@^15.2.0:
   version "15.3.0"
   resolved "https://registry.yarnpkg.com/cacache/-/cacache-15.3.0.tgz#dc85380fb2f556fe3dda4c719bfa0ec875a7f1eb"
@@ -3170,6 +3182,14 @@ [email protected], core-util-is@~1.0.0:
   resolved "https://registry.npmjs.org/core-util-is/-/core-util-is-1.0.2.tgz"
   integrity sha1-tf1UIgqivFq1eqtxQMlAdUUDwac=
 
+cpu-features@~0.0.10:
+  version "0.0.10"
+  resolved "https://registry.yarnpkg.com/cpu-features/-/cpu-features-0.0.10.tgz#9aae536db2710c7254d7ed67cb3cbc7d29ad79c5"
+  integrity sha512-9IkYqtX3YHPCzoVg1Py+o9057a3i0fp7S530UWokCSaFVTc7CwXPRiOjRjBQQ18ZCNafx78YfnG+HALxtVmOGA==
+  dependencies:
+    buildcheck "~0.0.6"
+    nan "^2.19.0"
+
 create-require@^1.1.0:
   version "1.1.1"
   resolved "https://registry.npmjs.org/create-require/-/create-require-1.1.1.tgz"
@@ -6311,6 +6331,11 @@ nan@^2.12.1:
   resolved "https://registry.yarnpkg.com/nan/-/nan-2.17.0.tgz#c0150a2368a182f033e9aa5195ec76ea41a199cb"
   integrity sha512-2ZTgtl0nJsO0KQCjEpxcIr5D+Yv90plTitZt9JBfQvVJDS5seMl3FOvsh3+9CoYWXf/1l5OaZzzF6nDm4cagaQ==
 
+nan@^2.19.0, nan@^2.20.0:
+  version "2.22.2"
+  resolved "https://registry.yarnpkg.com/nan/-/nan-2.22.2.tgz#6b504fd029fb8f38c0990e52ad5c26772fdacfbb"
+  integrity sha512-DANghxFkS1plDdRsX0X9pm0Z6SJNN6gBdtXfanwoZ8hooC5gosGFSBGRYHUVPz1asKA/kMRqDRdHrluZ61SpBQ==
+
 nanoid@^2.1.0:
   version "2.1.11"
   resolved "https://registry.npmjs.org/nanoid/-/nanoid-2.1.11.tgz"
@@ -7907,6 +7932,17 @@ sqlstring@^2.3.2:
   resolved "https://registry.yarnpkg.com/sqlstring/-/sqlstring-2.3.3.tgz#2ddc21f03bce2c387ed60680e739922c65751d0c"
   integrity sha512-qC9iz2FlN7DQl3+wjwn3802RTyjCx7sDvfQEXchwa6CWOx07/WVfh91gBmQ9fahw8snwGEWU3xGzOt4tFyHLxg==
 
+ssh2@^1.15.0:
+  version "1.16.0"
+  resolved "https://registry.yarnpkg.com/ssh2/-/ssh2-1.16.0.tgz#79221d40cbf4d03d07fe881149de0a9de928c9f0"
+  integrity sha512-r1X4KsBGedJqo7h8F5c4Ybpcr5RjyP+aWIG007uBPRjmdQWfEiVLzSK71Zji1B9sKxwaCvD8y8cwSkYrlLiRRg==
+  dependencies:
+    asn1 "^0.2.6"
+    bcrypt-pbkdf "^1.0.2"
+  optionalDependencies:
+    cpu-features "~0.0.10"
+    nan "^2.20.0"
+
 sshpk@^1.7.0:
   version "1.16.1"
   resolved "https://registry.npmjs.org/sshpk/-/sshpk-1.16.1.tgz"
@@ -8349,6 +8385,13 @@ tunnel-agent@^0.6.0:
   dependencies:
     safe-buffer "^5.0.1"
 
+tunnel-ssh@^5.2.0:
+  version "5.2.0"
+  resolved "https://registry.yarnpkg.com/tunnel-ssh/-/tunnel-ssh-5.2.0.tgz#199df96b07f1fa833d578e47a5801da4af065b2a"
+  integrity sha512-IGiyhE2RSt3NVvZ7aKH3ykziAxKNPe/z97Rab/lrIXslif/cq7J/m6EXfERlDITiFyGGYMqqi5SSrt/mk1VbEg==
+  dependencies:
+    ssh2 "^1.15.0"
+
 [email protected]:
   version "0.0.6"
   resolved "https://registry.yarnpkg.com/tunnel/-/tunnel-0.0.6.tgz#72f1314b34a5b192db012324df2cc587ca47f92c"