Establishing SSL Connection to PostgreSQL DB Server
When striving to keep information in your PostgreSQL database safe, the first thing you need to do is to encrypt all connections to it for protecting authentication credentials (usernames / passwords) and stored data from interception. This guide is intended to help you in establishing secure SSL connection to your PostgreSQL container, hosted at the platform.
Below, we’ll explore the appropriate database server adjustment, required for SSL enabling, and certificates generation for it. Then, we’ll create and add certs for client machine and, lastly, will establish secure connection to our server via pgAdmin tool. So, let’s go on!
PostgreSQL Server Configuration
Obviously, for this tutorial we’ll use an environment with PostgreSQL database inside - you can easily create such if you haven’t done this yet.
1. To start with, connect to your database server via SSH Gate.
Tip: In case you haven’t performed similar operation before, you need to:
- generate an SSH keypair
- add your public SSH key to the dashboard
- access your account via SSH protocol
2. Now, in order to make it work with SSL, you need to add the following three files to the /var/lib/pgsql/data server directory:
- server.key - private key
- server.crt - server certificate
- root.crt - trusted root certificate
Within this tutorial, we’ll briefly consider how you can generate them by yourselves.
Tips:
- we won’t explain commands parameters in details here, but if you’d like to know more, just refer to the Self-Signed Custom SSL page in our documentation or check the official OpenSSL site for the full list of available actions
- you can also use custom SSL certificate similarly to the described below (follow the Generate a Custom SSL Certificate section of the linked guide to get such). In this latter case, you can skip the generation instruction and jump directly to the 6th step of this instruction
So, navigate to the mentioned folder and proceed with steps below.
3. First of all, let’s create the first file - private key:
- execute the next commands:
| |
During the server.key generation, you’ll be asked for a pass phrase - specify any and confirm it to finish creation.
- Now, in order to work with this key further, it’s required remove the pass phrase you’ve added previously. Execute the following command for this:
| |
Re-enter pass phrase one more time for confirmation.
- Set the appropriate permission and ownership rights for your private key file with the next commands:
| |
4. Now, you need to create server certificate based on your server.key file, e.g.:
| |
Note: It’s required to set your personal data for the subj parameter if the certificate is intended to be used in production:
| Unit | Meaning | Example |
|---|---|---|
| /C= | Country | GB |
| /ST= | State | London |
| /L= | Location | London |
| /O= | Organization | Global Security |
| /OU= (optional) | Organizational Unit | IT Department |
| /CN= | Common Name | example.com |
| /emailAddress= | email@example.com |
You can also just skip the -subj parameter within the command and pass all these arguments in the interactive mode within the automatically opened inquiry.
5. Since we are going to sign certs by ourselves, the generated server certificate can be used as a trusted root certificate as well, so just make its copy with the appropriate name:
| |
Now, as you have all three certificate files, you can proceed to PostgreSQL database configurations, required for SSL activation and usage.
6. Open the pg_hba.conf file, located in the same folder, for editing with any preferable terminal editor (vim for example) or directly via dashboard.
Replace its default content with the following lines:
| |
Notes:
- If you want to work with a database as a user other than the default webadmin, change the appropriate value within the last line of the config to the required name. In this case, you’ll need to use the same username for all the further commands (we’ll denote where this is required).
- Also, for the older PostgreSQL versions (10 and lower), you need to change the clientcert value to one “md5 clientcert=1” in the last line of the config:
| |
Save the updated file.
7. To finish configurations, you need to apply some more changes to the postgresql.conf file.
Navigate to its Security and Authentication section (approximately at the 80th line) and activate SSL usage itself, through uncommenting the same-named setting and changing its value to “on”. Also, add the new ssl_ca_file parameter below:
| |
Don’t forget to save these changes.
8. Lastly, restart your PostgreSQL container in order to apply new settings:
| |
Client Certificates
Now, let’s create one more set of SSL certificate files for client instance, in order to support secure connection on both sides.
1. Return to the terminal window with SSH connection to your PostgreSQL server you’ve operated through during server setup (or reconnect to it) - you’ll need your server certificates for further actions.
Once inside, generate a private key for client (also without a pass phrase, just as it was done in the previous section), for example within the tmp directory:
| |
2. Next, create SSL certificate for your PostgreSQL database user (webadmin by default) and sign it with our trusted root.crt file on server.
| |
Notes:
- while commonly data for the subj parameter can be changed to your personal data here, its Common Name (/CN=) must be equal to database user name you’ve set during the first certificate generation in server configuration file (webadmin in our case)
- root.crt and server.key files should be located in the same folder the 2nd command is executed from; otherwise, the full path to them should be specified
3. After the files - postgresql.key, postgresql.crt, root.crt - are ready, you need to move them to to the .postgresql folder at your client machine (for that, you can use FTP add-on or just copy and paste files content).
Also, if needed, you can set the key read permission for owner only with the chmod 0400 ~/.postgresql/postgresql.key command to achieve more security.
Establish Connection via PgAdmin
Eventually, after server and client configurations are done, you are ready to establish the connection. In our case, we’ll use the pgAdmin 3 tool as an example, so get this application (or any other preferred one) installed beforehand.
1. In order to connect to the DB server via SSL, you need either public IP or endpoint being attached for your PostgreSQL database container.
We’ll consider the latter case - access environment Settings, switch to the Endpoints section and Add new endpoint with the same-named button at the top pane.
2. Now, when you have an access point, run your pgAdmin 3 client and select the New Server Registration option.
In the Properties tab of the opened window, specify the following data:
- Name - any desired connection name (e.g. ssl-to-pgsql)
- Host - access point you’ve added in the first step (Public IP address or endpoint Access URL without port number)
- Port - use the default port 5432 for External IP or endpoint’s Public port (denoted in the same-named section of the appropriate column)
- Username - database user you’ve set the SSL certificate and configurations for (i.e. webadmin by default)
- Password - the corresponding user’s password (sent via email for webadmin or the one you’ve set otherwise)
The rest of the fields can be left unchanged or adjusted according your requirements.
3. Next, switch to the SSL tab and, for the same-named line, select the require option from the drop-down list.
That’s all! The required certificates will be loaded automatically during the first connection establishment, so just click OK to start managing your database via secure connection.
Now you can connect your application to database (use the Connect to Database guide as an example) and enable SSL configurations for your project to encrypt your data while fetching/transferring.