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 */
39 #include "netdissect-stdinc.h"
45 #include "netdissect.h"
46 #include "addrtoname.h"
51 * Based on ntp.h from the U of MD implementation
52 * This file is based on Version 2 of the NTP spec (RFC1119).
56 * Definitions for the masses
58 #define JAN_1970 INT64_T_CONSTANT(2208988800) /* 1970 - 1900 in seconds */
61 * Structure definitions for NTP fixed point values
64 * 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
65 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
67 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
69 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
72 * 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
73 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
74 * | Integer Part | Fraction Part |
75 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
89 * 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
90 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
91 * |LI | VN |Mode | Stratum | Poll | Precision |
92 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
94 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
96 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
97 * | Reference Identifier |
98 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
100 * | Reference Timestamp (64) |
102 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
104 * | Originate Timestamp (64) |
106 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
108 * | Receive Timestamp (64) |
110 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
112 * | Transmit Timestamp (64) |
114 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
115 * | Key Identifier (optional) (32) |
116 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
119 * | Message Digest (optional) (128) |
122 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
125 /* Length of the NTP data message with the mandatory fields ("the header")
126 * and without any optional fields (extension, Key Identifier,
129 #define NTP_TIMEMSG_MINLEN 48U
131 struct ntp_time_data
{
132 nd_uint8_t status
; /* status of local clock and leap info */
133 nd_uint8_t stratum
; /* Stratum level */
134 nd_int8_t ppoll
; /* poll value */
136 struct s_fixedpt root_delay
;
137 struct s_fixedpt root_dispersion
;
139 struct l_fixedpt ref_timestamp
;
140 struct l_fixedpt org_timestamp
;
141 struct l_fixedpt rec_timestamp
;
142 struct l_fixedpt xmt_timestamp
;
144 nd_uint8_t message_digest
[20];
147 * Leap Second Codes (high order two bits)
149 #define NO_WARNING 0x00 /* no warning */
150 #define PLUS_SEC 0x40 /* add a second (61 seconds) */
151 #define MINUS_SEC 0x80 /* minus a second (59 seconds) */
152 #define ALARM 0xc0 /* alarm condition (clock unsynchronized) */
155 * Clock Status Bits that Encode Version
157 #define NTPVERSION_1 0x08
158 #define VERSIONMASK 0x38
159 #define VERSIONSHIFT 3
160 #define LEAPMASK 0xc0
163 #undef MODEMASK /* Solaris sucks */
165 #define MODEMASK 0x07
171 #define MODE_UNSPEC 0 /* unspecified */
172 #define MODE_SYM_ACT 1 /* symmetric active */
173 #define MODE_SYM_PAS 2 /* symmetric passive */
174 #define MODE_CLIENT 3 /* client */
175 #define MODE_SERVER 4 /* server */
176 #define MODE_BROADCAST 5 /* broadcast */
177 #define MODE_CONTROL 6 /* control message */
178 #define MODE_RES2 7 /* reserved */
181 * Stratum Definitions
183 #define UNSPECIFIED 0
184 #define PRIM_REF 1 /* radio clock */
185 #define INFO_QUERY 62 /* **** THIS implementation dependent **** */
186 #define INFO_REPLY 63 /* **** THIS implementation dependent **** */
188 static void p_sfix(netdissect_options
*ndo
, const struct s_fixedpt
*);
189 static void p_ntp_time(netdissect_options
*, const struct l_fixedpt
*);
190 static void p_ntp_delta(netdissect_options
*, const struct l_fixedpt
*, const struct l_fixedpt
*);
191 static void p_poll(netdissect_options
*, const int);
193 static const struct tok ntp_mode_values
[] = {
194 { MODE_UNSPEC
, "unspecified" },
195 { MODE_SYM_ACT
, "symmetric active" },
196 { MODE_SYM_PAS
, "symmetric passive" },
197 { MODE_CLIENT
, "Client" },
198 { MODE_SERVER
, "Server" },
199 { MODE_BROADCAST
, "Broadcast" },
200 { MODE_CONTROL
, "Control Message" },
201 { MODE_RES2
, "Reserved" },
205 static const struct tok ntp_leapind_values
[] = {
208 { MINUS_SEC
, "-1s" },
209 { ALARM
, "clock unsynchronized" },
213 static const struct tok ntp_stratum_values
[] = {
214 { UNSPECIFIED
, "unspecified" },
215 { PRIM_REF
, "primary reference" },
219 /* draft-ietf-ntp-mode-6-cmds-02
221 * 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
222 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
223 * |LI | VN |Mode |R|E|M| OpCode | Sequence Number |
224 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
225 * | Status | Association ID |
226 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
228 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
230 * / Data (up to 468 bytes) /
232 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
233 * | Padding (optional) |
234 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
236 * / Authenticator (optional, 96 bytes) /
238 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
240 * Figure 1: NTP Control Message Header
243 /* Length of the NTP control message with the mandatory fields ("the header")
244 * and without any optional fields (Data, Padding, Authenticator).
246 #define NTP_CTRLMSG_MINLEN 12U
248 struct ntp_control_data
{
249 nd_uint8_t magic
; /* LI, VN, Mode */
250 nd_uint8_t control
; /* R, E, M, OpCode */
251 nd_uint16_t sequence
; /* Sequence Number */
252 nd_uint16_t status
; /* Status */
253 nd_uint16_t assoc
; /* Association ID */
254 nd_uint16_t offset
; /* Offset */
255 nd_uint16_t count
; /* Count */
256 nd_uint8_t data
[564]; /* Data, [Padding, [Authenticator]] */
260 * Print NTP time requests and responses
263 ntp_time_print(netdissect_options
*ndo
,
264 const struct ntp_time_data
*bp
, u_int length
)
268 if (length
< NTP_TIMEMSG_MINLEN
)
271 ND_TCHECK_1(bp
->stratum
);
272 stratum
= GET_U_1(bp
->stratum
);
273 ND_PRINT(", Stratum %u (%s)",
275 tok2str(ntp_stratum_values
, (stratum
>=2 && stratum
<=15) ? "secondary reference" : "reserved", stratum
));
277 ND_TCHECK_1(bp
->ppoll
);
278 ND_PRINT(", poll %d", GET_S_1(bp
->ppoll
));
279 p_poll(ndo
, GET_S_1(bp
->ppoll
));
281 ND_TCHECK_1(bp
->precision
);
282 ND_PRINT(", precision %d", GET_S_1(bp
->precision
));
284 ND_TCHECK_SIZE(&bp
->root_delay
);
285 ND_PRINT("\n\tRoot Delay: ");
286 p_sfix(ndo
, &bp
->root_delay
);
288 ND_TCHECK_SIZE(&bp
->root_dispersion
);
289 ND_PRINT(", Root dispersion: ");
290 p_sfix(ndo
, &bp
->root_dispersion
);
292 ND_TCHECK_4(bp
->refid
);
293 ND_PRINT(", Reference-ID: ");
294 /* Interpretation depends on stratum */
298 ND_PRINT("(unspec)");
302 if (nd_printn(ndo
, (const u_char
*)&(bp
->refid
), 4, ndo
->ndo_snapend
))
307 ND_PRINT("%s INFO_QUERY", ipaddr_string(ndo
, bp
->refid
));
308 /* this doesn't have more content */
312 ND_PRINT("%s INFO_REPLY", ipaddr_string(ndo
, bp
->refid
));
313 /* this is too complex to be worth printing */
317 /* In NTPv4 (RFC 5905) refid is an IPv4 address or first 32 bits of
318 MD5 sum of IPv6 address */
319 ND_PRINT("0x%08x", GET_BE_U_4(bp
->refid
));
323 ND_TCHECK_SIZE(&bp
->ref_timestamp
);
324 ND_PRINT("\n\t Reference Timestamp: ");
325 p_ntp_time(ndo
, &(bp
->ref_timestamp
));
327 ND_TCHECK_SIZE(&bp
->org_timestamp
);
328 ND_PRINT("\n\t Originator Timestamp: ");
329 p_ntp_time(ndo
, &(bp
->org_timestamp
));
331 ND_TCHECK_SIZE(&bp
->rec_timestamp
);
332 ND_PRINT("\n\t Receive Timestamp: ");
333 p_ntp_time(ndo
, &(bp
->rec_timestamp
));
335 ND_TCHECK_SIZE(&bp
->xmt_timestamp
);
336 ND_PRINT("\n\t Transmit Timestamp: ");
337 p_ntp_time(ndo
, &(bp
->xmt_timestamp
));
339 ND_PRINT("\n\t Originator - Receive Timestamp: ");
340 p_ntp_delta(ndo
, &(bp
->org_timestamp
), &(bp
->rec_timestamp
));
342 ND_PRINT("\n\t Originator - Transmit Timestamp: ");
343 p_ntp_delta(ndo
, &(bp
->org_timestamp
), &(bp
->xmt_timestamp
));
345 /* FIXME: this code is not aware of any extension fields */
346 if (length
== NTP_TIMEMSG_MINLEN
+ 4) { /* Optional: key-id (crypto-NAK) */
347 ND_TCHECK_4(bp
->key_id
);
348 ND_PRINT("\n\tKey id: %u", GET_BE_U_4(bp
->key_id
));
349 } else if (length
== NTP_TIMEMSG_MINLEN
+ 4 + 16) { /* Optional: key-id + 128-bit digest */
350 ND_TCHECK_4(bp
->key_id
);
351 ND_PRINT("\n\tKey id: %u", GET_BE_U_4(bp
->key_id
));
352 ND_TCHECK_LEN(bp
->message_digest
, 16);
353 ND_PRINT("\n\tAuthentication: %08x%08x%08x%08x",
354 GET_BE_U_4(bp
->message_digest
),
355 GET_BE_U_4(bp
->message_digest
+ 4),
356 GET_BE_U_4(bp
->message_digest
+ 8),
357 GET_BE_U_4(bp
->message_digest
+ 12));
358 } else if (length
== NTP_TIMEMSG_MINLEN
+ 4 + 20) { /* Optional: key-id + 160-bit digest */
359 ND_TCHECK_4(bp
->key_id
);
360 ND_PRINT("\n\tKey id: %u", GET_BE_U_4(bp
->key_id
));
361 ND_TCHECK_LEN(bp
->message_digest
, 20);
362 ND_PRINT("\n\tAuthentication: %08x%08x%08x%08x%08x",
363 GET_BE_U_4(bp
->message_digest
),
364 GET_BE_U_4(bp
->message_digest
+ 4),
365 GET_BE_U_4(bp
->message_digest
+ 8),
366 GET_BE_U_4(bp
->message_digest
+ 12),
367 GET_BE_U_4(bp
->message_digest
+ 16));
368 } else if (length
> NTP_TIMEMSG_MINLEN
) {
369 ND_PRINT("\n\t(%u more bytes after the header)", length
- NTP_TIMEMSG_MINLEN
);
374 nd_print_invalid(ndo
);
375 ND_TCHECK_LEN(bp
, length
);
383 * Print NTP control message requests and responses
386 ntp_control_print(netdissect_options
*ndo
,
387 const struct ntp_control_data
*cd
, u_int length
)
389 uint8_t control
, R
, E
, M
, opcode
;
390 uint16_t sequence
, status
, assoc
, offset
, count
;
392 if (length
< NTP_CTRLMSG_MINLEN
)
395 ND_TCHECK_1(cd
->control
);
396 control
= GET_U_1(cd
->control
);
397 R
= (control
& 0x80) != 0;
398 E
= (control
& 0x40) != 0;
399 M
= (control
& 0x20) != 0;
400 opcode
= control
& 0x1f;
401 ND_PRINT(", %s, %s, %s, OpCode=%u\n",
402 R
? "Response" : "Request", E
? "Error" : "OK",
403 M
? "More" : "Last", opcode
);
405 ND_TCHECK_2(cd
->sequence
);
406 sequence
= GET_BE_U_2(cd
->sequence
);
407 ND_PRINT("\tSequence=%hu", sequence
);
409 ND_TCHECK_2(cd
->status
);
410 status
= GET_BE_U_2(cd
->status
);
411 ND_PRINT(", Status=%#hx", status
);
413 ND_TCHECK_2(cd
->assoc
);
414 assoc
= GET_BE_U_2(cd
->assoc
);
415 ND_PRINT(", Assoc.=%hu", assoc
);
417 ND_TCHECK_2(cd
->offset
);
418 offset
= GET_BE_U_2(cd
->offset
);
419 ND_PRINT(", Offset=%hu", offset
);
421 ND_TCHECK_2(cd
->count
);
422 count
= GET_BE_U_2(cd
->count
);
423 ND_PRINT(", Count=%hu", count
);
425 if (NTP_CTRLMSG_MINLEN
+ count
> length
)
428 ND_TCHECK_LEN(cd
->data
, count
);
429 ND_PRINT("\n\tTO-BE-DONE: data not interpreted");
434 nd_print_invalid(ndo
);
435 ND_TCHECK_LEN(cd
, length
);
443 struct ntp_time_data td
;
444 struct ntp_control_data cd
;
448 * Print NTP requests, handling the common VN, LI, and Mode
451 ntp_print(netdissect_options
*ndo
,
452 const u_char
*cp
, u_int length
)
454 const union ntpdata
*bp
= (const union ntpdata
*)cp
;
455 u_int mode
, version
, leapind
;
458 ndo
->ndo_protocol
= "ntp";
459 ND_TCHECK_1(bp
->td
.status
);
460 status
= GET_U_1(bp
->td
.status
);
462 version
= (status
& VERSIONMASK
) >> VERSIONSHIFT
;
463 ND_PRINT("NTPv%u", version
);
465 mode
= (status
& MODEMASK
) >> MODESHIFT
;
466 if (!ndo
->ndo_vflag
) {
467 ND_PRINT(", %s, length %u",
468 tok2str(ntp_mode_values
, "Unknown mode", mode
),
473 ND_PRINT(", %s, length %u\n",
474 tok2str(ntp_mode_values
, "Unknown mode", mode
), length
);
476 /* leapind = (status & LEAPMASK) >> LEAPSHIFT; */
477 leapind
= (status
& LEAPMASK
);
478 ND_PRINT("\tLeap indicator: %s (%u)",
479 tok2str(ntp_leapind_values
, "Unknown", leapind
),
490 ntp_time_print(ndo
, &bp
->td
, length
);
494 ntp_control_print(ndo
, &bp
->cd
, length
);
498 break; /* XXX: not implemented! */
507 p_sfix(netdissect_options
*ndo
,
508 const struct s_fixedpt
*sfp
)
514 i
= GET_BE_U_2(sfp
->int_part
);
515 f
= GET_BE_U_2(sfp
->fraction
);
516 ff
= f
/ 65536.0; /* shift radix point by 16 bits */
517 f
= (int)(ff
* 1000000.0); /* Treat fraction as parts per million */
518 ND_PRINT("%d.%06d", i
, f
);
521 #define FMAXINT (4294967296.0) /* floating point rep. of MAXINT */
524 p_ntp_time(netdissect_options
*ndo
,
525 const struct l_fixedpt
*lfp
)
532 i
= GET_BE_U_4(lfp
->int_part
);
533 uf
= GET_BE_U_4(lfp
->fraction
);
535 if (ff
< 0.0) /* some compilers are buggy */
537 ff
= ff
/ FMAXINT
; /* shift radix point by 32 bits */
538 f
= (uint32_t)(ff
* 1000000000.0); /* treat fraction as parts per billion */
539 ND_PRINT("%u.%09u", i
, f
);
543 * print the UTC time in human-readable format.
546 int64_t seconds_64bit
= (int64_t)i
- JAN_1970
;
551 seconds
= (time_t)seconds_64bit
;
552 if (seconds
!= seconds_64bit
) {
554 * It doesn't fit into a time_t, so we can't hand it
557 ND_PRINT(" (unrepresentable)");
559 tm
= gmtime(&seconds
);
562 * gmtime() can't handle it.
563 * (Yes, that might happen with some version of
564 * Microsoft's C library.)
566 ND_PRINT(" (unrepresentable)");
568 /* use ISO 8601 (RFC3339) format */
569 strftime(time_buf
, sizeof (time_buf
), "%Y-%m-%dT%H:%M:%SZ", tm
);
570 ND_PRINT(" (%s)", time_buf
);
577 /* Prints time difference between *lfp and *olfp */
579 p_ntp_delta(netdissect_options
*ndo
,
580 const struct l_fixedpt
*olfp
,
581 const struct l_fixedpt
*lfp
)
590 u
= GET_BE_U_4(lfp
->int_part
);
591 ou
= GET_BE_U_4(olfp
->int_part
);
592 uf
= GET_BE_U_4(lfp
->fraction
);
593 ouf
= GET_BE_U_4(olfp
->fraction
);
594 if (ou
== 0 && ouf
== 0) {
595 p_ntp_time(ndo
, lfp
);
599 if (u
> ou
) { /* new is definitely greater than old */
603 if (ouf
> uf
) /* must borrow from high-order bits */
605 } else if (u
< ou
) { /* new is definitely less than old */
609 if (uf
> ouf
) /* must borrow from the high-order bits */
611 } else { /* int_part is zero */
623 if (ff
< 0.0) /* some compilers are buggy */
625 ff
= ff
/ FMAXINT
; /* shift radix point by 32 bits */
626 f
= (uint32_t)(ff
* 1000000000.0); /* treat fraction as parts per billion */
627 ND_PRINT("%s%u.%09u", signbit
? "-" : "+", i
, f
);
630 /* Prints polling interval in log2 as seconds or fraction of second */
632 p_poll(netdissect_options
*ndo
,
633 const int poll_interval
)
635 if (poll_interval
<= -32 || poll_interval
>= 32)
638 if (poll_interval
>= 0)
639 ND_PRINT(" (%us)", 1U << poll_interval
);
641 ND_PRINT(" (1/%us)", 1U << -poll_interval
);