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