diff options
| author | Hubert Kario <hkario@redhat.com> | 2017-09-29 15:36:01 +0200 |
|---|---|---|
| committer | Hubert Kario <hkario@redhat.com> | 2017-09-29 15:36:01 +0200 |
| commit | 6787c60df982fe7631c97ca91eff83b5efac017f (patch) | |
| tree | 2ef20f0904e4c3796e68fcb6660f31b9aac1aff4 /doc | |
| parent | effdcf6c2a10afea8041addb8ccce2367ecaac0d (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/4442)
Diffstat (limited to 'doc')
| -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 36bd00da28..08aae5e919 100644 --- a/doc/crypto/BN_new.pod +++ b/doc/crypto/BN_new.pod @@ -36,7 +36,8 @@ If B<a> is NULL, nothing is done. =head1 RETURN VALUES BN_new() and BN_secure_new() -return a pointer to the B<BIGNUM>. If the allocation fails, +return a pointer to the B<BIGNUM> initialised to the value 0. +If the allocation fails, they return B<NULL> and set an error code that can be obtained by L<ERR_get_error(3)>. |