1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
|
.\" $OpenBSD: BN_add_word.3,v 1.4 2016/11/20 16:27:14 schwarze Exp $
.\" OpenSSL b97fdb57 Nov 11 09:33:09 2016 +0100
.\"
.\" This file was written by Ulf Moeller <ulf@openssl.org>.
.\" Copyright (c) 2000, 2005 The OpenSSL Project. All rights reserved.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\"
.\" 1. Redistributions of source code must retain the above copyright
.\" notice, this list of conditions and the following disclaimer.
.\"
.\" 2. Redistributions in binary form must reproduce the above copyright
.\" notice, this list of conditions and the following disclaimer in
.\" the documentation and/or other materials provided with the
.\" distribution.
.\"
.\" 3. All advertising materials mentioning features or use of this
.\" software must display the following acknowledgment:
.\" "This product includes software developed by the OpenSSL Project
.\" for use in the OpenSSL Toolkit. (http://www.openssl.org/)"
.\"
.\" 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
.\" endorse or promote products derived from this software without
.\" prior written permission. For written permission, please contact
.\" openssl-core@openssl.org.
.\"
.\" 5. Products derived from this software may not be called "OpenSSL"
.\" nor may "OpenSSL" appear in their names without prior written
.\" permission of the OpenSSL Project.
.\"
.\" 6. Redistributions of any form whatsoever must retain the following
.\" acknowledgment:
.\" "This product includes software developed by the OpenSSL Project
.\" for use in the OpenSSL Toolkit (http://www.openssl.org/)"
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
.\" EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
.\" PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE OpenSSL PROJECT OR
.\" ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
.\" SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
.\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
.\" LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
.\" STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
.\" OF THE POSSIBILITY OF SUCH DAMAGE.
.\"
.Dd $Mdocdate: November 20 2016 $
.Dt BN_ADD_WORD 3
.Os
.Sh NAME
.Nm BN_add_word ,
.Nm BN_sub_word ,
.Nm BN_mul_word ,
.Nm BN_div_word ,
.Nm BN_mod_word
.Nd arithmetic functions on BIGNUMs with integers
.Sh SYNOPSIS
.In openssl/bn.h
.Ft int
.Fo BN_add_word
.Fa "BIGNUM *a"
.Fa "BN_ULONG w"
.Fc
.Ft int
.Fo BN_sub_word
.Fa "BIGNUM *a"
.Fa "BN_ULONG w"
.Fc
.Ft int
.Fo BN_mul_word
.Fa "BIGNUM *a"
.Fa "BN_ULONG w"
.Fc
.Ft BN_ULONG
.Fo BN_div_word
.Fa "BIGNUM *a"
.Fa "BN_ULONG w"
.Fc
.Ft BN_ULONG
.Fo BN_mod_word
.Fa "const BIGNUM *a"
.Fa "BN_ULONG w"
.Fc
.Sh DESCRIPTION
These functions perform arithmetic operations on BIGNUMs with unsigned
integers.
They are much more efficient than the normal BIGNUM arithmetic
operations.
.Pp
.Fn BN_add_word
adds
.Fa w
to
.Fa a
.Pq Li a+=w .
.Pp
.Fn BN_sub_word
subtracts
.Fa w
from
.Fa a
.Pq Li a-=w .
.Pp
.Fn BN_mul_word
multiplies
.Fa a
and
.Fa w
.Pq Li a*=w .
.Pp
.Fn BN_div_word
divides
.Fa a
by
.Fa w
.Pq Li a/=w
and returns the remainder.
.Pp
.Fn BN_mod_word
returns the remainder of
.Fa a
divided by
.Fa w
.Pq Li a%w .
.Pp
For
.Fn BN_div_word
and
.Fn BN_mod_word ,
.Fa w
must not be 0.
.Sh RETURN VALUES
.Fn BN_add_word ,
.Fn BN_sub_word ,
and
.Fn BN_mul_word
return 1 for success or 0 on error.
The error codes can be obtained by
.Xr ERR_get_error 3 .
.Pp
.Fn BN_mod_word
and
.Fn BN_div_word
return
.Fa a Ns % Ns Fa w
on success and
.Po Vt BN_ULONG Pc Ns -1
if an error occurred.
.Sh SEE ALSO
.Xr bn 3 ,
.Xr BN_add 3 ,
.Xr ERR_get_error 3
.Sh HISTORY
.Fn BN_add_word
and
.Fn BN_mod_word
are available in all versions of SSLeay and OpenSSL.
.Fn BN_div_word
was added in SSLeay 0.8, and
.Fn BN_sub_word
and
.Fn BN_mul_word
in SSLeay 0.9.0.
.Pp
Before 0.9.8a, the return value for
.Fn BN_div_word
and
.Fn BN_mod_word
in case of an error was 0.
|
