doc: note that get_params and set_params calls should return true if the param array...

Reviewed-by: Shane Lontis <shane.lontis@oracle.com>
(Merged from https://github.com/openssl/openssl/pull/14383)

diff --git a/doc/man7/provider-asym_cipher.pod b/doc/man7/provider-asym_cipher.pod
index 91c1c0f830ee49f58bf6695246488b9316bbb400..108fbceceb6f0aae20176d922212ed4ba97c067b 100644 (file)
--- a/doc/man7/provider-asym_cipher.pod
+++ b/doc/man7/provider-asym_cipher.pod
@@ -173,9 +173,12 @@ functions.
 OSSL_FUNC_asym_cipher_get_ctx_params() gets asymmetric cipher parameters associated
 with the given provider side asymmetric cipher context I<ctx> and stores them in
 I<params>.
+Passing NULL for I<params> should return true.
+
 OSSL_FUNC_asym_cipher_set_ctx_params() sets the asymmetric cipher parameters associated
 with the given provider side asymmetric cipher context I<ctx> to I<params>.
 Any parameter settings are additional to any that were previously set.
+Passing NULL for I<params> should return true.
 
 Parameters currently recognised by built-in asymmetric cipher algorithms are as
 follows.

diff --git a/doc/man7/provider-cipher.pod b/doc/man7/provider-cipher.pod
index 13ec95568c1bf9b4beb2f7aae62cce6390a4ddd0..de5be060a1663c93931b1fb75d4efef4b6e0386b 100644 (file)
--- a/doc/man7/provider-cipher.pod
+++ b/doc/man7/provider-cipher.pod
@@ -186,9 +186,11 @@ and stores them in I<params>.
 OSSL_FUNC_cipher_set_ctx_params() sets cipher operation parameters for the
 provider side cipher context I<cctx> to I<params>.
 Any parameter settings are additional to any that were previously set.
+Passing NULL for I<params> should return true.
 
 OSSL_FUNC_cipher_get_ctx_params() gets cipher operation details details from
 the given provider side cipher context I<cctx> and stores them in I<params>.
+Passing NULL for I<params> should return true.
 
 OSSL_FUNC_cipher_gettable_params(), OSSL_FUNC_cipher_gettable_ctx_params(),
 and OSSL_FUNC_cipher_settable_ctx_params() all return constant B<OSSL_PARAM>

diff --git a/doc/man7/provider-digest.pod b/doc/man7/provider-digest.pod
index 8307428b16e80461585bf184205cd6ace2f1e4f9..ce53c61de4e971f758305df3a27c855ba64022df 100644 (file)
--- a/doc/man7/provider-digest.pod
+++ b/doc/man7/provider-digest.pod
@@ -152,9 +152,11 @@ and stores them in I<params>.
 OSSL_FUNC_digest_set_ctx_params() sets digest operation parameters for the
 provider side digest context I<dctx> to I<params>.
 Any parameter settings are additional to any that were previously set.
+Passing NULL for I<params> should return true.
 
 OSSL_FUNC_digest_get_ctx_params() gets digest operation details details from
 the given provider side digest context I<dctx> and stores them in I<params>.
+Passing NULL for I<params> should return true.
 
 OSSL_FUNC_digest_gettable_params() returns a constant B<OSSL_PARAM> array
 containing descriptors of the parameters that OSSL_FUNC_digest_get_params()

diff --git a/doc/man7/provider-encoder.pod b/doc/man7/provider-encoder.pod
index 2fcbd6499a4c1a6fb9c5456d024d151970a386bc..5e34b7a3946145b5a14c79678f9d4b93d5dd1178 100644 (file)
--- a/doc/man7/provider-encoder.pod
+++ b/doc/man7/provider-encoder.pod
@@ -197,6 +197,7 @@ OSSL_FUNC_encoder_newctx().
 OSSL_FUNC_encoder_set_ctx_params() sets context data according to parameters
 from I<params> that it recognises.  Unrecognised parameters should be
 ignored.
+Passing NULL for I<params> should return true.
 
 OSSL_FUNC_encoder_settable_ctx_params() returns a constant B<OSSL_PARAM>
 array describing the parameters that OSSL_FUNC_encoder_set_ctx_params()

diff --git a/doc/man7/provider-kdf.pod b/doc/man7/provider-kdf.pod
index 0b13537e8d454ca3549498712980030bc46550fe..fb9e30a843da36e8029250d1c094c73b8d823376 100644 (file)
--- a/doc/man7/provider-kdf.pod
+++ b/doc/man7/provider-kdf.pod
@@ -127,9 +127,11 @@ provider algorithm and stores them in I<params>.
 OSSL_FUNC_kdf_set_ctx_params() sets KDF parameters associated with the given
 provider side KDF context I<kctx> to I<params>.
 Any parameter settings are additional to any that were previously set.
+Passing NULL for I<params> should return true.
 
 OSSL_FUNC_kdf_get_ctx_params() retrieves gettable parameter values associated
 with the given provider side KDF context I<kctx> and stores them in I<params>.
+Passing NULL for I<params> should return true.
 
 OSSL_FUNC_kdf_gettable_params(), OSSL_FUNC_kdf_gettable_ctx_params(),
 and OSSL_FUNC_kdf_settable_ctx_params() all return constant B<OSSL_PARAM>

diff --git a/doc/man7/provider-kem.pod b/doc/man7/provider-kem.pod
index 7ed98ba05cc921c0525095c2c27923453afca88a..3ed9ff11fc902ec53c1033bddbd968339ff35a0b 100644 (file)
--- a/doc/man7/provider-kem.pod
+++ b/doc/man7/provider-kem.pod
@@ -171,9 +171,12 @@ functions.
 OSSL_FUNC_kem_get_ctx_params() gets asymmetric kem parameters associated
 with the given provider side asymmetric kem context I<ctx> and stores them in
 I<params>.
+Passing NULL for I<params> should return true.
+
 OSSL_FUNC_kem_set_ctx_params() sets the asymmetric kem parameters associated
 with the given provider side asymmetric kem context I<ctx> to I<params>.
 Any parameter settings are additional to any that were previously set.
+Passing NULL for I<params> should return true.
 
 No parameters are currently recognised by built-in asymmetric kem algorithms.
 

diff --git a/doc/man7/provider-keyexch.pod b/doc/man7/provider-keyexch.pod
index 577fc385108824f5360da6936efbdcf64422454a..0fc36c5da6975e2ec6d77bc6dd09fd5c3d4cbe3c 100644 (file)
--- a/doc/man7/provider-keyexch.pod
+++ b/doc/man7/provider-keyexch.pod
@@ -139,10 +139,12 @@ OSSL_FUNC_keyexch_set_ctx_params() sets key exchange parameters associated with
 given provider side key exchange context I<ctx> to I<params>,
 see L</Common Key Exchange parameters>.
 Any parameter settings are additional to any that were previously set.
+Passing NULL for I<params> should return true.
 
 OSSL_FUNC_keyexch_get_ctx_params() gets key exchange parameters associated with the
 given provider side key exchange context I<ctx> into I<params>,
 see L</Common Key Exchange parameters>.
+Passing NULL for I<params> should return true.
 
 OSSL_FUNC_keyexch_settable_ctx_params() yields a constant B<OSSL_PARAM> array that
 describes the settable parameters, i.e. parameters that can be used with

diff --git a/doc/man7/provider-mac.pod b/doc/man7/provider-mac.pod
index 8b4ce936133d90f6452838da49534c807b4dd0a1..82bbdb9aa24d4cae52f7b34df54f84db4a37fae6 100644 (file)
--- a/doc/man7/provider-mac.pod
+++ b/doc/man7/provider-mac.pod
@@ -137,10 +137,12 @@ provider algorithm and stores them in I<params>.
 OSSL_FUNC_mac_set_ctx_params() sets mac parameters associated with the given
 provider side mac context I<mctx> to I<params>.
 Any parameter settings are additional to any that were previously set.
+Passing NULL for I<params> should return true.
 
 OSSL_FUNC_mac_get_ctx_params() gets details of currently set parameter values
 associated with the given provider side mac context I<mctx> and stores them
 in I<params>.
+Passing NULL for I<params> should return true.
 
 OSSL_FUNC_mac_gettable_params(), OSSL_FUNC_mac_gettable_ctx_params(),
 and OSSL_FUNC_mac_settable_ctx_params() all return constant B<OSSL_PARAM>

diff --git a/doc/man7/provider-rand.pod b/doc/man7/provider-rand.pod
index 157f6227e9c644703cea485019cec059b3d62e41..be8123761008037b782deb0a67367ee890d75dc6 100644 (file)
--- a/doc/man7/provider-rand.pod
+++ b/doc/man7/provider-rand.pod
@@ -160,10 +160,12 @@ provider algorithm and stores them in I<params>.
 OSSL_FUNC_rand_set_ctx_params() sets rand parameters associated with the given
 provider side rand context I<ctx> to I<params>.
 Any parameter settings are additional to any that were previously set.
+Passing NULL for I<params> should return true.
 
 OSSL_FUNC_rand_get_ctx_params() gets details of currently set parameter values
 associated with the given provider side rand context I<ctx> and stores them
 in I<params>.
+Passing NULL for I<params> should return true.
 
 OSSL_FUNC_rand_gettable_params(), OSSL_FUNC_rand_gettable_ctx_params(),
 and OSSL_FUNC_rand_settable_ctx_params() all return constant B<OSSL_PARAM>

diff --git a/doc/man7/provider-signature.pod b/doc/man7/provider-signature.pod
index 44bfa706c4d6c0afd65b00add1b5f7f360926e3b..fe8a68b77cae56970d640462e0cbb4606bd706ea 100644 (file)
--- a/doc/man7/provider-signature.pod
+++ b/doc/man7/provider-signature.pod
@@ -332,9 +332,12 @@ the OSSL_FUNC_signature_get_ctx_params() and OSSL_FUNC_signature_set_ctx_params(
 
 OSSL_FUNC_signature_get_ctx_params() gets signature parameters associated with the
 given provider side signature context I<ctx> and stored them in I<params>.
+Passing NULL for I<params> should return true.
+
 OSSL_FUNC_signature_set_ctx_params() sets the signature parameters associated with the
 given provider side signature context I<ctx> to I<params>.
 Any parameter settings are additional to any that were previously set.
+Passing NULL for I<params> should return true.
 
 Common parameters currently recognised by built-in signature algorithms are as
 follows.
@@ -391,9 +394,12 @@ functions.
 
 OSSL_FUNC_signature_get_md_ctx_params() gets digest parameters associated with the
 given provider side digest signature context I<ctx> and stores them in I<params>.
+Passing NULL for I<params> should return true.
+
 OSSL_FUNC_signature_set_ms_ctx_params() sets the digest parameters associated with the
 given provider side digest signature context I<ctx> to I<params>.
 Any parameter settings are additional to any that were previously set.
+Passing NULL for I<params> should return true.
 
 Parameters currently recognised by built-in signature algorithms are the same
 as those for built-in digest algorithms. See

diff --git a/doc/man7/provider-storemgmt.pod b/doc/man7/provider-storemgmt.pod
index 2e5bddc5ec6f4cee1683fb4adc1d71b3c4ed39d7..8b4c7dbe71e35951050140654eedb6f424fa169d 100644 (file)
--- a/doc/man7/provider-storemgmt.pod
+++ b/doc/man7/provider-storemgmt.pod
@@ -89,6 +89,7 @@ OSSL_FUNC_store_set_ctx_params() should set additional parameters, such as what
 kind of data to expect, search criteria, and so on.  More on those below, in
 L</Load Parameters>.  Whether unrecognised parameters are an error or simply
 ignored is at the implementation's discretion.
+Passing NULL for I<params> should return true.
 
 OSSL_FUNC_store_load() loads the next object from the URI opened by
 OSSL_FUNC_store_open(), creates an object abstraction for it (see