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

   1 /**
   2  * \file version.h
   3  *
   4  * \brief Run-time version information
   5  *
   6  *  Copyright (C) 2006-2014, ARM Limited, All Rights Reserved
   7  *
   8  *  This file is part of mbed TLS (https://polarssl.org)
   9  *
  10  *  This program is free software; you can redistribute it and/or modify
  11  *  it under the terms of the GNU General Public License as published by
  12  *  the Free Software Foundation; either version 2 of the License, or
  13  *  (at your option) any later version.
  14  *
  15  *  This program is distributed in the hope that it will be useful,
  16  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  *  GNU General Public License for more details.
  19  *
  20  *  You should have received a copy of the GNU General Public License along
  21  *  with this program; if not, write to the Free Software Foundation, Inc.,
  22  *  51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  23  */
  24 /*
  25  * This set of compile-time defines and run-time variables can be used to
  26  * determine the version number of the mbed TLS library used.
  27  */
  28 #ifndef POLARSSL_VERSION_H
  29 #define POLARSSL_VERSION_H
  30
  31 #if !defined(POLARSSL_CONFIG_FILE)
  32 #include "config.h"
  33 #else
  34 #include POLARSSL_CONFIG_FILE
  35 #endif
  36
  37 /**
  38  * The version number x.y.z is split into three parts.
  39  * Major, Minor, Patchlevel
  40  */
  41 #define POLARSSL_VERSION_MAJOR  1
  42 #define POLARSSL_VERSION_MINOR  3
  43 #define POLARSSL_VERSION_PATCH  10
  44
  45 /**
  46  * The single version number has the following structure:
  47  *    MMNNPP00
  48  *    Major version | Minor version | Patch version
  49  */
  50 #define POLARSSL_VERSION_NUMBER         0x01030A00
  51 #define POLARSSL_VERSION_STRING         "1.3.10"
  52 #define POLARSSL_VERSION_STRING_FULL    "mbed TLS 1.3.10"
  53
  54 #if defined(POLARSSL_VERSION_C)
  55
  56 #ifdef __cplusplus
  57 extern "C" {
  58 #endif
  59
  60 /**
  61  * Get the version number.
  62  *
  63  * \return          The constructed version number in the format
  64  *                  MMNNPP00 (Major, Minor, Patch).
  65  */
  66 unsigned int version_get_number( void );
  67
  68 /**
  69  * Get the version string ("x.y.z").
  70  *
  71  * \param string    The string that will receive the value.
  72  *                  (Should be at least 9 bytes in size)
  73  */
  74 void version_get_string( char *string );
  75
  76 /**
  77  * Get the full version string ("mbed TLS x.y.z").
  78  *
  79  * \param string    The string that will receive the value. The mbed TLS version
  80  *                  string will use 18 bytes AT MOST including a terminating
  81  *                  null byte.
  82  *                  (So the buffer should be at least 18 bytes to receive this
  83  *                  version string).
  84  */
  85 void version_get_string_full( char *string );
  86
  87 /**
  88  * \brief           Check if support for a feature was compiled into this
  89  *                  mbed TLS binary. This allows you to see at runtime if the
  90  *                  library was for instance compiled with or without
  91  *                  Multi-threading support.
  92  *
  93  *                  Note: only checks against defines in the sections "System
  94  *                        support", "mbed TLS modules" and "mbed TLS feature
  95  *                        support" in config.h
  96  *
  97  * \param feature   The string for the define to check (e.g. "POLARSSL_AES_C")
  98  *
  99  * \return          0 if the feature is present, -1 if the feature is not
 100  *                  present and -2 if support for feature checking as a whole
 101  *                  was not compiled in.
 102  */
 103 int version_check_feature( const char *feature );
 104
 105 #ifdef __cplusplus
 106 }
 107 #endif
 108
 109 #endif /* POLARSSL_VERSION_C */
 110
 111 #endif /* version.h */