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

randombit / botan / 20698655531

04 Jan 2026 08:25PM UTC coverage: 90.416% (-0.009%) from 90.425%
20698655531

Pull #5124

github

web-flow
Merge 627aed356 into f283c5d29
Pull Request #5124: Cooperative Cancellation in PasswordHash

101700 of 112480 relevant lines covered (90.42%)

13010053.87 hits per line

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

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

7
#include <botan/ffi.h>
8

9
#include <botan/base64.h>
10
#include <botan/hex.h>
11
#include <botan/mem_ops.h>
12
#include <botan/version.h>
13
#include <botan/internal/ct_utils.h>
14
#include <botan/internal/ffi_util.h>
15
#include <cstdio>
16
#include <cstdlib>
17

18
#if defined(BOTAN_HAS_OS_UTILS)
19
   #include <botan/internal/os_utils.h>
20
#endif
21

22
namespace Botan_FFI {
23

24
namespace {
25

26
// NOLINTNEXTLINE(*-avoid-non-const-global-variables)
27
thread_local std::string g_last_exception_what;
97,102✔
28

29
int ffi_map_error_type(Botan::ErrorType err) {
11✔
30
   switch(err) {
11✔
31
      case Botan::ErrorType::Unknown:
32
         return BOTAN_FFI_ERROR_UNKNOWN_ERROR;
33

34
      case Botan::ErrorType::SystemError:
×
35
      case Botan::ErrorType::IoError:
×
36
      case Botan::ErrorType::Pkcs11Error:
×
37
      case Botan::ErrorType::CommonCryptoError:
×
38
      case Botan::ErrorType::ZlibError:
×
39
      case Botan::ErrorType::Bzip2Error:
×
40
      case Botan::ErrorType::LzmaError:
×
41
      case Botan::ErrorType::DatabaseError:
×
42
         return BOTAN_FFI_ERROR_SYSTEM_ERROR;
×
43

44
      case Botan::ErrorType::TPMError:
×
45
         return BOTAN_FFI_ERROR_TPM_ERROR;
×
46

47
      case Botan::ErrorType::NotImplemented:
48
         return BOTAN_FFI_ERROR_NOT_IMPLEMENTED;
49
      case Botan::ErrorType::OutOfMemory:
×
50
         return BOTAN_FFI_ERROR_OUT_OF_MEMORY;
×
51
      case Botan::ErrorType::InternalError:
×
52
         return BOTAN_FFI_ERROR_INTERNAL_ERROR;
×
53
      case Botan::ErrorType::OperationCanceled:
2✔
54
      case Botan::ErrorType::InvalidObjectState:
2✔
55
         return BOTAN_FFI_ERROR_INVALID_OBJECT_STATE;
2✔
56
      case Botan::ErrorType::KeyNotSet:
2✔
57
         return BOTAN_FFI_ERROR_KEY_NOT_SET;
2✔
58
      case Botan::ErrorType::InvalidArgument:
4✔
59
      case Botan::ErrorType::InvalidNonceLength:
4✔
60
         return BOTAN_FFI_ERROR_BAD_PARAMETER;
4✔
61

62
      case Botan::ErrorType::EncodingFailure:
1✔
63
      case Botan::ErrorType::DecodingFailure:
1✔
64
         return BOTAN_FFI_ERROR_INVALID_INPUT;
1✔
65

66
      case Botan::ErrorType::InvalidTag:
×
67
         return BOTAN_FFI_ERROR_BAD_MAC;
×
68

69
      case Botan::ErrorType::InvalidKeyLength:
×
70
         return BOTAN_FFI_ERROR_INVALID_KEY_LENGTH;
×
71
      case Botan::ErrorType::LookupError:
72
         return BOTAN_FFI_ERROR_NOT_IMPLEMENTED;
73

74
      case Botan::ErrorType::HttpError:
×
75
         return BOTAN_FFI_ERROR_HTTP_ERROR;
×
76
      case Botan::ErrorType::TLSError:
×
77
         return BOTAN_FFI_ERROR_TLS_ERROR;
×
78
      case Botan::ErrorType::RoughtimeError:
×
79
         return BOTAN_FFI_ERROR_ROUGHTIME_ERROR;
×
80
   }
81

82
   return BOTAN_FFI_ERROR_UNKNOWN_ERROR;
83
}
84

85
}  // namespace
86

87
void ffi_clear_last_exception() {
97,080✔
88
   g_last_exception_what.clear();
97,080✔
89
}
97,071✔
90

91
int ffi_error_exception_thrown(const char* func_name, const char* exn, int rc) {
17✔
92
   g_last_exception_what.assign(exn);
17✔
93

94
#if defined(BOTAN_HAS_OS_UTILS)
95
   std::string val;
17✔
96
   if(Botan::OS::read_env_variable(val, "BOTAN_FFI_PRINT_EXCEPTIONS") && !val.empty()) {
17✔
97
      // NOLINTNEXTLINE(*-vararg)
98
      static_cast<void>(std::fprintf(stderr, "in %s exception '%s' returning %d\n", func_name, exn, rc));
×
99
   }
100
#endif
101

102
   return rc;
17✔
103
}
17✔
104

105
int ffi_error_exception_thrown(const char* func_name, const char* exn, Botan::ErrorType err) {
11✔
106
   return ffi_error_exception_thrown(func_name, exn, ffi_map_error_type(err));
11✔
107
}
108

109
int botan_view_str_bounce_fn(botan_view_ctx vctx, const char* str, size_t len) {
74✔
110
   return botan_view_bin_bounce_fn(vctx, reinterpret_cast<const uint8_t*>(str), len);
74✔
111
}
112

113
int botan_view_bin_bounce_fn(botan_view_ctx vctx, const uint8_t* buf, size_t len) {
168✔
114
   if(vctx == nullptr || buf == nullptr) {
168✔
115
      return BOTAN_FFI_ERROR_NULL_POINTER;
116
   }
117

118
   const botan_view_bounce_struct* ctx = static_cast<botan_view_bounce_struct*>(vctx);
168✔
119

120
   const size_t avail = *ctx->out_len;
168✔
121
   *ctx->out_len = len;
168✔
122

123
   if(avail < len || ctx->out_ptr == nullptr) {
168✔
124
      if(ctx->out_ptr != nullptr) {
78✔
125
         Botan::clear_mem(ctx->out_ptr, avail);
×
126
      }
127
      return BOTAN_FFI_ERROR_INSUFFICIENT_BUFFER_SPACE;
78✔
128
   } else {
129
      Botan::copy_mem(ctx->out_ptr, buf, len);
90✔
130
      return BOTAN_FFI_SUCCESS;
90✔
131
   }
132
}
133

134
}  // namespace Botan_FFI
135

