[openssl-commits] [openssl] OpenSSL_1_0_2-stable update

Rich Salz rsalz at openssl.org
Wed Jan 24 21:08:30 UTC 2018

The branch OpenSSL_1_0_2-stable has been updated
       via  d3736a65baadb369b2570bf85d7f966bc567e7ff (commit)
      from  d19bf137ba24ce15ceb1e37e0093f1b7242340f1 (commit)

- Log -----------------------------------------------------------------
commit d3736a65baadb369b2570bf85d7f966bc567e7ff
Author: Rich Salz <rsalz at openssl.org>
Date:   Tue Jan 23 09:58:33 2018 -0500

    Fix BN doc
    Backport from https://github.com/openssl/openssl/pull/5141
    Reviewed-by: Viktor Dukhovni <viktor at openssl.org>
    Reviewed-by: Bernd Edlinger <bernd.edlinger at hotmail.de>
    (Merged from https://github.com/openssl/openssl/pull/5151)
    (cherry picked from commit 8b2124aba357a928fec6d7a3bafe186fc83080fc)


Summary of changes:
 doc/crypto/BN_zero.pod | 21 ++++++++++++---------
 1 file changed, 12 insertions(+), 9 deletions(-)

diff --git a/doc/crypto/BN_zero.pod b/doc/crypto/BN_zero.pod
index b555ec3..8aa9c14 100644
--- a/doc/crypto/BN_zero.pod
+++ b/doc/crypto/BN_zero.pod
@@ -14,34 +14,37 @@ operations
  const BIGNUM *BN_value_one(void);
- int BN_set_word(BIGNUM *a, unsigned long w);
- unsigned long BN_get_word(BIGNUM *a);
+ int BN_set_word(BIGNUM *a, BN_ULONG w);
+ BN_ULONG BN_get_word(BIGNUM *a);
+B<BN_ULONG> is a macro that will be an unsigned integral type optimied
+for the most efficient implementation on the local platform.
 BN_zero(), BN_one() and BN_set_word() set B<a> to the values 0, 1 and
 B<w> respectively.  BN_zero() and BN_one() are macros.
 BN_value_one() returns a B<BIGNUM> constant of value 1. This constant
 is useful for use in comparisons and assignment.
-BN_get_word() returns B<a>, if it can be represented as an unsigned
+BN_get_word() returns B<a>, if it can be represented as a B<BN_ULONG>.
-BN_get_word() returns the value B<a>, and 0xffffffffL if B<a> cannot
-be represented as an unsigned long.
+BN_get_word() returns the value B<a>, or all-bits-set if B<a> cannot
+be represented as a B<BN_ULONG>.
 BN_zero(), BN_one() and BN_set_word() return 1 on success, 0 otherwise.
 BN_value_one() returns the constant.
 =head1 BUGS
-Someone might change the constant.
+If a B<BIGNUM> is equal to the value of all-bits-set, it will collide
+with the error condition returned by BN_get_word() which uses that
+as an error value.
-If a B<BIGNUM> is equal to 0xffffffffL it can be represented as an
-unsigned long but this value is also returned on error.
+B<BN_ULONG> should probably be a typedef.
 =head1 SEE ALSO

More information about the openssl-commits mailing list