Botan  2.12.1
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 271 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().

273  {
274  return ffi_guard_thunk(__func__, [=]() -> int {
275  if(*out_len < Botan::base64_decode_max_output(in_len))
276  {
277  *out_len = Botan::base64_decode_max_output(in_len);
279  }
280 
281  *out_len = Botan::base64_decode(out, std::string(base64_str, in_len));
282  return BOTAN_FFI_SUCCESS;
283  });
284  }
int ffi_guard_thunk(const char *func_name, std::function< int()> thunk)
Definition: ffi.cpp:86
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 263 of file ffi.cpp.

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

264  {
265  return ffi_guard_thunk(__func__, [=]() -> int {
266  const std::string base64 = Botan::base64_encode(in, len);
267  return Botan_FFI::write_str_output(out, out_len, base64);
268  });
269  }
int ffi_guard_thunk(const char *func_name, std::function< int()> thunk)
Definition: ffi.cpp:86
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: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 230 of file ffi.cpp.

References Botan::constant_time_compare().

Referenced by botan_same_mem().

231  {
232  return Botan::constant_time_compare(x, y, len) ? 0 : -1;
233  }
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 122 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.

123  {
124  switch(err)
125  {
126  case BOTAN_FFI_SUCCESS:
127  return "OK";
128 
130  return "Invalid verifier";
131 
133  return "Invalid input";
134 
136  return "Invalid authentication code";
137 
139  return "Insufficient buffer space";
140 
142  return "Exception thrown";
143 
145  return "Out of memory";
146 
148  return "Error while calling system API";
149 
151  return "Internal error";
152 
154  return "Bad flag";
155 
157  return "Null pointer argument";
158 
160  return "Bad parameter";
161 
163  return "Key not set on object";
164 
166  return "Invalid key length";
167 
169  return "Invalid object state";
170 
172  return "Not implemented";
173 
175  return "Invalid object handle";
176 
178  return "TLS error";
179 
181  return "HTTP error";
182 
184  return "Unknown error";
185  }
186 
187  return "Unknown error";
188  }

◆ botan_ffi_api_version()

uint32_t botan_ffi_api_version ( void  )

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 193 of file ffi.cpp.

194  {
195  return BOTAN_HAS_FFI;
196  }

◆ 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 198 of file ffi.cpp.

References BOTAN_FFI_SUCCESS.

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

◆ 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 255 of file ffi.cpp.

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

256  {
257  return ffi_guard_thunk(__func__, [=]() -> int {
258  const std::vector<uint8_t> bin = Botan::hex_decode(hex_str, in_len);
259  return Botan_FFI::write_vec_output(out, out_len, bin);
260  });
261  }
int ffi_guard_thunk(const char *func_name, std::function< int()> thunk)
Definition: ffi.cpp:86
int write_vec_output(uint8_t out[], size_t *out_len, const std::vector< uint8_t, Alloc > &buf)
Definition: ffi_util.h:146
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 246 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().

247  {
248  return ffi_guard_thunk(__func__, [=]() -> int {
249  const bool uppercase = (flags & BOTAN_FFI_HEX_LOWER_CASE) == 0;
250  Botan::hex_encode(out, in, len, uppercase);
251  return BOTAN_FFI_SUCCESS;
252  });
253  }
int ffi_guard_thunk(const char *func_name, std::function< int()> thunk)
Definition: ffi.cpp:86
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 235 of file ffi.cpp.

References botan_constant_time_compare().

236  {
237  return botan_constant_time_compare(x, y, len);
238  }
int botan_constant_time_compare(const uint8_t *x, const uint8_t *y, size_t len)
Definition: ffi.cpp:230

◆ 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 240 of file ffi.cpp.

References BOTAN_FFI_SUCCESS, and Botan::secure_scrub_memory().

241  {
242  Botan::secure_scrub_memory(mem, bytes);
243  return BOTAN_FFI_SUCCESS;
244  }
void secure_scrub_memory(void *ptr, size_t n)
Definition: os_utils.cpp:65

◆ botan_version_datestamp()

uint32_t botan_version_datestamp ( void  )

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

Definition at line 228 of file ffi.cpp.

References Botan::version_datestamp().

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

◆ botan_version_major()

uint32_t botan_version_major ( void  )

Return the major version of the library

Definition at line 225 of file ffi.cpp.

References Botan::version_major().

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

◆ botan_version_minor()

uint32_t botan_version_minor ( void  )

Return the minor version of the library

Definition at line 226 of file ffi.cpp.

References Botan::version_minor().

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

◆ botan_version_patch()

uint32_t botan_version_patch ( void  )

Return the patch version of the library

Definition at line 227 of file ffi.cpp.

References Botan::version_patch().

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

◆ botan_version_string()

const char* botan_version_string ( void  )

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

Definition at line 220 of file ffi.cpp.

References Botan::version_cstr().

221  {
222  return Botan::version_cstr();
223  }
const char * version_cstr()
Definition: version.cpp:29