Automatically run ntpd as non-root when possible.

Ntpd needs only a subset of full root privileges to do its job. Specifically
it needs the ability to manipulate system time, and to re-bind to a
privileged UDP port after interface changes. The mac_ntpd(4) policy module
(see r336525) can grant these privs.

These changes detect the availability of mac_ntpd(4). If enabled, and if the
ntpd configuration is fairly vanilla, it automatically runs ntpd as the
non-root user 'ntpd' (uid 123). "Vanilla" means the config doesn't include
command line or ntp.conf options changing the location of files or using any
files/dirs likely to be inaccessible to user ntpd.  Ntpd can still run as
non-root when using such options, but the admin must ensure all required
files and dirs are accessible, and then set ntpd_user=ntpd in rc.conf.

Note that these changes also address PR 199127 by using the command_args
technique suggested in the patch. They also tangentially address PR 113552,
which is primarily about inconsistent filenames in documentation, but some
of the inconsistancy was caused by old code in rc.d/ntpd which is leftover
from the intial import from netbsd. There was code to do chroot setup which
required the use of the netbsd clockctl(4) device; that code never had any
effect on freebsd, because we lack that device and don't build ntpd with the
options that would allow using it.

PR:		113552 199127
Relnotes:	yes
Differential Revision:	https://reviews.freebsd.org/D16050
This commit is contained in:
Ian Lepore 2018-07-20 13:59:29 +00:00
parent fff9b47462
commit d11f4dfd21
Notes: svn2git 2020-12-20 02:59:44 +00:00
svn path=/head/; revision=336547
2 changed files with 81 additions and 32 deletions

View File

@ -381,8 +381,7 @@ ntpd_enable="NO" # Run ntpd Network Time Protocol (or NO).
ntpd_program="/usr/sbin/ntpd" # path to ntpd, if you want a different one.
ntpd_config="/etc/ntp.conf" # ntpd(8) configuration file
ntpd_sync_on_start="NO" # Sync time on ntpd startup, even if offset is high
ntpd_flags="-p /var/run/ntpd.pid -f /var/db/ntpd.drift"
# Flags to ntpd (if enabled).
ntpd_flags="" # Additional flags to ntpd
ntp_src_leapfile="/etc/ntp/leap-seconds"
# Initial source for ntpd leapfile
ntp_db_leapfile="/var/db/ntpd.leap-seconds.list"

View File

