libc: Refine the arc4random_buf implementation

fill the buffer with getrandom instead random pool
and move the implementation to from crypto to libc

Signed-off-by: Xiang Xiao <xiaoxiang@xiaomi.com>

crypto/random_pool.c

@@ -508,15 +508,10 @@ void up_randompool_initialize(void)
 }
 
 /****************************************************************************
- * Name: arc4random_buf
+ * Name: up_rngbuf
  *
  * Description:
- *   Fill a buffer of arbitrary length with randomness. This is the
- *   preferred interface for getting random numbers. The traditional
- *   /dev/random approach is susceptible for things like the attacker
- *   exhausting file descriptors on purpose.
- *
- *   Note that this function cannot fail, other than by asserting.
+ *   Fill a buffer of arbitrary length with randomness.
  *
  * Input Parameters:
  *   bytes  - Buffer for returned random bytes
@@ -527,33 +522,9 @@ void up_randompool_initialize(void)
  *
  ****************************************************************************/
 
-void arc4random_buf(FAR void *bytes, size_t nbytes)
+void up_rngbuf(FAR void *bytes, size_t nbytes)
 {
   nxmutex_lock(&g_rng.rd_lock);
   rng_buf_internal(bytes, nbytes);
   nxmutex_unlock(&g_rng.rd_lock);
 }
-
-/****************************************************************************
- * Name: arc4random
- *
- * Description:
- *   Returns a single 32-bit value. This is the preferred interface for
- *   getting random numbers. The traditional /dev/random approach is
- *   susceptible for things like the attacker exhausting file
- *   descriptors on purpose.
- *
- *   Note that this function cannot fail, other than by asserting.
- *
- * Returned Value:
- *   a random 32-bit value.
- *
- ****************************************************************************/
-
-uint32_t arc4random(void)
-{
-  uint32_t ret;
-
-  arc4random_buf(&ret, sizeof(ret));
-  return ret;
-}

drivers/crypto/dev_urandom.c

@@ -148,9 +148,8 @@ static ssize_t devurand_read(FAR struct file *filep, FAR char *buffer,
 #ifdef CONFIG_DEV_URANDOM_RANDOM_POOL
   if (len > 0)
     {
-      arc4random_buf(buffer, len);
+      up_rngbuf(buffer, len);
     }
-
 #else
   size_t n;
   uint32_t rnd;

drivers/vhost/vhost-rng.c

@@ -25,7 +25,7 @@
 #include <debug.h>
 #include <errno.h>
 #include <stdio.h>
-#include <sys/random.h>
+#include <stdlib.h>
 
 #include <nuttx/kmalloc.h>
 #include <nuttx/vhost/vhost.h>
@@ -99,12 +99,7 @@ static void vhost_rng_work(FAR void *arg)
         }
 
       spin_unlock_irqrestore(&priv->lock, flags);
-      ret = getrandom(buf, len, 0);
-      if (ret < 0)
-        {
-          vhosterr("getrandom failed, ret=%zd\n", ret);
-          ret = 0;
-        }
+      arc4random_buf(buf, len);
 
       flags = spin_lock_irqsave(&priv->lock);
       virtqueue_add_consumed_buffer(vq, idx, (uint32_t)ret);

include/nuttx/random.h

@@ -131,6 +131,16 @@ void up_rngaddint(enum rnd_source_t kindof, int val);
 void up_rngaddentropy(enum rnd_source_t kindof, FAR const uint32_t *buf,
                       size_t n);
 
+/****************************************************************************
+ * Name: up_rngbuf
+ *
+ * Description:
+ *   Fill a buffer of arbitrary length with randomness.
+ *
+ ****************************************************************************/
+
+void up_rngbuf(FAR void *bytes, size_t nbytes);
+
 /****************************************************************************
  * Name: up_rngreseed
  *

include/stdlib.h

@@ -152,10 +152,8 @@ double    erand48(FAR unsigned short int xsubi[3]);
 #define   srandom(s) srand(s)
 long      random(void);
 
-#ifdef CONFIG_CRYPTO_RANDOM_POOL
 void      arc4random_buf(FAR void *bytes, size_t nbytes);
 uint32_t  arc4random(void);
-#endif
 
 /* Environment variable support */
 

include/sys/syscall_lookup.h

@@ -384,14 +384,6 @@ SYSCALL_LOOKUP(munmap,                     2)
   SYSCALL_LOOKUP(socketpair,               4)
 #endif
 
