Botan 3.7.1
Crypto and TLS for C&
ffi.cpp File Reference
#include <botan/ffi.h>
#include <botan/base64.h>
#include <botan/hex.h>
#include <botan/mem_ops.h>
#include <botan/version.h>
#include <botan/internal/ct_utils.h>
#include <botan/internal/ffi_util.h>
#include <cstdio>
#include <cstdlib>

Go to the source code of this file.

Namespaces

namespace  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)
 
const char * botan_error_last_exception_message ()
 
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::botan_view_bin_bounce_fn (botan_view_ctx vctx, const uint8_t *buf, size_t len)
 
int Botan_FFI::botan_view_str_bounce_fn (botan_view_ctx vctx, const char *str, size_t len)
 
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, const 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 345 of file ffi.cpp.

345 {
346 return ffi_guard_thunk(__func__, [=]() -> int {
347 if(*out_len < Botan::base64_decode_max_output(in_len)) {
348 *out_len = Botan::base64_decode_max_output(in_len);
350 }
351
352 *out_len = Botan::base64_decode(out, std::string(base64_str, in_len));
353 return BOTAN_FFI_SUCCESS;
354 });
355}
@ BOTAN_FFI_SUCCESS
Definition ffi.h:114
@ BOTAN_FFI_ERROR_INSUFFICIENT_BUFFER_SPACE
Definition ffi.h:120
int ffi_guard_thunk(const char *func_name, const std::function< int()> &thunk)
Definition ffi.cpp:128
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:168
size_t base64_decode_max_output(size_t input_length)
Definition base64.cpp:200

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

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

338 {
339 return ffi_guard_thunk(__func__, [=]() -> int {
340 const std::string base64 = Botan::base64_encode(in, len);
341 return Botan_FFI::write_str_output(out, out_len, base64);
342 });
343}
int write_str_output(uint8_t out[], size_t *out_len, std::string_view str)
Definition ffi_util.h:205
size_t base64_encode(char out[], const uint8_t in[], size_t input_length, size_t &input_consumed, bool final_inputs)
Definition base64.cpp:160

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

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

308 {
309 auto same = Botan::CT::is_equal(x, y, len);
310 // Return 0 if same or -1 otherwise
311 return static_cast<int>(same.select(1, 0)) - 1;
312}
constexpr CT::Mask< T > is_equal(const T x[], const T y[], size_t len)
Definition ct_utils.h:788

References Botan::CT::is_equal().

Referenced by botan_same_mem().

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

156 {
157 switch(err) {
159 return "OK";
160
162 return "Invalid verifier";
163
165 return "Invalid input";
166
168 return "Invalid authentication code";
169
171 return "Insufficient buffer space";
172
174 return "String conversion error";
175
177 return "Exception thrown";
178
180 return "Out of memory";
181
183 return "Error while calling system API";
184
186 return "Internal error";
187
189 return "Bad flag";
190
192 return "Null pointer argument";
193
195 return "Bad parameter";
196
198 return "Key not set on object";
199
201 return "Invalid key length";
202
204 return "Invalid object state";
205
207 return "Not implemented";
208
210 return "Invalid object handle";
211
213 return "TLS error";
214
216 return "HTTP error";
217
219 return "Unknown error";
220
221 default:
222 return "Unknown error";
223 }
224}
@ BOTAN_FFI_ERROR_NOT_IMPLEMENTED
Definition ffi.h:135
@ BOTAN_FFI_ERROR_INVALID_KEY_LENGTH
Definition ffi.h:132
@ BOTAN_FFI_ERROR_KEY_NOT_SET
Definition ffi.h:131
@ BOTAN_FFI_ERROR_TLS_ERROR
Definition ffi.h:138
@ BOTAN_FFI_ERROR_EXCEPTION_THROWN
Definition ffi.h:123
@ BOTAN_FFI_ERROR_OUT_OF_MEMORY
Definition ffi.h:124
@ BOTAN_FFI_ERROR_INTERNAL_ERROR
Definition ffi.h:126
@ BOTAN_FFI_INVALID_VERIFIER
Definition ffi.h:115
@ BOTAN_FFI_ERROR_INVALID_OBJECT
Definition ffi.h:136
@ BOTAN_FFI_ERROR_UNKNOWN_ERROR
Definition ffi.h:143
@ BOTAN_FFI_ERROR_HTTP_ERROR
Definition ffi.h:139
@ BOTAN_FFI_ERROR_BAD_FLAG
Definition ffi.h:128
@ BOTAN_FFI_ERROR_INVALID_INPUT
Definition ffi.h:117
@ BOTAN_FFI_ERROR_STRING_CONVERSION_ERROR
Definition ffi.h:121
@ BOTAN_FFI_ERROR_NULL_POINTER
Definition ffi.h:129
@ BOTAN_FFI_ERROR_SYSTEM_ERROR
Definition ffi.h:125
@ BOTAN_FFI_ERROR_INVALID_OBJECT_STATE
Definition ffi.h:133
@ BOTAN_FFI_ERROR_BAD_MAC
Definition ffi.h:118
@ BOTAN_FFI_ERROR_BAD_PARAMETER
Definition ffi.h:130

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_STRING_CONVERSION_ERROR, BOTAN_FFI_ERROR_SYSTEM_ERROR, BOTAN_FFI_ERROR_TLS_ERROR, BOTAN_FFI_ERROR_UNKNOWN_ERROR, BOTAN_FFI_INVALID_VERIFIER, and BOTAN_FFI_SUCCESS.

