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
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315 | /*
* Copyright (C) 2004-2024 Internet Systems Consortium, Inc. ("ISC")
* Copyright (c) 1995-2003 by Internet Software Consortium
*
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
*
* Internet Systems Consortium, Inc.
* 950 Charter Street
* Redwood City, CA 94063
* <info@isc.org>
* https://www.isc.org/
*
* This software has been written for Internet Systems Consortium
* by Ted Lemon in cooperation with Vixie Enterprises. To learn more
* about Internet Systems Consortium, see ``https://www.isc.org''.
* To learn more about Vixie Enterprises, see ``http://www.vix.com''.
*/
/*
* NOTE: This files is imported from ISC DHCP. It uses C notation.
* Format kept for easier merge.
*/
#ifndef DHCP_H
#define DHCP_H
#include <stdint.h><--- Include file: not found. Please note: Cppcheck does not need standard library headers to get proper results.
/// @note Code points in comments are those assigned by IANA
/// but not yet implemented in Kea.
/// To implement a standard option, remove the comment characters,
/// add an entry in std_option_defs.h, add a stdOptionDefs4 unit test
/// in tests/libdhcp++_unittest.cc and update dhcp4-std-options-list-part2
/// in the dhcp4-srv.xml source file of the user guide.
namespace isc {
namespace dhcp {
/* IPv4 Broadcast address */
#define DHCP_IPV4_BROADCAST_ADDRESS "255.255.255.255"
/* BOOTP (rfc951) message types */
enum BOOTPTypes {
BOOTREQUEST = 1,
BOOTREPLY = 2
};
/* Possible values for flags field... */
static const uint16_t BOOTP_BROADCAST = 32768L;
/// @brief Possible values for hardware type (htype) field.
enum HType {
HTYPE_UNDEFINED = 0, ///< not specified or undefined
HTYPE_ETHER = 1, ///< Ethernet 10Mbps
HTYPE_DOCSIS = 1, ///< The traffic captures we have from cable modems as
/// well as this list by IANA:
/// http://www.iana.org/assignments/
/// arp-parameters/arp-parameters.xhtml suggest that
/// Ethernet (1) should be used in DOCSIS environment.
HTYPE_IEEE802 = 6, ///< IEEE 802.2 Token Ring
HTYPE_FDDI = 8 ///< FDDI
/// TODO Add infiniband here
};
/* DHCP Option codes: */
enum DHCPOptionType {
DHO_PAD = 0, /* RFC2132 */
DHO_SUBNET_MASK = 1, /* RFC2132 */
DHO_TIME_OFFSET = 2, /* RFC2132 */
DHO_ROUTERS = 3, /* RFC2132 */
DHO_TIME_SERVERS = 4, /* RFC2132 */
DHO_NAME_SERVERS = 5, /* RFC2132 */
DHO_DOMAIN_NAME_SERVERS = 6, /* RFC2132 */
DHO_LOG_SERVERS = 7, /* RFC2132 */
DHO_COOKIE_SERVERS = 8, /* RFC2132 */
DHO_LPR_SERVERS = 9, /* RFC2132 */
DHO_IMPRESS_SERVERS = 10, /* RFC2132 */
DHO_RESOURCE_LOCATION_SERVERS = 11, /* RFC2132 */
DHO_HOST_NAME = 12, /* RFC2132 */
DHO_BOOT_SIZE = 13, /* RFC2132 */
DHO_MERIT_DUMP = 14, /* RFC2132 */
DHO_DOMAIN_NAME = 15, /* RFC2132 */
DHO_SWAP_SERVER = 16, /* RFC2132 */
DHO_ROOT_PATH = 17, /* RFC2132 */
DHO_EXTENSIONS_PATH = 18, /* RFC2132 */
DHO_IP_FORWARDING = 19, /* RFC2132 */
DHO_NON_LOCAL_SOURCE_ROUTING = 20, /* RFC2132 */
DHO_POLICY_FILTER = 21, /* RFC2132 */
DHO_MAX_DGRAM_REASSEMBLY = 22, /* RFC2132 */
DHO_DEFAULT_IP_TTL = 23, /* RFC2132 */
DHO_PATH_MTU_AGING_TIMEOUT = 24, /* RFC2132 */
DHO_PATH_MTU_PLATEAU_TABLE = 25, /* RFC2132 */
DHO_INTERFACE_MTU = 26, /* RFC2132 */
DHO_ALL_SUBNETS_LOCAL = 27, /* RFC2132 */
DHO_BROADCAST_ADDRESS = 28, /* RFC2132 */
DHO_PERFORM_MASK_DISCOVERY = 29, /* RFC2132 */
DHO_MASK_SUPPLIER = 30, /* RFC2132 */
DHO_ROUTER_DISCOVERY = 31, /* RFC2132 */
DHO_ROUTER_SOLICITATION_ADDRESS = 32, /* RFC2132 */
DHO_STATIC_ROUTES = 33, /* RFC2132 */
DHO_TRAILER_ENCAPSULATION = 34, /* RFC2132 */
DHO_ARP_CACHE_TIMEOUT = 35, /* RFC2132 */
DHO_IEEE802_3_ENCAPSULATION = 36, /* RFC2132 */
DHO_DEFAULT_TCP_TTL = 37, /* RFC2132 */
DHO_TCP_KEEPALIVE_INTERVAL = 38, /* RFC2132 */
DHO_TCP_KEEPALIVE_GARBAGE = 39, /* RFC2132 */
DHO_NIS_DOMAIN = 40, /* RFC2132 */
DHO_NIS_SERVERS = 41, /* RFC2132 */
DHO_NTP_SERVERS = 42, /* RFC2132 */
DHO_VENDOR_ENCAPSULATED_OPTIONS = 43, /* RFC2132 */
DHO_NETBIOS_NAME_SERVERS = 44, /* RFC2132 */
DHO_NETBIOS_DD_SERVER = 45, /* RFC2132 */
DHO_NETBIOS_NODE_TYPE = 46, /* RFC2132 */
DHO_NETBIOS_SCOPE = 47, /* RFC2132 */
DHO_FONT_SERVERS = 48, /* RFC2132 */
DHO_X_DISPLAY_MANAGER = 49, /* RFC2132 */
DHO_DHCP_REQUESTED_ADDRESS = 50, /* RFC2132 */
DHO_DHCP_LEASE_TIME = 51, /* RFC2132 */
DHO_DHCP_OPTION_OVERLOAD = 52, /* RFC2132 */
DHO_DHCP_MESSAGE_TYPE = 53, /* RFC2132 */
DHO_DHCP_SERVER_IDENTIFIER = 54, /* RFC2132 */
DHO_DHCP_PARAMETER_REQUEST_LIST = 55, /* RFC2132 */
DHO_DHCP_MESSAGE = 56, /* RFC2132 */
DHO_DHCP_MAX_MESSAGE_SIZE = 57, /* RFC2132 */
DHO_DHCP_RENEWAL_TIME = 58, /* RFC2132 */
DHO_DHCP_REBINDING_TIME = 59, /* RFC2132 */
DHO_VENDOR_CLASS_IDENTIFIER = 60, /* RFC2132 */
DHO_DHCP_CLIENT_IDENTIFIER = 61, /* RFC2132 */
DHO_NWIP_DOMAIN_NAME = 62, /* RFC2242 */
DHO_NWIP_SUBOPTIONS = 63, /* RFC2242 */
DHO_NISP_DOMAIN_NAME = 64, /* RFC2132 */
DHO_NISP_SERVER_ADDR = 65, /* RFC2132 */
DHO_TFTP_SERVER_NAME = 66, /* RFC2132 */
DHO_BOOT_FILE_NAME = 67, /* RFC2132 */
DHO_HOME_AGENT_ADDRS = 68, /* RFC2132 */
DHO_SMTP_SERVER = 69, /* RFC2132 */
DHO_POP3_SERVER = 70, /* RFC2132 */
DHO_NNTP_SERVER = 71, /* RFC2132 */
DHO_WWW_SERVER = 72, /* RFC2132 */
DHO_FINGER_SERVER = 73, /* RFC2132 */
DHO_IRC_SERVER = 74, /* RFC2132 */
DHO_STREETTALK_SERVER = 75, /* RFC2132 */
DHO_STDASERVER = 76, /* RFC2132 */
DHO_USER_CLASS = 77, /* RFC3004 */
DHO_DIRECTORY_AGENT = 78, /* RFC2610 */
DHO_SERVICE_SCOPE = 79, /* RFC2610 */
// DHO_RAPID_COMMIT = 80, /* RFC4039 */
DHO_FQDN = 81, /* RFC4702 */
DHO_DHCP_AGENT_OPTIONS = 82, /* RFC3046 */
// DHO_ISNS = 83, /* RFC4174 */
// 84 is removed/unassigned
DHO_NDS_SERVERS = 85, /* RFC2241 */
DHO_NDS_TREE_NAME = 86, /* RFC2241 */
DHO_NDS_CONTEXT = 87, /* RFC2241 */
DHO_BCMCS_DOMAIN_NAME_LIST = 88, /* RFC4280 */
DHO_BCMCS_IPV4_ADDR = 89, /* RFC4280 */
DHO_AUTHENTICATE = 90, /* RFC3118 */
DHO_CLIENT_LAST_TRANSACTION_TIME = 91, /* RFC4388 */
DHO_ASSOCIATED_IP = 92, /* RFC4388 */
DHO_SYSTEM = 93, /* RFC4578 */
DHO_NDI = 94, /* RFC4578 */
// DHO_LDAP = 95, /* RFC3679 */
// 96 is removed/unassigned
DHO_UUID_GUID = 97, /* RFC4578 */
DHO_USER_AUTH = 98, /* RFC2485 */
DHO_GEOCONF_CIVIC = 99, /* RFC4776 */
DHO_PCODE = 100, /* RFC4833 */
DHO_TCODE = 101, /* RFC4833 */
// 102-107 are removed/unassigned
DHO_V6_ONLY_PREFERRED = 108, /* RFC8925 */
// 109-111 are removed/unassigned
DHO_NETINFO_ADDR = 112, /* RFC3679 */
DHO_NETINFO_TAG = 113, /* RFC3679 */
// URL option was replaced with captive portal.
// DHO_URL = 114, /* RFC3679 */
DHO_V4_CAPTIVE_PORTAL = 114, /* RFC8910 */
// 115 is removed/unassigned
DHO_AUTO_CONFIG = 116, /* RFC2563 */
DHO_NAME_SERVICE_SEARCH = 117, /* RFC2937 */
DHO_SUBNET_SELECTION = 118, /* RFC3011 */
DHO_DOMAIN_SEARCH = 119, /* RFC3397 */
// DHO_SIP_SERVERS = 120, /* RFC3361 */
DHO_CLASSLESS_STATIC_ROUTE = 121, /* RFC3442 */
// DHO_CCC = 122, /* RFC3495 */
// DHO_GEOCONF = 123, /* RFC6225 */
DHO_VIVCO_SUBOPTIONS = 124, /* RFC3925 */
DHO_VIVSO_SUBOPTIONS = 125, /* RFC3925 */
// 126-127 are removed/unassigned
// 128-135 have multiple definitions including PXE
DHO_PANA_AGENT = 136, /* RFC5192 */
DHO_V4_LOST = 137, /* RFC5223 */
DHO_CAPWAP_AC_V4 = 138, /* RFC5417 */
// DHO_IPV4_ADDR_MOS = 139, /* RFC5678 */
// DHO_IPV4_FQDN_MOS = 140, /* RFC5678 */
DHO_SIP_UA_CONF_SERVICE_DOMAINS = 141, /* RFC6011 */
// DHO_IPV4_ADDR_ANDSF = 142, /* RFC6153 */
DHO_V4_SZTP_REDIRECT = 143, /* RFC8572 */
// DHO_GEOLOC = 144, /* RFC6225 */
// DHO_FORCERENEW_NONCE_CAPABLE = 145, /* RFC6704 */
DHO_RDNSS_SELECT = 146, /* RFC6731 */
// 147-149 are removed/unassigned
// 150 have multiple definitions
DHO_STATUS_CODE = 151, /* RFC6926 */
DHO_BASE_TIME = 152, /* RFC6926 */
DHO_START_TIME_OF_STATE = 153, /* RFC6926 */
DHO_QUERY_START_TIME = 154, /* RFC6926 */
DHO_QUERY_END_TIME = 155, /* RFC6926 */
DHO_DHCP_STATE = 156, /* RFC6926 */
DHO_DATA_SOURCE = 157, /* RFC6926 */
// DHO_V4_PCP_SERVER = 158, /* RFC7291 */
DHO_V4_PORTPARAMS = 159, /* RFC7618 */
// 160 used to be assigned in RFC7710, but was removed in RFC8910
// The Captive Portal option now uses code 114.
// DHO_MUD_URL_V4 = 161, /* RFC8520 */
DHO_V4_DNR = 162, /* RFC9463 */
// 163-209 are removed/unassigned
// DHO_PATH_PREFIX = 210, /* RFC5071 */
// DHO_REBOOT_TIME = 211, /* RFC5071 */
DHO_6RD = 212, /* RFC5969 */
DHO_V4_ACCESS_DOMAIN = 213, /* RFC5986 */
// 214-219 are removed/unassigned
// DHO_SUBNET_ALLOC = 220, /* RFC6656 */
// DHO_VSS = 221, /* RFC6607 */
// 222-223 are removed/unassigned
// 224-254 are reserved for private use
DHO_END = 255 /* RFC2132 */
};
/* DHCP message types. */
enum DHCPMessageType {
DHCP_NOTYPE = 0, ///< Message Type option missing
DHCPDISCOVER = 1,
DHCPOFFER = 2,
DHCPREQUEST = 3,
DHCPDECLINE = 4,
DHCPACK = 5,
DHCPNAK = 6,
DHCPRELEASE = 7,
DHCPINFORM = 8,
// DHCPFORCERENEW = 9,
DHCPLEASEQUERY = 10,
DHCPLEASEUNASSIGNED = 11,
DHCPLEASEUNKNOWN = 12,
DHCPLEASEACTIVE = 13,
DHCPBULKLEASEQUERY = 14,
DHCPLEASEQUERYDONE = 15,
// DHCPACTIVELEASEQUERY = 16,
DHCPLEASEQUERYSTATUS = 17,
DHCPTLS = 18,
DHCP_TYPES_EOF
};
static const uint16_t DHCP4_CLIENT_PORT = 68;
static const uint16_t DHCP4_SERVER_PORT = 67;
/// Magic cookie validating dhcp options field (and bootp vendor
/// extensions field).
static const uint32_t DHCP_OPTIONS_COOKIE = 0x63825363;
/// Relay Agent Information suboption types.
enum RAISubOptionType {
RAI_OPTION_AGENT_CIRCUIT_ID = 1, // RFC3046
RAI_OPTION_REMOTE_ID = 2, // RFC3046
/* option 3 is reserved and will never be assigned */
RAI_OPTION_DOCSIS_DEVICE_CLASS = 4, // RFC3256
RAI_OPTION_LINK_SELECTION = 5, // RFC3527
RAI_OPTION_SUBSCRIBER_ID = 6, // RFC3993
RAI_OPTION_RADIUS = 7, // RFC4014
RAI_OPTION_AUTH = 8, // RFC4030
RAI_OPTION_VSI = 9, // RFC4243
RAI_OPTION_RELAY_FLAGS = 10, // RFC5010
RAI_OPTION_SERVER_ID_OVERRIDE = 11, // RFC5107
RAI_OPTION_RELAY_ID = 12, // RFC6925
RAI_OPTION_ACCESS_TECHNO_TYPE = 13, // RFC7839
RAI_OPTION_ACCESS_NETWORK_NAME = 14, // RFC7839
RAI_OPTION_ACCESS_POINT_NAME = 15, // RFC7839
RAI_OPTION_ACCESS_POINT_BSSID = 16, // RFC7839
RAI_OPTION_OPERATOR_ID = 17, // RFC7839
RAI_OPTION_OPERATOR_REALM = 18, // RFC7839
RAI_OPTION_RELAY_PORT = 19, // RFC8357
RAI_OPTION_VIRTUAL_SUBNET_SELECT = 151, // RFC6607
RAI_OPTION_VIRTUAL_SUBNET_SELECT_CTRL = 152 // RFC6607
};
// TODO: Following are leftovers from dhcp.h import from ISC DHCP
// They will be converted to C++-style defines once they will start
// to be used.
#if 0
/* FQDN suboptions: */
#define FQDN_NO_CLIENT_UPDATE 1
#define FQDN_SERVER_UPDATE 2
#define FQDN_ENCODED 3
#define FQDN_RCODE1 4
#define FQDN_RCODE2 5
#define FQDN_HOSTNAME 6
#define FQDN_DOMAINNAME 7
#define FQDN_FQDN 8
#define FQDN_SUBOPTION_COUNT 8
/* Enterprise Suboptions: */
#define VENDOR_ISC_SUBOPTIONS 2495
#endif
/* Client identifier types */
static const uint8_t CLIENT_ID_OPTION_TYPE_DUID = 255;
} // end of isc::dhcp namespace
} // end of isc namespace
#endif /* DHCP_H */
|