Skip to contentSkip to conversation

package/initscripts: refactor S20urandom

PATCH New unixmania at gmail.com 3 participants 3 messages Oct 24, 2019 – Oct 25, 2019

lore
Share & tools
lore
#0 lore raw

PATCH v2 1/1 package/initscripts: refactor S20urandom

From: Carlos Santos <[email protected]>

Adapt the format to the current template, used in other init scripts, but do not use start/stop functions due to peculiarities.

Treat RNG initialization and random seed backup as separate operations.

Read /proc/sys/kernel/random/poolsize to calculate the pool size, as suggestred by the urandom manual page.

Ensure that the random seed file has the correct size to prevent dumping an empty file to /dev/urandom on the first boot.

Save the seed at /var/lib/random-seed as other non-systemd distributions do (e.g. RHEL6), since /etc can be in a red-only rootfs. The Filesystem Hierarchy Standard defines that /var/lib holds persistent data modified by programs as they run.

Users willing to use a different path just need to redefine URANDOM_SEED in /etc/default/urandom instead of rewriting the init script.

---
CC: Matthew Weber <[email protected]>
---
Changes v1->v2
- Convert start and stop function in init_rng and save_random_seed to avoid duplicated code.
- Improve sanity checks
- Keep failing gracefully in read-only rootfs cases, as pointed by Matthew Weber.

---
 package/initscripts/init.d/S20urandom | 98 ++++++++++++++++-----------
 1 file changed, 60 insertions(+), 38 deletions(-)
package/initscripts/init.d/S20urandom +60 -38
index cababe1023..4f6936a200 100644
@@ -1,51 +1,73 @@
 #! /bin/sh
 #
-# urandom	This script saves the random seed between reboots.
-#		It is called from the boot, halt and reboot scripts.
-#
-# Version:	@(#)urandom  1.33  22-Jun-1998  miquels at cistron.nl
+# Preserve the random seed between reboots. See urandom(4).
 #
 
+# Quietly do nothing if /dev/urandom does not exist
 [ -c /dev/urandom ] || exit 0
-#. /etc/default/rcS
 
-case "$1" in
-	start|"")
-		# check for read only file system
-		if ! touch /etc/random-seed 2>/dev/null
-		then
-			echo "read-only file system detected...done"
-			exit
-		fi
-		if [ "$VERBOSE" != no ]
-		then
-			printf "Initializing random number generator... "
+URANDOM_SEED="/var/lib/random-seed"
+
+# shellcheck source=/dev/null
+[ -r "/etc/default/urandom" ] && . "/etc/default/urandom"
+
+if pool_bits=$(cat /proc/sys/kernel/random/poolsize 2> /dev/null); then
+	pool_size=$((pool_bits/8))
+else
+	pool_size=512
+fi
+
+check_file_size() {
+	[ -f "$URANDOM_SEED" ] || return 1
+	# Try to read two blocks but exactly one will be read if the file has
+	# the correct size.
+	size=$(dd if="$URANDOM_SEED" bs="$pool_size" count=2 2> /dev/null | wc -c)
+	test "$size" -eq "$pool_size"
+}
+
+init_rng() {
+	if check_file_size; then
+		printf 'Initializing random number generator: '
+		dd if="$URANDOM_SEED" bs="$pool_size" of=/dev/urandom count=1 2> /dev/null
+		status=$?
+		if [ "$status" -eq 0 ]; then
+			echo "OK"
+		else
+			echo "FAIL"
 		fi
-		# Load and then save 512 bytes,
-		# which is the size of the entropy pool
-		cat /etc/random-seed >/dev/urandom
-		rm -f /etc/random-seed
+		return "$status"
+	fi
+}
+
+save_random_seed() {
+	printf 'Saving random seed: '
+	if touch "$URANDOM_SEED" 2> /dev/null; then
 		umask 077
-		dd if=/dev/urandom of=/etc/random-seed count=1 \
-			>/dev/null 2>&1 || echo "urandom start: failed."
+		dd if=/dev/urandom of="$URANDOM_SEED" bs="$pool_size" count=1 2> /dev/null
+		status=$?
 		umask 022
-		[ "$VERBOSE" != no ] && echo "done."
-		;;
-	stop)
-		if ! touch /etc/random-seed 2>/dev/null
-		then
-			exit
+		if [ "$status" -eq 0 ]; then
+			echo "OK"
+		else
+			echo "FAIL"
 		fi
-		# Carry a random seed from shut-down to start-up;
-		# see documentation in linux/drivers/char/random.c
-		[ "$VERBOSE" != no ] && printf "Saving random seed... "
-		umask 077
-		dd if=/dev/urandom of=/etc/random-seed count=1 \
-			>/dev/null 2>&1 || echo "urandom stop: failed."
-		[ "$VERBOSE" != no ] && echo "done."
-		;;
+	else
+		status=$?
+		echo "SKIP (read-only file system detected)"
+	fi
+	return "$status"
+}
+
+case "$1" in
+	start|restart|reload)
+		# Carry a random seed from start-up to start-up
+		# Load and then save the whole entropy pool
+		init_rng && save_random_seed;;
+	stop)
+		# Carry a random seed from shut-down to start-up
+		# Save the whole entropy pool
+		save_random_seed;;
 	*)
