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 #define ND_LONGJMP_FROM_TCHECK
46 #include "netdissect.h"
47 #include "addrtoname.h"
53 * Based on ntp.h from the U of MD implementation
54 * This file is based on Version 2 of the NTP spec (RFC1119).
59 * 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
60 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
61 * |LI | VN |Mode | Stratum | Poll | Precision |
62 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
64 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
66 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
67 * | Reference Identifier |
68 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
70 * | Reference Timestamp (64) |
72 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
74 * | Originate Timestamp (64) |
76 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
78 * | Receive Timestamp (64) |
80 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
82 * | Transmit Timestamp (64) |
84 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
85 * | Key Identifier (optional) (32) |
86 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
89 * | Message Digest (optional) (128) |
92 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
95 /* Length of the NTP data message with the mandatory fields ("the header")
96 * and without any optional fields (extension, Key Identifier,
99 #define NTP_TIMEMSG_MINLEN 48U
101 struct ntp_time_data
{
102 nd_uint8_t status
; /* status of local clock and leap info */
103 nd_uint8_t stratum
; /* Stratum level */
104 nd_int8_t ppoll
; /* poll value */
106 struct s_fixedpt root_delay
;
107 struct s_fixedpt root_dispersion
;
109 struct l_fixedpt ref_timestamp
;
110 struct l_fixedpt org_timestamp
;
111 struct l_fixedpt rec_timestamp
;
112 struct l_fixedpt xmt_timestamp
;
114 nd_uint8_t message_digest
[20];
117 * Leap Second Codes (high order two bits)
119 #define NO_WARNING 0x00 /* no warning */
120 #define PLUS_SEC 0x40 /* add a second (61 seconds) */
121 #define MINUS_SEC 0x80 /* minus a second (59 seconds) */
122 #define ALARM 0xc0 /* alarm condition (clock unsynchronized) */
125 * Clock Status Bits that Encode Version
127 #define NTPVERSION_1 0x08
128 #define VERSIONMASK 0x38
129 #define VERSIONSHIFT 3
130 #define LEAPMASK 0xc0
133 #undef MODEMASK /* Solaris sucks */
135 #define MODEMASK 0x07
141 #define MODE_UNSPEC 0 /* unspecified */
142 #define MODE_SYM_ACT 1 /* symmetric active */
143 #define MODE_SYM_PAS 2 /* symmetric passive */
144 #define MODE_CLIENT 3 /* client */
145 #define MODE_SERVER 4 /* server */
146 #define MODE_BROADCAST 5 /* broadcast */
147 #define MODE_CONTROL 6 /* control message */
148 #define MODE_RES2 7 /* reserved */
151 * Stratum Definitions
153 #define UNSPECIFIED 0
154 #define PRIM_REF 1 /* radio clock */
155 #define INFO_QUERY 62 /* **** THIS implementation dependent **** */
156 #define INFO_REPLY 63 /* **** THIS implementation dependent **** */
158 static void p_sfix(netdissect_options
*ndo
, const struct s_fixedpt
*);
159 static void p_ntp_delta(netdissect_options
*, const struct l_fixedpt
*, const struct l_fixedpt
*);
160 static void p_poll(netdissect_options
*, const int);
162 static const struct tok ntp_mode_values
[] = {
163 { MODE_UNSPEC
, "unspecified" },
164 { MODE_SYM_ACT
, "symmetric active" },
165 { MODE_SYM_PAS
, "symmetric passive" },
166 { MODE_CLIENT
, "Client" },
167 { MODE_SERVER
, "Server" },
168 { MODE_BROADCAST
, "Broadcast" },
169 { MODE_CONTROL
, "Control Message" },
170 { MODE_RES2
, "Reserved" },
174 static const struct tok ntp_leapind_values
[] = {
177 { MINUS_SEC
, "-1s" },
178 { ALARM
, "clock unsynchronized" },
182 static const struct tok ntp_stratum_values
[] = {
183 { UNSPECIFIED
, "unspecified" },
184 { PRIM_REF
, "primary reference" },
188 /* draft-ietf-ntp-mode-6-cmds-02
190 * 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
191 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
192 * |LI | VN |Mode |R|E|M| OpCode | Sequence Number |
193 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
194 * | Status | Association ID |
195 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
197 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
199 * / Data (up to 468 bytes) /
201 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
202 * | Padding (optional) |
203 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
205 * / Authenticator (optional, 96 bytes) /
207 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
209 * Figure 1: NTP Control Message Header
212 /* Length of the NTP control message with the mandatory fields ("the header")
213 * and without any optional fields (Data, Padding, Authenticator).
215 #define NTP_CTRLMSG_MINLEN 12U
217 struct ntp_control_data
{
218 nd_uint8_t magic
; /* LI, VN, Mode */
219 nd_uint8_t control
; /* R, E, M, OpCode */
220 nd_uint16_t sequence
; /* Sequence Number */
221 nd_uint16_t status
; /* Status */
222 nd_uint16_t assoc
; /* Association ID */
223 nd_uint16_t offset
; /* Offset */
224 nd_uint16_t count
; /* Count */
225 nd_uint8_t data
[564]; /* Data, [Padding, [Authenticator]] */
229 * Print NTP time requests and responses
232 ntp_time_print(netdissect_options
*ndo
,
233 const struct ntp_time_data
*bp
, u_int length
)
237 if (length
< NTP_TIMEMSG_MINLEN
)
240 stratum
= GET_U_1(bp
->stratum
);
241 ND_PRINT(", Stratum %u (%s)",
243 tok2str(ntp_stratum_values
, (stratum
>=2 && stratum
<=15) ? "secondary reference" : "reserved", stratum
));
245 ND_PRINT(", poll %d", GET_S_1(bp
->ppoll
));
246 p_poll(ndo
, GET_S_1(bp
->ppoll
));
248 ND_PRINT(", precision %d", GET_S_1(bp
->precision
));
250 ND_PRINT("\n\tRoot Delay: ");
251 p_sfix(ndo
, &bp
->root_delay
);
253 ND_PRINT(", Root dispersion: ");
254 p_sfix(ndo
, &bp
->root_dispersion
);
256 ND_PRINT(", Reference-ID: ");
257 /* Interpretation depends on stratum */
261 ND_PRINT("(unspec)");
262 ND_TCHECK_4(bp
->refid
);
266 nd_printjn(ndo
, (const u_char
*)&(bp
->refid
), 4);
270 ND_PRINT("%s INFO_QUERY", GET_IPADDR_STRING(bp
->refid
));
271 /* this doesn't have more content */
275 ND_PRINT("%s INFO_REPLY", GET_IPADDR_STRING(bp
->refid
));
276 /* this is too complex to be worth printing */
280 /* In NTPv4 (RFC 5905) refid is an IPv4 address or first 32 bits of
281 MD5 sum of IPv6 address */
282 ND_PRINT("0x%08x", GET_BE_U_4(bp
->refid
));
286 ND_PRINT("\n\t Reference Timestamp: ");
287 p_ntp_time(ndo
, &(bp
->ref_timestamp
));
289 ND_PRINT("\n\t Originator Timestamp: ");
290 p_ntp_time(ndo
, &(bp
->org_timestamp
));
292 ND_PRINT("\n\t Receive Timestamp: ");
293 p_ntp_time(ndo
, &(bp
->rec_timestamp
));
295 ND_PRINT("\n\t Transmit Timestamp: ");
296 p_ntp_time(ndo
, &(bp
->xmt_timestamp
));
298 ND_PRINT("\n\t Originator - Receive Timestamp: ");
299 p_ntp_delta(ndo
, &(bp
->org_timestamp
), &(bp
->rec_timestamp
));
301 ND_PRINT("\n\t Originator - Transmit Timestamp: ");
302 p_ntp_delta(ndo
, &(bp
->org_timestamp
), &(bp
->xmt_timestamp
));
304 /* FIXME: this code is not aware of any extension fields */
305 if (length
== NTP_TIMEMSG_MINLEN
+ 4) { /* Optional: key-id (crypto-NAK) */
306 ND_PRINT("\n\tKey id: %u", GET_BE_U_4(bp
->key_id
));
307 } else if (length
== NTP_TIMEMSG_MINLEN
+ 4 + 16) { /* Optional: key-id + 128-bit digest */
308 ND_PRINT("\n\tKey id: %u", GET_BE_U_4(bp
->key_id
));
309 ND_PRINT("\n\tAuthentication: %08x%08x%08x%08x",
310 GET_BE_U_4(bp
->message_digest
),
311 GET_BE_U_4(bp
->message_digest
+ 4),
312 GET_BE_U_4(bp
->message_digest
+ 8),
313 GET_BE_U_4(bp
->message_digest
+ 12));
314 } else if (length
== NTP_TIMEMSG_MINLEN
+ 4 + 20) { /* Optional: key-id + 160-bit digest */
315 ND_PRINT("\n\tKey id: %u", GET_BE_U_4(bp
->key_id
));
316 ND_PRINT("\n\tAuthentication: %08x%08x%08x%08x%08x",
317 GET_BE_U_4(bp
->message_digest
),
318 GET_BE_U_4(bp
->message_digest
+ 4),
319 GET_BE_U_4(bp
->message_digest
+ 8),
320 GET_BE_U_4(bp
->message_digest
+ 12),
321 GET_BE_U_4(bp
->message_digest
+ 16));
322 } else if (length
> NTP_TIMEMSG_MINLEN
) {
323 ND_PRINT("\n\t(%u more bytes after the header)", length
- NTP_TIMEMSG_MINLEN
);
328 nd_print_invalid(ndo
);
329 ND_TCHECK_LEN(bp
, length
);
333 * Print NTP control message requests and responses
336 ntp_control_print(netdissect_options
*ndo
,
337 const struct ntp_control_data
*cd
, u_int length
)
339 uint8_t control
, R
, E
, M
, opcode
;
340 uint16_t sequence
, status
, assoc
, offset
, count
;
342 if (length
< NTP_CTRLMSG_MINLEN
)
345 control
= GET_U_1(cd
->control
);
346 R
= (control
& 0x80) != 0;
347 E
= (control
& 0x40) != 0;
348 M
= (control
& 0x20) != 0;
349 opcode
= control
& 0x1f;
350 ND_PRINT(", %s, %s, %s, OpCode=%u\n",
351 R
? "Response" : "Request", E
? "Error" : "OK",
352 M
? "More" : "Last", opcode
);
354 sequence
= GET_BE_U_2(cd
->sequence
);
355 ND_PRINT("\tSequence=%hu", sequence
);
357 status
= GET_BE_U_2(cd
->status
);
358 ND_PRINT(", Status=%#hx", status
);
360 assoc
= GET_BE_U_2(cd
->assoc
);
361 ND_PRINT(", Assoc.=%hu", assoc
);
363 offset
= GET_BE_U_2(cd
->offset
);
364 ND_PRINT(", Offset=%hu", offset
);
366 count
= GET_BE_U_2(cd
->count
);
367 ND_PRINT(", Count=%hu", count
);
369 if (NTP_CTRLMSG_MINLEN
+ count
> length
)
372 ND_TCHECK_LEN(cd
->data
, count
);
373 ND_PRINT("\n\tTO-BE-DONE: data not interpreted");
378 nd_print_invalid(ndo
);
379 ND_TCHECK_LEN(cd
, length
);
383 struct ntp_time_data td
;
384 struct ntp_control_data cd
;
388 * Print NTP requests, handling the common VN, LI, and Mode
391 ntp_print(netdissect_options
*ndo
,
392 const u_char
*cp
, u_int length
)
394 const union ntpdata
*bp
= (const union ntpdata
*)cp
;
395 u_int mode
, version
, leapind
;
398 ndo
->ndo_protocol
= "ntp";
399 status
= GET_U_1(bp
->td
.status
);
401 version
= (status
& VERSIONMASK
) >> VERSIONSHIFT
;
402 ND_PRINT("NTPv%u", version
);
404 mode
= (status
& MODEMASK
) >> MODESHIFT
;
405 if (!ndo
->ndo_vflag
) {
406 ND_PRINT(", %s, length %u",
407 tok2str(ntp_mode_values
, "Unknown mode", mode
),
412 ND_PRINT(", %s, length %u\n",
413 tok2str(ntp_mode_values
, "Unknown mode", mode
), length
);
415 /* leapind = (status & LEAPMASK) >> LEAPSHIFT; */
416 leapind
= (status
& LEAPMASK
);
417 ND_PRINT("\tLeap indicator: %s (%u)",
418 tok2str(ntp_leapind_values
, "Unknown", leapind
),
429 ntp_time_print(ndo
, &bp
->td
, length
);
433 ntp_control_print(ndo
, &bp
->cd
, length
);
437 break; /* XXX: not implemented! */
442 p_sfix(netdissect_options
*ndo
,
443 const struct s_fixedpt
*sfp
)
449 i
= GET_BE_U_2(sfp
->int_part
);
450 f
= GET_BE_U_2(sfp
->fraction
);
451 ff
= f
/ 65536.0; /* shift radix point by 16 bits */
452 f
= (int)(ff
* 1000000.0); /* Treat fraction as parts per million */
453 ND_PRINT("%d.%06d", i
, f
);
456 /* Prints time difference between *lfp and *olfp */
458 p_ntp_delta(netdissect_options
*ndo
,
459 const struct l_fixedpt
*olfp
,
460 const struct l_fixedpt
*lfp
)
469 u
= GET_BE_U_4(lfp
->int_part
);
470 ou
= GET_BE_U_4(olfp
->int_part
);
471 uf
= GET_BE_U_4(lfp
->fraction
);
472 ouf
= GET_BE_U_4(olfp
->fraction
);
473 if (ou
== 0 && ouf
== 0) {
474 p_ntp_time(ndo
, lfp
);
478 if (u
> ou
) { /* new is definitely greater than old */
482 if (ouf
> uf
) /* must borrow from high-order bits */
484 } else if (u
< ou
) { /* new is definitely less than old */
488 if (uf
> ouf
) /* must borrow from the high-order bits */
490 } else { /* int_part is zero */
502 if (ff
< 0.0) /* some compilers are buggy */
504 ff
= ff
/ FMAXINT
; /* shift radix point by 32 bits */
505 f
= (uint32_t)(ff
* 1000000000.0); /* treat fraction as parts per billion */
506 ND_PRINT("%s%u.%09u", signbit
? "-" : "+", i
, f
);
509 /* Prints polling interval in log2 as seconds or fraction of second */
511 p_poll(netdissect_options
*ndo
,
512 const int poll_interval
)
514 if (poll_interval
<= -32 || poll_interval
>= 32)
517 if (poll_interval
>= 0)
518 ND_PRINT(" (%us)", 1U << poll_interval
);
520 ND_PRINT(" (1/%us)", 1U << -poll_interval
);