]> git.ipfire.org Git - thirdparty/openssl.git/commit
doc: Document properties param for Argon2 KDF
authorClemens Lang <cllang@redhat.com>
Wed, 28 Aug 2024 15:18:03 +0000 (17:18 +0200)
committerTomas Mraz <tomas@openssl.org>
Thu, 29 Aug 2024 17:20:05 +0000 (19:20 +0200)
commit6772c2ab1bc5f12dd800247cd6800c45c2c0bf6e
treeb9518c6794496bf8a85a7cf0c697534a3b3baade
parent80008d4a94b660f3df1608c771098f4942c906bd
doc: Document properties param for Argon2 KDF

The Argon2 KDF uses OSSL_KDF_PARAM_PROPERTIES to fetch implementations
of blake2bmac and blake2b512 if ctx->mac and ctx->md are NULL. This
isn't documented in the manpage, so users that might, for example, want
to fetch an instance of Argon2 with the -fips property query to obtain
a working Argon2 KDF even though the default property query requires
fips=yes are left wondering why this fails.

Fortunately, EVP_KDF(3)/PARAMETERS already explains what the properties
are used for, so we really just need to add a single line.

Signed-off-by: Clemens Lang <cllang@redhat.com>
Reviewed-by: Dmitry Belyavskiy <beldmit@gmail.com>
Reviewed-by: Paul Dale <ppzgs1@gmail.com>
Reviewed-by: Tomas Mraz <tomas@openssl.org>
(Merged from https://github.com/openssl/openssl/pull/25306)
doc/man7/EVP_KDF-ARGON2.pod