feat: add SSL options to PostgreSQL connection #379
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Some database providers only accepts requests with SSL enabled (e.g. Timescale Cloud). We support the following SSL options: ssl, cert, key, ca Those options will map from Knex.js to the library https://github.com/iceddev/pg-connection-string thanks to the Knex.js PR knex/knex#3410 Please be careful when configuring SSL connection. Passing key value into cert or inversely can trigger an uncaught exception and even `process.on('uncaughtException', fn)` cannot catch it.
for local and CircleCI environments. Previously, test was failing with a single-domain certificate. SSL certificate was rejected for CircleCI as the host didn't match the certificate information (localhost). For tests, we used a self-signed multi-domains certificate to check database SSL connections. However generating a self-signed multi-domain certificate isn't enough for Node.js, as it will reject it because it is self-signed. To overcome this, we have to sign it with another root certificate (that can be self-signed). For Knex connection configuration, we need to provide the two certificates as `sslcert` and `sslca` properties. In real world usage, you may only need to specify one of them.
abruere
approved these changes
Aug 14, 2020
docker-compose.override.yml
Outdated
| @@ -35,6 +35,22 @@ services: | |||
| volumes: | |||
| - timescaledb-v1.7.1-pg12-data:/var/lib/postgresql/data/pgdata | |||
|
|
|||
| # Service used only test environment to check if SSL database connections work | |||
There was a problem hiding this comment.
in test environment
EDIT: removed after refactoring.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Some database providers only accepts requests with SSL enabled
(e.g. Timescale Cloud).
We support the following SSL options: ssl, cert, key, ca
Those options will map from Knex.js to the library
https://github.com/iceddev/pg-connection-string
thanks to the Knex.js PR
knex/knex#3410
Please be careful when configuring SSL connection.
Passing key value into cert or inversely can trigger
an uncaught exception and even
process.on('uncaughtException', fn)cannot catch it.
Add multi-domains certificate to PostgreSQL Docker image to check
that SSL connections is correctly handled in tests.