Mbed TLS v3.6.3
|
This file contains the definitions and functions of the Mbed TLS platform abstraction layer. More...
#include "mbedtls/private_access.h"
#include "mbedtls/build_info.h"
#include "mbedtls/platform_time.h"
#include <stdlib.h>
#include <stdio.h>
#include <stdarg.h>
#include "platform_alt.h"
Go to the source code of this file.
Functions | |
int | mbedtls_platform_set_fprintf (int(*fprintf_func)(FILE *stream, const char *,...)) |
This function dynamically configures the fprintf function that is called when the mbedtls_fprintf() function is invoked by the library. More... | |
int | mbedtls_platform_set_printf (int(*printf_func)(const char *,...)) |
This function dynamically configures the snprintf function that is called when the mbedtls_snprintf() function is invoked by the library. More... | |
int | mbedtls_platform_set_snprintf (int(*snprintf_func)(char *s, size_t n, const char *format,...)) |
This function allows configuring a custom snprintf function pointer. More... | |
int | mbedtls_platform_set_vsnprintf (int(*vsnprintf_func)(char *s, size_t n, const char *format, va_list arg)) |
Set your own snprintf function pointer. More... | |
int | mbedtls_platform_set_setbuf (void(*setbuf_func)(FILE *stream, char *buf)) |
Dynamically configure the function that is called when the mbedtls_setbuf() function is called by the library. More... | |
int | mbedtls_platform_set_exit (void(*exit_func)(int status)) |
This function dynamically configures the exit function that is called when the mbedtls_exit() function is invoked by the library. More... | |
int | mbedtls_platform_set_nv_seed (int(*nv_seed_read_func)(unsigned char *buf, size_t buf_len), int(*nv_seed_write_func)(unsigned char *buf, size_t buf_len)) |
This function allows configuring custom seed file writing and reading functions. More... | |
int | mbedtls_platform_setup (mbedtls_platform_context *ctx) |
This function performs any platform-specific initialization operations. More... | |
void | mbedtls_platform_teardown (mbedtls_platform_context *ctx) |
This function performs any platform teardown operations. More... | |
Variables | |
int(* | mbedtls_fprintf )(FILE *stream, const char *format,...) |
int(* | mbedtls_printf )(const char *format,...) |
int(* | mbedtls_snprintf )(char *s, size_t n, const char *format,...) |
int(* | mbedtls_vsnprintf )(char *s, size_t n, const char *format, va_list arg) |
void(* | mbedtls_setbuf )(FILE *stream, char *buf) |
Function pointer to call for setbuf() functionality (changing the internal buffering on stdio calls). More... | |
void(* | mbedtls_exit )(int status) |
int(* | mbedtls_nv_seed_read )(unsigned char *buf, size_t buf_len) |
int(* | mbedtls_nv_seed_write )(unsigned char *buf, size_t buf_len) |
This file contains the definitions and functions of the Mbed TLS platform abstraction layer.
The platform abstraction layer removes the need for the library to directly link to standard C library functions or operating system services, making the library easier to port and embed. Application developers and users of the library can provide their own implementations of these functions, or implementations specific to their platform, which can be statically linked to the library or dynamically configured at runtime.
When all compilation options related to platform abstraction are disabled, this header just defines mbedtls_xxx
function names as aliases to the standard xxx
function.
Most modules in the library and example programs are expected to include this header.
Definition in file platform.h.
#define mbedtls_calloc MBEDTLS_PLATFORM_CALLOC_MACRO |
Definition at line 144 of file platform.h.
#define MBEDTLS_EXIT_FAILURE MBEDTLS_PLATFORM_STD_EXIT_FAILURE |
Definition at line 383 of file platform.h.
#define MBEDTLS_EXIT_SUCCESS MBEDTLS_PLATFORM_STD_EXIT_SUCCESS |
Definition at line 378 of file platform.h.
#define mbedtls_free MBEDTLS_PLATFORM_FREE_MACRO |
Definition at line 143 of file platform.h.
int mbedtls_platform_set_exit | ( | void(*)(int status) | exit_func | ) |
This function dynamically configures the exit function that is called when the mbedtls_exit() function is invoked by the library.
exit_func | The exit function implementation. |
0
on success. int mbedtls_platform_set_fprintf | ( | int(*)(FILE *stream, const char *,...) | fprintf_func | ) |
This function dynamically configures the fprintf function that is called when the mbedtls_fprintf() function is invoked by the library.
fprintf_func | The fprintf function implementation. |
0
. int mbedtls_platform_set_nv_seed | ( | int(*)(unsigned char *buf, size_t buf_len) | nv_seed_read_func, |
int(*)(unsigned char *buf, size_t buf_len) | nv_seed_write_func | ||
) |
This function allows configuring custom seed file writing and reading functions.
nv_seed_read_func | The seed reading function implementation. |
nv_seed_write_func | The seed writing function implementation. |
0
on success. int mbedtls_platform_set_printf | ( | int(*)(const char *,...) | printf_func | ) |
This function dynamically configures the snprintf function that is called when the mbedtls_snprintf() function is invoked by the library.
printf_func | The printf function implementation. |
0
on success. int mbedtls_platform_set_setbuf | ( | void(*)(FILE *stream, char *buf) | setbuf_func | ) |
Dynamically configure the function that is called when the mbedtls_setbuf() function is called by the library.
setbuf_func | The setbuf function implementation |
0
int mbedtls_platform_set_snprintf | ( | int(*)(char *s, size_t n, const char *format,...) | snprintf_func | ) |
This function allows configuring a custom snprintf
function pointer.
snprintf_func | The snprintf function implementation. |
0
on success. int mbedtls_platform_set_vsnprintf | ( | int(*)(char *s, size_t n, const char *format, va_list arg) | vsnprintf_func | ) |
Set your own snprintf function pointer.
vsnprintf_func | The vsnprintf function implementation |
0
int mbedtls_platform_setup | ( | mbedtls_platform_context * | ctx | ) |
This function performs any platform-specific initialization operations.
Its implementation is platform-specific, and unless platform-specific code is provided, it does nothing.
ctx | The platform context. |
0
on success. void mbedtls_platform_teardown | ( | mbedtls_platform_context * | ctx | ) |
This function performs any platform teardown operations.
Its implementation is platform-specific, and unless platform-specific code is provided, it does nothing.
ctx | The platform context. |
void(* mbedtls_exit)(int status) |
int(* mbedtls_fprintf)(FILE *stream, const char *format,...) |
int(* mbedtls_nv_seed_read)(unsigned char *buf, size_t buf_len) |
int(* mbedtls_nv_seed_write)(unsigned char *buf, size_t buf_len) |
int(* mbedtls_printf)(const char *format,...) |
void(* mbedtls_setbuf)(FILE *stream, char *buf) |
Function pointer to call for setbuf()
functionality (changing the internal buffering on stdio calls).
The library always calls this function with buf
equal to NULL
.
int(* mbedtls_snprintf)(char *s, size_t n, const char *format,...) |
int(* mbedtls_vsnprintf)(char *s, size_t n, const char *format, va_list arg) |