BUG #8467: Slightly confusing pgcrypto example in docs

From: postgresql(at)richardneill(dot)org
To: pgsql-bugs(at)postgresql(dot)org
Subject: BUG #8467: Slightly confusing pgcrypto example in docs
Date: 2013-09-23 23:11:40
Message-ID: E1VOFI4-0005nz-6r@wrigleys.postgresql.org
Views: Raw Message | Whole Thread | Download mbox | Resend email
Thread:
Lists: pgsql-bugs

The following bug has been logged on the website:

Bug reference: 8467
Logged by: Richard Neill
Email address: postgresql(at)richardneill(dot)org
PostgreSQL version: 9.3.0
Operating system: Documentation bug
Description:

The documentation for pgcrypto:
http://www.postgresql.org/docs/current/static/pgcrypto.html
(and indeed all versions from 8.3-9.3)
contains the following:

--------------------
Example of authentication:

SELECT pswhash = crypt('entered password', pswhash) FROM ... ;

This returns true if the entered password is correct.
--------------------

I found this confusing, because it's using the same name, "pswhash" in 2
places, one of which is a boolean. It would be, imho, clearer to write the
example query as:

--------------------
SELECT is_authenticated = crypt('entered password', pswhash) FROM ... ;
--------------------

[Also, should the default example perhaps use gen_salt('bf'), as opposed to
gen_salt('md5') ?]

Responses

Browse pgsql-bugs by date

  From Date Subject
Next Message marian.krucina 2013-09-24 11:42:23 BUG #8468: Create index on type tstzrange fail
Previous Message Devrim GÜNDÜZ 2013-09-23 20:48:48 Re: BUG #8463: Packaging problem with postgis rpms