candm.h

   1 /*
   2   chronyd/chronyc - Programs for keeping computer clocks accurate.
   3
   4  **********************************************************************
   5  * Copyright (C) Richard P. Curnow  1997-2003
   6  *
   7  * This program is free software; you can redistribute it and/or modify
   8  * it under the terms of version 2 of the GNU General Public License as
   9  * published by the Free Software Foundation.
  10  *
  11  * This program is distributed in the hope that it will be useful, but
  12  * WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14  * General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public License along
  17  * with this program; if not, write to the Free Software Foundation, Inc.,
  18  * 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
  19  *
  20  **********************************************************************
  21
  22   =======================================================================
  23
  24   Definitions for the network protocol used for command and monitoring
  25   of the timeserver.
  26
  27   */
  28
  29 #ifndef GOT_CANDM_H
  30 #define GOT_CANDM_H
  31
  32 #include "sysincl.h"
  33 #include "addressing.h"
  34
  35 /* This is the default port to use for CANDM, if no alternative is
  36    defined */
  37 #define DEFAULT_CANDM_PORT 323
  38
  39 /* Request codes */
  40 #define REQ_NULL 0
  41 #define REQ_ONLINE 1
  42 #define REQ_OFFLINE 2
  43 #define REQ_BURST 3
  44 #define REQ_MODIFY_MINPOLL 4
  45 #define REQ_MODIFY_MAXPOLL 5
  46 #define REQ_DUMP 6
  47 #define REQ_MODIFY_MAXDELAY 7
  48 #define REQ_MODIFY_MAXDELAYRATIO 8
  49 #define REQ_MODIFY_MAXUPDATESKEW 9
  50 #define REQ_LOGON 10
  51 #define REQ_SETTIME 11
  52 #define REQ_LOCAL 12
  53 #define REQ_MANUAL 13
  54 #define REQ_N_SOURCES 14
  55 #define REQ_SOURCE_DATA 15
  56 #define REQ_REKEY 16
  57 #define REQ_ALLOW 17
  58 #define REQ_ALLOWALL 18
  59 #define REQ_DENY 19
  60 #define REQ_DENYALL 20
  61 #define REQ_CMDALLOW 21
  62 #define REQ_CMDALLOWALL 22
  63 #define REQ_CMDDENY 23
  64 #define REQ_CMDDENYALL 24
  65 #define REQ_ACCHECK 25
  66 #define REQ_CMDACCHECK 26
  67 #define REQ_ADD_SERVER 27
  68 #define REQ_ADD_PEER 28
  69 #define REQ_DEL_SOURCE 29
  70 #define REQ_WRITERTC 30
  71 #define REQ_DFREQ 31
  72 #define REQ_DOFFSET 32
  73 #define REQ_TRACKING 33
  74 #define REQ_SOURCESTATS 34
  75 #define REQ_RTCREPORT 35
  76 #define REQ_TRIMRTC 36
  77 #define REQ_CYCLELOGS 37
  78 #define REQ_SUBNETS_ACCESSED 38
  79 #define REQ_CLIENT_ACCESSES 39
  80 #define REQ_CLIENT_ACCESSES_BY_INDEX 40
  81 #define REQ_MANUAL_LIST 41
  82 #define REQ_MANUAL_DELETE 42
  83 #define REQ_MAKESTEP 43
  84 #define REQ_ACTIVITY 44
  85 #define REQ_MODIFY_MINSTRATUM 45
  86 #define REQ_MODIFY_POLLTARGET 46
  87 #define REQ_MODIFY_MAXDELAYDEVRATIO 47
  88 #define REQ_RESELECT 48
  89 #define REQ_RESELECTDISTANCE 49
  90 #define REQ_MODIFY_MAKESTEP 50
  91 #define REQ_SMOOTHING 51
  92 #define REQ_SMOOTHTIME 52
  93 #define N_REQUEST_TYPES 53
  94
  95 /* Special utoken value used to log on with first exchange being the
  96    password.  (This time value has long since gone by) */
  97 #define SPECIAL_UTOKEN 0x10101010
  98
  99 /* Structure used to exchange timevals independent on size of time_t */
 100 typedef struct {
 101   uint32_t tv_sec_high;
 102   uint32_t tv_sec_low;
 103   uint32_t tv_nsec;
 104 } Timeval;
 105
 106 /* This is used in tv_sec_high for 32-bit timestamps */
 107 #define TV_NOHIGHSEC 0x7fffffff
 108
 109 /* 32-bit floating-point format consisting of 7-bit signed exponent
 110    and 25-bit signed coefficient without hidden bit.
 111    The result is calculated as: 2^(exp - 25) * coef */
 112 typedef struct {
 113   int32_t f;
 114 } Float;
 115
 116 /* The EOR (end of record) fields are used by the offsetof operator in
 117    pktlength.c, to get the number of bytes that ought to be
 118    transmitted for each packet type. */
 119
 120 typedef struct {
 121   int32_t EOR;
 122 } REQ_Null;
 123
 124 typedef struct {
 125   IPAddr mask;
 126   IPAddr address;
 127   int32_t EOR;
 128 } REQ_Online;
 129
 130 typedef struct {
 131   IPAddr mask;
 132   IPAddr address;
 133   int32_t EOR;
 134 } REQ_Offline;
 135
 136 typedef struct {
 137   IPAddr mask;
 138   IPAddr address;
 139   int32_t n_good_samples;
 140   int32_t n_total_samples;
 141   int32_t EOR;
 142 } REQ_Burst;
 143
 144 typedef struct {
 145   IPAddr address;
 146   int32_t new_minpoll;
 147   int32_t EOR;
 148 } REQ_Modify_Minpoll;
 149
 150 typedef struct {
 151   IPAddr address;
 152   int32_t new_maxpoll;
 153   int32_t EOR;
 154 } REQ_Modify_Maxpoll;
 155
 156 typedef struct {
 157   int32_t pad;
 158   int32_t EOR;
 159 } REQ_Dump;
 160
 161 typedef struct {
 162   IPAddr address;
 163   Float new_max_delay;
 164   int32_t EOR;
 165 } REQ_Modify_Maxdelay;
 166
 167 typedef struct {
 168   IPAddr address;
 169   Float new_max_delay_ratio;
 170   int32_t EOR;
 171 } REQ_Modify_Maxdelayratio;
 172
 173 typedef struct {
 174   IPAddr address;
 175   Float new_max_delay_dev_ratio;
 176   int32_t EOR;
 177 } REQ_Modify_Maxdelaydevratio;
 178
 179 typedef struct {
 180   IPAddr address;
 181   int32_t new_min_stratum;
 182   int32_t EOR;
 183 } REQ_Modify_Minstratum;
 184
 185 typedef struct {
 186   IPAddr address;
 187   int32_t new_poll_target;
 188   int32_t EOR;
 189 } REQ_Modify_Polltarget;
 190
 191 typedef struct {
 192   Float new_max_update_skew;
 193   int32_t EOR;
 194 } REQ_Modify_Maxupdateskew;
 195
 196 typedef struct {
 197   int32_t limit;
 198   Float threshold;
 199   int32_t EOR;
 200 } REQ_Modify_Makestep;
 201
 202 typedef struct {
 203   Timeval ts;
 204   int32_t EOR;
 205 } REQ_Logon;
 206
 207 typedef struct {
 208   Timeval ts;
 209   int32_t EOR;
 210 } REQ_Settime;
 211
 212 typedef struct {
 213   int32_t on_off;
 214   int32_t stratum;
 215   int32_t EOR;
 216 } REQ_Local;
 217
 218 typedef struct {
 219   int32_t option;
 220   int32_t EOR;
 221 } REQ_Manual;
 222
 223 typedef struct {
 224   int32_t index;
 225   int32_t EOR;
 226 } REQ_Source_Data;
 227
 228 typedef struct {
 229   IPAddr ip;
 230   int32_t subnet_bits;
 231   int32_t EOR;
 232 } REQ_Allow_Deny;
 233
 234 typedef struct {
 235   IPAddr ip;
 236   int32_t EOR;
 237 } REQ_Ac_Check;
 238
 239 /* Flags used in NTP source requests */
 240 #define REQ_ADDSRC_ONLINE 0x1
 241 #define REQ_ADDSRC_AUTOOFFLINE 0x2
 242 #define REQ_ADDSRC_IBURST 0x4
 243 #define REQ_ADDSRC_PREFER 0x8
 244 #define REQ_ADDSRC_NOSELECT 0x10
 245
 246 typedef struct {
 247   IPAddr ip_addr;
 248   uint32_t port;
 249   int32_t minpoll;
 250   int32_t maxpoll;
 251   int32_t presend_minpoll;
 252   uint32_t authkey;
 253   Float max_delay;
 254   Float max_delay_ratio;
 255   uint32_t flags;
 256   int32_t EOR;
 257 } REQ_NTP_Source;
 258
 259 typedef struct {
 260   IPAddr ip_addr;
 261   int32_t EOR;
 262 } REQ_Del_Source;
 263
 264 typedef struct {
 265   Float dfreq;
 266   int32_t EOR;
 267 } REQ_Dfreq;
 268
 269 typedef struct {
 270   int32_t sec;
 271   int32_t usec;
 272   int32_t EOR;
 273 } REQ_Doffset;
 274
 275 typedef struct {
 276   uint32_t index;
 277   int32_t EOR;
 278 } REQ_Sourcestats;
 279
 280 /* This is based on the response size rather than the
 281    request size */
 282 #define MAX_CLIENT_ACCESSES 8
 283
 284 typedef struct {
 285   uint32_t first_index;
 286   uint32_t n_indices;
 287   int32_t EOR;
 288 } REQ_ClientAccessesByIndex;
 289
 290 typedef struct {
 291   int32_t index;
 292   int32_t EOR;
 293 } REQ_ManualDelete;
 294
 295 typedef struct {
 296   Float distance;
 297   int32_t EOR;
 298 } REQ_ReselectDistance;
 299
 300 #define REQ_SMOOTHTIME_RESET 0
 301 #define REQ_SMOOTHTIME_ACTIVATE 1
 302
 303 typedef struct {
 304   int32_t option;
 305   int32_t EOR;
 306 } REQ_SmoothTime;
 307
 308 /* ================================================== */
 309
 310 #define PKT_TYPE_CMD_REQUEST 1
 311 #define PKT_TYPE_CMD_REPLY 2
 312
 313 /* This version number needs to be incremented whenever the packet
 314    size and/or the format of any of the existing messages is changed.
 315    Other changes, e.g. new command types, should be handled cleanly by
 316    client.c and cmdmon.c anyway, so the version can stay the same.
 317
 318    Version 1 : original version with fixed size packets
 319
 320    Version 2 : both command and reply packet sizes made capable of
 321    being variable length.
 322
 323    Version 3 : NTP_Source message lengthened (auto_offline)
 324
 325    Version 4 : IPv6 addressing added, 64-bit time values, sourcestats
 326    and tracking reports extended, added flags to NTP source request,
 327    trimmed source report, replaced fixed-point format with floating-point
 328    and used also instead of integer microseconds, new commands: modify stratum,
 329    modify polltarget, modify maxdelaydevratio, reselect, reselectdistance
 330
 331    Version 5 : auth data moved to the end of the packet to allow hashes with
 332    different sizes, extended sources, tracking and activity reports, dropped
 333    subnets accessed and client accesses
 334
 335    Version 6 : added padding to requests to prevent amplification attack,
 336    changed maximum number of samples in manual list to 16, new commands: modify
 337    makestep, smoothing report, smoothtime command
 338
 339    Authentication was removed later in version 6.
 340  */
 341
 342 #define PROTO_VERSION_NUMBER 6
 343
 344 /* The oldest protocol versions that are compatible enough with the current
 345    version to report a version mismatch for the server and the client */
 346 #define PROTO_VERSION_MISMATCH_COMPAT_SERVER 5
 347 #define PROTO_VERSION_MISMATCH_COMPAT_CLIENT 4
 348
 349 /* The first protocol version using padding in requests */
 350 #define PROTO_VERSION_PADDING 6
 351
 352 /* The maximum length of padding in request packet, currently
 353    defined by CLIENT_ACCESSES_BY_INDEX and MANUAL_LIST */
 354 #define MAX_PADDING_LENGTH 396
 355
 356 /* ================================================== */
 357
 358 typedef struct {
 359   uint8_t version; /* Protocol version */
 360   uint8_t pkt_type; /* What sort of packet this is */
 361   uint8_t res1;
 362   uint8_t res2;
 363   uint16_t command; /* Which command is being issued */
 364   uint16_t attempt; /* How many resends the client has done
 365                              (count up from zero for same sequence
 366                              number) */
 367   uint32_t sequence; /* Client's sequence number */
 368   uint32_t pad1;
 369   uint32_t pad2;
 370
 371   union {
 372     REQ_Null null;
 373     REQ_Online online;
 374     REQ_Offline offline;
 375     REQ_Burst burst;
 376     REQ_Modify_Minpoll modify_minpoll;
 377     REQ_Modify_Maxpoll modify_maxpoll;
 378     REQ_Dump dump;
 379     REQ_Modify_Maxdelay modify_maxdelay;
 380     REQ_Modify_Maxdelayratio modify_maxdelayratio;
 381     REQ_Modify_Maxdelaydevratio modify_maxdelaydevratio;
 382     REQ_Modify_Minstratum modify_minstratum;
 383     REQ_Modify_Polltarget modify_polltarget;
 384     REQ_Modify_Maxupdateskew modify_maxupdateskew;
 385     REQ_Modify_Makestep modify_makestep;
 386     REQ_Logon logon;
 387     REQ_Settime settime;
 388     REQ_Local local;
 389     REQ_Manual manual;
 390     REQ_Source_Data source_data;
 391     REQ_Allow_Deny allow_deny;
 392     REQ_Ac_Check ac_check;
 393     REQ_NTP_Source ntp_source;
 394     REQ_Del_Source del_source;
 395     REQ_Dfreq dfreq;
 396     REQ_Doffset doffset;
 397     REQ_Sourcestats sourcestats;
 398     REQ_ClientAccessesByIndex client_accesses_by_index;
 399     REQ_ManualDelete manual_delete;
 400     REQ_ReselectDistance reselect_distance;
 401     REQ_SmoothTime smoothtime;
 402   } data; /* Command specific parameters */
 403
 404   /* Padding used to prevent traffic amplification.  It only defines the
 405      maximum size of the packet, there is no hole after the data field. */
 406   uint8_t padding[MAX_PADDING_LENGTH];
 407
 408 } CMD_Request;
 409
 410 /* ================================================== */
 411 /* Authority codes for command types */
 412
 413 #define PERMIT_OPEN 0
 414 #define PERMIT_LOCAL 1
 415 #define PERMIT_AUTH 2
 416
 417 /* ================================================== */
 418
 419 /* Reply codes */
 420 #define RPY_NULL 1
 421 #define RPY_N_SOURCES 2
 422 #define RPY_SOURCE_DATA 3
 423 #define RPY_MANUAL_TIMESTAMP 4
 424 #define RPY_TRACKING 5
 425 #define RPY_SOURCESTATS 6
 426 #define RPY_RTC 7
 427 #define RPY_SUBNETS_ACCESSED 8
 428 #define RPY_CLIENT_ACCESSES 9
 429 #define RPY_CLIENT_ACCESSES_BY_INDEX 10
 430 #define RPY_MANUAL_LIST 11
 431 #define RPY_ACTIVITY 12
 432 #define RPY_SMOOTHING 13
 433 #define N_REPLY_TYPES 14
 434
 435 /* Status codes */
 436 #define STT_SUCCESS 0
 437 #define STT_FAILED 1
 438 #define STT_UNAUTH 2
 439 #define STT_INVALID 3
 440 #define STT_NOSUCHSOURCE 4
 441 #define STT_INVALIDTS 5
 442 #define STT_NOTENABLED 6
 443 #define STT_BADSUBNET 7
 444 #define STT_ACCESSALLOWED 8
 445 #define STT_ACCESSDENIED 9
 446 /* Deprecated */
 447 #define STT_NOHOSTACCESS 10
 448 #define STT_SOURCEALREADYKNOWN 11
 449 #define STT_TOOMANYSOURCES 12
 450 #define STT_NORTC 13
 451 #define STT_BADRTCFILE 14
 452 #define STT_INACTIVE 15
 453 #define STT_BADSAMPLE 16
 454 #define STT_INVALIDAF 17
 455 #define STT_BADPKTVERSION 18
 456 #define STT_BADPKTLENGTH 19
 457
 458 typedef struct {
 459   int32_t EOR;
 460 } RPY_Null;
 461
 462 typedef struct {
 463   uint32_t n_sources;
 464   int32_t EOR;
 465 } RPY_N_Sources;
 466
 467 #define RPY_SD_MD_CLIENT 0
 468 #define RPY_SD_MD_PEER   1
 469 #define RPY_SD_MD_REF    2
 470
 471 #define RPY_SD_ST_SYNC 0
 472 #define RPY_SD_ST_UNREACH 1
 473 #define RPY_SD_ST_FALSETICKER 2
 474 #define RPY_SD_ST_JITTERY 3
 475 #define RPY_SD_ST_CANDIDATE 4
 476 #define RPY_SD_ST_OUTLIER 5
 477
 478 #define RPY_SD_FLAG_NOSELECT 0x1
 479 #define RPY_SD_FLAG_PREFER 0x2
 480
 481 typedef struct {
 482   IPAddr ip_addr;
 483   int16_t poll;
 484   uint16_t stratum;
 485   uint16_t state;
 486   uint16_t mode;
 487   uint16_t flags;
 488   uint16_t reachability;
 489   uint32_t  since_sample;
 490   Float orig_latest_meas;
 491   Float latest_meas;
 492   Float latest_meas_err;
 493   int32_t EOR;
 494 } RPY_Source_Data;
 495
 496 typedef struct {
 497   uint32_t ref_id;
 498   IPAddr ip_addr;
 499   uint16_t stratum;
 500   uint16_t leap_status;
 501   Timeval ref_time;
 502   Float current_correction;
 503   Float last_offset;
 504   Float rms_offset;
 505   Float freq_ppm;
 506   Float resid_freq_ppm;
 507   Float skew_ppm;
 508   Float root_delay;
 509   Float root_dispersion;
 510   Float last_update_interval;
 511   int32_t EOR;
 512 } RPY_Tracking;
 513
 514 typedef struct {
 515   uint32_t ref_id;
 516   IPAddr ip_addr;
 517   uint32_t n_samples;
 518   uint32_t n_runs;
 519   uint32_t span_seconds;
 520   Float sd;
 521   Float resid_freq_ppm;
 522   Float skew_ppm;
 523   Float est_offset;
 524   Float est_offset_err;
 525   int32_t EOR;
 526 } RPY_Sourcestats;
 527
 528 typedef struct {
 529   Timeval ref_time;
 530   uint16_t n_samples;
 531   uint16_t n_runs;
 532   uint32_t span_seconds;
 533   Float rtc_seconds_fast;
 534   Float rtc_gain_rate_ppm;
 535   int32_t EOR;
 536 } RPY_Rtc;
 537
 538 typedef struct {
 539   uint32_t centiseconds;
 540   Float dfreq_ppm;
 541   Float new_afreq_ppm;
 542   int32_t EOR;
 543 } RPY_ManualTimestamp;
 544
 545 typedef struct {
 546   IPAddr ip;
 547   uint32_t client_hits;
 548   uint32_t peer_hits;
 549   uint32_t cmd_hits_auth;
 550   uint32_t cmd_hits_normal;
 551   uint32_t cmd_hits_bad;
 552   uint32_t last_ntp_hit_ago;
 553   uint32_t last_cmd_hit_ago;
 554 } RPY_ClientAccesses_Client;
 555
 556 typedef struct {
 557   uint32_t n_indices;      /* how many indices there are in the server's table */
 558   uint32_t next_index;     /* the index 1 beyond those processed on this call */
 559   uint32_t n_clients;      /* the number of valid entries in the following array */
 560   RPY_ClientAccesses_Client clients[MAX_CLIENT_ACCESSES];
 561   int32_t EOR;
 562 } RPY_ClientAccessesByIndex;
 563
 564 #define MAX_MANUAL_LIST_SAMPLES 16
 565
 566 typedef struct {
 567   Timeval when;
 568   Float slewed_offset;
 569   Float orig_offset;
 570   Float residual;
 571 } RPY_ManualListSample;
 572
 573 typedef struct {
 574   uint32_t n_samples;
 575   RPY_ManualListSample samples[MAX_MANUAL_LIST_SAMPLES];
 576   int32_t EOR;
 577 } RPY_ManualList;
 578
 579 typedef struct {
 580   int32_t online;
 581   int32_t offline;
 582   int32_t burst_online;
 583   int32_t burst_offline;
 584   int32_t unresolved;
 585   int32_t EOR;
 586 } RPY_Activity;
 587
 588 #define RPY_SMT_FLAG_ACTIVE 0x1
 589 #define RPY_SMT_FLAG_LEAPONLY 0x2
 590
 591 typedef struct {
 592   uint32_t flags;
 593   Float offset;
 594   Float freq_ppm;
 595   Float wander_ppm;
 596   Float last_update_ago;
 597   Float remaining_time;
 598   int32_t EOR;
 599 } RPY_Smoothing;
 600
 601 typedef struct {
 602   uint8_t version;
 603   uint8_t pkt_type;
 604   uint8_t res1;
 605   uint8_t res2;
 606   uint16_t command; /* Which command is being replied to */
 607   uint16_t reply; /* Which format of reply this is */
 608   uint16_t status; /* Status of command processing */
 609   uint16_t pad1; /* Padding for compatibility and 4 byte alignment */
 610   uint16_t pad2;
 611   uint16_t pad3;
 612   uint32_t sequence; /* Echo of client's sequence number */
 613   uint32_t pad4;
 614   uint32_t pad5;
 615
 616   union {
 617     RPY_Null null;
 618     RPY_N_Sources n_sources;
 619     RPY_Source_Data source_data;
 620     RPY_ManualTimestamp manual_timestamp;
 621     RPY_Tracking tracking;
 622     RPY_Sourcestats sourcestats;
 623     RPY_Rtc rtc;
 624     RPY_ClientAccessesByIndex client_accesses_by_index;
 625     RPY_ManualList manual_list;
 626     RPY_Activity activity;
 627     RPY_Smoothing smoothing;
 628   } data; /* Reply specific parameters */
 629
 630 } CMD_Reply;
 631
 632 /* ================================================== */
 633
 634 #endif /* GOT_CANDM_H */