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

randombit / botan / 5200168067

07 Jun 2023 12:49PM UTC coverage: 91.738% (-0.009%) from 91.747%
5200168067

push

github

randombit
Merge GH #3573 Enable some additional clang-tidy warnings

76197 of 83059 relevant lines covered (91.74%)

11891039.95 hits per line

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

78.44
/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,508✔
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,493✔
116
   g_last_exception_what.clear();
94,493✔
117

118
   try {
94,493✔
119
      return thunk();
188,986✔
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() { return g_last_exception_what.c_str(); }
2✔
142

143
const char* botan_error_description(int err) {
152✔
144
   switch(err) {
152✔
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_INSUFFICIENT_BUFFER_SPACE:
1✔
158
         return "Insufficient buffer space";
1✔
159

160
      case BOTAN_FFI_ERROR_STRING_CONVERSION_ERROR:
1✔
161
         return "String conversion error";
1✔
162

163
      case BOTAN_FFI_ERROR_EXCEPTION_THROWN:
1✔
164
         return "Exception thrown";
1✔
165

166
      case BOTAN_FFI_ERROR_OUT_OF_MEMORY:
1✔
167
         return "Out of memory";
1✔
168

169
      case BOTAN_FFI_ERROR_SYSTEM_ERROR:
1✔
170
         return "Error while calling system API";
1✔
171

172
      case BOTAN_FFI_ERROR_INTERNAL_ERROR:
1✔
173
         return "Internal error";
1✔
174

175
      case BOTAN_FFI_ERROR_BAD_FLAG:
1✔
176
         return "Bad flag";
1✔
177

178
      case BOTAN_FFI_ERROR_NULL_POINTER:
1✔
179
         return "Null pointer argument";
1✔
180

181
      case BOTAN_FFI_ERROR_BAD_PARAMETER:
1✔
182
         return "Bad parameter";
1✔
183

184
      case BOTAN_FFI_ERROR_KEY_NOT_SET:
1✔
185
         return "Key not set on object";
1✔
186

187
      case BOTAN_FFI_ERROR_INVALID_KEY_LENGTH:
1✔
188
         return "Invalid key length";
1✔
189

190
      case BOTAN_FFI_ERROR_INVALID_OBJECT_STATE:
1✔
191
         return "Invalid object state";
1✔
192

193
      case BOTAN_FFI_ERROR_NOT_IMPLEMENTED:
2✔
194
         return "Not implemented";
2✔
195

196
      case BOTAN_FFI_ERROR_INVALID_OBJECT:
1✔
197
         return "Invalid object handle";
1✔
198

199
      case BOTAN_FFI_ERROR_TLS_ERROR:
1✔
200
         return "TLS error";
1✔
201

202
      case BOTAN_FFI_ERROR_HTTP_ERROR:
1✔
203
         return "HTTP error";
1✔
204

205
      case BOTAN_FFI_ERROR_UNKNOWN_ERROR:
1✔
206
         return "Unknown error";
1✔
207

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

213
/*
214
* Versioning
215
*/
216
uint32_t botan_ffi_api_version() { return BOTAN_HAS_FFI; }
3✔
217

218
int botan_ffi_supports_api(uint32_t api_version) {
7✔
219
   // This is the API introduced in 3.1
220
   if(api_version == 20230711) {
7✔
221
      return BOTAN_FFI_SUCCESS;
222
   }
223

224
   // This is the API introduced in 3.0
225
   if(api_version == 20230403) {
6✔
226
      return BOTAN_FFI_SUCCESS;
227
   }
228

229
   // This is the API introduced in 2.18
230
   if(api_version == 20210220) {
5✔
231
      return BOTAN_FFI_SUCCESS;
232
   }
233

234
   // This is the API introduced in 2.13
235
   if(api_version == 20191214) {
5✔
236
      return BOTAN_FFI_SUCCESS;
237
   }
238

239
   // This is the API introduced in 2.8
240
   if(api_version == 20180713) {
5✔
241
      return BOTAN_FFI_SUCCESS;
242
   }
243

244
   // This is the API introduced in 2.3
245
   if(api_version == 20170815) {
4✔
246
      return BOTAN_FFI_SUCCESS;
247
   }
248

249
   // This is the API introduced in 2.1
250
   if(api_version == 20170327) {
3✔
251
      return BOTAN_FFI_SUCCESS;
252
   }
253

254
   // This is the API introduced in 2.0
255
   if(api_version == 20150515) {
2✔
256
      return BOTAN_FFI_SUCCESS;
1✔
257
   }
258

259
   // Something else:
260
   return -1;
261
}
262

263
const char* botan_version_string() { return Botan::version_cstr(); }
2✔
264

265
uint32_t botan_version_major() { return Botan::version_major(); }
2✔
266

267
uint32_t botan_version_minor() { return Botan::version_minor(); }
2✔
268

269
uint32_t botan_version_patch() { return Botan::version_patch(); }
1✔
270

271
uint32_t botan_version_datestamp() { return Botan::version_datestamp(); }
1✔
272

273
int botan_constant_time_compare(const uint8_t* x, const uint8_t* y, size_t len) {
28✔
274
   return Botan::constant_time_compare(x, y, len) ? 0 : -1;
28✔
275
}
276

277
int botan_same_mem(const uint8_t* x, const uint8_t* y, size_t len) { return botan_constant_time_compare(x, y, len); }
×
278

279
int botan_scrub_mem(void* mem, size_t bytes) {
1✔
280
   Botan::secure_scrub_memory(mem, bytes);
1✔
281
   return BOTAN_FFI_SUCCESS;
1✔
282
}
283

284
int botan_hex_encode(const uint8_t* in, size_t len, char* out, uint32_t flags) {
3✔
285
   return ffi_guard_thunk(__func__, [=]() -> int {
3✔
286
      const bool uppercase = (flags & BOTAN_FFI_HEX_LOWER_CASE) == 0;
3✔
287
      Botan::hex_encode(out, in, len, uppercase);
3✔
288
      return BOTAN_FFI_SUCCESS;
3✔
289
   });
3✔
290
}
291

292
int botan_hex_decode(const char* hex_str, size_t in_len, uint8_t* out, size_t* out_len) {
2✔
293
   return ffi_guard_thunk(__func__, [=]() -> int {
2✔
294
      const std::vector<uint8_t> bin = Botan::hex_decode(hex_str, in_len);
2✔
295
      return Botan_FFI::write_vec_output(out, out_len, bin);
2✔
296
   });
4✔
297
}
298

299
int botan_base64_encode(const uint8_t* in, size_t len, char* out, size_t* out_len) {
2✔
300
   return ffi_guard_thunk(__func__, [=]() -> int {
2✔
301
      const std::string base64 = Botan::base64_encode(in, len);
2✔
302
      return Botan_FFI::write_str_output(out, out_len, base64);
2✔
303
   });
4✔
304
}
305

306
int botan_base64_decode(const char* base64_str, size_t in_len, uint8_t* out, size_t* out_len) {
2✔
307
   return ffi_guard_thunk(__func__, [=]() -> int {
2✔
308
      if(*out_len < Botan::base64_decode_max_output(in_len)) {
2✔
309
         *out_len = Botan::base64_decode_max_output(in_len);
1✔
310
         return BOTAN_FFI_ERROR_INSUFFICIENT_BUFFER_SPACE;
1✔
311
      }
312

313
      *out_len = Botan::base64_decode(out, std::string(base64_str, in_len));
1✔
314
      return BOTAN_FFI_SUCCESS;
1✔
315
   });
2✔
316
}
317
}
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

© 2025 Coveralls, Inc