7 # REQUIRE: DAEMON ntpdate FILESYSTEMS devfs
9 # KEYWORD: nojail shutdown
14 desc="Network Time Protocol daemon"
16 command="/usr/sbin/${name}"
17 extra_commands="fetch needfetch"
18 fetch_cmd="ntpd_fetch_leapfile"
19 needfetch_cmd="ntpd_needfetch_leapfile"
20 start_precmd="ntpd_precmd"
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"
27 pidfile="${_ntp_default_dir}/${name}.pid"
33 # If the admin set what uid to use, we don't change it.
34 if [ -n "${ntpd_user}" ]; then
38 # If the admin set any command line options involving files, we
39 # may not be able to access them as user ntpd.
41 *-f* | *--driftfile* | *-i* | *--jaildir* | \
42 *-k* | *--keyfile* | *-l* | *--logfile* | \
43 *-p* | *--pidfile* | *-s* | *--statsdir* )
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
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
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"
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}"
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 if can_run_nonroot; then
92 driftopt="-f ${_ntp_default_driftfile}"
93 elif grep -q "^[ \t]*driftfile" "${ntpd_config}" ||
94 [ -n "${rc_flags}" ] &&
95 ( [ -z "${rc_flags##*-f*}" ] ||
96 [ -z "${rc_flags##*--driftfile*}" ] ); then
97 driftopt="" # admin set the option, we don't need to add it.
98 elif [ -f "${_ntp_old_driftfile}" ]; then
99 driftopt="-f ${_ntp_old_driftfile}"
101 driftopt="-f ${_ntp_default_driftfile}"
104 # Set command_args based on the various config vars.
105 command_args="-p ${pidfile} -c ${ntpd_config} ${driftopt}"
106 if checkyesno ntpd_sync_on_start; then
107 command_args="${command_args} -g"
110 # Make sure the leapfile is ready to use.
112 if [ ! -f "${ntp_db_leapfile}" ]; then
118 # Seconds between 1900-01-01 and 1970-01-01
119 # echo $(((70*365+17)*86400))
120 ntp_to_unix=2208988800
122 echo $(($(date -u +%s)+$ntp_to_unix))
125 get_ntp_leapfile_ver() {
126 # Leapfile update date (version number).
127 expr "$(awk '$1 == "#$" { print $2 }' "$1" 2>/dev/null)" : \
128 '^\([1-9][0-9]*\)$' \| 0
131 get_ntp_leapfile_expiry() {
132 # Leapfile expiry date.
133 expr "$(awk '$1 == "#@" { print $2 }' "$1" 2>/dev/null)" : \
134 '^\([1-9][0-9]*\)$' \| 0
137 ntpd_init_leapfile() {
138 # Refresh working leapfile with an invalid hash due to
139 # FreeBSD id header. Ntpd will ignore leapfiles with a
140 # mismatch hash. The file must be the virgin file from
142 if [ ! -f $ntp_db_leapfile ]; then
143 cp -p $ntp_src_leapfile $ntp_db_leapfile
147 ntpd_needfetch_leapfile() {
150 if checkyesno ntp_leapfile_fetch_verbose; then
156 ntp_ver_no_src=$(get_ntp_leapfile_ver $ntp_src_leapfile)
157 ntp_expiry_src=$(get_ntp_leapfile_expiry $ntp_src_leapfile)
158 ntp_ver_no_db=$(get_ntp_leapfile_ver $ntp_db_leapfile)
159 ntp_expiry_db=$(get_ntp_leapfile_expiry $ntp_db_leapfile)
160 $verbose ntp_src_leapfile version is $ntp_ver_no_src expires $ntp_expiry_src
161 $verbose ntp_db_leapfile version is $ntp_ver_no_db expires $ntp_expiry_db
163 if [ "$ntp_ver_no_src" -gt "$ntp_ver_no_db" -o \
164 "$ntp_ver_no_src" -eq "$ntp_ver_no_db" -a \
165 "$ntp_expiry_src" -gt "$ntp_expiry_db" ]; then
166 $verbose replacing $ntp_db_leapfile with $ntp_src_leapfile
167 cp -p $ntp_src_leapfile $ntp_db_leapfile
168 ntp_ver_no_db=$ntp_ver_no_src
170 $verbose not replacing $ntp_db_leapfile with $ntp_src_leapfile
172 ntp_leapfile_expiry_seconds=$((ntp_leapfile_expiry_days*86400))
173 ntp_leap_expiry=$(get_ntp_leapfile_expiry $ntp_db_leapfile)
174 ntp_leap_fetch_date=$((ntp_leap_expiry-ntp_leapfile_expiry_seconds))
175 if [ $(current_ntp_ts) -ge $ntp_leap_fetch_date ]; then
176 $verbose Within ntp leapfile expiry limit, initiating fetch
177 # Return code 0: ntp leapfile fetch needed
180 # Return code 1: ntp leapfile fetch not needed
184 ntpd_fetch_leapfile() {
185 if checkyesno ntp_leapfile_fetch_verbose; then
191 if ntpd_needfetch_leapfile ; then
192 for url in $ntp_leapfile_sources ; do
193 $verbose fetching $url
194 fetch $ntp_leapfile_fetch_opts -o $_ntp_tmp_leapfile $url && break
196 ntp_ver_no_tmp=$(get_ntp_leapfile_ver $_ntp_tmp_leapfile)
197 ntp_expiry_tmp=$(get_ntp_leapfile_expiry $_ntp_tmp_leapfile)
198 if [ "$ntp_expiry_tmp" -gt "$ntp_expiry_db" -o \
199 "$ntp_expiry_tmp" -eq "$ntp_expiry_db" -a \
200 "$ntp_ver_no_tmp" -gt "$ntp_ver_no_db" ]; then
201 $verbose using $url as $ntp_db_leapfile
202 mv -f $_ntp_tmp_leapfile $ntp_db_leapfile ||
203 $verbose "warning: cannot replace $ntp_db_leapfile (read-only fs?)"
205 $verbose using existing $ntp_db_leapfile