diff options
| author | Richard Levitte <levitte@openssl.org> | 2021-11-21 09:48:05 +0100 |
|---|---|---|
| committer | Richard Levitte <levitte@openssl.org> | 2021-11-23 11:43:07 +0100 |
| commit | 8100a59fed1c985a3307c97af12cc8794bd93069 (patch) | |
| tree | e0130563f3a6161eee3e102aaf9dfd77c0bfee31 /doc | |
| parent | b5a4f7f56fc8601c6aadd58a5e22ab1a1954ba5a (diff) | |
DOC: OSSL_PARAM_{set,get,construct}_BN() currently only supports nonnegative numbers
Reviewed-by: Matt Caswell <matt@openssl.org>
Reviewed-by: Tomas Mraz <tomas@openssl.org>
(Merged from https://github.com/openssl/openssl/pull/17074)
(cherry picked from commit b33fb68a3230b8fc87f6663212ac3ffae0b361c5)
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/man3/OSSL_PARAM_int.pod | 6 |
1 files changed, 6 insertions, 0 deletions
diff --git a/doc/man3/OSSL_PARAM_int.pod b/doc/man3/OSSL_PARAM_int.pod index 69b723d348..9ca725d120 100644 --- a/doc/man3/OSSL_PARAM_int.pod +++ b/doc/man3/OSSL_PARAM_int.pod @@ -331,6 +331,12 @@ representable by the target type or parameter. Apart from that, the functions must be used appropriately for the expected type of the parameter. +OSSL_PARAM_get_BN() and OSSL_PARAM_set_BN() currently only support +nonnegative B<BIGNUM>s, and by consequence, only +B<OSSL_PARAM_UNSIGNED_INTEGER>. OSSL_PARAM_construct_BN() currently +constructs an B<OSSL_PARAM> structure with the data type +B<OSSL_PARAM_UNSIGNED_INTEGER>. + For OSSL_PARAM_construct_utf8_ptr() and OSSL_PARAM_consstruct_octet_ptr(), I<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. |