@ -14,53 +14,103 @@ name="ntpd"
desc="Network Time Protocol daemon"
rcvar="ntpd_enable"
command="/usr/sbin/${name}"
pidfile="/var/run/${name}.pid"
extra_commands="fetch needfetch"
fetch_cmd="ntpd_fetch_leapfile"
needfetch_cmd="ntpd_needfetch_leapfile"
start_precmd="ntpd_precmd"
_ntp_tmp_leapfile="/var/run/ntpd.leap-seconds.list"
_ntp_default_dir="/var/db/ntp"
_ntp_default_driftfile="${_ntp_default_dir}/ntpd.drift"
_ntp_old_driftfile="/var/db/ntpd.drift"
pidfile="${_ntp_default_dir}/${name}.pid"
load_rc_config $name
can_run_nonroot()
{
# If the admin set what uid to use, we don't change it.
if [ -n "${ntpd_user}" ]; then
return 1
fi
# If the admin set any command line options involving files, we
# may not be able to access them as user ntpd.
case "${rc_flags}" in
*-f* | *--driftfile* | *-i* | *--jaildir* | \
*-k* | *--keyfile* | *-l* | *--logfile* | \
*-p* | *--pidfile* | *-s* | *--statsdir* )
return 1;;
esac
# If the admin set any options in ntp.conf involving files,
# we may not be able to access them as user ntpd.
local fileopts="^[ \t]*crypto|^[ \t]*driftfile|^[ \t]*key|^[ \t]*logfile|^[ \t]*statsdir"
grep -E -q "${fileopts}" "${ntpd_config}" && return 1
# Try to set up the the MAC ntpd policy so ntpd can run with reduced
# privileges. Detect whether MAC is compiled into the kernel, load
# the policy module if not already present, then check whether the
# policy has been disabled via tunable or sysctl.
[ -n "$(sysctl -qn security.mac.version)" ] || return 1
sysctl -qn security.mac.ntpd >/dev/null || kldload -qn mac_ntpd || return 1
[ "$(sysctl -qn security.mac.ntpd.enabled)" == "1" ] || return 1
# On older existing systems, the ntp dir may by owned by root, change
# it to ntpd to give the daemon create/write access to the driftfile.
if [ "$(stat -f %u ${_ntp_default_dir})" = "0" ]; then
chown ntpd:ntpd "${_ntp_default_dir}" || return 1
chmod 0755 "${_ntp_default_dir}" || return 1
logger -s -t "rc.d/ntpd" -p daemon.notice \
"${_ntp_default_dir} updated to owner ntpd:ntpd, mode 0755"
fi
# If the driftfile exists in the standard location for older existing
# systems, move it into the ntp dir and fix the ownership if we can.
if [ -f "${_ntp_old_driftfile}" ] && [ ! -L "${_ntp_old_driftfile}" ]; then
mv "${_ntp_old_driftfile}" "${_ntp_default_driftfile}" &&
chown ntpd:ntpd "${_ntp_default_driftfile}" || return 1
logger -s -t "rc.d/ntpd" -p daemon.notice \
"${_ntp_default_driftfile} updated to owner ntpd:ntpd"
logger -s -t "rc.d/ntpd" -p daemon.notice \
"${_ntp_old_driftfile} moved to ${_ntp_default_driftfile}"
fi
}
ntpd_precmd()
{
rc_flags="-c ${ntpd_config} ${ntpd_flags}"
local driftopt
if checkyesno ntpd_sync_on_start; then
rc_flags="-g $rc_flags"
# If we can run as a non-root user, switch uid to ntpd and use the
# new default location for the driftfile inside the ntpd-owned dir.
# Otherwise, figure out what to do about the driftfile option. If set
# by the admin, we don't add the option. If the file exists in the old
# default location we use that, else we use the new default location.
if can_run_nonroot; then
_user="ntpd"
driftopt="-f ${_ntp_default_driftfile}"
elif [ -z "${rc_flags##*-f*}" ] ||
[ -z "${rc_flags##*--driftfile*}" ] ||
grep -q "^[ \t]*driftfile" "${ntpd_config}"; then
driftopt="" # admin set the option, we don't need to add it.
elif [ -f "${_ntp_old_driftfile}" ]; then
driftopt="-f ${_ntp_old_driftfile}"
else
driftopt="-f ${_ntp_default_driftfile}"
fi
ntpd_init_leapfile
# Set command_args based on the various config vars.
command_args="-p ${pidfile} -c ${ntpd_config} ${driftopt}"
if checkyesno ntpd_sync_on_start; then
command_args="${command_args} -g"
fi
if [ ! -f $ntp_db_leapfile ]; then
# Make sure the leapfile is ready to use.
ntpd_init_leapfile
if [ ! -f "${ntp_db_leapfile}" ]; then
ntpd_fetch_leapfile
fi
if [ -z "$ntpd_chrootdir" ]; then
return 0;
fi
# If running in a chroot cage, ensure that the appropriate files
# exist inside the cage, as well as helper symlinks into the cage
# from outside.
#
# As this is called after the is_running and required_dir checks
# are made in run_rc_command(), we can safely assume ${ntpd_chrootdir}
# exists and ntpd isn't running at this point (unless forcestart
# is used).
#
if [ ! -c "${ntpd_chrootdir}/dev/clockctl" ]; then
rm -f "${ntpd_chrootdir}/dev/clockctl"
( cd /dev ; /bin/pax -rw -pe clockctl "${ntpd_chrootdir}/dev" )
fi
ln -fs "${ntpd_chrootdir}/var/db/ntp.drift" /var/db/ntp.drift
ln -fs "${ntpd_chrootdir}${_ntp_tmp_leapfile}" ${_ntp_tmp_leapfile}
# Change run_rc_commands()'s internal copy of $ntpd_flags
#
rc_flags="-u ntpd:ntpd -i ${ntpd_chrootdir} $rc_flags"
}
current_ntp_ts() {