xref: /freebsd/libexec/rc/rc.d/ntpd (revision a2119d62c0dea95e138bb3c962e2735a681924bc)
1#!/bin/sh
2#
3# $FreeBSD$
4#
5
6# PROVIDE: ntpd
7# REQUIRE: DAEMON ntpdate FILESYSTEMS devfs
8# BEFORE:  LOGIN
9# KEYWORD: nojail shutdown
10
11. /etc/rc.subr
12
13name="ntpd"
14desc="Network Time Protocol daemon"
15rcvar="ntpd_enable"
16command="/usr/sbin/${name}"
17extra_commands="fetch needfetch"
18fetch_cmd="ntpd_fetch_leapfile"
19needfetch_cmd="ntpd_needfetch_leapfile"
20start_precmd="ntpd_precmd"
21
22_ntp_tmp_leapfile="/var/run/ntpd.leap-seconds.list"
23_ntp_default_dir="/var/db/ntp"
24_ntp_default_driftfile="${_ntp_default_dir}/ntpd.drift"
25_ntp_old_driftfile="/var/db/ntpd.drift"
26
27pidfile="${_ntp_default_dir}/${name}.pid"
28
29load_rc_config $name
30
31can_run_nonroot()
32{
33	# If the admin set what uid to use, we don't change it.
34	if [ -n "${ntpd_user}" ]; then
35		return 1
36	fi
37
38	# If the admin set any command line options involving files, we
39	# may not be able to access them as user ntpd.
40	case "${rc_flags}" in
41	    *-f* | *--driftfile* | *-i* | *--jaildir*   | \
42	    *-k* | *--keyfile*   | *-l* | *--logfile*   | \
43	    *-p* | *--pidfile*   | *-s* | *--statsdir* )
44		return 1;;
45	esac
46
47	# If the admin set any options in ntp.conf involving files,
48	# we may not be able to access them as user ntpd.
49	local fileopts="^[ \t]*crypto|^[ \t]*driftfile|^[ \t]*key|^[ \t]*logfile|^[ \t]*statsdir"
50	grep -E -q "${fileopts}" "${ntpd_config}" && return 1
51
52	# Try to set up the the MAC ntpd policy so ntpd can run with reduced
53	# privileges.  Detect whether MAC is compiled into the kernel, load
54	# the policy module if not already present, then check whether the
55	# policy has been disabled via tunable or sysctl.
56	[ -n "$(sysctl -qn security.mac.version)" ] || return 1
57	sysctl -qn security.mac.ntpd >/dev/null || kldload -qn mac_ntpd || return 1
58	[ "$(sysctl -qn security.mac.ntpd.enabled)" == "1" ] || return 1
59
60	# On older existing systems, the ntp dir may by owned by root, change
61	# it to ntpd to give the daemon create/write access to the driftfile.
62	if [ "$(stat -f %u ${_ntp_default_dir})" = "0" ]; then
63		chown ntpd:ntpd "${_ntp_default_dir}" || return 1
64		chmod 0755 "${_ntp_default_dir}" || return 1
65		logger -s -t "rc.d/ntpd" -p daemon.notice \
66		    "${_ntp_default_dir} updated to owner ntpd:ntpd, mode 0755"
67	fi
68
69	# If the driftfile exists in the standard location for older existing
70	# systems, move it into the ntp dir and fix the ownership if we can.
71	if [ -f "${_ntp_old_driftfile}" ] && [ ! -L "${_ntp_old_driftfile}" ]; then
72		mv "${_ntp_old_driftfile}" "${_ntp_default_driftfile}" &&
73		   chown ntpd:ntpd "${_ntp_default_driftfile}" || return 1
74		logger -s -t "rc.d/ntpd" -p daemon.notice \
75		    "${_ntp_default_driftfile} updated to owner ntpd:ntpd"
76		logger -s -t "rc.d/ntpd" -p daemon.notice \
77		    "${_ntp_old_driftfile} moved to ${_ntp_default_driftfile}"
78	fi
79}
80
81ntpd_precmd()
82{
83	local driftopt
84
85	# If we can run as a non-root user, switch uid to ntpd and use the
86	# new default location for the driftfile inside the ntpd-owned dir.
87	# Otherwise, figure out what to do about the driftfile option.  If set
88	# by the admin, we don't add the option.  If the file exists in the old
89	# default location we use that, else we use the new default location.
90
91	if can_run_nonroot; then
92		_user="ntpd"
93		driftopt="-f ${_ntp_default_driftfile}"
94	elif grep -q "^[ \t]*driftfile" "${ntpd_config}" ||
95	     [ -n "${rc_flags}" ] &&
96	     ( [ -z "${rc_flags##*-f*}" ] ||
97	       [ -z "${rc_flags##*--driftfile*}" ] ); then
98		driftopt="" # admin set the option, we don't need to add it.
99	elif [ -f "${_ntp_old_driftfile}" ]; then
100		driftopt="-f ${_ntp_old_driftfile}"
101	else
102		driftopt="-f ${_ntp_default_driftfile}"
103	fi
104
105	# Set command_args based on the various config vars.
106	command_args="-p ${pidfile} -c ${ntpd_config} ${driftopt}"
107	if checkyesno ntpd_sync_on_start; then
108		command_args="${command_args} -g"
109	fi
110
111	# Make sure the leapfile is ready to use.
112	ntpd_init_leapfile
113	if [ ! -f "${ntp_db_leapfile}" ]; then
114		ntpd_fetch_leapfile
115	fi
116}
117
118current_ntp_ts() {
119	# Seconds between 1900-01-01 and 1970-01-01
120	# echo $(((70*365+17)*86400))
121	ntp_to_unix=2208988800
122
123	echo $(($(date -u +%s)+$ntp_to_unix))
124}
125
126get_ntp_leapfile_ver() {
127	# Leapfile update date (version number).
128	expr "$(awk '$1 == "#$" { print $2 }' "$1" 2>/dev/null)" : \
129		'^\([1-9][0-9]*\)$' \| 0
130}
131
132get_ntp_leapfile_expiry() {
133	# Leapfile expiry date.
134	expr "$(awk '$1 == "#@" { print $2 }' "$1" 2>/dev/null)" : \
135		'^\([1-9][0-9]*\)$' \| 0
136}
137
138ntpd_init_leapfile() {
139	# Refresh working leapfile with an invalid hash due to
140	# FreeBSD id header. Ntpd will ignore leapfiles with a
141	# mismatch hash. The file must be the virgin file from
142	# the source.
143	if [ ! -f $ntp_db_leapfile ]; then
144		cp -p $ntp_src_leapfile $ntp_db_leapfile
145	fi
146}
147
148ntpd_needfetch_leapfile() {
149	local rc verbose
150
151	if checkyesno ntp_leapfile_fetch_verbose; then
152		verbose=echo
153	else
154		verbose=:
155	fi
156
157	ntp_ver_no_src=$(get_ntp_leapfile_ver $ntp_src_leapfile)
158	ntp_expiry_src=$(get_ntp_leapfile_expiry $ntp_src_leapfile)
159	ntp_ver_no_db=$(get_ntp_leapfile_ver $ntp_db_leapfile)
160	ntp_expiry_db=$(get_ntp_leapfile_expiry $ntp_db_leapfile)
161	$verbose ntp_src_leapfile version is $ntp_ver_no_src expires $ntp_expiry_src
162	$verbose ntp_db_leapfile version is $ntp_ver_no_db expires $ntp_expiry_db
163
164	if [ "$ntp_ver_no_src" -gt "$ntp_ver_no_db" -o \
165	     "$ntp_ver_no_src" -eq "$ntp_ver_no_db" -a \
166	     "$ntp_expiry_src" -gt "$ntp_expiry_db" ]; then
167		$verbose replacing $ntp_db_leapfile with $ntp_src_leapfile
168		cp -p $ntp_src_leapfile $ntp_db_leapfile
169		ntp_ver_no_db=$ntp_ver_no_src
170	else
171		$verbose not replacing $ntp_db_leapfile with $ntp_src_leapfile
172	fi
173	ntp_leapfile_expiry_seconds=$((ntp_leapfile_expiry_days*86400))
174	ntp_leap_expiry=$(get_ntp_leapfile_expiry $ntp_db_leapfile)
175	ntp_leap_fetch_date=$((ntp_leap_expiry-ntp_leapfile_expiry_seconds))
176	if [ $(current_ntp_ts) -ge $ntp_leap_fetch_date ]; then
177		$verbose Within ntp leapfile expiry limit, initiating fetch
178		# Return code 0: ntp leapfile fetch needed
179		return 0
180	fi
181	# Return code 1: ntp leapfile fetch not needed
182	return 1
183}
184
185ntpd_fetch_leapfile() {
186	if checkyesno ntp_leapfile_fetch_verbose; then
187		verbose=echo
188	else
189		verbose=:
190	fi
191
192	if ntpd_needfetch_leapfile ; then
193		for url in $ntp_leapfile_sources ; do
194			$verbose fetching $url
195			fetch $ntp_leapfile_fetch_opts -o $_ntp_tmp_leapfile $url && break
196		done
197		ntp_ver_no_tmp=$(get_ntp_leapfile_ver $_ntp_tmp_leapfile)
198		ntp_expiry_tmp=$(get_ntp_leapfile_expiry $_ntp_tmp_leapfile)
199		if [ "$ntp_expiry_tmp" -gt "$ntp_expiry_db" -o \
200		     "$ntp_expiry_tmp" -eq "$ntp_expiry_db" -a \
201		     "$ntp_ver_no_tmp" -gt "$ntp_ver_no_db" ]; then
202			$verbose using $url as $ntp_db_leapfile
203			mv -f $_ntp_tmp_leapfile $ntp_db_leapfile ||
204			    $verbose "warning: cannot replace $ntp_db_leapfile (read-only fs?)"
205		else
206			$verbose using existing $ntp_db_leapfile
207		fi
208	fi
209}
210
211run_rc_command "$1"
212