33.18. SSL Support
PostgreSQL has native support for using SSL connections to encrypt client/server communications for increased security. See Section 18.9 for details about the server-side SSL functionality.
reads the system-wide
configuration file. By default, this
file is named
and is located in the
directory reported by
openssl version -d
. This default
can be overridden by setting environment variable
to the name of the desired configuration
33.18.1. Client Verification of Server Certificates
By default, PostgreSQL will not perform any verification of the server certificate. This means that it is possible to spoof the server identity (for example by modifying a DNS record or by taking over the server IP address) without the client knowing. In order to prevent spoofing, the client must be able to verify the server's identity via a chain of trust. A chain of trust is established by placing a root (self-signed) certificate authority ( CA ) certificate on one computer and a leaf certificate signed by the root certificate on another computer. It is also possible to use an " intermediate " certificate which is signed by the root certificate and signs leaf certificates.
To allow the client to verify the identity of the server, place a root certificate on the client and a leaf certificate signed by the root certificate on the server. To allow the server to verify the identity of the client, place a root certificate on the server and a leaf certificate signed by the root certificate on the client. One or more intermediate certificates (usually stored with the leaf certificate) can also be used to link the leaf certificate to the root certificate.
Once a chain of trust has been established, there are two ways for
the client to validate the leaf certificate sent by the server.
If the parameter
is set to
libpq will verify that the server is trustworthy by checking the
certificate chain up to the root certificate stored on the client.
is set to
verify that the server host
name matches the name stored in the server certificate. The
SSL connection will fail if the server certificate cannot be
is recommended in most
mode, the host name is matched against the
certificate's Subject Alternative Name attribute(s), or against the
Common Name attribute if no Subject Alternative Name of type
present. If the certificate's name attribute starts with an asterisk
), the asterisk will be treated as
a wildcard, which will match all characters
). This means the certificate will not match subdomains.
If the connection is made using an IP address instead of a host name, the
IP address will be matched (without doing any DNS lookups).
To allow server certificate verification, one or more root certificates
must be placed in the file
in the user's home directory. (On Microsoft Windows the file is named
certificates should also be added to the file if they are needed to link
the certificate chain sent by the server to the root certificates
stored on the client.
Certificate Revocation List (CRL) entries are also checked
if the file
The location of the root certificate file and the CRL can be changed by
the connection parameters
or the environment variables
For backwards compatibility with earlier versions of PostgreSQL, if a
root CA file exists, the behavior of
will be the same
as that of
, meaning the server certificate
is validated against the CA. Relying on this behavior is discouraged,
and applications that need certificate validation should always use
33.18.2. Client Certificates
If the server attempts to verify the identity of the
client by requesting the client's leaf certificate,
will send the certificate(s) stored in
in the user's home
directory. The certificates must chain to the root certificate trusted
by the server. A matching
private key file
On Microsoft Windows these files are named
The location of the certificate and key files can be overridden by the
, or by the
On Unix systems, the permissions on the private key file must disallow
any access to world or group; achieve this by a command such as
chmod 0600 ~/.postgresql/postgresql.key
Alternatively, the file can be owned by root and have group read access
permissions). That setup is intended
for installations where certificate and key files are managed by the
operating system. The user of
then be made a member of the group that has access to those certificate
and key files. (On Microsoft Windows, there is no file permissions
check, since the
The first certificate in
must be the
client's certificate because it must match the client's private key.
certificates can be optionally appended
to the file - doing so avoids requiring storage of intermediate
certificates on the server (
The certificate and key may be in PEM or ASN.1 DER format.
The key may be
stored in cleartext or encrypted with a passphrase using any algorithm supported
by OpenSSL, like AES-128. If the key is stored encrypted, then the passphrase
may be provided in the
option. If an encrypted key is supplied and the
option is absent or blank, a password will be prompted for interactively by
OpenSSL with a
Enter PEM pass phrase:
prompt if a TTY is available. Applications can override the client certificate
prompt and the handling of the
parameter by supplying
their own key password callback; see
For instructions on creating certificates, see Section 18.9.5 .
33.18.3. Protection Provided in Different Modes
The different values for the
parameter provide different
levels of protection. SSL can provide
protection against three types of attacks:
If a third party can examine the network traffic between the client and the server, it can read both connection information (including the user name and password) and the data that is passed. SSL uses encryption to prevent this.
- Man in the middle ( MITM )
If a third party can modify the data while passing between the client and server, it can pretend to be the server and therefore see and modify data even if it is encrypted . The third party can then forward the connection information and data to the original server, making it impossible to detect this attack. Common vectors to do this include DNS poisoning and address hijacking, whereby the client is directed to a different server than intended. There are also several other attack methods that can accomplish this. SSL uses certificate verification to prevent this, by authenticating the server to the client.
If a third party can pretend to be an authorized client, it can simply access data it should not have access to. Typically this can happen through insecure password management. SSL uses client certificates to prevent this, by making sure that only holders of valid certificates can access the server.
For a connection to be known SSL-secured, SSL usage must be configured
both the client and the server
before the connection
is made. If it is only configured on the server, the client may end up
sending sensitive information (e.g., passwords) before
it knows that the server requires high security. In libpq, secure
connections can be ensured
by setting the
, and providing the system with a root certificate to
verify against. This is analogous to using an
for encrypted web browsing.
Once the server has been authenticated, the client can pass sensitive data. This means that up until this point, the client does not need to know if certificates will be used for authentication, making it safe to specify that only in the server configuration.
options carry overhead in the form of encryption and
key-exchange, so there is a trade-off that has to be made between performance
illustrates the risks the different
protect against, and what statement they make about security and overhead.
Table 33.1. SSL Mode Descriptions
||Eavesdropping protection||MITM protection||Statement|
||No||No||I don't care about security, and I don't want to pay the overhead of encryption.|
||Maybe||No||I don't care about security, but I will pay the overhead of encryption if the server insists on it.|
||Maybe||No||I don't care about encryption, but I wish to pay the overhead of encryption if the server supports it.|
||Yes||No||I want my data to be encrypted, and I accept the overhead. I trust that the network will make sure I always connect to the server I want.|
||Yes||Depends on CA policy||I want my data encrypted, and I accept the overhead. I want to be sure that I connect to a server that I trust.|
||Yes||Yes||I want my data encrypted, and I accept the overhead. I want to be sure that I connect to a server I trust, and that it's the one I specify.|
The difference between
depends on the policy of the root
. If a public
allows connections to a server
may have registered with the
In this case,
should always be used. If
is used, or even a self-signed certificate, using
often provides enough protection.
The default value for
. As is shown
in the table, this makes no sense from a security point of view, and it only
promises performance overhead if possible. It is only provided as the default
for backward compatibility, and is not recommended in secure deployments.
33.18.4. SSL Client File Usage
Table 33.2 summarizes the files that are relevant to the SSL setup on the client.
Table 33.2. Libpq/Client SSL File Usage
||client certificate||sent to server|
||client private key||proves client certificate sent by owner; does not indicate certificate owner is trustworthy|
||trusted certificate authorities||checks that server certificate is signed by a trusted certificate authority|
||certificates revoked by certificate authorities||server certificate must not be on this list|
33.18.5. SSL Library Initialization
If your application initializes
is built with
support, you should call
have been initialized by your application, so that
will not also initialize those libraries.
Allows applications to select which security libraries to initialize.
void PQinitOpenSSL(int do_ssl, int do_crypto);
do_sslis non-zero, libpq will initialize the OpenSSL library before first opening a database connection. When
do_cryptois non-zero, the
libcryptolibrary will be initialized. By default (if
PQinitOpenSSLis not called), both libraries are initialized. When SSL support is not compiled in, this function is present but does nothing.
If your application uses and initializes either OpenSSL or its underlying
libcryptolibrary, you must call this function with zeroes for the appropriate parameter(s) before first opening a database connection. Also be sure that you have done that initialization before opening a database connection.
Allows applications to select which security libraries to initialize.
void PQinitSSL(int do_ssl);
This function is equivalent to
PQinitOpenSSL(do_ssl, do_ssl). It is sufficient for applications that initialize both or neither of OpenSSL and