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 */
37 #include "netdissect-stdinc.h"
39 #define ND_LONGJMP_FROM_TCHECK
40 #include "netdissect.h"
41 #include "addrtoname.h"
47 * Based on ntp.h from the U of MD implementation
48 * This file is based on Version 2 of the NTP spec (RFC1119).
51 /* RFC 5905 updated by RFC 7822
53 * 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
54 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
55 * |LI | VN |Mode | Stratum | Poll | Precision |
56 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
58 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
60 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
61 * | Reference Identifier |
62 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
64 * | Reference Timestamp (64) |
66 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
68 * | Originate Timestamp (64) |
70 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
72 * | Receive Timestamp (64) |
74 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
76 * | Transmit Timestamp (64) |
78 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
81 * . Optional Extensions (variable) .
84 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
87 /* Length of the NTP data message with the mandatory fields ("the header")
88 * and without any optional fields (extension, Key Identifier,
91 #define NTP_TIMEMSG_MINLEN 48U
93 struct ntp_time_data
{
94 nd_uint8_t status
; /* status of local clock and leap info */
95 nd_uint8_t stratum
; /* Stratum level */
96 nd_int8_t ppoll
; /* poll value */
98 struct s_fixedpt root_delay
;
99 struct s_fixedpt root_dispersion
;
101 struct l_fixedpt ref_timestamp
;
102 struct l_fixedpt org_timestamp
;
103 struct l_fixedpt rec_timestamp
;
104 struct l_fixedpt xmt_timestamp
;
105 /* extension fields and/or MAC follow */
108 struct ntp_extension_field
{
115 * Leap Second Codes (high order two bits)
117 #define NO_WARNING 0x00 /* no warning */
118 #define PLUS_SEC 0x40 /* add a second (61 seconds) */
119 #define MINUS_SEC 0x80 /* minus a second (59 seconds) */
120 #define ALARM 0xc0 /* alarm condition (clock unsynchronized) */
123 * Clock Status Bits that Encode Version
125 #define NTPVERSION_1 0x08
126 #define VERSIONMASK 0x38
127 #define VERSIONSHIFT 3
128 #define LEAPMASK 0xc0
131 #undef MODEMASK /* Solaris sucks */
133 #define MODEMASK 0x07
139 #define MODE_UNSPEC 0 /* unspecified */
140 #define MODE_SYM_ACT 1 /* symmetric active */
141 #define MODE_SYM_PAS 2 /* symmetric passive */
142 #define MODE_CLIENT 3 /* client */
143 #define MODE_SERVER 4 /* server */
144 #define MODE_BROADCAST 5 /* broadcast */
145 #define MODE_CONTROL 6 /* control message */
146 #define MODE_RES2 7 /* reserved */
149 * Stratum Definitions
151 #define UNSPECIFIED 0
152 #define PRIM_REF 1 /* radio clock */
153 #define INFO_QUERY 62 /* **** THIS implementation dependent **** */
154 #define INFO_REPLY 63 /* **** THIS implementation dependent **** */
156 static void p_sfix(netdissect_options
*ndo
, const struct s_fixedpt
*);
157 static void p_ntp_delta(netdissect_options
*, const struct l_fixedpt
*, const struct l_fixedpt
*);
158 static void p_poll(netdissect_options
*, const int);
159 static u_int
p_ext_fields(netdissect_options
*, const u_char
*, u_int length
);
161 static const struct tok ntp_mode_values
[] = {
162 { MODE_UNSPEC
, "unspecified" },
163 { MODE_SYM_ACT
, "symmetric active" },
164 { MODE_SYM_PAS
, "symmetric passive" },
165 { MODE_CLIENT
, "Client" },
166 { MODE_SERVER
, "Server" },
167 { MODE_BROADCAST
, "Broadcast" },
168 { MODE_CONTROL
, "Control Message" },
169 { MODE_RES2
, "Reserved" },
173 static const struct tok ntp_leapind_values
[] = {
176 { MINUS_SEC
, "-1s" },
177 { ALARM
, "clock unsynchronized" },
181 static const struct tok ntp_stratum_values
[] = {
182 { UNSPECIFIED
, "unspecified" },
183 { PRIM_REF
, "primary reference" },
187 static const struct tok ntp_ef_types
[] = {
188 { 0x0104, "Unique Identifier" },
189 { 0x0204, "NTS Cookie" },
190 { 0x0304, "NTS Cookie Placeholder" },
191 { 0x0404, "NTS Authenticator and Encrypted Extension Fields" },
192 { 0x2005, "Checksum Complement" },
196 /* draft-ietf-ntp-mode-6-cmds-02
198 * 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
199 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
200 * |LI | VN |Mode |R|E|M| OpCode | Sequence Number |
201 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
202 * | Status | Association ID |
203 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
205 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
207 * / Data (up to 468 bytes) /
209 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
210 * | Padding (optional) |
211 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
213 * / Authenticator (optional, 96 bytes) /
215 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
217 * Figure 1: NTP Control Message Header
220 /* Length of the NTP control message with the mandatory fields ("the header")
221 * and without any optional fields (Data, Padding, Authenticator).
223 #define NTP_CTRLMSG_MINLEN 12U
225 struct ntp_control_data
{
226 nd_uint8_t magic
; /* LI, VN, Mode */
227 nd_uint8_t control
; /* R, E, M, OpCode */
228 nd_uint16_t sequence
; /* Sequence Number */
229 nd_uint16_t status
; /* Status */
230 nd_uint16_t assoc
; /* Association ID */
231 nd_uint16_t offset
; /* Offset */
232 nd_uint16_t count
; /* Count */
233 nd_uint8_t data
[564]; /* Data, [Padding, [Authenticator]] */
237 * Print NTP time requests and responses
240 ntp_time_print(netdissect_options
*ndo
,
241 const struct ntp_time_data
*bp
, u_int length
, u_int version
)
247 if (length
< NTP_TIMEMSG_MINLEN
)
250 stratum
= GET_U_1(bp
->stratum
);
251 ND_PRINT(", Stratum %u (%s)",
253 tok2str(ntp_stratum_values
, (stratum
>=2 && stratum
<=15) ? "secondary reference" : "reserved", stratum
));
255 ND_PRINT(", poll %d", GET_S_1(bp
->ppoll
));
256 p_poll(ndo
, GET_S_1(bp
->ppoll
));
258 ND_PRINT(", precision %d", GET_S_1(bp
->precision
));
260 ND_PRINT("\n\tRoot Delay: ");
261 p_sfix(ndo
, &bp
->root_delay
);
263 ND_PRINT(", Root dispersion: ");
264 p_sfix(ndo
, &bp
->root_dispersion
);
266 ND_PRINT(", Reference-ID: ");
267 /* Interpretation depends on stratum */
271 ND_PRINT("(unspec)");
272 ND_TCHECK_4(bp
->refid
);
276 nd_printjn(ndo
, (const u_char
*)&(bp
->refid
), 4);
280 ND_PRINT("%s INFO_QUERY", GET_IPADDR_STRING(bp
->refid
));
281 /* this doesn't have more content */
285 ND_PRINT("%s INFO_REPLY", GET_IPADDR_STRING(bp
->refid
));
286 /* this is too complex to be worth printing */
290 /* In NTPv4 (RFC 5905) refid is an IPv4 address or first 32 bits of
291 MD5 sum of IPv6 address */
292 ND_PRINT("0x%08x", GET_BE_U_4(bp
->refid
));
296 ND_PRINT("\n\t Reference Timestamp: ");
297 p_ntp_time(ndo
, &(bp
->ref_timestamp
));
299 ND_PRINT("\n\t Originator Timestamp: ");
300 p_ntp_time(ndo
, &(bp
->org_timestamp
));
302 ND_PRINT("\n\t Receive Timestamp: ");
303 p_ntp_time(ndo
, &(bp
->rec_timestamp
));
305 ND_PRINT("\n\t Transmit Timestamp: ");
306 p_ntp_time(ndo
, &(bp
->xmt_timestamp
));
308 ND_PRINT("\n\t Originator - Receive Timestamp: ");
309 p_ntp_delta(ndo
, &(bp
->org_timestamp
), &(bp
->rec_timestamp
));
311 ND_PRINT("\n\t Originator - Transmit Timestamp: ");
312 p_ntp_delta(ndo
, &(bp
->org_timestamp
), &(bp
->xmt_timestamp
));
315 efs_len
= p_ext_fields(ndo
, (const u_char
*)bp
+ NTP_TIMEMSG_MINLEN
, length
- NTP_TIMEMSG_MINLEN
);
319 mac
= (const u_char
*)bp
+ NTP_TIMEMSG_MINLEN
+ efs_len
;
321 if (length
== NTP_TIMEMSG_MINLEN
+ efs_len
+ 4) { /* Optional: key-id (crypto-NAK) */
322 ND_PRINT("\n\tKey id: %u", GET_BE_U_4(mac
));
323 } else if (length
== NTP_TIMEMSG_MINLEN
+ efs_len
+ 4 + 16) { /* Optional: key-id + 128-bit digest */
324 ND_PRINT("\n\tKey id: %u", GET_BE_U_4(mac
));
325 ND_PRINT("\n\tAuthentication: %08x%08x%08x%08x",
328 GET_BE_U_4(mac
+ 12),
329 GET_BE_U_4(mac
+ 16));
330 } else if (length
== NTP_TIMEMSG_MINLEN
+ efs_len
+ 4 + 20) { /* Optional: key-id + 160-bit digest */
331 ND_PRINT("\n\tKey id: %u", GET_BE_U_4(mac
));
332 ND_PRINT("\n\tAuthentication: %08x%08x%08x%08x%08x",
335 GET_BE_U_4(mac
+ 12),
336 GET_BE_U_4(mac
+ 16),
337 GET_BE_U_4(mac
+ 20));
338 } else if (length
> NTP_TIMEMSG_MINLEN
+ efs_len
) {
339 ND_PRINT("\n\t(%u more bytes after the header and extension fields)",
340 length
- NTP_TIMEMSG_MINLEN
- efs_len
);
345 nd_print_invalid(ndo
);
346 ND_TCHECK_LEN(bp
, length
);
350 * Print NTP control message requests and responses
353 ntp_control_print(netdissect_options
*ndo
,
354 const struct ntp_control_data
*cd
, u_int length
)
356 uint8_t control
, R
, E
, M
, opcode
;
357 uint16_t sequence
, status
, assoc
, offset
, count
;
359 if (length
< NTP_CTRLMSG_MINLEN
)
362 control
= GET_U_1(cd
->control
);
363 R
= (control
& 0x80) != 0;
364 E
= (control
& 0x40) != 0;
365 M
= (control
& 0x20) != 0;
366 opcode
= control
& 0x1f;
367 ND_PRINT(", %s, %s, %s, OpCode=%u\n",
368 R
? "Response" : "Request", E
? "Error" : "OK",
369 M
? "More" : "Last", opcode
);
371 sequence
= GET_BE_U_2(cd
->sequence
);
372 ND_PRINT("\tSequence=%hu", sequence
);
374 status
= GET_BE_U_2(cd
->status
);
375 ND_PRINT(", Status=%#hx", status
);
377 assoc
= GET_BE_U_2(cd
->assoc
);
378 ND_PRINT(", Assoc.=%hu", assoc
);
380 offset
= GET_BE_U_2(cd
->offset
);
381 ND_PRINT(", Offset=%hu", offset
);
383 count
= GET_BE_U_2(cd
->count
);
384 ND_PRINT(", Count=%hu", count
);
386 if (NTP_CTRLMSG_MINLEN
+ count
> length
)
389 ND_TCHECK_LEN(cd
->data
, count
);
390 ND_PRINT("\n\tTO-BE-DONE: data not interpreted");
395 nd_print_invalid(ndo
);
396 ND_TCHECK_LEN(cd
, length
);
400 struct ntp_time_data td
;
401 struct ntp_control_data cd
;
405 * Print NTP requests, handling the common VN, LI, and Mode
408 ntp_print(netdissect_options
*ndo
,
409 const u_char
*cp
, u_int length
)
411 const union ntpdata
*bp
= (const union ntpdata
*)cp
;
412 u_int mode
, version
, leapind
;
415 ndo
->ndo_protocol
= "ntp";
416 status
= GET_U_1(bp
->td
.status
);
418 version
= (status
& VERSIONMASK
) >> VERSIONSHIFT
;
419 ND_PRINT("NTPv%u", version
);
421 mode
= (status
& MODEMASK
) >> MODESHIFT
;
422 if (!ndo
->ndo_vflag
) {
423 ND_PRINT(", %s, length %u",
424 tok2str(ntp_mode_values
, "Unknown mode", mode
),
429 ND_PRINT(", %s, length %u\n",
430 tok2str(ntp_mode_values
, "Unknown mode", mode
), length
);
432 /* leapind = (status & LEAPMASK) >> LEAPSHIFT; */
433 leapind
= (status
& LEAPMASK
);
434 ND_PRINT("\tLeap indicator: %s (%u)",
435 tok2str(ntp_leapind_values
, "Unknown", leapind
),
446 ntp_time_print(ndo
, &bp
->td
, length
, version
);
450 ntp_control_print(ndo
, &bp
->cd
, length
);
454 break; /* XXX: not implemented! */
459 p_sfix(netdissect_options
*ndo
,
460 const struct s_fixedpt
*sfp
)
466 i
= GET_BE_U_2(sfp
->int_part
);
467 f
= GET_BE_U_2(sfp
->fraction
);
468 ff
= f
/ 65536.0; /* shift radix point by 16 bits */
469 f
= (int)(ff
* 1000000.0); /* Treat fraction as parts per million */
470 ND_PRINT("%d.%06d", i
, f
);
473 /* Prints time difference between *lfp and *olfp */
475 p_ntp_delta(netdissect_options
*ndo
,
476 const struct l_fixedpt
*olfp
,
477 const struct l_fixedpt
*lfp
)
486 u
= GET_BE_U_4(lfp
->int_part
);
487 ou
= GET_BE_U_4(olfp
->int_part
);
488 uf
= GET_BE_U_4(lfp
->fraction
);
489 ouf
= GET_BE_U_4(olfp
->fraction
);
490 if (ou
== 0 && ouf
== 0) {
491 p_ntp_time(ndo
, lfp
);
495 if (u
> ou
) { /* new is definitely greater than old */
499 if (ouf
> uf
) /* must borrow from high-order bits */
501 } else if (u
< ou
) { /* new is definitely less than old */
505 if (uf
> ouf
) /* must borrow from the high-order bits */
507 } else { /* int_part is zero */
519 if (ff
< 0.0) /* some compilers are buggy */
521 ff
= ff
/ FMAXINT
; /* shift radix point by 32 bits */
522 f
= (uint32_t)(ff
* 1000000000.0); /* treat fraction as parts per billion */
523 ND_PRINT("%s%u.%09u", signbit
? "-" : "+", i
, f
);
526 /* Prints polling interval in log2 as seconds or fraction of second */
528 p_poll(netdissect_options
*ndo
,
529 const int poll_interval
)
531 if (poll_interval
<= -32 || poll_interval
>= 32)
534 if (poll_interval
>= 0)
535 ND_PRINT(" (%us)", 1U << poll_interval
);
537 ND_PRINT(" (1/%us)", 1U << -poll_interval
);
540 /* Prints an NTPv4 extension field */
542 p_ntp_ef(netdissect_options
*ndo
, u_int type
, u_int length
, const u_char
*ef_body
)
544 ND_PRINT("\n\t %s", tok2str(ntp_ef_types
, "Unknown type", type
));
545 ND_PRINT(" (0x%04x), length %u", type
, length
);
547 if (ndo
->ndo_vflag
> 2)
548 hex_print(ndo
, "\n\t ", ef_body
, length
- 4);
551 * If we're not going to print it, at least make sure
552 * it's present in the packet, so if ef_len is too long,
555 ND_TCHECK_LEN(ef_body
, length
- 4);
559 /* Prints list of extension fields per RFC 7822 */
561 p_ext_fields(netdissect_options
*ndo
, const u_char
*cp
, u_int length
)
563 const struct ntp_extension_field
*ef
;
564 u_int ef_type
, ef_len
, efs_len
;
570 /* RFC 7822 requires the last EF in the packet to have at least
571 28 octets to avoid ambiguity with MACs */
572 while (length
- efs_len
>= 28) {
573 ef
= (const struct ntp_extension_field
*)(cp
+ efs_len
);
574 ef_type
= GET_BE_U_2(ef
->type
);
575 ef_len
= GET_BE_U_2(ef
->length
);
577 if (efs_len
+ ef_len
> length
|| ef_len
< 4 || ef_len
% 4 != 0) {
578 nd_print_invalid(ndo
);
583 ND_PRINT("\n\tExtension fields:");
587 p_ntp_ef(ndo
, ef_type
, ef_len
, (const u_char
*)(ef
+ 1));
590 * The entire extension field is guaranteed to be in the
591 * captured data, as p_ntp_ef() will longjmp out if it
594 * As the total length of the captured data fits in a
595 * u_int, this means that the total length of all the
596 * extension fields will fit in a u_int, so this will