-		echo "Usage: urandom {start|stop}" >&2
+		echo "Usage: $0 {start|stop|restart|reload}"
 		exit 1
-		;;
 esac
Signature · 1 line
2.18.1
#1 lore raw

PATCH v2 1/1 package/initscripts: refactor S20urandom

Carlos,

Quoted 19 lines · On Thu, Oct 24, 2019 at 9:03 AM <[email protected]> wrote:

From: Carlos Santos <[email protected]>

Adapt the format to the current template, used in other init scripts, but do not use start/stop functions due to peculiarities.

Treat RNG initialization and random seed backup as separate operations.

Read /proc/sys/kernel/random/poolsize to calculate the pool size, as suggestred by the urandom manual page.

Ensure that the random seed file has the correct size to prevent dumping an empty file to /dev/urandom on the first boot.

Save the seed at /var/lib/random-seed as other non-systemd distributions do (e.g. RHEL6), since /etc can be in a red-only rootfs. The Filesystem Hierarchy Standard defines that /var/lib holds persistent data modified by programs as they run.

Quoted 4 lines

Users willing to use a different path just need to redefine URANDOM_SEED in /etc/default/urandom instead of rewriting the init script.

Quoted 136 lines

---
CC: Matthew Weber <[email protected]>
---
Changes v1->v2
- Convert start and stop function in init_rng and save_random_seed to avoid duplicated code.
- Improve sanity checks
- Keep failing gracefully in read-only rootfs cases, as pointed by Matthew Weber.

---
 package/initscripts/init.d/S20urandom | 98 ++++++++++++++++-----------
 1 file changed, 60 insertions(+), 38 deletions(-)
package/initscripts/init.d/S20urandom +60 -39
index cababe1023..4f6936a200 100644
@@ -1,51 +1,73 @@
 #! /bin/sh
 #
-# urandom      This script saves the random seed between reboots.
-#              It is called from the boot, halt and reboot scripts.
-#
-# Version:     @(#)urandom  1.33  22-Jun-1998  miquels at cistron.nl
+# Preserve the random seed between reboots. See urandom(4).
 #
 
+# Quietly do nothing if /dev/urandom does not exist
 [ -c /dev/urandom ] || exit 0
-#. /etc/default/rcS
 
-case "$1" in
-       start|"")
-               # check for read only file system
-               if ! touch /etc/random-seed 2>/dev/null
-               then
-                       echo "read-only file system detected...done"
-                       exit
-               fi
-               if [ "$VERBOSE" != no ]
-               then
-                       printf "Initializing random number generator... "
+URANDOM_SEED="/var/lib/random-seed"
+
+# shellcheck source=/dev/null
+[ -r "/etc/default/urandom" ] && . "/etc/default/urandom"
+
+if pool_bits=$(cat /proc/sys/kernel/random/poolsize 2> /dev/null); then
+       pool_size=$((pool_bits/8))
+else
+       pool_size=512
+fi
+
+check_file_size() {
+       [ -f "$URANDOM_SEED" ] || return 1
+       # Try to read two blocks but exactly one will be read if the file has
+       # the correct size.
+       size=$(dd if="$URANDOM_SEED" bs="$pool_size" count=2 2> /dev/null | wc -c)
+       test "$size" -eq "$pool_size"
+}
+
+init_rng() {
+       if check_file_size; then
+               printf 'Initializing random number generator: '
+               dd if="$URANDOM_SEED" bs="$pool_size" of=/dev/urandom count=1 2> /dev/null
+               status=$?
+               if [ "$status" -eq 0 ]; then
+                       echo "OK"
+               else
+                       echo "FAIL"
                fi
-               # Load and then save 512 bytes,
-               # which is the size of the entropy pool
-               cat /etc/random-seed >/dev/urandom
-               rm -f /etc/random-seed
+               return "$status"
+       fi
+}
+
+save_random_seed() {
+       printf 'Saving random seed: '
+       if touch "$URANDOM_SEED" 2> /dev/null; then
                umask 077
-               dd if=/dev/urandom of=/etc/random-seed count=1 \
-                       >/dev/null 2>&1 || echo "urandom start: failed."
+               dd if=/dev/urandom of="$URANDOM_SEED" bs="$pool_size" count=1 2> /dev/null
+               status=$?
                umask 022
-               [ "$VERBOSE" != no ] && echo "done."
-               ;;
-       stop)
-               if ! touch /etc/random-seed 2>/dev/null
-               then
-                       exit
+               if [ "$status" -eq 0 ]; then
+                       echo "OK"
+               else
+                       echo "FAIL"
                fi