136
extern "C" {
137

138
using namespace Botan_FFI;
139

140
const char* botan_error_last_exception_message() {
5✔
141
   return g_last_exception_what.c_str();
5✔
142
}
143

144
const char* botan_error_description(int err) {
155✔
145
   switch(err) {
155✔
146
      case BOTAN_FFI_SUCCESS:
147
         return "OK";
148

149
      case BOTAN_FFI_INVALID_VERIFIER:
1✔
150
         return "Invalid verifier";
1✔
151

152
      case BOTAN_FFI_ERROR_INVALID_INPUT:
2✔
153
         return "Invalid input";
2✔
154

155
      case BOTAN_FFI_ERROR_BAD_MAC:
1✔
156
         return "Invalid authentication code";
1✔
157

158
      case BOTAN_FFI_ERROR_NO_VALUE:
2✔
159
         return "No value available";
2✔
160

161
      case BOTAN_FFI_ERROR_INSUFFICIENT_BUFFER_SPACE:
1✔
162
         return "Insufficient buffer space";
1✔
163

164
      case BOTAN_FFI_ERROR_STRING_CONVERSION_ERROR:
1✔
165
         return "String conversion error";
1✔
166

167
      case BOTAN_FFI_ERROR_EXCEPTION_THROWN:
1✔
168
         return "Exception thrown";
1✔
169

170
      case BOTAN_FFI_ERROR_OUT_OF_MEMORY:
1✔
171
         return "Out of memory";
1✔
172

173
      case BOTAN_FFI_ERROR_SYSTEM_ERROR:
1✔
174
         return "Error while calling system API";
1✔
175

176
      case BOTAN_FFI_ERROR_INTERNAL_ERROR:
1✔
177
         return "Internal error";
1✔
178

179
      case BOTAN_FFI_ERROR_BAD_FLAG:
1✔
180
         return "Bad flag";
1✔
181

182
      case BOTAN_FFI_ERROR_NULL_POINTER:
1✔
183
         return "Null pointer argument";
1✔
184

185
      case BOTAN_FFI_ERROR_BAD_PARAMETER:
1✔
186
         return "Bad parameter";
1✔
187

188
      case BOTAN_FFI_ERROR_KEY_NOT_SET:
1✔
189
         return "Key not set on object";
1✔
190

191
      case BOTAN_FFI_ERROR_INVALID_KEY_LENGTH:
1✔
192
         return "Invalid key length";
1✔
193

194
      case BOTAN_FFI_ERROR_INVALID_OBJECT_STATE:
1✔
195
         return "Invalid object state";
1✔
196

197
      case BOTAN_FFI_ERROR_NOT_IMPLEMENTED:
4✔
198
         return "Not implemented";
4✔
199

200
      case BOTAN_FFI_ERROR_INVALID_OBJECT:
1✔
201
         return "Invalid object handle";
1✔
202

203
      case BOTAN_FFI_ERROR_TLS_ERROR:
1✔
204
         return "TLS error";
1✔
205

206
      case BOTAN_FFI_ERROR_HTTP_ERROR:
1✔
207
         return "HTTP error";
1✔
208

209
      case BOTAN_FFI_ERROR_UNKNOWN_ERROR:
129✔
210
      default:
129✔
211
         return "Unknown error";
129✔
212
   }
213
}
214

215
/*
216
* Versioning
217
*/
218
uint32_t botan_ffi_api_version() {
4✔
219
   return BOTAN_HAS_FFI;
4✔
220
}
221

222
int botan_ffi_supports_api(uint32_t api_version) {
7✔
223
   // This is the API introduced in 3.10
224
   if(api_version == 20250829) {
7✔
225
      return BOTAN_FFI_SUCCESS;
226
   }
227

228
   // This is the API introduced in 3.8
229
   if(api_version == 20250506) {
5✔
230
      return BOTAN_FFI_SUCCESS;
231
   }
232

233
   // This is the API introduced in 3.4
234
   if(api_version == 20240408) {
5✔
235
      return BOTAN_FFI_SUCCESS;
236
   }
237

238
   // This is the API introduced in 3.2
239
   if(api_version == 20231009) {
5✔
240
      return BOTAN_FFI_SUCCESS;
241
   }
242

243
   // This is the API introduced in 3.1
244
   if(api_version == 20230711) {
5✔
245
      return BOTAN_FFI_SUCCESS;
246
   }
247

248
   // This is the API introduced in 3.0
249
   if(api_version == 20230403) {
5✔
250
      return BOTAN_FFI_SUCCESS;
251
   }
252

253
   // This is the API introduced in 2.18
254
   if(api_version == 20210220) {
5✔
255
      return BOTAN_FFI_SUCCESS;
256
   }
257

258
   // This is the API introduced in 2.13
259
   if(api_version == 20191214) {
5✔
260
      return BOTAN_FFI_SUCCESS;
261
   }
262

263
   // This is the API introduced in 2.8
264
   if(api_version == 20180713) {
5✔
265
      return BOTAN_FFI_SUCCESS;
266
   }
267

268
   // This is the API introduced in 2.3
269
   if(api_version == 20170815) {
4✔
270
      return BOTAN_FFI_SUCCESS;
271
   }
272

273
   // This is the API introduced in 2.1
274
   if(api_version == 20170327) {
3✔
275
      return BOTAN_FFI_SUCCESS;
276
   }
277

278
   // This is the API introduced in 2.0
279
   if(api_version == 20150515) {
2✔
280
      return BOTAN_FFI_SUCCESS;
1✔
281
   }
282

283
   // Something else:
284
   return -1;
285
}
286

287
const char* botan_version_string() {
2✔
288
   return Botan::version_cstr();
2✔
289
}
290

291
uint32_t botan_version_major() {
2✔
292
   return Botan::version_major();
2✔
293
}
294

295
uint32_t botan_version_minor() {
2✔
296
   return Botan::version_minor();
2✔
297
}
298

299
uint32_t botan_version_patch() {
1✔
300
   return Botan::version_patch();
1✔
301
}
302

303
uint32_t botan_version_datestamp() {
1✔
304
   return Botan::version_datestamp();
1✔
305
}
306

307
int botan_constant_time_compare(const uint8_t* x, const uint8_t* y, size_t len) {
28✔
308
   auto same = Botan::CT::is_equal(x, y, len);
28✔
309
   // Return 0 if same or -1 otherwise
310
   return static_cast<int>(same.select(1, 0)) - 1;
28✔
311
}
312

313
int botan_same_mem(const uint8_t* x, const uint8_t* y, size_t len) {
×
314
   return botan_constant_time_compare(x, y, len);
×
315
}
316

317
int botan_scrub_mem(void* mem, size_t bytes) {
1✔
318
   Botan::secure_scrub_memory(mem, bytes);
1✔
319
   return BOTAN_FFI_SUCCESS;
1✔
320
}
321

322
int botan_hex_encode(const uint8_t* in, size_t len, char* out, uint32_t flags) {
3✔
323
   return ffi_guard_thunk(__func__, [=]() -> int {
3✔
324
      const bool uppercase = (flags & BOTAN_FFI_HEX_LOWER_CASE) == 0;
3✔
325
      Botan::hex_encode(out, in, len, uppercase);
3✔
326
      return BOTAN_FFI_SUCCESS;
327
   });
3✔
328
}
329

330
int botan_hex_decode(const char* hex_str, size_t in_len, uint8_t* out, size_t* out_len) {
2✔
331
   return ffi_guard_thunk(__func__, [=]() -> int {
2✔
332
      const std::vector<uint8_t> bin = Botan::hex_decode(hex_str, in_len);
2✔
333
      return Botan_FFI::write_vec_output(out, out_len, bin);
2✔
334
   });
2✔
335
}
336

337
int botan_base64_encode(const uint8_t* in, size_t len, char* out, size_t* out_len) {
2✔
338
   return ffi_guard_thunk(__func__, [=]() -> int {
2✔
339
      const std::string base64 = Botan::base64_encode(in, len);
2✔
340
      return Botan_FFI::write_str_output(out, out_len, base64);
2✔
341
   });
2✔
342
}
343

344
int botan_base64_decode(const char* base64_str, size_t in_len, uint8_t* out, size_t* out_len) {
2✔
345
   return ffi_guard_thunk(__func__, [=]() -> int {
2✔
346
      if(*out_len < Botan::base64_decode_max_output(in_len)) {
2✔
347
         *out_len = Botan::base64_decode_max_output(in_len);
1✔
348
         return BOTAN_FFI_ERROR_INSUFFICIENT_BUFFER_SPACE;
1✔
349
      }
350

351
      *out_len = Botan::base64_decode(out, std::string(base64_str, in_len));
1✔
352
      return BOTAN_FFI_SUCCESS;
1✔
353
   });
2✔
354
}
355
}
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