2 chronyd/chronyc - Programs for keeping computer clocks accurate.
4 **********************************************************************
5 * Copyright (C) Richard P. Curnow 1997-2003
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.
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.
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.
20 **********************************************************************
22 =======================================================================
24 Definitions for the network protocol used for command and monitoring
33 #include "addressing.h"
35 /* This is the default port to use for CANDM, if no alternative is
37 #define DEFAULT_CANDM_PORT 323
44 #define REQ_MODIFY_MINPOLL 4
45 #define REQ_MODIFY_MAXPOLL 5
47 #define REQ_MODIFY_MAXDELAY 7
48 #define REQ_MODIFY_MAXDELAYRATIO 8
49 #define REQ_MODIFY_MAXUPDATESKEW 9
51 #define REQ_SETTIME 11
54 #define REQ_N_SOURCES 14
55 #define REQ_SOURCE_DATA 15
58 #define REQ_ALLOWALL 18
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
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 REQ_REFRESH 53
94 #define REQ_SERVER_STATS 54
95 #define REQ_CLIENT_ACCESSES_BY_INDEX2 55
97 #define REQ_NTP_DATA 57
98 #define REQ_ADD_SERVER2 58
99 #define REQ_ADD_PEER2 59
100 #define REQ_ADD_SERVER3 60
101 #define REQ_ADD_PEER3 61
102 #define REQ_SHUTDOWN 62
103 #define REQ_ONOFFLINE 63
104 #define REQ_ADD_SOURCE 64
105 #define REQ_NTP_SOURCE_NAME 65
106 #define N_REQUEST_TYPES 66
108 /* Structure used to exchange timespecs independent of time_t size */
110 uint32_t tv_sec_high
;
115 /* This is used in tv_sec_high for 32-bit timestamps */
116 #define TV_NOHIGHSEC 0x7fffffff
118 /* 32-bit floating-point format consisting of 7-bit signed exponent
119 and 25-bit signed coefficient without hidden bit.
120 The result is calculated as: 2^(exp - 25) * coef */
125 /* The EOR (end of record) fields are used by the offsetof operator in
126 pktlength.c, to get the number of bytes that ought to be
127 transmitted for each packet type. */
148 int32_t n_good_samples
;
149 int32_t n_total_samples
;
157 } REQ_Modify_Minpoll
;
163 } REQ_Modify_Maxpoll
;
174 } REQ_Modify_Maxdelay
;
178 Float new_max_delay_ratio
;
180 } REQ_Modify_Maxdelayratio
;
184 Float new_max_delay_dev_ratio
;
186 } REQ_Modify_Maxdelaydevratio
;
190 int32_t new_min_stratum
;
192 } REQ_Modify_Minstratum
;
196 int32_t new_poll_target
;
198 } REQ_Modify_Polltarget
;
201 Float new_max_update_skew
;
203 } REQ_Modify_Maxupdateskew
;
209 } REQ_Modify_Makestep
;
250 /* Source types in NTP source requests */
251 #define REQ_ADDSRC_SERVER 1
252 #define REQ_ADDSRC_PEER 2
253 #define REQ_ADDSRC_POOL 3
255 /* Flags used in NTP source requests */
256 #define REQ_ADDSRC_ONLINE 0x1
257 #define REQ_ADDSRC_AUTOOFFLINE 0x2
258 #define REQ_ADDSRC_IBURST 0x4
259 #define REQ_ADDSRC_PREFER 0x8
260 #define REQ_ADDSRC_NOSELECT 0x10
261 #define REQ_ADDSRC_TRUST 0x20
262 #define REQ_ADDSRC_REQUIRE 0x40
263 #define REQ_ADDSRC_INTERLEAVED 0x80
264 #define REQ_ADDSRC_BURST 0x100
265 #define REQ_ADDSRC_NTS 0x200
273 int32_t presend_minpoll
;
274 uint32_t min_stratum
;
275 uint32_t poll_target
;
277 uint32_t max_sources
;
283 Float max_delay_ratio
;
284 Float max_delay_dev_ratio
;
289 int32_t filter_length
;
290 uint32_t reserved
[3];
315 /* This is based on the response size rather than the
317 #define MAX_CLIENT_ACCESSES 8
320 uint32_t first_index
;
323 } REQ_ClientAccessesByIndex
;
333 } REQ_ReselectDistance
;
335 #define REQ_SMOOTHTIME_RESET 0
336 #define REQ_SMOOTHTIME_ACTIVATE 1
353 /* ================================================== */
355 #define PKT_TYPE_CMD_REQUEST 1
356 #define PKT_TYPE_CMD_REPLY 2
358 /* This version number needs to be incremented whenever the packet
359 size and/or the format of any of the existing messages is changed.
360 Other changes, e.g. new command types, should be handled cleanly by
361 client.c and cmdmon.c anyway, so the version can stay the same.
363 Version 1 : original version with fixed size packets
365 Version 2 : both command and reply packet sizes made capable of
366 being variable length.
368 Version 3 : NTP_Source message lengthened (auto_offline)
370 Version 4 : IPv6 addressing added, 64-bit time values, sourcestats
371 and tracking reports extended, added flags to NTP source request,
372 trimmed source report, replaced fixed-point format with floating-point
373 and used also instead of integer microseconds, new commands: modify stratum,
374 modify polltarget, modify maxdelaydevratio, reselect, reselectdistance
376 Version 5 : auth data moved to the end of the packet to allow hashes with
377 different sizes, extended sources, tracking and activity reports, dropped
378 subnets accessed and client accesses
380 Version 6 : added padding to requests to prevent amplification attack,
381 changed maximum number of samples in manual list to 16, new commands: modify
382 makestep, smoothing, smoothtime
384 Support for authentication was removed later in version 6 of the protocol
385 and commands that required authentication are allowed only locally over Unix
388 Version 6 (no authentication) : changed format of client accesses by index
389 (using new request/reply types) and manual timestamp, added new fields and
390 flags to NTP source request and report, made length of manual list constant,
391 added new commands: ntpdata, refresh, serverstats, shutdown
394 #define PROTO_VERSION_NUMBER 6
396 /* The oldest protocol versions that are compatible enough with the current
397 version to report a version mismatch for the server and the client */
398 #define PROTO_VERSION_MISMATCH_COMPAT_SERVER 5
399 #define PROTO_VERSION_MISMATCH_COMPAT_CLIENT 4
401 /* The first protocol version using padding in requests */
402 #define PROTO_VERSION_PADDING 6
404 /* The maximum length of padding in request packet, currently
405 defined by MANUAL_LIST */
406 #define MAX_PADDING_LENGTH 396
408 /* ================================================== */
411 uint8_t version
; /* Protocol version */
412 uint8_t pkt_type
; /* What sort of packet this is */
415 uint16_t command
; /* Which command is being issued */
416 uint16_t attempt
; /* How many resends the client has done
417 (count up from zero for same sequence
419 uint32_t sequence
; /* Client's sequence number */
428 REQ_Modify_Minpoll modify_minpoll
;
429 REQ_Modify_Maxpoll modify_maxpoll
;
431 REQ_Modify_Maxdelay modify_maxdelay
;
432 REQ_Modify_Maxdelayratio modify_maxdelayratio
;
433 REQ_Modify_Maxdelaydevratio modify_maxdelaydevratio
;
434 REQ_Modify_Minstratum modify_minstratum
;
435 REQ_Modify_Polltarget modify_polltarget
;
436 REQ_Modify_Maxupdateskew modify_maxupdateskew
;
437 REQ_Modify_Makestep modify_makestep
;
442 REQ_Source_Data source_data
;
443 REQ_Allow_Deny allow_deny
;
444 REQ_Ac_Check ac_check
;
445 REQ_NTP_Source ntp_source
;
446 REQ_Del_Source del_source
;
449 REQ_Sourcestats sourcestats
;
450 REQ_ClientAccessesByIndex client_accesses_by_index
;
451 REQ_ManualDelete manual_delete
;
452 REQ_ReselectDistance reselect_distance
;
453 REQ_SmoothTime smoothtime
;
454 REQ_NTPData ntp_data
;
455 REQ_NTPData ntp_source_name
;
456 } data
; /* Command specific parameters */
458 /* Padding used to prevent traffic amplification. It only defines the
459 maximum size of the packet, there is no hole after the data field. */
460 uint8_t padding
[MAX_PADDING_LENGTH
];
464 /* ================================================== */
465 /* Authority codes for command types */
467 #define PERMIT_OPEN 0
468 #define PERMIT_LOCAL 1
469 #define PERMIT_AUTH 2
471 /* ================================================== */
475 #define RPY_N_SOURCES 2
476 #define RPY_SOURCE_DATA 3
477 #define RPY_MANUAL_TIMESTAMP 4
478 #define RPY_TRACKING 5
479 #define RPY_SOURCESTATS 6
481 #define RPY_SUBNETS_ACCESSED 8
482 #define RPY_CLIENT_ACCESSES 9
483 #define RPY_CLIENT_ACCESSES_BY_INDEX 10
484 #define RPY_MANUAL_LIST 11
485 #define RPY_ACTIVITY 12
486 #define RPY_SMOOTHING 13
487 #define RPY_SERVER_STATS 14
488 #define RPY_CLIENT_ACCESSES_BY_INDEX2 15
489 #define RPY_NTP_DATA 16
490 #define RPY_MANUAL_TIMESTAMP2 17
491 #define RPY_MANUAL_LIST2 18
492 #define RPY_NTP_SOURCE_NAME 19
493 #define N_REPLY_TYPES 20
496 #define STT_SUCCESS 0
499 #define STT_INVALID 3
500 #define STT_NOSUCHSOURCE 4
501 #define STT_INVALIDTS 5
502 #define STT_NOTENABLED 6
503 #define STT_BADSUBNET 7
504 #define STT_ACCESSALLOWED 8
505 #define STT_ACCESSDENIED 9
507 #define STT_NOHOSTACCESS 10
508 #define STT_SOURCEALREADYKNOWN 11
509 #define STT_TOOMANYSOURCES 12
511 #define STT_BADRTCFILE 14
512 #define STT_INACTIVE 15
513 #define STT_BADSAMPLE 16
514 #define STT_INVALIDAF 17
515 #define STT_BADPKTVERSION 18
516 #define STT_BADPKTLENGTH 19
517 #define STT_INVALIDNAME 21
528 #define RPY_SD_MD_CLIENT 0
529 #define RPY_SD_MD_PEER 1
530 #define RPY_SD_MD_REF 2
532 #define RPY_SD_ST_SYNC 0
533 #define RPY_SD_ST_UNREACH 1
534 #define RPY_SD_ST_FALSETICKER 2
535 #define RPY_SD_ST_JITTERY 3
536 #define RPY_SD_ST_CANDIDATE 4
537 #define RPY_SD_ST_OUTLIER 5
539 #define RPY_SD_FLAG_NOSELECT 0x1
540 #define RPY_SD_FLAG_PREFER 0x2
541 #define RPY_SD_FLAG_TRUST 0x4
542 #define RPY_SD_FLAG_REQUIRE 0x8
551 uint16_t reachability
;
552 uint32_t since_sample
;
553 Float orig_latest_meas
;
555 Float latest_meas_err
;
563 uint16_t leap_status
;
565 Float current_correction
;
569 Float resid_freq_ppm
;
572 Float root_dispersion
;
573 Float last_update_interval
;
582 uint32_t span_seconds
;
584 Float resid_freq_ppm
;
587 Float est_offset_err
;
595 uint32_t span_seconds
;
596 Float rtc_seconds_fast
;
597 Float rtc_gain_rate_ppm
;
606 } RPY_ManualTimestamp
;
616 int8_t ntp_timeout_interval
;
618 uint32_t last_ntp_hit_ago
;
619 uint32_t last_cmd_hit_ago
;
620 } RPY_ClientAccesses_Client
;
623 uint32_t n_indices
; /* how many indices there are in the server's table */
624 uint32_t next_index
; /* the index 1 beyond those processed on this call */
625 uint32_t n_clients
; /* the number of valid entries in the following array */
626 RPY_ClientAccesses_Client clients
[MAX_CLIENT_ACCESSES
];
628 } RPY_ClientAccessesByIndex
;
639 #define MAX_MANUAL_LIST_SAMPLES 16
646 } RPY_ManualListSample
;
650 RPY_ManualListSample samples
[MAX_MANUAL_LIST_SAMPLES
];
657 int32_t burst_online
;
658 int32_t burst_offline
;
663 #define RPY_SMT_FLAG_ACTIVE 0x1
664 #define RPY_SMT_FLAG_LEAPONLY 0x2
671 Float last_update_ago
;
672 Float remaining_time
;
676 #define RPY_NTP_FLAGS_TESTS 0x3ff
677 #define RPY_NTP_FLAG_INTERLEAVED 0x4000
678 #define RPY_NTP_FLAG_AUTHENTICATED 0x8000
683 uint16_t remote_port
;
691 Float root_dispersion
;
696 Float peer_dispersion
;
698 Float jitter_asymmetry
;
702 uint32_t total_tx_count
;
703 uint32_t total_rx_count
;
704 uint32_t total_valid_count
;
705 uint32_t reserved
[4];
719 uint16_t command
; /* Which command is being replied to */
720 uint16_t reply
; /* Which format of reply this is */
721 uint16_t status
; /* Status of command processing */
722 uint16_t pad1
; /* Padding for compatibility and 4 byte alignment */
725 uint32_t sequence
; /* Echo of client's sequence number */
731 RPY_N_Sources n_sources
;
732 RPY_Source_Data source_data
;
733 RPY_ManualTimestamp manual_timestamp
;
734 RPY_Tracking tracking
;
735 RPY_Sourcestats sourcestats
;
737 RPY_ClientAccessesByIndex client_accesses_by_index
;
738 RPY_ServerStats server_stats
;
739 RPY_ManualList manual_list
;
740 RPY_Activity activity
;
741 RPY_Smoothing smoothing
;
742 RPY_NTPData ntp_data
;
743 RPY_NTPSourceName ntp_source_name
;
744 } data
; /* Reply specific parameters */
748 /* ================================================== */
750 #endif /* GOT_CANDM_H */