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