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

randombit / botan / 5890505464

17 Aug 2023 11:45AM UTC coverage: 91.716% (+0.007%) from 91.709%
5890505464

push

github

randombit
Merge GH #3667 Add Python argon2 interface

78581 of 85679 relevant lines covered (91.72%)

8394432.28 hits per line

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

78.98
/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/ffi_util.h>
14
#include <botan/internal/os_utils.h>
15
#include <cstdio>
16
#include <cstdlib>
17

18
namespace Botan_FFI {
19

20
// NOLINTNEXTLINE(*-avoid-non-const-global-variables)
21
thread_local std::string g_last_exception_what;
94,511✔
22

23
int ffi_error_exception_thrown(const char* func_name, const char* exn, int rc) {
13✔
24
   g_last_exception_what.assign(exn);
13✔
25

26
   std::string val;
13✔
27
   if(Botan::OS::read_env_variable(val, "BOTAN_FFI_PRINT_EXCEPTIONS") == true && !val.empty()) {
13✔
28
      static_cast<void>(std::fprintf(stderr, "in %s exception '%s' returning %d\n", func_name, exn, rc));
×
29
   }
30
   return rc;
13✔
31
}
13✔
32

33
int botan_view_str_bounce_fn(botan_view_ctx vctx, const char* str, size_t len) {
68✔
34
   return botan_view_bin_bounce_fn(vctx, reinterpret_cast<const uint8_t*>(str), len);
68✔
35
}
36

37
int botan_view_bin_bounce_fn(botan_view_ctx vctx, const uint8_t* buf, size_t len) {
155✔
38
   if(vctx == nullptr || buf == nullptr) {
155✔
39
      return BOTAN_FFI_ERROR_NULL_POINTER;
40
   }
41

42
   botan_view_bounce_struct* ctx = static_cast<botan_view_bounce_struct*>(vctx);
155✔
43

44
   const size_t avail = *ctx->out_len;
155✔
45
   *ctx->out_len = len;
155✔
46

47
   if(avail < len || ctx->out_ptr == nullptr) {
155✔
48
      if(ctx->out_ptr) {
72✔
49
         Botan::clear_mem(ctx->out_ptr, avail);
×
50
      }
51
      return BOTAN_FFI_ERROR_INSUFFICIENT_BUFFER_SPACE;
72✔
52
   } else {
53
      Botan::copy_mem(ctx->out_ptr, buf, len);
83✔
54
      return BOTAN_FFI_SUCCESS;
83✔
55
   }
56
}
57

58
namespace {
59

60
int ffi_map_error_type(Botan::ErrorType err) {
7✔
61
   switch(err) {
7✔
62
      case Botan::ErrorType::Unknown:
63
         return BOTAN_FFI_ERROR_UNKNOWN_ERROR;
64

65
      case Botan::ErrorType::SystemError:
×
66
      case Botan::ErrorType::IoError:
×
67
      case Botan::ErrorType::Pkcs11Error:
×
68
      case Botan::ErrorType::CommonCryptoError:
×
69
      case Botan::ErrorType::TPMError:
×
70
      case Botan::ErrorType::ZlibError:
×
71
      case Botan::ErrorType::Bzip2Error:
×
72
      case Botan::ErrorType::LzmaError:
×
73
      case Botan::ErrorType::DatabaseError:
×
74
         return BOTAN_FFI_ERROR_SYSTEM_ERROR;
×
75

76
      case Botan::ErrorType::NotImplemented:
×
77
         return BOTAN_FFI_ERROR_NOT_IMPLEMENTED;
×
78
      case Botan::ErrorType::OutOfMemory:
×
79
         return BOTAN_FFI_ERROR_OUT_OF_MEMORY;
×
80
      case Botan::ErrorType::InternalError:
×
81
         return BOTAN_FFI_ERROR_INTERNAL_ERROR;
×
82
      case Botan::ErrorType::InvalidObjectState:
2✔
83
         return BOTAN_FFI_ERROR_INVALID_OBJECT_STATE;
2✔
84
      case Botan::ErrorType::KeyNotSet:
2✔
85
         return BOTAN_FFI_ERROR_KEY_NOT_SET;
2✔
86
      case Botan::ErrorType::InvalidArgument:
2✔
87
      case Botan::ErrorType::InvalidNonceLength:
2✔
88
         return BOTAN_FFI_ERROR_BAD_PARAMETER;
2✔
89

90
      case Botan::ErrorType::EncodingFailure:
1✔
91
      case Botan::ErrorType::DecodingFailure:
1✔
92
         return BOTAN_FFI_ERROR_INVALID_INPUT;
1✔
93

94
      case Botan::ErrorType::InvalidTag:
×
95
         return BOTAN_FFI_ERROR_BAD_MAC;
×
96

97
      case Botan::ErrorType::InvalidKeyLength:
×
98
         return BOTAN_FFI_ERROR_INVALID_KEY_LENGTH;
×
99
      case Botan::ErrorType::LookupError:
×
100
         return BOTAN_FFI_ERROR_NOT_IMPLEMENTED;
×
101

102
      case Botan::ErrorType::HttpError:
×
103
         return BOTAN_FFI_ERROR_HTTP_ERROR;
×
104
      case Botan::ErrorType::TLSError:
×
105
         return BOTAN_FFI_ERROR_TLS_ERROR;
×
106
      case Botan::ErrorType::RoughtimeError:
×
107
         return BOTAN_FFI_ERROR_ROUGHTIME_ERROR;
×
108
   }
109

110
   return BOTAN_FFI_ERROR_UNKNOWN_ERROR;
111
}
112

113
}  // namespace
114

115
int ffi_guard_thunk(const char* func_name, const std::function<int()>& thunk) {
94,496✔
116
   g_last_exception_what.clear();
94,496✔
117

118
   try {
94,496✔
119
      return thunk();
188,992✔
120
   } catch(std::bad_alloc&) {
13✔
121
      return ffi_error_exception_thrown(func_name, "bad_alloc", BOTAN_FFI_ERROR_OUT_OF_MEMORY);
×
122
   } catch(Botan_FFI::FFI_Error& e) {
6✔
123
      return ffi_error_exception_thrown(func_name, e.what(), e.error_code());
6✔
124
   } catch(Botan::Exception& e) {
13✔
125
      return ffi_error_exception_thrown(func_name, e.what(), ffi_map_error_type(e.error_type()));
7✔
126
   } catch(std::exception& e) {
7✔
127
      return ffi_error_exception_thrown(func_name, e.what());
×
128
   } catch(...) {
×
129
      return ffi_error_exception_thrown(func_name, "unknown exception");
×
130
   }
×
131

132
   return BOTAN_FFI_ERROR_UNKNOWN_ERROR;
133
}
134

135
}  // namespace Botan_FFI
136

