2001-01-11 13:01:20 +00:00
|
|
|
#!/bin/sh
|
|
|
|
#
|
2023-05-10 15:40:58 +00:00
|
|
|
# SPDX-License-Identifier: BSD-2-Clause
|
2017-11-27 15:25:02 +00:00
|
|
|
#
|
2012-09-04 16:00:51 +00:00
|
|
|
# Copyright (c) 2001-2006,2012 Douglas Barton, dougb@FreeBSD.org
|
2001-01-11 13:01:20 +00:00
|
|
|
# All rights reserved.
|
|
|
|
#
|
|
|
|
# Redistribution and use in source and binary forms, with or without
|
|
|
|
# modification, are permitted provided that the following conditions
|
|
|
|
# are met:
|
|
|
|
# 1. Redistributions of source code must retain the above copyright
|
|
|
|
# notice, this list of conditions and the following disclaimer.
|
|
|
|
# 2. Redistributions in binary form must reproduce the above copyright
|
|
|
|
# notice, this list of conditions and the following disclaimer in the
|
|
|
|
# documentation and/or other materials provided with the distribution.
|
|
|
|
#
|
|
|
|
# THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
|
|
|
|
# ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
|
|
|
|
# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
|
|
|
|
# ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
|
|
|
|
# FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
|
|
|
|
# DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
|
|
|
|
# OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
|
|
|
|
# HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
|
|
|
|
# LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
|
|
|
|
# OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
|
|
|
|
# SUCH DAMAGE.
|
|
|
|
#
|
|
|
|
|
|
|
|
# This script is called by cron to store bits of randomness which are
|
|
|
|
# then used to seed /dev/random on boot.
|
|
|
|
|
2012-09-04 16:00:51 +00:00
|
|
|
# Originally developed by Doug Barton, dougb@FreeBSD.org
|
2001-01-14 07:18:31 +00:00
|
|
|
|
2001-01-11 13:01:20 +00:00
|
|
|
PATH=/bin:/usr/bin
|
|
|
|
|
|
|
|
# If there is a global system configuration file, suck it in.
|
|
|
|
#
|
|
|
|
if [ -r /etc/defaults/rc.conf ]; then
|
|
|
|
. /etc/defaults/rc.conf
|
2006-08-28 06:41:50 +00:00
|
|
|
source_rc_confs 2>/dev/null
|
2001-01-11 13:01:20 +00:00
|
|
|
elif [ -r /etc/rc.conf ]; then
|
2006-08-28 06:41:50 +00:00
|
|
|
. /etc/rc.conf 2>/dev/null
|
2001-01-11 13:01:20 +00:00
|
|
|
fi
|
|
|
|
|
2014-07-22 06:40:27 +00:00
|
|
|
[ $(/sbin/sysctl -n security.jail.jailed) = 0 ] || exit 0
|
|
|
|
|
2001-01-11 13:01:20 +00:00
|
|
|
case ${entropy_dir} in
|
|
|
|
[Nn][Oo])
|
|
|
|
exit 0
|
|
|
|
;;
|
|
|
|
*)
|
2001-01-14 07:18:31 +00:00
|
|
|
entropy_dir=${entropy_dir:-/var/db/entropy}
|
2001-01-11 13:01:20 +00:00
|
|
|
;;
|
|
|
|
esac
|
|
|
|
|
This is the much-discussed major upgrade to the random(4) device, known to you all as /dev/random.
This code has had an extensive rewrite and a good series of reviews, both by the author and other parties. This means a lot of code has been simplified. Pluggable structures for high-rate entropy generators are available, and it is most definitely not the case that /dev/random can be driven by only a hardware souce any more. This has been designed out of the device. Hardware sources are stirred into the CSPRNG (Yarrow, Fortuna) like any other entropy source. Pluggable modules may be written by third parties for additional sources.
The harvesting structures and consequently the locking have been simplified. Entropy harvesting is done in a more general way (the documentation for this will follow). There is some GREAT entropy to be had in the UMA allocator, but it is disabled for now as messing with that is likely to annoy many people.
The venerable (but effective) Yarrow algorithm, which is no longer supported by its authors now has an alternative, Fortuna. For now, Yarrow is retained as the default algorithm, but this may be changed using a kernel option. It is intended to make Fortuna the default algorithm for 11.0. Interested parties are encouraged to read ISBN 978-0-470-47424-2 "Cryptography Engineering" By Ferguson, Schneier and Kohno for Fortuna's gory details. Heck, read it anyway.
Many thanks to Arthur Mesh who did early grunt work, and who got caught in the crossfire rather more than he deserved to.
My thanks also to folks who helped me thresh this out on whiteboards and in the odd "Hallway track", or otherwise.
My Nomex pants are on. Let the feedback commence!
Reviewed by: trasz,des(partial),imp(partial?),rwatson(partial?)
Approved by: so(des)
2014-10-30 21:21:53 +00:00
|
|
|
entropy_save_sz=${entropy_save_sz:-4096}
|
2001-01-11 13:01:20 +00:00
|
|
|
entropy_save_num=${entropy_save_num:-8}
|
|
|
|
|
|
|
|
if [ ! -d "${entropy_dir}" ]; then
|
2012-09-04 16:00:51 +00:00
|
|
|
install -d -o operator -g operator -m 0700 "${entropy_dir}" || {
|
|
|
|
logger -is -t "$0" The entropy directory "${entropy_dir}" does \
|
|
|
|
not exist, and cannot be created. Therefore no entropy can \
|
|
|
|
be saved.; exit 1; }
|
2001-01-11 13:01:20 +00:00
|
|
|
fi
|
|
|
|
|
2012-09-04 16:00:51 +00:00
|
|
|
cd "${entropy_dir}" || {
|
|
|
|
logger -is -t "$0" Cannot cd to the entropy directory: "${entropy_dir}". \
|
|
|
|
Entropy file rotation is aborted.; exit 1; }
|
|
|
|
|
|
|
|
for f in saved-entropy.*; do
|
|
|
|
case "${f}" in saved-entropy.\*) continue ;; esac # No files match
|
2019-11-30 20:06:53 +00:00
|
|
|
[ ${f#saved-entropy\.} -gt ${entropy_save_num} ] && unlink ${f}
|
2012-09-04 16:00:51 +00:00
|
|
|
done
|
|
|
|
|
2019-11-30 20:06:53 +00:00
|
|
|
umask 177
|
2001-01-11 13:01:20 +00:00
|
|
|
|
2019-11-30 20:06:53 +00:00
|
|
|
# Scan slots [1..$entropy_save_num), picking an empty slot or the oldest
|
|
|
|
# existing file if no empty slot was available.
|
|
|
|
#
|
|
|
|
# 1. Find out the first regular file or empty slot (and its serial number)
|
|
|
|
#
|
|
|
|
n=1
|
|
|
|
while [ ${n} -le ${entropy_save_num} ]; do
|
|
|
|
save_file="saved-entropy.${n}"
|
|
|
|
if [ ! -e "${save_file}" -o -f "${save_file}" ]; then
|
|
|
|
break
|
|
|
|
else
|
2012-09-04 16:00:51 +00:00
|
|
|
logger -is -t "$0" \
|
2019-11-30 20:06:53 +00:00
|
|
|
"${save_file}" is not a regular file, skipped.
|
2001-01-11 13:01:20 +00:00
|
|
|
fi
|
2019-11-30 20:06:53 +00:00
|
|
|
n=$(( ${n} + 1 ))
|
2001-01-11 13:01:20 +00:00
|
|
|
done
|
2019-11-30 20:06:53 +00:00
|
|
|
#
|
|
|
|
# 2. Start from (serial number + 1), and check if the slot is empty
|
|
|
|
# or is an older regular file, update save_file pointer in either
|
|
|
|
# case, and break early if we found an empty slot.
|
|
|
|
#
|
|
|
|
if [ -f ${save_file} ]; then
|
|
|
|
n=$(( ${n} + 1 ))
|
|
|
|
while [ ${n} -le ${entropy_save_num} ]; do
|
|
|
|
next_file=saved-entropy.${n}
|
|
|
|
if [ -f "${next_file}" ]; then
|
|
|
|
[ "${next_file}" -ot "${save_file}" ] && \
|
|
|
|
save_file="${next_file}"
|
|
|
|
elif [ ! -e "${next_file}" ]; then
|
|
|
|
save_file="${next_file}"
|
|
|
|
break
|
|
|
|
else
|
|
|
|
logger -is -t "$0" \
|
|
|
|
"${next_file}" is not a regular file, skipped.
|
|
|
|
fi
|
|
|
|
n=$(( ${n} + 1 ))
|
|
|
|
done
|
|
|
|
fi
|
|
|
|
#
|
|
|
|
# 3. Check if the pointer we have in hand is really a regular file or
|
|
|
|
# an empty slot, and bail out as that means there is no available slot.
|
|
|
|
#
|
|
|
|
if [ -e "${save_file}" -a ! -f "${save_file}" ]; then
|
|
|
|
logger -is -t "$0" \
|
|
|
|
No available slot in "${entropy_dir}", save entropy is aborted.
|
|
|
|
exit 1
|
|
|
|
fi
|
2001-01-11 13:01:20 +00:00
|
|
|
|
2019-11-30 20:06:53 +00:00
|
|
|
# Save entropy to the selected slot.
|
|
|
|
chmod 600 "${save_file}" 2>/dev/null || :
|
|
|
|
dd if=/dev/random of="${save_file}" bs=${entropy_save_sz} count=1 2>/dev/null
|
|
|
|
chflags nodump "${save_file}" 2>/dev/null || :
|
|
|
|
fsync "${save_file}" "."
|
2001-01-11 13:01:20 +00:00
|
|
|
|
|
|
|
exit 0
|