diff options
| author | Richard Levitte <levitte@openssl.org> | 2019-09-26 07:45:33 +0200 |
|---|---|---|
| committer | Richard Levitte <levitte@openssl.org> | 2019-09-27 19:03:34 +0200 |
| commit | 8f3b8fd6f45fc5f2ab924011908a1e66c2dba462 (patch) | |
| tree | beee6b69801d4025d41225e466e7513a6bc416e8 /doc/man3/OSSL_PARAM_int.pod | |
| parent | OSSL_PARAM.pod: document the mechanism to figure out buffer sizes (diff) | |
| download | openssl-8f3b8fd6f45fc5f2ab924011908a1e66c2dba462.tar.xz openssl-8f3b8fd6f45fc5f2ab924011908a1e66c2dba462.zip | |
OSSL_PARAM functions: change to allow the data field to be NULL
Reviewed-by: Paul Dale <paul.dale@oracle.com>
(Merged from https://github.com/openssl/openssl/pull/10025)
Diffstat (limited to '')
| -rw-r--r-- | doc/man3/OSSL_PARAM_int.pod | 14 |
1 files changed, 11 insertions, 3 deletions
diff --git a/doc/man3/OSSL_PARAM_int.pod b/doc/man3/OSSL_PARAM_int.pod index 742e8d5774..991b3d1212 100644 --- a/doc/man3/OSSL_PARAM_int.pod +++ b/doc/man3/OSSL_PARAM_int.pod @@ -198,6 +198,8 @@ Type coercion takes place as discussed in the NOTES section. OSSL_PARAM_set_TYPE() stores a value B<val> of type B<TYPE> into the parameter B<p>. +If the parameter's I<data> field is NULL, then only its I<return_size> field +will be assigned the size the parameter's I<data> buffer should have. Type coercion takes place as discussed in the NOTES section. OSSL_PARAM_get_BN() retrieves a BIGNUM from the parameter pointed to by B<p>. @@ -205,6 +207,8 @@ The BIGNUM referenced by B<val> is updated and is allocated if B<*val> is B<NULL>. OSSL_PARAM_set_BN() stores the BIGNUM B<val> into the parameter B<p>. +If the parameter's I<data> field is NULL, then only its I<return_size> field +will be assigned the size the parameter's I<data> buffer should have. OSSL_PARAM_get_utf8_string() retrieves a UTF8 string from the parameter pointed to by B<p>. @@ -215,6 +219,8 @@ If memory is allocated by this function, it must be freed by the caller. OSSL_PARAM_set_utf8_string() sets a UTF8 string from the parameter pointed to by B<p> to the value referenced by B<val>. +If the parameter's I<data> field is NULL, then only its I<return_size> field +will be assigned the size the parameter's I<data> buffer should have. OSSL_PARAM_get_octet_string() retrieves an OCTET string from the parameter pointed to by B<p>. @@ -225,6 +231,8 @@ If memory is allocated by this function, it must be freed by the caller. OSSL_PARAM_set_octet_string() sets an OCTET string from the parameter pointed to by B<p> to the value referenced by B<val>. +If the parameter's I<data> field is NULL, then only its I<return_size> field +will be assigned the size the parameter's I<data> buffer should have. OSSL_PARAM_get_utf8_ptr() retrieves the UTF8 string pointer from the parameter referenced by B<p> and stores it in B<*val>. @@ -260,9 +268,9 @@ representable by the target type or parameter. Apart from that, the functions must be used appropriately for the expected type of the parameter. -For OSSL_PARAM_get_utf8_ptr() and OSSL_PARAM_get_octet_ptr(), B<bsize> -is not relevant if the purpose is to send the B<OSSL_PARAM> array to a -I<responder>, i.e. to get parameter data back. +For OSSL_PARAM_construct_utf8_ptr() and OSSL_PARAM_consstruct_octet_ptr(), +B<bsize> is not relevant if the purpose is to send the B<OSSL_PARAM> array +to a I<responder>, i.e. to get parameter data back. In that case, B<bsize> can safely be given zero. See L<OSSL_PARAM(3)/DESCRIPTION> for further information on the possible purposes. |