From e7f2dac96826d7988467e6293156fcb12277a040 Mon Sep 17 00:00:00 2001 From: Pauli Date: Wed, 25 Sep 2019 20:27:27 +1000 Subject: [PATCH] Use OSSL_PARAM types for KDF documentation Reviewed-by: Richard Levitte (Merged from https://github.com/openssl/openssl/pull/10011) --- doc/man7/EVP_KDF-HKDF.pod | 2 +- doc/man7/EVP_KDF-PBKDF2.pod | 4 ++-- doc/man7/EVP_KDF-SCRYPT.pod | 10 +++++----- doc/man7/EVP_KDF-SS.pod | 2 +- doc/man7/EVP_KDF-SSHKDF.pod | 2 +- 5 files changed, 10 insertions(+), 10 deletions(-) diff --git a/doc/man7/EVP_KDF-HKDF.pod b/doc/man7/EVP_KDF-HKDF.pod index ce623039c2..d68f384034 100644 --- a/doc/man7/EVP_KDF-HKDF.pod +++ b/doc/man7/EVP_KDF-HKDF.pod @@ -42,7 +42,7 @@ This parameter sets the info value. The length of the context info buffer cannot exceed 1024 bytes; this should be more than enough for any normal use of HKDF. -=item B ("mode") or +=item B ("mode") or This parameter sets the mode for the HKDF operation. There are three modes that are currently defined: diff --git a/doc/man7/EVP_KDF-PBKDF2.pod b/doc/man7/EVP_KDF-PBKDF2.pod index f90029bf4e..d93dff68cc 100644 --- a/doc/man7/EVP_KDF-PBKDF2.pod +++ b/doc/man7/EVP_KDF-PBKDF2.pod @@ -28,7 +28,7 @@ The supported parameters are: =item B ("salt") -=item B ("iter") +=item B ("iter") This parameter has a default value of 2048. @@ -38,7 +38,7 @@ This parameter has a default value of 2048. These parameters work as described in L. -=item B ("pkcs5") +=item B ("pkcs5") This parameter can be used to enable or disable SP800-132 compliance checks. Setting the mode to 0 enables the compliance checks. diff --git a/doc/man7/EVP_KDF-SCRYPT.pod b/doc/man7/EVP_KDF-SCRYPT.pod index 706237f6f2..1372f6d677 100644 --- a/doc/man7/EVP_KDF-SCRYPT.pod +++ b/doc/man7/EVP_KDF-SCRYPT.pod @@ -49,15 +49,15 @@ The supported parameters are: These parameters work as described in L. -=item B ("n") +=item B ("n") -=item B ("r") +=item B ("r") -=item B ("p") +=item B ("p") These parameters configure the scrypt work factors N, r and p. -N is a parameter of type uint64_t. -Both r and p are parameters of type uint32_t. +N is a parameter of type B. +Both r and p are parameters of type B. =back diff --git a/doc/man7/EVP_KDF-SS.pod b/doc/man7/EVP_KDF-SS.pod index 160e12ac39..0ccfe2ed28 100644 --- a/doc/man7/EVP_KDF-SS.pod +++ b/doc/man7/EVP_KDF-SS.pod @@ -45,7 +45,7 @@ The supported parameters are: =item B ("mac") -=item B ("maclen") +=item B ("maclen") =item B ("salt") diff --git a/doc/man7/EVP_KDF-SSHKDF.pod b/doc/man7/EVP_KDF-SSHKDF.pod index 7649f70cdb..e1350e951b 100644 --- a/doc/man7/EVP_KDF-SSHKDF.pod +++ b/doc/man7/EVP_KDF-SSHKDF.pod @@ -41,7 +41,7 @@ These parameters work as described in L. These parameters set the respective values for the KDF. If a value is already set, the contents are replaced. -=item B ("type") +=item B ("type") This parameter sets the type for the SSHHKDF operation. There are six supported types: -- 2.25.1