Botan  2.4.0
Crypto and TLS for C++11
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/version.h>
10 #include <botan/mem_ops.h>
11 #include <botan/hex.h>
12 #include <botan/base64.h>
13 #include <cstdio>
14 
15 namespace Botan_FFI {
16 
17 int ffi_error_exception_thrown(const char* func_name, const char* exn)
18  {
19  fprintf(stderr, "in %s exception %s\n", func_name, exn);
21  }
22 
23 }
24 
25 extern "C" {
26 
27 using namespace Botan_FFI;
28 
29 /*
30 * Versioning
31 */
33  {
34  return BOTAN_HAS_FFI;
35  }
36 
37 int botan_ffi_supports_api(uint32_t api_version)
38  {
39  // Current API version
40  if(api_version == BOTAN_HAS_FFI)
41  return BOTAN_FFI_SUCCESS;
42 
43  // Older versions that are still supported
44 
45  // This is the 2.1/2.2 API
46  if(api_version == 20170327)
47  return BOTAN_FFI_SUCCESS;
48 
49  // This is the 2.0 API
50  if(api_version == 20150515)
51  return BOTAN_FFI_SUCCESS;
52 
53  return -1;
54  }
55 
56 const char* botan_version_string()
57  {
58  return Botan::version_cstr();
59  }
60 
61 uint32_t botan_version_major() { return Botan::version_major(); }
62 uint32_t botan_version_minor() { return Botan::version_minor(); }
63 uint32_t botan_version_patch() { return Botan::version_patch(); }
65 
66 int botan_constant_time_compare(const uint8_t* x, const uint8_t* y, size_t len)
67  {
68  return Botan::constant_time_compare(x, y, len) ? 0 : -1;
69  }
70 
71 int botan_same_mem(const uint8_t* x, const uint8_t* y, size_t len)
72  {
73  return botan_constant_time_compare(x, y, len);
74  }
75 
76 int botan_scrub_mem(void* mem, size_t bytes)
77  {
78  Botan::secure_scrub_memory(mem, bytes);
79  return BOTAN_FFI_SUCCESS;
80  }
81 
82 int botan_hex_encode(const uint8_t* in, size_t len, char* out, uint32_t flags)
83  {
84  return ffi_guard_thunk(BOTAN_CURRENT_FUNCTION, [=]() -> int {
85  const bool uppercase = (flags & BOTAN_FFI_HEX_LOWER_CASE) == 0;
86  Botan::hex_encode(out, in, len, uppercase);
87  return BOTAN_FFI_SUCCESS;
88  });
89  }
90 
91 int botan_hex_decode(const char* hex_str, size_t in_len, uint8_t* out, size_t* out_len)
92  {
93  return ffi_guard_thunk(BOTAN_CURRENT_FUNCTION, [=]() -> int {
94  const std::vector<uint8_t> bin = Botan::hex_decode(hex_str, in_len);
95  return Botan_FFI::write_vec_output(out, out_len, bin);
96  });
97  }
98 
99 int botan_base64_encode(const uint8_t* in, size_t len, char* out, size_t* out_len)
100  {
101  return ffi_guard_thunk(BOTAN_CURRENT_FUNCTION, [=]() -> int {
102  const std::string base64 = Botan::base64_encode(in, len);
103  return Botan_FFI::write_str_output(out, out_len, base64);
104  });
105  }
106 
107 int botan_base64_decode(const char* base64_str, size_t in_len,
108  uint8_t* out, size_t* out_len)
109  {
110  return ffi_guard_thunk(BOTAN_CURRENT_FUNCTION, [=]() -> int {
111  if(*out_len < Botan::base64_decode_max_output(in_len))
112  {
113  *out_len = Botan::base64_decode_max_output(in_len);
115  }
116 
117  *out_len = Botan::base64_decode(out, std::string(base64_str, in_len));
118  return BOTAN_FFI_SUCCESS;
119  });
120  }
121 
122 }
123 
void hex_encode(char output[], const uint8_t input[], size_t input_length, bool uppercase)
Definition: hex.cpp:14
int botan_hex_encode(const uint8_t *in, size_t len, char *out, uint32_t flags)
Definition: ffi.cpp:82
#define BOTAN_FFI_SUCCESS
Definition: ffi.h:137
size_t base64_decode_max_output(size_t input_length)
Definition: base64.cpp:256
int ffi_error_exception_thrown(const char *func_name, const char *exn)
Definition: ffi.cpp:17
int ffi_guard_thunk(const char *func_name, Thunk thunk)
Definition: ffi_util.h:64
Flags flags(Flag flags)
Definition: p11.h:858
bool constant_time_compare(const uint8_t x[], const uint8_t y[], size_t len)
Definition: mem_ops.cpp:44
int write_vec_output(uint8_t out[], size_t *out_len, const std::vector< uint8_t, Alloc > &buf)
Definition: ffi_util.h:146
#define BOTAN_FFI_HEX_LOWER_CASE
Definition: ffi.h:172
int botan_base64_encode(const uint8_t *in, size_t len, char *out, size_t *out_len)
Definition: ffi.cpp:99
uint32_t botan_version_patch()
Definition: ffi.cpp:63
int botan_scrub_mem(void *mem, size_t bytes)
Definition: ffi.cpp:76
uint32_t version_major()
Definition: version.cpp:72
int write_str_output(uint8_t out[], size_t *out_len, const std::string &str)
Definition: ffi_util.h:151
size_t base64_encode(char out[], const uint8_t in[], size_t input_length, size_t &input_consumed, bool final_inputs)
Definition: base64.cpp:35
uint32_t botan_ffi_api_version()
Definition: ffi.cpp:32
uint32_t version_patch()
Definition: version.cpp:74
#define BOTAN_FFI_ERROR_EXCEPTION_THROWN
Definition: ffi.h:145
uint32_t botan_version_major()
Definition: ffi.cpp:61
int botan_same_mem(const uint8_t *x, const uint8_t *y, size_t len)
Definition: ffi.cpp:71
size_t base64_decode(uint8_t output[], const char input[], size_t input_length, size_t &input_consumed, bool final_inputs, bool ignore_ws)
Definition: base64.cpp:100
uint32_t version_minor()
Definition: version.cpp:73
size_t hex_decode(uint8_t output[], const char input[], size_t input_length, size_t &input_consumed, bool ignore_ws)
Definition: hex.cpp:49
#define BOTAN_FFI_ERROR_INSUFFICIENT_BUFFER_SPACE
Definition: ffi.h:144
uint32_t botan_version_minor()
Definition: ffi.cpp:62
uint32_t version_datestamp()
Definition: version.cpp:67
int botan_base64_decode(const char *base64_str, size_t in_len, uint8_t *out, size_t *out_len)
Definition: ffi.cpp:107
void secure_scrub_memory(void *ptr, size_t n)
Definition: os_utils.cpp:37
uint32_t botan_version_datestamp()
Definition: ffi.cpp:64
int botan_hex_decode(const char *hex_str, size_t in_len, uint8_t *out, size_t *out_len)
Definition: ffi.cpp:91
int botan_ffi_supports_api(uint32_t api_version)
Definition: ffi.cpp:37
#define BOTAN_CURRENT_FUNCTION
Definition: compiler.h:143
int botan_constant_time_compare(const uint8_t *x, const uint8_t *y, size_t len)
Definition: ffi.cpp:66
const char * version_cstr()
Definition: version.cpp:29
const char * botan_version_string()
Definition: ffi.cpp:56