137
extern "C" {
138

139
using namespace Botan_FFI;
140

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

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

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

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

156
      case BOTAN_FFI_ERROR_BAD_MAC:
1✔
157
         return "Invalid authentication code";
1✔
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:
2✔
196
         return "Not implemented";
2✔
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:
1✔
208
         return "Unknown error";
1✔
209

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

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

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

228
   // This is the API introduced in 3.1
229
   if(api_version == 20230711) {
6✔
230
      return BOTAN_FFI_SUCCESS;
231
   }
232

233
   // This is the API introduced in 3.0
234
   if(api_version == 20230403) {
6✔
235
      return BOTAN_FFI_SUCCESS;
236
   }
237

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

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

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

253
   // This is the API introduced in 2.3
254
   if(api_version == 20170815) {
4✔
255
      return BOTAN_FFI_SUCCESS;
256
   }
257

258
   // This is the API introduced in 2.1
259
   if(api_version == 20170327) {
3✔
260
      return BOTAN_FFI_SUCCESS;
261
   }
262

263
   // This is the API introduced in 2.0
264
   if(api_version == 20150515) {
2✔
265
      return BOTAN_FFI_SUCCESS;
1✔
266
   }
267

268
   // Something else:
269
   return -1;
270
}
271

272
const char* botan_version_string() {
2✔
273
   return Botan::version_cstr();
2✔
274
}
275

276
uint32_t botan_version_major() {
2✔
277
   return Botan::version_major();
2✔
278
}
279

280
uint32_t botan_version_minor() {
2✔
281
   return Botan::version_minor();
2✔
282
}
283

284
uint32_t botan_version_patch() {
1✔
285
   return Botan::version_patch();
1✔
286
}
287

288
uint32_t botan_version_datestamp() {
1✔
289
   return Botan::version_datestamp();
1✔
290
}
291

292
int botan_constant_time_compare(const uint8_t* x, const uint8_t* y, size_t len) {
28✔
293
   return Botan::constant_time_compare(x, y, len) ? 0 : -1;
28✔
294
}
295

296
int botan_same_mem(const uint8_t* x, const uint8_t* y, size_t len) {
×
297
   return botan_constant_time_compare(x, y, len);
×
298
}
299

300
int botan_scrub_mem(void* mem, size_t bytes) {
1✔
301
   Botan::secure_scrub_memory(mem, bytes);
1✔
302
   return BOTAN_FFI_SUCCESS;
1✔
303
}
304

305
int botan_hex_encode(const uint8_t* in, size_t len, char* out, uint32_t flags) {
3✔
306
   return ffi_guard_thunk(__func__, [=]() -> int {
3✔
307
      const bool uppercase = (flags & BOTAN_FFI_HEX_LOWER_CASE) == 0;
3✔
308
      Botan::hex_encode(out, in, len, uppercase);
3✔
309
      return BOTAN_FFI_SUCCESS;
3✔
310
   });
3✔
311
}
312

313
int botan_hex_decode(const char* hex_str, size_t in_len, uint8_t* out, size_t* out_len) {
2✔
314
   return ffi_guard_thunk(__func__, [=]() -> int {
2✔
315
      const std::vector<uint8_t> bin = Botan::hex_decode(hex_str, in_len);
2✔
316
      return Botan_FFI::write_vec_output(out, out_len, bin);
2✔
317
   });
4✔
318
}
319

320
int botan_base64_encode(const uint8_t* in, size_t len, char* out, size_t* out_len) {
2✔
321
   return ffi_guard_thunk(__func__, [=]() -> int {
2✔
322
      const std::string base64 = Botan::base64_encode(in, len);
2✔
323
      return Botan_FFI::write_str_output(out, out_len, base64);
2✔
324
   });
4✔
325
}
326

327
int botan_base64_decode(const char* base64_str, size_t in_len, uint8_t* out, size_t* out_len) {
2✔
328
   return ffi_guard_thunk(__func__, [=]() -> int {
2✔
329
      if(*out_len < Botan::base64_decode_max_output(in_len)) {
2✔
330
         *out_len = Botan::base64_decode_max_output(in_len);
1✔
331
         return BOTAN_FFI_ERROR_INSUFFICIENT_BUFFER_SPACE;
1✔
332
      }
333

334
      *out_len = Botan::base64_decode(out, std::string(base64_str, in_len));
1✔
335
      return BOTAN_FFI_SUCCESS;
1✔
336
   });
2✔
337
}
338
}
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