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