diff options
author | Richard Levitte <levitte@openssl.org> | 2019-11-01 22:58:27 +0100 |
---|---|---|
committer | Patrick Steuer <patrick.steuer@de.ibm.com> | 2019-11-03 11:19:04 +0100 |
commit | 909ef4de3187b752710b7ae69b6df5df51251600 (patch) | |
tree | 8e4d795fe4ea7883f4608e8886659e970a9156cc /doc | |
parent | 2c99372dbdab23726327777f36e2cbc0a1af0873 (diff) |
doc/man3/OSSL_PARAM.pod: Clarify return_size with integer types
Reviewed-by: Patrick Steuer <patrick.steuer@de.ibm.com>
(Merged from https://github.com/openssl/openssl/pull/10326)
Diffstat (limited to 'doc')
-rw-r--r-- | doc/man3/OSSL_PARAM.pod | 24 |
1 files changed, 18 insertions, 6 deletions
diff --git a/doc/man3/OSSL_PARAM.pod b/doc/man3/OSSL_PARAM.pod index df532b4264..cd7d41006b 100644 --- a/doc/man3/OSSL_PARAM.pod +++ b/doc/man3/OSSL_PARAM.pod @@ -100,10 +100,12 @@ accepted, otherwise it specifies the maximum size allowed. =item I<return_size> When an array of B<OSSL_PARAM> is used to request data, the -I<responder> must set this field to indicate the actual size of the -parameter data. -In case the I<data_size> is too small for the data, the I<responder> -must still set this field to indicate the minimum data size required. +I<responder> must set this field to indicate size of the parameter +data, including padding as the case may be. +In case the I<data_size> is an unsuitable size for the data, the +I<responder> must still set this field to indicate the minimum data +size required. +(further notes on this in L</NOTES> below). When the B<OSSL_PARAM> is used as a parameter descriptor, I<return_size> should be ignored. @@ -238,8 +240,18 @@ B<OSSL_PARAM_OCTET_STRING>), but this is in no way mandatory. 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 required size, and eventually return an -error. +B<OSSL_PARAM> item to the minimum required size, and eventually return +an error. + +=item * + +For the integer type parameters (B<OSSL_PARAM_UNSIGNED_INTEGER> and +B<OSSL_PARAM_INTEGER>), a I<responder> may choose to return an error +if the I<data_size> isn't a suitable size (even if I<data_size> is +bigger than needed). If the I<responder> finds the size suitable, it +must fill all I<data_size> bytes and ensure correct padding for the +native endianness, and set I<return_size> to the same value as +I<data_size>. =back |