summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorPauli <paul.dale@oracle.com>2019-09-25 20:27:27 +1000
committerPauli <paul.dale@oracle.com>2019-09-26 07:10:41 +1000
commite7f2dac96826d7988467e6293156fcb12277a040 (patch)
treee0b83d80f80e40afeb243f2adb8dfa93e2e15d81
parent19bd1fa1ef17ff0ac071402cb6b002f1c29e37b9 (diff)
Use OSSL_PARAM types for KDF documentation
Reviewed-by: Richard Levitte <levitte@openssl.org> (Merged from https://github.com/openssl/openssl/pull/10011)
-rw-r--r--doc/man7/EVP_KDF-HKDF.pod2
-rw-r--r--doc/man7/EVP_KDF-PBKDF2.pod4
-rw-r--r--doc/man7/EVP_KDF-SCRYPT.pod10
-rw-r--r--doc/man7/EVP_KDF-SS.pod2
-rw-r--r--doc/man7/EVP_KDF-SSHKDF.pod2
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<OSSL_KDF_PARAM_MODE> ("mode") <UTF8 string> or <int>
+=item B<OSSL_KDF_PARAM_MODE> ("mode") <UTF8 string> or <integer>
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<OSSL_KDF_PARAM_SALT> ("salt") <octet string>
-=item B<OSSL_KDF_PARAM_ITER> ("iter") <unsigned int>
+=item B<OSSL_KDF_PARAM_ITER> ("iter") <unsigned integer>
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<EVP_KDF(3)/PARAMETERS>.
-=item B<OSSL_KDF_PARAM_PKCS5> ("pkcs5") <int>
+=item B<OSSL_KDF_PARAM_PKCS5> ("pkcs5") <integer>
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<EVP_KDF(3)/PARAMETERS>.
-=item B<OSSL_KDF_PARAM_SCRYPT_N> ("n") <int>
+=item B<OSSL_KDF_PARAM_SCRYPT_N> ("n") <unsigned integer>
-=item B<OSSL_KDF_PARAM_SCRYPT_R> ("r") <int>
+=item B<OSSL_KDF_PARAM_SCRYPT_R> ("r") <unsigned integer>
-=item B<OSSL_KDF_PARAM_SCRYPT_P> ("p") <int>
+=item B<OSSL_KDF_PARAM_SCRYPT_P> ("p") <unsigned integer>
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<uint64_t>.
+Both r and p are parameters of type B<uint32_t>.
=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<OSSL_KDF_PARAM_MAC> ("mac") <UTF8 string>
-=item B<OSSL_KDF_PARAM_MAC_SIZE> ("maclen") <size_t>
+=item B<OSSL_KDF_PARAM_MAC_SIZE> ("maclen") <unsigned integer>
=item B<OSSL_KDF_PARAM_SALT> ("salt") <octet string>
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<EVP_KDF(3)/PARAMETERS>.
These parameters set the respective values for the KDF.
If a value is already set, the contents are replaced.
-=item B<OSSL_KDF_PARAM_SSHKDF_TYPE> ("type") <int>
+=item B<OSSL_KDF_PARAM_SSHKDF_TYPE> ("type") <integer>
This parameter sets the type for the SSHHKDF operation.
There are six supported types: