platform_util.c 4.9 KB

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