138 lines
4.2 KiB
C++
138 lines
4.2 KiB
C++
/**
|
|
* \file version.h
|
|
*
|
|
* \brief Run-time version information
|
|
*/
|
|
/*
|
|
* Copyright The Mbed TLS Contributors
|
|
* SPDX-License-Identifier: Apache-2.0 OR GPL-2.0-or-later
|
|
*
|
|
* This file is provided under the Apache License 2.0, or the
|
|
* GNU General Public License v2.0 or later.
|
|
*
|
|
* **********
|
|
* Apache License 2.0:
|
|
*
|
|
* Licensed under the Apache License, Version 2.0 (the "License"); you may
|
|
* not use this file except in compliance with the License.
|
|
* You may obtain a copy of the License at
|
|
*
|
|
* http://www.apache.org/licenses/LICENSE-2.0
|
|
*
|
|
* Unless required by applicable law or agreed to in writing, software
|
|
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
|
|
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
* See the License for the specific language governing permissions and
|
|
* limitations under the License.
|
|
*
|
|
* **********
|
|
*
|
|
* **********
|
|
* GNU General Public License v2.0 or later:
|
|
*
|
|
* This program is free software; you can redistribute it and/or modify
|
|
* it under the terms of the GNU General Public License as published by
|
|
* the Free Software Foundation; either version 2 of the License, or
|
|
* (at your option) any later version.
|
|
*
|
|
* This program is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
* GNU General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU General Public License along
|
|
* with this program; if not, write to the Free Software Foundation, Inc.,
|
|
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
|
|
*
|
|
* **********
|
|
*/
|
|
/*
|
|
* This set of compile-time defines and run-time variables can be used to
|
|
* determine the version number of the mbed TLS library used.
|
|
*/
|
|
#ifndef MBEDTLS_VERSION_H
|
|
#define MBEDTLS_VERSION_H
|
|
|
|
#if !defined(MBEDTLS_CONFIG_FILE)
|
|
#include "config.h"
|
|
#else
|
|
#include MBEDTLS_CONFIG_FILE
|
|
#endif
|
|
|
|
/**
|
|
* The version number x.y.z is split into three parts.
|
|
* Major, Minor, Patchlevel
|
|
*/
|
|
#define MBEDTLS_VERSION_MAJOR 2
|
|
#define MBEDTLS_VERSION_MINOR 16
|
|
#define MBEDTLS_VERSION_PATCH 11
|
|
|
|
/**
|
|
* The single version number has the following structure:
|
|
* MMNNPP00
|
|
* Major version | Minor version | Patch version
|
|
*/
|
|
#define MBEDTLS_VERSION_NUMBER 0x02100B00
|
|
#define MBEDTLS_VERSION_STRING "2.16.11"
|
|
#define MBEDTLS_VERSION_STRING_FULL "mbed TLS 2.16.11"
|
|
|
|
#if defined(MBEDTLS_VERSION_C)
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
|
|
/**
|
|
* Get the version number.
|
|
*
|
|
* \return The constructed version number in the format
|
|
* MMNNPP00 (Major, Minor, Patch).
|
|
*/
|
|
unsigned int mbedtls_version_get_number( void );
|
|
|
|
/**
|
|
* Get the version string ("x.y.z").
|
|
*
|
|
* \param string The string that will receive the value.
|
|
* (Should be at least 9 bytes in size)
|
|
*/
|
|
void mbedtls_version_get_string( 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).
|
|
*/
|
|
void mbedtls_version_get_string_full( char *string );
|
|
|
|
/**
|
|
* \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.
|
|
*/
|
|
int mbedtls_version_check_feature( const char *feature );
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|
|
|
|
#endif /* MBEDTLS_VERSION_C */
|
|
|
|
#endif /* version.h */
|