contrib/ntp/include/ntp_request.h

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