From: Daniel Gustafsson <daniel@yesql.se>
To: Peter Eisentraut <peter.eisentraut@2ndquadrant.com>
Cc: pgsql-docs@lists.postgresql.org
Subject: Re: Formatting of warning about using ident
Date: Mon, 1 Jul 2019 13:48:52 +0200
Message-ID: <D7DCADB0-D7E7-4C1B-ACFD-7C1AD466EFE5@yesql.se> (raw)
In-Reply-To: <bc0f78d9-c7e5-1804-9cc1-2fe30f16d2a2@2ndquadrant.com>
References: <B20006D2-AE84-40CE-97DE-A607A0027EE0@yesql.se>
<bc0f78d9-c7e5-1804-9cc1-2fe30f16d2a2@2ndquadrant.com>
> On 26 Jun 2019, at 15:09, Peter Eisentraut <peter.eisentraut@2ndquadrant.com> wrote:
>
> On 2019-06-14 10:47, Daniel Gustafsson wrote:
>> The warning about using ident for authorization or access control is using a
>> <blockquote> with an <attribution> rather than a <warning>, making it look
>> quite different from the rest of the manual, and less like a warning IMO.
>
> But this is a quote from the RFC. If you want to change it to a warning
> box, then you also need to rephrase the surrounding text. But I don't
> really see the need. It seems fine as it is.
It is indeed a quote, but to my reading/understanding the only reason we’ve
included it is to act as a warning? Thats why the formatting stood out as it’s
not consistent for warnings. The attached v2 instead wraps the quote in a
<warning> with a slight rewording to make it even more prominent.
cheers ./daniel
Attachments:ident_warning-v2.patch (application/octet-stream, 1.8K) download
From 3451bebdb293e60a097f45c05aa1cc486d475b2d Mon Sep 17 00:00:00 2001
From: Daniel Gustafsson <daniel@yesql.se>
Date: Mon, 1 Jul 2019 13:45:12 +0200
Subject: [PATCH] Turn ident warning into an actual <warning>
The warning about using ident for authorization or access control was
not formatted as a <warning>, making it less visible for readers used
to the PostgreSQL documentation style. Wrap the quote in a <warning>
block with slight rewording to emphasize the warning.
---
doc/src/sgml/client-auth.sgml | 21 ++++++++++++---------
1 file changed, 12 insertions(+), 9 deletions(-)
diff --git a/doc/src/sgml/client-auth.sgml b/doc/src/sgml/client-auth.sgmlindex ffed887ab7..bf7a70ee70 100644--- a/doc/src/sgml/client-auth.sgml+++ b/doc/src/sgml/client-auth.sgml@@ -1426,15 +1426,18 @@ omicron bryanh guest1
therefore only appropriate for closed networks where each client
machine is under tight control and where the database and system
administrators operate in close contact. In other words, you must
- trust the machine running the ident server.- Heed the warning:- <blockquote>- <attribution>RFC 1413</attribution>- <para>- The Identification Protocol is not intended as an authorization- or access control protocol.- </para>- </blockquote>+ trust the machine running the ident server. RFC 1413 explicitly+ warns about using ident authentication for authorization or access+ control:+ <warning>+ <blockquote>+ <attribution>RFC 1413</attribution>+ <para>+ The Identification Protocol is not intended as an authorization+ or access control protocol.+ </para>+ </blockquote>+ </warning>
</para>
<para>
--
2.14.1.145.gb3622a4ee
=
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Reply to all the recipients using the --to and --cc options:
reply via email
To: pgsql-docs@postgresql.org
Cc: daniel@yesql.se, peter.eisentraut@2ndquadrant.com, pgsql-docs@lists.postgresql.org
Subject: Re: Formatting of warning about using ident
In-Reply-To: <D7DCADB0-D7E7-4C1B-ACFD-7C1AD466EFE5@yesql.se>
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
This inbox is served by DDX for PostgreSQL; see mirroring instructions
for how to clone and mirror all data and code used for this inbox