2 * ntp_control.c - respond to mode 6 control messages and send async
3 * traps. Provides service to ntpq and others.
14 #ifdef HAVE_NETINET_IN_H
15 # include <netinet/in.h>
17 #include <arpa/inet.h>
21 #include "ntp_refclock.h"
22 #include "ntp_control.h"
23 #include "ntp_unixtime.h"
24 #include "ntp_stdlib.h"
25 #include "ntp_config.h"
26 #include "ntp_crypto.h"
27 #include "ntp_assert.h"
28 #include "ntp_leapsec.h"
29 #include "ntp_md5.h" /* provides OpenSSL digest API */
30 #include "lib_strbuf.h"
31 #include <rc_cmdlength.h>
33 # include "ntp_syscall.h"
37 * Structure to hold request procedure information
41 short control_code; /* defined request code */
42 #define NO_REQUEST (-1)
43 u_short flags; /* flags word */
44 /* Only one flag. Authentication required or not. */
47 void (*handler) (struct recvbuf *, int); /* handle request */
52 * Request processing routines
54 static void ctl_error (u_char);
56 static u_short ctlclkstatus (struct refclockstat *);
58 static void ctl_flushpkt (u_char);
59 static void ctl_putdata (const char *, unsigned int, int);
60 static void ctl_putstr (const char *, const char *, size_t);
61 static void ctl_putdblf (const char *, int, int, double);
62 #define ctl_putdbl(tag, d) ctl_putdblf(tag, 1, 3, d)
63 #define ctl_putdbl6(tag, d) ctl_putdblf(tag, 1, 6, d)
64 #define ctl_putsfp(tag, sfp) ctl_putdblf(tag, 0, -1, \
66 static void ctl_putuint (const char *, u_long);
67 static void ctl_puthex (const char *, u_long);
68 static void ctl_putint (const char *, long);
69 static void ctl_putts (const char *, l_fp *);
70 static void ctl_putadr (const char *, u_int32,
72 static void ctl_putrefid (const char *, u_int32);
73 static void ctl_putarray (const char *, double *, int);
74 static void ctl_putsys (int);
75 static void ctl_putpeer (int, struct peer *);
76 static void ctl_putfs (const char *, tstamp_t);
77 static void ctl_printf (const char *, ...) NTP_PRINTF(1, 2);
79 static void ctl_putclock (int, struct refclockstat *, int);
81 static const struct ctl_var *ctl_getitem(const struct ctl_var *,
83 static u_short count_var (const struct ctl_var *);
84 static void control_unspec (struct recvbuf *, int);
85 static void read_status (struct recvbuf *, int);
86 static void read_sysvars (void);
87 static void read_peervars (void);
88 static void read_variables (struct recvbuf *, int);
89 static void write_variables (struct recvbuf *, int);
90 static void read_clockstatus(struct recvbuf *, int);
91 static void write_clockstatus(struct recvbuf *, int);
92 static void set_trap (struct recvbuf *, int);
93 static void save_config (struct recvbuf *, int);
94 static void configure (struct recvbuf *, int);
95 static void send_mru_entry (mon_entry *, int);
96 static void send_random_tag_value(int);
97 static void read_mru_list (struct recvbuf *, int);
98 static void send_ifstats_entry(endpt *, u_int);
99 static void read_ifstats (struct recvbuf *);
100 static void sockaddrs_from_restrict_u(sockaddr_u *, sockaddr_u *,
102 static void send_restrict_entry(restrict_u *, int, u_int);
103 static void send_restrict_list(restrict_u *, int, u_int *);
104 static void read_addr_restrictions(struct recvbuf *);
105 static void read_ordlist (struct recvbuf *, int);
106 static u_int32 derive_nonce (sockaddr_u *, u_int32, u_int32);
107 static void generate_nonce (struct recvbuf *, char *, size_t);
108 static int validate_nonce (const char *, struct recvbuf *);
109 static void req_nonce (struct recvbuf *, int);
110 static void unset_trap (struct recvbuf *, int);
111 static struct ctl_trap *ctlfindtrap(sockaddr_u *,
114 int/*BOOL*/ is_safe_filename(const char * name);
116 static const struct ctl_proc control_codes[] = {
117 { CTL_OP_UNSPEC, NOAUTH, control_unspec },
118 { CTL_OP_READSTAT, NOAUTH, read_status },
119 { CTL_OP_READVAR, NOAUTH, read_variables },
120 { CTL_OP_WRITEVAR, AUTH, write_variables },
121 { CTL_OP_READCLOCK, NOAUTH, read_clockstatus },
122 { CTL_OP_WRITECLOCK, AUTH, write_clockstatus },
123 { CTL_OP_SETTRAP, AUTH, set_trap },
124 { CTL_OP_CONFIGURE, AUTH, configure },
125 { CTL_OP_SAVECONFIG, AUTH, save_config },
126 { CTL_OP_READ_MRU, NOAUTH, read_mru_list },
127 { CTL_OP_READ_ORDLIST_A, AUTH, read_ordlist },
128 { CTL_OP_REQ_NONCE, NOAUTH, req_nonce },
129 { CTL_OP_UNSETTRAP, AUTH, unset_trap },
130 { NO_REQUEST, 0, NULL }
134 * System variables we understand
138 #define CS_PRECISION 3
139 #define CS_ROOTDELAY 4
140 #define CS_ROOTDISPERSION 5
150 #define CS_PROCESSOR 15
152 #define CS_VERSION 17
154 #define CS_VARLIST 19
156 #define CS_LEAPTAB 21
157 #define CS_LEAPEND 22
159 #define CS_MRU_ENABLED 24
160 #define CS_MRU_DEPTH 25
161 #define CS_MRU_DEEPEST 26
162 #define CS_MRU_MINDEPTH 27
163 #define CS_MRU_MAXAGE 28
164 #define CS_MRU_MAXDEPTH 29
165 #define CS_MRU_MEM 30
166 #define CS_MRU_MAXMEM 31
167 #define CS_SS_UPTIME 32
168 #define CS_SS_RESET 33
169 #define CS_SS_RECEIVED 34
170 #define CS_SS_THISVER 35
171 #define CS_SS_OLDVER 36
172 #define CS_SS_BADFORMAT 37
173 #define CS_SS_BADAUTH 38
174 #define CS_SS_DECLINED 39
175 #define CS_SS_RESTRICTED 40
176 #define CS_SS_LIMITED 41
177 #define CS_SS_KODSENT 42
178 #define CS_SS_PROCESSED 43
179 #define CS_SS_LAMPORT 44
180 #define CS_SS_TSROUNDING 45
181 #define CS_PEERADR 46
182 #define CS_PEERMODE 47
183 #define CS_BCASTDELAY 48
184 #define CS_AUTHDELAY 49
185 #define CS_AUTHKEYS 50
186 #define CS_AUTHFREEK 51
187 #define CS_AUTHKLOOKUPS 52
188 #define CS_AUTHKNOTFOUND 53
189 #define CS_AUTHKUNCACHED 54
190 #define CS_AUTHKEXPIRED 55
191 #define CS_AUTHENCRYPTS 56
192 #define CS_AUTHDECRYPTS 57
193 #define CS_AUTHRESET 58
194 #define CS_K_OFFSET 59
196 #define CS_K_MAXERR 61
197 #define CS_K_ESTERR 62
198 #define CS_K_STFLAGS 63
199 #define CS_K_TIMECONST 64
200 #define CS_K_PRECISION 65
201 #define CS_K_FREQTOL 66
202 #define CS_K_PPS_FREQ 67
203 #define CS_K_PPS_STABIL 68
204 #define CS_K_PPS_JITTER 69
205 #define CS_K_PPS_CALIBDUR 70
206 #define CS_K_PPS_CALIBS 71
207 #define CS_K_PPS_CALIBERRS 72
208 #define CS_K_PPS_JITEXC 73
209 #define CS_K_PPS_STBEXC 74
210 #define CS_KERN_FIRST CS_K_OFFSET
211 #define CS_KERN_LAST CS_K_PPS_STBEXC
212 #define CS_IOSTATS_RESET 75
213 #define CS_TOTAL_RBUF 76
214 #define CS_FREE_RBUF 77
215 #define CS_USED_RBUF 78
216 #define CS_RBUF_LOWATER 79
217 #define CS_IO_DROPPED 80
218 #define CS_IO_IGNORED 81
219 #define CS_IO_RECEIVED 82
220 #define CS_IO_SENT 83
221 #define CS_IO_SENDFAILED 84
222 #define CS_IO_WAKEUPS 85
223 #define CS_IO_GOODWAKEUPS 86
224 #define CS_TIMERSTATS_RESET 87
225 #define CS_TIMER_OVERRUNS 88
226 #define CS_TIMER_XMTS 89
228 #define CS_WANDER_THRESH 91
229 #define CS_LEAPSMEARINTV 92
230 #define CS_LEAPSMEAROFFS 93
231 #define CS_MAX_NOAUTOKEY CS_LEAPSMEAROFFS
233 #define CS_FLAGS (1 + CS_MAX_NOAUTOKEY)
234 #define CS_HOST (2 + CS_MAX_NOAUTOKEY)
235 #define CS_PUBLIC (3 + CS_MAX_NOAUTOKEY)
236 #define CS_CERTIF (4 + CS_MAX_NOAUTOKEY)
237 #define CS_SIGNATURE (5 + CS_MAX_NOAUTOKEY)
238 #define CS_REVTIME (6 + CS_MAX_NOAUTOKEY)
239 #define CS_IDENT (7 + CS_MAX_NOAUTOKEY)
240 #define CS_DIGEST (8 + CS_MAX_NOAUTOKEY)
241 #define CS_MAXCODE CS_DIGEST
242 #else /* !AUTOKEY follows */
243 #define CS_MAXCODE CS_MAX_NOAUTOKEY
244 #endif /* !AUTOKEY */
247 * Peer variables we understand
250 #define CP_AUTHENABLE 2
251 #define CP_AUTHENTIC 3
258 #define CP_STRATUM 10
261 #define CP_PRECISION 13
262 #define CP_ROOTDELAY 14
263 #define CP_ROOTDISPERSION 15
265 #define CP_REFTIME 17
270 #define CP_UNREACH 22
275 #define CP_DISPERSION 27
277 #define CP_FILTDELAY 29
278 #define CP_FILTOFFSET 30
280 #define CP_RECEIVED 32
282 #define CP_FILTERROR 34
285 #define CP_VARLIST 37
290 #define CP_SRCHOST 42
291 #define CP_TIMEREC 43
292 #define CP_TIMEREACH 44
293 #define CP_BADAUTH 45
294 #define CP_BOGUSORG 46
296 #define CP_SELDISP 48
297 #define CP_SELBROKEN 49
298 #define CP_CANDIDATE 50
299 #define CP_MAX_NOAUTOKEY CP_CANDIDATE
301 #define CP_FLAGS (1 + CP_MAX_NOAUTOKEY)
302 #define CP_HOST (2 + CP_MAX_NOAUTOKEY)
303 #define CP_VALID (3 + CP_MAX_NOAUTOKEY)
304 #define CP_INITSEQ (4 + CP_MAX_NOAUTOKEY)
305 #define CP_INITKEY (5 + CP_MAX_NOAUTOKEY)
306 #define CP_INITTSP (6 + CP_MAX_NOAUTOKEY)
307 #define CP_SIGNATURE (7 + CP_MAX_NOAUTOKEY)
308 #define CP_IDENT (8 + CP_MAX_NOAUTOKEY)
309 #define CP_MAXCODE CP_IDENT
310 #else /* !AUTOKEY follows */
311 #define CP_MAXCODE CP_MAX_NOAUTOKEY
312 #endif /* !AUTOKEY */
315 * Clock variables we understand
318 #define CC_TIMECODE 2
321 #define CC_BADFORMAT 5
323 #define CC_FUDGETIME1 7
324 #define CC_FUDGETIME2 8
325 #define CC_FUDGEVAL1 9
326 #define CC_FUDGEVAL2 10
329 #define CC_VARLIST 13
330 #define CC_MAXCODE CC_VARLIST
333 * System variable values. The array can be indexed by the variable
334 * index to find the textual name.
336 static const struct ctl_var sys_var[] = {
337 { 0, PADDING, "" }, /* 0 */
338 { CS_LEAP, RW, "leap" }, /* 1 */
339 { CS_STRATUM, RO, "stratum" }, /* 2 */
340 { CS_PRECISION, RO, "precision" }, /* 3 */
341 { CS_ROOTDELAY, RO, "rootdelay" }, /* 4 */
342 { CS_ROOTDISPERSION, RO, "rootdisp" }, /* 5 */
343 { CS_REFID, RO, "refid" }, /* 6 */
344 { CS_REFTIME, RO, "reftime" }, /* 7 */
345 { CS_POLL, RO, "tc" }, /* 8 */
346 { CS_PEERID, RO, "peer" }, /* 9 */
347 { CS_OFFSET, RO, "offset" }, /* 10 */
348 { CS_DRIFT, RO, "frequency" }, /* 11 */
349 { CS_JITTER, RO, "sys_jitter" }, /* 12 */
350 { CS_ERROR, RO, "clk_jitter" }, /* 13 */
351 { CS_CLOCK, RO, "clock" }, /* 14 */
352 { CS_PROCESSOR, RO, "processor" }, /* 15 */
353 { CS_SYSTEM, RO, "system" }, /* 16 */
354 { CS_VERSION, RO, "version" }, /* 17 */
355 { CS_STABIL, RO, "clk_wander" }, /* 18 */
356 { CS_VARLIST, RO, "sys_var_list" }, /* 19 */
357 { CS_TAI, RO, "tai" }, /* 20 */
358 { CS_LEAPTAB, RO, "leapsec" }, /* 21 */
359 { CS_LEAPEND, RO, "expire" }, /* 22 */
360 { CS_RATE, RO, "mintc" }, /* 23 */
361 { CS_MRU_ENABLED, RO, "mru_enabled" }, /* 24 */
362 { CS_MRU_DEPTH, RO, "mru_depth" }, /* 25 */
363 { CS_MRU_DEEPEST, RO, "mru_deepest" }, /* 26 */
364 { CS_MRU_MINDEPTH, RO, "mru_mindepth" }, /* 27 */
365 { CS_MRU_MAXAGE, RO, "mru_maxage" }, /* 28 */
366 { CS_MRU_MAXDEPTH, RO, "mru_maxdepth" }, /* 29 */
367 { CS_MRU_MEM, RO, "mru_mem" }, /* 30 */
368 { CS_MRU_MAXMEM, RO, "mru_maxmem" }, /* 31 */
369 { CS_SS_UPTIME, RO, "ss_uptime" }, /* 32 */
370 { CS_SS_RESET, RO, "ss_reset" }, /* 33 */
371 { CS_SS_RECEIVED, RO, "ss_received" }, /* 34 */
372 { CS_SS_THISVER, RO, "ss_thisver" }, /* 35 */
373 { CS_SS_OLDVER, RO, "ss_oldver" }, /* 36 */
374 { CS_SS_BADFORMAT, RO, "ss_badformat" }, /* 37 */
375 { CS_SS_BADAUTH, RO, "ss_badauth" }, /* 38 */
376 { CS_SS_DECLINED, RO, "ss_declined" }, /* 39 */
377 { CS_SS_RESTRICTED, RO, "ss_restricted" }, /* 40 */
378 { CS_SS_LIMITED, RO, "ss_limited" }, /* 41 */
379 { CS_SS_KODSENT, RO, "ss_kodsent" }, /* 42 */
380 { CS_SS_PROCESSED, RO, "ss_processed" }, /* 43 */
381 { CS_SS_LAMPORT, RO, "ss_lamport" }, /* 44 */
382 { CS_SS_TSROUNDING, RO, "ss_tsrounding" }, /* 45 */
383 { CS_PEERADR, RO, "peeradr" }, /* 46 */
384 { CS_PEERMODE, RO, "peermode" }, /* 47 */
385 { CS_BCASTDELAY, RO, "bcastdelay" }, /* 48 */
386 { CS_AUTHDELAY, RO, "authdelay" }, /* 49 */
387 { CS_AUTHKEYS, RO, "authkeys" }, /* 50 */
388 { CS_AUTHFREEK, RO, "authfreek" }, /* 51 */
389 { CS_AUTHKLOOKUPS, RO, "authklookups" }, /* 52 */
390 { CS_AUTHKNOTFOUND, RO, "authknotfound" }, /* 53 */
391 { CS_AUTHKUNCACHED, RO, "authkuncached" }, /* 54 */
392 { CS_AUTHKEXPIRED, RO, "authkexpired" }, /* 55 */
393 { CS_AUTHENCRYPTS, RO, "authencrypts" }, /* 56 */
394 { CS_AUTHDECRYPTS, RO, "authdecrypts" }, /* 57 */
395 { CS_AUTHRESET, RO, "authreset" }, /* 58 */
396 { CS_K_OFFSET, RO, "koffset" }, /* 59 */
397 { CS_K_FREQ, RO, "kfreq" }, /* 60 */
398 { CS_K_MAXERR, RO, "kmaxerr" }, /* 61 */
399 { CS_K_ESTERR, RO, "kesterr" }, /* 62 */
400 { CS_K_STFLAGS, RO, "kstflags" }, /* 63 */
401 { CS_K_TIMECONST, RO, "ktimeconst" }, /* 64 */
402 { CS_K_PRECISION, RO, "kprecis" }, /* 65 */
403 { CS_K_FREQTOL, RO, "kfreqtol" }, /* 66 */
404 { CS_K_PPS_FREQ, RO, "kppsfreq" }, /* 67 */
405 { CS_K_PPS_STABIL, RO, "kppsstab" }, /* 68 */
406 { CS_K_PPS_JITTER, RO, "kppsjitter" }, /* 69 */
407 { CS_K_PPS_CALIBDUR, RO, "kppscalibdur" }, /* 70 */
408 { CS_K_PPS_CALIBS, RO, "kppscalibs" }, /* 71 */
409 { CS_K_PPS_CALIBERRS, RO, "kppscaliberrs" }, /* 72 */
410 { CS_K_PPS_JITEXC, RO, "kppsjitexc" }, /* 73 */
411 { CS_K_PPS_STBEXC, RO, "kppsstbexc" }, /* 74 */
412 { CS_IOSTATS_RESET, RO, "iostats_reset" }, /* 75 */
413 { CS_TOTAL_RBUF, RO, "total_rbuf" }, /* 76 */
414 { CS_FREE_RBUF, RO, "free_rbuf" }, /* 77 */
415 { CS_USED_RBUF, RO, "used_rbuf" }, /* 78 */
416 { CS_RBUF_LOWATER, RO, "rbuf_lowater" }, /* 79 */
417 { CS_IO_DROPPED, RO, "io_dropped" }, /* 80 */
418 { CS_IO_IGNORED, RO, "io_ignored" }, /* 81 */
419 { CS_IO_RECEIVED, RO, "io_received" }, /* 82 */
420 { CS_IO_SENT, RO, "io_sent" }, /* 83 */
421 { CS_IO_SENDFAILED, RO, "io_sendfailed" }, /* 84 */
422 { CS_IO_WAKEUPS, RO, "io_wakeups" }, /* 85 */
423 { CS_IO_GOODWAKEUPS, RO, "io_goodwakeups" }, /* 86 */
424 { CS_TIMERSTATS_RESET, RO, "timerstats_reset" },/* 87 */
425 { CS_TIMER_OVERRUNS, RO, "timer_overruns" }, /* 88 */
426 { CS_TIMER_XMTS, RO, "timer_xmts" }, /* 89 */
427 { CS_FUZZ, RO, "fuzz" }, /* 90 */
428 { CS_WANDER_THRESH, RO, "clk_wander_threshold" }, /* 91 */
430 { CS_LEAPSMEARINTV, RO, "leapsmearinterval" }, /* 92 */
431 { CS_LEAPSMEAROFFS, RO, "leapsmearoffset" }, /* 93 */
434 { CS_FLAGS, RO, "flags" }, /* 1 + CS_MAX_NOAUTOKEY */
435 { CS_HOST, RO, "host" }, /* 2 + CS_MAX_NOAUTOKEY */
436 { CS_PUBLIC, RO, "update" }, /* 3 + CS_MAX_NOAUTOKEY */
437 { CS_CERTIF, RO, "cert" }, /* 4 + CS_MAX_NOAUTOKEY */
438 { CS_SIGNATURE, RO, "signature" }, /* 5 + CS_MAX_NOAUTOKEY */
439 { CS_REVTIME, RO, "until" }, /* 6 + CS_MAX_NOAUTOKEY */
440 { CS_IDENT, RO, "ident" }, /* 7 + CS_MAX_NOAUTOKEY */
441 { CS_DIGEST, RO, "digest" }, /* 8 + CS_MAX_NOAUTOKEY */
443 { 0, EOV, "" } /* 94/102 */
446 static struct ctl_var *ext_sys_var = NULL;
449 * System variables we print by default (in fuzzball order,
452 static const u_char def_sys_var[] = {
493 static const struct ctl_var peer_var[] = {
494 { 0, PADDING, "" }, /* 0 */
495 { CP_CONFIG, RO, "config" }, /* 1 */
496 { CP_AUTHENABLE, RO, "authenable" }, /* 2 */
497 { CP_AUTHENTIC, RO, "authentic" }, /* 3 */
498 { CP_SRCADR, RO, "srcadr" }, /* 4 */
499 { CP_SRCPORT, RO, "srcport" }, /* 5 */
500 { CP_DSTADR, RO, "dstadr" }, /* 6 */
501 { CP_DSTPORT, RO, "dstport" }, /* 7 */
502 { CP_LEAP, RO, "leap" }, /* 8 */
503 { CP_HMODE, RO, "hmode" }, /* 9 */
504 { CP_STRATUM, RO, "stratum" }, /* 10 */
505 { CP_PPOLL, RO, "ppoll" }, /* 11 */
506 { CP_HPOLL, RO, "hpoll" }, /* 12 */
507 { CP_PRECISION, RO, "precision" }, /* 13 */
508 { CP_ROOTDELAY, RO, "rootdelay" }, /* 14 */
509 { CP_ROOTDISPERSION, RO, "rootdisp" }, /* 15 */
510 { CP_REFID, RO, "refid" }, /* 16 */
511 { CP_REFTIME, RO, "reftime" }, /* 17 */
512 { CP_ORG, RO, "org" }, /* 18 */
513 { CP_REC, RO, "rec" }, /* 19 */
514 { CP_XMT, RO, "xleave" }, /* 20 */
515 { CP_REACH, RO, "reach" }, /* 21 */
516 { CP_UNREACH, RO, "unreach" }, /* 22 */
517 { CP_TIMER, RO, "timer" }, /* 23 */
518 { CP_DELAY, RO, "delay" }, /* 24 */
519 { CP_OFFSET, RO, "offset" }, /* 25 */
520 { CP_JITTER, RO, "jitter" }, /* 26 */
521 { CP_DISPERSION, RO, "dispersion" }, /* 27 */
522 { CP_KEYID, RO, "keyid" }, /* 28 */
523 { CP_FILTDELAY, RO, "filtdelay" }, /* 29 */
524 { CP_FILTOFFSET, RO, "filtoffset" }, /* 30 */
525 { CP_PMODE, RO, "pmode" }, /* 31 */
526 { CP_RECEIVED, RO, "received"}, /* 32 */
527 { CP_SENT, RO, "sent" }, /* 33 */
528 { CP_FILTERROR, RO, "filtdisp" }, /* 34 */
529 { CP_FLASH, RO, "flash" }, /* 35 */
530 { CP_TTL, RO, "ttl" }, /* 36 */
531 { CP_VARLIST, RO, "peer_var_list" }, /* 37 */
532 { CP_IN, RO, "in" }, /* 38 */
533 { CP_OUT, RO, "out" }, /* 39 */
534 { CP_RATE, RO, "headway" }, /* 40 */
535 { CP_BIAS, RO, "bias" }, /* 41 */
536 { CP_SRCHOST, RO, "srchost" }, /* 42 */
537 { CP_TIMEREC, RO, "timerec" }, /* 43 */
538 { CP_TIMEREACH, RO, "timereach" }, /* 44 */
539 { CP_BADAUTH, RO, "badauth" }, /* 45 */
540 { CP_BOGUSORG, RO, "bogusorg" }, /* 46 */
541 { CP_OLDPKT, RO, "oldpkt" }, /* 47 */
542 { CP_SELDISP, RO, "seldisp" }, /* 48 */
543 { CP_SELBROKEN, RO, "selbroken" }, /* 49 */
544 { CP_CANDIDATE, RO, "candidate" }, /* 50 */
546 { CP_FLAGS, RO, "flags" }, /* 1 + CP_MAX_NOAUTOKEY */
547 { CP_HOST, RO, "host" }, /* 2 + CP_MAX_NOAUTOKEY */
548 { CP_VALID, RO, "valid" }, /* 3 + CP_MAX_NOAUTOKEY */
549 { CP_INITSEQ, RO, "initsequence" }, /* 4 + CP_MAX_NOAUTOKEY */
550 { CP_INITKEY, RO, "initkey" }, /* 5 + CP_MAX_NOAUTOKEY */
551 { CP_INITTSP, RO, "timestamp" }, /* 6 + CP_MAX_NOAUTOKEY */
552 { CP_SIGNATURE, RO, "signature" }, /* 7 + CP_MAX_NOAUTOKEY */
553 { CP_IDENT, RO, "ident" }, /* 8 + CP_MAX_NOAUTOKEY */
555 { 0, EOV, "" } /* 50/58 */
560 * Peer variables we print by default
562 static const u_char def_peer_var[] = {
611 * Clock variable list
613 static const struct ctl_var clock_var[] = {
614 { 0, PADDING, "" }, /* 0 */
615 { CC_TYPE, RO, "type" }, /* 1 */
616 { CC_TIMECODE, RO, "timecode" }, /* 2 */
617 { CC_POLL, RO, "poll" }, /* 3 */
618 { CC_NOREPLY, RO, "noreply" }, /* 4 */
619 { CC_BADFORMAT, RO, "badformat" }, /* 5 */
620 { CC_BADDATA, RO, "baddata" }, /* 6 */
621 { CC_FUDGETIME1, RO, "fudgetime1" }, /* 7 */
622 { CC_FUDGETIME2, RO, "fudgetime2" }, /* 8 */
623 { CC_FUDGEVAL1, RO, "stratum" }, /* 9 */
624 { CC_FUDGEVAL2, RO, "refid" }, /* 10 */
625 { CC_FLAGS, RO, "flags" }, /* 11 */
626 { CC_DEVICE, RO, "device" }, /* 12 */
627 { CC_VARLIST, RO, "clock_var_list" }, /* 13 */
628 { 0, EOV, "" } /* 14 */
633 * Clock variables printed by default
635 static const u_char def_clock_var[] = {
637 CC_TYPE, /* won't be output if device = known */
653 * MRU string constants shared by send_mru_entry() and read_mru_list().
655 static const char addr_fmt[] = "addr.%d";
656 static const char last_fmt[] = "last.%d";
659 * System and processor definitions.
663 # define STR_SYSTEM "UNIX"
665 # ifndef STR_PROCESSOR
666 # define STR_PROCESSOR "unknown"
669 static const char str_system[] = STR_SYSTEM;
670 static const char str_processor[] = STR_PROCESSOR;
672 # include <sys/utsname.h>
673 static struct utsname utsnamebuf;
674 #endif /* HAVE_UNAME */
677 * Trap structures. We only allow a few of these, and send a copy of
678 * each async message to each live one. Traps time out after an hour, it
679 * is up to the trap receipient to keep resetting it to avoid being
683 struct ctl_trap ctl_traps[CTL_MAXTRAPS];
687 * Type bits, for ctlsettrap() call.
689 #define TRAP_TYPE_CONFIG 0 /* used by configuration code */
690 #define TRAP_TYPE_PRIO 1 /* priority trap */
691 #define TRAP_TYPE_NONPRIO 2 /* nonpriority trap */
695 * List relating reference clock types to control message time sources.
696 * Index by the reference clock type. This list will only be used iff
697 * the reference clock driver doesn't set peer->sstclktype to something
698 * different than CTL_SST_TS_UNSPEC.
701 static const u_char clocktypes[] = {
702 CTL_SST_TS_NTP, /* REFCLK_NONE (0) */
703 CTL_SST_TS_LOCAL, /* REFCLK_LOCALCLOCK (1) */
704 CTL_SST_TS_UHF, /* deprecated REFCLK_GPS_TRAK (2) */
705 CTL_SST_TS_HF, /* REFCLK_WWV_PST (3) */
706 CTL_SST_TS_LF, /* REFCLK_WWVB_SPECTRACOM (4) */
707 CTL_SST_TS_UHF, /* REFCLK_TRUETIME (5) */
708 CTL_SST_TS_UHF, /* REFCLK_IRIG_AUDIO (6) */
709 CTL_SST_TS_HF, /* REFCLK_CHU (7) */
710 CTL_SST_TS_LF, /* REFCLOCK_PARSE (default) (8) */
711 CTL_SST_TS_LF, /* REFCLK_GPS_MX4200 (9) */
712 CTL_SST_TS_UHF, /* REFCLK_GPS_AS2201 (10) */
713 CTL_SST_TS_UHF, /* REFCLK_GPS_ARBITER (11) */
714 CTL_SST_TS_UHF, /* REFCLK_IRIG_TPRO (12) */
715 CTL_SST_TS_ATOM, /* REFCLK_ATOM_LEITCH (13) */
716 CTL_SST_TS_LF, /* deprecated REFCLK_MSF_EES (14) */
717 CTL_SST_TS_NTP, /* not used (15) */
718 CTL_SST_TS_UHF, /* REFCLK_IRIG_BANCOMM (16) */
719 CTL_SST_TS_UHF, /* REFCLK_GPS_DATU (17) */
720 CTL_SST_TS_TELEPHONE, /* REFCLK_NIST_ACTS (18) */
721 CTL_SST_TS_HF, /* REFCLK_WWV_HEATH (19) */
722 CTL_SST_TS_UHF, /* REFCLK_GPS_NMEA (20) */
723 CTL_SST_TS_UHF, /* REFCLK_GPS_VME (21) */
724 CTL_SST_TS_ATOM, /* REFCLK_ATOM_PPS (22) */
725 CTL_SST_TS_NTP, /* not used (23) */
726 CTL_SST_TS_NTP, /* not used (24) */
727 CTL_SST_TS_NTP, /* not used (25) */
728 CTL_SST_TS_UHF, /* REFCLK_GPS_HP (26) */
729 CTL_SST_TS_LF, /* REFCLK_ARCRON_MSF (27) */
730 CTL_SST_TS_UHF, /* REFCLK_SHM (28) */
731 CTL_SST_TS_UHF, /* REFCLK_PALISADE (29) */
732 CTL_SST_TS_UHF, /* REFCLK_ONCORE (30) */
733 CTL_SST_TS_UHF, /* REFCLK_JUPITER (31) */
734 CTL_SST_TS_LF, /* REFCLK_CHRONOLOG (32) */
735 CTL_SST_TS_LF, /* REFCLK_DUMBCLOCK (33) */
736 CTL_SST_TS_LF, /* REFCLK_ULINK (34) */
737 CTL_SST_TS_LF, /* REFCLK_PCF (35) */
738 CTL_SST_TS_HF, /* REFCLK_WWV (36) */
739 CTL_SST_TS_LF, /* REFCLK_FG (37) */
740 CTL_SST_TS_UHF, /* REFCLK_HOPF_SERIAL (38) */
741 CTL_SST_TS_UHF, /* REFCLK_HOPF_PCI (39) */
742 CTL_SST_TS_LF, /* REFCLK_JJY (40) */
743 CTL_SST_TS_UHF, /* REFCLK_TT560 (41) */
744 CTL_SST_TS_UHF, /* REFCLK_ZYFER (42) */
745 CTL_SST_TS_UHF, /* REFCLK_RIPENCC (43) */
746 CTL_SST_TS_UHF, /* REFCLK_NEOCLOCK4X (44) */
747 CTL_SST_TS_UHF, /* REFCLK_TSYNCPCI (45) */
748 CTL_SST_TS_UHF /* REFCLK_GPSDJSON (46) */
750 #endif /* REFCLOCK */
754 * Keyid used for authenticating write requests.
756 keyid_t ctl_auth_keyid;
759 * We keep track of the last error reported by the system internally
761 static u_char ctl_sys_last_event;
762 static u_char ctl_sys_num_events;
766 * Statistic counters to keep track of requests and responses.
768 u_long ctltimereset; /* time stats reset */
769 u_long numctlreq; /* number of requests we've received */
770 u_long numctlbadpkts; /* number of bad control packets */
771 u_long numctlresponses; /* number of resp packets sent with data */
772 u_long numctlfrags; /* number of fragments sent */
773 u_long numctlerrors; /* number of error responses sent */
774 u_long numctltooshort; /* number of too short input packets */
775 u_long numctlinputresp; /* number of responses on input */
776 u_long numctlinputfrag; /* number of fragments on input */
777 u_long numctlinputerr; /* number of input pkts with err bit set */
778 u_long numctlbadoffset; /* number of input pkts with nonzero offset */
779 u_long numctlbadversion; /* number of input pkts with unknown version */
780 u_long numctldatatooshort; /* data too short for count */
781 u_long numctlbadop; /* bad op code found in packet */
782 u_long numasyncmsgs; /* number of async messages we've sent */
785 * Response packet used by these routines. Also some state information
786 * so that we can handle packet formatting within a common set of
787 * subroutines. Note we try to enter data in place whenever possible,
788 * but the need to set the more bit correctly means we occasionally
789 * use the extra buffer and copy.
791 static struct ntp_control rpkt;
792 static u_char res_version;
793 static u_char res_opcode;
794 static associd_t res_associd;
795 static u_short res_frags; /* datagrams in this response */
796 static int res_offset; /* offset of payload in response */
797 static u_char * datapt;
798 static u_char * dataend;
799 static int datalinelen;
800 static int datasent; /* flag to avoid initial ", " */
801 static int datanotbinflag;
802 static sockaddr_u *rmt_addr;
803 static struct interface *lcl_inter;
805 static u_char res_authenticate;
806 static u_char res_authokay;
807 static keyid_t res_keyid;
809 #define MAXDATALINELEN (72)
811 static u_char res_async; /* sending async trap response? */
814 * Pointers for saving state when decoding request packets
820 #define MIN(a, b) (((a) <= (b)) ? (a) : (b))
824 * init_control - initialize request data
833 #endif /* HAVE_UNAME */
838 ctl_sys_last_event = EVNT_UNSPEC;
839 ctl_sys_num_events = 0;
842 for (i = 0; i < COUNTOF(ctl_traps); i++)
843 ctl_traps[i].tr_flags = 0;
848 * ctl_error - send an error response for the current request
858 DPRINTF(3, ("sending control error %u\n", errcode));
861 * Fill in the fields. We assume rpkt.sequence and rpkt.associd
862 * have already been filled in.
864 rpkt.r_m_e_op = (u_char)CTL_RESPONSE | CTL_ERROR |
865 (res_opcode & CTL_OP_MASK);
866 rpkt.status = htons((u_short)(errcode << 8) & 0xff00);
870 * send packet and bump counters
872 if (res_authenticate && sys_authenticate) {
873 maclen = authencrypt(res_keyid, (u_int32 *)&rpkt,
875 sendpkt(rmt_addr, lcl_inter, -2, (void *)&rpkt,
876 CTL_HEADER_LEN + maclen);
878 sendpkt(rmt_addr, lcl_inter, -3, (void *)&rpkt,
883 is_safe_filename(const char * name)
885 /* We need a strict validation of filenames we should write: The
886 * daemon might run with special permissions and is remote
887 * controllable, so we better take care what we allow as file
890 * The first character must be digit or a letter from the ASCII
891 * base plane or a '_' ([_A-Za-z0-9]), the following characters
892 * must be from [-._+A-Za-z0-9].
894 * We do not trust the character classification much here: Since
895 * the NTP protocol makes no provisions for UTF-8 or local code
896 * pages, we strictly require the 7bit ASCII code page.
898 * The following table is a packed bit field of 128 two-bit
899 * groups. The LSB in each group tells us if a character is
900 * acceptable at the first position, the MSB if the character is
901 * accepted at any other position.
903 * This does not ensure that the file name is syntactically
904 * correct (multiple dots will not work with VMS...) but it will
905 * exclude potential globbing bombs and directory traversal. It
906 * also rules out drive selection. (For systems that have this
907 * notion, like Windows or VMS.)
909 static const uint32_t chclass[8] = {
910 0x00000000, 0x00000000,
911 0x28800000, 0x000FFFFF,
912 0xFFFFFFFC, 0xC03FFFFF,
913 0xFFFFFFFC, 0x003FFFFF
916 u_int widx, bidx, mask;
917 if ( ! (name && *name))
921 while (0 != (widx = (u_char)*name++)) {
922 bidx = (widx & 15) << 1;
924 if (widx >= sizeof(chclass)/sizeof(chclass[0]))
926 if (0 == ((chclass[widx] >> bidx) & mask))
935 * save_config - Implements ntpq -c "saveconfig <filename>"
936 * Writes current configuration including any runtime
937 * changes by ntpq's :config or config-from-file
939 * Note: There should be no buffer overflow or truncation in the
940 * processing of file names -- both cause security problems. This is bit
941 * painful to code but essential here.
945 struct recvbuf *rbufp,
949 /* block directory traversal by searching for characters that
950 * indicate directory components in a file path.
952 * Conceptually we should be searching for DIRSEP in filename,
953 * however Windows actually recognizes both forward and
954 * backslashes as equivalent directory separators at the API
955 * level. On POSIX systems we could allow '\\' but such
956 * filenames are tricky to manipulate from a shell, so just
957 * reject both types of slashes on all platforms.
959 /* TALOS-CAN-0062: block directory traversal for VMS, too */
960 static const char * illegal_in_filename =
962 ":[]" /* do not allow drive and path components here */
963 #elif defined(SYS_WINNT)
964 ":\\/" /* path and drive separators */
966 "\\/" /* separator and critical char for POSIX */
971 static const char savedconfig_eq[] = "savedconfig=";
973 /* Build a safe open mode from the available mode flags. We want
974 * to create a new file and write it in text mode (when
975 * applicable -- only Windows does this...)
977 static const int openmode = O_CREAT | O_TRUNC | O_WRONLY
978 # if defined(O_EXCL) /* posix, vms */
980 # elif defined(_O_EXCL) /* windows is alway very special... */
983 # if defined(_O_TEXT) /* windows, again */
991 char savedconfig[sizeof(savedconfig_eq) + sizeof(filename)];
999 if (RES_NOMODIFY & restrict_mask) {
1000 ctl_printf("%s", "saveconfig prohibited by restrict ... nomodify");
1004 "saveconfig from %s rejected due to nomodify restriction",
1005 stoa(&rbufp->recv_srcadr));
1011 if (NULL == saveconfigdir) {
1012 ctl_printf("%s", "saveconfig prohibited, no saveconfigdir configured");
1016 "saveconfig from %s rejected, no saveconfigdir",
1017 stoa(&rbufp->recv_srcadr));
1021 /* The length checking stuff gets serious. Do not assume a NUL
1022 * byte can be found, but if so, use it to calculate the needed
1023 * buffer size. If the available buffer is too short, bail out;
1024 * likewise if there is no file spec. (The latter will not
1025 * happen when using NTPQ, but there are other ways to craft a
1028 reqlen = (size_t)(reqend - reqpt);
1030 char * nulpos = (char*)memchr(reqpt, 0, reqlen);
1032 reqlen = (size_t)(nulpos - reqpt);
1036 if (reqlen >= sizeof(filespec)) {
1037 ctl_printf("saveconfig exceeded maximum raw name length (%u)",
1038 (u_int)sizeof(filespec));
1041 "saveconfig exceeded maximum raw name length from %s",
1042 stoa(&rbufp->recv_srcadr));
1046 /* copy data directly as we exactly know the size */
1047 memcpy(filespec, reqpt, reqlen);
1048 filespec[reqlen] = '\0';
1051 * allow timestamping of the saved config filename with
1052 * strftime() format such as:
1053 * ntpq -c "saveconfig ntp-%Y%m%d-%H%M%S.conf"
1054 * XXX: Nice feature, but not too safe.
1055 * YYY: The check for permitted characters in file names should
1056 * weed out the worst. Let's hope 'strftime()' does not
1057 * develop pathological problems.
1060 if (0 == strftime(filename, sizeof(filename), filespec,
1064 * If we arrive here, 'strftime()' balked; most likely
1065 * the buffer was too short. (Or it encounterd an empty
1066 * format, or just a format that expands to an empty
1067 * string.) We try to use the original name, though this
1068 * is very likely to fail later if there are format
1069 * specs in the string. Note that truncation cannot
1070 * happen here as long as both buffers have the same
1073 strlcpy(filename, filespec, sizeof(filename));
1077 * Check the file name for sanity. This might/will rule out file
1078 * names that would be legal but problematic, and it blocks
1079 * directory traversal.
1081 if (!is_safe_filename(filename)) {
1082 ctl_printf("saveconfig rejects unsafe file name '%s'",
1086 "saveconfig rejects unsafe file name from %s",
1087 stoa(&rbufp->recv_srcadr));
1092 * XXX: This next test may not be needed with is_safe_filename()
1095 /* block directory/drive traversal */
1096 /* TALOS-CAN-0062: block directory traversal for VMS, too */
1097 if (NULL != strpbrk(filename, illegal_in_filename)) {
1098 snprintf(reply, sizeof(reply),
1099 "saveconfig does not allow directory in filename");
1100 ctl_putdata(reply, strlen(reply), 0);
1103 "saveconfig rejects unsafe file name from %s",
1104 stoa(&rbufp->recv_srcadr));
1108 /* concatenation of directory and path can cause another
1111 prc = snprintf(fullpath, sizeof(fullpath), "%s%s",
1112 saveconfigdir, filename);
1113 if (prc < 0 || prc >= sizeof(fullpath)) {
1114 ctl_printf("saveconfig exceeded maximum path length (%u)",
1115 (u_int)sizeof(fullpath));
1118 "saveconfig exceeded maximum path length from %s",
1119 stoa(&rbufp->recv_srcadr));
1123 fd = open(fullpath, openmode, S_IRUSR | S_IWUSR);
1127 fptr = fdopen(fd, "w");
1129 if (NULL == fptr || -1 == dump_all_config_trees(fptr, 1)) {
1130 ctl_printf("Unable to save configuration to file '%s': %m",
1133 "saveconfig %s from %s failed", filename,
1134 stoa(&rbufp->recv_srcadr));
1136 ctl_printf("Configuration saved to '%s'", filename);
1138 "Configuration saved to '%s' (requested by %s)",
1139 fullpath, stoa(&rbufp->recv_srcadr));
1141 * save the output filename in system variable
1142 * savedconfig, retrieved with:
1143 * ntpq -c "rv 0 savedconfig"
1144 * Note: the way 'savedconfig' is defined makes overflow
1145 * checks unnecessary here.
1147 snprintf(savedconfig, sizeof(savedconfig), "%s%s",
1148 savedconfig_eq, filename);
1149 set_sys_var(savedconfig, strlen(savedconfig) + 1, RO);
1154 #else /* !SAVECONFIG follows */
1156 "saveconfig unavailable, configured with --disable-saveconfig");
1163 * process_control - process an incoming control message
1167 struct recvbuf *rbufp,
1171 struct ntp_control *pkt;
1174 const struct ctl_proc *cc;
1179 DPRINTF(3, ("in process_control()\n"));
1182 * Save the addresses for error responses
1185 rmt_addr = &rbufp->recv_srcadr;
1186 lcl_inter = rbufp->dstadr;
1187 pkt = (struct ntp_control *)&rbufp->recv_pkt;
1190 * If the length is less than required for the header, or
1191 * it is a response or a fragment, ignore this.
1193 if (rbufp->recv_length < (int)CTL_HEADER_LEN
1194 || (CTL_RESPONSE | CTL_MORE | CTL_ERROR) & pkt->r_m_e_op
1195 || pkt->offset != 0) {
1196 DPRINTF(1, ("invalid format in control packet\n"));
1197 if (rbufp->recv_length < (int)CTL_HEADER_LEN)
1199 if (CTL_RESPONSE & pkt->r_m_e_op)
1201 if (CTL_MORE & pkt->r_m_e_op)
1203 if (CTL_ERROR & pkt->r_m_e_op)
1205 if (pkt->offset != 0)
1209 res_version = PKT_VERSION(pkt->li_vn_mode);
1210 if (res_version > NTP_VERSION || res_version < NTP_OLDVERSION) {
1211 DPRINTF(1, ("unknown version %d in control packet\n",
1218 * Pull enough data from the packet to make intelligent
1221 rpkt.li_vn_mode = PKT_LI_VN_MODE(sys_leap, res_version,
1223 res_opcode = pkt->r_m_e_op;
1224 rpkt.sequence = pkt->sequence;
1225 rpkt.associd = pkt->associd;
1229 res_associd = htons(pkt->associd);
1231 res_authenticate = FALSE;
1233 res_authokay = FALSE;
1234 req_count = (int)ntohs(pkt->count);
1235 datanotbinflag = FALSE;
1238 datapt = rpkt.u.data;
1239 dataend = &rpkt.u.data[CTL_MAX_DATA_LEN];
1241 if ((rbufp->recv_length & 0x3) != 0)
1242 DPRINTF(3, ("Control packet length %d unrounded\n",
1243 rbufp->recv_length));
1246 * We're set up now. Make sure we've got at least enough
1247 * incoming data space to match the count.
1249 req_data = rbufp->recv_length - CTL_HEADER_LEN;
1250 if (req_data < req_count || rbufp->recv_length & 0x3) {
1251 ctl_error(CERR_BADFMT);
1252 numctldatatooshort++;
1256 properlen = req_count + CTL_HEADER_LEN;
1257 /* round up proper len to a 8 octet boundary */
1259 properlen = (properlen + 7) & ~7;
1260 maclen = rbufp->recv_length - properlen;
1261 if ((rbufp->recv_length & 3) == 0 &&
1262 maclen >= MIN_MAC_LEN && maclen <= MAX_MAC_LEN &&
1264 res_authenticate = TRUE;
1265 pkid = (void *)((char *)pkt + properlen);
1266 res_keyid = ntohl(*pkid);
1267 DPRINTF(3, ("recv_len %d, properlen %d, wants auth with keyid %08x, MAC length=%zu\n",
1268 rbufp->recv_length, properlen, res_keyid,
1271 if (!authistrustedip(res_keyid, &rbufp->recv_srcadr))
1272 DPRINTF(3, ("invalid keyid %08x\n", res_keyid));
1273 else if (authdecrypt(res_keyid, (u_int32 *)pkt,
1274 rbufp->recv_length - maclen,
1276 res_authokay = TRUE;
1277 DPRINTF(3, ("authenticated okay\n"));
1280 DPRINTF(3, ("authentication failed\n"));
1285 * Set up translate pointers
1287 reqpt = (char *)pkt->u.data;
1288 reqend = reqpt + req_count;
1291 * Look for the opcode processor
1293 for (cc = control_codes; cc->control_code != NO_REQUEST; cc++) {
1294 if (cc->control_code == res_opcode) {
1295 DPRINTF(3, ("opcode %d, found command handler\n",
1297 if (cc->flags == AUTH
1299 || res_keyid != ctl_auth_keyid)) {
1300 ctl_error(CERR_PERMISSION);
1303 (cc->handler)(rbufp, restrict_mask);
1309 * Can't find this one, return an error.
1312 ctl_error(CERR_BADOP);
1318 * ctlpeerstatus - return a status word for this peer
1322 register struct peer *p
1328 if (FLAG_CONFIG & p->flags)
1329 status |= CTL_PST_CONFIG;
1331 status |= CTL_PST_AUTHENABLE;
1332 if (FLAG_AUTHENTIC & p->flags)
1333 status |= CTL_PST_AUTHENTIC;
1335 status |= CTL_PST_REACH;
1336 if (MDF_TXONLY_MASK & p->cast_flags)
1337 status |= CTL_PST_BCAST;
1339 return CTL_PEER_STATUS(status, p->num_events, p->last_event);
1344 * ctlclkstatus - return a status word for this clock
1349 struct refclockstat *pcs
1352 return CTL_PEER_STATUS(0, pcs->lastevent, pcs->currentstatus);
1358 * ctlsysstatus - return the system status word
1363 register u_char this_clock;
1365 this_clock = CTL_SST_TS_UNSPEC;
1367 if (sys_peer != NULL) {
1368 if (CTL_SST_TS_UNSPEC != sys_peer->sstclktype)
1369 this_clock = sys_peer->sstclktype;
1370 else if (sys_peer->refclktype < COUNTOF(clocktypes))
1371 this_clock = clocktypes[sys_peer->refclktype];
1373 #else /* REFCLOCK */
1375 this_clock = CTL_SST_TS_NTP;
1376 #endif /* REFCLOCK */
1377 return CTL_SYS_STATUS(sys_leap, this_clock, ctl_sys_num_events,
1378 ctl_sys_last_event);
1383 * ctl_flushpkt - write out the current packet and prepare
1384 * another if necessary.
1398 dlen = datapt - rpkt.u.data;
1399 if (!more && datanotbinflag && dlen + 2 < CTL_MAX_DATA_LEN) {
1401 * Big hack, output a trailing \r\n
1407 sendlen = dlen + CTL_HEADER_LEN;
1410 * Pad to a multiple of 32 bits
1412 while (sendlen & 0x3) {
1418 * Fill in the packet with the current info
1420 rpkt.r_m_e_op = CTL_RESPONSE | more |
1421 (res_opcode & CTL_OP_MASK);
1422 rpkt.count = htons((u_short)dlen);
1423 rpkt.offset = htons((u_short)res_offset);
1425 for (i = 0; i < COUNTOF(ctl_traps); i++) {
1426 if (TRAP_INUSE & ctl_traps[i].tr_flags) {
1430 ctl_traps[i].tr_version,
1433 htons(ctl_traps[i].tr_sequence);
1434 sendpkt(&ctl_traps[i].tr_addr,
1435 ctl_traps[i].tr_localaddr, -4,
1436 (struct pkt *)&rpkt, sendlen);
1438 ctl_traps[i].tr_sequence++;
1443 if (res_authenticate && sys_authenticate) {
1446 * If we are going to authenticate, then there
1447 * is an additional requirement that the MAC
1448 * begin on a 64 bit boundary.
1450 while (totlen & 7) {
1454 keyid = htonl(res_keyid);
1455 memcpy(datapt, &keyid, sizeof(keyid));
1456 maclen = authencrypt(res_keyid,
1457 (u_int32 *)&rpkt, totlen);
1458 sendpkt(rmt_addr, lcl_inter, -5,
1459 (struct pkt *)&rpkt, totlen + maclen);
1461 sendpkt(rmt_addr, lcl_inter, -6,
1462 (struct pkt *)&rpkt, sendlen);
1471 * Set us up for another go around.
1475 datapt = rpkt.u.data;
1479 /* --------------------------------------------------------------------
1480 * block transfer API -- stream string/data fragments into xmit buffer
1481 * without additional copying
1484 /* buffer descriptor: address & size of fragment
1485 * 'buf' may only be NULL when 'len' is zero!
1492 /* put ctl data in a gather-style operation */
1495 const CtlMemBufT * argv,
1497 int/*BOOL*/ bin /* set to 1 when data is binary */
1500 const char * src_ptr;
1501 size_t src_len, cur_len, add_len, argi;
1503 /* text / binary preprocessing, possibly create new linefeed */
1507 datanotbinflag = TRUE;
1514 /* sum up total length */
1515 for (argi = 0, src_len = 0; argi < argc; ++argi)
1516 src_len += argv[argi].len;
1517 /* possibly start a new line, assume no size_t overflow */
1518 if ((src_len + datalinelen + 1) >= MAXDATALINELEN) {
1529 /* now stream out all buffers */
1530 for (argi = 0; argi < argc; ++argi) {
1531 src_ptr = argv[argi].buf;
1532 src_len = argv[argi].len;
1534 if ( ! (src_ptr && src_len))
1537 cur_len = (size_t)(dataend - datapt);
1538 while ((src_len + add_len) > cur_len) {
1539 /* Not enough room in this one, flush it out. */
1540 if (src_len < cur_len)
1543 memcpy(datapt, src_ptr, cur_len);
1545 datalinelen += cur_len;
1550 ctl_flushpkt(CTL_MORE);
1551 cur_len = (size_t)(dataend - datapt);
1554 memcpy(datapt, src_ptr, src_len);
1556 datalinelen += src_len;
1563 * ctl_putdata - write data into the packet, fragmenting and starting
1564 * another if this one is full.
1570 int bin /* set to 1 when data is binary */
1577 ctl_putdata_ex(args, 1, bin);
1581 * ctl_putstr - write a tagged string into the response packet
1586 * len is the data length excluding the NUL terminator,
1587 * as in ctl_putstr("var", "value", strlen("value"));
1599 args[0].len = strlen(tag);
1601 args[1].buf = "=\"";
1607 ctl_putdata_ex(args, 4, FALSE);
1609 ctl_putdata_ex(args, 1, FALSE);
1615 * ctl_putunqstr - write a tagged string into the response packet
1620 * len is the data length excluding the NUL terminator.
1621 * data must not contain a comma or whitespace.
1633 args[0].len = strlen(tag);
1639 ctl_putdata_ex(args, 3, FALSE);
1641 ctl_putdata_ex(args, 1, FALSE);
1647 * ctl_putdblf - write a tagged, signed double into the response packet
1660 rc = snprintf(buffer, sizeof(buffer),
1661 (use_f ? "%.*f" : "%.*g"),
1663 INSIST(rc >= 0 && (size_t)rc < sizeof(buffer));
1664 ctl_putunqstr(tag, buffer, rc);
1668 * ctl_putuint - write a tagged unsigned integer into the response
1676 char buffer[24]; /* needs to fit for 64 bits! */
1679 rc = snprintf(buffer, sizeof(buffer), "%lu", uval);
1680 INSIST(rc >= 0 && rc < sizeof(buffer));
1681 ctl_putunqstr(tag, buffer, rc);
1685 * ctl_putcal - write a decoded calendar data into the response.
1686 * only used with AUTOKEY currently, so compiled conditional
1692 const struct calendar *pcal
1698 rc = snprintf(buffer, sizeof(buffer),
1699 "%04d%02d%02d%02d%02d",
1700 pcal->year, pcal->month, pcal->monthday,
1701 pcal->hour, pcal->minute
1703 INSIST(rc >= 0 && (size_t)rc < sizeof(buffer));
1704 ctl_putunqstr(tag, buffer, rc);
1709 * ctl_putfs - write a decoded filestamp into the response
1720 time_t fstamp = (time_t)uval - JAN_1970;
1721 struct tm *tm = gmtime(&fstamp);
1726 rc = snprintf(buffer, sizeof(buffer),
1727 "%04d%02d%02d%02d%02d",
1728 tm->tm_year + 1900, tm->tm_mon + 1, tm->tm_mday,
1729 tm->tm_hour, tm->tm_min);
1730 INSIST(rc >= 0 && (size_t)rc < sizeof(buffer));
1731 ctl_putunqstr(tag, buffer, rc);
1736 * ctl_puthex - write a tagged unsigned integer, in hex, into the
1745 char buffer[24]; /* must fit 64bit int! */
1748 rc = snprintf(buffer, sizeof(buffer), "0x%lx", uval);
1749 INSIST(rc >= 0 && (size_t)rc < sizeof(buffer));
1750 ctl_putunqstr(tag, buffer, rc);
1755 * ctl_putint - write a tagged signed integer into the response
1763 char buffer[24]; /*must fit 64bit int */
1766 rc = snprintf(buffer, sizeof(buffer), "%ld", ival);
1767 INSIST(rc >= 0 && rc < sizeof(buffer));
1768 ctl_putunqstr(tag, buffer, rc);
1773 * ctl_putts - write a tagged timestamp, in hex, into the response
1784 rc = snprintf(buffer, sizeof(buffer),
1786 (u_long)ts->l_ui, (u_long)ts->l_uf);
1787 INSIST(rc >= 0 && (size_t)rc < sizeof(buffer));
1788 ctl_putunqstr(tag, buffer, rc);
1793 * ctl_putadr - write an IP address into the response
1805 cq = numtoa(addr32);
1808 ctl_putunqstr(tag, cq, strlen(cq));
1813 * ctl_putrefid - send a u_int32 refid as printable text
1825 uint8_t b[sizeof(uint32_t)];
1829 for (nc = 0; nc < sizeof(bytes.b) && bytes.b[nc]; ++nc)
1830 if (!isprint(bytes.b[nc]))
1832 ctl_putunqstr(tag, (const char*)bytes.b, nc);
1837 * ctl_putarray - write a tagged eight element double array into the response
1851 ep = buffer + sizeof(buffer);
1857 rc = snprintf(cp, (size_t)(ep - cp), " %.2f", arr[i] * 1e3);
1858 INSIST(rc >= 0 && (size_t)rc < (size_t)(ep - cp));
1860 } while (i != start);
1861 ctl_putunqstr(tag, buffer, (size_t)(cp - buffer));
1865 * ctl_printf - put a formatted string into the data buffer
1873 static const char * ellipsis = "[...]";
1879 rc = vsnprintf(fmtbuf, sizeof(fmtbuf), fmt, va);
1881 if (rc < 0 || rc >= sizeof(fmtbuf))
1882 strcpy(fmtbuf + sizeof(fmtbuf) - strlen(ellipsis) - 1,
1884 ctl_putdata(fmtbuf, strlen(fmtbuf), 0);
1889 * ctl_putsys - output a system variable
1903 struct cert_info *cp;
1904 #endif /* AUTOKEY */
1906 static struct timex ntx;
1907 static u_long ntp_adjtime_time;
1909 static const double to_ms =
1911 1.0e-6; /* nsec to msec */
1913 1.0e-3; /* usec to msec */
1917 * CS_K_* variables depend on up-to-date output of ntp_adjtime()
1919 if (CS_KERN_FIRST <= varid && varid <= CS_KERN_LAST &&
1920 current_time != ntp_adjtime_time) {
1922 if (ntp_adjtime(&ntx) < 0)
1923 msyslog(LOG_ERR, "ntp_adjtime() for mode 6 query failed: %m");
1925 ntp_adjtime_time = current_time;
1927 #endif /* KERNEL_PLL */
1932 ctl_putuint(sys_var[CS_LEAP].text, sys_leap);
1936 ctl_putuint(sys_var[CS_STRATUM].text, sys_stratum);
1940 ctl_putint(sys_var[CS_PRECISION].text, sys_precision);
1944 ctl_putdbl(sys_var[CS_ROOTDELAY].text, sys_rootdelay *
1948 case CS_ROOTDISPERSION:
1949 ctl_putdbl(sys_var[CS_ROOTDISPERSION].text,
1950 sys_rootdisp * 1e3);
1954 if (sys_stratum > 1 && sys_stratum < STRATUM_UNSPEC)
1955 ctl_putadr(sys_var[varid].text, sys_refid, NULL);
1957 ctl_putrefid(sys_var[varid].text, sys_refid);
1961 ctl_putts(sys_var[CS_REFTIME].text, &sys_reftime);
1965 ctl_putuint(sys_var[CS_POLL].text, sys_poll);
1969 if (sys_peer == NULL)
1970 ctl_putuint(sys_var[CS_PEERID].text, 0);
1972 ctl_putuint(sys_var[CS_PEERID].text,
1977 if (sys_peer != NULL && sys_peer->dstadr != NULL)
1978 ss = sptoa(&sys_peer->srcadr);
1981 ctl_putunqstr(sys_var[CS_PEERADR].text, ss, strlen(ss));
1985 u = (sys_peer != NULL)
1988 ctl_putuint(sys_var[CS_PEERMODE].text, u);
1992 ctl_putdbl6(sys_var[CS_OFFSET].text, last_offset * 1e3);
1996 ctl_putdbl(sys_var[CS_DRIFT].text, drift_comp * 1e6);
2000 ctl_putdbl6(sys_var[CS_JITTER].text, sys_jitter * 1e3);
2004 ctl_putdbl(sys_var[CS_ERROR].text, clock_jitter * 1e3);
2009 ctl_putts(sys_var[CS_CLOCK].text, &tmp);
2014 ctl_putstr(sys_var[CS_PROCESSOR].text, str_processor,
2015 sizeof(str_processor) - 1);
2017 ctl_putstr(sys_var[CS_PROCESSOR].text,
2018 utsnamebuf.machine, strlen(utsnamebuf.machine));
2019 #endif /* HAVE_UNAME */
2024 ctl_putstr(sys_var[CS_SYSTEM].text, str_system,
2025 sizeof(str_system) - 1);
2027 snprintf(str, sizeof(str), "%s/%s", utsnamebuf.sysname,
2028 utsnamebuf.release);
2029 ctl_putstr(sys_var[CS_SYSTEM].text, str, strlen(str));
2030 #endif /* HAVE_UNAME */
2034 ctl_putstr(sys_var[CS_VERSION].text, Version,
2039 ctl_putdbl(sys_var[CS_STABIL].text, clock_stability *
2045 char buf[CTL_MAX_DATA_LEN];
2046 //buffPointer, firstElementPointer, buffEndPointer
2047 char *buffp, *buffend;
2051 const struct ctl_var *k;
2054 buffend = buf + sizeof(buf);
2055 if (strlen(sys_var[CS_VARLIST].text) > (sizeof(buf) - 4))
2056 break; /* really long var name */
2058 snprintf(buffp, sizeof(buf), "%s=\"",sys_var[CS_VARLIST].text);
2059 buffp += strlen(buffp);
2060 firstVarName = TRUE;
2061 for (k = sys_var; !(k->flags & EOV); k++) {
2062 if (k->flags & PADDING)
2064 len = strlen(k->text);
2065 if (len + 1 >= buffend - buffp)
2070 firstVarName = FALSE;
2071 memcpy(buffp, k->text, len);
2075 for (k = ext_sys_var; k && !(k->flags & EOV); k++) {
2076 if (k->flags & PADDING)
2078 if (NULL == k->text)
2080 ss1 = strchr(k->text, '=');
2082 len = strlen(k->text);
2084 len = ss1 - k->text;
2085 if (len + 1 >= buffend - buffp)
2089 firstVarName = FALSE;
2091 memcpy(buffp, k->text,(unsigned)len);
2094 if (2 >= buffend - buffp)
2100 ctl_putdata(buf, (unsigned)( buffp - buf ), 0);
2106 ctl_putuint(sys_var[CS_TAI].text, sys_tai);
2111 leap_signature_t lsig;
2112 leapsec_getsig(&lsig);
2114 ctl_putfs(sys_var[CS_LEAPTAB].text, lsig.ttime);
2120 leap_signature_t lsig;
2121 leapsec_getsig(&lsig);
2123 ctl_putfs(sys_var[CS_LEAPEND].text, lsig.etime);
2128 case CS_LEAPSMEARINTV:
2129 if (leap_smear_intv > 0)
2130 ctl_putuint(sys_var[CS_LEAPSMEARINTV].text, leap_smear_intv);
2133 case CS_LEAPSMEAROFFS:
2134 if (leap_smear_intv > 0)
2135 ctl_putdbl(sys_var[CS_LEAPSMEAROFFS].text,
2136 leap_smear.doffset * 1e3);
2138 #endif /* LEAP_SMEAR */
2141 ctl_putuint(sys_var[CS_RATE].text, ntp_minpoll);
2144 case CS_MRU_ENABLED:
2145 ctl_puthex(sys_var[varid].text, mon_enabled);
2149 ctl_putuint(sys_var[varid].text, mru_entries);
2153 kb = mru_entries * (sizeof(mon_entry) / 1024.);
2157 ctl_putuint(sys_var[varid].text, u);
2160 case CS_MRU_DEEPEST:
2161 ctl_putuint(sys_var[varid].text, mru_peakentries);
2164 case CS_MRU_MINDEPTH:
2165 ctl_putuint(sys_var[varid].text, mru_mindepth);
2169 ctl_putint(sys_var[varid].text, mru_maxage);
2172 case CS_MRU_MAXDEPTH:
2173 ctl_putuint(sys_var[varid].text, mru_maxdepth);
2177 kb = mru_maxdepth * (sizeof(mon_entry) / 1024.);
2181 ctl_putuint(sys_var[varid].text, u);
2185 ctl_putuint(sys_var[varid].text, current_time);
2189 ctl_putuint(sys_var[varid].text,
2190 current_time - sys_stattime);
2193 case CS_SS_RECEIVED:
2194 ctl_putuint(sys_var[varid].text, sys_received);
2198 ctl_putuint(sys_var[varid].text, sys_newversion);
2202 ctl_putuint(sys_var[varid].text, sys_oldversion);
2205 case CS_SS_BADFORMAT:
2206 ctl_putuint(sys_var[varid].text, sys_badlength);
2210 ctl_putuint(sys_var[varid].text, sys_badauth);
2213 case CS_SS_DECLINED:
2214 ctl_putuint(sys_var[varid].text, sys_declined);
2217 case CS_SS_RESTRICTED:
2218 ctl_putuint(sys_var[varid].text, sys_restricted);
2222 ctl_putuint(sys_var[varid].text, sys_limitrejected);
2226 ctl_putuint(sys_var[varid].text, sys_lamport);
2229 case CS_SS_TSROUNDING:
2230 ctl_putuint(sys_var[varid].text, sys_tsrounding);
2234 ctl_putuint(sys_var[varid].text, sys_kodsent);
2237 case CS_SS_PROCESSED:
2238 ctl_putuint(sys_var[varid].text, sys_processed);
2242 ctl_putdbl(sys_var[varid].text, sys_bdelay * 1e3);
2246 LFPTOD(&sys_authdelay, dtemp);
2247 ctl_putdbl(sys_var[varid].text, dtemp * 1e3);
2251 ctl_putuint(sys_var[varid].text, authnumkeys);
2255 ctl_putuint(sys_var[varid].text, authnumfreekeys);
2258 case CS_AUTHKLOOKUPS:
2259 ctl_putuint(sys_var[varid].text, authkeylookups);
2262 case CS_AUTHKNOTFOUND:
2263 ctl_putuint(sys_var[varid].text, authkeynotfound);
2266 case CS_AUTHKUNCACHED:
2267 ctl_putuint(sys_var[varid].text, authkeyuncached);
2270 case CS_AUTHKEXPIRED:
2271 ctl_putuint(sys_var[varid].text, authkeyexpired);
2274 case CS_AUTHENCRYPTS:
2275 ctl_putuint(sys_var[varid].text, authencryptions);
2278 case CS_AUTHDECRYPTS:
2279 ctl_putuint(sys_var[varid].text, authdecryptions);
2283 ctl_putuint(sys_var[varid].text,
2284 current_time - auth_timereset);
2288 * CTL_IF_KERNLOOP() puts a zero if the kernel loop is
2289 * unavailable, otherwise calls putfunc with args.
2292 # define CTL_IF_KERNLOOP(putfunc, args) \
2293 ctl_putint(sys_var[varid].text, 0)
2295 # define CTL_IF_KERNLOOP(putfunc, args) \
2300 * CTL_IF_KERNPPS() puts a zero if either the kernel
2301 * loop is unavailable, or kernel hard PPS is not
2302 * active, otherwise calls putfunc with args.
2305 # define CTL_IF_KERNPPS(putfunc, args) \
2306 ctl_putint(sys_var[varid].text, 0)
2308 # define CTL_IF_KERNPPS(putfunc, args) \
2309 if (0 == ntx.shift) \
2310 ctl_putint(sys_var[varid].text, 0); \
2312 putfunc args /* no trailing ; */
2318 (sys_var[varid].text, 0, -1, to_ms * ntx.offset)
2325 (sys_var[varid].text, ntx.freq)
2332 (sys_var[varid].text, 0, 6,
2333 to_ms * ntx.maxerror)
2340 (sys_var[varid].text, 0, 6,
2341 to_ms * ntx.esterror)
2349 ss = k_st_flags(ntx.status);
2351 ctl_putstr(sys_var[varid].text, ss, strlen(ss));
2354 case CS_K_TIMECONST:
2357 (sys_var[varid].text, ntx.constant)
2361 case CS_K_PRECISION:
2364 (sys_var[varid].text, 0, 6,
2365 to_ms * ntx.precision)
2372 (sys_var[varid].text, ntx.tolerance)
2379 (sys_var[varid].text, ntx.ppsfreq)
2383 case CS_K_PPS_STABIL:
2386 (sys_var[varid].text, ntx.stabil)
2390 case CS_K_PPS_JITTER:
2393 (sys_var[varid].text, to_ms * ntx.jitter)
2397 case CS_K_PPS_CALIBDUR:
2400 (sys_var[varid].text, 1 << ntx.shift)
2404 case CS_K_PPS_CALIBS:
2407 (sys_var[varid].text, ntx.calcnt)
2411 case CS_K_PPS_CALIBERRS:
2414 (sys_var[varid].text, ntx.errcnt)
2418 case CS_K_PPS_JITEXC:
2421 (sys_var[varid].text, ntx.jitcnt)
2425 case CS_K_PPS_STBEXC:
2428 (sys_var[varid].text, ntx.stbcnt)
2432 case CS_IOSTATS_RESET:
2433 ctl_putuint(sys_var[varid].text,
2434 current_time - io_timereset);
2438 ctl_putuint(sys_var[varid].text, total_recvbuffs());
2442 ctl_putuint(sys_var[varid].text, free_recvbuffs());
2446 ctl_putuint(sys_var[varid].text, full_recvbuffs());
2449 case CS_RBUF_LOWATER:
2450 ctl_putuint(sys_var[varid].text, lowater_additions());
2454 ctl_putuint(sys_var[varid].text, packets_dropped);
2458 ctl_putuint(sys_var[varid].text, packets_ignored);
2461 case CS_IO_RECEIVED:
2462 ctl_putuint(sys_var[varid].text, packets_received);
2466 ctl_putuint(sys_var[varid].text, packets_sent);
2469 case CS_IO_SENDFAILED:
2470 ctl_putuint(sys_var[varid].text, packets_notsent);
2474 ctl_putuint(sys_var[varid].text, handler_calls);
2477 case CS_IO_GOODWAKEUPS:
2478 ctl_putuint(sys_var[varid].text, handler_pkts);
2481 case CS_TIMERSTATS_RESET:
2482 ctl_putuint(sys_var[varid].text,
2483 current_time - timer_timereset);
2486 case CS_TIMER_OVERRUNS:
2487 ctl_putuint(sys_var[varid].text, alarm_overflow);
2491 ctl_putuint(sys_var[varid].text, timer_xmtcalls);
2495 ctl_putdbl(sys_var[varid].text, sys_fuzz * 1e3);
2497 case CS_WANDER_THRESH:
2498 ctl_putdbl(sys_var[varid].text, wander_threshold * 1e6);
2503 ctl_puthex(sys_var[CS_FLAGS].text,
2509 strlcpy(str, OBJ_nid2ln(crypto_nid),
2511 ctl_putstr(sys_var[CS_DIGEST].text, str,
2520 dp = EVP_get_digestbynid(crypto_flags >> 16);
2521 strlcpy(str, OBJ_nid2ln(EVP_MD_pkey_type(dp)),
2523 ctl_putstr(sys_var[CS_SIGNATURE].text, str,
2529 if (hostval.ptr != NULL)
2530 ctl_putstr(sys_var[CS_HOST].text, hostval.ptr,
2531 strlen(hostval.ptr));
2535 if (sys_ident != NULL)
2536 ctl_putstr(sys_var[CS_IDENT].text, sys_ident,
2541 for (cp = cinfo; cp != NULL; cp = cp->link) {
2542 snprintf(str, sizeof(str), "%s %s 0x%x",
2543 cp->subject, cp->issuer, cp->flags);
2544 ctl_putstr(sys_var[CS_CERTIF].text, str,
2546 ctl_putcal(sys_var[CS_REVTIME].text, &(cp->last));
2551 if (hostval.tstamp != 0)
2552 ctl_putfs(sys_var[CS_PUBLIC].text,
2553 ntohl(hostval.tstamp));
2555 #endif /* AUTOKEY */
2564 * ctl_putpeer - output a peer variable
2572 char buf[CTL_MAX_DATA_LEN];
2577 const struct ctl_var *k;
2582 #endif /* AUTOKEY */
2587 ctl_putuint(peer_var[id].text,
2588 !(FLAG_PREEMPT & p->flags));
2592 ctl_putuint(peer_var[id].text, !(p->keyid));
2596 ctl_putuint(peer_var[id].text,
2597 !!(FLAG_AUTHENTIC & p->flags));
2601 ctl_putadr(peer_var[id].text, 0, &p->srcadr);
2605 ctl_putuint(peer_var[id].text, SRCPORT(&p->srcadr));
2609 if (p->hostname != NULL)
2610 ctl_putstr(peer_var[id].text, p->hostname,
2611 strlen(p->hostname));
2615 ctl_putadr(peer_var[id].text, 0,
2622 ctl_putuint(peer_var[id].text,
2624 ? SRCPORT(&p->dstadr->sin)
2630 ctl_putdbl(peer_var[id].text, p->r21 / 1e3);
2635 ctl_putdbl(peer_var[id].text, p->r34 / 1e3);
2639 ctl_putuint(peer_var[id].text, p->throttle);
2643 ctl_putuint(peer_var[id].text, p->leap);
2647 ctl_putuint(peer_var[id].text, p->hmode);
2651 ctl_putuint(peer_var[id].text, p->stratum);
2655 ctl_putuint(peer_var[id].text, p->ppoll);
2659 ctl_putuint(peer_var[id].text, p->hpoll);
2663 ctl_putint(peer_var[id].text, p->precision);
2667 ctl_putdbl(peer_var[id].text, p->rootdelay * 1e3);
2670 case CP_ROOTDISPERSION:
2671 ctl_putdbl(peer_var[id].text, p->rootdisp * 1e3);
2676 if (p->flags & FLAG_REFCLOCK) {
2677 ctl_putrefid(peer_var[id].text, p->refid);
2681 if (p->stratum > 1 && p->stratum < STRATUM_UNSPEC)
2682 ctl_putadr(peer_var[id].text, p->refid,
2685 ctl_putrefid(peer_var[id].text, p->refid);
2689 ctl_putts(peer_var[id].text, &p->reftime);
2693 ctl_putts(peer_var[id].text, &p->aorg);
2697 ctl_putts(peer_var[id].text, &p->dst);
2702 ctl_putdbl(peer_var[id].text, p->xleave * 1e3);
2707 ctl_putdbl(peer_var[id].text, p->bias * 1e3);
2711 ctl_puthex(peer_var[id].text, p->reach);
2715 ctl_puthex(peer_var[id].text, p->flash);
2720 if (p->flags & FLAG_REFCLOCK) {
2721 ctl_putuint(peer_var[id].text, p->ttl);
2725 if (p->ttl > 0 && p->ttl < COUNTOF(sys_ttl))
2726 ctl_putint(peer_var[id].text,
2731 ctl_putuint(peer_var[id].text, p->unreach);
2735 ctl_putuint(peer_var[id].text,
2736 p->nextdate - current_time);
2740 ctl_putdbl(peer_var[id].text, p->delay * 1e3);
2744 ctl_putdbl(peer_var[id].text, p->offset * 1e3);
2748 ctl_putdbl(peer_var[id].text, p->jitter * 1e3);
2752 ctl_putdbl(peer_var[id].text, p->disp * 1e3);
2756 if (p->keyid > NTP_MAXKEY)
2757 ctl_puthex(peer_var[id].text, p->keyid);
2759 ctl_putuint(peer_var[id].text, p->keyid);
2763 ctl_putarray(peer_var[id].text, p->filter_delay,
2768 ctl_putarray(peer_var[id].text, p->filter_offset,
2773 ctl_putarray(peer_var[id].text, p->filter_disp,
2778 ctl_putuint(peer_var[id].text, p->pmode);
2782 ctl_putuint(peer_var[id].text, p->received);
2786 ctl_putuint(peer_var[id].text, p->sent);
2791 be = buf + sizeof(buf);
2792 if (strlen(peer_var[id].text) + 4 > sizeof(buf))
2793 break; /* really long var name */
2795 snprintf(s, sizeof(buf), "%s=\"", peer_var[id].text);
2798 for (k = peer_var; !(EOV & k->flags); k++) {
2799 if (PADDING & k->flags)
2801 i = strlen(k->text);
2802 if (s + i + 1 >= be)
2806 memcpy(s, k->text, i);
2812 ctl_putdata(buf, (u_int)(s - buf), 0);
2817 ctl_putuint(peer_var[id].text,
2818 current_time - p->timereceived);
2822 ctl_putuint(peer_var[id].text,
2823 current_time - p->timereachable);
2827 ctl_putuint(peer_var[id].text, p->badauth);
2831 ctl_putuint(peer_var[id].text, p->bogusorg);
2835 ctl_putuint(peer_var[id].text, p->oldpkt);
2839 ctl_putuint(peer_var[id].text, p->seldisptoolarge);
2843 ctl_putuint(peer_var[id].text, p->selbroken);
2847 ctl_putuint(peer_var[id].text, p->status);
2852 ctl_puthex(peer_var[id].text, p->crypto);
2857 dp = EVP_get_digestbynid(p->crypto >> 16);
2858 str = OBJ_nid2ln(EVP_MD_pkey_type(dp));
2859 ctl_putstr(peer_var[id].text, str, strlen(str));
2864 if (p->subject != NULL)
2865 ctl_putstr(peer_var[id].text, p->subject,
2866 strlen(p->subject));
2869 case CP_VALID: /* not used */
2873 if (NULL == (ap = p->recval.ptr))
2876 ctl_putint(peer_var[CP_INITSEQ].text, ap->seq);
2877 ctl_puthex(peer_var[CP_INITKEY].text, ap->key);
2878 ctl_putfs(peer_var[CP_INITTSP].text,
2879 ntohl(p->recval.tstamp));
2883 if (p->ident != NULL)
2884 ctl_putstr(peer_var[id].text, p->ident,
2889 #endif /* AUTOKEY */
2896 * ctl_putclock - output clock variables
2901 struct refclockstat *pcs,
2905 char buf[CTL_MAX_DATA_LEN];
2909 const struct ctl_var *k;
2914 if (mustput || pcs->clockdesc == NULL
2915 || *(pcs->clockdesc) == '\0') {
2916 ctl_putuint(clock_var[id].text, pcs->type);
2920 ctl_putstr(clock_var[id].text,
2922 (unsigned)pcs->lencode);
2926 ctl_putuint(clock_var[id].text, pcs->polls);
2930 ctl_putuint(clock_var[id].text,
2935 ctl_putuint(clock_var[id].text,
2940 ctl_putuint(clock_var[id].text,
2945 if (mustput || (pcs->haveflags & CLK_HAVETIME1))
2946 ctl_putdbl(clock_var[id].text,
2947 pcs->fudgetime1 * 1e3);
2951 if (mustput || (pcs->haveflags & CLK_HAVETIME2))
2952 ctl_putdbl(clock_var[id].text,
2953 pcs->fudgetime2 * 1e3);
2957 if (mustput || (pcs->haveflags & CLK_HAVEVAL1))
2958 ctl_putint(clock_var[id].text,
2963 if (mustput || (pcs->haveflags & CLK_HAVEVAL2)) {
2964 if (pcs->fudgeval1 > 1)
2965 ctl_putadr(clock_var[id].text,
2966 pcs->fudgeval2, NULL);
2968 ctl_putrefid(clock_var[id].text,
2974 ctl_putuint(clock_var[id].text, pcs->flags);
2978 if (pcs->clockdesc == NULL ||
2979 *(pcs->clockdesc) == '\0') {
2981 ctl_putstr(clock_var[id].text,
2984 ctl_putstr(clock_var[id].text,
2986 strlen(pcs->clockdesc));
2992 be = buf + sizeof(buf);
2993 if (strlen(clock_var[CC_VARLIST].text) + 4 >
2995 break; /* really long var name */
2997 snprintf(s, sizeof(buf), "%s=\"",
2998 clock_var[CC_VARLIST].text);
3002 for (k = clock_var; !(EOV & k->flags); k++) {
3003 if (PADDING & k->flags)
3006 i = strlen(k->text);
3007 if (s + i + 1 >= be)
3012 memcpy(s, k->text, i);
3016 for (k = pcs->kv_list; k && !(EOV & k->flags); k++) {
3017 if (PADDING & k->flags)
3024 while (*ss && *ss != '=')
3027 if (s + i + 1 >= be)
3032 memcpy(s, k->text, (unsigned)i);
3041 ctl_putdata(buf, (unsigned)(s - buf), 0);
3050 * ctl_getitem - get the next data item from the incoming packet
3052 static const struct ctl_var *
3054 const struct ctl_var *var_list,
3058 /* [Bug 3008] First check the packet data sanity, then search
3059 * the key. This improves the consistency of result values: If
3060 * the result is NULL once, it will never be EOV again for this
3061 * packet; If it's EOV, it will never be NULL again until the
3062 * variable is found and processed in a given 'var_list'. (That
3063 * is, a result is returned that is neither NULL nor EOV).
3065 static const struct ctl_var eol = { 0, EOV, NULL };
3066 static char buf[128];
3067 static u_long quiet_until;
3068 const struct ctl_var *v;
3073 * Part One: Validate the packet state
3076 /* Delete leading commas and white space */
3077 while (reqpt < reqend && (*reqpt == ',' ||
3078 isspace((unsigned char)*reqpt)))
3080 if (reqpt >= reqend)
3083 /* Scan the string in the packet until we hit comma or
3084 * EoB. Register position of first '=' on the fly. */
3085 for (tp = NULL, cp = reqpt; cp != reqend; ++cp) {
3086 if (*cp == '=' && tp == NULL)
3092 /* Process payload, if any. */
3095 /* eventually strip white space from argument. */
3096 const char *plhead = tp + 1; /* skip the '=' */
3097 const char *pltail = cp;
3100 while (plhead != pltail && isspace((u_char)plhead[0]))
3102 while (plhead != pltail && isspace((u_char)pltail[-1]))
3105 /* check payload size, terminate packet on overflow */
3106 plsize = (size_t)(pltail - plhead);
3107 if (plsize >= sizeof(buf))
3110 /* copy data, NUL terminate, and set result data ptr */
3111 memcpy(buf, plhead, plsize);
3115 /* no payload, current end --> current name termination */
3121 * Now we're sure that the packet data itself is sane. Scan the
3122 * list now. Make sure a NULL list is properly treated by
3123 * returning a synthetic End-Of-Values record. We must not
3124 * return NULL pointers after this point, or the behaviour would
3125 * become inconsistent if called several times with different
3126 * variable lists after an EoV was returned. (Such a behavior
3127 * actually caused Bug 3008.)
3130 if (NULL == var_list)
3133 for (v = var_list; !(EOV & v->flags); ++v)
3134 if (!(PADDING & v->flags)) {
3135 /* Check if the var name matches the buffer. The
3136 * name is bracketed by [reqpt..tp] and not NUL
3137 * terminated, and it contains no '=' char. The
3138 * lookup value IS NUL-terminated but might
3139 * include a '='... We have to look out for
3142 const char *sp1 = reqpt;
3143 const char *sp2 = v->text;
3145 /* [Bug 3412] do not compare past NUL byte in name */
3147 && ('\0' != *sp2) && (*sp1 == *sp2)) {
3151 if (sp1 == tp && (*sp2 == '\0' || *sp2 == '='))
3155 /* See if we have found a valid entry or not. If found, advance
3156 * the request pointer for the next round; if not, clear the
3157 * data pointer so we have no dangling garbage here.
3162 reqpt = cp + (cp != reqend);
3166 /*TODO? somehow indicate this packet was bad, apart from syslog? */
3169 if (quiet_until <= current_time) {
3170 quiet_until = current_time + 300;
3171 msyslog(LOG_WARNING,
3172 "Possible 'ntpdx' exploit from %s#%u (possibly spoofed)",
3173 stoa(rmt_addr), SRCPORT(rmt_addr));
3175 reqpt = reqend; /* never again for this packet! */
3181 * control_unspec - response to an unspecified op-code
3186 struct recvbuf *rbufp,
3193 * What is an appropriate response to an unspecified op-code?
3194 * I return no errors and no data, unless a specified assocation
3198 peer = findpeerbyassoc(res_associd);
3200 ctl_error(CERR_BADASSOC);
3203 rpkt.status = htons(ctlpeerstatus(peer));
3205 rpkt.status = htons(ctlsysstatus());
3211 * read_status - return either a list of associd's, or a particular
3217 struct recvbuf *rbufp,
3224 /* a_st holds association ID, status pairs alternating */
3225 u_short a_st[CTL_MAX_DATA_LEN / sizeof(u_short)];
3229 printf("read_status: ID %d\n", res_associd);
3232 * Two choices here. If the specified association ID is
3233 * zero we return all known assocation ID's. Otherwise
3234 * we return a bunch of stuff about the particular peer.
3237 peer = findpeerbyassoc(res_associd);
3239 ctl_error(CERR_BADASSOC);
3242 rpkt.status = htons(ctlpeerstatus(peer));
3244 peer->num_events = 0;
3246 * For now, output everything we know about the
3247 * peer. May be more selective later.
3249 for (cp = def_peer_var; *cp != 0; cp++)
3250 ctl_putpeer((int)*cp, peer);
3255 rpkt.status = htons(ctlsysstatus());
3256 for (peer = peer_list; peer != NULL; peer = peer->p_link) {
3257 a_st[n++] = htons(peer->associd);
3258 a_st[n++] = htons(ctlpeerstatus(peer));
3259 /* two entries each loop iteration, so n + 1 */
3260 if (n + 1 >= COUNTOF(a_st)) {
3261 ctl_putdata((void *)a_st, n * sizeof(a_st[0]),
3267 ctl_putdata((void *)a_st, n * sizeof(a_st[0]), 1);
3273 * read_peervars - half of read_variables() implementation
3278 const struct ctl_var *v;
3283 u_char wants[CP_MAXCODE + 1];
3287 * Wants info for a particular peer. See if we know
3290 peer = findpeerbyassoc(res_associd);
3292 ctl_error(CERR_BADASSOC);
3295 rpkt.status = htons(ctlpeerstatus(peer));
3297 peer->num_events = 0;
3300 while (NULL != (v = ctl_getitem(peer_var, &valuep))) {
3301 if (v->flags & EOV) {
3302 ctl_error(CERR_UNKNOWNVAR);
3305 INSIST(v->code < COUNTOF(wants));
3310 for (i = 1; i < COUNTOF(wants); i++)
3312 ctl_putpeer(i, peer);
3314 for (cp = def_peer_var; *cp != 0; cp++)
3315 ctl_putpeer((int)*cp, peer);
3321 * read_sysvars - half of read_variables() implementation
3326 const struct ctl_var *v;
3337 * Wants system variables. Figure out which he wants
3338 * and give them to him.
3340 rpkt.status = htons(ctlsysstatus());
3342 ctl_sys_num_events = 0;
3343 wants_count = CS_MAXCODE + 1 + count_var(ext_sys_var);
3344 wants = emalloc_zero(wants_count);
3346 while (NULL != (v = ctl_getitem(sys_var, &valuep))) {
3347 if (!(EOV & v->flags)) {
3348 INSIST(v->code < wants_count);
3352 v = ctl_getitem(ext_sys_var, &valuep);
3354 ctl_error(CERR_BADVALUE);
3358 if (EOV & v->flags) {
3359 ctl_error(CERR_UNKNOWNVAR);
3363 n = v->code + CS_MAXCODE + 1;
3364 INSIST(n < wants_count);
3370 for (n = 1; n <= CS_MAXCODE; n++)
3373 for (n = 0; n + CS_MAXCODE + 1 < wants_count; n++)
3374 if (wants[n + CS_MAXCODE + 1]) {
3375 pch = ext_sys_var[n].text;
3376 ctl_putdata(pch, strlen(pch), 0);
3379 for (cs = def_sys_var; *cs != 0; cs++)
3380 ctl_putsys((int)*cs);
3381 for (kv = ext_sys_var; kv && !(EOV & kv->flags); kv++)
3382 if (DEF & kv->flags)
3383 ctl_putdata(kv->text, strlen(kv->text),
3392 * read_variables - return the variables the caller asks for
3397 struct recvbuf *rbufp,
3409 * write_variables - write into variables. We only allow leap bit
3415 struct recvbuf *rbufp,
3419 const struct ctl_var *v;
3430 * If he's trying to write into a peer tell him no way
3432 if (res_associd != 0) {
3433 ctl_error(CERR_PERMISSION);
3440 rpkt.status = htons(ctlsysstatus());
3443 * Look through the variables. Dump out at the first sign of
3446 while ((v = ctl_getitem(sys_var, &valuep)) != 0) {
3448 if (v->flags & EOV) {
3449 if ((v = ctl_getitem(ext_sys_var, &valuep)) !=
3451 if (v->flags & EOV) {
3452 ctl_error(CERR_UNKNOWNVAR);
3460 if (!(v->flags & CAN_WRITE)) {
3461 ctl_error(CERR_PERMISSION);
3464 if (!ext_var && (*valuep == '\0' || !atoint(valuep,
3466 ctl_error(CERR_BADFMT);
3469 if (!ext_var && (val & ~LEAP_NOTINSYNC) != 0) {
3470 ctl_error(CERR_BADVALUE);
3475 octets = strlen(v->text) + strlen(valuep) + 2;
3476 vareqv = emalloc(octets);
3479 while (*t && *t != '=')
3482 memcpy(tt, valuep, 1 + strlen(valuep));
3483 set_sys_var(vareqv, 1 + strlen(vareqv), v->flags);
3486 ctl_error(CERR_UNSPEC); /* really */
3492 * If we got anything, do it. xxx nothing to do ***
3495 if (leapind != ~0 || leapwarn != ~0) {
3496 if (!leap_setleap((int)leapind, (int)leapwarn)) {
3497 ctl_error(CERR_PERMISSION);
3507 * configure() processes ntpq :config/config-from-file, allowing
3508 * generic runtime reconfiguration.
3510 static void configure(
3511 struct recvbuf *rbufp,
3518 /* I haven't yet implemented changes to an existing association.
3519 * Hence check if the association id is 0
3521 if (res_associd != 0) {
3522 ctl_error(CERR_BADVALUE);
3526 if (RES_NOMODIFY & restrict_mask) {
3527 snprintf(remote_config.err_msg,
3528 sizeof(remote_config.err_msg),
3529 "runtime configuration prohibited by restrict ... nomodify");
3530 ctl_putdata(remote_config.err_msg,
3531 strlen(remote_config.err_msg), 0);
3535 "runtime config from %s rejected due to nomodify restriction",
3536 stoa(&rbufp->recv_srcadr));
3541 /* Initialize the remote config buffer */
3542 data_count = remoteconfig_cmdlength(reqpt, reqend);
3544 if (data_count > sizeof(remote_config.buffer) - 2) {
3545 snprintf(remote_config.err_msg,
3546 sizeof(remote_config.err_msg),
3547 "runtime configuration failed: request too long");
3548 ctl_putdata(remote_config.err_msg,
3549 strlen(remote_config.err_msg), 0);
3552 "runtime config from %s rejected: request too long",
3553 stoa(&rbufp->recv_srcadr));
3556 /* Bug 2853 -- check if all characters were acceptable */
3557 if (data_count != (size_t)(reqend - reqpt)) {
3558 snprintf(remote_config.err_msg,
3559 sizeof(remote_config.err_msg),
3560 "runtime configuration failed: request contains an unprintable character");
3561 ctl_putdata(remote_config.err_msg,
3562 strlen(remote_config.err_msg), 0);
3565 "runtime config from %s rejected: request contains an unprintable character: %0x",
3566 stoa(&rbufp->recv_srcadr),
3571 memcpy(remote_config.buffer, reqpt, data_count);
3572 /* The buffer has no trailing linefeed or NUL right now. For
3573 * logging, we do not want a newline, so we do that first after
3574 * adding the necessary NUL byte.
3576 remote_config.buffer[data_count] = '\0';
3577 DPRINTF(1, ("Got Remote Configuration Command: %s\n",
3578 remote_config.buffer));
3579 msyslog(LOG_NOTICE, "%s config: %s",
3580 stoa(&rbufp->recv_srcadr),
3581 remote_config.buffer);
3583 /* Now we have to make sure there is a NL/NUL sequence at the
3584 * end of the buffer before we parse it.
3586 remote_config.buffer[data_count++] = '\n';
3587 remote_config.buffer[data_count] = '\0';
3588 remote_config.pos = 0;
3589 remote_config.err_pos = 0;
3590 remote_config.no_errors = 0;
3591 config_remotely(&rbufp->recv_srcadr);
3594 * Check if errors were reported. If not, output 'Config
3595 * Succeeded'. Else output the error count. It would be nice
3596 * to output any parser error messages.
3598 if (0 == remote_config.no_errors) {
3599 retval = snprintf(remote_config.err_msg,
3600 sizeof(remote_config.err_msg),
3601 "Config Succeeded");
3603 remote_config.err_pos += retval;
3606 ctl_putdata(remote_config.err_msg, remote_config.err_pos, 0);
3609 DPRINTF(1, ("Reply: %s\n", remote_config.err_msg));
3611 if (remote_config.no_errors > 0)
3612 msyslog(LOG_NOTICE, "%d error in %s config",
3613 remote_config.no_errors,
3614 stoa(&rbufp->recv_srcadr));
3619 * derive_nonce - generate client-address-specific nonce value
3620 * associated with a given timestamp.
3622 static u_int32 derive_nonce(
3628 static u_int32 salt[4];
3629 static u_long last_salt_update;
3631 u_char digest[EVP_MAX_MD_SIZE];
3637 while (!salt[0] || current_time - last_salt_update >= 3600) {
3638 salt[0] = ntp_random();
3639 salt[1] = ntp_random();
3640 salt[2] = ntp_random();
3641 salt[3] = ntp_random();
3642 last_salt_update = current_time;
3645 ctx = EVP_MD_CTX_new();
3646 # if defined(OPENSSL) && defined(EVP_MD_CTX_FLAG_NON_FIPS_ALLOW)
3647 /* [Bug 3457] set flags and don't kill them again */
3648 EVP_MD_CTX_set_flags(ctx, EVP_MD_CTX_FLAG_NON_FIPS_ALLOW);
3649 EVP_DigestInit_ex(ctx, EVP_get_digestbynid(NID_md5), NULL);
3651 EVP_DigestInit(ctx, EVP_get_digestbynid(NID_md5));
3653 EVP_DigestUpdate(ctx, salt, sizeof(salt));
3654 EVP_DigestUpdate(ctx, &ts_i, sizeof(ts_i));
3655 EVP_DigestUpdate(ctx, &ts_f, sizeof(ts_f));
3657 EVP_DigestUpdate(ctx, &SOCK_ADDR4(addr),
3658 sizeof(SOCK_ADDR4(addr)));
3660 EVP_DigestUpdate(ctx, &SOCK_ADDR6(addr),
3661 sizeof(SOCK_ADDR6(addr)));
3662 EVP_DigestUpdate(ctx, &NSRCPORT(addr), sizeof(NSRCPORT(addr)));
3663 EVP_DigestUpdate(ctx, salt, sizeof(salt));
3664 EVP_DigestFinal(ctx, d.digest, &len);
3665 EVP_MD_CTX_free(ctx);
3672 * generate_nonce - generate client-address-specific nonce string.
3674 static void generate_nonce(
3675 struct recvbuf * rbufp,
3682 derived = derive_nonce(&rbufp->recv_srcadr,
3683 rbufp->recv_time.l_ui,
3684 rbufp->recv_time.l_uf);
3685 snprintf(nonce, nonce_octets, "%08x%08x%08x",
3686 rbufp->recv_time.l_ui, rbufp->recv_time.l_uf, derived);
3691 * validate_nonce - validate client-address-specific nonce string.
3693 * Returns TRUE if the local calculation of the nonce matches the
3694 * client-provided value and the timestamp is recent enough.
3696 static int validate_nonce(
3697 const char * pnonce,
3698 struct recvbuf * rbufp
3708 if (3 != sscanf(pnonce, "%08x%08x%08x", &ts_i, &ts_f, &supposed))
3711 ts.l_ui = (u_int32)ts_i;
3712 ts.l_uf = (u_int32)ts_f;
3713 derived = derive_nonce(&rbufp->recv_srcadr, ts.l_ui, ts.l_uf);
3714 get_systime(&now_delta);
3715 L_SUB(&now_delta, &ts);
3717 return (supposed == derived && now_delta.l_ui < 16);
3722 * send_random_tag_value - send a randomly-generated three character
3723 * tag prefix, a '.', an index, a '=' and a
3724 * random integer value.
3726 * To try to force clients to ignore unrecognized tags in mrulist,
3727 * reslist, and ifstats responses, the first and last rows are spiced
3728 * with randomly-generated tag names with correct .# index. Make it
3729 * three characters knowing that none of the currently-used subscripted
3730 * tags have that length, avoiding the need to test for
3734 send_random_tag_value(
3741 noise = rand() ^ (rand() << 16);
3742 buf[0] = 'a' + noise % 26;
3744 buf[1] = 'a' + noise % 26;
3746 buf[2] = 'a' + noise % 26;
3749 snprintf(&buf[4], sizeof(buf) - 4, "%d", indx);
3750 ctl_putuint(buf, noise);
3755 * Send a MRU list entry in response to a "ntpq -c mrulist" operation.
3757 * To keep clients honest about not depending on the order of values,
3758 * and thereby avoid being locked into ugly workarounds to maintain
3759 * backward compatibility later as new fields are added to the response,
3760 * the order is random.
3768 const char first_fmt[] = "first.%d";
3769 const char ct_fmt[] = "ct.%d";
3770 const char mv_fmt[] = "mv.%d";
3771 const char rs_fmt[] = "rs.%d";
3773 u_char sent[6]; /* 6 tag=value pairs */
3779 remaining = COUNTOF(sent);
3781 noise = (u_int32)(rand() ^ (rand() << 16));
3782 while (remaining > 0) {
3783 which = (noise & 7) % COUNTOF(sent);
3786 which = (which + 1) % COUNTOF(sent);
3791 snprintf(tag, sizeof(tag), addr_fmt, count);
3792 pch = sptoa(&mon->rmtadr);
3793 ctl_putunqstr(tag, pch, strlen(pch));
3797 snprintf(tag, sizeof(tag), last_fmt, count);
3798 ctl_putts(tag, &mon->last);
3802 snprintf(tag, sizeof(tag), first_fmt, count);
3803 ctl_putts(tag, &mon->first);
3807 snprintf(tag, sizeof(tag), ct_fmt, count);
3808 ctl_putint(tag, mon->count);
3812 snprintf(tag, sizeof(tag), mv_fmt, count);
3813 ctl_putuint(tag, mon->vn_mode);
3817 snprintf(tag, sizeof(tag), rs_fmt, count);
3818 ctl_puthex(tag, mon->flags);
3828 * read_mru_list - supports ntpq's mrulist command.
3830 * The challenge here is to match ntpdc's monlist functionality without
3831 * being limited to hundreds of entries returned total, and without
3832 * requiring state on the server. If state were required, ntpq's
3833 * mrulist command would require authentication.
3835 * The approach was suggested by Ry Jones. A finite and variable number
3836 * of entries are retrieved per request, to avoid having responses with
3837 * such large numbers of packets that socket buffers are overflowed and
3838 * packets lost. The entries are retrieved oldest-first, taking into
3839 * account that the MRU list will be changing between each request. We
3840 * can expect to see duplicate entries for addresses updated in the MRU
3841 * list during the fetch operation. In the end, the client can assemble
3842 * a close approximation of the MRU list at the point in time the last
3843 * response was sent by ntpd. The only difference is it may be longer,
3844 * containing some number of oldest entries which have since been
3845 * reclaimed. If necessary, the protocol could be extended to zap those
3846 * from the client snapshot at the end, but so far that doesn't seem
3849 * To accomodate the changing MRU list, the starting point for requests
3850 * after the first request is supplied as a series of last seen
3851 * timestamps and associated addresses, the newest ones the client has
3852 * received. As long as at least one of those entries hasn't been
3853 * bumped to the head of the MRU list, ntpd can pick up at that point.
3854 * Otherwise, the request is failed and it is up to ntpq to back up and
3855 * provide the next newest entry's timestamps and addresses, conceivably
3856 * backing up all the way to the starting point.
3859 * nonce= Regurgitated nonce retrieved by the client
3860 * previously using CTL_OP_REQ_NONCE, demonstrating
3861 * ability to receive traffic sent to its address.
3862 * frags= Limit on datagrams (fragments) in response. Used
3863 * by newer ntpq versions instead of limit= when
3864 * retrieving multiple entries.
3865 * limit= Limit on MRU entries returned. One of frags= or
3866 * limit= must be provided.
3867 * limit=1 is a special case: Instead of fetching
3868 * beginning with the supplied starting point's
3869 * newer neighbor, fetch the supplied entry, and
3870 * in that case the #.last timestamp can be zero.
3871 * This enables fetching a single entry by IP
3872 * address. When limit is not one and frags= is
3873 * provided, the fragment limit controls.
3874 * mincount= (decimal) Return entries with count >= mincount.
3875 * laddr= Return entries associated with the server's IP
3876 * address given. No port specification is needed,
3877 * and any supplied is ignored.
3878 * resall= 0x-prefixed hex restrict bits which must all be
3879 * lit for an MRU entry to be included.
3880 * Has precedence over any resany=.
3881 * resany= 0x-prefixed hex restrict bits, at least one of
3882 * which must be list for an MRU entry to be
3884 * last.0= 0x-prefixed hex l_fp timestamp of newest entry
3885 * which client previously received.
3886 * addr.0= text of newest entry's IP address and port,
3887 * IPv6 addresses in bracketed form: [::]:123
3888 * last.1= timestamp of 2nd newest entry client has.
3889 * addr.1= address of 2nd newest entry.
3892 * ntpq provides as many last/addr pairs as will fit in a single request
3893 * packet, except for the first request in a MRU fetch operation.
3895 * The response begins with a new nonce value to be used for any
3896 * followup request. Following the nonce is the next newer entry than
3897 * referred to by last.0 and addr.0, if the "0" entry has not been
3898 * bumped to the front. If it has, the first entry returned will be the
3899 * next entry newer than referred to by last.1 and addr.1, and so on.
3900 * If none of the referenced entries remain unchanged, the request fails
3901 * and ntpq backs up to the next earlier set of entries to resync.
3903 * Except for the first response, the response begins with confirmation
3904 * of the entry that precedes the first additional entry provided:
3906 * last.older= hex l_fp timestamp matching one of the input
3907 * .last timestamps, which entry now precedes the
3908 * response 0. entry in the MRU list.
3909 * addr.older= text of address corresponding to older.last.
3911 * And in any case, a successful response contains sets of values
3912 * comprising entries, with the oldest numbered 0 and incrementing from
3915 * addr.# text of IPv4 or IPv6 address and port
3916 * last.# hex l_fp timestamp of last receipt
3917 * first.# hex l_fp timestamp of first receipt
3918 * ct.# count of packets received
3919 * mv.# mode and version
3920 * rs.# restriction mask (RES_* bits)
3922 * Note the code currently assumes there are no valid three letter
3923 * tags sent with each row, and needs to be adjusted if that changes.
3925 * The client should accept the values in any order, and ignore .#
3926 * values which it does not understand, to allow a smooth path to
3927 * future changes without requiring a new opcode. Clients can rely
3928 * on all *.0 values preceding any *.1 values, that is all values for
3929 * a given index number are together in the response.
3931 * The end of the response list is noted with one or two tag=value
3932 * pairs. Unconditionally:
3934 * now= 0x-prefixed l_fp timestamp at the server marking
3935 * the end of the operation.
3937 * If any entries were returned, now= is followed by:
3939 * last.newest= hex l_fp identical to last.# of the prior
3942 static void read_mru_list(
3943 struct recvbuf *rbufp,
3947 static const char nulltxt[1] = { '\0' };
3948 static const char nonce_text[] = "nonce";
3949 static const char frags_text[] = "frags";
3950 static const char limit_text[] = "limit";
3951 static const char mincount_text[] = "mincount";
3952 static const char resall_text[] = "resall";
3953 static const char resany_text[] = "resany";
3954 static const char maxlstint_text[] = "maxlstint";
3955 static const char laddr_text[] = "laddr";
3956 static const char resaxx_fmt[] = "0x%hx";
3965 struct interface * lcladr;
3970 sockaddr_u addr[COUNTOF(last)];
3972 struct ctl_var * in_parms;
3973 const struct ctl_var * v;
3982 mon_entry * prior_mon;
3985 if (RES_NOMRULIST & restrict_mask) {
3986 ctl_error(CERR_PERMISSION);
3989 "mrulist from %s rejected due to nomrulist restriction",
3990 stoa(&rbufp->recv_srcadr));
3995 * fill in_parms var list with all possible input parameters.
3998 set_var(&in_parms, nonce_text, sizeof(nonce_text), 0);
3999 set_var(&in_parms, frags_text, sizeof(frags_text), 0);
4000 set_var(&in_parms, limit_text, sizeof(limit_text), 0);
4001 set_var(&in_parms, mincount_text, sizeof(mincount_text), 0);
4002 set_var(&in_parms, resall_text, sizeof(resall_text), 0);
4003 set_var(&in_parms, resany_text, sizeof(resany_text), 0);
4004 set_var(&in_parms, maxlstint_text, sizeof(maxlstint_text), 0);
4005 set_var(&in_parms, laddr_text, sizeof(laddr_text), 0);
4006 for (i = 0; i < COUNTOF(last); i++) {
4007 snprintf(buf, sizeof(buf), last_fmt, (int)i);
4008 set_var(&in_parms, buf, strlen(buf) + 1, 0);
4009 snprintf(buf, sizeof(buf), addr_fmt, (int)i);
4010 set_var(&in_parms, buf, strlen(buf) + 1, 0);
4013 /* decode input parms */
4026 /* have to go through '(void*)' to drop 'const' property from pointer.
4027 * ctl_getitem()' needs some cleanup, too.... perlinger@ntp.org
4029 while (NULL != (v = ctl_getitem(in_parms, (void*)&val)) &&
4030 !(EOV & v->flags)) {
4036 if (!strcmp(nonce_text, v->text)) {
4038 pnonce = (*val) ? estrdup(val) : NULL;
4039 } else if (!strcmp(frags_text, v->text)) {
4040 if (1 != sscanf(val, "%hu", &frags))
4042 } else if (!strcmp(limit_text, v->text)) {
4043 if (1 != sscanf(val, "%u", &limit))
4045 } else if (!strcmp(mincount_text, v->text)) {
4046 if (1 != sscanf(val, "%d", &mincount))
4050 } else if (!strcmp(resall_text, v->text)) {
4051 if (1 != sscanf(val, resaxx_fmt, &resall))
4053 } else if (!strcmp(resany_text, v->text)) {
4054 if (1 != sscanf(val, resaxx_fmt, &resany))
4056 } else if (!strcmp(maxlstint_text, v->text)) {
4057 if (1 != sscanf(val, "%u", &maxlstint))
4059 } else if (!strcmp(laddr_text, v->text)) {
4060 if (!decodenetnum(val, &laddr))
4062 lcladr = getinterface(&laddr, 0);
4063 } else if (1 == sscanf(v->text, last_fmt, &si) &&
4064 (size_t)si < COUNTOF(last)) {
4065 if (2 != sscanf(val, "0x%08x.%08x", &ui, &uf))
4069 if (!SOCK_UNSPEC(&addr[si]) && si == priors)
4071 } else if (1 == sscanf(v->text, addr_fmt, &si) &&
4072 (size_t)si < COUNTOF(addr)) {
4073 if (!decodenetnum(val, &addr[si]))
4075 if (last[si].l_ui && last[si].l_uf && si == priors)
4078 DPRINTF(1, ("read_mru_list: invalid key item: '%s' (ignored)\n",
4083 DPRINTF(1, ("read_mru_list: invalid param for '%s': '%s' (bailing)\n",
4090 free_varlist(in_parms);
4093 /* return no responses until the nonce is validated */
4097 nonce_valid = validate_nonce(pnonce, rbufp);
4102 if ((0 == frags && !(0 < limit && limit <= MRU_ROW_LIMIT)) ||
4103 frags > MRU_FRAGS_LIMIT) {
4104 ctl_error(CERR_BADVALUE);
4109 * If either frags or limit is not given, use the max.
4111 if (0 != frags && 0 == limit)
4113 else if (0 != limit && 0 == frags)
4114 frags = MRU_FRAGS_LIMIT;
4117 * Find the starting point if one was provided.
4120 for (i = 0; i < (size_t)priors; i++) {
4121 hash = MON_HASH(&addr[i]);
4122 for (mon = mon_hash[hash];
4124 mon = mon->hash_next)
4125 if (ADDR_PORT_EQ(&mon->rmtadr, &addr[i]))
4128 if (L_ISEQU(&mon->last, &last[i]))
4134 /* If a starting point was provided... */
4136 /* and none could be found unmodified... */
4138 /* tell ntpq to try again with older entries */
4139 ctl_error(CERR_UNKNOWNVAR);
4142 /* confirm the prior entry used as starting point */
4143 ctl_putts("last.older", &mon->last);
4144 pch = sptoa(&mon->rmtadr);
4145 ctl_putunqstr("addr.older", pch, strlen(pch));
4148 * Move on to the first entry the client doesn't have,
4149 * except in the special case of a limit of one. In
4150 * that case return the starting point entry.
4153 mon = PREV_DLIST(mon_mru_list, mon, mru);
4154 } else { /* start with the oldest */
4155 mon = TAIL_DLIST(mon_mru_list, mru);
4159 * send up to limit= entries in up to frags= datagrams
4162 generate_nonce(rbufp, buf, sizeof(buf));
4163 ctl_putunqstr("nonce", buf, strlen(buf));
4166 mon != NULL && res_frags < frags && count < limit;
4167 mon = PREV_DLIST(mon_mru_list, mon, mru)) {
4169 if (mon->count < mincount)
4171 if (resall && resall != (resall & mon->flags))
4173 if (resany && !(resany & mon->flags))
4175 if (maxlstint > 0 && now.l_ui - mon->last.l_ui >
4178 if (lcladr != NULL && mon->lcladr != lcladr)
4181 send_mru_entry(mon, count);
4183 send_random_tag_value(0);
4189 * If this batch completes the MRU list, say so explicitly with
4190 * a now= l_fp timestamp.
4194 send_random_tag_value(count - 1);
4195 ctl_putts("now", &now);
4196 /* if any entries were returned confirm the last */
4197 if (prior_mon != NULL)
4198 ctl_putts("last.newest", &prior_mon->last);
4205 * Send a ifstats entry in response to a "ntpq -c ifstats" request.
4207 * To keep clients honest about not depending on the order of values,
4208 * and thereby avoid being locked into ugly workarounds to maintain
4209 * backward compatibility later as new fields are added to the response,
4210 * the order is random.
4218 const char addr_fmtu[] = "addr.%u";
4219 const char bcast_fmt[] = "bcast.%u";
4220 const char en_fmt[] = "en.%u"; /* enabled */
4221 const char name_fmt[] = "name.%u";
4222 const char flags_fmt[] = "flags.%u";
4223 const char tl_fmt[] = "tl.%u"; /* ttl */
4224 const char mc_fmt[] = "mc.%u"; /* mcast count */
4225 const char rx_fmt[] = "rx.%u";
4226 const char tx_fmt[] = "tx.%u";
4227 const char txerr_fmt[] = "txerr.%u";
4228 const char pc_fmt[] = "pc.%u"; /* peer count */
4229 const char up_fmt[] = "up.%u"; /* uptime */
4231 u_char sent[IFSTATS_FIELDS]; /* 12 tag=value pairs */
4238 remaining = COUNTOF(sent);
4242 while (remaining > 0) {
4243 if (noisebits < 4) {
4244 noise = rand() ^ (rand() << 16);
4247 which = (noise & 0xf) % COUNTOF(sent);
4252 which = (which + 1) % COUNTOF(sent);
4257 snprintf(tag, sizeof(tag), addr_fmtu, ifnum);
4258 pch = sptoa(&la->sin);
4259 ctl_putunqstr(tag, pch, strlen(pch));
4263 snprintf(tag, sizeof(tag), bcast_fmt, ifnum);
4264 if (INT_BCASTOPEN & la->flags)
4265 pch = sptoa(&la->bcast);
4268 ctl_putunqstr(tag, pch, strlen(pch));
4272 snprintf(tag, sizeof(tag), en_fmt, ifnum);
4273 ctl_putint(tag, !la->ignore_packets);
4277 snprintf(tag, sizeof(tag), name_fmt, ifnum);
4278 ctl_putstr(tag, la->name, strlen(la->name));
4282 snprintf(tag, sizeof(tag), flags_fmt, ifnum);
4283 ctl_puthex(tag, (u_int)la->flags);
4287 snprintf(tag, sizeof(tag), tl_fmt, ifnum);
4288 ctl_putint(tag, la->last_ttl);
4292 snprintf(tag, sizeof(tag), mc_fmt, ifnum);
4293 ctl_putint(tag, la->num_mcast);
4297 snprintf(tag, sizeof(tag), rx_fmt, ifnum);
4298 ctl_putint(tag, la->received);
4302 snprintf(tag, sizeof(tag), tx_fmt, ifnum);
4303 ctl_putint(tag, la->sent);
4307 snprintf(tag, sizeof(tag), txerr_fmt, ifnum);
4308 ctl_putint(tag, la->notsent);
4312 snprintf(tag, sizeof(tag), pc_fmt, ifnum);
4313 ctl_putuint(tag, la->peercnt);
4317 snprintf(tag, sizeof(tag), up_fmt, ifnum);
4318 ctl_putuint(tag, current_time - la->starttime);
4324 send_random_tag_value((int)ifnum);
4329 * read_ifstats - send statistics for each local address, exposed by
4334 struct recvbuf * rbufp
4341 * loop over [0..sys_ifnum] searching ep_list for each
4344 for (ifidx = 0; ifidx < sys_ifnum; ifidx++) {
4345 for (la = ep_list; la != NULL; la = la->elink)
4346 if (ifidx == la->ifnum)
4350 /* return stats for one local address */
4351 send_ifstats_entry(la, ifidx);
4357 sockaddrs_from_restrict_u(
4367 psaA->sa.sa_family = AF_INET;
4368 psaA->sa4.sin_addr.s_addr = htonl(pres->u.v4.addr);
4369 psaM->sa.sa_family = AF_INET;
4370 psaM->sa4.sin_addr.s_addr = htonl(pres->u.v4.mask);
4372 psaA->sa.sa_family = AF_INET6;
4373 memcpy(&psaA->sa6.sin6_addr, &pres->u.v6.addr,
4374 sizeof(psaA->sa6.sin6_addr));
4375 psaM->sa.sa_family = AF_INET6;
4376 memcpy(&psaM->sa6.sin6_addr, &pres->u.v6.mask,
4377 sizeof(psaA->sa6.sin6_addr));
4383 * Send a restrict entry in response to a "ntpq -c reslist" request.
4385 * To keep clients honest about not depending on the order of values,
4386 * and thereby avoid being locked into ugly workarounds to maintain
4387 * backward compatibility later as new fields are added to the response,
4388 * the order is random.
4391 send_restrict_entry(
4397 const char addr_fmtu[] = "addr.%u";
4398 const char mask_fmtu[] = "mask.%u";
4399 const char hits_fmt[] = "hits.%u";
4400 const char flags_fmt[] = "flags.%u";
4402 u_char sent[RESLIST_FIELDS]; /* 4 tag=value pairs */
4411 const char * match_str;
4412 const char * access_str;
4414 sockaddrs_from_restrict_u(&addr, &mask, pres, ipv6);
4415 remaining = COUNTOF(sent);
4419 while (remaining > 0) {
4420 if (noisebits < 2) {
4421 noise = rand() ^ (rand() << 16);
4424 which = (noise & 0x3) % COUNTOF(sent);
4429 which = (which + 1) % COUNTOF(sent);
4431 /* XXX: Numbers? Really? */
4435 snprintf(tag, sizeof(tag), addr_fmtu, idx);
4437 ctl_putunqstr(tag, pch, strlen(pch));
4441 snprintf(tag, sizeof(tag), mask_fmtu, idx);
4443 ctl_putunqstr(tag, pch, strlen(pch));
4447 snprintf(tag, sizeof(tag), hits_fmt, idx);
4448 ctl_putuint(tag, pres->count);
4452 snprintf(tag, sizeof(tag), flags_fmt, idx);
4453 match_str = res_match_flags(pres->mflags);
4454 access_str = res_access_flags(pres->rflags);
4455 if ('\0' == match_str[0]) {
4459 snprintf(buf, LIB_BUFLENGTH, "%s %s",
4460 match_str, access_str);
4463 ctl_putunqstr(tag, pch, strlen(pch));
4469 send_random_tag_value((int)idx);
4480 for ( ; pres != NULL; pres = pres->link) {
4481 send_restrict_entry(pres, ipv6, *pidx);
4488 * read_addr_restrictions - returns IPv4 and IPv6 access control lists
4491 read_addr_restrictions(
4492 struct recvbuf * rbufp
4498 send_restrict_list(restrictlist4, FALSE, &idx);
4499 send_restrict_list(restrictlist6, TRUE, &idx);
4505 * read_ordlist - CTL_OP_READ_ORDLIST_A for ntpq -c ifstats & reslist
4509 struct recvbuf * rbufp,
4513 const char ifstats_s[] = "ifstats";
4514 const size_t ifstats_chars = COUNTOF(ifstats_s) - 1;
4515 const char addr_rst_s[] = "addr_restrictions";
4516 const size_t a_r_chars = COUNTOF(addr_rst_s) - 1;
4517 struct ntp_control * cpkt;
4518 u_short qdata_octets;
4521 * CTL_OP_READ_ORDLIST_A was first named CTL_OP_READ_IFSTATS and
4522 * used only for ntpq -c ifstats. With the addition of reslist
4523 * the same opcode was generalized to retrieve ordered lists
4524 * which require authentication. The request data is empty or
4525 * contains "ifstats" (not null terminated) to retrieve local
4526 * addresses and associated stats. It is "addr_restrictions"
4527 * to retrieve the IPv4 then IPv6 remote address restrictions,
4528 * which are access control lists. Other request data return
4531 cpkt = (struct ntp_control *)&rbufp->recv_pkt;
4532 qdata_octets = ntohs(cpkt->count);
4533 if (0 == qdata_octets || (ifstats_chars == qdata_octets &&
4534 !memcmp(ifstats_s, cpkt->u.data, ifstats_chars))) {
4535 read_ifstats(rbufp);
4538 if (a_r_chars == qdata_octets &&
4539 !memcmp(addr_rst_s, cpkt->u.data, a_r_chars)) {
4540 read_addr_restrictions(rbufp);
4543 ctl_error(CERR_UNKNOWNVAR);
4548 * req_nonce - CTL_OP_REQ_NONCE for ntpq -c mrulist prerequisite.
4550 static void req_nonce(
4551 struct recvbuf * rbufp,
4557 generate_nonce(rbufp, buf, sizeof(buf));
4558 ctl_putunqstr("nonce", buf, strlen(buf));
4564 * read_clockstatus - return clock radio status
4569 struct recvbuf *rbufp,
4575 * If no refclock support, no data to return
4577 ctl_error(CERR_BADASSOC);
4579 const struct ctl_var * v;
4587 struct ctl_var * kv;
4588 struct refclockstat cs;
4590 if (res_associd != 0) {
4591 peer = findpeerbyassoc(res_associd);
4594 * Find a clock for this jerk. If the system peer
4595 * is a clock use it, else search peer_list for one.
4597 if (sys_peer != NULL && (FLAG_REFCLOCK &
4601 for (peer = peer_list;
4603 peer = peer->p_link)
4604 if (FLAG_REFCLOCK & peer->flags)
4607 if (NULL == peer || !(FLAG_REFCLOCK & peer->flags)) {
4608 ctl_error(CERR_BADASSOC);
4612 * If we got here we have a peer which is a clock. Get his
4616 refclock_control(&peer->srcadr, NULL, &cs);
4619 * Look for variables in the packet.
4621 rpkt.status = htons(ctlclkstatus(&cs));
4622 wants_alloc = CC_MAXCODE + 1 + count_var(kv);
4623 wants = emalloc_zero(wants_alloc);
4625 while (NULL != (v = ctl_getitem(clock_var, &valuep))) {
4626 if (!(EOV & v->flags)) {
4627 wants[v->code] = TRUE;
4630 v = ctl_getitem(kv, &valuep);
4632 ctl_error(CERR_BADVALUE);
4634 free_varlist(cs.kv_list);
4637 if (EOV & v->flags) {
4638 ctl_error(CERR_UNKNOWNVAR);
4640 free_varlist(cs.kv_list);
4643 wants[CC_MAXCODE + 1 + v->code] = TRUE;
4649 for (i = 1; i <= CC_MAXCODE; i++)
4651 ctl_putclock(i, &cs, TRUE);
4653 for (i = 0; !(EOV & kv[i].flags); i++)
4654 if (wants[i + CC_MAXCODE + 1])
4655 ctl_putdata(kv[i].text,
4659 for (cc = def_clock_var; *cc != 0; cc++)
4660 ctl_putclock((int)*cc, &cs, FALSE);
4661 for ( ; kv != NULL && !(EOV & kv->flags); kv++)
4662 if (DEF & kv->flags)
4663 ctl_putdata(kv->text, strlen(kv->text),
4668 free_varlist(cs.kv_list);
4676 * write_clockstatus - we don't do this
4681 struct recvbuf *rbufp,
4685 ctl_error(CERR_PERMISSION);
4689 * Trap support from here on down. We send async trap messages when the
4690 * upper levels report trouble. Traps can by set either by control
4691 * messages or by configuration.
4694 * set_trap - set a trap in response to a control message
4698 struct recvbuf *rbufp,
4705 * See if this guy is allowed
4707 if (restrict_mask & RES_NOTRAP) {
4708 ctl_error(CERR_PERMISSION);
4713 * Determine his allowed trap type.
4715 traptype = TRAP_TYPE_PRIO;
4716 if (restrict_mask & RES_LPTRAP)
4717 traptype = TRAP_TYPE_NONPRIO;
4720 * Call ctlsettrap() to do the work. Return
4721 * an error if it can't assign the trap.
4723 if (!ctlsettrap(&rbufp->recv_srcadr, rbufp->dstadr, traptype,
4725 ctl_error(CERR_NORESOURCE);
4731 * unset_trap - unset a trap in response to a control message
4735 struct recvbuf *rbufp,
4742 * We don't prevent anyone from removing his own trap unless the
4743 * trap is configured. Note we also must be aware of the
4744 * possibility that restriction flags were changed since this
4745 * guy last set his trap. Set the trap type based on this.
4747 traptype = TRAP_TYPE_PRIO;
4748 if (restrict_mask & RES_LPTRAP)
4749 traptype = TRAP_TYPE_NONPRIO;
4752 * Call ctlclrtrap() to clear this out.
4754 if (!ctlclrtrap(&rbufp->recv_srcadr, rbufp->dstadr, traptype))
4755 ctl_error(CERR_BADASSOC);
4761 * ctlsettrap - called to set a trap
4766 struct interface *linter,
4772 struct ctl_trap *tp;
4773 struct ctl_trap *tptouse;
4776 * See if we can find this trap. If so, we only need update
4777 * the flags and the time.
4779 if ((tp = ctlfindtrap(raddr, linter)) != NULL) {
4782 case TRAP_TYPE_CONFIG:
4783 tp->tr_flags = TRAP_INUSE|TRAP_CONFIGURED;
4786 case TRAP_TYPE_PRIO:
4787 if (tp->tr_flags & TRAP_CONFIGURED)
4788 return (1); /* don't change anything */
4789 tp->tr_flags = TRAP_INUSE;
4792 case TRAP_TYPE_NONPRIO:
4793 if (tp->tr_flags & TRAP_CONFIGURED)
4794 return (1); /* don't change anything */
4795 tp->tr_flags = TRAP_INUSE|TRAP_NONPRIO;
4798 tp->tr_settime = current_time;
4804 * First we heard of this guy. Try to find a trap structure
4805 * for him to use, clearing out lesser priority guys if we
4806 * have to. Clear out anyone who's expired while we're at it.
4809 for (n = 0; n < COUNTOF(ctl_traps); n++) {
4811 if ((TRAP_INUSE & tp->tr_flags) &&
4812 !(TRAP_CONFIGURED & tp->tr_flags) &&
4813 ((tp->tr_settime + CTL_TRAPTIME) > current_time)) {
4817 if (!(TRAP_INUSE & tp->tr_flags)) {
4819 } else if (!(TRAP_CONFIGURED & tp->tr_flags)) {
4822 case TRAP_TYPE_CONFIG:
4823 if (tptouse == NULL) {
4827 if ((TRAP_NONPRIO & tptouse->tr_flags) &&
4828 !(TRAP_NONPRIO & tp->tr_flags))
4831 if (!(TRAP_NONPRIO & tptouse->tr_flags)
4832 && (TRAP_NONPRIO & tp->tr_flags)) {
4836 if (tptouse->tr_origtime <
4841 case TRAP_TYPE_PRIO:
4842 if ( TRAP_NONPRIO & tp->tr_flags) {
4843 if (tptouse == NULL ||
4845 tptouse->tr_flags) &&
4846 tptouse->tr_origtime <
4852 case TRAP_TYPE_NONPRIO:
4859 * If we don't have room for him return an error.
4861 if (tptouse == NULL)
4865 * Set up this structure for him.
4867 tptouse->tr_settime = tptouse->tr_origtime = current_time;
4868 tptouse->tr_count = tptouse->tr_resets = 0;
4869 tptouse->tr_sequence = 1;
4870 tptouse->tr_addr = *raddr;
4871 tptouse->tr_localaddr = linter;
4872 tptouse->tr_version = (u_char) version;
4873 tptouse->tr_flags = TRAP_INUSE;
4874 if (traptype == TRAP_TYPE_CONFIG)
4875 tptouse->tr_flags |= TRAP_CONFIGURED;
4876 else if (traptype == TRAP_TYPE_NONPRIO)
4877 tptouse->tr_flags |= TRAP_NONPRIO;
4884 * ctlclrtrap - called to clear a trap
4889 struct interface *linter,
4893 register struct ctl_trap *tp;
4895 if ((tp = ctlfindtrap(raddr, linter)) == NULL)
4898 if (tp->tr_flags & TRAP_CONFIGURED
4899 && traptype != TRAP_TYPE_CONFIG)
4909 * ctlfindtrap - find a trap given the remote and local addresses
4911 static struct ctl_trap *
4914 struct interface *linter
4919 for (n = 0; n < COUNTOF(ctl_traps); n++)
4920 if ((ctl_traps[n].tr_flags & TRAP_INUSE)
4921 && ADDR_PORT_EQ(raddr, &ctl_traps[n].tr_addr)
4922 && (linter == ctl_traps[n].tr_localaddr))
4923 return &ctl_traps[n];
4930 * report_event - report an event to the trappers
4934 int err, /* error code */
4935 struct peer *peer, /* peer structure pointer */
4936 const char *str /* protostats string */
4939 char statstr[NTP_MAXSTRLEN];
4944 * Report the error to the protostats file, system log and
4950 * Discard a system report if the number of reports of
4951 * the same type exceeds the maximum.
4953 if (ctl_sys_last_event != (u_char)err)
4954 ctl_sys_num_events= 0;
4955 if (ctl_sys_num_events >= CTL_SYS_MAXEVENTS)
4958 ctl_sys_last_event = (u_char)err;
4959 ctl_sys_num_events++;
4960 snprintf(statstr, sizeof(statstr),
4961 "0.0.0.0 %04x %02x %s",
4962 ctlsysstatus(), err, eventstr(err));
4964 len = strlen(statstr);
4965 snprintf(statstr + len, sizeof(statstr) - len,
4969 msyslog(LOG_INFO, "%s", statstr);
4973 * Discard a peer report if the number of reports of
4974 * the same type exceeds the maximum for that peer.
4979 errlast = (u_char)err & ~PEER_EVENT;
4980 if (peer->last_event != errlast)
4981 peer->num_events = 0;
4982 if (peer->num_events >= CTL_PEER_MAXEVENTS)
4985 peer->last_event = errlast;
4987 if (ISREFCLOCKADR(&peer->srcadr))
4988 src = refnumtoa(&peer->srcadr);
4990 src = stoa(&peer->srcadr);
4992 snprintf(statstr, sizeof(statstr),
4993 "%s %04x %02x %s", src,
4994 ctlpeerstatus(peer), err, eventstr(err));
4996 len = strlen(statstr);
4997 snprintf(statstr + len, sizeof(statstr) - len,
5000 NLOG(NLOG_PEEREVENT)
5001 msyslog(LOG_INFO, "%s", statstr);
5003 record_proto_stats(statstr);
5006 printf("event at %lu %s\n", current_time, statstr);
5010 * If no trappers, return.
5012 if (num_ctl_traps <= 0)
5016 * Peer Events should be associated with a peer -- hence the
5017 * name. But there are instances where this function is called
5018 * *without* a valid peer. This happens e.g. with an unsolicited
5019 * CryptoNAK, or when a leap second alarm is going off while
5020 * currently without a system peer.
5022 * The most sensible approach to this seems to bail out here if
5023 * this happens. Avoiding to call this function would also
5024 * bypass the log reporting in the first part of this function,
5025 * and this is probably not the best of all options.
5026 * -*-perlinger@ntp.org-*-
5028 if ((err & PEER_EVENT) && !peer)
5032 * Set up the outgoing packet variables
5034 res_opcode = CTL_OP_ASYNCMSG;
5037 res_authenticate = FALSE;
5038 datapt = rpkt.u.data;
5039 dataend = &rpkt.u.data[CTL_MAX_DATA_LEN];
5040 if (!(err & PEER_EVENT)) {
5042 rpkt.status = htons(ctlsysstatus());
5044 /* Include the core system variables and the list. */
5045 for (i = 1; i <= CS_VARLIST; i++)
5047 } else if (NULL != peer) { /* paranoia -- skip output */
5048 rpkt.associd = htons(peer->associd);
5049 rpkt.status = htons(ctlpeerstatus(peer));
5051 /* Dump it all. Later, maybe less. */
5052 for (i = 1; i <= CP_MAX_NOAUTOKEY; i++)
5053 ctl_putpeer(i, peer);
5056 * for clock exception events: add clock variables to
5057 * reflect info on exception
5059 if (err == PEVNT_CLOCK) {
5060 struct refclockstat cs;
5064 refclock_control(&peer->srcadr, NULL, &cs);
5066 ctl_puthex("refclockstatus",
5069 for (i = 1; i <= CC_MAXCODE; i++)
5070 ctl_putclock(i, &cs, FALSE);
5071 for (kv = cs.kv_list;
5072 kv != NULL && !(EOV & kv->flags);
5074 if (DEF & kv->flags)
5075 ctl_putdata(kv->text,
5078 free_varlist(cs.kv_list);
5080 # endif /* REFCLOCK */
5084 * We're done, return.
5091 * mprintf_event - printf-style varargs variant of report_event()
5095 int evcode, /* event code */
5096 struct peer * p, /* may be NULL */
5097 const char * fmt, /* msnprintf format */
5106 rc = mvsnprintf(msg, sizeof(msg), fmt, ap);
5108 report_event(evcode, p, msg);
5115 * ctl_clr_stats - clear stat counters
5120 ctltimereset = current_time;
5123 numctlresponses = 0;
5128 numctlinputresp = 0;
5129 numctlinputfrag = 0;
5131 numctlbadoffset = 0;
5132 numctlbadversion = 0;
5133 numctldatatooshort = 0;
5140 const struct ctl_var *k
5149 while (!(EOV & (k++)->flags))
5152 ENSURE(c <= USHRT_MAX);
5159 struct ctl_var **kv,
5169 *kv = erealloc(*kv, (c + 2) * sizeof(**kv));
5171 buf = emalloc(size);
5176 k[c + 1].text = NULL;
5177 k[c + 1].flags = EOV;
5185 struct ctl_var **kv,
5196 if (NULL == data || !size)
5201 while (!(EOV & k->flags)) {
5202 if (NULL == k->text) {
5204 memcpy(td, data, size);
5211 while (*t != '=' && *s == *t) {
5215 if (*s == *t && ((*t == '=') || !*t)) {
5216 td = erealloc((void *)(intptr_t)k->text, size);
5217 memcpy(td, data, size);
5226 td = add_var(kv, size, def);
5227 memcpy(td, data, size);
5238 set_var(&ext_sys_var, data, size, def);
5243 * get_ext_sys_var() retrieves the value of a user-defined variable or
5244 * NULL if the variable has not been setvar'd.
5247 get_ext_sys_var(const char *tag)
5255 for (v = ext_sys_var; !(EOV & v->flags); v++) {
5256 if (NULL != v->text && !memcmp(tag, v->text, c)) {
5257 if ('=' == v->text[c]) {
5258 val = v->text + c + 1;
5260 } else if ('\0' == v->text[c]) {
5278 for (k = kv; !(k->flags & EOV); k++)
5279 free((void *)(intptr_t)k->text);