• Home
  • Features
  • Pricing
  • Docs
  • Announcements
  • Sign In

randombit / botan / 13274522654

11 Feb 2025 11:26PM UTC coverage: 91.645% (-0.007%) from 91.652%
13274522654

push

github

web-flow
Merge pull request #4647 from randombit/jack/internal-assert-and-mem-ops

Avoid using mem_ops.h or assert.h in public headers

94854 of 103501 relevant lines covered (91.65%)

11334975.77 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

96.95
/src/lib/math/bigint/divide.cpp
1
/*
2
* Division Algorithms
3
* (C) 1999-2007,2012,2018,2021 Jack Lloyd
4
*
5
* Botan is released under the Simplified BSD License (see license.txt)
6
*/
7

8
#include <botan/internal/divide.h>
9

10
#include <botan/internal/bit_ops.h>
11
#include <botan/internal/ct_utils.h>
12
#include <botan/internal/mp_core.h>
13

14
namespace Botan {
15

16
namespace {
17

18
/*
19
* Handle signed operands, if necessary
20
*/
21
void sign_fixup(const BigInt& x, const BigInt& y, BigInt& q, BigInt& r) {
351,116✔
22
   q.cond_flip_sign(x.sign() != y.sign());
351,116✔
23

24
   if(x.is_negative() && r.is_nonzero()) {
352,780✔
25
      q -= 1;
1,660✔
26
      r = y.abs() - r;
1,660✔
27
   }
28
}
351,116✔
29

30
inline bool division_check(word q, word y2, word y1, word x3, word x2, word x1) {
2,815,702✔
31
   /*
32
   Compute (y3,y2,y1) = (y2,y1) * q
33
   and return true if (y3,y2,y1) > (x3,x2,x1)
34
   */
35

36
   word y3 = 0;
2,815,702✔
37
   y1 = word_madd2(q, y1, &y3);
2,815,702✔
38
   y2 = word_madd2(q, y2, &y3);
2,815,702✔
39

40
   const word x[3] = {x1, x2, x3};
2,815,702✔
41
   const word y[3] = {y1, y2, y3};
2,815,702✔
42

43
   return bigint_ct_is_lt(x, 3, y, 3).as_bool();
2,815,702✔
44
}
45

46
}  // namespace
47

48
void ct_divide(const BigInt& x, const BigInt& y, BigInt& q_out, BigInt& r_out) {
6,644✔
49
   if(y.is_zero()) {
11,274✔
50
      throw Invalid_Argument("ct_divide: cannot divide by zero");
×
51
   }
52

53
   const size_t x_words = x.sig_words();
6,644✔
54
   const size_t y_words = y.sig_words();
6,644✔
55

56
   const size_t x_bits = x.bits();
6,644✔
57

58
   BigInt q = BigInt::with_capacity(x_words);
6,644✔
59
   BigInt r = BigInt::with_capacity(y_words);
6,644✔
60
   BigInt t = BigInt::with_capacity(y_words);  // a temporary
6,644✔
61

62
   for(size_t i = 0; i != x_bits; ++i) {
6,069,652✔
63
      const size_t b = x_bits - 1 - i;
6,063,008✔
64
      const bool x_b = x.get_bit(b);
6,063,008✔
65

66
      r <<= 1;
6,063,008✔
67
      r.conditionally_set_bit(0, x_b);
6,063,008✔
68

69
      const bool r_gte_y = bigint_sub3(t.mutable_data(), r._data(), r.size(), y._data(), y_words) == 0;
6,063,008✔
70

71
      q.conditionally_set_bit(b, r_gte_y);
6,063,008✔
72
      r.ct_cond_swap(r_gte_y, t);
6,063,008✔
73
   }
74

75
   sign_fixup(x, y, q, r);
6,644✔
76
   r_out = r;
6,644✔
77
   q_out = q;
6,644✔
78
}
6,644✔
79

80
BigInt ct_divide_pow2k(size_t k, const BigInt& y) {
116,206✔
81
   BOTAN_ARG_CHECK(!y.is_zero(), "Cannot divide by zero");
116,584✔
82
   BOTAN_ARG_CHECK(!y.is_negative(), "Negative divisor not supported");
116,206✔
83
   BOTAN_ARG_CHECK(k > 1, "Invalid k");
116,206✔
84

85
   const size_t x_bits = k + 1;
116,206✔
86
   const size_t y_bits = y.bits();
116,206✔
87

88
   if(x_bits < y_bits) {
116,206✔
89
      return BigInt::zero();
273✔
90
   }
91

92
   BOTAN_ASSERT_NOMSG(y_bits >= 1);
115,933✔
93
   const size_t x_words = (x_bits + WordInfo<word>::bits - 1) / WordInfo<word>::bits;
115,933✔
94
   const size_t y_words = y.sig_words();
115,933✔
95

96
   BigInt q = BigInt::with_capacity(x_words);
115,933✔
97
   BigInt r = BigInt::with_capacity(y_words + 1);
115,933✔
98
   BigInt t = BigInt::with_capacity(y_words + 1);  // a temporary
115,933✔
99

100
   r.set_bit(y_bits - 1);
115,933✔
101
   for(size_t i = y_bits - 1; i != x_bits; ++i) {
36,092,079✔
102
      const size_t b = x_bits - 1 - i;
35,976,146✔
103

104
      if(i >= y_bits) {
35,976,146✔
105
         bigint_shl1(r.mutable_data(), r.size(), r.size(), 1);
35,860,213✔
106
      }
107

108
      const bool r_gte_y = bigint_sub3(t.mutable_data(), r._data(), r.size(), y._data(), y_words) == 0;
35,976,146✔
109

110
      q.conditionally_set_bit(b, r_gte_y);
35,976,146✔
111

112
      bigint_cnd_swap(static_cast<word>(r_gte_y), r.mutable_data(), t.mutable_data(), y_words + 1);
35,976,146✔
113
   }
114

115
   // No need for sign fixup
116

117
   return q;
115,933✔
118
}
115,933✔
119

120
void ct_divide_word(const BigInt& x, word y, BigInt& q_out, word& r_out) {
589,012✔
121
   if(y == 0) {
589,012✔
122
      throw Invalid_Argument("ct_divide_word: cannot divide by zero");
×
123
   }
124

125
   const size_t x_words = x.sig_words();
589,012✔
126
   const size_t x_bits = x.bits();
589,012✔
127

128
   BigInt q = BigInt::with_capacity(x_words);
589,012✔
129
   word r = 0;
130

131
   for(size_t i = 0; i != x_bits; ++i) {
58,741,912✔
132
      const size_t b = x_bits - 1 - i;
58,152,900✔
133
      const bool x_b = x.get_bit(b);
58,152,900✔
134

135
      const auto r_carry = CT::Mask<word>::expand_top_bit(r);
58,152,900✔
136

137
      r <<= 1;
58,152,900✔
138
      r += x_b;
58,152,900✔
139

140
      const auto r_gte_y = CT::Mask<word>::is_gte(r, y) | r_carry;
58,152,900✔
141
      q.conditionally_set_bit(b, r_gte_y.as_bool());
58,152,900✔
142
      r = r_gte_y.select(r - y, r);
58,152,900✔
143
   }
144

145
   if(x.is_negative()) {
589,012✔
146
      q.flip_sign();
19✔
147
      if(r != 0) {
19✔
148
         --q;
15✔
149
         r = y - r;
15✔
150
      }
151
   }
152

153
   r_out = r;
589,012✔
154
   q_out = q;
589,012✔
155
}
589,012✔
156

157
BigInt ct_divide_word(const BigInt& x, word y) {
4,338✔
158
   BigInt q;
4,338✔
159
   word r;
4,338✔
160
   ct_divide_word(x, y, q, r);
4,338✔
161
   BOTAN_UNUSED(r);
4,338✔
162
   return q;
4,338✔
163
}
×
164

165
word ct_mod_word(const BigInt& x, word y) {
4,338✔
166
   BOTAN_ARG_CHECK(x.is_positive(), "The argument x must be positive");
4,338✔
167
   BOTAN_ARG_CHECK(y != 0, "Cannot divide by zero");
4,338✔
168

169
   const size_t x_bits = x.bits();
4,338✔
170

171
   word r = 0;
4,338✔
172

173
   for(size_t i = 0; i != x_bits; ++i) {
3,020,902✔
174
      const size_t b = x_bits - 1 - i;
3,016,564✔
175
      const bool x_b = x.get_bit(b);
3,016,564✔
176

177
      const auto r_carry = CT::Mask<word>::expand_top_bit(r);
3,016,564✔
178

179
      r <<= 1;
3,016,564✔
180
      r += x_b;
3,016,564✔
181

182
      const auto r_gte_y = CT::Mask<word>::is_gte(r, y) | r_carry;
3,016,564✔
183
      r = r_gte_y.select(r - y, r);
3,016,564✔
184
   }
185

186
   return r;
4,338✔
187
}
188

189
BigInt ct_modulo(const BigInt& x, const BigInt& y) {
5,417✔
190
   if(y.is_negative() || y.is_zero()) {
10,834✔
191
      throw Invalid_Argument("ct_modulo requires y > 0");
×
192
   }
193

194
   const size_t y_words = y.sig_words();
5,417✔
195

196
   const size_t x_bits = x.bits();
5,417✔
197

198
   BigInt r = BigInt::with_capacity(y_words);
5,417✔
199
   BigInt t = BigInt::with_capacity(y_words);
5,417✔
200

201
   for(size_t i = 0; i != x_bits; ++i) {
7,529,513✔
202
      const size_t b = x_bits - 1 - i;
7,524,096✔
203
      const bool x_b = x.get_bit(b);
7,524,096✔
204

205
      r <<= 1;
7,524,096✔
206
      r.conditionally_set_bit(0, x_b);
7,524,096✔
207

208
      const bool r_gte_y = bigint_sub3(t.mutable_data(), r._data(), r.size(), y._data(), y_words) == 0;
7,524,096✔
209

210
      r.ct_cond_swap(r_gte_y, t);
7,524,096✔
211
   }
212

213
   if(x.is_negative()) {
5,417✔
214
      if(r.is_nonzero()) {
1,170✔
215
         r = y - r;
583✔
216
      }
217
   }
218

219
   return r;
5,417✔
220
}
5,417✔
221

222
/*
223
* Solve x = q * y + r
224
*
225
* See Handbook of Applied Cryptography section 14.2.5
226
*/
227
void vartime_divide(const BigInt& x, const BigInt& y_arg, BigInt& q_out, BigInt& r_out) {
344,472✔
228
   if(y_arg.is_zero()) {
344,548✔
229
      throw Invalid_Argument("vartime_divide: cannot divide by zero");
×
230
   }
231

232
   const size_t y_words = y_arg.sig_words();
344,472✔
233

234
   BOTAN_ASSERT_NOMSG(y_words > 0);
344,472✔
235

236
   BigInt y = y_arg;
344,472✔
237

238
   BigInt r = x;
344,472✔
239
   BigInt q = BigInt::zero();
344,472✔
240
   secure_vector<word> ws;
344,472✔
241

242
   r.set_sign(BigInt::Positive);
344,472✔
243
   y.set_sign(BigInt::Positive);
344,472✔
244

245
   // Calculate shifts needed to normalize y with high bit set
246
   const size_t shifts = y.top_bits_free();
344,472✔
247

248
   y <<= shifts;
344,472✔
249
   r <<= shifts;
344,472✔
250

251
   // we know y has not changed size, since we only shifted up to set high bit
252
   const size_t t = y_words - 1;
344,472✔
253
   const size_t n = std::max(y_words, r.sig_words()) - 1;  // r may have changed size however
688,944✔
254

255
   BOTAN_ASSERT_NOMSG(n >= t);
344,472✔
256

257
   q.grow_to(n - t + 1);
344,472✔
258

259
   word* q_words = q.mutable_data();
344,472✔
260

261
   BigInt shifted_y = y << (WordInfo<word>::bits * (n - t));
344,472✔
262

263
   // Set q_{n-t} to number of times r > shifted_y
264
   q_words[n - t] = r.reduce_below(shifted_y, ws);
344,472✔
265

266
   const word y_t0 = y.word_at(t);
344,472✔
267
   const word y_t1 = y.word_at(t - 1);
344,472✔
268
   BOTAN_DEBUG_ASSERT((y_t0 >> (WordInfo<word>::bits - 1)) == 1);
344,472✔
269

270
   for(size_t j = n; j != t; --j) {
1,752,323✔
271
      const word x_j0 = r.word_at(j);
1,407,851✔
272
      const word x_j1 = r.word_at(j - 1);
1,407,851✔
273
      const word x_j2 = r.word_at(j - 2);
1,407,851✔
274

275
      word qjt = bigint_divop_vartime(x_j0, x_j1, y_t0);
1,407,851✔
276

277
      qjt = CT::Mask<word>::is_equal(x_j0, y_t0).select(WordInfo<word>::max, qjt);
1,407,851✔
278

279
      // Per HAC 14.23, this operation is required at most twice
280
      qjt -= division_check(qjt, y_t0, y_t1, x_j0, x_j1, x_j2);
1,407,851✔
281
      qjt -= division_check(qjt, y_t0, y_t1, x_j0, x_j1, x_j2);
1,407,851✔
282
      BOTAN_DEBUG_ASSERT(division_check(qjt, y_t0, y_t1, x_j0, x_j1, x_j2) == false);
1,407,851✔
283

284
      shifted_y >>= WordInfo<word>::bits;
1,407,851✔
285
      // Now shifted_y == y << (WordInfo<word>::bits * (j-t-1))
286

287
      // TODO this sequence could be better
288
      r -= qjt * shifted_y;
1,407,851✔
289
      qjt -= r.is_negative();
1,407,851✔
290
      r += static_cast<word>(r.is_negative()) * shifted_y;
1,407,851✔
291

292
      q_words[j - t - 1] = qjt;
1,407,851✔
293
   }
294

295
   r >>= shifts;
344,472✔
296

297
   sign_fixup(x, y_arg, q, r);
344,472✔
298

299
   r_out = r;
344,472✔
300
   q_out = q;
344,472✔
301
}
688,944✔
302

303
}  // namespace Botan
STATUS · Troubleshooting · Open an Issue · Sales · Support · CAREERS · ENTERPRISE · START FREE · SCHEDULE DEMO
ANNOUNCEMENTS · TWITTER · TOS & SLA · Supported CI Services · What's a CI service? · Automated Testing

© 2026 Coveralls, Inc