The SSL/SSH tab of the connection dialog encrypts the connection to the database (SSL/TLS) and lets you reach a database you cannot connect to directly through an SSH server or a proxy. Why encryption and verifying the other side are different, and how to choose a mode, is explained under 'Secure connections' in Connections and execution targets. This page describes the options in the tab.
Where you can use itWebDesktopWithout signing inSigned inLocal projectsAccount projects
What's on the screen
| No. | Name | Description |
|---|---|---|
| 1 | SSL/SSH tab | Available after you click the Connect to DB button in the connection dialog. The number next to it is how many of SSL/TLS, SSH Tunnel and Proxy are on. |
| 2 | SSL/TLS switch | Turns SSL/TLS on and expands its options. Use it with a DBMS that supports SSL. |
| 3 | Mode | How far to go with encryption and server verification. The chosen mode is described below the field. When you first turn SSL on, the mode is Require. |
| 4 | CA Certificate row | The CA certificate trusted when verifying the server certificate. Pick a file with the Upload button. |
| 5 | Client Certificate, Client Key and Client Key Password | Fill these in when the database identifies users by client certificate (mutual authentication). They appear only for DBMSs that support it. |
- MySQL and MariaDB have an extra Public key retrieval option. Click the question mark icon for an explanation.
- When you pick a file, its content, not its path, is stored in the connection, and the row gets a Content set badge. In the web app, the same button uploads a file from your computer. Upload again when you get a new certificate. The red button removes it.
Turning on SSL/TLS
- In the connection dialog, open the SSL/SSH tab (1).
- Turn on the SSL/TLS switch (2).
- Choose a mode in the Mode field (3). Use Verify Full for a production database. If you connect by IP address or through an SSH tunnel, use Verify CA.
- For a mode that verifies the server, upload the database server's CA certificate in the CA Certificate row (4). For a cloud database, the CA bundle file published by the service works as is.
- Check the connection with the Test Connection button in the Connection tab, then save.
What you can choose depends on the DBMS.
| DBMS | Connection security | Certificate settings |
|---|---|---|
| PostgreSQL, MySQL | Choose from all five modes. | Use a client certificate. |
| MariaDB | Choose Disable, Require, Verify CA or Verify Full. | Use a client certificate. |
| SQL Server | Choose Disable, Require or Verify Full. | Verify the server certificate. |
| Oracle | Specify the tcps protocol in the JDBC URL. | Use a client certificate. |
| Snowflake, BigQuery | Connect over TLS (HTTPS). Check the This DBMS always connects over TLS (HTTPS). Encryption cannot be turned off and there is no SSL mode to choose. notice. |
- SQL Server always verifies the host name when it verifies the certificate. When connecting by IP or an alias, give the certificate's host name with
hostNameInCertificatein the Properties tab. - For a connection using the MySQL 5 (Legacy) driver, the SSL settings in this tab do not reach the driver. Use the default driver if you need SSL.
- Host name verification for Oracle is set with
oracle.net.ssl_server_dn_matchin the Properties tab. - If you switch the DBMS and the chosen mode does not exist for the new DBMS, it changes to Require (or the first mode in the list if there is none).
Connecting through an SSH tunnel
| No. | Name | Description |
|---|---|---|
| 1 | Host and Port | The SSH server (bastion host) to go through. The port starts at 22. |
| 2 | Username and Auth Method | The account on the SSH server. Choose between Password and Public Key authentication. |
| 3 | Password | The value for Password authentication. If you choose Public Key, the Private Key row and the Passphrase field appear instead. |
| 4 | Port Forwarding | Remote Host and Remote Port are the database address as seen from the SSH server. If left empty, the values of the Host and Port fields in the Connection tab are used. If Local Port is left empty, a free port is chosen automatically. |
| 5 | Advanced | Keep-Alive (sec) (0 at first), Timeout (sec) (30 seconds at first) and Strict host key checking (off at first). |
- Turn on the SSH Tunnel switch.
- Enter the SSH server's address and account (1, 2), then the Password field or Private Key row (3) for the Auth Method.
- If the database address is a name visible only from the SSH server (for example, a cloud database's internal endpoint), enter it in the Remote Host field (4).
- For a production environment, turn on Strict host key checking (5).
- Check the connection with the Test Connection button in the Connection tab and save.
- In the web app, the NeoSQL server opens the SSH tunnel. The SSH server must be reachable from the internet.
- A private key is also stored in the connection as file content. You can upload it in the web app too.
Connecting through a proxy
Turn on the Proxy switch to connect to the database through a proxy server.
| Option | Description |
|---|---|
| Type | Choose SOCKS5 (the initial value), SOCKS4 or HTTP |
| Host, Port | The proxy server's address. The port starts at 1080 |
| Username, Password | Fill in when the proxy requires authentication |
What is shared with the team
In an account project, the values in this tab are stored in two places.
| Shared values (connection settings) | Values each member enters separately |
|---|---|
| The SSL/TLS switch, Mode, CA Certificate, the SSH server address with the Port Forwarding and Advanced settings, the proxy Type and address | SSH Username, Password, Private Key and Passphrase; proxy Username and Password |
- The Client Certificate and Client Key are stored once in the connection, like the Username and Password in the Connection tab, and the team uses them together.
- In a local project, all secrets are stored in this computer's OS secure storage. Where they are stored is explained under 'Where connection credentials are stored' in Connections and execution targets.
Things to keep in mind
- Require only encrypts; it does not check that the other side is the real database server. For a production database, add the CA certificate and use Verify CA or stronger.
- With Strict host key checking off, you will not notice if the SSH server is replaced.
- Set SSL with the SSL/TLS switch. If you put SSL keys in the URL or the Properties tab, a hint appears, and when the switch is on, the switch's settings win.
- Databricks always connects over TLS, so you do not need to turn on SSL/TLS in this tab. If you turn it on, the This DBMS always connects over TLS (HTTPS). Encryption cannot be turned off and there is no SSL mode to choose. notice is shown instead of a mode.
Related screens
- Connections and execution targets: the difference between encryption and verifying the other side, and how to choose a mode.
- Create and edit a connection: the other tabs of the connection dialog.
- Connect to a production database safely: the steps for connecting a production database with a secure connection and a profile.
- Database reference: SSL support that differs by DBMS.