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 REQ_RESET_SOURCES 66
107 #define REQ_AUTH_DATA 67
108 #define REQ_CLIENT_ACCESSES_BY_INDEX3 68
109 #define REQ_SELECT_DATA 69
110 #define REQ_RELOAD_SOURCES 70
111 #define REQ_DOFFSET2 71
112 #define N_REQUEST_TYPES 72
114 /* Structure used to exchange timespecs independent of time_t size */
116 uint32_t tv_sec_high
;
121 /* This is used in tv_sec_high for 32-bit timestamps */
122 #define TV_NOHIGHSEC 0x7fffffff
124 /* 32-bit floating-point format consisting of 7-bit signed exponent
125 and 25-bit signed coefficient without hidden bit.
126 The result is calculated as: 2^(exp - 25) * coef */
131 /* The EOR (end of record) fields are used by the offsetof operator in
132 pktlength.c, to get the number of bytes that ought to be
133 transmitted for each packet type. */
154 int32_t n_good_samples
;
155 int32_t n_total_samples
;
163 } REQ_Modify_Minpoll
;
169 } REQ_Modify_Maxpoll
;
180 } REQ_Modify_Maxdelay
;
184 Float new_max_delay_ratio
;
186 } REQ_Modify_Maxdelayratio
;
190 Float new_max_delay_dev_ratio
;
192 } REQ_Modify_Maxdelaydevratio
;
196 int32_t new_min_stratum
;
198 } REQ_Modify_Minstratum
;
202 int32_t new_poll_target
;
204 } REQ_Modify_Polltarget
;
207 Float new_max_update_skew
;
209 } REQ_Modify_Maxupdateskew
;
215 } REQ_Modify_Makestep
;
256 /* Source types in NTP source requests */
257 #define REQ_ADDSRC_SERVER 1
258 #define REQ_ADDSRC_PEER 2
259 #define REQ_ADDSRC_POOL 3
261 /* Flags used in NTP source requests */
262 #define REQ_ADDSRC_ONLINE 0x1
263 #define REQ_ADDSRC_AUTOOFFLINE 0x2
264 #define REQ_ADDSRC_IBURST 0x4
265 #define REQ_ADDSRC_PREFER 0x8
266 #define REQ_ADDSRC_NOSELECT 0x10
267 #define REQ_ADDSRC_TRUST 0x20
268 #define REQ_ADDSRC_REQUIRE 0x40
269 #define REQ_ADDSRC_INTERLEAVED 0x80
270 #define REQ_ADDSRC_BURST 0x100
271 #define REQ_ADDSRC_NTS 0x200
272 #define REQ_ADDSRC_COPY 0x400
280 int32_t presend_minpoll
;
281 uint32_t min_stratum
;
282 uint32_t poll_target
;
284 uint32_t max_sources
;
290 Float max_delay_ratio
;
291 Float max_delay_dev_ratio
;
296 int32_t filter_length
;
298 uint32_t reserved
[2];
322 /* This is based on the response size rather than the
324 #define MAX_CLIENT_ACCESSES 8
327 uint32_t first_index
;
332 } REQ_ClientAccessesByIndex
;
342 } REQ_ReselectDistance
;
344 #define REQ_SMOOTHTIME_RESET 0
345 #define REQ_SMOOTHTIME_ACTIVATE 1
372 /* ================================================== */
374 #define PKT_TYPE_CMD_REQUEST 1
375 #define PKT_TYPE_CMD_REPLY 2
377 /* This version number needs to be incremented whenever the packet
378 size and/or the format of any of the existing messages is changed.
379 Other changes, e.g. new command types, should be handled cleanly by
380 client.c and cmdmon.c anyway, so the version can stay the same.
382 Version 1 : original version with fixed size packets
384 Version 2 : both command and reply packet sizes made capable of
385 being variable length.
387 Version 3 : NTP_Source message lengthened (auto_offline)
389 Version 4 : IPv6 addressing added, 64-bit time values, sourcestats
390 and tracking reports extended, added flags to NTP source request,
391 trimmed source report, replaced fixed-point format with floating-point
392 and used also instead of integer microseconds, new commands: modify stratum,
393 modify polltarget, modify maxdelaydevratio, reselect, reselectdistance
395 Version 5 : auth data moved to the end of the packet to allow hashes with
396 different sizes, extended sources, tracking and activity reports, dropped
397 subnets accessed and client accesses
399 Version 6 : added padding to requests to prevent amplification attack,
400 changed maximum number of samples in manual list to 16, new commands: modify
401 makestep, smoothing, smoothtime
403 Support for authentication was removed later in version 6 of the protocol
404 and commands that required authentication are allowed only locally over Unix
407 Version 6 (no authentication) : changed format of client accesses by index
408 (two times), delta offset, and manual timestamp, added new fields and
409 flags to NTP source request and report, made length of manual list constant,
410 added new commands: authdata, ntpdata, onoffline, refresh, reset,
411 selectdata, serverstats, shutdown, sourcename
414 #define PROTO_VERSION_NUMBER 6
416 /* The oldest protocol versions that are compatible enough with the current
417 version to report a version mismatch for the server and the client */
418 #define PROTO_VERSION_MISMATCH_COMPAT_SERVER 5
419 #define PROTO_VERSION_MISMATCH_COMPAT_CLIENT 4
421 /* The first protocol version using padding in requests */
422 #define PROTO_VERSION_PADDING 6
424 /* The maximum length of padding in request packet, currently
425 defined by CLIENT_ACCESSES_BY_INDEX3 */
426 #define MAX_PADDING_LENGTH 484
428 /* ================================================== */
431 uint8_t version
; /* Protocol version */
432 uint8_t pkt_type
; /* What sort of packet this is */
435 uint16_t command
; /* Which command is being issued */
436 uint16_t attempt
; /* How many resends the client has done
437 (count up from zero for same sequence
439 uint32_t sequence
; /* Client's sequence number */
448 REQ_Modify_Minpoll modify_minpoll
;
449 REQ_Modify_Maxpoll modify_maxpoll
;
451 REQ_Modify_Maxdelay modify_maxdelay
;
452 REQ_Modify_Maxdelayratio modify_maxdelayratio
;
453 REQ_Modify_Maxdelaydevratio modify_maxdelaydevratio
;
454 REQ_Modify_Minstratum modify_minstratum
;
455 REQ_Modify_Polltarget modify_polltarget
;
456 REQ_Modify_Maxupdateskew modify_maxupdateskew
;
457 REQ_Modify_Makestep modify_makestep
;
462 REQ_Source_Data source_data
;
463 REQ_Allow_Deny allow_deny
;
464 REQ_Ac_Check ac_check
;
465 REQ_NTP_Source ntp_source
;
466 REQ_Del_Source del_source
;
469 REQ_Sourcestats sourcestats
;
470 REQ_ClientAccessesByIndex client_accesses_by_index
;
471 REQ_ManualDelete manual_delete
;
472 REQ_ReselectDistance reselect_distance
;
473 REQ_SmoothTime smoothtime
;
474 REQ_NTPData ntp_data
;
475 REQ_NTPSourceName ntp_source_name
;
476 REQ_AuthData auth_data
;
477 REQ_SelectData select_data
;
478 } data
; /* Command specific parameters */
480 /* Padding used to prevent traffic amplification. It only defines the
481 maximum size of the packet, there is no hole after the data field. */
482 uint8_t padding
[MAX_PADDING_LENGTH
];
486 /* ================================================== */
487 /* Authority codes for command types */
489 #define PERMIT_OPEN 0
490 #define PERMIT_LOCAL 1
491 #define PERMIT_AUTH 2
493 /* ================================================== */
497 #define RPY_N_SOURCES 2
498 #define RPY_SOURCE_DATA 3
499 #define RPY_MANUAL_TIMESTAMP 4
500 #define RPY_TRACKING 5
501 #define RPY_SOURCESTATS 6
503 #define RPY_SUBNETS_ACCESSED 8
504 #define RPY_CLIENT_ACCESSES 9
505 #define RPY_CLIENT_ACCESSES_BY_INDEX 10
506 #define RPY_MANUAL_LIST 11
507 #define RPY_ACTIVITY 12
508 #define RPY_SMOOTHING 13
509 #define RPY_SERVER_STATS 14
510 #define RPY_CLIENT_ACCESSES_BY_INDEX2 15
511 #define RPY_NTP_DATA 16
512 #define RPY_MANUAL_TIMESTAMP2 17
513 #define RPY_MANUAL_LIST2 18
514 #define RPY_NTP_SOURCE_NAME 19
515 #define RPY_AUTH_DATA 20
516 #define RPY_CLIENT_ACCESSES_BY_INDEX3 21
517 #define RPY_SERVER_STATS2 22
518 #define RPY_SELECT_DATA 23
519 #define N_REPLY_TYPES 24
522 #define STT_SUCCESS 0
525 #define STT_INVALID 3
526 #define STT_NOSUCHSOURCE 4
527 #define STT_INVALIDTS 5
528 #define STT_NOTENABLED 6
529 #define STT_BADSUBNET 7
530 #define STT_ACCESSALLOWED 8
531 #define STT_ACCESSDENIED 9
533 #define STT_NOHOSTACCESS 10
534 #define STT_SOURCEALREADYKNOWN 11
535 #define STT_TOOMANYSOURCES 12
537 #define STT_BADRTCFILE 14
538 #define STT_INACTIVE 15
539 #define STT_BADSAMPLE 16
540 #define STT_INVALIDAF 17
541 #define STT_BADPKTVERSION 18
542 #define STT_BADPKTLENGTH 19
543 #define STT_INVALIDNAME 21
554 #define RPY_SD_MD_CLIENT 0
555 #define RPY_SD_MD_PEER 1
556 #define RPY_SD_MD_REF 2
558 #define RPY_SD_ST_SELECTED 0
559 #define RPY_SD_ST_NONSELECTABLE 1
560 #define RPY_SD_ST_FALSETICKER 2
561 #define RPY_SD_ST_JITTERY 3
562 #define RPY_SD_ST_UNSELECTED 4
563 #define RPY_SD_ST_SELECTABLE 5
572 uint16_t reachability
;
573 uint32_t since_sample
;
574 Float orig_latest_meas
;
576 Float latest_meas_err
;
584 uint16_t leap_status
;
586 Float current_correction
;
590 Float resid_freq_ppm
;
593 Float root_dispersion
;
594 Float last_update_interval
;
603 uint32_t span_seconds
;
605 Float resid_freq_ppm
;
608 Float est_offset_err
;
616 uint32_t span_seconds
;
617 Float rtc_seconds_fast
;
618 Float rtc_gain_rate_ppm
;
627 } RPY_ManualTimestamp
;
640 int8_t ntp_timeout_interval
;
641 uint32_t last_ntp_hit_ago
;
642 uint32_t last_nke_hit_ago
;
643 uint32_t last_cmd_hit_ago
;
644 } RPY_ClientAccesses_Client
;
647 uint32_t n_indices
; /* how many indices there are in the server's table */
648 uint32_t next_index
; /* the index 1 beyond those processed on this call */
649 uint32_t n_clients
; /* the number of valid entries in the following array */
650 RPY_ClientAccesses_Client clients
[MAX_CLIENT_ACCESSES
];
652 } RPY_ClientAccessesByIndex
;
662 uint32_t ntp_auth_hits
;
666 #define MAX_MANUAL_LIST_SAMPLES 16
673 } RPY_ManualListSample
;
677 RPY_ManualListSample samples
[MAX_MANUAL_LIST_SAMPLES
];
684 int32_t burst_online
;
685 int32_t burst_offline
;
690 #define RPY_SMT_FLAG_ACTIVE 0x1
691 #define RPY_SMT_FLAG_LEAPONLY 0x2
698 Float last_update_ago
;
699 Float remaining_time
;
703 #define RPY_NTP_FLAGS_TESTS 0x3ff
704 #define RPY_NTP_FLAG_INTERLEAVED 0x4000
705 #define RPY_NTP_FLAG_AUTHENTICATED 0x8000
710 uint16_t remote_port
;
718 Float root_dispersion
;
723 Float peer_dispersion
;
725 Float jitter_asymmetry
;
729 uint32_t total_tx_count
;
730 uint32_t total_rx_count
;
731 uint32_t total_valid_count
;
732 uint32_t reserved
[4];
741 #define RPY_AD_MD_NONE 0
742 #define RPY_AD_MD_SYMMETRIC 1
743 #define RPY_AD_MD_NTS 2
750 uint16_t ke_attempts
;
751 uint32_t last_ke_ago
;
753 uint16_t cookie_length
;
759 #define RPY_SD_OPTION_NOSELECT 0x1
760 #define RPY_SD_OPTION_PREFER 0x2
761 #define RPY_SD_OPTION_TRUST 0x4
762 #define RPY_SD_OPTION_REQUIRE 0x8
768 uint8_t authentication
;
771 uint16_t conf_options
;
772 uint16_t eff_options
;
773 uint32_t last_sample_ago
;
785 uint16_t command
; /* Which command is being replied to */
786 uint16_t reply
; /* Which format of reply this is */
787 uint16_t status
; /* Status of command processing */
788 uint16_t pad1
; /* Padding for compatibility and 4 byte alignment */
791 uint32_t sequence
; /* Echo of client's sequence number */
797 RPY_N_Sources n_sources
;
798 RPY_Source_Data source_data
;
799 RPY_ManualTimestamp manual_timestamp
;
800 RPY_Tracking tracking
;
801 RPY_Sourcestats sourcestats
;
803 RPY_ClientAccessesByIndex client_accesses_by_index
;
804 RPY_ServerStats server_stats
;
805 RPY_ManualList manual_list
;
806 RPY_Activity activity
;
807 RPY_Smoothing smoothing
;
808 RPY_NTPData ntp_data
;
809 RPY_NTPSourceName ntp_source_name
;
810 RPY_AuthData auth_data
;
811 RPY_SelectData select_data
;
812 } data
; /* Reply specific parameters */
816 /* ================================================== */
818 #endif /* GOT_CANDM_H */