Horton

Thread

Commits

  1. Fix outdated comment of scram_build_secret()

  2. Make SCRAM iteration count configurable

  1. Outdated comment on scram_build_secret

    Matheus Alcantara <matheusssilv97@gmail.com> — 2024-12-09T23:39:03Z

    Hi,

The documentation for the iterations parameter on scram_build_secret say:
  * If iterations is 0, default number of iterations is used.

But the body of the function have the following assert
	Assert(iterations > 0);

Commit b577743000 introduced the assert and remove the if condition. 
All usages of this function is using an iteration > 0, so I think that 
is just a matter of updating the documentation? If that's the case the 
attached patch does that.

-- 
Matheus Alcantara
EDB: https://www.enterprisedb.com

  2. Re: Outdated comment on scram_build_secret

    Michael Paquier <michael@paquier.xyz> — 2024-12-10T00:58:28Z

    On Mon, Dec 09, 2024 at 08:39:03PM -0300, Matheus Alcantara wrote:
> Commit b577743000 introduced the assert and remove the if condition. All
> usages of this function is using an iteration > 0, so I think that is just a
> matter of updating the documentation? If that's the case the attached patch
> does that.

Ah, good catch.  

> - * If iterations is 0, default number of iterations is used.  The result is
> - * palloc'd or malloc'd, so caller is responsible for freeing it.
> + * The result is palloc'd or malloc'd, so caller is responsible for freeing it.

Removing the comment sounds like the right thing to do here.  I'll go
do that in a bit down to v16.
--
Michael