◆ botan_error_last_exception_message()

const char * botan_error_last_exception_message ( void )

Return the message of the last exception caught in this thread.

This pointer can/will be reallocated or overwritten the next time this thread calls any other Botan FFI function and must be copied to persistent storage first.

Definition at line 152 of file ffi.cpp.

152 {
153 return g_last_exception_what.c_str();
154}

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

229 {
230 return BOTAN_HAS_FFI;
231}
#define BOTAN_HAS_FFI
Definition build.h:253

References BOTAN_HAS_FFI.

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

233 {
234 // This is the API introduced in 3.4
235 if(api_version == 20240408) {
236 return BOTAN_FFI_SUCCESS;
237 }
238
239 // This is the API introduced in 3.2
240 if(api_version == 20231009) {
241 return BOTAN_FFI_SUCCESS;
242 }
243
244 // This is the API introduced in 3.1
245 if(api_version == 20230711) {
246 return BOTAN_FFI_SUCCESS;
247 }
248
249 // This is the API introduced in 3.0
250 if(api_version == 20230403) {
251 return BOTAN_FFI_SUCCESS;
252 }
253
254 // This is the API introduced in 2.18
255 if(api_version == 20210220) {
256 return BOTAN_FFI_SUCCESS;
257 }
258
259 // This is the API introduced in 2.13
260 if(api_version == 20191214) {
261 return BOTAN_FFI_SUCCESS;
262 }
263
264 // This is the API introduced in 2.8
265 if(api_version == 20180713) {
266 return BOTAN_FFI_SUCCESS;
267 }
268
269 // This is the API introduced in 2.3
270 if(api_version == 20170815) {
271 return BOTAN_FFI_SUCCESS;
272 }
273
274 // This is the API introduced in 2.1
275 if(api_version == 20170327) {
276 return BOTAN_FFI_SUCCESS;
277 }
278
279 // This is the API introduced in 2.0
280 if(api_version == 20150515) {
281 return BOTAN_FFI_SUCCESS;
282 }
283
284 // Something else:
285 return -1;
286}

References BOTAN_FFI_SUCCESS.

◆ 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 the output buffer on input, set to the number of bytes written
Returns
0 on success, a negative value on failure

Definition at line 331 of file ffi.cpp.

331 {
332 return ffi_guard_thunk(__func__, [=]() -> int {
333 const std::vector<uint8_t> bin = Botan::hex_decode(hex_str, in_len);
334 return Botan_FFI::write_vec_output(out, out_len, bin);
335 });
336}
int write_vec_output(uint8_t out[], size_t *out_len, const std::vector< uint8_t, Alloc > &buf)
Definition ffi_util.h:201
size_t hex_decode(uint8_t output[], const char input[], size_t input_length, size_t &input_consumed, bool ignore_ws)
Definition hex.cpp:73

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

◆ 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, a negative value on failure

Definition at line 323 of file ffi.cpp.

323 {
324 return ffi_guard_thunk(__func__, [=]() -> int {
325 const bool uppercase = (flags & BOTAN_FFI_HEX_LOWER_CASE) == 0;
326 Botan::hex_encode(out, in, len, uppercase);
327 return BOTAN_FFI_SUCCESS;
328 });
329}
#define BOTAN_FFI_HEX_LOWER_CASE
Definition ffi.h:237
Flags flags(Flag flags)
Definition p11.h:838
void hex_encode(char output[], const uint8_t input[], size_t input_length, bool uppercase)
Definition hex.cpp:35

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

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

314 {
315 return botan_constant_time_compare(x, y, len);
316}
int botan_constant_time_compare(const uint8_t *x, const uint8_t *y, size_t len)
Definition ffi.cpp:308

References botan_constant_time_compare().

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

318 {
319 Botan::secure_scrub_memory(mem, bytes);
320 return BOTAN_FFI_SUCCESS;
321}
void secure_scrub_memory(void *ptr, size_t n)
Definition mem_utils.cpp:19

References BOTAN_FFI_SUCCESS, and Botan::secure_scrub_memory().

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

304 {
306}
uint32_t version_datestamp()
Definition version.cpp:75

References Botan::version_datestamp().

◆ botan_version_major()

uint32_t botan_version_major ( void )

Return the major version of the library

Definition at line 292 of file ffi.cpp.

292 {
293 return Botan::version_major();
294}
uint32_t version_major()
Definition version.cpp:82

References Botan::version_major().

◆ botan_version_minor()

uint32_t botan_version_minor ( void )

Return the minor version of the library

Definition at line 296 of file ffi.cpp.

296 {
297 return Botan::version_minor();
298}
uint32_t version_minor()
Definition version.cpp:86

References Botan::version_minor().

◆ botan_version_patch()

uint32_t botan_version_patch ( void )

Return the patch version of the library

Definition at line 300 of file ffi.cpp.

300 {
301 return Botan::version_patch();
302}
uint32_t version_patch()
Definition version.cpp:90

References Botan::version_patch().

◆ botan_version_string()

const char * botan_version_string ( void )

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

Definition at line 288 of file ffi.cpp.

288 {
289 return Botan::version_cstr();
290}
const char * version_cstr()
Definition version.cpp:33

References Botan::version_cstr().