Ssh port fowarding (#23)

* support ssh portfowrding

* update README

* enable to set config value from environment variable

Author: joe-re

README.md

@@ -60,29 +60,79 @@ $ sql-language-server up --method stdio
 {
   "adapter": "mysql",
   "host": "localhost",
-  "port": 3306,
+  "port": 3307,
   "user": "username",
   "password": "password",
-  "database": "mysql-development"
+  "database": "mysql-development",
+  "ssh": {
+    "user": "ubuntu",
+    "remoteHost": "ec2-xxx-xxx-xxx-xxx.ap-southeast-1.compute.amazonaws.com",
+    "dbHost": "127.0.0.1",
+    "port": 3306,
+    "identityFile": "~/.ssh/id_rsa",
+    "passphrase": "123456"
+  }
 }
 ```
 
-- Details
-  - adapter: "mysql" | "postgres"
-  - host: string
-  - port: number
-  - user: string
-  - password: string
-  - database: string
-
 Please restart sql-language-server process after create .sqlrc.json.
 
+#### Parameters
+
+| Key      | Description                 | value                   | required | default                           |
+| -------- | --------------------------- | ----------------------- | -------- | --------------------------------- |
+| adapter  | Database type               | `"mysql" | "postgres"`  | true     |                                   |
+| host     | Database host               | string                  | true     |                                   |
+| port     | Database port               | string                  | false    | mysql:3306, postgres:5432         |
+| user     | Database user               | string                  | true     | mysql:"root", postgres:"postgres" |
+| password | Database password           | string                  | false    |                                   |
+| database | Database name               | string                  | false    |                                   |
+| ssh      | Settings for port fowarding | \*see below SSH section | false    |                                   |
+
+##### SSH
+
+| Key          | Description                              | value  | required | default                   |
+| ------------ | ---------------------------------------- | ------ | -------- | ------------------------- |
+| remoteHost   | The host address you want to connect to  | string | true     |                           |
+| remotePort   | Port number of the server for ssh        | number | false    | 22                        |
+| user         | User name on the server                  | string | false    |                           |
+| dbHost       | Database host on the server              | string | false    | 127.0.0.1                 |
+| dbPort       | Databse port on the server               | number | false    | mysql:3306, postgres:5432 |
+| identitiFile | Identity file for ssh                    | string | false    | ~/.ssh/config/id_rsa      |
+| passphrase   | Passphrase to allow to use identity file | string | false    |                           |
+
+#### Inject envitonment variables
+
+${ssm:VARIABLE_NAME} syntax allows you to replace configuration value with environt variable.
+This is useful when you don't write actual file on configuration file.
+
+##### example
+
+```json
+{
+  "adapter": "mysql",
+  "host": "localhost",
+  "port": 3307,
+  "user": "username",
+  "password": "${env:DB_PASSWORD}",
+  "database": "mysql-development",
+  "ssh": {
+    "user": "ubuntu",
+    "remoteHost": "ec2-xxx-xxx-xxx-xxx.ap-southeast-1.compute.amazonaws.com",
+    "dbHost": "127.0.0.1",
+    "port": 3306,
+    "identityFile": "~/.ssh/id_rsa",
+    "passphrase": "${env:SSH_PASSPHRASE}"
+  }
+}
+```
+
 ### TODO
 
 - [x] SELECT
 - [x] INSERT
 - [x] UPDATE
 - [x] DELETE
+- [x] ssh port forwarding
 - [ ] Beautify
 - [ ] Lint
-- [ ] ssh port forwarding

packages/server/SettingStore.ts

@@ -4,13 +4,23 @@ import EventEmitter from 'events'
 
 const logger = log4js.getLogger()
 
+export type SSHConfig = {
+  remoteHost: string
+  remotePort?: number
+  dbHost?: string
+  dbPort?: number
+  user?: string
+  passphrase?: string
+  identityFile?: string
+}
 export type Settings = {
   adapter: 'mysql' | 'postgresql',
   host: string | null,
   port: number | null,
   user: string | null,
   database: string | null,
-  password: string | null
+  password: string | null,
+  ssh: SSHConfig | null
 }
 
 export default class SettingStore extends EventEmitter {
@@ -20,7 +30,8 @@ export default class SettingStore extends EventEmitter {
     port: null,
     user: null,
     database: null,
-    password: null
+    password: null,
+    ssh: null
   }
   private static instance: SettingStore;
 
@@ -68,7 +79,22 @@ export default class SettingStore extends EventEmitter {
   }
 
   setSetting(setting: Partial<Settings>) {
-    this.state = Object.assign({}, this.state, setting)
+    const replaceEnv = (v: { [key: string]: any }) => {
+      for (const k in v) {
+        if (v[k] && typeof v[k] === 'object') {
+          replaceEnv(v[k])
+        } else if (typeof v[k] === 'string') {
+          const matched = (v[k] as string).match(/\${env:(.*?)}/)
+          if (matched) {
+            v[k] = (v[k] as string).replace(`\${env:${matched[1]}}`, process.env[matched[1]] || '')
+          }
+        }
+      }
+    }
+    const newSetting = Object.assign({}, setting)
+    newSetting.ssh = newSetting.ssh ? Object.assign({}, newSetting.ssh) : null
+    replaceEnv(newSetting)
+    this.state = Object.assign({}, this.state, newSetting)
     this.emit('change', this.state)
   }
 }

packages/server/database_libs/AbstractClient.ts

@@ -1,5 +1,7 @@
 import { Settings } from '../SettingStore'
 import log4js from 'log4js';
+import { SSHConnection } from 'node-ssh-forward'
+import { readFileSync } from 'fs'
 
 const logger = log4js.getLogger()
 
@@ -29,11 +31,34 @@ export default abstract class AbstractClient {
   abstract disconnect(): void
   abstract getTables(): Promise<string[]>
   abstract getColumns(tableName: string): Promise<RawField[]>
+  abstract DefaultPort: number
+  abstract DefaultHost: string
+  abstract DefaultUser: string
 
   async getSchema(): Promise<Schema> {
     let schema: Schema = []
+    const sshConnection =
+      this.settings.ssh ? new SSHConnection({
+        endHost: this.settings.ssh.remoteHost,
+        username: this.settings.ssh.user,
+        privateKey: readFileSync(this.settings.ssh.identityFile || `${process.env.HOME}/.ssh/id_rsa`),
+        passphrase: this.settings.ssh.passphrase || ''
+      }) : null
+    if (sshConnection) {
+      await sshConnection.forward({
+        fromPort: this.settings.port || this.DefaultPort,
+        toPort: this.settings.ssh?.dbPort || this.DefaultPort,
+        toHost: this.settings.ssh?.dbHost || '127.0.0.1'
+      }).then(v => {
+        if (v) {
+          logger.error('Failed to ssh remote server')
+          logger.error(v)
+        }
+        return []
+      })
+    }
+    this.connect()
     try {
-      this.connect()
       const tables = await this.getTables()
       schema = await Promise.all(
         tables.map((v) => this.getColumns(v).then(columns => ({
@@ -42,11 +67,14 @@ export default abstract class AbstractClient {
           columns: columns.map(v => this.toColumnFromRawField(v)) }
         )))
       )
-      this.disconnect()
     } catch (e) {
-      this.disconnect()
       logger.error(e)
       throw e
+    } finally {
+      this.disconnect()
+      if (sshConnection) {
+        sshConnection.shutdown()
+      }
     }
     return schema
   }

packages/server/database_libs/MysqlClient.ts

@@ -9,13 +9,17 @@ export default class MysqlClient extends AbstractClient {
     super(settings)
   }
 
+  get DefaultPort() { return 3306 }
+  get DefaultHost() { return '127.0.0.1' }
+  get DefaultUser() { return 'root' }
+
   connect() {
     this.connection = mysql.createConnection({
-      host: this.settings.host || 'localhost',
+      host: this.settings.host || this.DefaultHost,
       password: this.settings.password || '',
-      user: this.settings.user || 'root',
-      port: this.settings.port || 3306,
-      database: this.settings.database || undefined
+      user: this.settings.user || this.DefaultUser,
+      port: this.settings.port || this.DefaultPort,
+      database: this.settings.database || ''
     })
   }
 

packages/server/database_libs/PostgresClient.ts

@@ -9,6 +9,10 @@ export default class PosgresClient extends AbstractClient {
     super(settings)
   }
 
+  get DefaultPort() { return 5432 }
+  get DefaultHost() { return '127.0.0.1' }
+  get DefaultUser() { return 'postgres' }
+
   connect() {
     const client: PG.Client = new PG.Client({
       user: this.settings.user || '',

packages/server/package.json

@@ -22,6 +22,7 @@
     "jest": "^26.0.1",
     "log4js": "^6.2.1",
     "mysql": "^2.15.0",
+    "node-ssh-forward": "^0.6.3",
     "pg": "^7.4.3",
     "vscode-languageclient": "^6.1.3",
     "vscode-languageserver": "^4.1.2",

packages/server/test/settingStore.test.ts

@@ -0,0 +1,38 @@
+import SettingStore from "../SettingStore"
+
+describe('setSetting', () => {
+  beforeAll(() => {
+    process.env.setSetting_DB_PASSWORD="replacedPassWord"
+    process.env.setSetting_SSH_PASSPHRASE="replacedPassphrase"
+  })
+  afterAll(() => {
+    process.env.setSetting_DB_PASSWORD=""
+    process.env.setSetting_SSH_PASSPHRASE=""
+  })
+  it('should replace ${env:VARIABLE_NAME} syntax with environment variable', () => {
+    const setting = {
+      "adapter": 'mysql' as 'mysql',
+      "host": "localhost",
+      "port": 3307,
+      "user": "username",
+      "password": "${env:setSetting_DB_PASSWORD}",
+      "database": "mysql-development",
+      "ssh": {
+        "user": "ubuntu",
+        "remoteHost": "ec2-xxx-xxx-xxx-xxx.ap-southeast-1.compute.amazonaws.com",
+        "dbHost": "127.0.0.1",
+        "port": 3306,
+        "identityFile": "~/.ssh/id_rsa",
+        "passphrase": "${env:setSetting_SSH_PASSPHRASE}"
+      }
+    }
+    const store = SettingStore.getInstance()
+    store.setSetting(setting)
+    expect(store.getSetting()).toMatchObject({
+      "password": "replacedPassWord",
+      "ssh": {
+        "passphrase": "replacedPassphrase"
+      }
+    })
+  })
+})