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

randombit / botan / 22855031980

09 Mar 2026 01:10PM UTC coverage: 90.173% (-0.01%) from 90.184%
22855031980

Pull #5425

github

web-flow
Merge 058be2a86 into cdaa9c0ff
Pull Request #5425: BigInt encoding cleanups

103789 of 115100 relevant lines covered (90.17%)

11503649.25 hits per line

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

95.7
/src/lib/ffi/ffi_mp.cpp
1
/*
2
* (C) 2015,2017 Jack Lloyd
3
* (C) 2017 Ribose Inc
4
*
5
* Botan is released under the Simplified BSD License (see license.txt)
6
*/
7

8
#include <botan/ffi.h>
9

10
#include <botan/assert.h>
11
#include <botan/numthry.h>
12
#include <botan/internal/barrett.h>
13
#include <botan/internal/divide.h>
14
#include <botan/internal/ffi_mp.h>
15
#include <botan/internal/ffi_rng.h>
16
#include <botan/internal/ffi_util.h>
17
#include <botan/internal/mem_utils.h>
18
#include <botan/internal/mod_inv.h>
19

20
extern "C" {
21

22
using namespace Botan_FFI;
23

24
int botan_mp_init(botan_mp_t* mp_out) {
148✔
25
   return ffi_guard_thunk(__func__, [=]() -> int {
148✔
26
      if(mp_out == nullptr) {
148✔
27
         return BOTAN_FFI_ERROR_NULL_POINTER;
28
      }
29

30
      auto mp = std::make_unique<Botan::BigInt>();
148✔
31
      return ffi_new_object(mp_out, std::move(mp));
148✔
32
   });
148✔
33
}
34

35
int botan_mp_clear(botan_mp_t mp) {
×
36
   return BOTAN_FFI_VISIT(mp, [](auto& bn) { bn.clear(); });
×
37
}
38

39
int botan_mp_set_from_int(botan_mp_t mp, int initial_value) {
2✔
40
   return BOTAN_FFI_VISIT(mp, [=](auto& bn) { bn = Botan::BigInt::from_s32(initial_value); });
4✔
41
}
42

43
int botan_mp_set_from_str(botan_mp_t mp, const char* str) {
37✔
44
   return BOTAN_FFI_VISIT(mp, [=](auto& bn) { bn = Botan::BigInt(str); });
74✔
45
}
46

47
int botan_mp_set_from_radix_str(botan_mp_t mp, const char* str, size_t radix) {
10✔
48
   return BOTAN_FFI_VISIT(mp, [=](auto& bn) {
20✔
49
      if(radix != 10 && radix != 16) {
50
         return BOTAN_FFI_ERROR_NOT_IMPLEMENTED;
51
      }
52

53
      bn = Botan::BigInt::from_radix_digits(std::string_view(str), radix);
54
      return BOTAN_FFI_SUCCESS;
55
   });
56
}
57

58
// NOLINTBEGIN(misc-misplaced-const)
59

60
int botan_mp_set_from_mp(botan_mp_t dest, const botan_mp_t source) {
4✔
61
   return BOTAN_FFI_VISIT(dest, [=](auto& bn) { bn = safe_get(source); });
8✔
62
}
63

64
int botan_mp_is_negative(const botan_mp_t mp) {
10✔
65
   return BOTAN_FFI_VISIT(mp, [](const auto& bn) { return bn.is_negative() ? 1 : 0; });
20✔
66
}
67

68
int botan_mp_is_positive(const botan_mp_t mp) {
6✔
69
   return BOTAN_FFI_VISIT(mp, [](const auto& bn) { return bn.is_positive() ? 1 : 0; });
12✔
70
}
71

72
int botan_mp_flip_sign(botan_mp_t mp) {
5✔
73
   return BOTAN_FFI_VISIT(mp, [](auto& bn) { bn.flip_sign(); });
15✔
74
}
75

76
int botan_mp_from_bin(botan_mp_t mp, const uint8_t bin[], size_t bin_len) {
1✔
77
   return BOTAN_FFI_VISIT(mp, [=](auto& bn) { bn._assign_from_bytes({bin, bin_len}); });
2✔
78
}
79

80
int botan_mp_to_hex(const botan_mp_t mp, char* out) {
3✔
81
   return BOTAN_FFI_VISIT(mp, [=](const auto& bn) {
6✔
82
      const std::string hex = bn.to_hex_string();
83

84
      // Check that we are about to write no more than the documented upper bound
85
      const size_t upper_bound = 2 * bn.bytes() + 5;
86
      BOTAN_ASSERT_NOMSG(hex.size() + 1 <= upper_bound);
87
      std::memcpy(out, hex.c_str(), 1 + hex.size());
88
   });
89
}
90

91
int botan_mp_view_hex(const botan_mp_t mp, botan_view_ctx ctx, botan_view_str_fn view) {
36✔
92
   return BOTAN_FFI_VISIT(mp, [=](const auto& bn) -> int {
108✔
93
      const std::string hex = bn.to_hex_string();
94
      return invoke_view_callback(view, ctx, hex);
95
   });
96
}
97

98
int botan_mp_to_str(const botan_mp_t mp, uint8_t radix, char* out, size_t* out_len) {
14✔
99
   return BOTAN_FFI_VISIT(mp, [=](const auto& bn) -> int {
28✔
100
      if(radix == 0 || radix == 10) {
101
         return write_str_output(out, out_len, bn.to_dec_string());
102
      } else if(radix == 16) {
103
         return write_str_output(out, out_len, bn.to_hex_string());
104
      } else {
105
         return BOTAN_FFI_ERROR_BAD_PARAMETER;
106
      }
107
   });
108
}
109

110
int botan_mp_view_str(const botan_mp_t mp, uint8_t radix, botan_view_ctx ctx, botan_view_str_fn view) {
3✔
111
   return BOTAN_FFI_VISIT(mp, [=](const auto& bn) -> int {
9✔
112
      if(radix == 10) {
113
         return invoke_view_callback(view, ctx, bn.to_dec_string());
114
      } else if(radix == 16) {
115
         return invoke_view_callback(view, ctx, bn.to_hex_string());
116
      } else {
117
         return BOTAN_FFI_ERROR_BAD_PARAMETER;
118
      }
119
   });
120
}
121

122
int botan_mp_to_bin(const botan_mp_t mp, uint8_t vec[]) {
3✔
123
   return BOTAN_FFI_VISIT(mp, [=](const auto& bn) { bn.serialize_to(std::span{vec, bn.bytes()}); });
6✔
124
}
125

126
int botan_mp_view_bin(const botan_mp_t mp, botan_view_ctx ctx, botan_view_bin_fn view) {
3✔
127
   return BOTAN_FFI_VISIT(mp, [=](const auto& bn) {
15✔
128
      const auto bytes = bn.serialize();
129
      return invoke_view_callback(view, ctx, bytes);
130
   });
131
}
132

133
int botan_mp_to_uint32(const botan_mp_t mp, uint32_t* val) {
5✔
134
   if(val == nullptr) {
5✔
135
      return BOTAN_FFI_ERROR_NULL_POINTER;
136
   }
137
   return BOTAN_FFI_VISIT(mp, [=](const auto& bn) { *val = bn.to_u32bit(); });
10✔
138
}
139

140
int botan_mp_destroy(botan_mp_t mp) {
178✔
141
   return BOTAN_FFI_CHECKED_DELETE(mp);
178✔
142
}
143

144
int botan_mp_add(botan_mp_t result, const botan_mp_t x, const botan_mp_t y) {
5✔
145
   return BOTAN_FFI_VISIT(result, [=](auto& res) {
10✔
146
      if(result == x) {
147
         res += safe_get(y);
148
      } else {
149
         res = safe_get(x) + safe_get(y);
150
      }
151
   });
152
}
153

154
int botan_mp_sub(botan_mp_t result, const botan_mp_t x, const botan_mp_t y) {
1✔
155
   return BOTAN_FFI_VISIT(result, [=](auto& res) {
2✔
156
      if(result == x) {
157
         res -= safe_get(y);
158
      } else {
159
         res = safe_get(x) - safe_get(y);
160
      }
161
   });
162
}
163

164
int botan_mp_add_u32(botan_mp_t result, const botan_mp_t x, uint32_t y) {
2✔
165
   return BOTAN_FFI_VISIT(result, [=](auto& res) {
4✔
166
      if(result == x) {
167
         res += static_cast<Botan::word>(y);
168
      } else {
169
         res = safe_get(x) + static_cast<Botan::word>(y);
170
      }
171
   });
172
}
173

174
int botan_mp_sub_u32(botan_mp_t result, const botan_mp_t x, uint32_t y) {
1✔
175
   return BOTAN_FFI_VISIT(result, [=](auto& res) {
2✔
176
      if(result == x) {
177
         res -= static_cast<Botan::word>(y);
178
      } else {
179
         res = safe_get(x) - static_cast<Botan::word>(y);
180
      }
181
   });
182
}
183

184
int botan_mp_mul(botan_mp_t result, const botan_mp_t x, const botan_mp_t y) {
6✔
185
   return BOTAN_FFI_VISIT(result, [=](auto& res) {
12✔
186
      if(result == x) {
187
         res *= safe_get(y);
188
      } else {
189
         res = safe_get(x) * safe_get(y);
190
      }
191
   });
192
}
193

194
int botan_mp_div(botan_mp_t quotient, botan_mp_t remainder, const botan_mp_t x, const botan_mp_t y) {
2✔
195
   return BOTAN_FFI_VISIT(quotient, [=](auto& q) {
4✔
196
      Botan::BigInt r;
197
      Botan::vartime_divide(safe_get(x), safe_get(y), q, r);
198
      safe_get(remainder) = r;
199
   });
200
}
201

202
int botan_mp_equal(const botan_mp_t x_w, const botan_mp_t y_w) {
24✔
203
   return BOTAN_FFI_VISIT(x_w, [=](const auto& x) -> int { return x == safe_get(y_w); });
48✔
204
}
205

206
int botan_mp_is_zero(const botan_mp_t mp) {
3✔
207
   return BOTAN_FFI_VISIT(mp, [](const auto& bn) -> int { return bn.is_zero(); });
6✔
208
}
209

210
int botan_mp_is_odd(const botan_mp_t mp) {
2✔
211
   return BOTAN_FFI_VISIT(mp, [](const auto& bn) -> int { return bn.is_odd(); });
5✔
212
}
213

214
int botan_mp_is_even(const botan_mp_t mp) {
2✔
215
   return BOTAN_FFI_VISIT(mp, [](const auto& bn) -> int { return bn.is_even(); });
5✔
216
}
217

218
int botan_mp_cmp(int* result, const botan_mp_t x_w, const botan_mp_t y_w) {
45✔
219
   return BOTAN_FFI_VISIT(x_w, [=](auto& x) { *result = x.cmp(safe_get(y_w)); });
90✔
220
}
221

222
int botan_mp_swap(botan_mp_t x_w, botan_mp_t y_w) {
×
223
   return BOTAN_FFI_VISIT(x_w, [=](auto& x) { x.swap(safe_get(y_w)); });
×
224
}
225

226
// Return (base^exponent) % modulus
227
int botan_mp_powmod(botan_mp_t out, const botan_mp_t base, const botan_mp_t exponent, const botan_mp_t modulus) {
2✔
228
   return BOTAN_FFI_VISIT(
4✔
229
      out, [=](auto& o) { o = Botan::power_mod(safe_get(base), safe_get(exponent), safe_get(modulus)); });
230
}
231

232
int botan_mp_lshift(botan_mp_t out, const botan_mp_t in, size_t shift) {
3✔
233
   return BOTAN_FFI_VISIT(out, [=](auto& o) { o = safe_get(in) << shift; });
6✔
234
}
235

236
int botan_mp_rshift(botan_mp_t out, const botan_mp_t in, size_t shift) {
4✔
237
   return BOTAN_FFI_VISIT(out, [=](auto& o) { o = safe_get(in) >> shift; });
8✔
238
}
239

240
int botan_mp_mod_inverse(botan_mp_t out, const botan_mp_t in, const botan_mp_t modulus) {
2✔
241
   return BOTAN_FFI_VISIT(out, [=](auto& o) {
4✔
242
      o = Botan::inverse_mod_general(safe_get(in), safe_get(modulus)).value_or(Botan::BigInt::zero());
243
   });
244
}
245

246
int botan_mp_mod_mul(botan_mp_t out, const botan_mp_t x, const botan_mp_t y, const botan_mp_t modulus) {
2✔
247
   return BOTAN_FFI_VISIT(out, [=](auto& o) {
6✔
248
      auto reducer = Botan::Barrett_Reduction::for_secret_modulus(safe_get(modulus));
249
      o = reducer.multiply(safe_get(x), safe_get(y));
250
   });
251
}
252

253
int botan_mp_rand_bits(botan_mp_t rand_out, botan_rng_t rng, size_t bits) {
2✔
254
   return BOTAN_FFI_VISIT(rng, [=](auto& r) { safe_get(rand_out).randomize(r, bits); });
4✔
255
}
256

257
int botan_mp_rand_range(botan_mp_t rand_out, botan_rng_t rng, const botan_mp_t lower, const botan_mp_t upper) {
10✔
258
   return BOTAN_FFI_VISIT(
30✔
259
      rng, [=](auto& r) { safe_get(rand_out) = Botan::BigInt::random_integer(r, safe_get(lower), safe_get(upper)); });
260
}
261

262
int botan_mp_gcd(botan_mp_t out, const botan_mp_t x, const botan_mp_t y) {
4✔
263
   return BOTAN_FFI_VISIT(out, [=](auto& o) { o = Botan::gcd(safe_get(x), safe_get(y)); });
8✔
264
}
265

266
int botan_mp_is_prime(const botan_mp_t mp, botan_rng_t rng, size_t test_prob) {
5✔
267
   return BOTAN_FFI_VISIT(mp, [=](const auto& n) { return (Botan::is_prime(n, safe_get(rng), test_prob)) ? 1 : 0; });
10✔
268
}
269

270
int botan_mp_get_bit(const botan_mp_t mp, size_t bit) {
6✔
271
   return BOTAN_FFI_VISIT(mp, [=](const auto& n) -> int { return n.get_bit(bit); });
12✔
272
}
273

274
int botan_mp_set_bit(botan_mp_t mp, size_t bit) {
2✔
275
   return BOTAN_FFI_VISIT(mp, [=](auto& n) { n.set_bit(bit); });
4✔
276
}
277

278
int botan_mp_clear_bit(botan_mp_t mp, size_t bit) {
2✔
279
   return BOTAN_FFI_VISIT(mp, [=](auto& n) { n.clear_bit(bit); });
4✔
280
}
281

282
int botan_mp_num_bits(const botan_mp_t mp, size_t* bits) {
7✔
283
   return BOTAN_FFI_VISIT(mp, [=](const auto& n) { *bits = n.bits(); });
14✔
284
}
285

286
int botan_mp_num_bytes(const botan_mp_t mp, size_t* bytes) {
10✔
287
   return BOTAN_FFI_VISIT(mp, [=](const auto& n) { *bytes = n.bytes(); });
20✔
288
}
289

290
// NOLINTEND(misc-misplaced-const)
291
}
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