From 8b2124aba357a928fec6d7a3bafe186fc83080fc Mon Sep 17 00:00:00 2001 From: Rich Salz Date: Tue, 23 Jan 2018 09:58:33 -0500 Subject: [PATCH] Fix BN doc Backport from https://github.com/openssl/openssl/pull/5141 Reviewed-by: Viktor Dukhovni Reviewed-by: Bernd Edlinger (Merged from https://github.com/openssl/openssl/pull/5151) --- 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 91d48aad88..70aff843cb 100644 --- a/doc/crypto/BN_zero.pod +++ b/doc/crypto/BN_zero.pod @@ -14,8 +14,8 @@ 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); Deprecated: @@ -25,19 +25,21 @@ Deprecated: =head1 DESCRIPTION +B 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 to the values 0, 1 and B respectively. BN_zero() and BN_one() are macros. BN_value_one() returns a B constant of value 1. This constant is useful for use in comparisons and assignment. -BN_get_word() returns B, if it can be represented as an unsigned -long. +BN_get_word() returns B, if it can be represented as a B. =head1 RETURN VALUES -BN_get_word() returns the value B, and 0xffffffffL if B cannot -be represented as an unsigned long. +BN_get_word() returns the value B, or all-bits-set if B cannot +be represented as a B. BN_one(), BN_set_word() and the deprecated version of BN_zero() return 1 on success, 0 otherwise. @@ -46,10 +48,11 @@ The preferred version of BN_zero() never fails and returns no value. =head1 BUGS -Someone might change the constant. +If a B 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 is equal to 0xffffffffL it can be represented as an -unsigned long but this value is also returned on error. +B should probably be a typedef. =head1 SEE ALSO -- 2.25.1