-               # Carry a random seed from shut-down to start-up;
-               # see documentation in linux/drivers/char/random.c
-               [ "$VERBOSE" != no ] && printf "Saving random seed... "
-               umask 077
-               dd if=/dev/urandom of=/etc/random-seed count=1 \
-                       >/dev/null 2>&1 || echo "urandom stop: failed."
-               [ "$VERBOSE" != no ] && echo "done."
-               ;;
+       else
+               status=$?
+               echo "SKIP (read-only file system detected)"
+       fi
+       return "$status"
+}
+
+case "$1" in
+       start|restart|reload)
+               # Carry a random seed from start-up to start-up
+               # Load and then save the whole entropy pool
+               init_rng && save_random_seed;;
+       stop)
+               # Carry a random seed from shut-down to start-up
+               # Save the whole entropy pool
+               save_random_seed;;
        *)
-               echo "Usage: urandom {start|stop}" >&2
+               echo "Usage: $0 {start|stop|restart|reload}"
                exit 1
-               ;;
 esac
--

2.18.1

_______________________________________________
buildroot mailing list
buildroot at busybox.net
http://lists.busybox.net/mailman/listinfo/buildroot

#2 lore raw

PATCH v2 1/1 package/initscripts: refactor S20urandom

In reply to unixmania at gmail.com
Quoted 71 lines
Quoted 1 line
Quoted 1 line
Quoted 1 line
Quoted 1 line

"unixmania" == unixmania <[email protected]> writes:

From: Carlos Santos <[email protected]>
Adapt the format to the current template, used in other init scripts, but do not use start/stop functions due to peculiarities.

Treat RNG initialization and random seed backup as separate operations.

Read /proc/sys/kernel/random/poolsize to calculate the pool size, as suggestred by the urandom manual page.

Ensure that the random seed file has the correct size to prevent dumping an empty file to /dev/urandom on the first boot.

Save the seed at /var/lib/random-seed as other non-systemd distributions do (e.g. RHEL6), since /etc can be in a red-only rootfs. The Filesystem Hierarchy Standard defines that /var/lib holds persistent data modified by programs as they run.

Users willing to use a different path just need to redefine URANDOM_SEED in /etc/default/urandom instead of rewriting the init script.

---
CC: Matthew Weber <[email protected]>
---
Changes v1->v2
- Convert start and stop function in init_rng and save_random_seed to avoid duplicated code.
- Improve sanity checks
- Keep failing gracefully in read-only rootfs cases, as pointed by Matthew Weber.

---
 package/initscripts/init.d/S20urandom | 98 ++++++++++++++++-----------
 1 file changed, 60 insertions(+), 38 deletions(-)
package/initscripts/init.d/S20urandom +8 -16
index cababe1023..4f6936a200 100644
@@ -1,51 +1,73 @@
 #! /bin/sh
 #
-# urandom	This script saves the random seed between reboots.
-#		It is called from the boot, halt and reboot scripts.
-#
-# Version:	@(#)urandom  1.33  22-Jun-1998  miquels at cistron.nl
+# Preserve the random seed between reboots. See urandom(4).
 #
 
+# Quietly do nothing if /dev/urandom does not exist
 [ -c /dev/urandom ] || exit 0
-#. /etc/default/rcS
 
-case "$1" in
-	start|"")
-		# check for read only file system
-		if ! touch /etc/random-seed 2>/dev/null
-		then
-			echo "read-only file system detected...done"
-			exit
-		fi
-		if [ "$VERBOSE" != no ]
-		then
-			printf "Initializing random number generator... "
+URANDOM_SEED="/var/lib/random-seed"
+
+# shellcheck source=/dev/null
+[ -r "/etc/default/urandom" ] && . "/etc/default/urandom"
+
+if pool_bits=$(cat /proc/sys/kernel/random/poolsize 2> /dev/null); then

package/initscripts/init.d/S20urandom line 24

Quoted 10 lines
package/initscripts/init.d/S20urandom +10 -0
+	pool_size=$((pool_bits/8))
+else
+	pool_size=512
+fi
+
+check_file_size() {
+	[ -f "$URANDOM_SEED" ] || return 1
+	# Try to read two blocks but exactly one will be read if the file has
+	# the correct size.
+	size=$(dd if="$URANDOM_SEED" bs="$pool_size" count=2 2> /dev/null | wc -c)

That seems like a quite complicated way of checking the size. We indeed do not enable the stat busybox applet by default, but the only reason for doing this over just wc -c < $URANDOM_SEED would be to protect against wasting time reading a huge file.

But OK, it doesn't hurt like this.

package/initscripts/init.d/S20urandom line 48

Quoted 7 lines
package/initscripts/init.d/S20urandom +3 -2
+	if touch "$URANDOM_SEED" 2> /dev/null; then
 		umask 077
-		dd if=/dev/urandom of=/etc/random-seed count=1 \
-			>/dev/null 2>&1 || echo "urandom start: failed."
+		dd if=/dev/urandom of="$URANDOM_SEED" bs="$pool_size" count=1 2> /dev/null
+		status=$?
 		umask 022

It is not so nice to hardcode 022 here, so I changed it to read the previous umask value and restore it.

Committed with that change, thanks.

Signature · 1 line
Bye, Peter Korsgaard