2 * Copyright (c) 1990, 1991, 1992, 1993, 1994, 1995, 1996, 1997
3 * The Regents of the University of California. All rights reserved.
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that: (1) source code distributions
7 * retain the above copyright notice and this paragraph in its entirety, (2)
8 * distributions including binary code include the above copyright notice and
9 * this paragraph in its entirety in the documentation or other materials
10 * provided with the distribution, and (3) all advertising materials mentioning
11 * features or use of this software display the following acknowledgement:
12 * ``This product includes software developed by the University of California,
13 * Lawrence Berkeley Laboratory and its contributors.'' Neither the name of
14 * the University nor the names of its contributors may be used to endorse
15 * or promote products derived from this software without specific prior
17 * THIS SOFTWARE IS PROVIDED ``AS IS'' AND WITHOUT ANY EXPRESS OR IMPLIED
18 * WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTIES OF
19 * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
21 * By Jeffrey Mogul/DECWRL
22 * loosely based on print-bootp.c
25 /* \summary: Network Time Protocol (NTP) printer */
31 #include <netdissect-stdinc.h>
37 #include "netdissect.h"
38 #include "addrtoname.h"
41 static const char tstr
[] = " [|ntp]";
44 * Based on ntp.h from the U of MD implementation
45 * This file is based on Version 2 of the NTP spec (RFC1119).
49 * Definitions for the masses
51 #define JAN_1970 INT64_T_CONSTANT(2208988800) /* 1970 - 1900 in seconds */
54 * Structure definitions for NTP fixed point values
57 * 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
58 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
60 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
62 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
65 * 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
66 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
67 * | Integer Part | Fraction Part |
68 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
82 * 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
83 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
84 * |LI | VN |Mode | Stratum | Poll | Precision |
85 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
87 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
89 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
90 * | Reference Identifier |
91 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
93 * | Reference Timestamp (64) |
95 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
97 * | Originate Timestamp (64) |
99 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
101 * | Receive Timestamp (64) |
103 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
105 * | Transmit Timestamp (64) |
107 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
108 * | Key Identifier (optional) (32) |
109 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
112 * | Message Digest (optional) (128) |
115 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
118 /* Length of the NTP data message with the mandatory fields ("the header")
119 * and without any optional fields (extension, Key Identifier,
122 #define NTP_TIMEMSG_MINLEN 48U
124 struct ntp_time_data
{
125 nd_uint8_t status
; /* status of local clock and leap info */
126 nd_uint8_t stratum
; /* Stratum level */
127 nd_int8_t ppoll
; /* poll value */
129 struct s_fixedpt root_delay
;
130 struct s_fixedpt root_dispersion
;
132 struct l_fixedpt ref_timestamp
;
133 struct l_fixedpt org_timestamp
;
134 struct l_fixedpt rec_timestamp
;
135 struct l_fixedpt xmt_timestamp
;
137 nd_uint8_t message_digest
[20];
140 * Leap Second Codes (high order two bits)
142 #define NO_WARNING 0x00 /* no warning */
143 #define PLUS_SEC 0x40 /* add a second (61 seconds) */
144 #define MINUS_SEC 0x80 /* minus a second (59 seconds) */
145 #define ALARM 0xc0 /* alarm condition (clock unsynchronized) */
148 * Clock Status Bits that Encode Version
150 #define NTPVERSION_1 0x08
151 #define VERSIONMASK 0x38
152 #define VERSIONSHIFT 3
153 #define LEAPMASK 0xc0
156 #undef MODEMASK /* Solaris sucks */
158 #define MODEMASK 0x07
164 #define MODE_UNSPEC 0 /* unspecified */
165 #define MODE_SYM_ACT 1 /* symmetric active */
166 #define MODE_SYM_PAS 2 /* symmetric passive */
167 #define MODE_CLIENT 3 /* client */
168 #define MODE_SERVER 4 /* server */
169 #define MODE_BROADCAST 5 /* broadcast */
170 #define MODE_CONTROL 6 /* control message */
171 #define MODE_RES2 7 /* reserved */
174 * Stratum Definitions
176 #define UNSPECIFIED 0
177 #define PRIM_REF 1 /* radio clock */
178 #define INFO_QUERY 62 /* **** THIS implementation dependent **** */
179 #define INFO_REPLY 63 /* **** THIS implementation dependent **** */
181 static void p_sfix(netdissect_options
*ndo
, const struct s_fixedpt
*);
182 static void p_ntp_time(netdissect_options
*, const struct l_fixedpt
*);
183 static void p_ntp_delta(netdissect_options
*, const struct l_fixedpt
*, const struct l_fixedpt
*);
184 static void p_poll(netdissect_options
*, register const int);
186 static const struct tok ntp_mode_values
[] = {
187 { MODE_UNSPEC
, "unspecified" },
188 { MODE_SYM_ACT
, "symmetric active" },
189 { MODE_SYM_PAS
, "symmetric passive" },
190 { MODE_CLIENT
, "Client" },
191 { MODE_SERVER
, "Server" },
192 { MODE_BROADCAST
, "Broadcast" },
193 { MODE_CONTROL
, "Control Message" },
194 { MODE_RES2
, "Reserved" },
198 static const struct tok ntp_leapind_values
[] = {
201 { MINUS_SEC
, "-1s" },
202 { ALARM
, "clock unsynchronized" },
206 static const struct tok ntp_stratum_values
[] = {
207 { UNSPECIFIED
, "unspecified" },
208 { PRIM_REF
, "primary reference" },
212 /* draft-ietf-ntp-mode-6-cmds-02
214 * 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
215 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
216 * |LI | VN |Mode |R|E|M| OpCode | Sequence Number |
217 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
218 * | Status | Association ID |
219 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
221 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
223 * / Data (up to 468 bytes) /
225 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
226 * | Padding (optional) |
227 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
229 * / Authenticator (optional, 96 bytes) /
231 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
233 * Figure 1: NTP Control Message Header
236 /* Length of the NTP control message with the mandatory fields ("the header")
237 * and without any optional fields (Data, Padding, Authenticator).
239 #define NTP_CTRLMSG_MINLEN 12U
241 struct ntp_control_data
{
242 nd_uint8_t magic
; /* LI, VN, Mode */
243 nd_uint8_t control
; /* R, E, M, OpCode */
244 nd_uint16_t sequence
; /* Sequence Number */
245 nd_uint16_t status
; /* Status */
246 nd_uint16_t assoc
; /* Association ID */
247 nd_uint16_t offset
; /* Offset */
248 nd_uint16_t count
; /* Count */
249 nd_uint8_t data
[564]; /* Data, [Padding, [Authenticator]] */
253 * Print NTP time requests and responses
256 ntp_time_print(netdissect_options
*ndo
,
257 register const struct ntp_time_data
*bp
, u_int length
)
259 if (length
< NTP_TIMEMSG_MINLEN
)
262 ND_TCHECK(bp
->stratum
);
263 ND_PRINT((ndo
, ", Stratum %u (%s)",
265 tok2str(ntp_stratum_values
, (bp
->stratum
>=2 && bp
->stratum
<=15) ? "secondary reference" : "reserved", bp
->stratum
)));
267 ND_TCHECK(bp
->ppoll
);
268 ND_PRINT((ndo
, ", poll %d", bp
->ppoll
));
269 p_poll(ndo
, bp
->ppoll
);
271 ND_TCHECK(bp
->precision
);
272 ND_PRINT((ndo
, ", precision %d", bp
->precision
));
274 ND_TCHECK(bp
->root_delay
);
275 ND_PRINT((ndo
, "\n\tRoot Delay: "));
276 p_sfix(ndo
, &bp
->root_delay
);
278 ND_TCHECK(bp
->root_dispersion
);
279 ND_PRINT((ndo
, ", Root dispersion: "));
280 p_sfix(ndo
, &bp
->root_dispersion
);
282 ND_TCHECK(bp
->refid
);
283 ND_PRINT((ndo
, ", Reference-ID: "));
284 /* Interpretation depends on stratum */
285 switch (bp
->stratum
) {
288 ND_PRINT((ndo
, "(unspec)"));
292 if (fn_printn(ndo
, (const u_char
*)&(bp
->refid
), 4, ndo
->ndo_snapend
))
297 ND_PRINT((ndo
, "%s INFO_QUERY", ipaddr_string(ndo
, &(bp
->refid
))));
298 /* this doesn't have more content */
302 ND_PRINT((ndo
, "%s INFO_REPLY", ipaddr_string(ndo
, &(bp
->refid
))));
303 /* this is too complex to be worth printing */
307 /* In NTPv4 (RFC 5905) refid is an IPv4 address or first 32 bits of
308 MD5 sum of IPv6 address */
309 ND_PRINT((ndo
, "0x%08x", EXTRACT_32BITS(&bp
->refid
)));
313 ND_TCHECK(bp
->ref_timestamp
);
314 ND_PRINT((ndo
, "\n\t Reference Timestamp: "));
315 p_ntp_time(ndo
, &(bp
->ref_timestamp
));
317 ND_TCHECK(bp
->org_timestamp
);
318 ND_PRINT((ndo
, "\n\t Originator Timestamp: "));
319 p_ntp_time(ndo
, &(bp
->org_timestamp
));
321 ND_TCHECK(bp
->rec_timestamp
);
322 ND_PRINT((ndo
, "\n\t Receive Timestamp: "));
323 p_ntp_time(ndo
, &(bp
->rec_timestamp
));
325 ND_TCHECK(bp
->xmt_timestamp
);
326 ND_PRINT((ndo
, "\n\t Transmit Timestamp: "));
327 p_ntp_time(ndo
, &(bp
->xmt_timestamp
));
329 ND_PRINT((ndo
, "\n\t Originator - Receive Timestamp: "));
330 p_ntp_delta(ndo
, &(bp
->org_timestamp
), &(bp
->rec_timestamp
));
332 ND_PRINT((ndo
, "\n\t Originator - Transmit Timestamp: "));
333 p_ntp_delta(ndo
, &(bp
->org_timestamp
), &(bp
->xmt_timestamp
));
335 /* FIXME: this code is not aware of any extension fields */
336 if (length
== NTP_TIMEMSG_MINLEN
+ 4) { /* Optional: key-id (crypto-NAK) */
337 ND_TCHECK(bp
->key_id
);
338 ND_PRINT((ndo
, "\n\tKey id: %u", EXTRACT_32BITS(&bp
->key_id
)));
339 } else if (length
== NTP_TIMEMSG_MINLEN
+ 4 + 16) { /* Optional: key-id + 128-bit digest */
340 ND_TCHECK(bp
->key_id
);
341 ND_PRINT((ndo
, "\n\tKey id: %u", EXTRACT_32BITS(&bp
->key_id
)));
342 ND_TCHECK2(bp
->message_digest
, 16);
343 ND_PRINT((ndo
, "\n\tAuthentication: %08x%08x%08x%08x",
344 EXTRACT_32BITS(bp
->message_digest
),
345 EXTRACT_32BITS(bp
->message_digest
+ 4),
346 EXTRACT_32BITS(bp
->message_digest
+ 8),
347 EXTRACT_32BITS(bp
->message_digest
+ 12)));
348 } else if (length
== NTP_TIMEMSG_MINLEN
+ 4 + 20) { /* Optional: key-id + 160-bit digest */
349 ND_TCHECK(bp
->key_id
);
350 ND_PRINT((ndo
, "\n\tKey id: %u", EXTRACT_32BITS(&bp
->key_id
)));
351 ND_TCHECK2(bp
->message_digest
, 20);
352 ND_PRINT((ndo
, "\n\tAuthentication: %08x%08x%08x%08x%08x",
353 EXTRACT_32BITS(bp
->message_digest
),
354 EXTRACT_32BITS(bp
->message_digest
+ 4),
355 EXTRACT_32BITS(bp
->message_digest
+ 8),
356 EXTRACT_32BITS(bp
->message_digest
+ 12),
357 EXTRACT_32BITS(bp
->message_digest
+ 16)));
358 } else if (length
> NTP_TIMEMSG_MINLEN
) {
359 ND_PRINT((ndo
, "\n\t(%u more bytes after the header)", length
- NTP_TIMEMSG_MINLEN
));
364 ND_PRINT((ndo
, " %s", istr
));
365 ND_TCHECK2(*bp
, length
);
369 ND_PRINT((ndo
, " %s", tstr
));
373 * Print NTP control message requests and responses
376 ntp_control_print(netdissect_options
*ndo
,
377 register const struct ntp_control_data
*cd
, u_int length
)
379 u_char R
, E
, M
, opcode
;
380 uint16_t sequence
, status
, assoc
, offset
, count
;
382 if (length
< NTP_CTRLMSG_MINLEN
)
385 ND_TCHECK(cd
->control
);
386 R
= (cd
->control
& 0x80) != 0;
387 E
= (cd
->control
& 0x40) != 0;
388 M
= (cd
->control
& 0x20) != 0;
389 opcode
= cd
->control
& 0x1f;
390 ND_PRINT((ndo
, ", %s, %s, %s, OpCode=%u\n",
391 R
? "Response" : "Request", E
? "Error" : "OK",
392 M
? "More" : "Last", (unsigned)opcode
));
394 ND_TCHECK(cd
->sequence
);
395 sequence
= EXTRACT_16BITS(&cd
->sequence
);
396 ND_PRINT((ndo
, "\tSequence=%hu", sequence
));
398 ND_TCHECK(cd
->status
);
399 status
= EXTRACT_16BITS(&cd
->status
);
400 ND_PRINT((ndo
, ", Status=%#hx", status
));
402 ND_TCHECK(cd
->assoc
);
403 assoc
= EXTRACT_16BITS(&cd
->assoc
);
404 ND_PRINT((ndo
, ", Assoc.=%hu", assoc
));
406 ND_TCHECK(cd
->offset
);
407 offset
= EXTRACT_16BITS(&cd
->offset
);
408 ND_PRINT((ndo
, ", Offset=%hu", offset
));
410 ND_TCHECK(cd
->count
);
411 count
= EXTRACT_16BITS(&cd
->count
);
412 ND_PRINT((ndo
, ", Count=%hu", count
));
414 if (NTP_CTRLMSG_MINLEN
+ count
> length
)
417 ND_TCHECK2(cd
->data
, count
);
418 ND_PRINT((ndo
, "\n\tTO-BE-DONE: data not interpreted"));
423 ND_PRINT((ndo
, " %s", istr
));
424 ND_TCHECK2(*cd
, length
);
428 ND_PRINT((ndo
, " %s", tstr
));
432 struct ntp_time_data td
;
433 struct ntp_control_data cd
;
437 * Print NTP requests, handling the common VN, LI, and Mode
440 ntp_print(netdissect_options
*ndo
,
441 register const u_char
*cp
, u_int length
)
443 register const union ntpdata
*bp
= (const union ntpdata
*)cp
;
444 int mode
, version
, leapind
;
446 ND_TCHECK(bp
->td
.status
);
448 version
= (bp
->td
.status
& VERSIONMASK
) >> VERSIONSHIFT
;
449 ND_PRINT((ndo
, "NTPv%d", version
));
451 mode
= (bp
->td
.status
& MODEMASK
) >> MODESHIFT
;
452 if (!ndo
->ndo_vflag
) {
453 ND_PRINT((ndo
, ", %s, length %u",
454 tok2str(ntp_mode_values
, "Unknown mode", mode
),
459 ND_PRINT((ndo
, ", %s, length %u\n",
460 tok2str(ntp_mode_values
, "Unknown mode", mode
), length
));
462 /* leapind = (bp->td.status & LEAPMASK) >> LEAPSHIFT; */
463 leapind
= (bp
->td
.status
& LEAPMASK
);
464 ND_PRINT((ndo
, "\tLeap indicator: %s (%u)",
465 tok2str(ntp_leapind_values
, "Unknown", leapind
),
468 if (mode
>= MODE_UNSPEC
&& mode
<= MODE_BROADCAST
)
469 ntp_time_print(ndo
, &bp
->td
, length
);
470 else if (mode
== MODE_CONTROL
)
471 ntp_control_print(ndo
, &bp
->cd
, length
);
473 {;} /* XXX: not implemented! */
477 ND_PRINT((ndo
, " %s", tstr
));
481 p_sfix(netdissect_options
*ndo
,
482 register const struct s_fixedpt
*sfp
)
488 i
= EXTRACT_16BITS(&sfp
->int_part
);
489 f
= EXTRACT_16BITS(&sfp
->fraction
);
490 ff
= f
/ 65536.0; /* shift radix point by 16 bits */
491 f
= (int)(ff
* 1000000.0); /* Treat fraction as parts per million */
492 ND_PRINT((ndo
, "%d.%06d", i
, f
));
495 #define FMAXINT (4294967296.0) /* floating point rep. of MAXINT */
498 p_ntp_time(netdissect_options
*ndo
,
499 register const struct l_fixedpt
*lfp
)
502 register uint32_t uf
;
506 i
= EXTRACT_32BITS(&lfp
->int_part
);
507 uf
= EXTRACT_32BITS(&lfp
->fraction
);
509 if (ff
< 0.0) /* some compilers are buggy */
511 ff
= ff
/ FMAXINT
; /* shift radix point by 32 bits */
512 f
= (uint32_t)(ff
* 1000000000.0); /* treat fraction as parts per billion */
513 ND_PRINT((ndo
, "%u.%09d", i
, f
));
517 * print the UTC time in human-readable format.
520 int64_t seconds_64bit
= (int64_t)i
- JAN_1970
;
525 seconds
= (time_t)seconds_64bit
;
526 if (seconds
!= seconds_64bit
) {
528 * It doesn't fit into a time_t, so we can't hand it
531 ND_PRINT((ndo
, " (unrepresentable)"));
533 tm
= gmtime(&seconds
);
536 * gmtime() can't handle it.
537 * (Yes, that might happen with some version of
538 * Microsoft's C library.)
540 ND_PRINT((ndo
, " (unrepresentable)"));
542 /* use ISO 8601 (RFC3339) format */
543 strftime(time_buf
, sizeof (time_buf
), "%Y-%m-%dT%H:%M:%S", tm
);
544 ND_PRINT((ndo
, " (%s)", time_buf
));
551 /* Prints time difference between *lfp and *olfp */
553 p_ntp_delta(netdissect_options
*ndo
,
554 register const struct l_fixedpt
*olfp
,
555 register const struct l_fixedpt
*lfp
)
558 register uint32_t u
, uf
;
559 register uint32_t ou
, ouf
;
564 u
= EXTRACT_32BITS(&lfp
->int_part
);
565 ou
= EXTRACT_32BITS(&olfp
->int_part
);
566 uf
= EXTRACT_32BITS(&lfp
->fraction
);
567 ouf
= EXTRACT_32BITS(&olfp
->fraction
);
568 if (ou
== 0 && ouf
== 0) {
569 p_ntp_time(ndo
, lfp
);
575 if (i
> 0) { /* new is definitely greater than old */
578 if (ouf
> uf
) /* must borrow from high-order bits */
580 } else if (i
< 0) { /* new is definitely less than old */
583 if (uf
> ouf
) /* must carry into the high-order bits */
586 } else { /* int_part is zero */
597 if (ff
< 0.0) /* some compilers are buggy */
599 ff
= ff
/ FMAXINT
; /* shift radix point by 32 bits */
600 f
= (uint32_t)(ff
* 1000000000.0); /* treat fraction as parts per billion */
601 ND_PRINT((ndo
, "%s%d.%09d", signbit
? "-" : "+", i
, f
));
604 /* Prints polling interval in log2 as seconds or fraction of second */
606 p_poll(netdissect_options
*ndo
,
607 register const int poll_interval
)
609 if (poll_interval
<= -32 || poll_interval
>= 32)
612 if (poll_interval
>= 0)
613 ND_PRINT((ndo
, " (%us)", 1U << poll_interval
));
615 ND_PRINT((ndo
, " (1/%us)", 1U << -poll_interval
));