Botan  2.9.0
Crypto and TLS for C++11
Namespaces | Functions
ffi.cpp File Reference
#include <botan/ffi.h>
#include <botan/internal/ffi_util.h>
#include <botan/internal/os_utils.h>
#include <botan/version.h>
#include <botan/mem_ops.h>
#include <botan/hex.h>
#include <botan/base64.h>
#include <cstdio>
#include <cstdlib>

Go to the source code of this file.

Namespaces

 Botan_FFI
 

Functions

int botan_base64_decode (const char *base64_str, size_t in_len, uint8_t *out, size_t *out_len)
 
int botan_base64_encode (const uint8_t *in, size_t len, char *out, size_t *out_len)
 
int botan_constant_time_compare (const uint8_t *x, const uint8_t *y, size_t len)
 
const char * botan_error_description (int err)
 
uint32_t botan_ffi_api_version ()
 
int botan_ffi_supports_api (uint32_t api_version)
 
int botan_hex_decode (const char *hex_str, size_t in_len, uint8_t *out, size_t *out_len)
 
int botan_hex_encode (const uint8_t *in, size_t len, char *out, uint32_t flags)
 
int botan_same_mem (const uint8_t *x, const uint8_t *y, size_t len)
 
int botan_scrub_mem (void *mem, size_t bytes)
 
uint32_t botan_version_datestamp ()
 
uint32_t botan_version_major ()
 
uint32_t botan_version_minor ()
 
uint32_t botan_version_patch ()
 
const char * botan_version_string ()
 
int Botan_FFI::ffi_error_exception_thrown (const char *func_name, const char *exn, int rc)
 
int Botan_FFI::ffi_guard_thunk (const char *func_name, std::function< int()> thunk)
 

Function Documentation

◆ botan_base64_decode()

int botan_base64_decode ( const char *  base64_str,
size_t  in_len,
uint8_t *  out,
size_t *  out_len 
)

Perform base64 decoding

Definition at line 266 of file ffi.cpp.

References Botan::base64_decode(), Botan::base64_decode_max_output(), BOTAN_FFI_ERROR_INSUFFICIENT_BUFFER_SPACE, BOTAN_FFI_SUCCESS, and Botan_FFI::ffi_guard_thunk().

268  {
269  return ffi_guard_thunk(__func__, [=]() -> int {
270  if(*out_len < Botan::base64_decode_max_output(in_len))
271  {
272  *out_len = Botan::base64_decode_max_output(in_len);
274  }
275 
276  *out_len = Botan::base64_decode(out, std::string(base64_str, in_len));
277  return BOTAN_FFI_SUCCESS;
278  });
279  }
int ffi_guard_thunk(const char *func_name, std::function< int()> thunk)
Definition: ffi.cpp:81
size_t base64_decode_max_output(size_t input_length)
Definition: base64.cpp:224
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:181

◆ botan_base64_encode()

int botan_base64_encode ( const uint8_t *  x,
size_t  len,
char *  out,
size_t *  out_len 
)

Perform base64 encoding

Definition at line 258 of file ffi.cpp.

References Botan::base64_encode(), Botan_FFI::ffi_guard_thunk(), and Botan_FFI::write_str_output().

259  {
260  return ffi_guard_thunk(__func__, [=]() -> int {
261  const std::string base64 = Botan::base64_encode(in, len);
262  return Botan_FFI::write_str_output(out, out_len, base64);
263  });
264  }
int ffi_guard_thunk(const char *func_name, std::function< int()> thunk)
Definition: ffi.cpp:81
int write_str_output(uint8_t out[], size_t *out_len, const std::string &str)
Definition: ffi_util.h:147
size_t base64_encode(char out[], const uint8_t in[], size_t input_length, size_t &input_consumed, bool final_inputs)
Definition: base64.cpp:166

◆ botan_constant_time_compare()

int botan_constant_time_compare ( const uint8_t *  x,
const uint8_t *  y,
size_t  len 
)

Returns 0 if x[0..len] == y[0..len], or otherwise -1

Definition at line 225 of file ffi.cpp.

References Botan::constant_time_compare().

Referenced by botan_same_mem().

226  {
227  return Botan::constant_time_compare(x, y, len) ? 0 : -1;
228  }
bool constant_time_compare(const uint8_t x[], const uint8_t y[], size_t len)
Definition: mem_ops.h:81

