pg.ddx.io pgsql-docs@postgresql.org mailing list archive
help / color / mirror / Atom feedBroken link in pgcrypto documentation
8+ messages / 4 participants
[nested] [flat]
* Broken link in pgcrypto documentation
@ 2024-02-12 12:55 PG Doc comments form <noreply@postgresql.org>
0 siblings, 1 reply; 8+ messages in thread
From: PG Doc comments form @ 2024-02-12 12:55 UTC (permalink / raw)
To: pgsql-docs@lists.postgresql.org; +Cc: hanefi.onaldi@microsoft.com
The following documentation comment has been logged on the website:
Page: https://www.postgresql.org/docs/16/pgcrypto.html
Description:
I was going through the links in pgcrypto documentation and I realized that
one of the links at Useful Reading section do not work.
interhack.net seems to be down for a while whereas interhack.com contains a
portion of the contents of the former website in a different hierarchy. I
did some digging and I believe we can update that link to the same set of
information on the other website.
Relevant page:
https://www.postgresql.org/docs/current/pgcrypto.html#PGCRYPTO-NOTES-USEFUL-READING
Current link that does not work:
http://www.interhack.net/people/cmcurtin/snake-oil-faq.html
Last capture at Web Archive:
https://web.archive.org/web/20211114090731/http://www.interhack.net/people/cmcurtin/snake-oil-faq.ht...
My suggestion for updating the link:
http://web.interhack.com/publications/snake-oil-faq
Thanks,
Hanefi
^ permalink raw reply [nested|flat] 8+ messages in thread
* Re: Broken link in pgcrypto documentation
@ 2024-02-13 18:11 Daniel Gustafsson <daniel@yesql.se>
parent: PG Doc comments form <noreply@postgresql.org>
0 siblings, 1 reply; 8+ messages in thread
From: Daniel Gustafsson @ 2024-02-13 18:11 UTC (permalink / raw)
To: hanefi.onaldi@microsoft.com; pgsql-docs@lists.postgresql.org
> On 12 Feb 2024, at 13:55, PG Doc comments form <noreply@postgresql.org> wrote:
>
> The following documentation comment has been logged on the website:
>
> Page: https://www.postgresql.org/docs/16/pgcrypto.html
> Description:
>
> I was going through the links in pgcrypto documentation and I realized that
> one of the links at Useful Reading section do not work.
Thanks for the report!
However, I wonder if we aren't better off removing the "Useful Reading" section
altogether? The field of crypto is continuously advancing and keeping a stale
10+ year old list of links is unlikely to provide more insights than what more
curated sites can do.
--
Daniel Gustafsson
^ permalink raw reply [nested|flat] 8+ messages in thread
* Re: Broken link in pgcrypto documentation
@ 2024-02-13 19:33 Magnus Hagander <magnus@hagander.net>
parent: Daniel Gustafsson <daniel@yesql.se>
0 siblings, 1 reply; 8+ messages in thread
From: Magnus Hagander @ 2024-02-13 19:33 UTC (permalink / raw)
To: Daniel Gustafsson <daniel@yesql.se>; +Cc: hanefi.onaldi@microsoft.com; pgsql-docs@lists.postgresql.org
On Tue, Feb 13, 2024 at 7:12 PM Daniel Gustafsson <daniel@yesql.se> wrote:
>
> > On 12 Feb 2024, at 13:55, PG Doc comments form <noreply@postgresql.org> wrote:
> >
> > The following documentation comment has been logged on the website:
> >
> > Page: https://www.postgresql.org/docs/16/pgcrypto.html
> > Description:
> >
> > I was going through the links in pgcrypto documentation and I realized that
> > one of the links at Useful Reading section do not work.
>
> Thanks for the report!
>
> However, I wonder if we aren't better off removing the "Useful Reading" section
> altogether? The field of crypto is continuously advancing and keeping a stale
> 10+ year old list of links is unlikely to provide more insights than what more
> curated sites can do.
+1. I don't think it's the job of a postgres contrib module to maintain that.
--
Magnus Hagander
Me: https://www.hagander.net/
Work: https://www.redpill-linpro.com/
^ permalink raw reply [nested|flat] 8+ messages in thread
* Re: Broken link in pgcrypto documentation
@ 2024-02-13 19:42 Tom Lane <tgl@sss.pgh.pa.us>
parent: Magnus Hagander <magnus@hagander.net>
0 siblings, 1 reply; 8+ messages in thread
From: Tom Lane @ 2024-02-13 19:42 UTC (permalink / raw)
To: Magnus Hagander <magnus@hagander.net>; +Cc: Daniel Gustafsson <daniel@yesql.se>; hanefi.onaldi@microsoft.com; pgsql-docs@lists.postgresql.org
Magnus Hagander <magnus@hagander.net> writes:
> On Tue, Feb 13, 2024 at 7:12 PM Daniel Gustafsson <daniel@yesql.se> wrote:
>> However, I wonder if we aren't better off removing the "Useful Reading" section
>> altogether? The field of crypto is continuously advancing and keeping a stale
>> 10+ year old list of links is unlikely to provide more insights than what more
>> curated sites can do.
> +1. I don't think it's the job of a postgres contrib module to maintain that.
+1. We haven't maintained that list in the past and it seems unlikely
that we'll get better at it.
I'm a little dubious about the "Technical References" list right below
it, too. The RFC references are probably useful and stable, and maybe
the wikipedia ref is OK, but I have little faith in either the
stability or the long-term relevance of the other two links.
regards, tom lane
^ permalink raw reply [nested|flat] 8+ messages in thread
* Re: Broken link in pgcrypto documentation
@ 2024-02-13 19:52 Daniel Gustafsson <daniel@yesql.se>
parent: Tom Lane <tgl@sss.pgh.pa.us>
0 siblings, 1 reply; 8+ messages in thread
From: Daniel Gustafsson @ 2024-02-13 19:52 UTC (permalink / raw)
To: Tom Lane <tgl@sss.pgh.pa.us>; +Cc: Magnus Hagander <magnus@hagander.net>; hanefi.onaldi@microsoft.com; pgsql-docs@lists.postgresql.org
> On 13 Feb 2024, at 20:42, Tom Lane <tgl@sss.pgh.pa.us> wrote:
>
> Magnus Hagander <magnus@hagander.net> writes:
>> On Tue, Feb 13, 2024 at 7:12 PM Daniel Gustafsson <daniel@yesql.se> wrote:
>>> However, I wonder if we aren't better off removing the "Useful Reading" section
>>> altogether? The field of crypto is continuously advancing and keeping a stale
>>> 10+ year old list of links is unlikely to provide more insights than what more
>>> curated sites can do.
>
>> +1. I don't think it's the job of a postgres contrib module to maintain that.
>
> +1. We haven't maintained that list in the past and it seems unlikely
> that we'll get better at it.
>
> I'm a little dubious about the "Technical References" list right below
> it, too. The RFC references are probably useful and stable, and maybe
> the wikipedia ref is OK, but I have little faith in either the
> stability or the long-term relevance of the other two links.
Not even those are all that stable, while the RFCs' in question haven't been
replaced they have all been updated with new RFC's which we don't link to. I
think we are better off removing them as well and leaving reading up on
security/crypto subject an exercise for the reader.
Specifically, I propose the attached.
--
Daniel Gustafsson
Attachments:
[application/octet-stream] pgcrypto_links.diff (2.5K, ../../9648F8FB-208E-4645-95D9-3E833C586512@yesql.se/2-pgcrypto_links.diff)
download | inline diff:
diff --git a/doc/src/sgml/pgcrypto.sgml b/doc/src/sgml/pgcrypto.sgml
index 2e29f1d6f7..2db159be71 100644
--- a/doc/src/sgml/pgcrypto.sgml
+++ b/doc/src/sgml/pgcrypto.sgml
@@ -1220,72 +1220,6 @@ gen_random_uuid() returns uuid
ciphertexts of a given size.
</para>
</sect3>
-
- <sect3 id="pgcrypto-notes-useful-reading">
- <title>Useful Reading</title>
-
- <itemizedlist>
- <listitem>
- <para><ulink url="https://www.gnupg.org/gph/en/manual.html"></ulink></para>
- <para>The GNU Privacy Handbook.</para>
- </listitem>
- <listitem>
- <para><ulink url="https://www.openwall.com/crypt/"></ulink></para>
- <para>Describes the crypt-blowfish algorithm.</para>
- </listitem>
- <listitem>
- <para>
- <ulink url="https://www.iusmentis.com/security/passphrasefaq/"></ulink>
- </para>
- <para>How to choose a good password.</para>
- </listitem>
- <listitem>
- <para><ulink url="http://world.std.com/~reinhold/diceware.html"></ulink></para>
- <para>Interesting idea for picking passwords.</para>
- </listitem>
- <listitem>
- <para>
- <ulink url="http://www.interhack.net/people/cmcurtin/snake-oil-faq.html"></ulink>
- </para>
- <para>Describes good and bad cryptography.</para>
- </listitem>
- </itemizedlist>
- </sect3>
-
- <sect3 id="pgcrypto-notes-tech-ref">
- <title>Technical References</title>
-
- <itemizedlist>
- <listitem>
- <para><ulink url="https://tools.ietf.org/html/rfc4880"></ulink></para>
- <para>OpenPGP message format.</para>
- </listitem>
- <listitem>
- <para><ulink url="https://tools.ietf.org/html/rfc1321"></ulink></para>
- <para>The MD5 Message-Digest Algorithm.</para>
- </listitem>
- <listitem>
- <para><ulink url="https://tools.ietf.org/html/rfc2104"></ulink></para>
- <para>HMAC: Keyed-Hashing for Message Authentication.</para>
- </listitem>
- <listitem>
- <para>
- <ulink url="https://www.usenix.org/legacy/events/usenix99/provos.html"></ulink>
- </para>
- <para>Comparison of crypt-des, crypt-md5 and bcrypt algorithms.</para>
- </listitem>
- <listitem>
- <para>
- <ulink url="https://en.wikipedia.org/wiki/Fortuna_(PRNG)"></ulink>
- </para>
- <para>Description of Fortuna CSPRNG.</para>
- </listitem>
- <listitem>
- <para><ulink url="https://jlcooke.ca/random/"></ulink></para>
- <para>Jean-Luc Cooke Fortuna-based <filename>/dev/random</filename> driver for Linux.</para>
- </listitem>
- </itemizedlist>
- </sect3>
</sect2>
<sect2 id="pgcrypto-author">
^ permalink raw reply [nested|flat] 8+ messages in thread
* Re: Broken link in pgcrypto documentation
@ 2024-02-13 20:08 Tom Lane <tgl@sss.pgh.pa.us>
parent: Daniel Gustafsson <daniel@yesql.se>
0 siblings, 1 reply; 8+ messages in thread
From: Tom Lane @ 2024-02-13 20:08 UTC (permalink / raw)
To: Daniel Gustafsson <daniel@yesql.se>; +Cc: Magnus Hagander <magnus@hagander.net>; hanefi.onaldi@microsoft.com; pgsql-docs@lists.postgresql.org
Daniel Gustafsson <daniel@yesql.se> writes:
> On 13 Feb 2024, at 20:42, Tom Lane <tgl@sss.pgh.pa.us> wrote:
>> I'm a little dubious about the "Technical References" list right below
>> it, too. The RFC references are probably useful and stable, and maybe
>> the wikipedia ref is OK, but I have little faith in either the
>> stability or the long-term relevance of the other two links.
> Not even those are all that stable, while the RFCs' in question haven't been
> replaced they have all been updated with new RFC's which we don't link to. I
> think we are better off removing them as well and leaving reading up on
> security/crypto subject an exercise for the reader.
Good point. Nuking both lists works for me.
regards, tom lane
^ permalink raw reply [nested|flat] 8+ messages in thread
* Re: Broken link in pgcrypto documentation
@ 2024-02-13 20:24 Magnus Hagander <magnus@hagander.net>
parent: Tom Lane <tgl@sss.pgh.pa.us>
0 siblings, 1 reply; 8+ messages in thread
From: Magnus Hagander @ 2024-02-13 20:24 UTC (permalink / raw)
To: Tom Lane <tgl@sss.pgh.pa.us>; +Cc: Daniel Gustafsson <daniel@yesql.se>; hanefi.onaldi@microsoft.com; pgsql-docs@lists.postgresql.org
On Tue, Feb 13, 2024 at 9:08 PM Tom Lane <tgl@sss.pgh.pa.us> wrote:
>
> Daniel Gustafsson <daniel@yesql.se> writes:
> > On 13 Feb 2024, at 20:42, Tom Lane <tgl@sss.pgh.pa.us> wrote:
> >> I'm a little dubious about the "Technical References" list right below
> >> it, too. The RFC references are probably useful and stable, and maybe
> >> the wikipedia ref is OK, but I have little faith in either the
> >> stability or the long-term relevance of the other two links.
>
> > Not even those are all that stable, while the RFCs' in question haven't been
> > replaced they have all been updated with new RFC's which we don't link to. I
> > think we are better off removing them as well and leaving reading up on
> > security/crypto subject an exercise for the reader.
>
> Good point. Nuking both lists works for me.
+1.
--
Magnus Hagander
Me: https://www.hagander.net/
Work: https://www.redpill-linpro.com/
^ permalink raw reply [nested|flat] 8+ messages in thread
* Re: Broken link in pgcrypto documentation
@ 2024-02-13 20:55 Daniel Gustafsson <daniel@yesql.se>
parent: Magnus Hagander <magnus@hagander.net>
0 siblings, 0 replies; 8+ messages in thread
From: Daniel Gustafsson @ 2024-02-13 20:55 UTC (permalink / raw)
To: Magnus Hagander <magnus@hagander.net>; +Cc: Tom Lane <tgl@sss.pgh.pa.us>; hanefi.onaldi@microsoft.com; pgsql-docs@lists.postgresql.org
> On 13 Feb 2024, at 21:24, Magnus Hagander <magnus@hagander.net> wrote:
>
> On Tue, Feb 13, 2024 at 9:08 PM Tom Lane <tgl@sss.pgh.pa.us> wrote:
>>
>> Daniel Gustafsson <daniel@yesql.se> writes:
>>> On 13 Feb 2024, at 20:42, Tom Lane <tgl@sss.pgh.pa.us> wrote:
>>>> I'm a little dubious about the "Technical References" list right below
>>>> it, too. The RFC references are probably useful and stable, and maybe
>>>> the wikipedia ref is OK, but I have little faith in either the
>>>> stability or the long-term relevance of the other two links.
>>
>>> Not even those are all that stable, while the RFCs' in question haven't been
>>> replaced they have all been updated with new RFC's which we don't link to. I
>>> think we are better off removing them as well and leaving reading up on
>>> security/crypto subject an exercise for the reader.
>>
>> Good point. Nuking both lists works for me.
>
> +1.
Alright, sounds good. I'll go ahead with that in the morning then, backpatched
all the way down since the links are equally outdated everywhere.
--
Daniel Gustafsson
^ permalink raw reply [nested|flat] 8+ messages in thread
end of thread, other threads:[~2024-02-13 20:55 UTC | newest]
Thread overview: 8+ messages (download: mbox mbox.gz follow: Atom feed)
-- links below jump to the message on this page --
2024-02-12 12:55 Broken link in pgcrypto documentation PG Doc comments form <noreply@postgresql.org>
2024-02-13 18:11 ` Daniel Gustafsson <daniel@yesql.se>
2024-02-13 19:33 ` Magnus Hagander <magnus@hagander.net>
2024-02-13 19:42 ` Tom Lane <tgl@sss.pgh.pa.us>
2024-02-13 19:52 ` Daniel Gustafsson <daniel@yesql.se>
2024-02-13 20:08 ` Tom Lane <tgl@sss.pgh.pa.us>
2024-02-13 20:24 ` Magnus Hagander <magnus@hagander.net>
2024-02-13 20:55 ` Daniel Gustafsson <daniel@yesql.se>
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