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