Go to main content

man pages section 3: Extended Library Functions, Volume 1

Exit Print View

Updated: Wednesday, July 27, 2022
 
 

BN_add_word (3openssl)

Name

BN_add_word - arithmetic functions on BIGNUMs with integers

Synopsis

#include <openssl/bn.h>

int BN_add_word(BIGNUM *a, BN_ULONG w);

int BN_sub_word(BIGNUM *a, BN_ULONG w);

int BN_mul_word(BIGNUM *a, BN_ULONG w);

BN_ULONG BN_div_word(BIGNUM *a, BN_ULONG w);

BN_ULONG BN_mod_word(const BIGNUM *a, BN_ULONG w);

Description

BN_add_word(3openssl)               OpenSSL              BN_add_word(3openssl)



NAME
       BN_add_word, BN_sub_word, BN_mul_word, BN_div_word, BN_mod_word -
       arithmetic functions on BIGNUMs with integers

SYNOPSIS
        #include <openssl/bn.h>

        int BN_add_word(BIGNUM *a, BN_ULONG w);

        int BN_sub_word(BIGNUM *a, BN_ULONG w);

        int BN_mul_word(BIGNUM *a, BN_ULONG w);

        BN_ULONG BN_div_word(BIGNUM *a, BN_ULONG w);

        BN_ULONG BN_mod_word(const BIGNUM *a, BN_ULONG w);

DESCRIPTION
       These functions perform arithmetic operations on BIGNUMs with unsigned
       integers. They are much more efficient than the normal BIGNUM
       arithmetic operations.

       BN_add_word() adds w to a ("a+=w").

       BN_sub_word() subtracts w from a ("a-=w").

       BN_mul_word() multiplies a and w ("a*=w").

       BN_div_word() divides a by w ("a/=w") and returns the remainder.

       BN_mod_word() returns the remainder of a divided by w ("a%w").

       For BN_div_word() and BN_mod_word(), w must not be 0.

RETURN VALUES
       BN_add_word(), BN_sub_word() and BN_mul_word() return 1 for success, 0
       on error. The error codes can be obtained by ERR_get_error(3).

       BN_mod_word() and BN_div_word() return a%w on success and (BN_ULONG)-1
       if an error occurred.


ATTRIBUTES
       See attributes(7) for descriptions of the following attributes:


       +---------------+--------------------------+
       |ATTRIBUTE TYPE |     ATTRIBUTE VALUE      |
       +---------------+--------------------------+
       |Availability   | library/security/openssl |
       +---------------+--------------------------+
       |Stability      | Pass-through uncommitted |
       +---------------+--------------------------+

SEE ALSO
       bn(3), ERR_get_error(3), BN_add(3)

HISTORY
       BN_add_word() and BN_mod_word() are available in all versions of SSLeay
       and OpenSSL. BN_div_word() was added in SSLeay 0.8, and BN_sub_word()
       and BN_mul_word() in SSLeay 0.9.0.

       Before 0.9.8a the return value for BN_div_word() and BN_mod_word() in
       case of an error was 0.



NOTES
       Source code for open source software components in Oracle Solaris can
       be found at https://www.oracle.com/downloads/opensource/solaris-source-
       code-downloads.html.

       This software was built from source available at
       https://github.com/oracle/solaris-userland.  The original community
       source was downloaded from
       https://www.openssl.org/source/openssl-1.0.2ze.tar.gz.

       Further information about this software can be found on the open source
       community website at https://www.openssl.org/.



1.0.2ze                           2022-05-03             BN_add_word(3openssl)