git.sur5r.net Git - freertos/blob - FreeRTOS-Labs/Source/mbedtls/library/platform_util.c

   1 /*\r
   2  * Common and shared functions used by multiple modules in the Mbed TLS\r
   3  * library.\r
   4  *\r
   5  *  Copyright (C) 2018, Arm Limited, All Rights Reserved\r
   6  *  SPDX-License-Identifier: Apache-2.0\r
   7  *\r
   8  *  Licensed under the Apache License, Version 2.0 (the "License"); you may\r
   9  *  not use this file except in compliance with the License.\r
  10  *  You may obtain a copy of the License at\r
  11  *\r
  12  *  http://www.apache.org/licenses/LICENSE-2.0\r
  13  *\r
  14  *  Unless required by applicable law or agreed to in writing, software\r
  15  *  distributed under the License is distributed on an "AS IS" BASIS, WITHOUT\r
  16  *  WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\r
  17  *  See the License for the specific language governing permissions and\r
  18  *  limitations under the License.\r
  19  *\r
  20  *  This file is part of Mbed TLS (https://tls.mbed.org)\r
  21  */\r
  22 \r
  23 /*\r
  24  * Ensure gmtime_r is available even with -std=c99; must be defined before\r
  25  * config.h, which pulls in glibc's features.h. Harmless on other platforms.\r
  26  */\r
  27 #if !defined(_POSIX_C_SOURCE)\r
  28 #define _POSIX_C_SOURCE 200112L\r
  29 #endif\r
  30 \r
  31 #if !defined(MBEDTLS_CONFIG_FILE)\r
  32 #include "mbedtls/config.h"\r
  33 #else\r
  34 #include MBEDTLS_CONFIG_FILE\r
  35 #endif\r
  36 \r
  37 #include "mbedtls/platform_util.h"\r
  38 #include "mbedtls/platform.h"\r
  39 #include "mbedtls/threading.h"\r
  40 \r
  41 #include <stddef.h>\r
  42 #include <string.h>\r
  43 \r
  44 #if !defined(MBEDTLS_PLATFORM_ZEROIZE_ALT)\r
  45 /*\r
  46  * This implementation should never be optimized out by the compiler\r
  47  *\r
  48  * This implementation for mbedtls_platform_zeroize() was inspired from Colin\r
  49  * Percival's blog article at:\r
  50  *\r
  51  * http://www.daemonology.net/blog/2014-09-04-how-to-zero-a-buffer.html\r
  52  *\r
  53  * It uses a volatile function pointer to the standard memset(). Because the\r
  54  * pointer is volatile the compiler expects it to change at\r
  55  * any time and will not optimize out the call that could potentially perform\r
  56  * other operations on the input buffer instead of just setting it to 0.\r
  57  * Nevertheless, as pointed out by davidtgoldblatt on Hacker News\r
  58  * (refer to http://www.daemonology.net/blog/2014-09-05-erratum.html for\r
  59  * details), optimizations of the following form are still possible:\r
  60  *\r
  61  * if( memset_func != memset )\r
  62  *     memset_func( buf, 0, len );\r
  63  *\r
  64  * Note that it is extremely difficult to guarantee that\r
  65  * mbedtls_platform_zeroize() will not be optimized out by aggressive compilers\r
  66  * in a portable way. For this reason, Mbed TLS also provides the configuration\r
  67  * option MBEDTLS_PLATFORM_ZEROIZE_ALT, which allows users to configure\r
  68  * mbedtls_platform_zeroize() to use a suitable implementation for their\r
  69  * platform and needs.\r
  70  */\r
  71 static void * (* const volatile memset_func)( void *, int, size_t ) = memset;\r
  72 \r
  73 void mbedtls_platform_zeroize( void *buf, size_t len )\r
  74 {\r
  75     memset_func( buf, 0, len );\r
  76 }\r
  77 #endif /* MBEDTLS_PLATFORM_ZEROIZE_ALT */\r
  78 \r
  79 #if defined(MBEDTLS_HAVE_TIME_DATE) && !defined(MBEDTLS_PLATFORM_GMTIME_R_ALT)\r
  80 #include <time.h>\r
  81 #if !defined(_WIN32) && (defined(unix) || \\r
  82     defined(__unix) || defined(__unix__) || (defined(__APPLE__) && \\r
  83     defined(__MACH__)))\r
  84 #include <unistd.h>\r
  85 #endif /* !_WIN32 && (unix || __unix || __unix__ ||\r
  86         * (__APPLE__ && __MACH__)) */\r
  87 \r
  88 #if !( ( defined(_POSIX_VERSION) && _POSIX_VERSION >= 200809L ) ||     \\r
  89        ( defined(_POSIX_THREAD_SAFE_FUNCTIONS ) &&                     \\r
  90          _POSIX_THREAD_SAFE_FUNCTIONS >= 20112L ) )\r
  91 /*\r
  92  * This is a convenience shorthand macro to avoid checking the long\r
  93  * preprocessor conditions above. Ideally, we could expose this macro in\r
  94  * platform_util.h and simply use it in platform_util.c, threading.c and\r
  95  * threading.h. However, this macro is not part of the Mbed TLS public API, so\r
  96  * we keep it private by only defining it in this file\r
  97  */\r
  98 #if ! ( defined(_WIN32) && !defined(EFIX64) && !defined(EFI32) )\r
  99 #define PLATFORM_UTIL_USE_GMTIME\r
 100 #endif /* ! ( defined(_WIN32) && !defined(EFIX64) && !defined(EFI32) ) */\r
 101 \r
 102 #endif /* !( ( defined(_POSIX_VERSION) && _POSIX_VERSION >= 200809L ) ||     \\r
 103              ( defined(_POSIX_THREAD_SAFE_FUNCTIONS ) &&                     \\r
 104                 _POSIX_THREAD_SAFE_FUNCTIONS >= 20112L ) ) */\r
 105 \r
 106 struct tm *mbedtls_platform_gmtime_r( const mbedtls_time_t *tt,\r
 107                                       struct tm *tm_buf )\r
 108 {\r
 109 #if defined(_WIN32) && !defined(EFIX64) && !defined(EFI32)\r
 110     return( ( gmtime_s( tm_buf, tt ) == 0 ) ? tm_buf : NULL );\r
 111 #elif !defined(PLATFORM_UTIL_USE_GMTIME)\r
 112     return( gmtime_r( tt, tm_buf ) );\r
 113 #else\r
 114     struct tm *lt;\r
 115 \r
 116 #if defined(MBEDTLS_THREADING_C)\r
 117     if( mbedtls_mutex_lock( &mbedtls_threading_gmtime_mutex ) != 0 )\r
 118         return( NULL );\r
 119 #endif /* MBEDTLS_THREADING_C */\r
 120 \r
 121     lt = gmtime( tt );\r
 122 \r
 123     if( lt != NULL )\r
 124     {\r
 125         memcpy( tm_buf, lt, sizeof( struct tm ) );\r
 126     }\r
 127 \r
 128 #if defined(MBEDTLS_THREADING_C)\r
 129     if( mbedtls_mutex_unlock( &mbedtls_threading_gmtime_mutex ) != 0 )\r
 130         return( NULL );\r
 131 #endif /* MBEDTLS_THREADING_C */\r
 132 \r
 133     return( ( lt == NULL ) ? NULL : tm_buf );\r
 134 #endif /* _WIN32 && !EFIX64 && !EFI32 */\r
 135 }\r
 136 #endif /* MBEDTLS_HAVE_TIME_DATE && MBEDTLS_PLATFORM_GMTIME_R_ALT */\r