1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
|
/*
* ntp_control.h - definitions related to NTP mode 6 control messages
*
* mode 6 messages are defined in RFC 9327
* Control Messages Protocol for Use with Network Time Protocol Version 4
* https://www.rfc-editor.org/rfc/rfc9327.pdf
*
*/
#ifndef GUARD_NTP_CONTROL_H
#define GUARD_NTP_CONTROL_H
#include "ntp_types.h"
/* The attribute after this structure is a gcc/clang extension that forces
* the beginning of a structure instance to be 32-bit aligned. Without this
* attempting to compile on a 32-bit host may throw warnings or errors when
* a pointer to this structure is passed to authdecrypt/authencrypt, both of
* which expect to be able to treat the structure as an array of uint32_t
* elements. Ideally, we'd get rid of that nasty type punning. */
struct ntp_control {
uint8_t li_vn_mode; /* leap, version, mode */
uint8_t r_m_e_op; /* response, more, error, opcode */
uint16_t sequence; /* sequence number of request */
uint16_t status; /* status word for association */
uint16_t associd; /* association ID (associd_t) */
uint16_t offset; /* offset of this batch of data */
/* the draft RFC says 0 <= count <= 468 */
uint16_t count; /* byte count of data in this packet */
uint8_t data[480 + MAX_MAC_LEN]; /* data + padding + auth */
} __attribute__((aligned(32)));
/*
* Length of the control header, in octets
*/
#define CTL_HEADER_LEN (offsetof(struct ntp_control, data))
#define CTL_MAX_DATA_LEN 468
/*
* Decoding for the r_m_e_op field
*/
#define CTL_RESPONSE 0x80
#define CTL_ERROR 0x40
#define CTL_MORE 0x20
#define CTL_OP_MASK 0x1f
#define CTL_ISRESPONSE(r_m_e_op) ((CTL_RESPONSE & (r_m_e_op)) != 0)
#define CTL_ISMORE(r_m_e_op) ((CTL_MORE & (r_m_e_op)) != 0)
#define CTL_ISERROR(r_m_e_op) ((CTL_ERROR & (r_m_e_op)) != 0)
#define CTL_OP(r_m_e_op) (CTL_OP_MASK & (r_m_e_op))
/*
* Opcodes
*/
#define CTL_OP_UNSPEC 0 /* unspeciffied */
#define CTL_OP_READSTAT 1 /* read status */
#define CTL_OP_READVAR 2 /* read variables */
#define CTL_OP_WRITEVAR 3 /* write variables */
#define CTL_OP_READCLOCK 4 /* read clock variables */
#define CTL_OP_WRITECLOCK 5 /* write clock variables */
/* #def CTL_OP_SETTRAP 6 ** set trap address (unused) */
/* #def CTL_OP_ASYNCMSG 7 ** trap message (unused) */
#define CTL_OP_CONFIGURE 8 /* runtime configuration */
/* #def CTL_OP_EXCONFIG 9 ** export config to file (unused) */
#define CTL_OP_READ_MRU 10 /* retrieve MRU (mrulist) */
#define CTL_OP_READ_ORDLIST_A 11 /* ordered list req. auth. */
#define CTL_OP_REQ_NONCE 12 /* request a client nonce */
/* #def CTL_OP_UNSETTRAP 31 ** unset trap (unused) */
/*
* {En,De}coding of the system status word
*/
#define CTL_SST_TS_UNSPEC 0 /* unspec */
#define CTL_SST_TS_ATOM 1 /* pps */
#define CTL_SST_TS_LF 2 /* lf radio */
#define CTL_SST_TS_HF 3 /* hf radio */
#define CTL_SST_TS_UHF 4 /* uhf radio */
#define CTL_SST_TS_LOCAL 5 /* local */
#define CTL_SST_TS_NTP 6 /* ntp */
#define CTL_SST_TS_UDPTIME 7 /* other */
#define CTL_SST_TS_WRSTWTCH 8 /* wristwatch */
#define CTL_SST_TS_TELEPHONE 9 /* telephone */
#define CTL_SYS_MAXEVENTS 15
#define CTL_SYS_STATUS(li, source, nevnt, evnt) \
(((((li) & 0xffff) << 14)&0xc000) | \
(((source)<<8)&0x3f00) | \
(((nevnt)<<4)&0x00f0) | \
((evnt)&0x000f))
#define CTL_SYS_LI(status) (((status)>>14) & 0x3)
#define CTL_SYS_SOURCE(status) (((status)>>8) & 0x3f)
#define CTL_SYS_NEVNT(status) (((status)>>4) & 0xf)
#define CTL_SYS_EVENT(status) ((status) & 0xf)
/*
* {En,De}coding of the peer status word
*/
#define CTL_PST_CONFIG 0x80
#define CTL_PST_AUTHENABLE 0x40
#define CTL_PST_AUTHENTIC 0x20
#define CTL_PST_REACH 0x10
#define CTL_PST_BCAST 0x08
#define CTL_PST_SEL_REJECT 0 /* reject */
#define CTL_PST_SEL_SANE 1 /* x falsetick */
#define CTL_PST_SEL_CORRECT 2 /* . excess */
#define CTL_PST_SEL_SELCAND 3 /* - outlier */
#define CTL_PST_SEL_SYNCCAND 4 /* + candidate */
#define CTL_PST_SEL_EXCESS 5 /* # backup */
#define CTL_PST_SEL_SYSPEER 6 /* * sys.peer */
#define CTL_PST_SEL_PPS 7 /* o pps.peer */
#define CTL_PEER_MAXEVENTS 15
#define CTL_PEER_STATUS(status, nevnt, evnt) \
((((status)<<8) & 0xff00) | \
(((nevnt)<<4) & 0x00f0) | \
((evnt) & 0x000f))
#define CTL_PEER_STATVAL(status)(((status)>>8) & 0xff)
#define CTL_PEER_NEVNT(status) (((status)>>4) & 0xf)
#define CTL_PEER_EVENT(status) ((status) & 0xf)
/*
* {En,De}coding of the clock status word
*/
#define CTL_CLK_OKAY 0
#define CTL_CLK_NOREPLY 1
#define CTL_CLK_BADFORMAT 2
#define CTL_CLK_FAULT 3
#define CTL_CLK_PROPAGATION 4
#define CTL_CLK_BADDATE 5
#define CTL_CLK_BADTIME 6
#define CTL_CLK_STATUS(status, event) \
((((status)<<8) & 0xff00) | \
((event) & 0x00ff))
/*
* Error code responses returned when the E bit is set.
*/
#define CERR_UNSPEC 0
#define CERR_PERMISSION 1
#define CERR_BADFMT 2
#define CERR_BADOP 3
#define CERR_BADASSOC 4
#define CERR_UNKNOWNVAR 5
#define CERR_BADVALUE 6
#define CERR_RESTRICT 7
#define CERR_NORESOURCE CERR_PERMISSION /* wish there was a different code */
/*
* Types of things we may deal with
* shared between ntpq and library
*/
#define TYPE_SYS 1
#define TYPE_PEER 2
#define TYPE_CLOCK 3
/*
* IFSTATS_FIELDS is the number of fields ntpd supplies for each ifstats
* row. Similarly RESLIST_FIELDS for reslist.
*/
#define IFSTATS_FIELDS 12
#define RESLIST_FIELDS 4
/*
* To prevent replay attacks, MRU list nonces age out. Time is in seconds.
*
* Don't change this value casually. Lengthening it might extend an
* attack window for DDoS amplification. Shortening it might make your
* server (or client) incompatible with older versions.
*/
#define NONCE_TIMEOUT 16
#endif /* GUARD_NTP_CONTROL_H */
|
