diff options
author | Hubert Kario <hkario@redhat.com> | 2017-09-29 15:40:43 +0200 |
---|---|---|
committer | Rich Salz <rsalz@openssl.org> | 2017-09-29 12:53:14 -0400 |
commit | d9a38e859dfe30a112c421dc7b32821370efd805 (patch) | |
tree | 1295012d42c113ad63fd4480f1339f52bfb19c35 /doc/crypto | |
parent | 20d2aaf22e54d07ead144c5e79fdaf6903cdbf2d (diff) |
doc: note that the BN_new() initialises the BIGNUM
BN_new() and BN_secure_new() not only allocate memory, but also
initialise it to deterministic value - 0.
Document that behaviour to make it explicit
backport from #4438
Reviewed-by: Richard Levitte <levitte@openssl.org>
Reviewed-by: Rich Salz <rsalz@openssl.org>
(Merged from https://github.com/openssl/openssl/pull/4443)
Diffstat (limited to 'doc/crypto')
-rw-r--r-- | doc/crypto/BN_new.pod | 3 |
1 files changed, 2 insertions, 1 deletions
diff --git a/doc/crypto/BN_new.pod b/doc/crypto/BN_new.pod index 413a1ea842..d446603191 100644 --- a/doc/crypto/BN_new.pod +++ b/doc/crypto/BN_new.pod @@ -34,7 +34,8 @@ If B<a> is NULL, nothing is done. =head1 RETURN VALUES -BN_new() returns a pointer to the B<BIGNUM>. If the allocation fails, +BN_new() returns a pointer to the B<BIGNUM> initialised to the value 0. +If the allocation fails, it returns B<NULL> and sets an error code that can be obtained by L<ERR_get_error(3)|ERR_get_error(3)>. |