◆ botan_error_description()

const char* botan_error_description ( int  err)

Convert an error code into a string. Returns "Unknown error" if the error code is not a known one.

Definition at line 117 of file ffi.cpp.

References BOTAN_FFI_ERROR_BAD_FLAG, BOTAN_FFI_ERROR_BAD_MAC, BOTAN_FFI_ERROR_BAD_PARAMETER, BOTAN_FFI_ERROR_EXCEPTION_THROWN, BOTAN_FFI_ERROR_HTTP_ERROR, BOTAN_FFI_ERROR_INSUFFICIENT_BUFFER_SPACE, BOTAN_FFI_ERROR_INTERNAL_ERROR, BOTAN_FFI_ERROR_INVALID_INPUT, BOTAN_FFI_ERROR_INVALID_KEY_LENGTH, BOTAN_FFI_ERROR_INVALID_OBJECT, BOTAN_FFI_ERROR_INVALID_OBJECT_STATE, BOTAN_FFI_ERROR_KEY_NOT_SET, BOTAN_FFI_ERROR_NOT_IMPLEMENTED, BOTAN_FFI_ERROR_NULL_POINTER, BOTAN_FFI_ERROR_OUT_OF_MEMORY, BOTAN_FFI_ERROR_SYSTEM_ERROR, BOTAN_FFI_ERROR_TLS_ERROR, BOTAN_FFI_ERROR_UNKNOWN_ERROR, BOTAN_FFI_INVALID_VERIFIER, and BOTAN_FFI_SUCCESS.

118  {
119  switch(err)
120  {
121  case BOTAN_FFI_SUCCESS:
122  return "OK";
123 
125  return "Invalid verifier";
126 
128  return "Invalid input";
129 
131  return "Invalid authentication code";
132 
134  return "Insufficient buffer space";
135 
137  return "Exception thrown";
138 
140  return "Out of memory";
141 
143  return "Error while calling system API";
144 
146  return "Internal error";
147 
149  return "Bad flag";
150 
152  return "Null pointer argument";
153 
155  return "Bad parameter";
156 
158  return "Key not set on object";
159 
161  return "Invalid key length";
162 
164  return "Invalid object state";
165 
167  return "Not implemented";
168 
170  return "Invalid object handle";
171 
173  return "TLS error";
174 
176  return "HTTP error";
177 
179  return "Unknown error";
180  }
181 
182  return "Unknown error";
183  }

◆ botan_ffi_api_version()

uint32_t botan_ffi_api_version ( )

Return the version of the currently supported FFI API. This is expressed in the form YYYYMMDD of the release date of this version of the API.

Definition at line 188 of file ffi.cpp.

189  {
190  return BOTAN_HAS_FFI;
191  }

◆ botan_ffi_supports_api()

int botan_ffi_supports_api ( uint32_t  api_version)

Return 0 (ok) if the version given is one this library supports. botan_ffi_supports_api(botan_ffi_api_version()) will always return 0.

Definition at line 193 of file ffi.cpp.

References BOTAN_FFI_SUCCESS.

194  {
195  // This is the API introduced in 2.8
196  if(api_version == 20180713)
197  return BOTAN_FFI_SUCCESS;
198 
199  // This is the API introduced in 2.3
200  if(api_version == 20170815)
201  return BOTAN_FFI_SUCCESS;
202 
203  // This is the API introduced in 2.1
204  if(api_version == 20170327)
205  return BOTAN_FFI_SUCCESS;
206 
207  // This is the API introduced in 2.0
208  if(api_version == 20150515)
209  return BOTAN_FFI_SUCCESS;
210 
211  // Something else:
212  return -1;
213  }

◆ botan_hex_decode()

int botan_hex_decode ( const char *  hex_str,
size_t  in_len,
uint8_t *  out,
size_t *  out_len 
)

Perform hex decoding

Parameters
hex_stra string of hex chars (whitespace is ignored)
in_lenthe length of hex_str
outthe output buffer should be at least strlen(hex_str)/2 bytes
out_lenthe size of out

Definition at line 250 of file ffi.cpp.

References Botan_FFI::ffi_guard_thunk(), Botan::hex_decode(), and Botan_FFI::write_vec_output().

