entropy_poll.c 7.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291
  1. /*
  2. * Platform-specific and custom entropy polling functions
  3. *
  4. * Copyright The Mbed TLS Contributors
  5. * SPDX-License-Identifier: Apache-2.0
  6. *
  7. * Licensed under the Apache License, Version 2.0 (the "License"); you may
  8. * not use this file except in compliance with the License.
  9. * You may obtain a copy of the License at
  10. *
  11. * http://www.apache.org/licenses/LICENSE-2.0
  12. *
  13. * Unless required by applicable law or agreed to in writing, software
  14. * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
  15. * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  16. * See the License for the specific language governing permissions and
  17. * limitations under the License.
  18. */
  19. #if defined(__linux__) && !defined(_GNU_SOURCE)
  20. /* Ensure that syscall() is available even when compiling with -std=c99 */
  21. #define _GNU_SOURCE
  22. #endif
  23. #include "common.h"
  24. #include <string.h>
  25. #if defined(MBEDTLS_ENTROPY_C)
  26. #include "mbedtls/entropy.h"
  27. #include "mbedtls/entropy_poll.h"
  28. #include "mbedtls/error.h"
  29. #if defined(MBEDTLS_TIMING_C)
  30. #include "mbedtls/timing.h"
  31. #endif
  32. #if defined(MBEDTLS_HAVEGE_C)
  33. #include "mbedtls/havege.h"
  34. #endif
  35. #if defined(MBEDTLS_ENTROPY_NV_SEED)
  36. #include "mbedtls/platform.h"
  37. #endif
  38. #if !defined(MBEDTLS_NO_PLATFORM_ENTROPY)
  39. #if !defined(unix) && !defined(__unix__) && !defined(__unix) && \
  40. !defined(__APPLE__) && !defined(_WIN32) && !defined(__QNXNTO__) && \
  41. !defined(__HAIKU__) && !defined(__midipix__)
  42. #error "Platform entropy sources only work on Unix and Windows, see MBEDTLS_NO_PLATFORM_ENTROPY in config.h"
  43. #endif
  44. #if defined(_WIN32) && !defined(EFIX64) && !defined(EFI32)
  45. #if !defined(_WIN32_WINNT)
  46. #define _WIN32_WINNT 0x0400
  47. #endif
  48. #include <windows.h>
  49. #include <wincrypt.h>
  50. int mbedtls_platform_entropy_poll( void *data, unsigned char *output, size_t len,
  51. size_t *olen )
  52. {
  53. HCRYPTPROV provider;
  54. ((void) data);
  55. *olen = 0;
  56. if( CryptAcquireContext( &provider, NULL, NULL,
  57. PROV_RSA_FULL, CRYPT_VERIFYCONTEXT ) == FALSE )
  58. {
  59. return( MBEDTLS_ERR_ENTROPY_SOURCE_FAILED );
  60. }
  61. if( CryptGenRandom( provider, (DWORD) len, output ) == FALSE )
  62. {
  63. CryptReleaseContext( provider, 0 );
  64. return( MBEDTLS_ERR_ENTROPY_SOURCE_FAILED );
  65. }
  66. CryptReleaseContext( provider, 0 );
  67. *olen = len;
  68. return( 0 );
  69. }
  70. #else /* _WIN32 && !EFIX64 && !EFI32 */
  71. /*
  72. * Test for Linux getrandom() support.
  73. * Since there is no wrapper in the libc yet, use the generic syscall wrapper
  74. * available in GNU libc and compatible libc's (eg uClibc).
  75. */
  76. #if ((defined(__linux__) && defined(__GLIBC__)) || defined(__midipix__))
  77. #include <unistd.h>
  78. #include <sys/syscall.h>
  79. #if defined(SYS_getrandom)
  80. #define HAVE_GETRANDOM
  81. #include <errno.h>
  82. static int getrandom_wrapper( void *buf, size_t buflen, unsigned int flags )
  83. {
  84. /* MemSan cannot understand that the syscall writes to the buffer */
  85. #if defined(__has_feature)
  86. #if __has_feature(memory_sanitizer)
  87. memset( buf, 0, buflen );
  88. #endif
  89. #endif
  90. return( syscall( SYS_getrandom, buf, buflen, flags ) );
  91. }
  92. #endif /* SYS_getrandom */
  93. #endif /* __linux__ || __midipix__ */
  94. #if defined(__FreeBSD__) || defined(__DragonFly__)
  95. #include <sys/param.h>
  96. #if (defined(__FreeBSD__) && __FreeBSD_version >= 1200000) || \
  97. (defined(__DragonFly__) && __DragonFly_version >= 500700)
  98. #include <errno.h>
  99. #include <sys/random.h>
  100. #define HAVE_GETRANDOM
  101. static int getrandom_wrapper( void *buf, size_t buflen, unsigned int flags )
  102. {
  103. return getrandom( buf, buflen, flags );
  104. }
  105. #endif /* (__FreeBSD__ && __FreeBSD_version >= 1200000) ||
  106. (__DragonFly__ && __DragonFly_version >= 500700) */
  107. #endif /* __FreeBSD__ || __DragonFly__ */
  108. /*
  109. * Some BSD systems provide KERN_ARND.
  110. * This is equivalent to reading from /dev/urandom, only it doesn't require an
  111. * open file descriptor, and provides up to 256 bytes per call (basically the
  112. * same as getentropy(), but with a longer history).
  113. *
  114. * Documentation: https://netbsd.gw.com/cgi-bin/man-cgi?sysctl+7
  115. */
  116. #if (defined(__FreeBSD__) || defined(__NetBSD__)) && !defined(HAVE_GETRANDOM)
  117. #include <sys/param.h>
  118. #include <sys/sysctl.h>
  119. #if defined(KERN_ARND)
  120. #define HAVE_SYSCTL_ARND
  121. static int sysctl_arnd_wrapper( unsigned char *buf, size_t buflen )
  122. {
  123. int name[2];
  124. size_t len;
  125. name[0] = CTL_KERN;
  126. name[1] = KERN_ARND;
  127. while( buflen > 0 )
  128. {
  129. len = buflen > 256 ? 256 : buflen;
  130. if( sysctl(name, 2, buf, &len, NULL, 0) == -1 )
  131. return( -1 );
  132. buflen -= len;
  133. buf += len;
  134. }
  135. return( 0 );
  136. }
  137. #endif /* KERN_ARND */
  138. #endif /* __FreeBSD__ || __NetBSD__ */
  139. #include <stdio.h>
  140. int mbedtls_platform_entropy_poll( void *data,
  141. unsigned char *output, size_t len, size_t *olen )
  142. {
  143. FILE *file;
  144. size_t read_len;
  145. int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
  146. ((void) data);
  147. #if defined(HAVE_GETRANDOM)
  148. ret = getrandom_wrapper( output, len, 0 );
  149. if( ret >= 0 )
  150. {
  151. *olen = ret;
  152. return( 0 );
  153. }
  154. else if( errno != ENOSYS )
  155. return( MBEDTLS_ERR_ENTROPY_SOURCE_FAILED );
  156. /* Fall through if the system call isn't known. */
  157. #else
  158. ((void) ret);
  159. #endif /* HAVE_GETRANDOM */
  160. #if defined(HAVE_SYSCTL_ARND)
  161. ((void) file);
  162. ((void) read_len);
  163. if( sysctl_arnd_wrapper( output, len ) == -1 )
  164. return( MBEDTLS_ERR_ENTROPY_SOURCE_FAILED );
  165. *olen = len;
  166. return( 0 );
  167. #else
  168. *olen = 0;
  169. file = fopen( "/dev/urandom", "rb" );
  170. if( file == NULL )
  171. return( MBEDTLS_ERR_ENTROPY_SOURCE_FAILED );
  172. read_len = fread( output, 1, len, file );
  173. if( read_len != len )
  174. {
  175. fclose( file );
  176. return( MBEDTLS_ERR_ENTROPY_SOURCE_FAILED );
  177. }
  178. fclose( file );
  179. *olen = len;
  180. return( 0 );
  181. #endif /* HAVE_SYSCTL_ARND */
  182. }
  183. #endif /* _WIN32 && !EFIX64 && !EFI32 */
  184. #endif /* !MBEDTLS_NO_PLATFORM_ENTROPY */
  185. #if defined(MBEDTLS_TEST_NULL_ENTROPY)
  186. int mbedtls_null_entropy_poll( void *data,
  187. unsigned char *output, size_t len, size_t *olen )
  188. {
  189. ((void) data);
  190. ((void) output);
  191. *olen = 0;
  192. if( len < sizeof(unsigned char) )
  193. return( 0 );
  194. output[0] = 0;
  195. *olen = sizeof(unsigned char);
  196. return( 0 );
  197. }
  198. #endif
  199. #if defined(MBEDTLS_TIMING_C)
  200. int mbedtls_hardclock_poll( void *data,
  201. unsigned char *output, size_t len, size_t *olen )
  202. {
  203. unsigned long timer = mbedtls_timing_hardclock();
  204. ((void) data);
  205. *olen = 0;
  206. if( len < sizeof(unsigned long) )
  207. return( 0 );
  208. memcpy( output, &timer, sizeof(unsigned long) );
  209. *olen = sizeof(unsigned long);
  210. return( 0 );
  211. }
  212. #endif /* MBEDTLS_TIMING_C */
  213. #if defined(MBEDTLS_HAVEGE_C)
  214. int mbedtls_havege_poll( void *data,
  215. unsigned char *output, size_t len, size_t *olen )
  216. {
  217. mbedtls_havege_state *hs = (mbedtls_havege_state *) data;
  218. *olen = 0;
  219. if( mbedtls_havege_random( hs, output, len ) != 0 )
  220. return( MBEDTLS_ERR_ENTROPY_SOURCE_FAILED );
  221. *olen = len;
  222. return( 0 );
  223. }
  224. #endif /* MBEDTLS_HAVEGE_C */
  225. #if defined(MBEDTLS_ENTROPY_NV_SEED)
  226. int mbedtls_nv_seed_poll( void *data,
  227. unsigned char *output, size_t len, size_t *olen )
  228. {
  229. unsigned char buf[MBEDTLS_ENTROPY_BLOCK_SIZE];
  230. size_t use_len = MBEDTLS_ENTROPY_BLOCK_SIZE;
  231. ((void) data);
  232. memset( buf, 0, MBEDTLS_ENTROPY_BLOCK_SIZE );
  233. if( mbedtls_nv_seed_read( buf, MBEDTLS_ENTROPY_BLOCK_SIZE ) < 0 )
  234. return( MBEDTLS_ERR_ENTROPY_SOURCE_FAILED );
  235. if( len < use_len )
  236. use_len = len;
  237. memcpy( output, buf, use_len );
  238. *olen = use_len;
  239. return( 0 );
  240. }
  241. #endif /* MBEDTLS_ENTROPY_NV_SEED */
  242. #endif /* MBEDTLS_ENTROPY_C */