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

randombit / botan / 20852529804

09 Jan 2026 12:52PM UTC coverage: 90.425% (+0.002%) from 90.423%
20852529804

Pull #5224

github

web-flow
Merge 4e7c239a0 into 46ea9a2a3
Pull Request #5224: Bump the FFI version for 3.11

101648 of 112412 relevant lines covered (90.42%)

12926373.88 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::InvalidObjectState:
2✔
54
         return BOTAN_FFI_ERROR_INVALID_OBJECT_STATE;
2✔
55
      case Botan::ErrorType::KeyNotSet:
2✔
56
         return BOTAN_FFI_ERROR_KEY_NOT_SET;
2✔
57
      case Botan::ErrorType::InvalidArgument:
4✔
58
      case Botan::ErrorType::InvalidNonceLength:
4✔
59
         return BOTAN_FFI_ERROR_BAD_PARAMETER;
4✔
60

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

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

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

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

81
   return BOTAN_FFI_ERROR_UNKNOWN_ERROR;
82
}
83

84
}  // namespace
85

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

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

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

101
   return rc;
17✔
102
}
17✔
103

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

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

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

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

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

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

133
}  // namespace Botan_FFI
134

135
extern "C" {
136

137
using namespace Botan_FFI;
138

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

227
   // This is the API introduced in 3.10
228
   if(api_version == 20250829) {
6✔
229
      return BOTAN_FFI_SUCCESS;
230
   }
231

232
   // This is the API introduced in 3.8
233
   if(api_version == 20250506) {
5✔
234
      return BOTAN_FFI_SUCCESS;
235
   }
236

237
   // This is the API introduced in 3.4
238
   if(api_version == 20240408) {
5✔
239
      return BOTAN_FFI_SUCCESS;
240
   }
241

242
   // This is the API introduced in 3.2
243
   if(api_version == 20231009) {
5✔
244
      return BOTAN_FFI_SUCCESS;
245
   }
246

247
   // This is the API introduced in 3.1
248
   if(api_version == 20230711) {
5✔
249
      return BOTAN_FFI_SUCCESS;
250
   }
251

252
   // This is the API introduced in 3.0
253
   if(api_version == 20230403) {
5✔
254
      return BOTAN_FFI_SUCCESS;
255
   }
256

257
   // This is the API introduced in 2.18
258
   if(api_version == 20210220) {
5✔
259
      return BOTAN_FFI_SUCCESS;
260
   }
261

262
   // This is the API introduced in 2.13
263
   if(api_version == 20191214) {
5✔
264
      return BOTAN_FFI_SUCCESS;
265
   }
266

267
   // This is the API introduced in 2.8
268
   if(api_version == 20180713) {
5✔
269
      return BOTAN_FFI_SUCCESS;
270
   }
271

272
   // This is the API introduced in 2.3
273
   if(api_version == 20170815) {
4✔
274
      return BOTAN_FFI_SUCCESS;
275
   }
276

277
   // This is the API introduced in 2.1
278
   if(api_version == 20170327) {
3✔
279
      return BOTAN_FFI_SUCCESS;
280
   }
281

282
   // This is the API introduced in 2.0
283
   if(api_version == 20150515) {
2✔
284
      return BOTAN_FFI_SUCCESS;
1✔
285
   }
286

287
   // Something else:
288
   return -1;
289
}
290

291
const char* botan_version_string() {
2✔
292
   return Botan::version_cstr();
2✔
293
}
294

295
uint32_t botan_version_major() {
2✔
296
   return Botan::version_major();
2✔
297
}
298

299
uint32_t botan_version_minor() {
2✔
300
   return Botan::version_minor();
2✔
301
}
302

303
uint32_t botan_version_patch() {
1✔
304
   return Botan::version_patch();
1✔
305
}
306

307
uint32_t botan_version_datestamp() {
1✔
308
   return Botan::version_datestamp();
1✔
309
}
310

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

317
int botan_same_mem(const uint8_t* x, const uint8_t* y, size_t len) {
×
318
   return botan_constant_time_compare(x, y, len);
×
319
}
320

321
int botan_scrub_mem(void* mem, size_t bytes) {
1✔
322
   Botan::secure_scrub_memory(mem, bytes);
1✔
323
   return BOTAN_FFI_SUCCESS;
1✔
324
}
325

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

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

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

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

355
      *out_len = Botan::base64_decode(out, std::string(base64_str, in_len));
1✔
356
      return BOTAN_FFI_SUCCESS;
1✔
357
   });
2✔
358
}
359
}
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