1/* 2 * ntp.h - NTP definitions for the masses 3 */ 4#ifndef NTP_H 5#define NTP_H 6 7#include <math.h> 8 9#include <ntp_fp.h> 10#include <ntp_types.h> 11#include <ntp_stdlib.h> 12#ifdef OPENSSL 13#include <ntp_crypto.h> 14#endif /* OPENSSL */ 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 82typedef signed char s_char; 83# else 84typedef 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#ifndef TRUE 93# define TRUE 1 94#endif /* TRUE */ 95#ifndef FALSE 96# define FALSE 0 97#endif /* FALSE */ 98 99/* 100 * NTP protocol parameters. See section 3.2.6 of the specification. 101 */ 102#define NTP_VERSION ((u_char)4) /* current version number */ 103#define NTP_OLDVERSION ((u_char)1) /* oldest credible version */ 104#define NTP_PORT 123 /* included for non-unix machines */ 105 106/* 107 * Poll interval parameters 108 */ 109#define NTP_UNREACH 10 /* poll unreach threshold */ 110#define NTP_MINPOLL 3 /* log2 min poll interval (8 s) */ 111#define NTP_MINDPOLL 6 /* log2 default min poll (64 s) */ 112#define NTP_MAXDPOLL 10 /* log2 default max poll (~17 m) */ 113#define NTP_MAXPOLL 17 /* log2 max poll interval (~36 h) */ 114#define NTP_RETRY 3 /* max packet retries */ 115#define NTP_MINPKT 1 /* log2 min interburst interval (2 s) */ 116 117/* 118 * Clock filter algorithm tuning parameters 119 */ 120#define MAXDISPERSE 16. /* max dispersion */ 121#define NTP_SHIFT 8 /* clock filter stages */ 122#define NTP_FWEIGHT .5 /* clock filter weight */ 123 124/* 125 * Selection algorithm tuning parameters 126 */ 127#define NTP_MINCLOCK 3 /* min survivors */ 128#define NTP_MAXCLOCK 10 /* max candidates */ 129#define NTP_MAXASSOC 50 /* max associations */ 130#define MINDISPERSE .001 /* min distance */ 131#define MAXDISTANCE 1.5 /* max root distance (select threshold) */ 132#define CLOCK_SGATE 3. /* popcorn spike gate */ 133#define HUFFPUFF 900 /* huff-n'-puff sample interval (s) */ 134#define MAXHOP 2 /* anti-clockhop threshold */ 135#define MAX_TTL 8 /* max ttl mapping vector size */ 136#define BEACON 7200 /* manycast beacon interval */ 137#define NTP_MAXEXTEN 2048 /* max extension field size */ 138 139/* 140 * Miscellaneous stuff 141 */ 142#define NTP_MAXKEY 65535 /* max authentication key number */ 143#define KEY_TYPE_MD5 NID_md5 /* MD5 digest NID */ 144/* 145 * Limits of things 146 */ 147#define MAXFILENAME 128 /* max length of file name */ 148#define MAXHOSTNAME 512 /* max length of host/node name */ 149#define NTP_MAXSTRLEN 256 /* max string length */ 150 151/* 152 * Operations for jitter calculations (these use doubles). 153 * 154 * Note that we carefully separate the jitter component from the 155 * dispersion component (frequency error plus precision). The frequency 156 * error component is computed as CLOCK_PHI times the difference between 157 * the epoch of the time measurement and the reference time. The 158 * precision component is computed as the square root of the mean of the 159 * squares of a zero-mean, uniform distribution of unit maximum 160 * amplitude. Whether this makes statistical sense may be arguable. 161 */ 162#define SQUARE(x) ((x) * (x)) 163#define SQRT(x) (sqrt(x)) 164#define DIFF(x, y) (SQUARE((x) - (y))) 165#define LOGTOD(a) ((a) < 0 ? 1. / (1L << -(a)) : \ 166 1L << (int)(a)) /* log2 to double */ 167#define UNIVAR(x) (SQUARE(.28867513 * LOGTOD(x))) /* std uniform distr */ 168#define ULOGTOD(a) (1L << (int)(a)) /* ulog2 to double */ 169 170#define EVENT_TIMEOUT 0 /* one second, that is */ 171 172 173/* 174 * The interface structure is used to hold the addresses and socket 175 * numbers of each of the interfaces we are using. 176 */ 177struct interface { 178 struct interface *link; /* interface list link */ 179 SOCKET fd; /* socket this is opened on */ 180 SOCKET bfd; /* socket for receiving broadcasts */ 181 sockaddr_u sin; /* interface address */ 182 sockaddr_u bcast; /* broadcast address */ 183 sockaddr_u mask; /* interface mask */ 184 char name[32]; /* name of interface */ 185 u_short family; /* Address family */ 186 u_short phase; /* phase in update cycle */ 187 int flags; /* interface flags */ 188 int last_ttl; /* last TTL specified */ 189 u_int32 addr_refid; /* IPv4 addr or IPv6 hash */ 190 int num_mcast; /* No. of IP addresses in multicast socket */ 191 u_long starttime; /* current_time as of creation of interface structure */ 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 scopeid; /* Scope used for Multicasting */ 196 u_int ifnum; /* sequential interface instance count */ 197 isc_boolean_t ignore_packets; /* listen-read-drop this? */ 198 struct peer *peers; /* list of peers for the interface */ 199 u_int peercnt; /* peers referencing this interface */ 200 int flags6; /* ifr6.ifr_ifru.ifru_flags6 */ 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 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 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 */ 249struct peer { 250 struct peer *next; /* link pointer in peer hash */ 251 struct peer *ass_next; /* link pointer in associd hash */ 252 struct peer *ilink; /* list of peers for interface */ 253 sockaddr_u srcadr; /* address of remote host */ 254 struct interface *dstadr; /* local address (interface) */ 255#ifdef __APPLE__ 256 char *dns_name; 257 u_long dns_update; 258 u_int dns_ttl; 259#endif /* __APPLE__ */ 260 associd_t associd; /* association ID */ 261 u_char version; /* version number */ 262 u_char hmode; /* local association mode */ 263 u_char hpoll; /* local poll interval */ 264 u_char minpoll; /* min poll interval */ 265 u_char maxpoll; /* max poll interval */ 266 u_int flags; /* association flags */ 267 u_char cast_flags; /* additional flags */ 268 u_char last_event; /* last peer error code */ 269 u_char num_events; /* number of error events */ 270 u_char ttl; /* ttl/refclock mode */ 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 OPENSSL 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 /* OPENSSL */ 328#define clear_to_zero status 329#endif /* OPENSSL */ 330 331 /* 332 * Ephemeral state variables 333 */ 334 u_char status; /* peer status */ 335 u_char reach; /* reachability register */ 336 int flash; /* protocol error test tally bits */ 337 u_long epoch; /* reference epoch */ 338 int burst; /* packets remaining in burst */ 339 int retry; /* retry counter */ 340 int flip; /* interleave mode control */ 341 int filter_nextpt; /* index into filter shift register */ 342 double filter_delay[NTP_SHIFT]; /* delay shift register */ 343 double filter_offset[NTP_SHIFT]; /* offset shift register */ 344 double filter_disp[NTP_SHIFT]; /* dispersion shift register */ 345 u_long filter_epoch[NTP_SHIFT]; /* epoch shift register */ 346 u_char filter_order[NTP_SHIFT]; /* filter sort index */ 347 l_fp rec; /* receive time stamp */ 348 l_fp xmt; /* transmit time stamp */ 349 l_fp dst; /* destination timestamp */ 350 l_fp aorg; /* origin timestamp */ 351 l_fp borg; /* alternate origin timestamp */ 352 double offset; /* peer clock offset */ 353 double delay; /* peer roundtrip delay */ 354 double jitter; /* peer jitter (squares) */ 355 double disp; /* peer dispersion */ 356 double xleave; /* interleave delay */ 357 double bias; /* bias for NIC asymmetry */ 358 359 /* 360 * Variables used to correct for packet length and asymmetry. 361 */ 362 double t21; /* outbound packet delay */ 363 int t21_bytes; /* outbound packet length */ 364 int t21_last; /* last outbound packet length */ 365 double r21; /* outbound data rate */ 366 double t34; /* inbound packet delay */ 367 int t34_bytes; /* inbound packet length */ 368 double r34; /* inbound data rate */ 369 370 /* 371 * End of clear-to-zero area 372 */ 373 u_long update; /* receive epoch */ 374#define end_clear_to_zero update 375 int unreach; /* watchdog counter */ 376 int throttle; /* rate control */ 377 u_long outdate; /* send time last packet */ 378 u_long nextdate; /* send time next packet */ 379 u_long nextaction; /* peer local activity timeout (refclocks) */ 380 void (*action) (struct peer *); /* action timeout function */ 381 382 /* 383 * Statistic counters 384 */ 385 u_long timereset; /* time stat counters were reset */ 386 u_long timereceived; /* last packet received time */ 387 u_long timereachable; /* last reachable/unreachable time */ 388 389 u_long sent; /* packets sent */ 390 u_long received; /* packets received */ 391 u_long processed; /* packets processed */ 392 u_long badauth; /* bad authentication (TEST5) */ 393 u_long bogusorg; /* bogus origin (TEST2, TEST3) */ 394 u_long oldpkt; /* old duplicate (TEST1) */ 395 u_long seldisptoolarge; /* bad header (TEST6, TEST7) */ 396 u_long selbroken; /* KoD received */ 397}; 398 399/* 400 * Values for peer.leap, sys_leap 401 */ 402#define LEAP_NOWARNING 0x0 /* normal, no leap second warning */ 403#define LEAP_ADDSECOND 0x1 /* last minute of day has 61 seconds */ 404#define LEAP_DELSECOND 0x2 /* last minute of day has 59 seconds */ 405#define LEAP_NOTINSYNC 0x3 /* overload, clock is free running */ 406 407/* 408 * Values for peer mode and packet mode. Only the modes through 409 * MODE_BROADCAST and MODE_BCLIENT appear in the transition 410 * function. MODE_CONTROL and MODE_PRIVATE can appear in packets, 411 * but those never survive to the transition function. 412 * is a 413 */ 414#define MODE_UNSPEC 0 /* unspecified (old version) */ 415#define MODE_ACTIVE 1 /* symmetric active mode */ 416#define MODE_PASSIVE 2 /* symmetric passive mode */ 417#define MODE_CLIENT 3 /* client mode */ 418#define MODE_SERVER 4 /* server mode */ 419#define MODE_BROADCAST 5 /* broadcast mode */ 420/* 421 * These can appear in packets 422 */ 423#define MODE_CONTROL 6 /* control mode */ 424#define MODE_PRIVATE 7 /* private mode */ 425/* 426 * This is a madeup mode for broadcast client. 427 */ 428#define MODE_BCLIENT 6 /* broadcast client mode */ 429 430/* 431 * Values for peer.stratum, sys_stratum 432 */ 433#define STRATUM_REFCLOCK ((u_char)0) /* default stratum */ 434/* A stratum of 0 in the packet is mapped to 16 internally */ 435#define STRATUM_PKT_UNSPEC ((u_char)0) /* unspecified in packet */ 436#define STRATUM_UNSPEC ((u_char)16) /* unspecified */ 437 438/* 439 * Values for peer.flags 440 */ 441#define FLAG_CONFIG 0x0001 /* association was configured */ 442#define FLAG_PREEMPT 0x0002 /* preemptable association */ 443#define FLAG_AUTHENTIC 0x0004 /* last message was authentic */ 444#define FLAG_REFCLOCK 0x0008 /* this is actually a reference clock */ 445#define FLAG_SYSPEER 0x0010 /* system peer */ 446#define FLAG_PREFER 0x0020 /* prefer peer */ 447#define FLAG_BURST 0x0040 /* burst mode */ 448#define FLAG_PPS 0x0080 /* steered by PPS */ 449#define FLAG_IBURST 0x0100 /* initial burst mode */ 450#define FLAG_NOSELECT 0x0200 /* never select */ 451#define FLAG_TRUE 0x0400 /* force truechimer */ 452#define FLAG_SKEY 0x0800 /* autokey authentication */ 453#define FLAG_XLEAVE 0x1000 /* interleaved protocol */ 454#define FLAG_XB 0x2000 /* interleaved broadcast */ 455#define FLAG_XBOGUS 0x4000 /* interleaved bogus packet */ 456#ifdef OPENSSL 457#define FLAG_ASSOC 0x8000 /* autokey request */ 458#endif /* OPENSSL */ 459/* local configuration was specified -- override any DNS configuration */ 460#define FLAG_UMINPOLL 0x10000 461#define FLAG_UMAXPOLL 0x20000 462#define FLAG_UBURST 0x40000 463#define FLAG_UIBURST 0x80000 464 465/* 466 * Definitions for the clear() routine. We use memset() to clear 467 * the parts of the peer structure which go to zero. These are 468 * used to calculate the start address and length of the area. 469 */ 470#define CLEAR_TO_ZERO(p) ((char *)&((p)->clear_to_zero)) 471#define END_CLEAR_TO_ZERO(p) ((char *)&((p)->end_clear_to_zero)) 472#define LEN_CLEAR_TO_ZERO (END_CLEAR_TO_ZERO((struct peer *)0) \ 473 - CLEAR_TO_ZERO((struct peer *)0)) 474#define CRYPTO_TO_ZERO(p) ((char *)&((p)->clear_to_zero)) 475#define END_CRYPTO_TO_ZERO(p) ((char *)&((p)->end_clear_to_zero)) 476#define LEN_CRYPTO_TO_ZERO (END_CRYPTO_TO_ZERO((struct peer *)0) \ 477 - CRYPTO_TO_ZERO((struct peer *)0)) 478 479/* 480 * Reference clock identifiers (for pps signal) 481 */ 482#define PPSREFID (u_int32)"PPS " /* used when pps controls stratum>1 */ 483 484/* 485 * Reference clock types. Added as necessary. 486 */ 487#define REFCLK_NONE 0 /* unknown or missing */ 488#define REFCLK_LOCALCLOCK 1 /* external (e.g., lockclock) */ 489#define REFCLK_GPS_TRAK 2 /* TRAK 8810 GPS Receiver */ 490#define REFCLK_WWV_PST 3 /* PST/Traconex 1020 WWV/H */ 491#define REFCLK_SPECTRACOM 4 /* Spectracom (generic) Receivers */ 492#define REFCLK_TRUETIME 5 /* TrueTime (generic) Receivers */ 493#define REFCLK_IRIG_AUDIO 6 /* IRIG-B/W audio decoder */ 494#define REFCLK_CHU_AUDIO 7 /* CHU audio demodulator/decoder */ 495#define REFCLK_PARSE 8 /* generic driver (usually DCF77,GPS,MSF) */ 496#define REFCLK_GPS_MX4200 9 /* Magnavox MX4200 GPS */ 497#define REFCLK_GPS_AS2201 10 /* Austron 2201A GPS */ 498#define REFCLK_GPS_ARBITER 11 /* Arbiter 1088A/B/ GPS */ 499#define REFCLK_IRIG_TPRO 12 /* KSI/Odetics TPRO-S IRIG */ 500#define REFCLK_ATOM_LEITCH 13 /* Leitch CSD 5300 Master Clock */ 501#define REFCLK_MSF_EES 14 /* EES M201 MSF Receiver */ 502#define REFCLK_GPSTM_TRUE 15 /* OLD TrueTime GPS/TM-TMD Receiver */ 503#define REFCLK_IRIG_BANCOMM 16 /* Bancomm GPS/IRIG Interface */ 504#define REFCLK_GPS_DATUM 17 /* Datum Programmable Time System */ 505#define REFCLK_ACTS 18 /* Generic Auto Computer Time Service */ 506#define REFCLK_WWV_HEATH 19 /* Heath GC1000 WWV/WWVH Receiver */ 507#define REFCLK_GPS_NMEA 20 /* NMEA based GPS clock */ 508#define REFCLK_GPS_VME 21 /* TrueTime GPS-VME Interface */ 509#define REFCLK_ATOM_PPS 22 /* 1-PPS Clock Discipline */ 510#define REFCLK_PTB_ACTS 23 /* replaced by REFCLK_ACTS */ 511#define REFCLK_USNO 24 /* replaced by REFCLK_ACTS */ 512#define REFCLK_GPS_HP 26 /* HP 58503A Time/Frequency Receiver */ 513#define REFCLK_ARCRON_MSF 27 /* ARCRON MSF radio clock. */ 514#define REFCLK_SHM 28 /* clock attached thru shared memory */ 515#define REFCLK_PALISADE 29 /* Trimble Navigation Palisade GPS */ 516#define REFCLK_ONCORE 30 /* Motorola UT Oncore GPS */ 517#define REFCLK_GPS_JUPITER 31 /* Rockwell Jupiter GPS receiver */ 518#define REFCLK_CHRONOLOG 32 /* Chrono-log K WWVB receiver */ 519#define REFCLK_DUMBCLOCK 33 /* Dumb localtime clock */ 520#define REFCLK_ULINK 34 /* Ultralink M320 WWVB receiver */ 521#define REFCLK_PCF 35 /* Conrad parallel port radio clock */ 522#define REFCLK_WWV_AUDIO 36 /* WWV/H audio demodulator/decoder */ 523#define REFCLK_FG 37 /* Forum Graphic GPS */ 524#define REFCLK_HOPF_SERIAL 38 /* hopf DCF77/GPS serial receiver */ 525#define REFCLK_HOPF_PCI 39 /* hopf DCF77/GPS PCI receiver */ 526#define REFCLK_JJY 40 /* JJY receiver */ 527#define REFCLK_TT560 41 /* TrueTime 560 IRIG-B decoder */ 528#define REFCLK_ZYFER 42 /* Zyfer GPStarplus receiver */ 529#define REFCLK_RIPENCC 43 /* RIPE NCC Trimble driver */ 530#define REFCLK_NEOCLOCK4X 44 /* NeoClock4X DCF77 or TDF receiver */ 531#define REFCLK_MAX 44 /* NeoClock4X DCF77 or TDF receiver */ 532 533 534/* 535 * NTP packet format. The mac field is optional. It isn't really 536 * an l_fp either, but for now declaring it that way is convenient. 537 * See Appendix A in the specification. 538 * 539 * Note that all u_fp and l_fp values arrive in network byte order 540 * and must be converted (except the mac, which isn't, really). 541 */ 542struct pkt { 543 u_char li_vn_mode; /* peer leap indicator */ 544 u_char stratum; /* peer stratum */ 545 u_char ppoll; /* peer poll interval */ 546 s_char precision; /* peer clock precision */ 547 u_fp rootdelay; /* roundtrip delay to primary source */ 548 u_fp rootdisp; /* dispersion to primary source*/ 549 u_int32 refid; /* reference id */ 550 l_fp reftime; /* last update time */ 551 l_fp org; /* originate time stamp */ 552 l_fp rec; /* receive time stamp */ 553 l_fp xmt; /* transmit time stamp */ 554 555#define LEN_PKT_NOMAC (12 * sizeof(u_int32)) /* min header length */ 556#define MIN_MAC_LEN (1 * sizeof(u_int32)) /* crypto_NAK */ 557#define MAX_MD5_LEN (5 * sizeof(u_int32)) /* MD5 */ 558#define MAX_MAC_LEN (6 * sizeof(u_int32)) /* SHA */ 559 560 /* 561 * The length of the packet less MAC must be a multiple of 64 562 * with an RSA modulus and Diffie-Hellman prime of 256 octets 563 * and maximum host name of 128 octets, the maximum autokey 564 * command is 152 octets and maximum autokey response is 460 565 * octets. A packet can contain no more than one command and one 566 * response, so the maximum total extension field length is 864 567 * octets. But, to handle humungus certificates, the bank must 568 * be broke. 569 */ 570#ifdef OPENSSL 571 u_int32 exten[NTP_MAXEXTEN / 4]; /* max extension field */ 572#else /* OPENSSL */ 573 u_int32 exten[1]; /* misused */ 574#endif /* OPENSSL */ 575 u_char mac[MAX_MAC_LEN]; /* mac */ 576}; 577 578/* 579 * Stuff for extracting things from li_vn_mode 580 */ 581#define PKT_MODE(li_vn_mode) ((u_char)((li_vn_mode) & 0x7)) 582#define PKT_VERSION(li_vn_mode) ((u_char)(((li_vn_mode) >> 3) & 0x7)) 583#define PKT_LEAP(li_vn_mode) ((u_char)(((li_vn_mode) >> 6) & 0x3)) 584 585/* 586 * Stuff for putting things back into li_vn_mode 587 */ 588#define PKT_LI_VN_MODE(li, vn, md) \ 589 ((u_char)((((li) << 6) & 0xc0) | (((vn) << 3) & 0x38) | ((md) & 0x7))) 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#define EVNT_CLKHOP 16 /* clockhop */ 628 629/* 630 * Peer event codes 631 */ 632#define PEVNT_MOBIL (1 | PEER_EVENT) /* mobilize */ 633#define PEVNT_DEMOBIL (2 | PEER_EVENT) /* demobilize */ 634#define PEVNT_UNREACH (3 | PEER_EVENT) /* unreachable */ 635#define PEVNT_REACH (4 | PEER_EVENT) /* reachable */ 636#define PEVNT_RESTART (5 | PEER_EVENT) /* restart */ 637#define PEVNT_REPLY (6 | PEER_EVENT) /* no reply */ 638#define PEVNT_RATE (7 | PEER_EVENT) /* rate exceeded */ 639#define PEVNT_DENY (8 | PEER_EVENT) /* access denied */ 640#define PEVNT_ARMED (9 | PEER_EVENT) /* leap armed */ 641#define PEVNT_NEWPEER (10 | PEER_EVENT) /* sys peer */ 642#define PEVNT_CLOCK (11 | PEER_EVENT) /* clock event */ 643#define PEVNT_AUTH (12 | PEER_EVENT) /* bad auth */ 644#define PEVNT_POPCORN (13 | PEER_EVENT) /* popcorn */ 645#define PEVNT_XLEAVE (14 | PEER_EVENT) /* interleave mode */ 646#define PEVNT_XERR (15 | PEER_EVENT) /* interleave error */ 647#define PEVNT_TAI (16 | PEER_EVENT) /* TAI */ 648 649/* 650 * Clock event codes 651 */ 652#define CEVNT_NOMINAL 0 /* unspecified */ 653#define CEVNT_TIMEOUT 1 /* no reply */ 654#define CEVNT_BADREPLY 2 /* bad format */ 655#define CEVNT_FAULT 3 /* fault */ 656#define CEVNT_PROP 4 /* bad signal */ 657#define CEVNT_BADDATE 5 /* bad date */ 658#define CEVNT_BADTIME 6 /* bad time */ 659#define CEVNT_MAX CEVNT_BADTIME 660 661/* 662 * Very misplaced value. Default port through which we send traps. 663 */ 664#define TRAPPORT 18447 665 666 667/* 668 * To speed lookups, peers are hashed by the low order bits of the 669 * remote IP address. These definitions relate to that. 670 */ 671#define NTP_HASH_SIZE 128 672#define NTP_HASH_MASK (NTP_HASH_SIZE-1) 673#define NTP_HASH_ADDR(src) sock_hash(src) 674 675/* 676 * min, min3 and max. Makes it easier to transliterate the spec without 677 * thinking about it. 678 */ 679#define min(a,b) (((a) < (b)) ? (a) : (b)) 680#define max(a,b) (((a) > (b)) ? (a) : (b)) 681#define min3(a,b,c) min(min((a),(b)), (c)) 682 683 684/* 685 * Configuration items. These are for the protocol module (proto_config()) 686 */ 687#define PROTO_BROADCLIENT 1 688#define PROTO_PRECISION 2 /* (not used) */ 689#define PROTO_AUTHENTICATE 3 690#define PROTO_BROADDELAY 4 691#define PROTO_AUTHDELAY 5 /* (not used) */ 692#define PROTO_MULTICAST_ADD 6 693#define PROTO_MULTICAST_DEL 7 694#define PROTO_NTP 8 695#define PROTO_KERNEL 9 696#define PROTO_MONITOR 10 697#define PROTO_FILEGEN 11 698#define PROTO_PPS 12 699#define PROTO_CAL 13 700#define PROTO_MINCLOCK 14 701#define PROTO_MAXCLOCK 15 702#define PROTO_MINSANE 16 703#define PROTO_FLOOR 17 704#define PROTO_CEILING 18 705#define PROTO_COHORT 19 706#define PROTO_CALLDELAY 20 707#define PROTO_MINDISP 21 708#define PROTO_MAXDIST 22 709#define PROTO_ADJ 23 710#define PROTO_MAXHOP 24 711#define PROTO_BEACON 25 712#define PROTO_ORPHAN 26 713 714/* 715 * Configuration items for the loop filter 716 */ 717#define LOOP_DRIFTINIT 1 /* set initial frequency offset */ 718#define LOOP_DRIFTCOMP 2 /* set frequency offset */ 719#define LOOP_MAX 3 /* set step offset */ 720#define LOOP_PANIC 4 /* set panic offseet */ 721#define LOOP_PHI 5 /* set dispersion rate */ 722#define LOOP_MINSTEP 6 /* set step timeout */ 723#define LOOP_MINPOLL 7 /* set min poll interval (log2 s) */ 724#define LOOP_ALLAN 8 /* set minimum Allan intercept */ 725#define LOOP_HUFFPUFF 9 /* set huff-n'-puff filter length */ 726#define LOOP_FREQ 10 /* set initial frequency */ 727#define LOOP_KERN_CLEAR 11 /* reset kernel pll parameters */ 728#define LOOP_CODEC 12 /* set audio codec frequency */ 729#define LOOP_LEAP 13 /* insert leap after second 23:59 */ 730 731/* 732 * Configuration items for the stats printer 733 */ 734#define STATS_FREQ_FILE 1 /* configure drift file */ 735#define STATS_STATSDIR 2 /* directory prefix for stats files */ 736#define STATS_PID_FILE 3 /* configure ntpd PID file */ 737#define STATS_LEAP_FILE 4 /* configure ntpd leapseconds file */ 738 739#define MJD_1900 15020 /* MJD for 1 Jan 1900 */ 740 741/* 742 * Default parameters. We use these in the absence of something better. 743 */ 744#define INADDR_NTP 0xe0000101 /* NTP multicast address 224.0.1.1 */ 745 746/* 747 * Structure used optionally for monitoring when this is turned on. 748 */ 749struct mon_data { 750 struct mon_data *hash_next; /* next structure in hash list */ 751 struct mon_data *mru_next; /* next structure in MRU list */ 752 struct mon_data *mru_prev; /* previous structure in MRU list */ 753 int flags; /* restrict flags */ 754 int leak; /* leaky bucket accumulator */ 755 int count; /* total packet count */ 756 u_long firsttime; /* first time found */ 757 u_long lasttime; /* last time found */ 758 sockaddr_u rmtadr; /* address of remote host */ 759 struct interface *interface; /* interface on which this arrived */ 760 u_short rmtport; /* remote port last came from */ 761 u_char mode; /* packet mode */ 762 u_char version; /* packet version */ 763 u_char cast_flags; /* flags MDF_?CAST */ 764}; 765 766/* 767 * Values for cast_flags 768 */ 769#define MDF_UCAST 0x01 /* unicast */ 770#define MDF_MCAST 0x02 /* multicast */ 771#define MDF_BCAST 0x04 /* broadcast */ 772#define MDF_LCAST 0x08 /* localcast */ 773#define MDF_ACAST 0x10 /* manycast */ 774#define MDF_BCLNT 0x20 /* broadcast client */ 775#define MDF_ACLNT 0x40 /* manycast client */ 776 777/* 778 * Values used with mon_enabled to indicate reason for enabling monitoring 779 */ 780#define MON_OFF 0x00 /* no monitoring */ 781#define MON_ON 0x01 /* monitoring explicitly enabled */ 782#define MON_RES 0x02 /* implicit monitoring for RES_LIMITED */ 783/* 784 * Structure used for restrictlist entries 785 */ 786struct restrictlist { 787 struct restrictlist *next; /* link to next entry */ 788 u_int32 addr; /* Ipv4 host address (host byte order) */ 789 u_int32 mask; /* Ipv4 mask for address (host byte order) */ 790 u_long count; /* number of packets matched */ 791 u_short flags; /* accesslist flags */ 792 u_short mflags; /* match flags */ 793}; 794 795struct restrictlist6 { 796 struct restrictlist6 *next; /* link to next entry */ 797 struct in6_addr addr6; /* Ipv6 host address */ 798 struct in6_addr mask6; /* Ipv6 mask address */ 799 u_long count; /* number of packets matched */ 800 u_short flags; /* accesslist flags */ 801 u_short mflags; /* match flags */ 802}; 803 804 805/* 806 * Access flags 807 */ 808#define RES_IGNORE 0x0001 /* ignore packet */ 809#define RES_DONTSERVE 0x0002 /* access denied */ 810#define RES_DONTTRUST 0x0004 /* authentication required */ 811#define RES_VERSION 0x0008 /* version mismatch */ 812#define RES_NOPEER 0x0010 /* new association denied */ 813#define RES_LIMITED 0x0020 /* packet rate exceeded */ 814#define RES_FLAGS (RES_IGNORE | RES_DONTSERVE |\ 815 RES_DONTTRUST | RES_VERSION |\ 816 RES_NOPEER | RES_LIMITED) 817 818#define RES_NOQUERY 0x0040 /* mode 6/7 packet denied */ 819#define RES_NOMODIFY 0x0080 /* mode 6/7 modify denied */ 820#define RES_NOTRAP 0x0100 /* mode 6/7 set trap denied */ 821#define RES_LPTRAP 0x0200 /* mode 6/7 low priority trap */ 822 823#define RES_KOD 0x0400 /* send kiss of death packet */ 824#define RES_MSSNTP 0x0800 /* enable MS-SNTP authentication */ 825#define RES_TIMEOUT 0x1000 /* timeout this entry */ 826 827#define RES_ALLFLAGS (RES_FLAGS | RES_NOQUERY |\ 828 RES_NOMODIFY | RES_NOTRAP |\ 829 RES_LPTRAP | RES_KOD |\ 830 RES_MSSNTP | RES_TIMEOUT) 831 832/* 833 * Match flags 834 */ 835#define RESM_INTERFACE 0x1000 /* this is an interface */ 836#define RESM_NTPONLY 0x2000 /* match ntp port only */ 837 838/* 839 * Restriction configuration ops 840 */ 841#define RESTRICT_FLAGS 1 /* add flags to restrict entry */ 842#define RESTRICT_UNFLAG 2 /* remove flags from restrict entry */ 843#define RESTRICT_REMOVE 3 /* remove a restrict entry */ 844#define RESTRICT_REMOVEIF 4 /* remove an interface restrict entry */ 845 846/* 847 * Endpoint structure for the select algorithm 848 */ 849struct endpoint { 850 double val; /* offset of endpoint */ 851 int type; /* interval entry/exit */ 852}; 853 854/* 855 * Association matching AM[] return codes 856 */ 857#define AM_ERR -1 /* error */ 858#define AM_NOMATCH 0 /* no match */ 859#define AM_PROCPKT 1 /* server/symmetric packet */ 860#define AM_BCST 2 /* broadcast packet */ 861#define AM_FXMIT 3 /* client packet */ 862#define AM_MANYCAST 4 /* manycast packet */ 863#define AM_NEWPASS 5 /* new passive */ 864#define AM_NEWBCL 6 /* new broadcast */ 865#define AM_POSSBCL 7 /* discard broadcast */ 866 867/* NetInfo configuration locations */ 868#ifdef HAVE_NETINFO 869#define NETINFO_CONFIG_DIR "/config/ntp" 870#endif 871 872#endif /* NTP_H */ 873