-/* The following is defined only if entropy pool random number generator
- * is enabled.
- */
-
-#ifdef CONFIG_CRYPTO_RANDOM_POOL
-  SYSCALL_LOOKUP(arc4random_buf,           2)
-#endif
-
 SYSCALL_LOOKUP(nanosleep,                  2)
 
 /* I/O event notification facility */

libs/libc/libc.csv

@@ -14,6 +14,8 @@
 "aio_suspend","aio.h","defined(CONFIG_FS_AIO)","int","FAR const struct aiocb * const []|FAR const struct aiocb * const *","int","FAR const struct timespec *"
 "alarm","unistd.h","!defined(CONFIG_DISABLE_POSIX_TIMERS)","unsigned int","unsigned int"
 "alphasort","dirent.h","","int","FAR const struct dirent **","FAR const struct dirent **"
+"arc4random","stdlib.h","","uint32_t"
+"arc4random_buf","stdlib.h","","void","FAR void *","size_t"
 "asprintf","stdio.h","","int","FAR char **","FAR const IPTR char *","..."
 "atof","stdlib.h","defined(CONFIG_HAVE_DOUBLE)","double","FAR const char *"
 "atoi","stdlib.h","","int","FAR const char *"

libs/libc/stdlib/CMakeLists.txt

@@ -61,6 +61,7 @@ set(SRCS
     lib_wctomb.c
     lib_mbstowcs.c
     lib_wcstombs.c
+    lib_arc4random.c
     lib_atexit.c)
 
 if(CONFIG_PSEUDOTERM)

libs/libc/stdlib/Make.defs

@@ -30,7 +30,7 @@ CSRCS += lib_strtoll.c lib_strtoul.c lib_strtoull.c lib_strtold.c
 CSRCS += lib_checkbase.c lib_mktemp.c lib_mkstemp.c lib_mkdtemp.c
 CSRCS += lib_aligned_alloc.c lib_posix_memalign.c lib_valloc.c lib_mblen.c
 CSRCS += lib_mbtowc.c lib_wctomb.c lib_mbstowcs.c lib_wcstombs.c lib_atexit.c
-CSRCS += lib_reallocarray.c
+CSRCS += lib_reallocarray.c lib_arc4random.c
 
 ifeq ($(CONFIG_PSEUDOTERM),y)
 CSRCS += lib_ptsname.c lib_ptsnamer.c lib_unlockpt.c lib_openpty.c

libs/libc/stdlib/lib_arc4random.c

@@ -1,5 +1,5 @@
 /****************************************************************************
- * net/utils/net_getrandom.c
+ * libs/libc/stdlib/lib_arc4random.c
  *
  * SPDX-License-Identifier: Apache-2.0
  *
@@ -24,9 +24,9 @@
  * Included Files
  ****************************************************************************/
 
-#include <nuttx/config.h>
-
+#include <errno.h>
 #include <stdint.h>
+#include <stdlib.h>
 #include <string.h>
 #include <sys/param.h>
 #include <sys/random.h>
@@ -34,34 +34,69 @@
 #include <nuttx/clock.h>
 #include <nuttx/hashtable.h>
 
+/****************************************************************************
+ * Private Functions
+ ****************************************************************************/
+
+#if defined(CONFIG_DEV_URANDOM) || defined(CONFIG_DEV_RANDOM)
+static int getrandom_all(FAR void *buf, size_t size, int flags)
+{
+  FAR char *tmp = buf;
+
+  while (size > 0)
+    {
+      ssize_t ret = getrandom(tmp, size, flags);
+      if (ret < 0)
+        {
+          if (get_errno() == EINTR)
+            {
+              continue;
+            }
+
+          return ret;
+        }
+
+      tmp += ret;
+      size -= ret;
+    }
+
+  return 0;
+}
+#endif
+
 /****************************************************************************
  * Public Functions
  ****************************************************************************/
 
 /****************************************************************************
- * Name: net_getrandom
+ * Name: arc4random_buf
  *
  * Description:
- *   Fill a buffer of arbitrary length with randomness. This function is
- *   guaranteed to be success.
+ *   Fill a buffer of arbitrary length with randomness. This is the
+ *   preferred interface for getting random numbers. The traditional
+ *   /dev/random approach is susceptible for things like the attacker
+ *   exhausting file descriptors on purpose.
+ *
+ *   Note that this function cannot fail, other than by asserting.
  *
  * Input Parameters:
  *   bytes  - Buffer for returned random bytes
  *   nbytes - Number of bytes requested.
  *
+ * Returned Value:
+ *   None
+ *
  ****************************************************************************/
 
