diff options
author | Peter Eisentraut <peter_e@gmx.net> | 2018-03-07 11:32:51 -0500 |
---|---|---|
committer | Peter Eisentraut <peter_e@gmx.net> | 2018-03-07 11:32:51 -0500 |
commit | d40c7cd00422ac9a1284a1ecb5d6c0671c5ec6e4 (patch) | |
tree | 14827f486a5c47106bcd6ef7f75e19107c9c0197 | |
parent | f9d34ce4e798ca768e28aea3703464db3179adcf (diff) | |
download | postgresql-d40c7cd00422ac9a1284a1ecb5d6c0671c5ec6e4.tar.gz postgresql-d40c7cd00422ac9a1284a1ecb5d6c0671c5ec6e4.zip |
doc: Add more substructure to SSL documentation
The SSL documentation text has gotten a bit long, so add some
subsections and reorder for better flow.
-rw-r--r-- | doc/src/sgml/runtime.sgml | 66 |
1 files changed, 37 insertions, 29 deletions
diff --git a/doc/src/sgml/runtime.sgml b/doc/src/sgml/runtime.sgml index 4929d5529d6..587b4305274 100644 --- a/doc/src/sgml/runtime.sgml +++ b/doc/src/sgml/runtime.sgml @@ -2158,6 +2158,9 @@ pg_dumpall -p 5432 | psql -d postgres -p 5433 enabled at build time (see <xref linkend="installation"/>). </para> + <sect2 id="ssl-setup"> + <title>Basic Setup</title> + <para> With <acronym>SSL</acronym> support compiled in, the <productname>PostgreSQL</productname> server can be started with @@ -2172,35 +2175,6 @@ pg_dumpall -p 5432 | psql -d postgres -p 5433 </para> <para> - <productname>PostgreSQL</productname> reads the system-wide - <productname>OpenSSL</productname> configuration file. By default, this - file is named <filename>openssl.cnf</filename> and is located in the - directory reported by <literal>openssl version -d</literal>. - This default can be overridden by setting environment variable - <envar>OPENSSL_CONF</envar> to the name of the desired configuration file. - </para> - - <para> - <productname>OpenSSL</productname> supports a wide range of ciphers - and authentication algorithms, of varying strength. While a list of - ciphers can be specified in the <productname>OpenSSL</productname> - configuration file, you can specify ciphers specifically for use by - the database server by modifying <xref linkend="guc-ssl-ciphers"/> in - <filename>postgresql.conf</filename>. - </para> - - <note> - <para> - It is possible to have authentication without encryption overhead by - using <literal>NULL-SHA</literal> or <literal>NULL-MD5</literal> ciphers. However, - a man-in-the-middle could read and pass communications between client - and server. Also, encryption overhead is minimal compared to the - overhead of authentication. For these reasons NULL ciphers are not - recommended. - </para> - </note> - - <para> To start in <acronym>SSL</acronym> mode, files containing the server certificate and private key must exist. By default, these files are expected to be named <filename>server.crt</filename> and <filename>server.key</filename>, respectively, in @@ -2245,6 +2219,40 @@ pg_dumpall -p 5432 | psql -d postgres -p 5433 <filename>server.crt</filename>. Instead, clients must have the root certificate of the server's certificate chain. </para> + </sect2> + + <sect2 id="ssl-openssl-config"> + <title>OpenSSL Configuration</title> + + <para> + <productname>PostgreSQL</productname> reads the system-wide + <productname>OpenSSL</productname> configuration file. By default, this + file is named <filename>openssl.cnf</filename> and is located in the + directory reported by <literal>openssl version -d</literal>. + This default can be overridden by setting environment variable + <envar>OPENSSL_CONF</envar> to the name of the desired configuration file. + </para> + + <para> + <productname>OpenSSL</productname> supports a wide range of ciphers + and authentication algorithms, of varying strength. While a list of + ciphers can be specified in the <productname>OpenSSL</productname> + configuration file, you can specify ciphers specifically for use by + the database server by modifying <xref linkend="guc-ssl-ciphers"/> in + <filename>postgresql.conf</filename>. + </para> + + <note> + <para> + It is possible to have authentication without encryption overhead by + using <literal>NULL-SHA</literal> or <literal>NULL-MD5</literal> ciphers. However, + a man-in-the-middle could read and pass communications between client + and server. Also, encryption overhead is minimal compared to the + overhead of authentication. For these reasons NULL ciphers are not + recommended. + </para> + </note> + </sect2> <sect2 id="ssl-client-certificates"> <title>Using Client Certificates</title> |