Network Handlers Reference

Table of contents

• SSH tunnel
• SSL
  • Common properties

The handlers object inside a connection's configuration routes the connection through a network handler. Each handler is keyed by its handler ID.

The available handlers for a connection appear in the connection settings dialog.

All handlers share these top-level fields:

Field	Type	Default	Description
type	string	-	Handler type
			- TUNNEL (SSH tunnel)
			- CONFIG (SSL)
enabled	boolean	false	Enable this handler for the connection
save-password	boolean	false	Store credentials in the workspace config. When true, the encrypted credentials file is used. When false, credentials must be entered on each connect
properties	object	-	Handler-specific parameters. See sections below

SSH tunnel

Handler ID: ssh_tunnel, type: TUNNEL

Property	Type	Default	Description
host	string	-	SSH server hostname or IP
port	integer	22	SSH server port
authType	string	-	Auth method: PASSWORD, PUBLIC_KEY
user	string	-	SSH username
password	string	-	SSH password. Used when authType is PASSWORD
keyPath	string	-	Path to the private key file. Used when authType is PUBLIC_KEY
keyValue	string	-	Private key content as a string. Used when authType is PUBLIC_KEY
localHost	string	-	Local host for port forwarding
localPort	integer	-	Local port for port forwarding
remoteHost	string	-	Remote host to forward traffic to
remotePort	integer	-	Remote port to forward traffic to
aliveInterval	integer	-	Keep-alive interval in milliseconds
sshConnectTimeout	integer	-	Tunnel connection timeout in milliseconds

Example:

{
  "handlers": {
    "ssh_tunnel": {
      "type": "TUNNEL",
      "enabled": true,
      "save-password": true,
      "properties": {
        "host": "db.internal.example.com",
        "port": 22,
        "authType": "PUBLIC_KEY",
        "user": "sshuser",
        "keyPath": "${project.path}/Keys/id_rsa"
      }
    }
  }
}

SSL

Type: CONFIG. Each database driver uses its own SSL handler ID (e.g. postgre_ssl, mysql_ssl, mongo_ssl).

Common properties

Most SSL handlers support certificates-based auth:

Property	Type	Default	Description
ssl.method	string	CERTIFICATES	Auth method: CERTIFICATES or KEYSTORE
ssl.sslMode	string		Set the SSL connection mode. Use disable, allow, prefer, require, verify-ca, or verify-full
ssl.ca.cert	string		Path to the CA certificate file
ssl.ca.cert.value	string		CA certificate content (inline)
ssl.client.cert	string		Path to the client certificate file
ssl.client.cert.value	string		Client certificate content (inline)
ssl.client.key	string		Path to the client private key file
ssl.client.key.value	string		Client private key content (inline)

For keystore-based auth (ssl.method: KEYSTORE):

Property	Type	Description
ssl.keystore	string	Path to the keystore file
ssl.keystore.value	string	Keystore content (inline)
ssl.keystore.password	string	Keystore password

Example:

{
  "handlers": {
    "postgre_ssl": {
      "type": "CONFIG",
      "enabled": true,
      "save-password": true,
      "properties": {
        "ssl.method": "CERTIFICATES",
        "ssl.sslMode": "verify-full",
        "ssl.ca.cert": "${project.path}/Keys/ca.crt",
        "ssl.client.cert": "${project.path}/Keys/client.crt",
        "ssl.client.key": "${project.path}/Keys/client.key"
      }
    }
  }
}