-void net_getrandom(FAR void *bytes, size_t nbytes)
+void arc4random_buf(FAR void *bytes, size_t nbytes)
 {
 #if defined(CONFIG_DEV_URANDOM) || defined(CONFIG_DEV_RANDOM)
-  ssize_t ret = getrandom(bytes, nbytes, 0);
-
-  if (ret < 0)
+  if (getrandom_all(bytes, nbytes, GRND_RANDOM) >= 0)
     {
-      ret = getrandom(bytes, nbytes, GRND_RANDOM);
+      return;
     }
 
-  if (ret == nbytes)
+  if (getrandom_all(bytes, nbytes, 0) >= 0)
     {
       return;
     }
@@ -82,3 +117,27 @@ void net_getrandom(FAR void *bytes, size_t nbytes)
       bytes   = (FAR uint8_t *)bytes + ncopy;
     }
 }
+
+/****************************************************************************
+ * Name: arc4random
+ *
+ * Description:
+ *   Returns a single 32-bit value. This is the preferred interface for
+ *   getting random numbers. The traditional /dev/random approach is
+ *   susceptible for things like the attacker exhausting file
+ *   descriptors on purpose.
+ *
+ *   Note that this function cannot fail, other than by asserting.
+ *
+ * Returned Value:
+ *   a random 32-bit value.
+ *
+ ****************************************************************************/
+
+uint32_t arc4random(void)
+{
+  uint32_t ret;
+
+  arc4random_buf(&ret, sizeof(ret));
+  return ret;
+}

libs/libc/unistd/lib_getentropy.c

@@ -24,8 +24,8 @@
  * Included Files
  ****************************************************************************/
 
-#include <sys/random.h>
 #include <errno.h>
+#include <stdlib.h>
 #include <unistd.h>
 
 /****************************************************************************
@@ -56,30 +56,12 @@
 
 int getentropy(FAR void *buffer, size_t length)
 {
-  FAR char *pos = buffer;
-
   if (length > 256)
     {
       set_errno(EIO);
       return -1;
     }
 
-  while (length > 0)
-    {
-      int ret = getrandom(pos, length, 0);
-      if (ret < 0)
-        {
-          if (get_errno() == EINTR)
-            {
-              continue;
-            }
-
-          return ret;
-        }
-
-      pos += ret;
-      length -= ret;
-    }
-
+  arc4random_buf(buffer, length);
   return 0;
 }

libs/libc/uuid/lib_uuid_create.c

@@ -24,39 +24,10 @@
  * Included Files
  ****************************************************************************/
 
-#include <sys/random.h>
 #include <errno.h>
 #include <stdlib.h>
 #include <uuid.h>
 
-/****************************************************************************
- * Private Functions
- ****************************************************************************/
-
-static int uuid_getrandom(FAR void *buf, size_t size, int flags)
-{
-  FAR char *tmp = buf;
-
-  while (size > 0)
-    {
-      ssize_t ret = getrandom(tmp, size, flags);
-      if (ret < 0)
-        {
-          if (get_errno() == EINTR)
-            {
-              continue;
-            }
-
-          return ret;
-        }
-
-      tmp += ret;
-      size -= ret;
-    }
-
-  return 0;
-}
-
 /****************************************************************************
  * Public Functions
  ****************************************************************************/
