1 /* 2 * ntp_request.h - definitions for the ntpd remote query facility 3 */ 4 5 #include "ntp_types.h" 6 7 /* 8 * A mode 7 packet is used exchanging data between an NTP server 9 * and a client for purposes other than time synchronization, e.g. 10 * monitoring, statistics gathering and configuration. A mode 7 11 * packet has the following format: 12 * 13 * 0 1 2 3 14 * 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 15 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ 16 * |R|M| VN | Mode|A| Sequence | Implementation| Req Code | 17 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ 18 * | Err | Number of data items | MBZ | Size of data item | 19 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ 20 * | | 21 * | Data (Minimum 0 octets, maximum 500 octets) | 22 * | | 23 * [...] 24 * | | 25 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ 26 * | Encryption Keyid (when A bit set) | 27 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ 28 * | | 29 * | Message Authentication Code (when A bit set) | 30 * | | 31 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ 32 * 33 * where the fields are (note that the client sends requests, the server 34 * responses): 35 * 36 * Response Bit: This packet is a response (if clear, packet is a request). 37 * 38 * More Bit: Set for all packets but the last in a response which 39 * requires more than one packet. 40 * 41 * Version Number: 2 for current version 42 * 43 * Mode: Always 7 44 * 45 * Authenticated bit: If set, this packet is authenticated. 46 * 47 * Sequence number: For a multipacket response, contains the sequence 48 * number of this packet. 0 is the first in the sequence, 49 * 127 (or less) is the last. The More Bit must be set in 50 * all packets but the last. 51 * 52 * Implementation number: The number of the implementation this request code 53 * is defined by. An implementation number of zero is used 54 * for requst codes/data formats which all implementations 55 * agree on. Implementation number 255 is reserved (for 56 * extensions, in case we run out). 57 * 58 * Request code: An implementation-specific code which specifies the 59 * operation to be (which has been) performed and/or the 60 * format and semantics of the data included in the packet. 61 * 62 * Err: Must be 0 for a request. For a response, holds an error 63 * code relating to the request. If nonzero, the operation 64 * requested wasn't performed. 65 * 66 * 0 - no error 67 * 1 - incompatable implementation number 68 * 2 - unimplemented request code 69 * 3 - format error (wrong data items, data size, packet size etc.) 70 * 4 - no data available (e.g. request for details on unknown peer) 71 * 5-6 I don't know 72 * 7 - authentication failure (i.e. permission denied) 73 * 74 * Number of data items: number of data items in packet. 0 to 500 75 * 76 * MBZ: A reserved data field, must be zero in requests and responses. 77 * 78 * Size of data item: size of each data item in packet. 0 to 500 79 * 80 * Data: Variable sized area containing request/response data. For 81 * requests and responses the size in octets must be greater 82 * than or equal to the product of the number of data items 83 * and the size of a data item. For requests the data area 84 * must be exactly 40 octets in length. For responses the 85 * data area may be any length between 0 and 500 octets 86 * inclusive. 87 * 88 * Message Authentication Code: Same as NTP spec, in definition and function. 89 * May optionally be included in requests which require 90 * authentication, is never included in responses. 91 * 92 * The version number, mode and keyid have the same function and are 93 * in the same location as a standard NTP packet. The request packet 94 * is the same size as a standard NTP packet to ease receive buffer 95 * management, and to allow the same encryption procedure to be used 96 * both on mode 7 and standard NTP packets. The mac is included when 97 * it is required that a request be authenticated, the keyid should be 98 * zero in requests in which the mac is not included. 99 * 100 * The data format depends on the implementation number/request code pair 101 * and whether the packet is a request or a response. The only requirement 102 * is that data items start in the octet immediately following the size 103 * word and that data items be concatenated without padding between (i.e. 104 * if the data area is larger than data_items*size, all padding is at 105 * the end). Padding is ignored, other than for encryption purposes. 106 * Implementations using encryption might want to include a time stamp 107 * or other data in the request packet padding. The key used for requests 108 * is implementation defined, but key 15 is suggested as a default. 109 */ 110 111 /* 112 * A request packet. These are almost a fixed length. 113 */ 114 115 #define MAXFILENAME 128 /* max key file name length */ 116 /* NOTE: also in ntp.h */ 117 118 struct req_pkt { 119 u_char rm_vn_mode; /* response, more, version, mode */ 120 u_char auth_seq; /* key, sequence number */ 121 u_char implementation; /* implementation number */ 122 u_char request; /* request number */ 123 u_short err_nitems; /* error code/number of data items */ 124 u_short mbz_itemsize; /* item size */ 125 char data[MAXFILENAME + 16]; /* data area [32 prev](144 byte max) */ 126 l_fp tstamp; /* time stamp, for authentication */ 127 keyid_t keyid; /* encryption key */ 128 char mac[MAX_MAC_LEN-sizeof(u_int32)]; /* (optional) 8 byte auth code */ 129 }; 130 131 /* 132 * The req_pkt_tail structure is used by ntpd to adjust for different 133 * packet sizes that may arrive. 134 */ 135 struct req_pkt_tail { 136 l_fp tstamp; /* time stamp, for authentication */ 137 keyid_t keyid; /* encryption key */ 138 char mac[MAX_MAC_LEN-sizeof(u_int32)]; /* (optional) 8 byte auth code */ 139 }; 140 141 /* 142 * Input packet lengths. One with the mac, one without. 143 */ 144 #define REQ_LEN_HDR 8 /* 4 * u_char + 2 * u_short */ 145 #define REQ_LEN_MAC (sizeof(struct req_pkt)) 146 #define REQ_LEN_NOMAC (sizeof(struct req_pkt) - MAX_MAC_LEN) 147 148 /* 149 * A response packet. The length here is variable, this is a 150 * maximally sized one. Note that this implementation doesn't 151 * authenticate responses. 152 */ 153 #define RESP_HEADER_SIZE (8) 154 #define RESP_DATA_SIZE (500) 155 156 struct resp_pkt { 157 u_char rm_vn_mode; /* response, more, version, mode */ 158 u_char auth_seq; /* key, sequence number */ 159 u_char implementation; /* implementation number */ 160 u_char request; /* request number */ 161 u_short err_nitems; /* error code/number of data items */ 162 u_short mbz_itemsize; /* item size */ 163 char data[RESP_DATA_SIZE]; /* data area */ 164 }; 165 166 167 /* 168 * Information error codes 169 */ 170 #define INFO_OKAY 0 171 #define INFO_ERR_IMPL 1 /* incompatable implementation */ 172 #define INFO_ERR_REQ 2 /* unknown request code */ 173 #define INFO_ERR_FMT 3 /* format error */ 174 #define INFO_ERR_NODATA 4 /* no data for this request */ 175 #define INFO_ERR_AUTH 7 /* authentication failure */ 176 177 /* 178 * Maximum sequence number. 179 */ 180 #define MAXSEQ 127 181 182 183 /* 184 * Bit setting macros for multifield items. 185 */ 186 #define RESP_BIT 0x80 187 #define MORE_BIT 0x40 188 189 #define ISRESPONSE(rm_vn_mode) (((rm_vn_mode)&RESP_BIT)!=0) 190 #define ISMORE(rm_vn_mode) (((rm_vn_mode)&MORE_BIT)!=0) 191 #define INFO_VERSION(rm_vn_mode) ((u_char)(((rm_vn_mode)>>3)&0x7)) 192 #define INFO_MODE(rm_vn_mode) ((rm_vn_mode)&0x7) 193 194 #define RM_VN_MODE(resp, more, version) \ 195 ((u_char)(((resp)?RESP_BIT:0)\ 196 |((more)?MORE_BIT:0)\ 197 |((version?version:(NTP_OLDVERSION+1))<<3)\ 198 |(MODE_PRIVATE))) 199 200 #define INFO_IS_AUTH(auth_seq) (((auth_seq) & 0x80) != 0) 201 #define INFO_SEQ(auth_seq) ((auth_seq)&0x7f) 202 #define AUTH_SEQ(auth, seq) ((u_char)((((auth)!=0)?0x80:0)|((seq)&0x7f))) 203 204 #define INFO_ERR(err_nitems) ((u_short)((ntohs(err_nitems)>>12)&0xf)) 205 #define INFO_NITEMS(err_nitems) ((u_short)(ntohs(err_nitems)&0xfff)) 206 #define ERR_NITEMS(err, nitems) (htons((u_short)((((u_short)(err)<<12)&0xf000)\ 207 |((u_short)(nitems)&0xfff)))) 208 209 #define INFO_MBZ(mbz_itemsize) ((ntohs(mbz_itemsize)>>12)&0xf) 210 #define INFO_ITEMSIZE(mbz_itemsize) (ntohs(mbz_itemsize)&0xfff) 211 #define MBZ_ITEMSIZE(itemsize) (htons((u_short)(itemsize))) 212 213 214 /* 215 * Implementation numbers. One for universal use and one for ntpd. 216 */ 217 #define IMPL_UNIV 0 218 #define IMPL_XNTPD 2 219 220 /* 221 * Some limits related to authentication. Frames which are 222 * authenticated must include a time stamp which differs from 223 * the receive time stamp by no more than 10 seconds. 224 */ 225 #define INFO_TS_MAXSKEW 10. 226 227 /* 228 * Universal request codes go here. There aren't any. 229 */ 230 231 /* 232 * NTPD request codes go here. 233 */ 234 #define REQ_PEER_LIST 0 /* return list of peers */ 235 #define REQ_PEER_LIST_SUM 1 /* return summary info for all peers */ 236 #define REQ_PEER_INFO 2 /* get standard information on peer */ 237 #define REQ_PEER_STATS 3 /* get statistics for peer */ 238 #define REQ_SYS_INFO 4 /* get system information */ 239 #define REQ_SYS_STATS 5 /* get system stats */ 240 #define REQ_IO_STATS 6 /* get I/O stats */ 241 #define REQ_MEM_STATS 7 /* stats related to peer list maint */ 242 #define REQ_LOOP_INFO 8 /* info from the loop filter */ 243 #define REQ_TIMER_STATS 9 /* get timer stats */ 244 #define REQ_CONFIG 10 /* configure a new peer */ 245 #define REQ_UNCONFIG 11 /* unconfigure an existing peer */ 246 #define REQ_SET_SYS_FLAG 12 /* set system flags */ 247 #define REQ_CLR_SYS_FLAG 13 /* clear system flags */ 248 #define REQ_MONITOR 14 /* (not used) */ 249 #define REQ_NOMONITOR 15 /* (not used) */ 250 #define REQ_GET_RESTRICT 16 /* return restrict list */ 251 #define REQ_RESADDFLAGS 17 /* add flags to restrict list */ 252 #define REQ_RESSUBFLAGS 18 /* remove flags from restrict list */ 253 #define REQ_UNRESTRICT 19 /* remove entry from restrict list */ 254 #define REQ_MON_GETLIST 20 /* return data collected by monitor */ 255 #define REQ_RESET_STATS 21 /* reset stat counters */ 256 #define REQ_RESET_PEER 22 /* reset peer stat counters */ 257 #define REQ_REREAD_KEYS 23 /* reread the encryption key file */ 258 #define REQ_DO_DIRTY_HACK 24 /* (not used) */ 259 #define REQ_DONT_DIRTY_HACK 25 /* (not used) */ 260 #define REQ_TRUSTKEY 26 /* add a trusted key */ 261 #define REQ_UNTRUSTKEY 27 /* remove a trusted key */ 262 #define REQ_AUTHINFO 28 /* return authentication info */ 263 #define REQ_TRAPS 29 /* return currently set traps */ 264 #define REQ_ADD_TRAP 30 /* add a trap */ 265 #define REQ_CLR_TRAP 31 /* clear a trap */ 266 #define REQ_REQUEST_KEY 32 /* define a new request keyid */ 267 #define REQ_CONTROL_KEY 33 /* define a new control keyid */ 268 #define REQ_GET_CTLSTATS 34 /* get stats from the control module */ 269 #define REQ_GET_LEAPINFO 35 /* (not used) */ 270 #define REQ_GET_CLOCKINFO 36 /* get clock information */ 271 #define REQ_SET_CLKFUDGE 37 /* set clock fudge factors */ 272 #define REQ_GET_KERNEL 38 /* get kernel pll/pps information */ 273 #define REQ_GET_CLKBUGINFO 39 /* get clock debugging info */ 274 #define REQ_SET_PRECISION 41 /* (not used) */ 275 #define REQ_MON_GETLIST_1 42 /* return collected v1 monitor data */ 276 #define REQ_HOSTNAME_ASSOCID 43 /* Here is a hostname + assoc_id */ 277 278 /* 279 * Flags in the peer information returns 280 */ 281 #define INFO_FLAG_CONFIG 0x1 282 #define INFO_FLAG_SYSPEER 0x2 283 #define INFO_FLAG_BURST 0x4 284 #define INFO_FLAG_REFCLOCK 0x8 285 #define INFO_FLAG_PREFER 0x10 286 #define INFO_FLAG_AUTHENABLE 0x20 287 #define INFO_FLAG_SEL_CANDIDATE 0x40 288 #define INFO_FLAG_SHORTLIST 0x80 289 290 /* 291 * Flags in the system information returns 292 */ 293 #define INFO_FLAG_BCLIENT 0x1 294 #define INFO_FLAG_AUTHENTICATE 0x2 295 #define INFO_FLAG_NTP 0x4 296 #define INFO_FLAG_KERNEL 0x8 297 #define INFO_FLAG_MONITOR 0x40 298 #define INFO_FLAG_FILEGEN 0x80 299 #define INFO_FLAG_CAL 0x10 300 #define INFO_FLAG_PPS_SYNC 0x20 301 302 /* 303 * Peer list structure. Used to return raw lists of peers. It goes 304 * without saying that everything returned is in network byte order. 305 * Well, it *would* have gone without saying, but somebody said it. 306 */ 307 struct info_peer_list { 308 u_int32 address; /* address of peer */ 309 u_short port; /* port number of peer */ 310 u_char hmode; /* mode for this peer */ 311 u_char flags; /* flags (from above) */ 312 }; 313 314 315 /* 316 * Peer summary structure. Sort of the info that ntpdc returns by default. 317 */ 318 struct info_peer_summary { 319 u_int32 dstadr; /* local address (zero for undetermined) */ 320 u_int32 srcadr; /* source address */ 321 u_short srcport; /* source port */ 322 u_char stratum; /* stratum of peer */ 323 s_char hpoll; /* host polling interval */ 324 s_char ppoll; /* peer polling interval */ 325 u_char reach; /* reachability register */ 326 u_char flags; /* flags, from above */ 327 u_char hmode; /* peer mode */ 328 s_fp delay; /* peer.estdelay */ 329 l_fp offset; /* peer.estoffset */ 330 u_fp dispersion; /* peer.estdisp */ 331 }; 332 333 334 /* 335 * Peer information structure. 336 */ 337 struct info_peer { 338 u_int32 dstadr; /* local address */ 339 u_int32 srcadr; /* remote address */ 340 u_short srcport; /* remote port */ 341 u_char flags; /* peer flags */ 342 u_char leap; /* peer.leap */ 343 u_char hmode; /* peer.hmode */ 344 u_char pmode; /* peer.pmode */ 345 u_char stratum; /* peer.stratum */ 346 u_char ppoll; /* peer.ppoll */ 347 u_char hpoll; /* peer.hpoll */ 348 s_char precision; /* peer.precision */ 349 u_char version; /* peer.version */ 350 u_char unused8; 351 u_char reach; /* peer.reach */ 352 u_char unreach; /* peer.unreach */ 353 u_char flash; /* old peer.flash */ 354 u_char ttl; /* peer.ttl */ 355 u_short flash2; /* new peer.flash */ 356 associd_t associd; /* association ID */ 357 keyid_t keyid; /* peer.keyid */ 358 u_int32 pkeyid; /* unused */ 359 u_int32 refid; /* peer.refid */ 360 u_int32 timer; /* peer.timer */ 361 s_fp rootdelay; /* peer.distance */ 362 u_fp rootdispersion; /* peer.dispersion */ 363 l_fp reftime; /* peer.reftime */ 364 l_fp org; /* peer.org */ 365 l_fp rec; /* peer.rec */ 366 l_fp xmt; /* peer.xmt */ 367 s_fp filtdelay[NTP_SHIFT]; /* delay shift register */ 368 l_fp filtoffset[NTP_SHIFT]; /* offset shift register */ 369 u_char order[NTP_SHIFT]; /* order of peers from last filter */ 370 s_fp delay; /* peer.estdelay */ 371 u_fp dispersion; /* peer.estdisp */ 372 l_fp offset; /* peer.estoffset */ 373 u_fp selectdisp; /* peer select dispersion */ 374 int32 unused1; /* (obsolete) */ 375 int32 unused2; 376 int32 unused3; 377 int32 unused4; 378 int32 unused5; 379 int32 unused6; 380 int32 unused7; 381 s_fp estbdelay; /* broadcast offset */ 382 }; 383 384 385 /* 386 * Peer statistics structure 387 */ 388 struct info_peer_stats { 389 u_int32 dstadr; /* local address */ 390 u_int32 srcadr; /* remote address */ 391 u_short srcport; /* remote port */ 392 u_short flags; /* peer flags */ 393 u_int32 timereset; /* time counters were reset */ 394 u_int32 timereceived; /* time since a packet received */ 395 u_int32 timetosend; /* time until a packet sent */ 396 u_int32 timereachable; /* time peer has been reachable */ 397 u_int32 sent; /* number sent */ 398 u_int32 unused1; /* (unused) */ 399 u_int32 processed; /* number processed */ 400 u_int32 unused2; /* (unused) */ 401 u_int32 badauth; /* bad authentication */ 402 u_int32 bogusorg; /* bogus origin */ 403 u_int32 oldpkt; /* duplicate */ 404 u_int32 unused3; /* (unused) */ 405 u_int32 unused4; /* (unused) */ 406 u_int32 seldisp; /* bad dispersion */ 407 u_int32 selbroken; /* bad reference time */ 408 u_int32 unused5; /* (unused) */ 409 u_char candidate; /* select order */ 410 u_char unused6; /* (unused) */ 411 u_char unused7; /* (unused) */ 412 u_char unused8; /* (unused) */ 413 }; 414 415 416 /* 417 * Loop filter variables 418 */ 419 struct info_loop { 420 l_fp last_offset; 421 l_fp drift_comp; 422 u_int32 compliance; 423 u_int32 watchdog_timer; 424 }; 425 426 427 /* 428 * System info. Mostly the sys.* variables, plus a few unique to 429 * the implementation. 430 */ 431 struct info_sys { 432 u_int32 peer; /* system peer address */ 433 u_char peer_mode; /* mode we are syncing to peer in */ 434 u_char leap; /* system leap bits */ 435 u_char stratum; /* our stratum */ 436 s_char precision; /* local clock precision */ 437 s_fp rootdelay; /* distance from sync source */ 438 u_fp rootdispersion; /* dispersion from sync source */ 439 u_int32 refid; /* reference ID of sync source */ 440 l_fp reftime; /* system reference time */ 441 u_int32 poll; /* system poll interval */ 442 u_char flags; /* system flags */ 443 u_char unused1; /* unused */ 444 u_char unused2; /* unused */ 445 u_char unused3; /* unused */ 446 s_fp bdelay; /* default broadcast offset */ 447 s_fp frequency; /* frequency residual (scaled ppm) */ 448 l_fp authdelay; /* default authentication delay */ 449 u_fp stability; /* clock stability (scaled ppm) */ 450 }; 451 452 453 /* 454 * System stats. These are collected in the protocol module 455 */ 456 struct info_sys_stats { 457 u_int32 timeup; /* time we have been up and running */ 458 u_int32 timereset; /* time since these were last cleared */ 459 u_int32 badstratum; /* packets claiming an invalid stratum */ 460 u_int32 oldversionpkt; /* old version packets received */ 461 u_int32 newversionpkt; /* new version packets received */ 462 u_int32 unknownversion; /* don't know version packets */ 463 u_int32 badlength; /* packets with bad length */ 464 u_int32 processed; /* packets processed */ 465 u_int32 badauth; /* packets dropped because of authorization */ 466 u_int32 wanderhold; /* (obsolete) */ 467 u_int32 limitrejected; /* rejected because of client limitation */ 468 }; 469 470 471 /* 472 * System stats - old version 473 */ 474 struct old_info_sys_stats { 475 u_int32 timeup; /* time we have been up and running */ 476 u_int32 timereset; /* time since these were last cleared */ 477 u_int32 badstratum; /* packets claiming an invalid stratum */ 478 u_int32 oldversionpkt; /* old version packets received */ 479 u_int32 newversionpkt; /* new version packets received */ 480 u_int32 unknownversion; /* don't know version packets */ 481 u_int32 badlength; /* packets with bad length */ 482 u_int32 processed; /* packets processed */ 483 u_int32 badauth; /* packets dropped because of authorization */ 484 u_int32 wanderhold; 485 }; 486 487 488 /* 489 * Peer memory statistics. Collected in the peer module. 490 */ 491 struct info_mem_stats { 492 u_int32 timereset; /* time since reset */ 493 u_short totalpeermem; 494 u_short freepeermem; 495 u_int32 findpeer_calls; 496 u_int32 allocations; 497 u_int32 demobilizations; 498 u_char hashcount[HASH_SIZE]; 499 }; 500 501 502 /* 503 * I/O statistics. Collected in the I/O module 504 */ 505 struct info_io_stats { 506 u_int32 timereset; /* time since reset */ 507 u_short totalrecvbufs; /* total receive bufs */ 508 u_short freerecvbufs; /* free buffers */ 509 u_short fullrecvbufs; /* full buffers */ 510 u_short lowwater; /* number of times we've added buffers */ 511 u_int32 dropped; /* dropped packets */ 512 u_int32 ignored; /* ignored packets */ 513 u_int32 received; /* received packets */ 514 u_int32 sent; /* packets sent */ 515 u_int32 notsent; /* packets not sent */ 516 u_int32 interrupts; /* interrupts we've handled */ 517 u_int32 int_received; /* received by interrupt handler */ 518 }; 519 520 521 /* 522 * Timer stats. Guess where from. 523 */ 524 struct info_timer_stats { 525 u_int32 timereset; /* time since reset */ 526 u_int32 alarms; /* alarms we've handled */ 527 u_int32 overflows; /* timer overflows */ 528 u_int32 xmtcalls; /* calls to xmit */ 529 }; 530 531 532 /* 533 * Structure for passing peer configuration information 534 */ 535 struct old_conf_peer { 536 u_int32 peeraddr; /* address to poll */ 537 u_char hmode; /* mode, either broadcast, active or client */ 538 u_char version; /* version number to poll with */ 539 u_char minpoll; /* min host poll interval */ 540 u_char maxpoll; /* max host poll interval */ 541 u_char flags; /* flags for this request */ 542 u_char ttl; /* time to live (multicast) or refclock mode */ 543 u_short unused; /* unused */ 544 keyid_t keyid; /* key to use for this association */ 545 }; 546 547 struct conf_peer { 548 u_int32 peeraddr; /* address to poll */ 549 u_char hmode; /* mode, either broadcast, active or client */ 550 u_char version; /* version number to poll with */ 551 u_char minpoll; /* min host poll interval */ 552 u_char maxpoll; /* max host poll interval */ 553 u_char flags; /* flags for this request */ 554 u_char ttl; /* time to live (multicast) or refclock mode */ 555 u_short unused; /* unused */ 556 keyid_t keyid; /* key to use for this association */ 557 char keystr[MAXFILENAME]; /* public key file name*/ 558 }; 559 560 #define CONF_FLAG_AUTHENABLE 0x01 561 #define CONF_FLAG_PREFER 0x02 562 #define CONF_FLAG_BURST 0x04 563 #define CONF_FLAG_IBURST 0x08 564 #define CONF_FLAG_NOSELECT 0x10 565 #define CONF_FLAG_SKEY 0x20 566 567 /* 568 * Structure for passing peer deletion information. Currently 569 * we only pass the address and delete all configured peers with 570 * this addess. 571 */ 572 struct conf_unpeer { 573 u_int32 peeraddr; /* address of peer */ 574 }; 575 576 /* 577 * Structure for carrying system flags. 578 */ 579 struct conf_sys_flags { 580 u_int32 flags; 581 }; 582 583 /* 584 * System flags we can set/clear 585 */ 586 #define SYS_FLAG_BCLIENT 0x01 587 #define SYS_FLAG_PPS 0x02 588 #define SYS_FLAG_NTP 0x04 589 #define SYS_FLAG_KERNEL 0x08 590 #define SYS_FLAG_MONITOR 0x10 591 #define SYS_FLAG_FILEGEN 0x20 592 #define SYS_FLAG_AUTH 0x40 593 #define SYS_FLAG_CAL 0x80 594 595 /* 596 * Structure used for returning restrict entries 597 */ 598 struct info_restrict { 599 u_int32 addr; /* match address */ 600 u_int32 mask; /* match mask */ 601 u_int32 count; /* number of packets matched */ 602 u_short flags; /* restrict flags */ 603 u_short mflags; /* match flags */ 604 }; 605 606 607 /* 608 * Structure used for specifying restrict entries 609 */ 610 struct conf_restrict { 611 u_int32 addr; /* match address */ 612 u_int32 mask; /* match mask */ 613 u_short flags; /* restrict flags */ 614 u_short mflags; /* match flags */ 615 }; 616 617 618 /* 619 * Structure used for returning monitor data 620 */ 621 struct info_monitor_1 { 622 u_int32 lasttime; /* last packet from this host */ 623 u_int32 firsttime; /* first time we received a packet */ 624 u_int32 lastdrop; /* last time we rejected a packet due to client limitation policy */ 625 u_int32 count; /* count of packets received */ 626 u_int32 addr; /* host address */ 627 u_int32 daddr; /* destination host address */ 628 u_int32 flags; /* flags about destination */ 629 u_short port; /* port number of last reception */ 630 u_char mode; /* mode of last packet */ 631 u_char version; /* version number of last packet */ 632 }; 633 634 635 /* 636 * Structure used for returning monitor data 637 */ 638 struct info_monitor { 639 u_int32 lasttime; /* last packet from this host */ 640 u_int32 firsttime; /* first time we received a packet */ 641 u_int32 lastdrop; /* last time we rejected a packet due to client limitation policy */ 642 u_int32 count; /* count of packets received */ 643 u_int32 addr; /* host address */ 644 u_short port; /* port number of last reception */ 645 u_char mode; /* mode of last packet */ 646 u_char version; /* version number of last packet */ 647 }; 648 649 /* 650 * Structure used for returning monitor data (old format 651 */ 652 struct old_info_monitor { 653 u_int32 lasttime; /* last packet from this host */ 654 u_int32 firsttime; /* first time we received a packet */ 655 u_int32 count; /* count of packets received */ 656 u_int32 addr; /* host address */ 657 u_short port; /* port number of last reception */ 658 u_char mode; /* mode of last packet */ 659 u_char version; /* version number of last packet */ 660 }; 661 662 /* 663 * Structure used for passing indication of flags to clear 664 */ 665 struct reset_flags { 666 u_int32 flags; 667 }; 668 669 #define RESET_FLAG_ALLPEERS 0x01 670 #define RESET_FLAG_IO 0x02 671 #define RESET_FLAG_SYS 0x04 672 #define RESET_FLAG_MEM 0x08 673 #define RESET_FLAG_TIMER 0x10 674 #define RESET_FLAG_AUTH 0x20 675 #define RESET_FLAG_CTL 0x40 676 677 #define RESET_ALLFLAGS \ 678 (RESET_FLAG_ALLPEERS|RESET_FLAG_IO|RESET_FLAG_SYS \ 679 |RESET_FLAG_MEM|RESET_FLAG_TIMER|RESET_FLAG_AUTH|RESET_FLAG_CTL) 680 681 /* 682 * Structure used to return information concerning the authentication 683 * module. 684 */ 685 struct info_auth { 686 u_int32 timereset; /* time counters were reset */ 687 u_int32 numkeys; /* number of keys we know */ 688 u_int32 numfreekeys; /* number of free keys */ 689 u_int32 keylookups; /* calls to authhavekey() */ 690 u_int32 keynotfound; /* requested key unknown */ 691 u_int32 encryptions; /* number of encryptions */ 692 u_int32 decryptions; /* number of decryptions */ 693 u_int32 expired; /* number of expired keys */ 694 u_int32 keyuncached; /* calls to encrypt/decrypt with uncached key */ 695 }; 696 697 698 /* 699 * Structure used to pass trap information to the client 700 */ 701 struct info_trap { 702 u_int32 local_address; /* local interface address */ 703 u_int32 trap_address; /* remote client's address */ 704 u_short trap_port; /* remote port number */ 705 u_short sequence; /* sequence number */ 706 u_int32 settime; /* time trap last set */ 707 u_int32 origtime; /* time trap originally set */ 708 u_int32 resets; /* number of resets on this trap */ 709 u_int32 flags; /* trap flags, as defined in ntp_control.h */ 710 }; 711 712 /* 713 * Structure used to pass add/clear trap information to the client 714 */ 715 struct conf_trap { 716 u_int32 local_address; /* local interface address */ 717 u_int32 trap_address; /* remote client's address */ 718 u_short trap_port; /* remote client's port */ 719 u_short unused; /* (unused) */ 720 }; 721 722 723 /* 724 * Structure used to return statistics from the control module 725 */ 726 struct info_control { 727 u_int32 ctltimereset; 728 u_int32 numctlreq; /* number of requests we've received */ 729 u_int32 numctlbadpkts; /* number of bad control packets */ 730 u_int32 numctlresponses; /* # resp packets sent */ 731 u_int32 numctlfrags; /* # of fragments sent */ 732 u_int32 numctlerrors; /* number of error responses sent */ 733 u_int32 numctltooshort; /* number of too short input packets */ 734 u_int32 numctlinputresp; /* number of responses on input */ 735 u_int32 numctlinputfrag; /* number of fragments on input */ 736 u_int32 numctlinputerr; /* # input pkts with err bit set */ 737 u_int32 numctlbadoffset; /* # input pkts with nonzero offset */ 738 u_int32 numctlbadversion; /* # input pkts with unknown version */ 739 u_int32 numctldatatooshort; /* data too short for count */ 740 u_int32 numctlbadop; /* bad op code found in packet */ 741 u_int32 numasyncmsgs; /* # async messages we've sent */ 742 }; 743 744 745 /* 746 * Structure used to return clock information 747 */ 748 struct info_clock { 749 u_int32 clockadr; 750 u_char type; 751 u_char flags; 752 u_char lastevent; 753 u_char currentstatus; 754 u_int32 polls; 755 u_int32 noresponse; 756 u_int32 badformat; 757 u_int32 baddata; 758 u_int32 timestarted; 759 l_fp fudgetime1; 760 l_fp fudgetime2; 761 int32 fudgeval1; 762 int32 fudgeval2; 763 }; 764 765 766 /* 767 * Structure used for setting clock fudge factors 768 */ 769 struct conf_fudge { 770 u_int32 clockadr; 771 u_int32 which; 772 l_fp fudgetime; 773 int32 fudgeval_flags; 774 }; 775 776 #define FUDGE_TIME1 1 777 #define FUDGE_TIME2 2 778 #define FUDGE_VAL1 3 779 #define FUDGE_VAL2 4 780 #define FUDGE_FLAGS 5 781 782 783 /* 784 * Structure used for returning clock debugging info 785 */ 786 #define NUMCBUGVALUES 16 787 #define NUMCBUGTIMES 32 788 789 struct info_clkbug { 790 u_int32 clockadr; 791 u_char nvalues; 792 u_char ntimes; 793 u_short svalues; 794 u_int32 stimes; 795 u_int32 values[NUMCBUGVALUES]; 796 l_fp times[NUMCBUGTIMES]; 797 }; 798 799 /* 800 * Structure used for returning kernel pll/PPS information 801 */ 802 struct info_kernel { 803 int32 offset; 804 int32 freq; 805 int32 maxerror; 806 int32 esterror; 807 u_short status; 808 u_short shift; 809 int32 constant; 810 int32 precision; 811 int32 tolerance; 812 813 /* 814 * Variables used only if PPS signal discipline is implemented 815 */ 816 int32 ppsfreq; 817 int32 jitter; 818 int32 stabil; 819 int32 jitcnt; 820 int32 calcnt; 821 int32 errcnt; 822 int32 stbcnt; 823 }; 824 825 /* 826 * Info returned with IP -> hostname lookup 827 */ 828 /* 144 might need to become 32, matching data[] member of req_pkt */ 829 #define NTP_MAXHOSTNAME (32 - sizeof(u_int32) - sizeof(u_short)) 830 struct info_dns_assoc { 831 u_int32 peeraddr; /* peer address (HMS: being careful...) */ 832 associd_t associd; /* association ID */ 833 char hostname[NTP_MAXHOSTNAME]; /* hostname */ 834 }; 835