Botan 2.19.1
Crypto and TLS for C&
ffi.cpp
Go to the documentation of this file.
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#include <botan/internal/ffi_util.h>
9#include <botan/internal/os_utils.h>
10#include <botan/version.h>
11#include <botan/mem_ops.h>
12#include <botan/hex.h>
13#include <botan/base64.h>
14#include <cstdio>
15#include <cstdlib>
16
17namespace Botan_FFI {
18
19int ffi_error_exception_thrown(const char* func_name, const char* exn, int rc)
20 {
21 std::string val;
22 if(Botan::OS::read_env_variable(val, "BOTAN_FFI_PRINT_EXCEPTIONS") == true && val != "")
23 {
24 std::fprintf(stderr, "in %s exception '%s' returning %d\n", func_name, exn, rc);
25 }
26 return rc;
27 }
28
29namespace {
30
31int ffi_map_error_type(Botan::ErrorType err)
32 {
33 switch(err)
34 {
37
49
63
67
70
75
82 }
83
85 }
86
87}
88
89int ffi_guard_thunk(const char* func_name, std::function<int ()> thunk)
90 {
91 try
92 {
93 return thunk();
94 }
95 catch(std::bad_alloc&)
96 {
97 return ffi_error_exception_thrown(func_name, "bad_alloc", BOTAN_FFI_ERROR_OUT_OF_MEMORY);
98 }
99 catch(Botan_FFI::FFI_Error& e)
100 {
101 return ffi_error_exception_thrown(func_name, e.what(), e.error_code());
102 }
103 catch(Botan::Exception& e)
104 {
105 return ffi_error_exception_thrown(func_name, e.what(), ffi_map_error_type(e.error_type()));
106 }
107 catch(std::exception& e)
108 {
109 return ffi_error_exception_thrown(func_name, e.what());
110 }
111 catch(...)
112 {
113 return ffi_error_exception_thrown(func_name, "unknown exception");
114 }
115
117 }
118
119}
120
121extern "C" {
122
123using namespace Botan_FFI;
124
125const char* botan_error_description(int err)
126 {
127 switch(err)
128 {
130 return "OK";
131
133 return "Invalid verifier";
134
136 return "Invalid input";
137
139 return "Invalid authentication code";
140
142 return "Insufficient buffer space";
143
145 return "Exception thrown";
146
148 return "Out of memory";
149
151 return "Error while calling system API";
152
154 return "Internal error";
155
157 return "Bad flag";
158
160 return "Null pointer argument";
161
163 return "Bad parameter";
164
166 return "Key not set on object";
167
169 return "Invalid key length";
170
172 return "Invalid object state";
173
175 return "Not implemented";
176
178 return "Invalid object handle";
179
181 return "TLS error";
182
184 return "HTTP error";
185
187 return "Unknown error";
188 }
189
190 return "Unknown error";
191 }
192
193/*
194* Versioning
195*/
197 {
198 return BOTAN_HAS_FFI;
199 }
200
201int botan_ffi_supports_api(uint32_t api_version)
202 {
203 // This is the API introduced in 2.18
204 if(api_version == 20210220)
205 return BOTAN_FFI_SUCCESS;
206
207 // This is the API introduced in 2.13
208 if(api_version == 20191214)
209 return BOTAN_FFI_SUCCESS;
210
211 // This is the API introduced in 2.8
212 if(api_version == 20180713)
213 return BOTAN_FFI_SUCCESS;
214
215 // This is the API introduced in 2.3
216 if(api_version == 20170815)
217 return BOTAN_FFI_SUCCESS;
218
219 // This is the API introduced in 2.1
220 if(api_version == 20170327)
221 return BOTAN_FFI_SUCCESS;
222
223 // This is the API introduced in 2.0
224 if(api_version == 20150515)
225 return BOTAN_FFI_SUCCESS;
226
227 // Something else:
228 return -1;
229 }
230
232 {
233 return Botan::version_cstr();
234 }
235
240
241int botan_constant_time_compare(const uint8_t* x, const uint8_t* y, size_t len)
242 {
243 return Botan::constant_time_compare(x, y, len) ? 0 : -1;
244 }
245
246int botan_same_mem(const uint8_t* x, const uint8_t* y, size_t len)
247 {
248 return botan_constant_time_compare(x, y, len);
249 }
250
251int botan_scrub_mem(void* mem, size_t bytes)
252 {
253 Botan::secure_scrub_memory(mem, bytes);
254 return BOTAN_FFI_SUCCESS;
255 }
256
257int botan_hex_encode(const uint8_t* in, size_t len, char* out, uint32_t flags)
258 {
259 return ffi_guard_thunk(__func__, [=]() -> int {
260 const bool uppercase = (flags & BOTAN_FFI_HEX_LOWER_CASE) == 0;
261 Botan::hex_encode(out, in, len, uppercase);
262 return BOTAN_FFI_SUCCESS;
263 });
264 }
265
266int botan_hex_decode(const char* hex_str, size_t in_len, uint8_t* out, size_t* out_len)
267 {
268 return ffi_guard_thunk(__func__, [=]() -> int {
269 const std::vector<uint8_t> bin = Botan::hex_decode(hex_str, in_len);
270 return Botan_FFI::write_vec_output(out, out_len, bin);
271 });
272 }
273
274int botan_base64_encode(const uint8_t* in, size_t len, char* out, size_t* out_len)
275 {
276 return ffi_guard_thunk(__func__, [=]() -> int {
277 const std::string base64 = Botan::base64_encode(in, len);
278 return Botan_FFI::write_str_output(out, out_len, base64);
279 });
280 }
281
282int botan_base64_decode(const char* base64_str, size_t in_len,
283 uint8_t* out, size_t* out_len)
284 {
285 return ffi_guard_thunk(__func__, [=]() -> int {
286 if(*out_len < Botan::base64_decode_max_output(in_len))
287 {
288 *out_len = Botan::base64_decode_max_output(in_len);
290 }
291
292 *out_len = Botan::base64_decode(out, std::string(base64_str, in_len));
293 return BOTAN_FFI_SUCCESS;
294 });
295 }
296
297}
const char * what() const noexcept override
Definition: exceptn.h:96
Botan::ErrorType error_type() const noexcept override
Definition: ffi_util.h:29
int error_code() const noexcept override
Definition: ffi_util.h:27
uint32_t botan_version_datestamp()
Definition: ffi.cpp:239
int botan_same_mem(const uint8_t *x, const uint8_t *y, size_t len)
Definition: ffi.cpp:246
const char * botan_version_string()
Definition: ffi.cpp:231
int botan_base64_decode(const char *base64_str, size_t in_len, uint8_t *out, size_t *out_len)
Definition: ffi.cpp:282
uint32_t botan_version_patch()
Definition: ffi.cpp:238
int botan_base64_encode(const uint8_t *in, size_t len, char *out, size_t *out_len)
Definition: ffi.cpp:274
int botan_scrub_mem(void *mem, size_t bytes)
Definition: ffi.cpp:251
int botan_hex_encode(const uint8_t *in, size_t len, char *out, uint32_t flags)
Definition: ffi.cpp:257
uint32_t botan_version_major()
Definition: ffi.cpp:236
uint32_t botan_ffi_api_version()
Definition: ffi.cpp:196
int botan_ffi_supports_api(uint32_t api_version)
Definition: ffi.cpp:201
const char * botan_error_description(int err)
Definition: ffi.cpp:125
uint32_t botan_version_minor()
Definition: ffi.cpp:237
int botan_constant_time_compare(const uint8_t *x, const uint8_t *y, size_t len)
Definition: ffi.cpp:241
int botan_hex_decode(const char *hex_str, size_t in_len, uint8_t *out, size_t *out_len)
Definition: ffi.cpp:266
#define BOTAN_FFI_HEX_LOWER_CASE
Definition: ffi.h:154
@ BOTAN_FFI_ERROR_NOT_IMPLEMENTED
Definition: ffi.h:83
@ BOTAN_FFI_ERROR_INVALID_KEY_LENGTH
Definition: ffi.h:80
@ BOTAN_FFI_ERROR_KEY_NOT_SET
Definition: ffi.h:79
@ BOTAN_FFI_ERROR_TLS_ERROR
Definition: ffi.h:86
@ BOTAN_FFI_ERROR_EXCEPTION_THROWN
Definition: ffi.h:71
@ BOTAN_FFI_ERROR_OUT_OF_MEMORY
Definition: ffi.h:72
@ BOTAN_FFI_ERROR_INTERNAL_ERROR
Definition: ffi.h:74
@ BOTAN_FFI_INVALID_VERIFIER
Definition: ffi.h:64
@ BOTAN_FFI_ERROR_INVALID_OBJECT
Definition: ffi.h:84
@ BOTAN_FFI_ERROR_UNKNOWN_ERROR
Definition: ffi.h:90
@ BOTAN_FFI_ERROR_HTTP_ERROR
Definition: ffi.h:87
@ BOTAN_FFI_ERROR_BAD_FLAG
Definition: ffi.h:76
@ BOTAN_FFI_ERROR_INVALID_INPUT
Definition: ffi.h:66
@ BOTAN_FFI_ERROR_NULL_POINTER
Definition: ffi.h:77
@ BOTAN_FFI_SUCCESS
Definition: ffi.h:63
@ BOTAN_FFI_ERROR_SYSTEM_ERROR
Definition: ffi.h:73
@ BOTAN_FFI_ERROR_ROUGHTIME_ERROR
Definition: ffi.h:88
@ BOTAN_FFI_ERROR_INVALID_OBJECT_STATE
Definition: ffi.h:81
@ BOTAN_FFI_ERROR_INSUFFICIENT_BUFFER_SPACE
Definition: ffi.h:69
@ BOTAN_FFI_ERROR_BAD_MAC
Definition: ffi.h:67
@ BOTAN_FFI_ERROR_BAD_PARAMETER
Definition: ffi.h:78
bool read_env_variable(std::string &value_out, const std::string &var_name)
Definition: os_utils.cpp:387
Flags flags(Flag flags)
Definition: p11.h:860
int ffi_error_exception_thrown(const char *func_name, const char *exn, int rc)
Definition: ffi.cpp:19
int ffi_guard_thunk(const char *func_name, std::function< int()> thunk)
Definition: ffi.cpp:89
int write_str_output(uint8_t out[], size_t *out_len, const std::string &str)
Definition: ffi_util.h:160
int write_vec_output(uint8_t out[], size_t *out_len, const std::vector< uint8_t, Alloc > &buf)
Definition: ffi_util.h:155
uint32_t version_minor()
Definition: version.cpp:81
uint32_t version_major()
Definition: version.cpp:80
const char * version_cstr()
Definition: version.cpp:33
size_t base64_encode(char out[], const uint8_t in[], size_t input_length, size_t &input_consumed, bool final_inputs)
Definition: base64.cpp:185
uint32_t version_datestamp()
Definition: version.cpp:75
void secure_scrub_memory(void *ptr, size_t n)
Definition: os_utils.cpp:66
uint32_t version_patch()
Definition: version.cpp:82
size_t base64_decode(uint8_t out[], const char in[], size_t input_length, size_t &input_consumed, bool final_inputs, bool ignore_ws)
Definition: base64.cpp:200
bool constant_time_compare(const uint8_t x[], const uint8_t y[], size_t len)
Definition: mem_ops.h:82
ErrorType
Definition: exceptn.h:20
void hex_encode(char output[], const uint8_t input[], size_t input_length, bool uppercase)
Definition: hex.cpp:31
size_t base64_decode_max_output(size_t input_length)
Definition: base64.cpp:243
size_t hex_decode(uint8_t output[], const char input[], size_t input_length, size_t &input_consumed, bool ignore_ws)
Definition: hex.cpp:89