entropy_poll.c 6.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239
  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 "entropy_poll.h"
  28. #include "mbedtls/error.h"
  29. #if defined(MBEDTLS_TIMING_C)
  30. #include "mbedtls/timing.h"
  31. #endif
  32. #include "mbedtls/platform.h"
  33. #if !defined(MBEDTLS_NO_PLATFORM_ENTROPY)
  34. #if !defined(unix) && !defined(__unix__) && !defined(__unix) && \
  35. !defined(__APPLE__) && !defined(_WIN32) && !defined(__QNXNTO__) && \
  36. !defined(__HAIKU__) && !defined(__midipix__)
  37. #error \
  38. "Platform entropy sources only work on Unix and Windows, see MBEDTLS_NO_PLATFORM_ENTROPY in mbedtls_config.h"
  39. #endif
  40. #if defined(_WIN32) && !defined(EFIX64) && !defined(EFI32)
  41. #if !defined(_WIN32_WINNT)
  42. #define _WIN32_WINNT 0x0400
  43. #endif
  44. #include <windows.h>
  45. #include <wincrypt.h>
  46. int mbedtls_platform_entropy_poll(void *data, unsigned char *output, size_t len,
  47. size_t *olen)
  48. {
  49. HCRYPTPROV provider;
  50. ((void) data);
  51. *olen = 0;
  52. if (CryptAcquireContext(&provider, NULL, NULL,
  53. PROV_RSA_FULL, CRYPT_VERIFYCONTEXT) == FALSE) {
  54. return MBEDTLS_ERR_ENTROPY_SOURCE_FAILED;
  55. }
  56. if (CryptGenRandom(provider, (DWORD) len, output) == FALSE) {
  57. CryptReleaseContext(provider, 0);
  58. return MBEDTLS_ERR_ENTROPY_SOURCE_FAILED;
  59. }
  60. CryptReleaseContext(provider, 0);
  61. *olen = len;
  62. return 0;
  63. }
  64. #else /* _WIN32 && !EFIX64 && !EFI32 */
  65. /*
  66. * Test for Linux getrandom() support.
  67. * Since there is no wrapper in the libc yet, use the generic syscall wrapper
  68. * available in GNU libc and compatible libc's (eg uClibc).
  69. */
  70. #if ((defined(__linux__) && defined(__GLIBC__)) || defined(__midipix__))
  71. #include <unistd.h>
  72. #include <sys/syscall.h>
  73. #if defined(SYS_getrandom)
  74. #define HAVE_GETRANDOM
  75. #include <errno.h>
  76. static int getrandom_wrapper(void *buf, size_t buflen, unsigned int flags)
  77. {
  78. /* MemSan cannot understand that the syscall writes to the buffer */
  79. #if defined(__has_feature)
  80. #if __has_feature(memory_sanitizer)
  81. memset(buf, 0, buflen);
  82. #endif
  83. #endif
  84. return syscall(SYS_getrandom, buf, buflen, flags);
  85. }
  86. #endif /* SYS_getrandom */
  87. #endif /* __linux__ || __midipix__ */
  88. #if defined(__FreeBSD__) || defined(__DragonFly__)
  89. #include <sys/param.h>
  90. #if (defined(__FreeBSD__) && __FreeBSD_version >= 1200000) || \
  91. (defined(__DragonFly__) && __DragonFly_version >= 500700)
  92. #include <errno.h>
  93. #include <sys/random.h>
  94. #define HAVE_GETRANDOM
  95. static int getrandom_wrapper(void *buf, size_t buflen, unsigned int flags)
  96. {
  97. return getrandom(buf, buflen, flags);
  98. }
  99. #endif /* (__FreeBSD__ && __FreeBSD_version >= 1200000) ||
  100. (__DragonFly__ && __DragonFly_version >= 500700) */
  101. #endif /* __FreeBSD__ || __DragonFly__ */
  102. /*
  103. * Some BSD systems provide KERN_ARND.
  104. * This is equivalent to reading from /dev/urandom, only it doesn't require an
  105. * open file descriptor, and provides up to 256 bytes per call (basically the
  106. * same as getentropy(), but with a longer history).
  107. *
  108. * Documentation: https://netbsd.gw.com/cgi-bin/man-cgi?sysctl+7
  109. */
  110. #if (defined(__FreeBSD__) || defined(__NetBSD__)) && !defined(HAVE_GETRANDOM)
  111. #include <sys/param.h>
  112. #include <sys/sysctl.h>
  113. #if defined(KERN_ARND)
  114. #define HAVE_SYSCTL_ARND
  115. static int sysctl_arnd_wrapper(unsigned char *buf, size_t buflen)
  116. {
  117. int name[2];
  118. size_t len;
  119. name[0] = CTL_KERN;
  120. name[1] = KERN_ARND;
  121. while (buflen > 0) {
  122. len = buflen > 256 ? 256 : buflen;
  123. if (sysctl(name, 2, buf, &len, NULL, 0) == -1) {
  124. return -1;
  125. }
  126. buflen -= len;
  127. buf += len;
  128. }
  129. return 0;
  130. }
  131. #endif /* KERN_ARND */
  132. #endif /* __FreeBSD__ || __NetBSD__ */
  133. #include <stdio.h>
  134. int mbedtls_platform_entropy_poll(void *data,
  135. unsigned char *output, size_t len, size_t *olen)
  136. {
  137. FILE *file;
  138. size_t read_len;
  139. int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
  140. ((void) data);
  141. #if defined(HAVE_GETRANDOM)
  142. ret = getrandom_wrapper(output, len, 0);
  143. if (ret >= 0) {
  144. *olen = ret;
  145. return 0;
  146. } else if (errno != ENOSYS) {
  147. return MBEDTLS_ERR_ENTROPY_SOURCE_FAILED;
  148. }
  149. /* Fall through if the system call isn't known. */
  150. #else
  151. ((void) ret);
  152. #endif /* HAVE_GETRANDOM */
  153. #if defined(HAVE_SYSCTL_ARND)
  154. ((void) file);
  155. ((void) read_len);
  156. if (sysctl_arnd_wrapper(output, len) == -1) {
  157. return MBEDTLS_ERR_ENTROPY_SOURCE_FAILED;
  158. }
  159. *olen = len;
  160. return 0;
  161. #else
  162. *olen = 0;
  163. file = fopen("/dev/urandom", "rb");
  164. if (file == NULL) {
  165. return MBEDTLS_ERR_ENTROPY_SOURCE_FAILED;
  166. }
  167. /* Ensure no stdio buffering of secrets, as such buffers cannot be wiped. */
  168. mbedtls_setbuf(file, NULL);
  169. read_len = fread(output, 1, len, file);
  170. if (read_len != len) {
  171. fclose(file);
  172. return MBEDTLS_ERR_ENTROPY_SOURCE_FAILED;
  173. }
  174. fclose(file);
  175. *olen = len;
  176. return 0;
  177. #endif /* HAVE_SYSCTL_ARND */
  178. }
  179. #endif /* _WIN32 && !EFIX64 && !EFI32 */
  180. #endif /* !MBEDTLS_NO_PLATFORM_ENTROPY */
  181. #if defined(MBEDTLS_ENTROPY_NV_SEED)
  182. int mbedtls_nv_seed_poll(void *data,
  183. unsigned char *output, size_t len, size_t *olen)
  184. {
  185. unsigned char buf[MBEDTLS_ENTROPY_BLOCK_SIZE];
  186. size_t use_len = MBEDTLS_ENTROPY_BLOCK_SIZE;
  187. ((void) data);
  188. memset(buf, 0, MBEDTLS_ENTROPY_BLOCK_SIZE);
  189. if (mbedtls_nv_seed_read(buf, MBEDTLS_ENTROPY_BLOCK_SIZE) < 0) {
  190. return MBEDTLS_ERR_ENTROPY_SOURCE_FAILED;
  191. }
  192. if (len < use_len) {
  193. use_len = len;
  194. }
  195. memcpy(output, buf, use_len);
  196. *olen = use_len;
  197. return 0;
  198. }
  199. #endif /* MBEDTLS_ENTROPY_NV_SEED */
  200. #endif /* MBEDTLS_ENTROPY_C */