1 /*
2  * ntp.h - NTP definitions for the masses
3  */
4 #ifndef NTP_H
5 #define NTP_H
6 
7 #include <stddef.h>
8 #include <math.h>
9 
10 #include <ntp_fp.h>
11 #include <ntp_types.h>
12 #include <ntp_lists.h>
13 #include <ntp_stdlib.h>
14 #include <ntp_crypto.h>
15 #include <ntp_random.h>
16 #include <ntp_net.h>
17 
18 #include <isc/boolean.h>
19 
20 /*
21  * Calendar arithmetic - contributed by G. Healton
22  */
23 #define YEAR_BREAK 500		/* years < this are tm_year values:
24 				 * Break < AnyFourDigitYear && Break >
25 				 * Anytm_yearYear */
26 
27 #define YEAR_PIVOT 98		/* 97/98: years < this are year 2000+
28 				 * FYI: official UNIX pivot year is
29 				 * 68/69 */
30 
31 /*
32  * Number of Days since 1 BC Gregorian to 1 January of given year
33  */
34 #define julian0(year)	(((year) * 365 ) + ((year) > 0 ? (((year) + 3) \
35 			    / 4 - ((year - 1) / 100) + ((year - 1) / \
36 			    400)) : 0))
37 
38 /*
39  * Number of days since start of NTP time to 1 January of given year
40  */
41 #define ntp0(year)	(julian0(year) - julian0(1900))
42 
43 /*
44  * Number of days since start of UNIX time to 1 January of given year
45  */
46 #define unix0(year)	(julian0(year) - julian0(1970))
47 
48 /*
49  * LEAP YEAR test for full 4-digit years (e.g, 1999, 2010)
50  */
51 #define isleap_4(y)	((y) % 4 == 0 && !((y) % 100 == 0 && !(y % \
52 			    400 == 0)))
53 
54 /*
55  * LEAP YEAR test for tm_year (struct tm) years (e.g, 99, 110)
56  */
57 #define isleap_tm(y)	((y) % 4 == 0 && !((y) % 100 == 0 && !(((y) \
58 			    + 1900) % 400 == 0)))
59 
60 /*
61  * to convert simple two-digit years to tm_year style years:
62  *
63  *	if (year < YEAR_PIVOT)
64  *		year += 100;
65  *
66  * to convert either two-digit OR tm_year years to four-digit years:
67  *
68  *	if (year < YEAR_PIVOT)
69  *		year += 100;
70  *
71  *	if (year < YEAR_BREAK)
72  *		year += 1900;
73  */
74 
75 /*
76  * How to get signed characters.  On machines where signed char works,
77  * use it. On machines where signed char doesn't work, char had better
78  * be signed.
79  */
80 #ifdef NEED_S_CHAR_TYPEDEF
81 # if SIZEOF_SIGNED_CHAR
82 typedef signed char s_char;
83 # else
84 typedef char s_char;
85 # endif
86   /* XXX: Why is this sequent bit INSIDE this test? */
87 # ifdef sequent
88 #  undef SO_RCVBUF
89 #  undef SO_SNDBUF
90 # endif
91 #endif
92 
93 /*
94  * NTP protocol parameters.  See section 3.2.6 of the specification.
95  */
96 #define	NTP_VERSION	((u_char)4) /* current version number */
97 #define	NTP_OLDVERSION	((u_char)1) /* oldest credible version */
98 #define	NTP_PORT	123	/* included for non-unix machines */
99 
100 /*
101  * Poll interval parameters
102  */
103 #define NTP_UNREACH	10	/* poll unreach threshold */
104 #define	NTP_MINPOLL	3	/* log2 min poll interval (8 s) */
105 #define NTP_MINDPOLL	6	/* log2 default min poll (64 s) */
106 #define NTP_MAXDPOLL	10	/* log2 default max poll (~17 m) */
107 #define	NTP_MAXPOLL	17	/* log2 max poll interval (~36 h) */
108 #define	NTP_RETRY	3	/* max packet retries */
109 #define	NTP_MINPKT	2	/* guard time (s) */
110 
111 /*
112  * Clock filter algorithm tuning parameters
113  */
114 #define MAXDISPERSE	16.	/* max dispersion */
115 #define	NTP_SHIFT	8	/* clock filter stages */
116 #define NTP_FWEIGHT	.5	/* clock filter weight */
117 
118 /*
119  * Selection algorithm tuning parameters
120  */
121 #define	NTP_MINCLOCK	3	/* min survivors */
122 #define	NTP_MAXCLOCK	10	/* max candidates */
123 #define MINDISPERSE	.001	/* min distance */
124 #define MAXDISTANCE	1.5	/* max root distance (select threshold) */
125 #define CLOCK_SGATE	3.	/* popcorn spike gate */
126 #define HUFFPUFF	900	/* huff-n'-puff sample interval (s) */
127 #define MAXHOP		2	/* anti-clockhop threshold */
128 #define MAX_TTL		8	/* max ttl mapping vector size */
129 #define	BEACON		7200	/* manycast beacon interval */
130 #define NTP_MAXEXTEN	2048	/* max extension field size */
131 #define	NTP_ORPHWAIT	300	/* orphan wait (s) */
132 
133 /*
134  * Miscellaneous stuff
135  */
136 #define NTP_MAXKEY	65535	/* max authentication key number */
137 #define	KEY_TYPE_MD5	NID_md5	/* MD5 digest NID */
138 /*
139  * Limits of things
140  */
141 #define	MAXFILENAME	256	/* max length of file name */
142 #define MAXHOSTNAME	512	/* max length of host/node name */
143 #define NTP_MAXSTRLEN	256	/* max string length */
144 
145 /*
146  * Operations for jitter calculations (these use doubles).
147  *
148  * Note that we carefully separate the jitter component from the
149  * dispersion component (frequency error plus precision). The frequency
150  * error component is computed as CLOCK_PHI times the difference between
151  * the epoch of the time measurement and the reference time. The
152  * precision component is computed as the square root of the mean of the
153  * squares of a zero-mean, uniform distribution of unit maximum
154  * amplitude. Whether this makes statistical sense may be arguable.
155  */
156 #define SQUARE(x) ((x) * (x))
157 #define SQRT(x) (sqrt(x))
158 #define DIFF(x, y) (SQUARE((x) - (y)))
159 #define LOGTOD(a)	ldexp(1., (int)(a)) /* log2 to double */
160 #define UNIVAR(x)	(SQUARE(.28867513 * LOGTOD(x))) /* std uniform distr */
161 #define ULOGTOD(a)	ldexp(1., (int)(a)) /* ulog2 to double */
162 
163 #define	EVENT_TIMEOUT	0	/* one second, that is */
164 
165 
166 /*
167  * The interface structure is used to hold the addresses and socket
168  * numbers of each of the local network addresses we are using.
169  * Because "interface" is a reserved word in C++ and has so many
170  * varied meanings, a change to "endpt" (via typedef) is under way.
171  * Eventually the struct tag will change from interface to endpt_tag.
172  * endpt is unrelated to the select algorithm's struct endpoint.
173  */
174 typedef struct interface endpt;
175 struct interface {
176 	endpt *		elink;		/* endpt list link */
177 	endpt *		mclink;		/* per-AF_* multicast list */
178 	void *		ioreg_ctx;	/* IO registration context */
179 	SOCKET		fd;		/* socket descriptor */
180 	SOCKET		bfd;		/* for receiving broadcasts */
181 	u_int32		ifnum;		/* endpt instance count */
182 	sockaddr_u	sin;		/* unicast address */
183 	sockaddr_u	mask;		/* subnet mask */
184 	sockaddr_u	bcast;		/* broadcast address */
185 	char		name[32];	/* name of interface */
186 	u_short		family;		/* AF_INET/AF_INET6 */
187 	u_short		phase;		/* phase in update cycle */
188 	u_int32		flags;		/* interface flags */
189 	int		last_ttl;	/* last TTL specified */
190 	u_int32		addr_refid;	/* IPv4 addr or IPv6 hash */
191 	int		num_mcast;	/* mcast addrs enabled */
192 	u_long		starttime;	/* current_time at creation */
193 	volatile long	received;	/* number of incoming packets */
194 	long		sent;		/* number of outgoing packets */
195 	long		notsent;	/* number of send failures */
196 	u_int		ifindex;	/* for IPV6_MULTICAST_IF */
197 	isc_boolean_t	ignore_packets; /* listen-read-drop this? */
198 	struct peer *	peers;		/* list of peers using endpt */
199 	u_int		peercnt;	/* count of same */
200 };
201 
202 /*
203  * Flags for interfaces
204  */
205 #define INT_UP		0x001	/* Interface is up */
206 #define	INT_PPP		0x002	/* Point-to-point interface */
207 #define	INT_LOOPBACK	0x004	/* the loopback interface */
208 #define	INT_BROADCAST	0x008	/* can broadcast out this interface */
209 #define INT_MULTICAST	0x010	/* can multicast out this interface */
210 #define	INT_BCASTOPEN	0x020	/* broadcast receive socket is open */
211 #define INT_MCASTOPEN	0x040	/* multicasting enabled */
212 #define INT_WILDCARD	0x080	/* wildcard interface - usually skipped */
213 #define INT_MCASTIF	0x100	/* bound directly to MCAST address */
214 #define INT_PRIVACY	0x200	/* RFC 4941 IPv6 privacy address */
215 #define INT_BCASTXMIT	0x400   /* socket setup to allow broadcasts */
216 
217 /*
218  * Define flasher bits (tests 1 through 11 in packet procedure)
219  * These reveal the state at the last grumble from the peer and are
220  * most handy for diagnosing problems, even if not strictly a state
221  * variable in the spec. These are recorded in the peer structure.
222  *
223  * Packet errors
224  */
225 #define TEST1		0X0001	/* duplicate packet */
226 #define TEST2		0x0002	/* bogus packet */
227 #define TEST3		0x0004	/* protocol unsynchronized */
228 #define TEST4		0x0008	/* access denied */
229 #define TEST5		0x0010	/* bad authentication */
230 #define TEST6		0x0020	/* bad synch or stratum */
231 #define TEST7		0x0040	/* bad header */
232 #define TEST8		0x0080  /* bad autokey */
233 #define TEST9		0x0100	/* bad crypto */
234 #define	PKT_TEST_MASK	(TEST1 | TEST2 | TEST3 | TEST4 | TEST5 |\
235 			TEST6 | TEST7 | TEST8 | TEST9)
236 /*
237  * Peer errors
238  */
239 #define TEST10		0x0200	/* peer bad synch or stratum */
240 #define	TEST11		0x0400	/* peer distance exceeded */
241 #define TEST12		0x0800	/* peer synchronization loop */
242 #define TEST13		0x1000	/* peer unreacable */
243 #define	PEER_TEST_MASK	(TEST10 | TEST11 | TEST12 | TEST13)
244 
245 /*
246  * Unused flags
247  */
248 #define TEST14		0x2000
249 #define TEST15		0x4000
250 #define TEST16		0x8000
251 
252 /*
253  * The peer structure. Holds state information relating to the guys
254  * we are peering with. Most of this stuff is from section 3.2 of the
255  * spec.
256  */
257 struct peer {
258 	struct peer *p_link;	/* link pointer in free & peer lists */
259 	struct peer *adr_link;	/* link pointer in address hash */
260 	struct peer *aid_link;	/* link pointer in associd hash */
261 	struct peer *ilink;	/* list of peers for interface */
262 	sockaddr_u srcadr;	/* address of remote host */
263 	char *	hostname;	/* if non-NULL, remote name */
264 	struct addrinfo *addrs;	/* hostname query result */
265 	struct addrinfo *ai;	/* position within addrs */
266 	endpt *	dstadr;		/* local address */
267 	associd_t associd;	/* association ID */
268 	u_char	version;	/* version number */
269 	u_char	hmode;		/* local association mode */
270 	u_char	hpoll;		/* local poll interval */
271 	u_char	minpoll;	/* min poll interval */
272 	u_char	maxpoll;	/* max poll interval */
273 	u_int	flags;		/* association flags */
274 	u_char	cast_flags;	/* additional flags */
275 	u_char	last_event;	/* last peer error code */
276 	u_char	num_events;	/* number of error events */
277 	u_int32	ttl;		/* ttl/refclock mode */
278 	char	*ident;		/* group identifier name */
279 
280 	/*
281 	 * Variables used by reference clock support
282 	 */
283 #ifdef REFCLOCK
284 	struct refclockproc *procptr; /* refclock structure pointer */
285 	u_char	refclktype;	/* reference clock type */
286 	u_char	refclkunit;	/* reference clock unit number */
287 	u_char	sstclktype;	/* clock type for system status word */
288 #endif /* REFCLOCK */
289 
290 	/*
291 	 * Variables set by received packet
292 	 */
293 	u_char	leap;		/* local leap indicator */
294 	u_char	pmode;		/* remote association mode */
295 	u_char	stratum;	/* remote stratum */
296 	u_char	ppoll;		/* remote poll interval */
297 	s_char	precision;	/* remote clock precision */
298 	double	rootdelay;	/* roundtrip delay to primary source */
299 	double	rootdisp;	/* dispersion to primary source */
300 	u_int32	refid;		/* remote reference ID */
301 	l_fp	reftime;	/* update epoch */
302 
303 	/*
304 	 * Variables used by authenticated client
305 	 */
306 	keyid_t keyid;		/* current key ID */
307 #ifdef AUTOKEY
308 #define clear_to_zero opcode
309 	u_int32	opcode;		/* last request opcode */
310 	associd_t assoc;	/* peer association ID */
311 	u_int32	crypto;		/* peer status word */
312 	EVP_PKEY *pkey;		/* public key */
313 	const EVP_MD *digest;	/* message digest algorithm */
314 	char	*subject;	/* certificate subject name */
315 	char	*issuer;	/* certificate issuer name */
316 	struct cert_info *xinfo; /* issuer certificate */
317 	keyid_t	pkeyid;		/* previous key ID */
318 	keyid_t	hcookie;	/* host cookie */
319 	keyid_t	pcookie;	/* peer cookie */
320 	const struct pkey_info *ident_pkey; /* identity key */
321 	BIGNUM	*iffval;	/* identity challenge (IFF, GQ, MV) */
322 	const BIGNUM *grpkey;	/* identity challenge key (GQ) */
323 	struct value cookval;	/* receive cookie values */
324 	struct value recval;	/* receive autokey values */
325 	struct exten *cmmd;	/* extension pointer */
326 	u_long	refresh;	/* next refresh epoch */
327 
328 	/*
329 	 * Variables used by authenticated server
330 	 */
331 	keyid_t	*keylist;	/* session key ID list */
332 	int	keynumber;	/* current key number */
333 	struct value encrypt;	/* send encrypt values */
334 	struct value sndval;	/* send autokey values */
335 #else	/* !AUTOKEY follows */
336 #define clear_to_zero status
337 #endif	/* !AUTOKEY */
338 
339 	/*
340 	 * Ephemeral state variables
341 	 */
342 	u_char	status;		/* peer status */
343 	u_char	new_status;	/* under-construction status */
344 	u_char	reach;		/* reachability register */
345 	int	flash;		/* protocol error test tally bits */
346 	u_long	epoch;		/* reference epoch */
347 	int	burst;		/* packets remaining in burst */
348 	int	retry;		/* retry counter */
349 	int	flip;		/* interleave mode control */
350 	int	filter_nextpt;	/* index into filter shift register */
351 	double	filter_delay[NTP_SHIFT]; /* delay shift register */
352 	double	filter_offset[NTP_SHIFT]; /* offset shift register */
353 	double	filter_disp[NTP_SHIFT]; /* dispersion shift register */
354 	u_long	filter_epoch[NTP_SHIFT]; /* epoch shift register */
355 	u_char	filter_order[NTP_SHIFT]; /* filter sort index */
356 	l_fp	rec;		/* receive time stamp */
357 	l_fp	xmt;		/* transmit time stamp */
358 	l_fp	dst;		/* destination timestamp */
359 	l_fp	aorg;		/* origin timestamp */
360 	l_fp	borg;		/* alternate origin timestamp */
361 	l_fp	bxmt;		/* most recent broadcast transmit timestamp */
362 	l_fp	nonce;		/* Value of nonce we sent as the xmt stamp */
363 	double	offset;		/* peer clock offset */
364 	double	delay;		/* peer roundtrip delay */
365 	double	jitter;		/* peer jitter (squares) */
366 	double	disp;		/* peer dispersion */
367 	double	xleave;		/* interleave delay */
368 	double	bias;		/* programmed offset bias */
369 
370 	/*
371 	 * Variables used to correct for packet length and asymmetry.
372 	 */
373 	double	t21;		/* outbound packet delay */
374 	int	t21_bytes;	/* outbound packet length */
375 	int	t21_last;	/* last outbound packet length */
376 	double	r21;		/* outbound data rate */
377 	double	t34;		/* inbound packet delay */
378 	int	t34_bytes;	/* inbound packet length */
379 	double	r34;		/* inbound data rate */
380 
381 	/*
382 	 * End of clear-to-zero area
383 	 */
384 	u_long	update;		/* receive epoch */
385 #define end_clear_to_zero update
386 	int	unreach;	/* watchdog counter */
387 	int	throttle;	/* rate control */
388 	u_long	outdate;	/* send time last packet */
389 	u_long	nextdate;	/* send time next packet */
390 
391 	/*
392 	 * Statistic counters
393 	 */
394 	u_long	timereset;	/* time stat counters were reset */
395 	u_long	timelastrec;	/* last packet received time, incl. trash */
396 	u_long	timereceived;	/* last (clean) packet received time */
397 	u_long	timereachable;	/* last reachable/unreachable time */
398 
399 	u_long	sent;		/* packets sent */
400 	u_long	received;	/* packets received */
401 	u_long	processed;	/* packets processed */
402 	u_long	badauth;	/* bad authentication (TEST5) */
403 	u_long	badNAK;		/* invalid crypto-NAK */
404 	u_long	bogusorg;	/* bogus origin (TEST2, TEST3) */
405 	u_long	oldpkt;		/* old duplicate (TEST1) */
406 	u_long	seldisptoolarge; /* bad header (TEST6, TEST7) */
407 	u_long	selbroken;	/* KoD received */
408 };
409 
410 /*
411  * Values for peer.leap, sys_leap
412  */
413 #define	LEAP_NOWARNING	0x0	/* normal, no leap second warning */
414 #define	LEAP_ADDSECOND	0x1	/* last minute of day has 61 seconds */
415 #define	LEAP_DELSECOND	0x2	/* last minute of day has 59 seconds */
416 #define	LEAP_NOTINSYNC	0x3	/* overload, clock is free running */
417 
418 /*
419  * Values for peer mode and packet mode. Only the modes through
420  * MODE_BROADCAST and MODE_BCLIENT appear in the transition
421  * function. MODE_CONTROL and MODE_PRIVATE can appear in packets,
422  * but those never survive to the transition function.
423  */
424 #define	MODE_UNSPEC	0	/* unspecified (old version) */
425 #define	MODE_ACTIVE	1	/* symmetric active mode */
426 #define	MODE_PASSIVE	2	/* symmetric passive mode */
427 #define	MODE_CLIENT	3	/* client mode */
428 #define	MODE_SERVER	4	/* server mode */
429 #define	MODE_BROADCAST	5	/* broadcast mode */
430 /*
431  * These can appear in packets
432  */
433 #define	MODE_CONTROL	6	/* control mode */
434 #define	MODE_PRIVATE	7	/* private mode */
435 /*
436  * This is a made-up mode for broadcast client.
437  */
438 #define	MODE_BCLIENT	6	/* broadcast client mode */
439 
440 /*
441  * Values for peer.stratum, sys_stratum
442  */
443 #define	STRATUM_REFCLOCK ((u_char)0) /* default stratum */
444 /* A stratum of 0 in the packet is mapped to 16 internally */
445 #define	STRATUM_PKT_UNSPEC ((u_char)0) /* unspecified in packet */
446 #define	STRATUM_UNSPEC	((u_char)16) /* unspecified */
447 
448 /*
449  * Values for peer.flags (u_int)
450  */
451 #define	FLAG_CONFIG	0x0001	/* association was configured */
452 #define	FLAG_PREEMPT	0x0002	/* preemptable association */
453 #define	FLAG_AUTHENTIC	0x0004	/* last message was authentic */
454 #define	FLAG_REFCLOCK	0x0008	/* this is actually a reference clock */
455 #define	FLAG_BC_VOL	0x0010	/* broadcast client volleying */
456 #define	FLAG_PREFER	0x0020	/* prefer peer */
457 #define	FLAG_BURST	0x0040	/* burst mode */
458 #define	FLAG_PPS	0x0080	/* steered by PPS */
459 #define	FLAG_IBURST	0x0100	/* initial burst mode */
460 #define	FLAG_NOSELECT	0x0200	/* never select */
461 #define	FLAG_TRUE	0x0400	/* force truechimer */
462 #define	FLAG_SKEY	0x0800  /* autokey authentication */
463 #define	FLAG_XLEAVE	0x1000	/* interleaved protocol */
464 #define	FLAG_XB		0x2000	/* interleaved broadcast */
465 #define	FLAG_XBOGUS	0x4000	/* interleaved bogus packet */
466 #ifdef	OPENSSL
467 # define FLAG_ASSOC	0x8000	/* autokey request */
468 #endif /* OPENSSL */
469 #define FLAG_TSTAMP_PPS	0x10000	/* PPS source provides absolute timestamp */
470 #define FLAG_LOOPNONCE	0x20000	/* Use a nonce for the loopback test */
471 
472 /*
473  * Definitions for the clear() routine.  We use memset() to clear
474  * the parts of the peer structure which go to zero.  These are
475  * used to calculate the start address and length of the area.
476  */
477 #define	CLEAR_TO_ZERO(p)	((char *)&((p)->clear_to_zero))
478 #define	END_CLEAR_TO_ZERO(p)	((char *)&((p)->end_clear_to_zero))
479 #define	LEN_CLEAR_TO_ZERO(p)	(END_CLEAR_TO_ZERO(p) - CLEAR_TO_ZERO(p))
480 #define CRYPTO_TO_ZERO(p)	((char *)&((p)->clear_to_zero))
481 #define END_CRYPTO_TO_ZERO(p)	((char *)&((p)->end_clear_to_zero))
482 #define LEN_CRYPTO_TO_ZERO	(END_CRYPTO_TO_ZERO((struct peer *)0) \
483 				    - CRYPTO_TO_ZERO((struct peer *)0))
484 
485 /*
486  * Reference clock types.  Added as necessary.
487  */
488 #define	REFCLK_NONE		0	/* unknown or missing */
489 #define	REFCLK_LOCALCLOCK	1	/* external (e.g., lockclock) */
490 #define	REFCLK_GPS_TRAK		2	/* TRAK 8810 GPS Receiver */
491 #define	REFCLK_WWV_PST		3	/* PST/Traconex 1020 WWV/H */
492 #define	REFCLK_SPECTRACOM	4	/* Spectracom (generic) Receivers */
493 #define	REFCLK_TRUETIME		5	/* TrueTime (generic) Receivers */
494 #define REFCLK_IRIG_AUDIO	6	/* IRIG-B/W audio decoder */
495 #define	REFCLK_CHU_AUDIO	7	/* CHU audio demodulator/decoder */
496 #define REFCLK_PARSE		8	/* generic driver (usually DCF77,GPS,MSF) */
497 #define	REFCLK_GPS_MX4200	9	/* Magnavox MX4200 GPS */
498 #define REFCLK_GPS_AS2201	10	/* Austron 2201A GPS */
499 #define	REFCLK_GPS_ARBITER	11	/* Arbiter 1088A/B/ GPS */
500 #define REFCLK_IRIG_TPRO	12	/* KSI/Odetics TPRO-S IRIG */
501 #define REFCLK_ATOM_LEITCH	13	/* Leitch CSD 5300 Master Clock */
502 #define REFCLK_MSF_EES		14	/* EES M201 MSF Receiver */
503 #define	REFCLK_GPSTM_TRUE	15	/* OLD TrueTime GPS/TM-TMD Receiver */
504 #define REFCLK_IRIG_BANCOMM	16	/* Bancomm GPS/IRIG Interface */
505 #define REFCLK_GPS_DATUM	17	/* Datum Programmable Time System */
506 #define REFCLK_ACTS		18	/* Generic Auto Computer Time Service */
507 #define REFCLK_WWV_HEATH	19	/* Heath GC1000 WWV/WWVH Receiver */
508 #define REFCLK_GPS_NMEA		20	/* NMEA based GPS clock */
509 #define REFCLK_GPS_VME		21	/* TrueTime GPS-VME Interface */
510 #define REFCLK_ATOM_PPS		22	/* 1-PPS Clock Discipline */
511 #define REFCLK_PTB_ACTS		23	/* replaced by REFCLK_ACTS */
512 #define REFCLK_USNO		24	/* replaced by REFCLK_ACTS */
513 #define REFCLK_GPS_HP		26	/* HP 58503A Time/Frequency Receiver */
514 #define REFCLK_ARCRON_MSF	27	/* ARCRON MSF radio clock. */
515 #define REFCLK_SHM		28	/* clock attached thru shared memory */
516 #define REFCLK_PALISADE		29	/* Trimble Navigation Palisade GPS */
517 #define REFCLK_ONCORE		30	/* Motorola UT Oncore GPS */
518 #define REFCLK_GPS_JUPITER	31	/* Rockwell Jupiter GPS receiver */
519 #define REFCLK_CHRONOLOG	32	/* Chrono-log K WWVB receiver */
520 #define REFCLK_DUMBCLOCK	33	/* Dumb localtime clock */
521 #define REFCLK_ULINK		34	/* Ultralink M320 WWVB receiver */
522 #define REFCLK_PCF		35	/* Conrad parallel port radio clock */
523 #define REFCLK_WWV_AUDIO	36	/* WWV/H audio demodulator/decoder */
524 #define REFCLK_FG		37	/* Forum Graphic GPS */
525 #define REFCLK_HOPF_SERIAL	38	/* hopf DCF77/GPS serial receiver  */
526 #define REFCLK_HOPF_PCI		39	/* hopf DCF77/GPS PCI receiver  */
527 #define REFCLK_JJY		40	/* JJY receiver  */
528 #define	REFCLK_TT560		41	/* TrueTime 560 IRIG-B decoder */
529 #define REFCLK_ZYFER		42	/* Zyfer GPStarplus receiver  */
530 #define REFCLK_RIPENCC		43	/* RIPE NCC Trimble driver */
531 #define REFCLK_NEOCLOCK4X	44	/* NeoClock4X DCF77 or TDF receiver */
532 #define REFCLK_TSYNCPCI		45	/* Spectracom TSYNC PCI timing board */
533 #define REFCLK_GPSDJSON		46
534 #define REFCLK_MAX		46
535 
536 
537 /*
538  * NTP packet format.  The mac field is optional.  It isn't really
539  * an l_fp either, but for now declaring it that way is convenient.
540  * See Appendix A in the specification.
541  *
542  * Note that all u_fp and l_fp values arrive in network byte order
543  * and must be converted (except the mac, which isn't, really).
544  */
545 struct pkt {
546 	u_char	li_vn_mode;	/* peer leap indicator */
547 	u_char	stratum;	/* peer stratum */
548 	u_char	ppoll;		/* peer poll interval */
549 	s_char	precision;	/* peer clock precision */
550 	u_fp	rootdelay;	/* roundtrip delay to primary source */
551 	u_fp	rootdisp;	/* dispersion to primary source*/
552 	u_int32	refid;		/* reference id */
553 	l_fp	reftime;	/* last update time */
554 	l_fp	org;		/* originate time stamp */
555 	l_fp	rec;		/* receive time stamp */
556 	l_fp	xmt;		/* transmit time stamp */
557 
558 #define	MIN_V4_PKT_LEN	(12 * sizeof(u_int32))	/* min header length */
559 #define	LEN_PKT_NOMAC	(12 * sizeof(u_int32))	/* min header length */
560 #define	MIN_MAC_LEN	(1 * sizeof(u_int32))	/* crypto_NAK */
561 #define	MAX_MD5_LEN	(5 * sizeof(u_int32))	/* MD5 */
562 #define	MAX_MAC_LEN	(6 * sizeof(u_int32))	/* SHA */
563 #define	KEY_MAC_LEN	sizeof(u_int32)		/* key ID in MAC */
564 #define	MAX_MDG_LEN	(MAX_MAC_LEN-KEY_MAC_LEN) /* max. digest len */
565 
566 	/*
567 	 * The length of the packet less MAC must be a multiple of 64
568 	 * with an RSA modulus and Diffie-Hellman prime of 256 octets
569 	 * and maximum host name of 128 octets, the maximum autokey
570 	 * command is 152 octets and maximum autokey response is 460
571 	 * octets. A packet can contain no more than one command and one
572 	 * response, so the maximum total extension field length is 864
573 	 * octets. But, to handle humungus certificates, the bank must
574 	 * be broke.
575 	 *
576 	 * The different definitions of the 'exten' field are here for
577 	 * the benefit of applications that want to send a packet from
578 	 * an auto variable in the stack - not using the AUTOKEY version
579 	 * saves 2KB of stack space. The receive buffer should ALWAYS be
580 	 * big enough to hold a full extended packet if the extension
581 	 * fields have to be parsed or skipped.
582 	 */
583 #ifdef AUTOKEY
584 	u_int32	exten[(NTP_MAXEXTEN + MAX_MAC_LEN) / sizeof(u_int32)];
585 #else	/* !AUTOKEY follows */
586 	u_int32	exten[(MAX_MAC_LEN) / sizeof(u_int32)];
587 #endif	/* !AUTOKEY */
588 };
589 
590 /*
591  * Stuff for extracting things from li_vn_mode
592  */
593 #define	PKT_MODE(li_vn_mode)	((u_char)((li_vn_mode) & 0x7))
594 #define	PKT_VERSION(li_vn_mode)	((u_char)(((li_vn_mode) >> 3) & 0x7))
595 #define	PKT_LEAP(li_vn_mode)	((u_char)(((li_vn_mode) >> 6) & 0x3))
596 
597 /*
598  * Stuff for putting things back into li_vn_mode in packets and vn_mode
599  * in ntp_monitor.c's mon_entry.
600  */
601 #define VN_MODE(v, m)		((((v) & 7) << 3) | ((m) & 0x7))
602 #define	PKT_LI_VN_MODE(l, v, m) ((((l) & 3) << 6) | VN_MODE((v), (m)))
603 
604 
605 /*
606  * Dealing with stratum.  0 gets mapped to 16 incoming, and back to 0
607  * on output.
608  */
609 #define	PKT_TO_STRATUM(s)	((u_char)(((s) == (STRATUM_PKT_UNSPEC)) ?\
610 				(STRATUM_UNSPEC) : (s)))
611 
612 #define	STRATUM_TO_PKT(s)	((u_char)(((s) == (STRATUM_UNSPEC)) ?\
613 				(STRATUM_PKT_UNSPEC) : (s)))
614 
615 
616 /*
617  * A test to determine if the refid should be interpreted as text string.
618  * This is usually the case for a refclock, which has stratum 0 internally,
619  * which results in sys_stratum 1 if the refclock becomes system peer, or
620  * in case of a kiss-of-death (KoD) packet that has STRATUM_PKT_UNSPEC (==0)
621  * in the packet which is converted to STRATUM_UNSPEC when the packet
622  * is evaluated.
623  */
624 #define REFID_ISTEXT(s) (((s) <= 1) || ((s) >= STRATUM_UNSPEC))
625 
626 
627 /*
628  * Event codes. Used for reporting errors/events to the control module
629  */
630 #define	PEER_EVENT	0x080	/* this is a peer event */
631 #define CRPT_EVENT	0x100	/* this is a crypto event */
632 
633 /*
634  * System event codes
635  */
636 #define	EVNT_UNSPEC	0	/* unspecified */
637 #define	EVNT_NSET	1	/* freq not set */
638 #define	EVNT_FSET	2	/* freq set */
639 #define	EVNT_SPIK	3	/* spike detect */
640 #define	EVNT_FREQ	4	/* freq mode */
641 #define	EVNT_SYNC	5	/* clock sync */
642 #define	EVNT_SYSRESTART	6	/* restart */
643 #define	EVNT_SYSFAULT	7	/* panic stop */
644 #define	EVNT_NOPEER	8	/* no sys peer */
645 #define	EVNT_ARMED	9	/* leap armed */
646 #define	EVNT_DISARMED	10	/* leap disarmed */
647 #define	EVNT_LEAP	11	/* leap event */
648 #define	EVNT_CLOCKRESET	12	/* clock step */
649 #define	EVNT_KERN	13	/* kernel event */
650 #define	EVNT_TAI	14	/* TAI */
651 #define	EVNT_LEAPVAL	15	/* stale leapsecond values */
652 
653 /*
654  * Peer event codes
655  */
656 #define	PEVNT_MOBIL	(1 | PEER_EVENT) /* mobilize */
657 #define	PEVNT_DEMOBIL	(2 | PEER_EVENT) /* demobilize */
658 #define	PEVNT_UNREACH	(3 | PEER_EVENT) /* unreachable */
659 #define	PEVNT_REACH	(4 | PEER_EVENT) /* reachable */
660 #define	PEVNT_RESTART	(5 | PEER_EVENT) /* restart */
661 #define	PEVNT_REPLY	(6 | PEER_EVENT) /* no reply */
662 #define	PEVNT_RATE	(7 | PEER_EVENT) /* rate exceeded */
663 #define	PEVNT_DENY	(8 | PEER_EVENT) /* access denied */
664 #define PEVNT_ARMED	(9 | PEER_EVENT) /* leap armed */
665 #define	PEVNT_NEWPEER	(10 | PEER_EVENT) /* sys peer */
666 #define	PEVNT_CLOCK	(11 | PEER_EVENT) /* clock event */
667 #define	PEVNT_AUTH	(12 | PEER_EVENT) /* bad auth */
668 #define	PEVNT_POPCORN	(13 | PEER_EVENT) /* popcorn */
669 #define	PEVNT_XLEAVE	(14 | PEER_EVENT) /* interleave mode */
670 #define	PEVNT_XERR	(15 | PEER_EVENT) /* interleave error */
671 
672 /*
673  * Clock event codes
674  */
675 #define	CEVNT_NOMINAL	0	/* unspecified */
676 #define	CEVNT_TIMEOUT	1	/* no reply */
677 #define	CEVNT_BADREPLY	2	/* bad format */
678 #define	CEVNT_FAULT	3	/* fault */
679 #define	CEVNT_PROP	4	/* bad signal */
680 #define	CEVNT_BADDATE	5	/* bad date */
681 #define	CEVNT_BADTIME	6	/* bad time */
682 #define CEVNT_MAX	CEVNT_BADTIME
683 
684 /*
685  * Very misplaced value.  Default port through which we send traps.
686  */
687 #define	TRAPPORT	18447
688 
689 
690 /*
691  * To speed lookups, peers are hashed by the low order bits of the
692  * remote IP address. These definitions relate to that.
693  */
694 #define	NTP_HASH_SIZE		128
695 #define	NTP_HASH_MASK		(NTP_HASH_SIZE-1)
696 #define	NTP_HASH_ADDR(src)	(sock_hash(src) & NTP_HASH_MASK)
697 
698 /*
699  * min, min3 and max.  Makes it easier to transliterate the spec without
700  * thinking about it.
701  */
702 #define	min(a,b)	(((a) < (b)) ? (a) : (b))
703 #define	max(a,b)	(((a) > (b)) ? (a) : (b))
704 #define	min3(a,b,c)	min(min((a),(b)), (c))
705 
706 
707 /*
708  * Configuration items.  These are for the protocol module (proto_config())
709  */
710 #define	PROTO_BROADCLIENT	1
711 #define	PROTO_PRECISION		2	/* (not used) */
712 #define	PROTO_AUTHENTICATE	3
713 #define	PROTO_BROADDELAY	4
714 #define	PROTO_AUTHDELAY		5	/* (not used) */
715 #define PROTO_MULTICAST_ADD	6
716 #define PROTO_MULTICAST_DEL	7
717 #define PROTO_NTP		8
718 #define PROTO_KERNEL		9
719 #define PROTO_MONITOR		10
720 #define PROTO_FILEGEN		11
721 #define	PROTO_PPS		12
722 #define PROTO_CAL		13
723 #define PROTO_MINCLOCK		14
724 #define	PROTO_MAXCLOCK		15
725 #define PROTO_MINSANE		16
726 #define PROTO_FLOOR		17
727 #define PROTO_CEILING		18
728 #define PROTO_COHORT		19
729 #define PROTO_CALLDELAY		20
730 #define PROTO_MINDISP		21
731 #define PROTO_MAXDIST		22
732 	/* available		23 */
733 #define	PROTO_MAXHOP		24
734 #define	PROTO_BEACON		25
735 #define	PROTO_ORPHAN		26
736 #define	PROTO_ORPHWAIT		27
737 #define	PROTO_MODE7		28
738 #define	PROTO_UECRYPTO		29
739 #define	PROTO_UECRYPTONAK	30
740 #define	PROTO_UEDIGEST		31
741 #define	PROTO_PCEDIGEST		32
742 #define	PROTO_BCPOLLBSTEP	33
743 
744 /*
745  * Configuration items for the loop filter
746  */
747 #define	LOOP_DRIFTINIT		1	/* iniitialize frequency */
748 #define	LOOP_KERN_CLEAR		2	/* set initial frequency offset */
749 #define LOOP_MAX		3	/* set both step offsets */
750 #define LOOP_MAX_BACK		4	/* set backward-step offset */
751 #define LOOP_MAX_FWD		5	/* set forward-step offset */
752 #define LOOP_PANIC		6	/* set panic offseet */
753 #define LOOP_PHI		7	/* set dispersion rate */
754 #define LOOP_MINSTEP		8	/* set step timeout */
755 #define LOOP_MINPOLL		9	/* set min poll interval (log2 s) */
756 #define LOOP_ALLAN		10	/* set minimum Allan intercept */
757 #define LOOP_HUFFPUFF		11	/* set huff-n'-puff filter length */
758 #define LOOP_FREQ		12	/* set initial frequency */
759 #define LOOP_CODEC		13	/* set audio codec frequency */
760 #define	LOOP_LEAP		14	/* insert leap after second 23:59 */
761 #define	LOOP_TICK		15	/* sim. low precision clock */
762 
763 /*
764  * Configuration items for the stats printer
765  */
766 #define	STATS_FREQ_FILE		1	/* configure drift file */
767 #define STATS_STATSDIR		2	/* directory prefix for stats files */
768 #define	STATS_PID_FILE		3	/* configure ntpd PID file */
769 #define	STATS_LEAP_FILE		4	/* configure ntpd leapseconds file */
770 
771 #define MJD_1900		15020	/* MJD for 1 Jan 1900 */
772 
773 /*
774  * Default parameters.  We use these in the absence of something better.
775  */
776 #define INADDR_NTP	0xe0000101	/* NTP multicast address 224.0.1.1 */
777 
778 /*
779  * Structure used optionally for monitoring when this is turned on.
780  */
781 typedef struct mon_data	mon_entry;
782 struct mon_data {
783 	mon_entry *	hash_next;	/* next structure in hash list */
784 	DECL_DLIST_LINK(mon_entry, mru);/* MRU list link pointers */
785 	struct interface * lcladr;	/* address on which this arrived */
786 	l_fp		first;		/* first time seen */
787 	l_fp		last;		/* last time seen */
788 	int		leak;		/* leaky bucket accumulator */
789 	int		count;		/* total packet count */
790 	u_short		flags;		/* restrict flags */
791 	u_char		vn_mode;	/* packet mode & version */
792 	u_char		cast_flags;	/* flags MDF_?CAST */
793 	sockaddr_u	rmtadr;		/* address of remote host */
794 };
795 
796 /*
797  * Values for cast_flags in mon_entry and struct peer.  mon_entry uses
798  * only the first three, MDF_UCAST, MDF_MCAST, and MDF_BCAST.
799  */
800 #define	MDF_UCAST	0x01	/* unicast client */
801 #define	MDF_MCAST	0x02	/* multicast server */
802 #define	MDF_BCAST	0x04	/* broadcast server */
803 #define	MDF_POOL	0x08	/* pool client solicitor */
804 #define MDF_ACAST	0x10	/* manycast client solicitor */
805 #define	MDF_BCLNT	0x20	/* eph. broadcast/multicast client */
806 #define MDF_UCLNT	0x40	/* preemptible manycast or pool client */
807 /*
808  * In the context of struct peer in ntpd, three of the cast_flags bits
809  * represent configured associations which never receive packets, and
810  * whose reach is always 0: MDF_BCAST, MDF_MCAST, and MDF_ACAST.  The
811  * last can be argued as responses are received, but those responses do
812  * not affect the MDF_ACAST association's reach register, rather they
813  * (may) result in mobilizing ephemeral MDF_ACLNT associations.
814  */
815 #define MDF_TXONLY_MASK	(MDF_BCAST | MDF_MCAST | MDF_ACAST | MDF_POOL)
816 /*
817  * manycastclient-like solicitor association cast_flags bits
818  */
819 #define MDF_SOLICIT_MASK	(MDF_ACAST | MDF_POOL)
820 /*
821  * Values used with mon_enabled to indicate reason for enabling monitoring
822  */
823 #define MON_OFF		0x00		/* no monitoring */
824 #define MON_ON		0x01		/* monitoring explicitly enabled */
825 #define MON_RES		0x02		/* implicit monitoring for RES_LIMITED */
826 /*
827  * Structure used for restrictlist entries
828  */
829 typedef struct res_addr4_tag {
830 	u_int32		addr;		/* IPv4 addr (host order) */
831 	u_int32		mask;		/* IPv4 mask (host order) */
832 } res_addr4;
833 
834 typedef struct res_addr6_tag {
835 	struct in6_addr addr;		/* IPv6 addr (net order) */
836 	struct in6_addr mask;		/* IPv6 mask (net order) */
837 } res_addr6;
838 
839 typedef struct restrict_u_tag	restrict_u;
840 struct restrict_u_tag {
841 	restrict_u *	link;		/* link to next entry */
842 	u_int32		count;		/* number of packets matched */
843 	u_short		rflags;		/* restrict (accesslist) flags */
844 	u_short		mflags;		/* match flags */
845 	short		ippeerlimit;	/* IP peer limit */
846 	int		srvfuzrftpoll;	/* server response: fuzz reftime */
847 	u_long		expire;		/* valid until time */
848 	union {				/* variant starting here */
849 		res_addr4 v4;
850 		res_addr6 v6;
851 	} u;
852 };
853 #define	V4_SIZEOF_RESTRICT_U	(offsetof(restrict_u, u)	\
854 				 + sizeof(res_addr4))
855 #define	V6_SIZEOF_RESTRICT_U	(offsetof(restrict_u, u)	\
856 				 + sizeof(res_addr6))
857 
858 typedef struct r4addr_tag	r4addr;
859 struct r4addr_tag {
860 	u_short		rflags;		/* match flags */
861 	short		ippeerlimit;	/* IP peer limit */
862 };
863 
864 char *build_iflags(u_int32 flags);
865 char *build_mflags(u_short mflags);
866 char *build_rflags(u_short rflags);
867 
868 /*
869  * Restrict (Access) flags (rflags)
870  */
871 #define	RES_IGNORE		0x0001	/* ignore packet */
872 #define	RES_DONTSERVE		0x0002	/* access denied */
873 #define	RES_DONTTRUST		0x0004	/* authentication required */
874 #define	RES_VERSION		0x0008	/* version mismatch */
875 #define	RES_NOPEER		0x0010	/* new association denied */
876 #define	RES_NOEPEER		0x0020	/* new ephemeral association denied */
877 #define RES_LIMITED		0x0040	/* packet rate exceeded */
878 #define RES_FLAGS		(RES_IGNORE | RES_DONTSERVE |\
879 				    RES_DONTTRUST | RES_VERSION |\
880 				    RES_NOPEER | RES_NOEPEER | RES_LIMITED)
881 
882 #define	RES_NOQUERY		0x0080	/* mode 6/7 packet denied */
883 #define	RES_NOMODIFY		0x0100	/* mode 6/7 modify denied */
884 #define	RES_NOTRAP		0x0200	/* mode 6/7 set trap denied */
885 #define	RES_LPTRAP		0x0400	/* mode 6/7 low priority trap */
886 
887 #define	RES_KOD			0x0800	/* send kiss of death packet */
888 #define	RES_MSSNTP		0x1000	/* enable MS-SNTP authentication */
889 #define	RES_FLAKE		0x2000	/* flakeway - drop 10% */
890 #define	RES_NOMRULIST		0x4000	/* mode 6 mrulist denied */
891 
892 #define	RES_SRVRSPFUZ		0x8000	/* Server response: fuzz */
893 
894 #define RES_UNUSED		0x0000	/* Unused flag bits (none left) */
895 
896 #define	RES_ALLFLAGS		(RES_FLAGS | RES_NOQUERY |	\
897 				 RES_NOMODIFY | RES_NOTRAP |	\
898 				 RES_LPTRAP | RES_KOD |		\
899 				 RES_MSSNTP | RES_FLAKE |	\
900 				 RES_NOMRULIST | RES_SRVRSPFUZ )
901 
902 /*
903  * Match flags (mflags)
904  */
905 #define	RESM_INTERFACE		0x1000	/* this is an interface */
906 #define	RESM_NTPONLY		0x2000	/* match source port 123 */
907 #define RESM_SOURCE		0x4000	/* from "restrict source" */
908 
909 /*
910  * Restriction configuration ops
911  */
912 typedef enum
913 restrict_ops {
914 	RESTRICT_FLAGS = 1,	/* add rflags to restrict entry */
915 	RESTRICT_UNFLAG,	/* remove rflags from restrict entry */
916 	RESTRICT_REMOVE,	/* remove a restrict entry */
917 	RESTRICT_REMOVEIF,	/* remove an interface restrict entry */
918 } restrict_op;
919 
920 /*
921  * Endpoint structure for the select algorithm
922  */
923 struct endpoint {
924 	double	val;			/* offset of endpoint */
925 	int	type;			/* interval entry/exit */
926 };
927 
928 /*
929  * Association matching AM[] return codes
930  */
931 #define AM_ERR		-1		/* error */
932 #define AM_NOMATCH	0		/* no match */
933 #define AM_PROCPKT	1		/* server/symmetric packet */
934 #define AM_BCST		2		/* broadcast packet */
935 #define AM_FXMIT	3		/* client packet */
936 #define AM_MANYCAST	4		/* manycast or pool */
937 #define AM_NEWPASS	5		/* new passive */
938 #define AM_NEWBCL	6		/* new broadcast */
939 #define AM_POSSBCL	7		/* discard broadcast */
940 
941 /* NetInfo configuration locations */
942 #ifdef HAVE_NETINFO
943 #define NETINFO_CONFIG_DIR "/config/ntp"
944 #endif
945 
946 /* ntpq -c mrulist rows per request limit in ntpd */
947 #define MRU_ROW_LIMIT	256
948 /* similar datagrams per response limit for ntpd */
949 #define MRU_FRAGS_LIMIT	128
950 #endif /* NTP_H */
951