From 860ea46ba7be69c46c37a96983e1ddca9d630c2e Mon Sep 17 00:00:00 2001 From: Daniel Gustafsson Date: Wed, 30 Mar 2022 13:07:30 +0200 Subject: [PATCH] doc: Clarify when SSL actually means TLS SSL has become the de facto term to mean an end-to-end encrypted channel regardless of protocol used, even though the SSL protocol is deprecated. Clarify what we mean with SSL in our documentation, especially for new users who might be looking for TLS. Reviewed-by: Robert Haas Discussion: https://postgr.es/m/D4ABB281-6CFD-46C6-A4E0-8EC23A2977BC@yesql.se --- doc/src/sgml/config.sgml | 8 +++++++- doc/src/sgml/libpq.sgml | 6 ++++-- doc/src/sgml/runtime.sgml | 15 ++++++++++++++- 3 files changed, 25 insertions(+), 4 deletions(-) diff --git a/doc/src/sgml/config.sgml b/doc/src/sgml/config.sgml index 05df48131d..9788e831bc 100644 --- a/doc/src/sgml/config.sgml +++ b/doc/src/sgml/config.sgml @@ -1184,7 +1184,13 @@ include_dir 'conf.d' SSL - See for more information about setting up SSL. + See for more information about setting up + SSL. The configuration parameters for controlling + transfer encryption using TLS protocols are named + ssl for historic reasons, even though support for + the SSL protocol has been deprecated. + SSL is in this context used interchangeably with + TLS. diff --git a/doc/src/sgml/libpq.sgml b/doc/src/sgml/libpq.sgml index eac5dee9f7..0b2a8720f0 100644 --- a/doc/src/sgml/libpq.sgml +++ b/doc/src/sgml/libpq.sgml @@ -8292,12 +8292,14 @@ ldap://ldap.acme.com/cn=dbserver,cn=hosts?pgconnectinfo?base?(objectclass=*) SSL + TLS PostgreSQL has native support for using SSL - connections to encrypt client/server communications for increased - security. See for details about the server-side + connections to encrypt client/server communications using + TLS protocols for increased security. + See for details about the server-side SSL functionality. diff --git a/doc/src/sgml/runtime.sgml b/doc/src/sgml/runtime.sgml index 3a463f12d7..1f021ea116 100644 --- a/doc/src/sgml/runtime.sgml +++ b/doc/src/sgml/runtime.sgml @@ -2182,6 +2182,7 @@ pg_dumpall -p 5432 | psql -d postgres -p 5433 SSL + TLS @@ -2193,13 +2194,25 @@ pg_dumpall -p 5432 | psql -d postgres -p 5433 enabled at build time (see ). + + The terms SSL and TLS are often used + interchangeably to mean a secure encrypted connection using a + TLS protocol. SSL protocols are the + precursors to TLS protocols, and the term + SSL is still used for encrypted connections even though + SSL protocols are no longer supported. + SSL is used interchangeably with TLS + in PostgreSQL. + + Basic Setup With SSL support compiled in, the PostgreSQL server can be started with - SSL enabled by setting the parameter + support for encrypted connections using TLS protocols + enabled by by setting the parameter to on in postgresql.conf. The server will listen for both normal and SSL connections on the same TCP port, and will negotiate