dist/ntp/include/ntp_control.h

   1 /*      $NetBSD: ntp_control.h,v 1.2 2003/12/04 16:23:36 drochner Exp $ */
   2
   3 /*
   4  * ntp_control.h - definitions related to NTP mode 6 control messages
   5  */
   6
   7 #include "ntp_types.h"
   8
   9 struct ntp_control {
  10         u_char li_vn_mode;              /* leap, version, mode */
  11         u_char r_m_e_op;                /* response, more, error, opcode */
  12         u_short sequence;               /* sequence number of request */
  13         u_short status;                 /* status word for association */
  14         associd_t associd;              /* association ID */
  15         u_short offset;                 /* offset of this batch of data */
  16         u_short count;                  /* count of data in this packet */
  17         u_char data[(480 + MAX_MAC_LEN)]; /* data + auth */
  18 };
  19
  20 /*
  21  * Length of the control header, in octets
  22  */
  23 #define CTL_HEADER_LEN          12
  24 #define CTL_MAX_DATA_LEN        468
  25
  26
  27 /*
  28  * Limits and things
  29  */
  30 #define CTL_MAXTRAPS    3               /* maximum number of traps we allow */
  31 #define CTL_TRAPTIME    (60*60)         /* time out traps in 1 hour */
  32 #define CTL_MAXAUTHSIZE 64              /* maximum size of an authen'ed req */
  33
  34 /*
  35  * Decoding for the r_m_e_op field
  36  */
  37 #define CTL_RESPONSE    0x80
  38 #define CTL_ERROR       0x40
  39 #define CTL_MORE        0x20
  40 #define CTL_OP_MASK     0x1f
  41
  42 #define CTL_ISRESPONSE(r_m_e_op)        (((r_m_e_op) & 0x80) != 0)
  43 #define CTL_ISMORE(r_m_e_op)    (((r_m_e_op) & 0x20) != 0)
  44 #define CTL_ISERROR(r_m_e_op)   (((r_m_e_op) & 0x40) != 0)
  45 #define CTL_OP(r_m_e_op)        ((r_m_e_op) & CTL_OP_MASK)
  46
  47 /*
  48  * Opcodes
  49  */
  50 #define CTL_OP_UNSPEC           0
  51 #define CTL_OP_READSTAT         1
  52 #define CTL_OP_READVAR          2
  53 #define CTL_OP_WRITEVAR         3
  54 #define CTL_OP_READCLOCK        4
  55 #define CTL_OP_WRITECLOCK       5
  56 #define CTL_OP_SETTRAP          6
  57 #define CTL_OP_ASYNCMSG         7
  58 #define CTL_OP_UNSETTRAP        31
  59
  60 /*
  61  * {En,De}coding of the system status word
  62  */
  63 #define CTL_SST_TS_UNSPEC       0       /* time source unspecified */
  64 #define CTL_SST_TS_ATOM         1       /* time source calibrated atomic */
  65 #define CTL_SST_TS_LF           2       /* time source VLF or LF radio */
  66 #define CTL_SST_TS_HF           3       /* time source HF radio */
  67 #define CTL_SST_TS_UHF          4       /* time source UHF radio */
  68 #define CTL_SST_TS_LOCAL        5       /* time source LOCAL */
  69 #define CTL_SST_TS_NTP          6       /* time source NTP */
  70 #define CTL_SST_TS_UDPTIME      7       /* time source UDP/TIME */
  71 #define CTL_SST_TS_WRSTWTCH     8       /* time source is wristwatch */
  72 #define CTL_SST_TS_TELEPHONE    9       /* time source is telephone modem */
  73 #define CTL_SST_TS_PPS          0x20    /* time source is PPS signal */
  74
  75 #define CTL_SYS_MAXEVENTS       15
  76
  77 #define CTL_SYS_STATUS(li, source, nevnt, evnt) \
  78                 (((((unsigned short)(li))<< 14)&0xc000) | \
  79                 (((source)<<8)&0x3f00) | \
  80                 (((nevnt)<<4)&0x00f0) | \
  81                 ((evnt)&0x000f))
  82
  83 #define CTL_SYS_LI(status)      (((status)>>14) & 0x3)
  84 #define CTL_SYS_SOURCE(status)  (((status)>>8) & 0x3f)
  85 #define CTL_SYS_NEVNT(status)   (((status)>>4) & 0xf)
  86 #define CTL_SYS_EVENT(status)   ((status) & 0xf)
  87
  88 /*
  89  * {En,De}coding of the peer status word
  90  */
  91 #define CTL_PST_CONFIG          0x80
  92 #define CTL_PST_AUTHENABLE      0x40
  93 #define CTL_PST_AUTHENTIC       0x20
  94 #define CTL_PST_REACH           0x10
  95 #define CTL_PST_UNSPEC          0x08
  96
  97 #define CTL_PST_SEL_REJECT      0       /*   reject */
  98 #define CTL_PST_SEL_SANE        1       /* x falsetick */
  99 #define CTL_PST_SEL_CORRECT     2       /* . excess */
 100 #define CTL_PST_SEL_SELCAND     3       /* - outlyer */
 101 #define CTL_PST_SEL_SYNCCAND    4       /* + candidat */
 102 #define CTL_PST_SEL_DISTSYSPEER 5       /* # selected */
 103 #define CTL_PST_SEL_SYSPEER     6       /* * sys.peer */
 104 #define CTL_PST_SEL_PPS         7       /* o pps.peer */
 105
 106 #define CTL_PEER_MAXEVENTS      15
 107
 108 #define CTL_PEER_STATUS(status, nevnt, evnt) \
 109                 ((((status)<<8) & 0xff00) | \
 110                 (((nevnt)<<4) & 0x00f0) | \
 111                 ((evnt) & 0x000f))
 112
 113 #define CTL_PEER_STATVAL(status)(((status)>>8) & 0xff)
 114 #define CTL_PEER_NEVNT(status)  (((status)>>4) & 0xf)
 115 #define CTL_PEER_EVENT(status)  ((status) & 0xf)
 116
 117 /*
 118  * {En,De}coding of the clock status word
 119  */
 120 #define CTL_CLK_OKAY            0
 121 #define CTL_CLK_NOREPLY         1
 122 #define CTL_CLK_BADFORMAT       2
 123 #define CTL_CLK_FAULT           3
 124 #define CTL_CLK_PROPAGATION     4
 125 #define CTL_CLK_BADDATE         5
 126 #define CTL_CLK_BADTIME         6
 127
 128 #define CTL_CLK_STATUS(status, event) \
 129                 ((((status)<<8) & 0xff00) | \
 130                 ((event) & 0x00ff))
 131
 132 /*
 133  * Error code responses returned when the E bit is set.
 134  */
 135 #define CERR_UNSPEC     0
 136 #define CERR_PERMISSION 1
 137 #define CERR_BADFMT     2
 138 #define CERR_BADOP      3
 139 #define CERR_BADASSOC   4
 140 #define CERR_UNKNOWNVAR 5
 141 #define CERR_BADVALUE   6
 142 #define CERR_RESTRICT   7
 143
 144 #define CERR_NORESOURCE CERR_PERMISSION /* wish there was a different code */
 145
 146
 147 /*
 148  * System variables we understand
 149  */
 150 #define CS_LEAP         1
 151 #define CS_STRATUM      2
 152 #define CS_PRECISION    3
 153 #define CS_ROOTDELAY    4
 154 #define CS_ROOTDISPERSION       5
 155 #define CS_REFID        6
 156 #define CS_REFTIME      7
 157 #define CS_POLL         8
 158 #define CS_PEERID       9
 159 #define CS_STATE        10
 160 #define CS_OFFSET       11
 161 #define CS_DRIFT        12
 162 #define CS_JITTER       13
 163 #define CS_ERROR        14
 164 #define CS_CLOCK        15
 165 #define CS_PROCESSOR    16
 166 #define CS_SYSTEM       17
 167 #define CS_VERSION      18
 168 #define CS_STABIL       19
 169 #define CS_VARLIST      20
 170 #ifdef OPENSSL
 171 #define CS_FLAGS        21
 172 #define CS_HOST         22
 173 #define CS_PUBLIC       23
 174 #define CS_CERTIF       24
 175 #define CS_REVTIME      25
 176 #define CS_LEAPTAB      26
 177 #define CS_TAI          27
 178 #define CS_DIGEST       28
 179 #define CS_IDENT        29
 180 #define CS_REVOKE       30
 181 #define CS_MAXCODE      CS_REVOKE
 182 #else
 183 #define CS_MAXCODE      CS_VARLIST
 184 #endif /* OPENSSL */
 185
 186 /*
 187  * Peer variables we understand
 188  */
 189 #define CP_CONFIG       1
 190 #define CP_AUTHENABLE   2
 191 #define CP_AUTHENTIC    3
 192 #define CP_SRCADR       4
 193 #define CP_SRCPORT      5
 194 #define CP_DSTADR       6
 195 #define CP_DSTPORT      7
 196 #define CP_LEAP         8
 197 #define CP_HMODE        9
 198 #define CP_STRATUM      10
 199 #define CP_PPOLL        11
 200 #define CP_HPOLL        12
 201 #define CP_PRECISION    13
 202 #define CP_ROOTDELAY    14
 203 #define CP_ROOTDISPERSION       15
 204 #define CP_REFID        16
 205 #define CP_REFTIME      17
 206 #define CP_ORG          18
 207 #define CP_REC          19
 208 #define CP_XMT          20
 209 #define CP_REACH        21
 210 #define CP_UNREACH      22
 211 #define CP_TIMER        23
 212 #define CP_DELAY        24
 213 #define CP_OFFSET       25
 214 #define CP_JITTER       26
 215 #define CP_DISPERSION   27
 216 #define CP_KEYID        28
 217 #define CP_FILTDELAY    29
 218 #define CP_FILTOFFSET   30
 219 #define CP_PMODE        31
 220 #define CP_RECEIVED     32
 221 #define CP_SENT         33
 222 #define CP_FILTERROR    34
 223 #define CP_FLASH        35
 224 #define CP_TTL          36
 225 #define CP_VARLIST      37
 226 #ifdef OPENSSL
 227 #define CP_FLAGS        38
 228 #define CP_HOST         39
 229 #define CP_VALID        40
 230 #define CP_INITSEQ      41
 231 #define CP_INITKEY      42
 232 #define CP_INITTSP      43
 233 #define CP_DIGEST       44
 234 #define CP_IDENT        45
 235 #define CP_MAXCODE      CP_IDENT
 236 #else
 237 #define CP_MAXCODE      CP_VARLIST
 238 #endif /* OPENSSL */
 239
 240 /*
 241  * Clock variables we understand
 242  */
 243 #define CC_TYPE         1
 244 #define CC_TIMECODE     2
 245 #define CC_POLL         3
 246 #define CC_NOREPLY      4
 247 #define CC_BADFORMAT    5
 248 #define CC_BADDATA      6
 249 #define CC_FUDGETIME1   7
 250 #define CC_FUDGETIME2   8
 251 #define CC_FUDGEVAL1    9
 252 #define CC_FUDGEVAL2    10
 253 #define CC_FLAGS        11
 254 #define CC_DEVICE       12
 255 #define CC_VARLIST      13
 256
 257 #define CC_MAXCODE      CC_VARLIST
 258
 259 /*
 260  * Definition of the structure used internally to hold trap information.
 261  * ntp_request.c wants to see this.
 262  */
 263 struct ctl_trap {
 264         struct sockaddr_storage tr_addr;/* address of trap recipient */
 265         struct interface *tr_localaddr; /* interface to send this through */
 266         u_long tr_settime;              /* time trap was set */
 267         u_long tr_count;                /* async messages sent to this guy */
 268         u_long tr_origtime;             /* time trap was originally set */
 269         u_long tr_resets;               /* count of resets for this trap */
 270         u_short tr_sequence;            /* trap sequence id */
 271         u_char tr_flags;                /* trap flags */
 272         u_char tr_version;              /* version number of trapper */
 273 };
 274 extern struct ctl_trap ctl_trap[];
 275
 276 /*
 277  * Flag bits
 278  */
 279 #define TRAP_INUSE      0x1             /* this trap is active */
 280 #define TRAP_NONPRIO    0x2             /* this trap is non-priority */
 281 #define TRAP_CONFIGURED 0x4             /* this trap was configured */
 282
 283 /*
 284  * Types of things we may deal with
 285  * shared between ntpq and library
 286  */
 287 #define TYPE_SYS        1
 288 #define TYPE_PEER       2
 289 #define TYPE_CLOCK      3