platform.h File Reference

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 <stddef.h>
#include <stdio.h>
#include <stdarg.h>
#include "platform_alt.h"

Include dependency graph for platform.h:

Go to the source code of this file.

Macros
#define	MBEDTLS_EXIT_SUCCESS   0
#define	MBEDTLS_EXIT_FAILURE   1

Functions
void *	mbedtls_calloc (size_t n, size_t size)
void	mbedtls_free (void *ptr)
int	mbedtls_platform_set_calloc_free (void *(*calloc_func)(size_t, size_t), void(*free_func)(void *))
	This function dynamically sets the memory-management functions used by the library, during runtime. More...
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_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_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)

Detailed Description

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.

Definition in file platform.h.

Macro Definition Documentation

#define MBEDTLS_EXIT_FAILURE   1

Definition at line 312 of file platform.h.

#define MBEDTLS_EXIT_SUCCESS   0

Definition at line 307 of file platform.h.

Function Documentation

void* mbedtls_calloc	(	size_t	n,
		size_t	size
	)

void mbedtls_free

(

void *

ptr

)

int mbedtls_platform_set_calloc_free	(	void *(*)(size_t, size_t)	calloc_func,
		void(*)(void *)	free_func
	)

This function dynamically sets the memory-management functions used by the library, during runtime.

Parameters

calloc_func	The calloc function implementation.
free_func	The free function implementation.

Returns

0.

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.

Parameters

exit_func

The exit function implementation.

Returns

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.

Parameters

fprintf_func

The fprintf function implementation.

Returns

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.

Parameters

nv_seed_read_func	The seed reading function implementation.
nv_seed_write_func	The seed writing function implementation.

Returns

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.

Parameters

printf_func

The printf function implementation.

Returns

0 on success.

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.

Parameters

snprintf_func

The snprintf function implementation.

Returns

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.

Parameters

vsnprintf_func

The vsnprintf function implementation

Returns

0

int mbedtls_platform_setup

(

mbedtls_platform_context *

ctx

)

This function performs any platform-specific initialization operations.

Note

This function should be called before any other library functions.

     Its implementation is platform-specific, and unless
     platform-specific code is provided, it does nothing.

The usage and necessity of this function is dependent on the platform.

Parameters

ctx	The platform context.

Returns

0 on success.

void mbedtls_platform_teardown

(

mbedtls_platform_context *

ctx

)

This function performs any platform teardown operations.

Note

This function should be called after every other Mbed TLS module has been correctly freed using the appropriate free function.

Its implementation is platform-specific, and unless platform-specific code is provided, it does nothing.

Note

The usage and necessity of this function is dependent on the platform.

Parameters

ctx	The platform context.

Variable Documentation

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,...)

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)