[openssl] master update

Dr. Paul Dale pauli at openssl.org
Tue Jan 11 23:14:43 UTC 2022


The branch master has been updated
       via  254217a4a0c9e64869495447a0e6bdc2323d4cd1 (commit)
      from  e5fb4b1469f317aa92768cdf804dfa29b72cb8f3 (commit)


- Log -----------------------------------------------------------------
commit 254217a4a0c9e64869495447a0e6bdc2323d4cd1
Author: Matt Caswell <matt at openssl.org>
Date:   Fri Jan 7 17:30:39 2022 +0000

    Clarify the int param getter documentation
    
    OSSL_PARAMs that are of type OSSL_PARAM_INTEGER or
    OSSL_PARAM_UNSIGNED_INTEGER can be obtained using any of the functions
    EVP_PKEY_get_int_param(), EVP_PKEY_get_size_t_param() or
    EVP_PKEY_get_bn_param(). The former two will fail if the parameter is too
    large to fit into the C variable. We clarify this in the documentation.
    
    Reviewed-by: Tomas Mraz <tomas at openssl.org>
    Reviewed-by: Paul Dale <pauli at openssl.org>
    (Merged from https://github.com/openssl/openssl/pull/17445)

-----------------------------------------------------------------------

Summary of changes:
 doc/man3/EVP_PKEY_gettable_params.pod | 9 +++++++++
 1 file changed, 9 insertions(+)

diff --git a/doc/man3/EVP_PKEY_gettable_params.pod b/doc/man3/EVP_PKEY_gettable_params.pod
index a3ccf8ec5f..383ca6eb58 100644
--- a/doc/man3/EVP_PKEY_gettable_params.pod
+++ b/doc/man3/EVP_PKEY_gettable_params.pod
@@ -37,6 +37,15 @@ EVP_PKEY_gettable_params() returns a constant list of I<params> indicating
 the names and types of key parameters that can be retrieved.
 See L<OSSL_PARAM(3)> for information about parameters.
 
+An B<OSSL_PARAM> of type B<OSSL_PARAM_INTEGER> or
+B<OSSL_PARAM_UNSIGNED_INTEGER> is of arbitrary length. Such a parameter can be
+obtained using any of the functions EVP_PKEY_get_int_param(),
+EVP_PKEY_get_size_t_param() or EVP_PKEY_get_bn_param(). Attempting to
+obtain an integer value that does not fit into a native C B<int> type will cause
+EVP_PKEY_get_int_param() to fail. Similarly attempting to obtain an integer
+value that is negative or does not fit into a native C B<size_t> type using
+EVP_PKEY_get_size_t_param() will also fail.
+
 EVP_PKEY_get_int_param() retrieves a key I<pkey> integer value I<*out>
 associated with a name of I<key_name>.
 


More information about the openssl-commits mailing list