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