Mbed TLS v2.28.5
Data Structures | Macros | Typedefs | Functions
platform.h File Reference

This file contains the definitions and functions of the Mbed TLS platform abstraction layer. More...

#include "mbedtls/config.h"
#include "mbedtls/platform_time.h"
#include <stdio.h>
#include <stdlib.h>
#include <time.h>
Include dependency graph for platform.h:

Go to the source code of this file.

Data Structures

struct  mbedtls_platform_context
 The platform context structure. More...
 

Macros

#define MBEDTLS_ERR_PLATFORM_HW_ACCEL_FAILED   -0x0070
 
#define MBEDTLS_ERR_PLATFORM_FEATURE_UNSUPPORTED   -0x0072
 
#define mbedtls_free   free
 
#define mbedtls_calloc   calloc
 
#define mbedtls_fprintf   fprintf
 
#define mbedtls_printf   printf
 
#define mbedtls_snprintf   MBEDTLS_PLATFORM_STD_SNPRINTF
 
#define mbedtls_vsnprintf   vsnprintf
 
#define mbedtls_exit   exit
 
#define MBEDTLS_EXIT_SUCCESS   MBEDTLS_PLATFORM_STD_EXIT_SUCCESS
 
#define MBEDTLS_EXIT_FAILURE   MBEDTLS_PLATFORM_STD_EXIT_FAILURE
 
SECTION: Module settings

The configuration options you can set for this module are in this section. Either change them in config.h or define them on the compiler command line.

#define MBEDTLS_PLATFORM_STD_SNPRINTF   snprintf
 
#define MBEDTLS_PLATFORM_STD_VSNPRINTF   vsnprintf
 
#define MBEDTLS_PLATFORM_STD_PRINTF   printf
 
#define MBEDTLS_PLATFORM_STD_FPRINTF   fprintf
 
#define MBEDTLS_PLATFORM_STD_CALLOC   calloc
 
#define MBEDTLS_PLATFORM_STD_FREE   free
 
#define MBEDTLS_PLATFORM_STD_EXIT   exit
 
#define MBEDTLS_PLATFORM_STD_TIME   time
 
#define MBEDTLS_PLATFORM_STD_EXIT_SUCCESS   EXIT_SUCCESS
 
#define MBEDTLS_PLATFORM_STD_EXIT_FAILURE   EXIT_FAILURE
 
#define MBEDTLS_PLATFORM_STD_NV_SEED_READ   mbedtls_platform_std_nv_seed_read
 
#define MBEDTLS_PLATFORM_STD_NV_SEED_WRITE   mbedtls_platform_std_nv_seed_write
 
#define MBEDTLS_PLATFORM_STD_NV_SEED_FILE   "seedfile"
 

Typedefs

typedef struct mbedtls_platform_context mbedtls_platform_context
 The platform context structure. More...
 

Functions

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

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.

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.

Macro Definition Documentation

◆ mbedtls_calloc

#define mbedtls_calloc   calloc

Definition at line 184 of file platform.h.

◆ MBEDTLS_ERR_PLATFORM_FEATURE_UNSUPPORTED

#define MBEDTLS_ERR_PLATFORM_FEATURE_UNSUPPORTED   -0x0072

The requested feature is not supported by the platform

Definition at line 54 of file platform.h.

◆ MBEDTLS_ERR_PLATFORM_HW_ACCEL_FAILED

#define MBEDTLS_ERR_PLATFORM_HW_ACCEL_FAILED   -0x0070

Hardware accelerator failed

Definition at line 52 of file platform.h.

◆ mbedtls_exit

#define mbedtls_exit   exit

Definition at line 334 of file platform.h.

◆ MBEDTLS_EXIT_FAILURE

#define MBEDTLS_EXIT_FAILURE   MBEDTLS_PLATFORM_STD_EXIT_FAILURE

Definition at line 347 of file platform.h.

◆ MBEDTLS_EXIT_SUCCESS

#define MBEDTLS_EXIT_SUCCESS   MBEDTLS_PLATFORM_STD_EXIT_SUCCESS

Definition at line 342 of file platform.h.

◆ mbedtls_fprintf

#define mbedtls_fprintf   fprintf

Definition at line 211 of file platform.h.

◆ mbedtls_free

#define mbedtls_free   free

Definition at line 183 of file platform.h.

◆ MBEDTLS_PLATFORM_STD_CALLOC

#define MBEDTLS_PLATFORM_STD_CALLOC   calloc

