Documentation

Documentation

Includes

config.h

#include "config.h"
#include "config.h"

MBEDTLS_CONFIG_FILE

#include MBEDTLS_CONFIG_FILE
#include MBEDTLS_CONFIG_FILE

Macros

Marco MBEDTLS_VERSION_H

#define MBEDTLS_VERSION_H


      

Marco MBEDTLS_VERSION_MAJOR

#define MBEDTLS_VERSION_MAJOR 2
/**
 * The version number x.y.z is split into three parts.
 * Major, Minor, Patchlevel
 */

Marco MBEDTLS_VERSION_MINOR

#define MBEDTLS_VERSION_MINOR 16


      

Marco MBEDTLS_VERSION_PATCH

#define MBEDTLS_VERSION_PATCH 2


      

Marco MBEDTLS_VERSION_NUMBER

#define MBEDTLS_VERSION_NUMBER        34603520
/**
 * The single version number has the following structure:
 *    MMNNPP00
 *    Major version | Minor version | Patch version
 */

Marco MBEDTLS_VERSION_STRING

#define MBEDTLS_VERSION_STRING        "2.16.2"


      

Marco MBEDTLS_VERSION_STRING_FULL

#define MBEDTLS_VERSION_STRING_FULL   "mbed TLS 2.16.2"

      

Functions

Func mbedtls_version_get_number

unsigned int mbedtls_version_get_number( void );
/**
 * Get the version number.
 *
 * \return          The constructed version number in the format
 *                  MMNNPP00 (Major, Minor, Patch).
 */

Func mbedtls_version_get_string

void mbedtls_version_get_string( char *string );
/**
 * Get the version string ("x.y.z").
 *
 * \param string    The string that will receive the value.
 *                  (Should be at least 9 bytes in size)
 */

Func mbedtls_version_get_string_full

void mbedtls_version_get_string_full( char *string );
/**
 * Get the full version string ("mbed TLS x.y.z").
 *
 * \param string    The string that will receive the value. The mbed TLS version
 *                  string will use 18 bytes AT MOST including a terminating
 *                  null byte.
 *                  (So the buffer should be at least 18 bytes to receive this
 *                  version string).
 */

Func mbedtls_version_check_feature

int mbedtls_version_check_feature( const char *feature );
/**
 * \brief           Check if support for a feature was compiled into this
 *                  mbed TLS binary. This allows you to see at runtime if the
 *                  library was for instance compiled with or without
 *                  Multi-threading support.
 *
 * \note            only checks against defines in the sections "System
 *                  support", "mbed TLS modules" and "mbed TLS feature
 *                  support" in config.h
 *
 * \param feature   The string for the define to check (e.g. "MBEDTLS_AES_C")
 *
 * \return          0 if the feature is present,
 *                  -1 if the feature is not present and
 *                  -2 if support for feature checking as a whole was not
 *                  compiled in.
 */

Vars

Consts

Types

Typedefs