diff options
| author | Watson Ladd <watsonbladd@gmail.com> | 2023-05-19 13:55:08 -0700 |
|---|---|---|
| committer | Tomas Mraz <tomas@openssl.org> | 2023-05-25 15:48:58 +0200 |
| commit | bdac6bcc50bb93b61989cee3f74a65c34abe1bd2 (patch) | |
| tree | c2ef9d1435bcf2faced217158d449feacd9e7f2a /doc | |
| parent | 16ec1b06bbac4d3130635f74cd0e09e40f222f8e (diff) | |
Clarify how to return string data
Reviewed-by: Paul Dale <pauli@openssl.org>
Reviewed-by: Tomas Mraz <tomas@openssl.org>
(Merged from https://github.com/openssl/openssl/pull/21004)
(cherry picked from commit eab96453bb145cde8e447f420a4ba099a5fa7004)
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/man3/OSSL_PARAM.pod | 8 |
1 files changed, 8 insertions, 0 deletions
diff --git a/doc/man3/OSSL_PARAM.pod b/doc/man3/OSSL_PARAM.pod index 78a465c8fd..4bc0bcf3c0 100644 --- a/doc/man3/OSSL_PARAM.pod +++ b/doc/man3/OSSL_PARAM.pod @@ -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 |