Default allocator to use, can be undefined. It must initialize the allocated buffer memory to zeroes. The size of the buffer is the product of the two parameters. The calloc function returns either a null pointer or a pointer to the allocated space. If the product is 0, the function may either return NULL or a valid pointer to an array of size 0 which is a valid input to the deallocation function. An uninitialized MBEDTLS_PLATFORM_STD_CALLOC always fails, returning a null pointer. See the description of #MBEDTLS_PLATFORM_MEMORY for more details. The corresponding deallocation function is MBEDTLS_PLATFORM_STD_FREE.

The default calloc function to use.

Definition at line 104 of file platform.h.

◆ MBEDTLS_PLATFORM_STD_EXIT

#define MBEDTLS_PLATFORM_STD_EXIT   exit

The default exit function to use.

Definition at line 110 of file platform.h.

◆ MBEDTLS_PLATFORM_STD_EXIT_FAILURE

#define MBEDTLS_PLATFORM_STD_EXIT_FAILURE   EXIT_FAILURE

The default exit value to use.

Definition at line 119 of file platform.h.

◆ MBEDTLS_PLATFORM_STD_EXIT_SUCCESS

#define MBEDTLS_PLATFORM_STD_EXIT_SUCCESS   EXIT_SUCCESS

The default exit value to use.

Definition at line 116 of file platform.h.

◆ MBEDTLS_PLATFORM_STD_FPRINTF

#define MBEDTLS_PLATFORM_STD_FPRINTF   fprintf

The default fprintf function to use.

Definition at line 101 of file platform.h.

◆ MBEDTLS_PLATFORM_STD_FREE

#define MBEDTLS_PLATFORM_STD_FREE   free

Default free to use, can be undefined. NULL is a valid parameter, and the function must do nothing. A non-null parameter will always be a pointer previously returned by MBEDTLS_PLATFORM_STD_CALLOC and not yet freed. An uninitialized MBEDTLS_PLATFORM_STD_FREE does not do anything. See the description of #MBEDTLS_PLATFORM_MEMORY for more details (same principles as for MBEDTLS_PLATFORM_STD_CALLOC apply).

The default free function to use.

Definition at line 107 of file platform.h.

◆ MBEDTLS_PLATFORM_STD_NV_SEED_FILE

#define MBEDTLS_PLATFORM_STD_NV_SEED_FILE   "seedfile"

Definition at line 129 of file platform.h.

◆ MBEDTLS_PLATFORM_STD_NV_SEED_READ

#define MBEDTLS_PLATFORM_STD_NV_SEED_READ   mbedtls_platform_std_nv_seed_read

Definition at line 123 of file platform.h.

◆ MBEDTLS_PLATFORM_STD_NV_SEED_WRITE

#define MBEDTLS_PLATFORM_STD_NV_SEED_WRITE   mbedtls_platform_std_nv_seed_write

Definition at line 126 of file platform.h.

◆ MBEDTLS_PLATFORM_STD_PRINTF

#define MBEDTLS_PLATFORM_STD_PRINTF   printf

The default printf function to use.

Definition at line 98 of file platform.h.

◆ MBEDTLS_PLATFORM_STD_SNPRINTF

#define MBEDTLS_PLATFORM_STD_SNPRINTF   snprintf

The default snprintf function to use.

Definition at line 87 of file platform.h.

◆ MBEDTLS_PLATFORM_STD_TIME

#define MBEDTLS_PLATFORM_STD_TIME   time

The default time function to use.

Definition at line 113 of file platform.h.

◆ MBEDTLS_PLATFORM_STD_VSNPRINTF

#define MBEDTLS_PLATFORM_STD_VSNPRINTF   vsnprintf

The default vsnprintf function to use.

Definition at line 94 of file platform.h.

◆ mbedtls_printf

#define mbedtls_printf   printf

Definition at line 236 of file platform.h.

◆ mbedtls_snprintf

#define mbedtls_snprintf   MBEDTLS_PLATFORM_STD_SNPRINTF

Definition at line 272 of file platform.h.

◆ mbedtls_vsnprintf

#define mbedtls_vsnprintf   vsnprintf

Definition at line 309 of file platform.h.

Typedef Documentation

◆ mbedtls_platform_context

The platform context structure.

Note
This structure may be used to assist platform-specific setup or teardown operations.

Function Documentation

◆ mbedtls_platform_setup()

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
ctxThe platform context.
Returns
0 on success.

◆ mbedtls_platform_teardown()

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
ctxThe platform context.