@@ -74,24 +45,7 @@ static int uuid_getrandom(FAR void *buf, size_t size, int flags)
 
 void uuid_create(FAR uuid_t *u, FAR uint32_t *status)
 {
-  int ret;
-
-  ret = uuid_getrandom(u, sizeof(uuid_t), GRND_RANDOM);
-  if (ret < 0)
-    {
-      ret = uuid_getrandom(u, sizeof(uuid_t), 0);
-    }
-
-  if (ret < 0)
-    {
-      FAR unsigned long *beg = (FAR unsigned long *)u;
-      FAR unsigned long *end = (FAR unsigned long *)(u + 1);
-
-      while (beg < end)
-        {
-          *beg++ = rand();
-        }
-    }
+  arc4random_buf(u, sizeof(uuid_t));
 
   u->clock_seq_hi_and_reserved &= ~(1 << 6);
   u->clock_seq_hi_and_reserved |= (1 << 7);

net/tcp/tcp_seqno.c

@@ -48,6 +48,7 @@
 #include <crypto/md5.h>
 #include <debug.h>
 #include <stdint.h>
+#include <stdlib.h>
 
 #include <nuttx/clock.h>
 #include <nuttx/net/netconfig.h>
@@ -55,7 +56,6 @@
 
 #include "devif/devif.h"
 #include "tcp/tcp.h"
-#include "utils/utils.h"
 
 /****************************************************************************
  * Private Data
@@ -97,7 +97,7 @@ static uint32_t tcp_isn_rfc6528(FAR struct tcp_conn_s *conn)
 
   if (g_tcp_isnkey[0] == 0)
     {
-      net_getrandom(g_tcp_isnkey, sizeof(g_tcp_isnkey));
+      arc4random_buf(g_tcp_isnkey, sizeof(g_tcp_isnkey));
     }
 
   /* M is the 4 microsecond timer */
@@ -216,7 +216,7 @@ void tcp_initsequence(FAR struct tcp_conn_s *conn)
     {
       /* Get a random TCP sequence number */
 
-      net_getrandom(&g_tcpsequence, sizeof(uint32_t));
+      arc4random_buf(&g_tcpsequence, sizeof(uint32_t));
 
       /* Use about half of allowed values */
 

net/utils/CMakeLists.txt

@@ -33,7 +33,6 @@ set(SRCS
     net_snoop.c
     net_cmsg.c
     net_iob_concat.c
-    net_getrandom.c
     net_mask2pref.c)
 
 # IPv6 utilities

net/utils/Make.defs

@@ -23,8 +23,8 @@
 # Common utilities
 
 NET_CSRCS += net_dsec2tick.c net_dsec2timeval.c net_timeval2dsec.c
-NET_CSRCS += net_chksum.c net_ipchksum.c net_incr32.c net_lock.c net_snoop.c
-NET_CSRCS += net_cmsg.c net_iob_concat.c net_getrandom.c net_mask2pref.c
+NET_CSRCS += net_chksum.c net_ipchksum.c net_incr32.c net_lock.c
+NET_CSRCS += net_snoop.c net_cmsg.c net_iob_concat.c net_mask2pref.c
 
 # IPv6 utilities
 

net/utils/utils.h

@@ -28,6 +28,9 @@
  ****************************************************************************/
 
 #include <nuttx/config.h>
+
+#include <stdlib.h>
+
 #include <nuttx/net/net.h>
 #include <nuttx/net/ip.h>
 #include <nuttx/net/netdev.h>
@@ -41,7 +44,7 @@
 #define NET_PORT_RANDOM_INIT(port) \
   do \
     { \
-      net_getrandom(&(port), sizeof(port)); \
+      arc4random_buf(&(port), sizeof(port)); \
       (port) = (port) % (CONFIG_NET_DEFAULT_MAX_PORT - \
                          CONFIG_NET_DEFAULT_MIN_PORT + 1); \
       (port) += CONFIG_NET_DEFAULT_MIN_PORT; \
@@ -187,21 +190,6 @@ unsigned int net_dsec2tick(int dsec);
 unsigned int net_timeval2dsec(FAR struct timeval *tv,
                               enum tv2ds_remainder_e remainder);
 
-/****************************************************************************
- * Name: net_getrandom
- *
- * Description:
- *   Fill a buffer of arbitrary length with randomness. This function is
- *   guaranteed to be success.
- *
- * Input Parameters:
- *   bytes  - Buffer for returned random bytes
- *   nbytes - Number of bytes requested.
- *
- ****************************************************************************/
-
-void net_getrandom(FAR void *bytes, size_t nbytes);
-
 /****************************************************************************
  * Name: net_ipv4_mask2pref
  *

syscall/syscall.csv

@@ -6,7 +6,6 @@
 "aio_fsync","aio.h","defined(CONFIG_FS_AIO)","int","int","FAR struct aiocb *"
 "aio_read","aio.h","defined(CONFIG_FS_AIO)","int","FAR struct aiocb *"
 "aio_write","aio.h","defined(CONFIG_FS_AIO)","int","FAR struct aiocb *"
-"arc4random_buf","stdlib.h","defined(CONFIG_CRYPTO_RANDOM_POOL)","void","FAR void *","size_t"
 "bind","sys/socket.h","defined(CONFIG_NET)","int","int","FAR const struct sockaddr *","socklen_t"
 "boardctl","sys/boardctl.h","defined(CONFIG_BOARDCTL)","int","unsigned int","uintptr_t"
 "chmod","sys/stat.h","","int","FAR const char *","mode_t"