reactos/include/reactos/libs/mbedtls/version.h

   1 /**
   2  * \file version.h
   3  *
   4  * \brief Run-time version information
   5  *
   6  *  Copyright (C) 2006-2015, ARM Limited, All Rights Reserved
   7  *  SPDX-License-Identifier: Apache-2.0
   8  *
   9  *  Licensed under the Apache License, Version 2.0 (the "License"); you may
  10  *  not use this file except in compliance with the License.
  11  *  You may obtain a copy of the License at
  12  *
  13  *  http://www.apache.org/licenses/LICENSE-2.0
  14  *
  15  *  Unless required by applicable law or agreed to in writing, software
  16  *  distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
  17  *  WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  18  *  See the License for the specific language governing permissions and
  19  *  limitations under the License.
  20  *
  21  *  This file is part of mbed TLS (https://tls.mbed.org)
  22  */
  23 /*
  24  * This set of compile-time defines and run-time variables can be used to
  25  * determine the version number of the mbed TLS library used.
  26  */
  27 #ifndef MBEDTLS_VERSION_H
  28 #define MBEDTLS_VERSION_H
  29
  30 #if !defined(MBEDTLS_CONFIG_FILE)
  31 #include "config.h"
  32 #else
  33 #include MBEDTLS_CONFIG_FILE
  34 #endif
  35
  36 /**
  37  * The version number x.y.z is split into three parts.
  38  * Major, Minor, Patchlevel
  39  */
  40 #define MBEDTLS_VERSION_MAJOR  2
  41 #define MBEDTLS_VERSION_MINOR  2
  42 #define MBEDTLS_VERSION_PATCH  0
  43
  44 /**
  45  * The single version number has the following structure:
  46  *    MMNNPP00
  47  *    Major version | Minor version | Patch version
  48  */
  49 #define MBEDTLS_VERSION_NUMBER         0x02020000
  50 #define MBEDTLS_VERSION_STRING         "2.2.0"
  51 #define MBEDTLS_VERSION_STRING_FULL    "mbed TLS 2.2.0"
  52
  53 #if defined(MBEDTLS_VERSION_C)
  54
  55 #ifdef __cplusplus
  56 extern "C" {
  57 #endif
  58
  59 /**
  60  * Get the version number.
  61  *
  62  * \return          The constructed version number in the format
  63  *                  MMNNPP00 (Major, Minor, Patch).
  64  */
  65 unsigned int mbedtls_version_get_number( void );
  66
  67 /**
  68  * Get the version string ("x.y.z").
  69  *
  70  * \param string    The string that will receive the value.
  71  *                  (Should be at least 9 bytes in size)
  72  */
  73 void mbedtls_version_get_string( char *string );
  74
  75 /**
  76  * Get the full version string ("mbed TLS x.y.z").
  77  *
  78  * \param string    The string that will receive the value. The mbed TLS version
  79  *                  string will use 18 bytes AT MOST including a terminating
  80  *                  null byte.
  81  *                  (So the buffer should be at least 18 bytes to receive this
  82  *                  version string).
  83  */
  84 void mbedtls_version_get_string_full( char *string );
  85
  86 /**
  87  * \brief           Check if support for a feature was compiled into this
  88  *                  mbed TLS binary. This allows you to see at runtime if the
  89  *                  library was for instance compiled with or without
  90  *                  Multi-threading support.
  91  *
  92  * \note            only checks against defines in the sections "System
  93  *                  support", "mbed TLS modules" and "mbed TLS feature
  94  *                  support" in config.h
  95  *
  96  * \param feature   The string for the define to check (e.g. "MBEDTLS_AES_C")
  97  *
  98  * \return          0 if the feature is present,
  99  *                  -1 if the feature is not present and
 100  *                  -2 if support for feature checking as a whole was not
 101  *                  compiled in.
 102  */
 103 int mbedtls_version_check_feature( const char *feature );
 104
 105 #ifdef __cplusplus
 106 }
 107 #endif
 108
 109 #endif /* MBEDTLS_VERSION_C */
 110
 111 #endif /* version.h */