Clarify how to return string data
authorWatson Ladd <watsonbladd@gmail.com>
Fri, 19 May 2023 20:55:08 +0000 (13:55 -0700)
committerTomas Mraz <tomas@openssl.org>
Thu, 25 May 2023 13:48:24 +0000 (15:48 +0200)
Reviewed-by: Paul Dale <pauli@openssl.org>
Reviewed-by: Tomas Mraz <tomas@openssl.org>
(Merged from https://github.com/openssl/openssl/pull/21004)

doc/man3/OSSL_PARAM.pod

index a1a275e0921aeeb13a6f0c92a680701dc7495eef..18da5bf99a04ac104877e32003d8b333572b8419 100644 (file)
@@ -267,6 +267,14 @@ B<OSSL_PARAM_OCTET_STRING>), but this is in no way mandatory.
 
 =item *
 
+If I<data> for a B<OSSL_PARAM_OCTET_STRING> or a
+B<OSSL_PARAM_UTF8_STRING> is NULL, the I<responder> should
+set I<return_size> to the size of the item to be returned
+and return success. Later the responder will be called again
+with I<data> pointing at the place for the value to be put.
+
+=item *
+
 If a I<responder> finds that some data sizes are too small for the
 requested data, it must set I<return_size> for each such
 B<OSSL_PARAM> item to the minimum required size, and eventually return