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

randombit / botan / 14001542335

21 Mar 2025 09:55PM UTC coverage: 91.599% (-0.002%) from 91.601%
14001542335

push

github

web-flow
Merge pull request #4777 from randombit/jack/ffi-thunk-save-space

Inline thunk calls in FFI

95345 of 104090 relevant lines covered (91.6%)

11616083.36 hits per line

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

82.21
/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;
96,243✔
28

29
int ffi_map_error_type(Botan::ErrorType err) {
9✔
30
   switch(err) {
9✔
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:
2✔
58
      case Botan::ErrorType::InvalidNonceLength:
2✔
59
         return BOTAN_FFI_ERROR_BAD_PARAMETER;
2✔
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() {
96,223✔
87
   g_last_exception_what.clear();
96,223✔
88
}
96,214✔
89

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

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

100
   return rc;
15✔
101
}
15✔
102

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

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

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

116
   botan_view_bounce_struct* ctx = static_cast<botan_view_bounce_struct*>(vctx);
155✔
117

118
   const size_t avail = *ctx->out_len;
155✔
119
   *ctx->out_len = len;
155✔
120

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

132
}  // namespace Botan_FFI
133

134
extern "C" {
135

136
using namespace Botan_FFI;
137

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

207
      case BOTAN_FFI_ERROR_UNKNOWN_ERROR:
208
         return "Unknown error";
209

210
      default:
211
         return "Unknown error";
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.8
224
   if(api_version == 20250506) {
7✔
225
      return BOTAN_FFI_SUCCESS;
226
   }
227

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

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

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

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

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

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

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

263
   // This is the API introduced in 2.3
264
   if(api_version == 20170815) {
4✔
265
      return BOTAN_FFI_SUCCESS;
266
   }
267

268
   // This is the API introduced in 2.1
269
   if(api_version == 20170327) {
3✔
270
      return BOTAN_FFI_SUCCESS;
271
   }
272

273
   // This is the API introduced in 2.0
274
   if(api_version == 20150515) {
2✔
275
      return BOTAN_FFI_SUCCESS;
1✔
276
   }
277

278
   // Something else:
279
   return -1;
280
}
281

282
const char* botan_version_string() {
2✔
283
   return Botan::version_cstr();
2✔
284
}
285

286
uint32_t botan_version_major() {
2✔
287
   return Botan::version_major();
2✔
288
}
289

290
uint32_t botan_version_minor() {
2✔
291
   return Botan::version_minor();
2✔
292
}
293

294
uint32_t botan_version_patch() {
1✔
295
   return Botan::version_patch();
1✔
296
}
297

298
uint32_t botan_version_datestamp() {
1✔
299
   return Botan::version_datestamp();
1✔
300
}
301

302
int botan_constant_time_compare(const uint8_t* x, const uint8_t* y, size_t len) {
28✔
303
   auto same = Botan::CT::is_equal(x, y, len);
28✔
304
   // Return 0 if same or -1 otherwise
305
   return static_cast<int>(same.select(1, 0)) - 1;
28✔
306
}
307

308
int botan_same_mem(const uint8_t* x, const uint8_t* y, size_t len) {
×
309
   return botan_constant_time_compare(x, y, len);
×
310
}
311

312
int botan_scrub_mem(void* mem, size_t bytes) {
1✔
313
   Botan::secure_scrub_memory(mem, bytes);
1✔
314
   return BOTAN_FFI_SUCCESS;
1✔
315
}
316

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

325
int botan_hex_decode(const char* hex_str, size_t in_len, uint8_t* out, size_t* out_len) {
2✔
326
   return ffi_guard_thunk(__func__, [=]() -> int {
2✔
327
      const std::vector<uint8_t> bin = Botan::hex_decode(hex_str, in_len);
2✔
328
      return Botan_FFI::write_vec_output(out, out_len, bin);
2✔
329
   });
2✔
330
}
331

332
int botan_base64_encode(const uint8_t* in, size_t len, char* out, size_t* out_len) {
2✔
333
   return ffi_guard_thunk(__func__, [=]() -> int {
2✔
334
      const std::string base64 = Botan::base64_encode(in, len);
2✔
335
      return Botan_FFI::write_str_output(out, out_len, base64);
2✔
336
   });
2✔
337
}
338

339
int botan_base64_decode(const char* base64_str, size_t in_len, uint8_t* out, size_t* out_len) {
2✔
340
   return ffi_guard_thunk(__func__, [=]() -> int {
2✔
341
      if(*out_len < Botan::base64_decode_max_output(in_len)) {
2✔
342
         *out_len = Botan::base64_decode_max_output(in_len);
1✔
343
         return BOTAN_FFI_ERROR_INSUFFICIENT_BUFFER_SPACE;
1✔
344
      }
345

346
      *out_len = Botan::base64_decode(out, std::string(base64_str, in_len));
1✔
347
      return BOTAN_FFI_SUCCESS;
1✔
348
   });
2✔
349
}
350
}
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