251  {
252  return ffi_guard_thunk(__func__, [=]() -> int {
253  const std::vector<uint8_t> bin = Botan::hex_decode(hex_str, in_len);
254  return Botan_FFI::write_vec_output(out, out_len, bin);
255  });
256  }
int ffi_guard_thunk(const char *func_name, std::function< int()> thunk)
Definition: ffi.cpp:81
int write_vec_output(uint8_t out[], size_t *out_len, const std::vector< uint8_t, Alloc > &buf)
Definition: ffi_util.h:142
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

◆ botan_hex_encode()

int botan_hex_encode ( const uint8_t *  x,
size_t  len,
char *  out,
uint32_t  flags 
)

Perform hex encoding

Parameters
xis some binary data
lenlength of x in bytes
outan array of at least x*2 bytes
flagsflags out be upper or lower case?
Returns
0 on success, 1 on failure

Definition at line 241 of file ffi.cpp.

References BOTAN_FFI_HEX_LOWER_CASE, BOTAN_FFI_SUCCESS, Botan_FFI::ffi_guard_thunk(), Botan::PKCS11::flags(), and Botan::hex_encode().

242  {
243  return ffi_guard_thunk(__func__, [=]() -> int {
244  const bool uppercase = (flags & BOTAN_FFI_HEX_LOWER_CASE) == 0;
245  Botan::hex_encode(out, in, len, uppercase);
246  return BOTAN_FFI_SUCCESS;
247  });
248  }
int ffi_guard_thunk(const char *func_name, std::function< int()> thunk)
Definition: ffi.cpp:81
void hex_encode(char output[], const uint8_t input[], size_t input_length, bool uppercase)
Definition: hex.cpp:14
Flags flags(Flag flags)
Definition: p11.h:858
#define BOTAN_FFI_HEX_LOWER_CASE
Definition: ffi.h:152

◆ botan_same_mem()

int botan_same_mem ( const uint8_t *  x,
const uint8_t *  y,
size_t  len 
)

Deprecated equivalent to botan_constant_time_compare

Definition at line 230 of file ffi.cpp.

References botan_constant_time_compare().

231  {
232  return botan_constant_time_compare(x, y, len);
233  }
int botan_constant_time_compare(const uint8_t *x, const uint8_t *y, size_t len)
Definition: ffi.cpp:225

◆ botan_scrub_mem()

int botan_scrub_mem ( void *  mem,
size_t  bytes 
)

Clear out memory using a system specific approach to bypass elision by the compiler (currently using RtlSecureZeroMemory or tricks with volatile pointers).

Definition at line 235 of file ffi.cpp.

References BOTAN_FFI_SUCCESS, and Botan::secure_scrub_memory().

236  {
237  Botan::secure_scrub_memory(mem, bytes);
238  return BOTAN_FFI_SUCCESS;
239  }
void secure_scrub_memory(void *ptr, size_t n)
Definition: os_utils.cpp:50

◆ botan_version_datestamp()

uint32_t botan_version_datestamp ( )

Return the date this version was released as an integer, or 0 if an unreleased version

Definition at line 223 of file ffi.cpp.

References Botan::version_datestamp().

223 { return Botan::version_datestamp(); }
uint32_t version_datestamp()
Definition: version.cpp:67

◆ botan_version_major()

uint32_t botan_version_major ( )

Return the major version of the library

Definition at line 220 of file ffi.cpp.

References Botan::version_major().

220 { return Botan::version_major(); }
uint32_t version_major()
Definition: version.cpp:72

◆ botan_version_minor()

uint32_t botan_version_minor ( )

Return the minor version of the library

Definition at line 221 of file ffi.cpp.

References Botan::version_minor().

221 { return Botan::version_minor(); }
uint32_t version_minor()
Definition: version.cpp:73

◆ botan_version_patch()

uint32_t botan_version_patch ( )

Return the patch version of the library

Definition at line 222 of file ffi.cpp.

References Botan::version_patch().

222 { return Botan::version_patch(); }
uint32_t version_patch()
Definition: version.cpp:74

◆ botan_version_string()

const char* botan_version_string ( )

Return a free-form version string, e.g., 2.0.0

Definition at line 215 of file ffi.cpp.

References Botan::version_cstr().

216  {
217  return Botan::version_cstr();
218  }
const char * version_cstr()
Definition: version.cpp:29