The branch master has been updated
via fddb1847b1d53ead95678cbe21004c03c88d506d (commit)
via b1cabee8ce63e73f0116e501cd0933ace3cdec88 (commit)
via 4c04e7b1cc14d98fe79acb647e4ad1cf1b8114b5 (commit)
via 54488bd914ee344d55dc75d9df71ce9a5ad3da49 (commit)
via 40526dfd92817fd1fdd8e4adc9065c02c7807818 (commit)
from 5b5e2985f355c8e99c196d9ce5d02c15bebadfbc (commit)
- Log -----------------------------------------------------------------
commit fddb1847b1d53ead95678cbe21004c03c88d506d
Author: Pauli <paul.d...@oracle.com>
Date: Tue Sep 17 08:46:49 2019 +1000
Change PARAMETER NAMES links to PARAMETERS
Reviewed-by: Richard Levitte <levi...@openssl.org>
(Merged from https://github.com/openssl/openssl/pull/9905)
commit b1cabee8ce63e73f0116e501cd0933ace3cdec88
Author: Pauli <paul.d...@oracle.com>
Date: Tue Sep 17 08:45:38 2019 +1000
Use PARAMETERS instead of PARAMETER NAMES for the heading for consistency.
Reviewed-by: Richard Levitte <levi...@openssl.org>
(Merged from https://github.com/openssl/openssl/pull/9905)
commit 4c04e7b1cc14d98fe79acb647e4ad1cf1b8114b5
Author: Pauli <paul.d...@oracle.com>
Date: Tue Sep 17 08:44:15 2019 +1000
Fix links to functions.
Reviewed-by: Richard Levitte <levi...@openssl.org>
(Merged from https://github.com/openssl/openssl/pull/9905)
commit 54488bd914ee344d55dc75d9df71ce9a5ad3da49
Author: Pauli <paul.d...@oracle.com>
Date: Mon Sep 16 09:07:32 2019 +1000
Cleanup KDF section 1 documentation.
Remove reference to EVP_KDF_ctrl_str and replace it with
EVP_KDF_CTX_set_params.
Add missing links, and specify two extra KDFs.
Reviewed-by: Richard Levitte <levi...@openssl.org>
(Merged from https://github.com/openssl/openssl/pull/9905)
commit 40526dfd92817fd1fdd8e4adc9065c02c7807818
Author: Pauli <paul.d...@oracle.com>
Date: Mon Sep 16 08:59:10 2019 +1000
Clean up KDF documentation in section 7.
The EVP_KDF_ctrl function doesn't exist anymore and have been replaced by
EVP_KDF_CTX_set_params.
The EVP_KDF_new_id function doesn't exist either and EVP_KDF_new should be
used instead.
Reviewed-by: Richard Levitte <levi...@openssl.org>
(Merged from https://github.com/openssl/openssl/pull/9905)
-----------------------------------------------------------------------
Summary of changes:
doc/man1/openssl-kdf.pod | 25 ++++++++++++++-----------
doc/man3/EVP_KDF.pod | 2 +-
doc/man3/EVP_MAC.pod | 2 +-
doc/man7/EVP_KDF-HKDF.pod | 16 ++++++++--------
doc/man7/EVP_KDF-PBKDF2.pod | 12 ++++++------
doc/man7/EVP_KDF-SCRYPT.pod | 14 +++++++-------
doc/man7/EVP_KDF-SS.pod | 12 ++++++------
doc/man7/EVP_KDF-SSHKDF.pod | 14 +++++++-------
doc/man7/EVP_KDF-TLS1_PRF.pod | 12 ++++++------
doc/man7/EVP_KDF-X942.pod | 12 ++++++------
doc/man7/EVP_KDF-X963.pod | 14 +++++++-------
doc/man7/EVP_MAC-BLAKE2.pod | 4 ++--
doc/man7/EVP_MAC-CMAC.pod | 4 ++--
doc/man7/EVP_MAC-GMAC.pod | 4 ++--
doc/man7/EVP_MAC-HMAC.pod | 4 ++--
doc/man7/EVP_MAC-KMAC.pod | 4 ++--
doc/man7/EVP_MAC-Poly1305.pod | 4 ++--
doc/man7/EVP_MAC-Siphash.pod | 4 ++--
18 files changed, 83 insertions(+), 80 deletions(-)
diff --git a/doc/man1/openssl-kdf.pod b/doc/man1/openssl-kdf.pod
index a2b0f25d25..2b14eaadc4 100644
--- a/doc/man1/openssl-kdf.pod
+++ b/doc/man1/openssl-kdf.pod
@@ -42,9 +42,9 @@ Output the derived key in binary form. Uses hexadecimal text
format if not speci
=item B<-kdfopt> I<nm:v>
Passes options to the KDF algorithm.
-A comprehensive list of controls can be found in the EVP_KDF_CTX implementation
-documentation.
-Common control strings used by EVP_KDF_ctrl_str() are:
+A comprehensive list of parameters can be found in the EVP_KDF_CTX
+implementation documentation.
+Common parameter names used by EVP_KDF_CTX_set_params() are:
=over 4
@@ -82,7 +82,8 @@ To see the list of supported digests, use the command I<list
-digest-commands>.
=item I<kdf_name>
Specifies the name of a supported KDF algorithm which will be used.
-The supported algorithms names are TLS1-PRF, HKDF, SSKDF, PBKDF2, SSHKDF and
id-scrypt.
+The supported algorithms names include TLS1-PRF, HKDF, SSKDF, PBKDF2,
+SSHKDF, X942KDF, X963KDF and id-scrypt.
=back
@@ -143,14 +144,16 @@ used when building OpenSSL.
=head1 SEE ALSO
L<openssl(1)>,
-L<openssl-pkeyutl(1)>
+L<openssl-pkeyutl(1)>,
L<EVP_KDF(3)>,
-L<EVP_KDF-SCRYPT(7)>
-L<EVP_KDF-TLS1_PRF(7)>
-L<EVP_KDF-PBKDF2(7)>
-L<EVP_KDF-HKDF(7)>
-L<EVP_KDF-SS(7)>
-L<EVP_KDF-SSHKDF(7)>
+L<EVP_KDF-SCRYPT(7)>,
+L<EVP_KDF-TLS1_PRF(7)>,
+L<EVP_KDF-PBKDF2(7)>,
+L<EVP_KDF-HKDF(7)>,
+L<EVP_KDF-SS(7)>,
+L<EVP_KDF-SSHKDF(7)>,
+L<EVP_KDF-X942(7)>,
+L<EVP_KDF-X963(7)>
=head1 HISTORY
diff --git a/doc/man3/EVP_KDF.pod b/doc/man3/EVP_KDF.pod
index 2770c9534f..9b88baad9f 100644
--- a/doc/man3/EVP_KDF.pod
+++ b/doc/man3/EVP_KDF.pod
@@ -138,7 +138,7 @@ providers in the given library context I<libctx>, and for
each of the
implementations, calls the given function I<fn> with the implementation method
and the given I<arg> as argument.
-=head1 PARAMETER NAMES
+=head1 PARAMETERS
The standard parameter names are:
diff --git a/doc/man3/EVP_MAC.pod b/doc/man3/EVP_MAC.pod
index 4d819b7544..2ab4c48fbf 100644
--- a/doc/man3/EVP_MAC.pod
+++ b/doc/man3/EVP_MAC.pod
@@ -165,7 +165,7 @@ providers in the given library context I<libctx>, and for
each of the
implementations, calls the given function I<fn> with the implementation method
and the given I<arg> as argument.
-=head1 PARAMETER NAMES
+=head1 PARAMETERS
Parameters are identified by name as strings, and have an expected
data type and maximum size.
diff --git a/doc/man7/EVP_KDF-HKDF.pod b/doc/man7/EVP_KDF-HKDF.pod
index fb675b2d45..ce623039c2 100644
--- a/doc/man7/EVP_KDF-HKDF.pod
+++ b/doc/man7/EVP_KDF-HKDF.pod
@@ -134,17 +134,17 @@ RFC 5869
=head1 SEE ALSO
-L<EVP_KDF>,
-L<EVP_KDF-CTX_new_id(3)>,
-L<EVP_KDF-CTX_free(3)>,
-L<EVP_KDF-ctrl(3)>,
-L<EVP_KDF-size(3)>,
-L<EVP_KDF-derive(3)>,
-L<EVP_KDF-CTX(3)/PARAMETERS>
+L<EVP_KDF(3)>,
+L<EVP_KDF_CTX_new(3)>,
+L<EVP_KDF_CTX_free(3)>,
+L<EVP_KDF_size(3)>,
+L<EVP_KDF_CTX_set_params(3)>,
+L<EVP_KDF_derive(3)>,
+L<EVP_KDF(3)/PARAMETERS>
=head1 COPYRIGHT
-Copyright 2016-2018 The OpenSSL Project Authors. All Rights Reserved.
+Copyright 2016-2019 The OpenSSL Project Authors. All Rights Reserved.
Licensed under the Apache License 2.0 (the "License"). You may not use
this file except in compliance with the License. You can obtain a copy
diff --git a/doc/man7/EVP_KDF-PBKDF2.pod b/doc/man7/EVP_KDF-PBKDF2.pod
index 311e0a3769..f90029bf4e 100644
--- a/doc/man7/EVP_KDF-PBKDF2.pod
+++ b/doc/man7/EVP_KDF-PBKDF2.pod
@@ -81,12 +81,12 @@ SP800-132
=head1 SEE ALSO
-L<EVP_KDF>,
-L<EVP_KDF-CTX_new_id(3)>,
-L<EVP_KDF-CTX_free(3)>,
-L<EVP_KDF-ctrl(3)>,
-L<EVP_KDF-derive(3)>,
-L<EVP_KDF-CTX(3)/PARAMETERS>
+L<EVP_KDF(3)>,
+L<EVP_KDF_CTX_new(3)>,
+L<EVP_KDF_CTX_free(3)>,
+L<EVP_KDF_CTX_set_params(3)>,
+L<EVP_KDF_derive(3)>,
+L<EVP_KDF(3)/PARAMETERS>
=head1 HISTORY
diff --git a/doc/man7/EVP_KDF-SCRYPT.pod b/doc/man7/EVP_KDF-SCRYPT.pod
index dff8e15f39..706237f6f2 100644
--- a/doc/man7/EVP_KDF-SCRYPT.pod
+++ b/doc/man7/EVP_KDF-SCRYPT.pod
@@ -123,16 +123,16 @@ RFC 7914
=head1 SEE ALSO
-L<EVP_KDF>,
-L<EVP_KDF-CTX_new_id(3)>,
-L<EVP_KDF-CTX_free(3)>,
-L<EVP_KDF-ctrl(3)>,
-L<EVP_KDF-derive(3)>,
-L<EVP_KDF-CTX(3)/PARAMETERS>
+L<EVP_KDF(3)>,
+L<EVP_KDF_CTX_new(3)>,
+L<EVP_KDF_CTX_free(3)>,
+L<EVP_KDF_CTX_set_params(3)>,
+L<EVP_KDF_derive(3)>,
+L<EVP_KDF(3)/PARAMETERS>
=head1 COPYRIGHT
-Copyright 2017-2018 The OpenSSL Project Authors. All Rights Reserved.
+Copyright 2017-2019 The OpenSSL Project Authors. All Rights Reserved.
Licensed under the Apache License 2.0 (the "License"). You may not use
this file except in compliance with the License. You can obtain a copy
diff --git a/doc/man7/EVP_KDF-SS.pod b/doc/man7/EVP_KDF-SS.pod
index be45d9e3c7..160e12ac39 100644
--- a/doc/man7/EVP_KDF-SS.pod
+++ b/doc/man7/EVP_KDF-SS.pod
@@ -172,12 +172,12 @@ NIST SP800-56Cr1.
=head1 SEE ALSO
-L<EVP_KDF>,
-L<EVP_KDF-CTX_new_id(3)>,
-L<EVP_KDF-CTX_free(3)>,
-L<EVP_KDF-ctrl(3)>,
-L<EVP_KDF-size(3)>,
-L<EVP_KDF-derive(3)>,
+L<EVP_KDF(3)>,
+L<EVP_KDF_CTX_new(3)>,
+L<EVP_KDF_CTX_free(3)>,
+L<EVP_KDF_CTX_set_params(3)>,
+L<EVP_KDF_size(3)>,
+L<EVP_KDF_derive(3)>,
L<EVP_KDF(3)/PARAMETERS>
=head1 HISTORY
diff --git a/doc/man7/EVP_KDF-SSHKDF.pod b/doc/man7/EVP_KDF-SSHKDF.pod
index cd05abe9dd..7649f70cdb 100644
--- a/doc/man7/EVP_KDF-SSHKDF.pod
+++ b/doc/man7/EVP_KDF-SSHKDF.pod
@@ -138,17 +138,17 @@ RFC 4253
=head1 SEE ALSO
-L<EVP_KDF>,
-L<EVP_KDF-CTX_new_id(3)>,
-L<EVP_KDF-CTX_free(3)>,
-L<EVP_KDF-ctrl(3)>,
-L<EVP_KDF-size(3)>,
-L<EVP_KDF-derive(3)>,
+L<EVP_KDF(3)>,
+L<EVP_KDF_CTX_new(3)>,
+L<EVP_KDF_CTX_free(3)>,
+L<EVP_KDF_CTX_set_params(3)>,
+L<EVP_KDF_size(3)>,
+L<EVP_KDF_derive(3)>,
L<EVP_KDF(3)/PARAMETERS>
=head1 COPYRIGHT
-Copyright 2016-2018 The OpenSSL Project Authors. All Rights Reserved.
+Copyright 2016-2019 The OpenSSL Project Authors. All Rights Reserved.
Licensed under the OpenSSL license (the "License"). You may not use
this file except in compliance with the License. You can obtain a copy
diff --git a/doc/man7/EVP_KDF-TLS1_PRF.pod b/doc/man7/EVP_KDF-TLS1_PRF.pod
index 2adcf9f0aa..58625a769a 100644
--- a/doc/man7/EVP_KDF-TLS1_PRF.pod
+++ b/doc/man7/EVP_KDF-TLS1_PRF.pod
@@ -94,12 +94,12 @@ RFC 2246, RFC 5246 and NIST SP 800-135 r1
=head1 SEE ALSO
-L<EVP_KDF>,
-L<EVP_KDF-CTX_new_id(3)>,
-L<EVP_KDF-CTX_free(3)>,
-L<EVP_KDF-ctrl(3)>,
-L<EVP_KDF-derive(3)>,
-L<EVP_KDF-CTX(3)/PARAMETERS>
+L<EVP_KDF(3)>,
+L<EVP_KDF_CTX_new(3)>,
+L<EVP_KDF_CTX_free(3)>,
+L<EVP_KDF_CTX_set_params(3)>,
+L<EVP_KDF_derive(3)>,
+L<EVP_KDF(3)/PARAMETERS>
=head1 COPYRIGHT
diff --git a/doc/man7/EVP_KDF-X942.pod b/doc/man7/EVP_KDF-X942.pod
index 83478f1be9..06cafc30ac 100644
--- a/doc/man7/EVP_KDF-X942.pod
+++ b/doc/man7/EVP_KDF-X942.pod
@@ -98,12 +98,12 @@ RFC 2631
=head1 SEE ALSO
-L<EVP_KDF>,
-L<EVP_KDF-CTX_new_id(3)>,
-L<EVP_KDF-CTX_free(3)>,
-L<EVP_KDF-ctrl(3)>,
-L<EVP_KDF-size(3)>,
-L<EVP_KDF-derive(3)>,
+L<EVP_KDF(3)>,
+L<EVP_KDF_CTX_new(3)>,
+L<EVP_KDF_CTX_free(3)>,
+L<EVP_KDF_CTX_set_params(3)>,
+L<EVP_KDF_size(3)>,
+L<EVP_KDF_derive(3)>,
L<EVP_KDF(3)/PARAMETERS>
=head1 HISTORY
diff --git a/doc/man7/EVP_KDF-X963.pod b/doc/man7/EVP_KDF-X963.pod
index 0986525846..36dc2bab1c 100644
--- a/doc/man7/EVP_KDF-X963.pod
+++ b/doc/man7/EVP_KDF-X963.pod
@@ -87,13 +87,13 @@ value "label":
=head1 SEE ALSO
-L<EVP_KDF>,
-L<EVP_KDF-CTX_new_id(3)>,
-L<EVP_KDF-CTX_free(3)>,
-L<EVP_KDF-ctrl(3)>,
-L<EVP_KDF-size(3)>,
-L<EVP_KDF-derive(3)>,
-L<EVP_KDF-CTX(3)/PARAMETERS>
+L<EVP_KDF(3)>,
+L<EVP_KDF_CTX_new(3)>,
+L<EVP_KDF_CTX_free(3)>,
+L<EVP_KDF_CTX_set_params(3)>,
+L<EVP_KDF_size(3)>,
+L<EVP_KDF_derive(3)>,
+L<EVP_KDF(3)/PARAMETERS>
=head1 HISTORY
diff --git a/doc/man7/EVP_MAC-BLAKE2.pod b/doc/man7/EVP_MAC-BLAKE2.pod
index 6ceb65d9e9..21be5223c9 100644
--- a/doc/man7/EVP_MAC-BLAKE2.pod
+++ b/doc/man7/EVP_MAC-BLAKE2.pod
@@ -25,7 +25,7 @@ properties, to be used with EVP_MAC_fetch():
=head2 Supported parameters
The general description of these parameters can be found in
-L<EVP_MAC(3)/PARAMETER NAMES>.
+L<EVP_MAC(3)/PARAMETERS>.
All these parameters can be set with EVP_MAC_CTX_set_params().
Furthermore, the "size" parameter can be retrieved with
@@ -61,7 +61,7 @@ It is 32 and 64 respectively by default.
=head1 SEE ALSO
L<EVP_MAC_CTX_get_params(3)>, L<EVP_MAC_CTX_set_params(3)>,
-L<EVP_MAC(3)/PARAMETER NAMES>, L<OSSL_PARAM(3)>
+L<EVP_MAC(3)/PARAMETERS>, L<OSSL_PARAM(3)>
=head1 HISTORY
diff --git a/doc/man7/EVP_MAC-CMAC.pod b/doc/man7/EVP_MAC-CMAC.pod
index e7675e2f7a..05d198a7a5 100644
--- a/doc/man7/EVP_MAC-CMAC.pod
+++ b/doc/man7/EVP_MAC-CMAC.pod
@@ -22,7 +22,7 @@ used with EVP_MAC_fetch():
=head2 Supported parameters
The general description of these parameters can be found in
-L<EVP_MAC(3)/PARAMETER NAMES>.
+L<EVP_MAC(3)/PARAMETERS>.
The following parameter can be set with EVP_MAC_CTX_set_params():
@@ -52,7 +52,7 @@ The "size" parameter can also be retrieved with with
EVP_MAC_size().
=head1 SEE ALSO
L<EVP_MAC_CTX_get_params(3)>, L<EVP_MAC_CTX_set_params(3)>,
-L<EVP_MAC(3)/PARAMETER NAMES>, L<OSSL_PARAM(3)>
+L<EVP_MAC(3)/PARAMETERS>, L<OSSL_PARAM(3)>
=head1 COPYRIGHT
diff --git a/doc/man7/EVP_MAC-GMAC.pod b/doc/man7/EVP_MAC-GMAC.pod
index fcd9c9625a..4953221909 100644
--- a/doc/man7/EVP_MAC-GMAC.pod
+++ b/doc/man7/EVP_MAC-GMAC.pod
@@ -22,7 +22,7 @@ used with EVP_MAC_fetch():
=head2 Supported parameters
The general description of these parameters can be found in
-L<EVP_MAC(3)/PARAMETER NAMES>.
+L<EVP_MAC(3)/PARAMETERS>.
The following parameter can be set with EVP_MAC_CTX_set_params():
@@ -54,7 +54,7 @@ The "size" parameter can also be retrieved with
EVP_MAC_size().
=head1 SEE ALSO
L<EVP_MAC_CTX_get_params(3)>, L<EVP_MAC_CTX_set_params(3)>,
-L<EVP_MAC(3)/PARAMETER NAMES>, L<OSSL_PARAM(3)>
+L<EVP_MAC(3)/PARAMETERS>, L<OSSL_PARAM(3)>
=head1 COPYRIGHT
diff --git a/doc/man7/EVP_MAC-HMAC.pod b/doc/man7/EVP_MAC-HMAC.pod
index 0fb92d329e..6e9e74dd37 100644
--- a/doc/man7/EVP_MAC-HMAC.pod
+++ b/doc/man7/EVP_MAC-HMAC.pod
@@ -22,7 +22,7 @@ used with EVP_MAC_fetch():
=head2 Supported parameters
The general description of these parameters can be found in
-L<EVP_MAC(3)/PARAMETER NAMES>.
+L<EVP_MAC(3)/PARAMETERS>.
The following parameter can be set with EVP_MAC_CTX_set_params():
@@ -56,7 +56,7 @@ The "size" parameter can also be retrieved with
EVP_MAC_size().
=head1 SEE ALSO
L<EVP_MAC_CTX_get_params(3)>, L<EVP_MAC_CTX_set_params(3)>,
-L<EVP_MAC(3)/PARAMETER NAMES>, L<OSSL_PARAM(3)>, L<HMAC(3)>
+L<EVP_MAC(3)/PARAMETERS>, L<OSSL_PARAM(3)>, L<HMAC(3)>
=head1 COPYRIGHT
diff --git a/doc/man7/EVP_MAC-KMAC.pod b/doc/man7/EVP_MAC-KMAC.pod
index 71a3bf21c2..d241414428 100644
--- a/doc/man7/EVP_MAC-KMAC.pod
+++ b/doc/man7/EVP_MAC-KMAC.pod
@@ -25,7 +25,7 @@ properties, to be used with EVP_MAC_fetch():
=head2 Supported parameters
The general description of these parameters can be found in
-L<EVP_MAC(3)/PARAMETER NAMES>.
+L<EVP_MAC(3)/PARAMETERS>.
All these parameters can be set with EVP_MAC_CTX_set_params().
Furthermore, the "size" parameter can be retrieved with
@@ -50,7 +50,7 @@ the input stream is set to zero.
=head1 SEE ALSO
L<EVP_MAC_CTX_get_params(3)>, L<EVP_MAC_CTX_set_params(3)>,
-L<EVP_MAC(3)/PARAMETER NAMES>, L<OSSL_PARAM(3)>
+L<EVP_MAC(3)/PARAMETERS>, L<OSSL_PARAM(3)>
=head1 COPYRIGHT
diff --git a/doc/man7/EVP_MAC-Poly1305.pod b/doc/man7/EVP_MAC-Poly1305.pod
index 02cbe0e4b4..5f606d66b2 100644
--- a/doc/man7/EVP_MAC-Poly1305.pod
+++ b/doc/man7/EVP_MAC-Poly1305.pod
@@ -22,7 +22,7 @@ used with EVP_MAC_fetch():
=head2 Supported parameters
The general description of these parameters can be found in
-L<EVP_MAC(3)/PARAMETER NAMES>.
+L<EVP_MAC(3)/PARAMETERS>.
The following parameter can be set with EVP_MAC_CTX_set_params():
@@ -46,7 +46,7 @@ The "size" parameter can also be retrieved with with
EVP_MAC_size().
=head1 SEE ALSO
L<EVP_MAC_CTX_get_params(3)>, L<EVP_MAC_CTX_set_params(3)>,
-L<EVP_MAC(3)/PARAMETER NAMES>, L<OSSL_PARAM(3)>
+L<EVP_MAC(3)/PARAMETERS>, L<OSSL_PARAM(3)>
=head1 COPYRIGHT
diff --git a/doc/man7/EVP_MAC-Siphash.pod b/doc/man7/EVP_MAC-Siphash.pod
index 25e0a8fa38..f82a668851 100644
--- a/doc/man7/EVP_MAC-Siphash.pod
+++ b/doc/man7/EVP_MAC-Siphash.pod
@@ -23,7 +23,7 @@ used with EVP_MAC_fetch():
=head2 Supported parameters
The general description of these parameters can be found in
-L<EVP_MAC(3)/PARAMETER NAMES>.
+L<EVP_MAC(3)/PARAMETERS>.
All these parameters can be set with EVP_MAC_CTX_set_params().
Furthermore, the "size" parameter can be retrieved with
@@ -40,7 +40,7 @@ EVP_MAC_CTX_get_params(), or with EVP_MAC_size().
=head1 SEE ALSO
L<EVP_MAC_CTX_get_params(3)>, L<EVP_MAC_CTX_set_params(3)>,
-L<EVP_MAC(3)/PARAMETER NAMES>, L<OSSL_PARAM(3)>
+L<EVP_MAC(3)/PARAMETERS>, L<OSSL_PARAM(3)>
=head1 COPYRIGHT
