]> 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:27 +0000 (19:20 +0200)
commit589286efca5ab637ae29ef7f3522dc85ee080d55
tree23f0a9c3ef4b0c9bab091d733a7ebbac078dadf0
parentba01343c9efd7d53e3f8fd24750fa7749e5c1d6a
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)

(cherry picked from commit 6772c2ab1bc5f12dd800247cd6800c45c2c0bf6e)
doc/man7/EVP_KDF-ARGON2.pod