summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorRichard Levitte <levitte@openssl.org>2021-11-19 13:18:34 +0100
committerRichard Levitte <levitte@openssl.org>2021-11-23 11:43:07 +0100
commitb5a4f7f56fc8601c6aadd58a5e22ab1a1954ba5a (patch)
tree074114676356b0183f958d6506ca5c29dc2b1705 /doc
parent38e2957249c90317a26a080c7e7eb186dd5b6598 (diff)
Make OSSL_PARAM_BLD_push_BN{,_pad}() return an error on negative numbers
Adding documentation to that fact as well. Fixes #17070 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 db65eabefe76e44818ff8bd19c68990e7dcc70d3)
Diffstat (limited to 'doc')
-rw-r--r--doc/man3/OSSL_PARAM_BLD.pod5
1 files changed, 5 insertions, 0 deletions
diff --git a/doc/man3/OSSL_PARAM_BLD.pod b/doc/man3/OSSL_PARAM_BLD.pod
index d07eff6f27..114ce44489 100644
--- a/doc/man3/OSSL_PARAM_BLD.pod
+++ b/doc/man3/OSSL_PARAM_BLD.pod
@@ -124,6 +124,11 @@ on error.
All of the OSSL_PARAM_BLD_push_TYPE functions return 1 on success and 0
on error.
+=head1 NOTES
+
+OSSL_PARAM_BLD_push_BN() and OSSL_PARAM_BLD_push_BN_pad() currently only
+support nonnegative B<BIGNUM>s. They return an error on negative B<BIGNUM>s.
+
=head1 EXAMPLES
Both examples creating an OSSL_PARAM array that contains an RSA key.