xref: /netbsd-src/external/bsd/tcpdump/dist/print-ntp.c (revision 181254a7b1bdde6873432bffef2d2decc4b5c22f)
1 /*
2  * Copyright (c) 1990, 1991, 1992, 1993, 1994, 1995, 1996, 1997
3  *	The Regents of the University of California.  All rights reserved.
4  *
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
16  * written permission.
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.
20  *
21  *	By Jeffrey Mogul/DECWRL
22  *	loosely based on print-bootp.c
23  */
24 
25 /* \summary: Network Time Protocol (NTP) printer */
26 
27 #include <sys/cdefs.h>
28 #ifndef lint
29 __RCSID("$NetBSD: print-ntp.c,v 1.8 2020/02/24 18:39:47 kamil Exp $");
30 #endif
31 
32 #ifdef HAVE_CONFIG_H
33 #include "config.h"
34 #endif
35 
36 #include <netdissect-stdinc.h>
37 
38 #ifdef HAVE_STRFTIME
39 #include <time.h>
40 #endif
41 
42 #include "netdissect.h"
43 #include "addrtoname.h"
44 #include "extract.h"
45 
46 /*
47  * Based on ntp.h from the U of MD implementation
48  *	This file is based on Version 2 of the NTP spec (RFC1119).
49  */
50 
51 /*
52  *  Definitions for the masses
53  */
54 #define	JAN_1970	2208988800U	/* 1970 - 1900 in seconds */
55 
56 /*
57  * Structure definitions for NTP fixed point values
58  *
59  *    0			  1		      2			  3
60  *    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
61  *   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
62  *   |			       Integer Part			     |
63  *   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
64  *   |			       Fraction Part			     |
65  *   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
66  *
67  *    0			  1		      2			  3
68  *    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
69  *   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
70  *   |		  Integer Part	     |	   Fraction Part	     |
71  *   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
72 */
73 struct l_fixedpt {
74 	uint32_t int_part;
75 	uint32_t fraction;
76 };
77 
78 struct s_fixedpt {
79 	uint16_t int_part;
80 	uint16_t fraction;
81 };
82 
83 /* rfc2030
84  *                      1                   2                   3
85  *  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
86  * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
87  * |LI | VN  |Mode |    Stratum    |     Poll      |   Precision   |
88  * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
89  * |                          Root Delay                           |
90  * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
91  * |                       Root Dispersion                         |
92  * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
93  * |                     Reference Identifier                      |
94  * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
95  * |                                                               |
96  * |                   Reference Timestamp (64)                    |
97  * |                                                               |
98  * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
99  * |                                                               |
100  * |                   Originate Timestamp (64)                    |
101  * |                                                               |
102  * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
103  * |                                                               |
104  * |                    Receive Timestamp (64)                     |
105  * |                                                               |
106  * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
107  * |                                                               |
108  * |                    Transmit Timestamp (64)                    |
109  * |                                                               |
110  * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
111  * |                 Key Identifier (optional) (32)                |
112  * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
113  * |                                                               |
114  * |                                                               |
115  * |                 Message Digest (optional) (128)               |
116  * |                                                               |
117  * |                                                               |
118  * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
119  */
120 
121 struct ntpdata {
122 	u_char status;		/* status of local clock and leap info */
123 	u_char stratum;		/* Stratum level */
124 	u_char ppoll;		/* poll value */
125 	int precision:8;
126 	struct s_fixedpt root_delay;
127 	struct s_fixedpt root_dispersion;
128 	uint32_t refid;
129 	struct l_fixedpt ref_timestamp;
130 	struct l_fixedpt org_timestamp;
131 	struct l_fixedpt rec_timestamp;
132 	struct l_fixedpt xmt_timestamp;
133         uint32_t key_id;
134         uint8_t  message_digest[16];
135 };
136 /*
137  *	Leap Second Codes (high order two bits)
138  */
139 #define	NO_WARNING	0x00	/* no warning */
140 #define	PLUS_SEC	0x40	/* add a second (61 seconds) */
141 #define	MINUS_SEC	0x80	/* minus a second (59 seconds) */
142 #define	ALARM		0xc0	/* alarm condition (clock unsynchronized) */
143 
144 /*
145  *	Clock Status Bits that Encode Version
146  */
147 #define	NTPVERSION_1	0x08
148 #define	VERSIONMASK	0x38
149 #define LEAPMASK	0xc0
150 #ifdef MODEMASK
151 #undef MODEMASK					/* Solaris sucks */
152 #endif
153 #define	MODEMASK	0x07
154 
155 /*
156  *	Code values
157  */
158 #define	MODE_UNSPEC	0	/* unspecified */
159 #define	MODE_SYM_ACT	1	/* symmetric active */
160 #define	MODE_SYM_PAS	2	/* symmetric passive */
161 #define	MODE_CLIENT	3	/* client */
162 #define	MODE_SERVER	4	/* server */
163 #define	MODE_BROADCAST	5	/* broadcast */
164 #define	MODE_RES1	6	/* reserved */
165 #define	MODE_RES2	7	/* reserved */
166 
167 /*
168  *	Stratum Definitions
169  */
170 #define	UNSPECIFIED	0
171 #define	PRIM_REF	1	/* radio clock */
172 #define	INFO_QUERY	62	/* **** THIS implementation dependent **** */
173 #define	INFO_REPLY	63	/* **** THIS implementation dependent **** */
174 
175 static void p_sfix(netdissect_options *ndo, const struct s_fixedpt *);
176 static void p_ntp_time(netdissect_options *, const struct l_fixedpt *);
177 static void p_ntp_delta(netdissect_options *, const struct l_fixedpt *, const struct l_fixedpt *);
178 
179 static const struct tok ntp_mode_values[] = {
180     { MODE_UNSPEC,    "unspecified" },
181     { MODE_SYM_ACT,   "symmetric active" },
182     { MODE_SYM_PAS,   "symmetric passive" },
183     { MODE_CLIENT,    "Client" },
184     { MODE_SERVER,    "Server" },
185     { MODE_BROADCAST, "Broadcast" },
186     { MODE_RES1,      "Reserved" },
187     { MODE_RES2,      "Reserved" },
188     { 0, NULL }
189 };
190 
191 static const struct tok ntp_leapind_values[] = {
192     { NO_WARNING,     "" },
193     { PLUS_SEC,       "+1s" },
194     { MINUS_SEC,      "-1s" },
195     { ALARM,          "clock unsynchronized" },
196     { 0, NULL }
197 };
198 
199 static const struct tok ntp_stratum_values[] = {
200 	{ UNSPECIFIED,	"unspecified" },
201 	{ PRIM_REF, 	"primary reference" },
202 	{ 0, NULL }
203 };
204 
205 /*
206  * Print ntp requests
207  */
208 UNALIGNED_OK
209 void
210 ntp_print(netdissect_options *ndo,
211           register const u_char *cp, u_int length)
212 {
213 	register const struct ntpdata *bp;
214 	int mode, version, leapind;
215 
216 	bp = (const struct ntpdata *)cp;
217 
218 	ND_TCHECK(bp->status);
219 
220 	version = (int)(bp->status & VERSIONMASK) >> 3;
221 	ND_PRINT((ndo, "NTPv%d", version));
222 
223 	mode = bp->status & MODEMASK;
224 	if (!ndo->ndo_vflag) {
225 		ND_PRINT((ndo, ", %s, length %u",
226 		          tok2str(ntp_mode_values, "Unknown mode", mode),
227 		          length));
228 		return;
229 	}
230 
231 	ND_PRINT((ndo, ", length %u\n\t%s",
232 	          length,
233 	          tok2str(ntp_mode_values, "Unknown mode", mode)));
234 
235 	leapind = bp->status & LEAPMASK;
236 	ND_PRINT((ndo, ", Leap indicator: %s (%u)",
237 	          tok2str(ntp_leapind_values, "Unknown", leapind),
238 	          leapind));
239 
240 	ND_TCHECK(bp->stratum);
241 	ND_PRINT((ndo, ", Stratum %u (%s)",
242 		bp->stratum,
243 		tok2str(ntp_stratum_values, (bp->stratum >=2 && bp->stratum<=15) ? "secondary reference" : "reserved", bp->stratum)));
244 
245 	ND_TCHECK(bp->ppoll);
246 	ND_PRINT((ndo, ", poll %u (%us)", bp->ppoll, 1 << bp->ppoll));
247 
248 	/* Can't ND_TCHECK bp->precision bitfield so bp->distance + 0 instead */
249 	ND_TCHECK2(bp->root_delay, 0);
250 	ND_PRINT((ndo, ", precision %d", bp->precision));
251 
252 	ND_TCHECK(bp->root_delay);
253 	ND_PRINT((ndo, "\n\tRoot Delay: "));
254 	p_sfix(ndo, &bp->root_delay);
255 
256 	ND_TCHECK(bp->root_dispersion);
257 	ND_PRINT((ndo, ", Root dispersion: "));
258 	p_sfix(ndo, &bp->root_dispersion);
259 
260 	ND_TCHECK(bp->refid);
261 	ND_PRINT((ndo, ", Reference-ID: "));
262 	/* Interpretation depends on stratum */
263 	switch (bp->stratum) {
264 
265 	case UNSPECIFIED:
266 		ND_PRINT((ndo, "(unspec)"));
267 		break;
268 
269 	case PRIM_REF:
270 		if (fn_printn(ndo, (const u_char *)&(bp->refid), 4, ndo->ndo_snapend))
271 			goto trunc;
272 		break;
273 
274 	case INFO_QUERY:
275 		ND_PRINT((ndo, "%s INFO_QUERY", ipaddr_string(ndo, &(bp->refid))));
276 		/* this doesn't have more content */
277 		return;
278 
279 	case INFO_REPLY:
280 		ND_PRINT((ndo, "%s INFO_REPLY", ipaddr_string(ndo, &(bp->refid))));
281 		/* this is too complex to be worth printing */
282 		return;
283 
284 	default:
285 		ND_PRINT((ndo, "%s", ipaddr_string(ndo, &(bp->refid))));
286 		break;
287 	}
288 
289 	ND_TCHECK(bp->ref_timestamp);
290 	ND_PRINT((ndo, "\n\t  Reference Timestamp:  "));
291 	p_ntp_time(ndo, &(bp->ref_timestamp));
292 
293 	ND_TCHECK(bp->org_timestamp);
294 	ND_PRINT((ndo, "\n\t  Originator Timestamp: "));
295 	p_ntp_time(ndo, &(bp->org_timestamp));
296 
297 	ND_TCHECK(bp->rec_timestamp);
298 	ND_PRINT((ndo, "\n\t  Receive Timestamp:    "));
299 	p_ntp_time(ndo, &(bp->rec_timestamp));
300 
301 	ND_TCHECK(bp->xmt_timestamp);
302 	ND_PRINT((ndo, "\n\t  Transmit Timestamp:   "));
303 	p_ntp_time(ndo, &(bp->xmt_timestamp));
304 
305 	ND_PRINT((ndo, "\n\t    Originator - Receive Timestamp:  "));
306 	p_ntp_delta(ndo, &(bp->org_timestamp), &(bp->rec_timestamp));
307 
308 	ND_PRINT((ndo, "\n\t    Originator - Transmit Timestamp: "));
309 	p_ntp_delta(ndo, &(bp->org_timestamp), &(bp->xmt_timestamp));
310 
311 	if ( (sizeof(struct ntpdata) - length) == 16) { 	/* Optional: key-id */
312 		ND_TCHECK(bp->key_id);
313 		ND_PRINT((ndo, "\n\tKey id: %u", bp->key_id));
314 	} else if ( (sizeof(struct ntpdata) - length) == 0) { 	/* Optional: key-id + authentication */
315 		ND_TCHECK(bp->key_id);
316 		ND_PRINT((ndo, "\n\tKey id: %u", bp->key_id));
317 		ND_TCHECK2(bp->message_digest, sizeof (bp->message_digest));
318                 ND_PRINT((ndo, "\n\tAuthentication: %08x%08x%08x%08x",
319         		       EXTRACT_32BITS(bp->message_digest),
320 		               EXTRACT_32BITS(bp->message_digest + 4),
321 		               EXTRACT_32BITS(bp->message_digest + 8),
322 		               EXTRACT_32BITS(bp->message_digest + 12)));
323         }
324 	return;
325 
326 trunc:
327 	ND_PRINT((ndo, " [|ntp]"));
328 }
329 
330 static void
331 p_sfix(netdissect_options *ndo,
332        register const struct s_fixedpt *sfp)
333 {
334 	register int i;
335 	register int f;
336 	register double ff;
337 
338 	i = EXTRACT_16BITS(&sfp->int_part);
339 	f = EXTRACT_16BITS(&sfp->fraction);
340 	ff = f / 65536.0;		/* shift radix point by 16 bits */
341 	f = (int)(ff * 1000000.0);	/* Treat fraction as parts per million */
342 	ND_PRINT((ndo, "%d.%06d", i, f));
343 }
344 
345 #define	FMAXINT	(4294967296.0)	/* floating point rep. of MAXINT */
346 
347 static void
348 p_ntp_time(netdissect_options *ndo,
349            register const struct l_fixedpt *lfp)
350 {
351 	register int32_t i;
352 	register uint32_t uf;
353 	register uint32_t f;
354 	register double ff;
355 
356 	i = EXTRACT_32BITS(&lfp->int_part);
357 	uf = EXTRACT_32BITS(&lfp->fraction);
358 	ff = uf;
359 	if (ff < 0.0)		/* some compilers are buggy */
360 		ff += FMAXINT;
361 	ff = ff / FMAXINT;			/* shift radix point by 32 bits */
362 	f = (uint32_t)(ff * 1000000000.0);	/* treat fraction as parts per billion */
363 	ND_PRINT((ndo, "%u.%09d", i, f));
364 
365 #ifdef HAVE_STRFTIME
366 	/*
367 	 * print the time in human-readable format.
368 	 */
369 	if (i) {
370 	    time_t seconds = i - JAN_1970;
371 	    struct tm *tm;
372 	    char time_buf[128];
373 
374 	    tm = localtime(&seconds);
375 	    strftime(time_buf, sizeof (time_buf), "%Y/%m/%d %H:%M:%S", tm);
376 	    ND_PRINT((ndo, " (%s)", time_buf));
377 	}
378 #endif
379 }
380 
381 /* Prints time difference between *lfp and *olfp */
382 static void
383 p_ntp_delta(netdissect_options *ndo,
384             register const struct l_fixedpt *olfp,
385             register const struct l_fixedpt *lfp)
386 {
387 	register int32_t i;
388 	register uint32_t u, uf;
389 	register uint32_t ou, ouf;
390 	register uint32_t f;
391 	register double ff;
392 	int signbit;
393 
394 	u = EXTRACT_32BITS(&lfp->int_part);
395 	ou = EXTRACT_32BITS(&olfp->int_part);
396 	uf = EXTRACT_32BITS(&lfp->fraction);
397 	ouf = EXTRACT_32BITS(&olfp->fraction);
398 	if (ou == 0 && ouf == 0) {
399 		p_ntp_time(ndo, lfp);
400 		return;
401 	}
402 
403 	i = u - ou;
404 
405 	if (i > 0) {		/* new is definitely greater than old */
406 		signbit = 0;
407 		f = uf - ouf;
408 		if (ouf > uf)	/* must borrow from high-order bits */
409 			i -= 1;
410 	} else if (i < 0) {	/* new is definitely less than old */
411 		signbit = 1;
412 		f = ouf - uf;
413 		if (uf > ouf)	/* must carry into the high-order bits */
414 			i += 1;
415 		i = -i;
416 	} else {		/* int_part is zero */
417 		if (uf > ouf) {
418 			signbit = 0;
419 			f = uf - ouf;
420 		} else {
421 			signbit = 1;
422 			f = ouf - uf;
423 		}
424 	}
425 
426 	ff = f;
427 	if (ff < 0.0)		/* some compilers are buggy */
428 		ff += FMAXINT;
429 	ff = ff / FMAXINT;			/* shift radix point by 32 bits */
430 	f = (uint32_t)(ff * 1000000000.0);	/* treat fraction as parts per billion */
431 	ND_PRINT((ndo, "%s%d.%09d", signbit ? "-" : "+", i, f));
432 }
433