std_option_defs.h 28.2 KB
Newer Older
1
// Copyright (C) 2012-2019 Internet Systems Consortium, Inc. ("ISC")
2
//
3 4 5
// 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/.
6 7 8 9 10

#ifndef STD_OPTION_DEFS_H
#define STD_OPTION_DEFS_H

#include <dhcp/option_data_types.h>
11 12
#include <dhcp/dhcp4.h>
#include <dhcp/dhcp6.h>
13
#include <dhcp/option_space.h>
14

15 16 17 18
// NOTE:
// When adding a new space, make sure you also update
// src/lib/yang/adaptor_option.cc

19 20 21
namespace isc {
namespace dhcp {

22 23 24 25 26 27 28
namespace {

/// @brief Declare an array holding parameters used to create instance
/// of a definition for option comprising a record of data fields.
///
/// @param name name of the array being declared.
#ifndef RECORD_DECL
29
#define RECORD_DECL(name, ...) const OptionDataType name[] = { __VA_ARGS__ }
30 31 32 33 34 35 36 37 38 39
#endif

/// @brief A pair of values: one pointing to the array holding types of
/// data fields belonging to the record, and size of this array.
///
/// @param name name of the array holding data fields' types.
#ifndef RECORD_DEF
#define RECORD_DEF(name) name, sizeof(name) / sizeof(name[0])
#endif

40 41 42 43
#ifndef NO_RECORD_DEF
#define NO_RECORD_DEF 0, 0
#endif

44 45 46
// SLP Directory Agent option.
RECORD_DECL(DIRECTORY_AGENT_RECORDS, OPT_BOOLEAN_TYPE, OPT_IPV4_ADDRESS_TYPE);

47 48 49 50 51
// SLP Service Scope option.
//
// The scope list is optional.
RECORD_DECL(SERVICE_SCOPE_RECORDS, OPT_BOOLEAN_TYPE, OPT_STRING_TYPE);

52 53 54 55 56 57 58 59
// fqdn option record fields.
//
// Note that the flags field indicates the type of domain
// name encoding. There is a choice between deprecated
// ASCII encoding and compressed encoding described in
// RFC 1035, section 3.1. The latter could be handled
// by OPT_FQDN_TYPE but we can't use it here because
// clients may request ASCII encoding.
60 61
RECORD_DECL(FQDN_RECORDS, OPT_UINT8_TYPE, OPT_UINT8_TYPE, OPT_UINT8_TYPE,
            OPT_FQDN_TYPE);
62

63 64 65 66 67
// V-I Vendor Class record fields.
//
// Opaque data is represented here by the binary data field.
RECORD_DECL(VIVCO_RECORDS, OPT_UINT32_TYPE, OPT_BINARY_TYPE);

Shawn Routhier's avatar
Shawn Routhier committed
68 69
// RFC4578 (PXE) record fields
//
70
// Three 1 byte fields to describe a network interface: type, major and minor
Shawn Routhier's avatar
Shawn Routhier committed
71
RECORD_DECL(CLIENT_NDI_RECORDS, OPT_UINT8_TYPE, OPT_UINT8_TYPE, OPT_UINT8_TYPE);
Josh Soref's avatar
Josh Soref committed
72
// A client identifier: a 1 byte type field followed by opaque data depending on the type
Shawn Routhier's avatar
Shawn Routhier committed
73 74
RECORD_DECL(UUID_GUID_RECORDS, OPT_UINT8_TYPE, OPT_BINARY_TYPE);

75 76 77 78 79 80
// RFC6731 DHCPv4 Recursive DNS Server Selection option.
//
// Flag, two addresses and domain list
RECORD_DECL(V4_RDNSS_SELECT_RECORDS, OPT_UINT8_TYPE, OPT_IPV4_ADDRESS_TYPE,
            OPT_IPV4_ADDRESS_TYPE, OPT_FQDN_TYPE);

81 82 83
// RFC7618 DHCPv4 Port Parameter option.
//
// PSID offset, PSID-len and PSID
84
RECORD_DECL(V4_PORTPARAMS_RECORDS, OPT_UINT8_TYPE, OPT_PSID_TYPE);
85

86 87 88 89 90 91
// RFC5969 DHCPv6 6RD option.
//
// two 8 bit lengthes, an IPv6 address and one or more IPv4 addresses
RECORD_DECL(OPT_6RD_RECORDS, OPT_UINT8_TYPE, OPT_UINT8_TYPE,
            OPT_IPV6_ADDRESS_TYPE, OPT_IPV4_ADDRESS_TYPE);

92
/// @brief Definitions of standard DHCPv4 options.
93
const OptionDefParams STANDARD_V4_OPTION_DEFINITIONS[] = {
94
    { "subnet-mask", DHO_SUBNET_MASK, OPT_IPV4_ADDRESS_TYPE, false, NO_RECORD_DEF, "" },
95
    { "time-offset", DHO_TIME_OFFSET, OPT_INT32_TYPE, false, NO_RECORD_DEF, "" },
96 97
    { "routers", DHO_ROUTERS, OPT_IPV4_ADDRESS_TYPE, true, NO_RECORD_DEF, "" },
    { "time-servers", DHO_TIME_SERVERS, OPT_IPV4_ADDRESS_TYPE, true, NO_RECORD_DEF, "" },
98
    { "name-servers", DHO_NAME_SERVERS, OPT_IPV4_ADDRESS_TYPE,
99
      true, NO_RECORD_DEF, "" },
100
    { "domain-name-servers", DHO_DOMAIN_NAME_SERVERS,
101 102
      OPT_IPV4_ADDRESS_TYPE, true, NO_RECORD_DEF, "" },
    { "log-servers", DHO_LOG_SERVERS, OPT_IPV4_ADDRESS_TYPE, true, NO_RECORD_DEF, "" },
103
    { "cookie-servers", DHO_COOKIE_SERVERS, OPT_IPV4_ADDRESS_TYPE,
104 105 106
      true, NO_RECORD_DEF, "" },
    { "lpr-servers", DHO_LPR_SERVERS, OPT_IPV4_ADDRESS_TYPE, true, NO_RECORD_DEF, "" },
    { "impress-servers", DHO_IMPRESS_SERVERS, OPT_IPV4_ADDRESS_TYPE, true, NO_RECORD_DEF, "" },
107
    { "resource-location-servers", DHO_RESOURCE_LOCATION_SERVERS,
108 109 110 111
      OPT_IPV4_ADDRESS_TYPE, true, NO_RECORD_DEF, "" },
    { "host-name", DHO_HOST_NAME, OPT_STRING_TYPE, false, NO_RECORD_DEF, "" },
    { "boot-size", DHO_BOOT_SIZE, OPT_UINT16_TYPE, false, NO_RECORD_DEF, "" },
    { "merit-dump", DHO_MERIT_DUMP, OPT_STRING_TYPE, false, NO_RECORD_DEF, "" },
112
    { "domain-name", DHO_DOMAIN_NAME, OPT_STRING_TYPE, false, NO_RECORD_DEF, "" },
113 114
    { "swap-server", DHO_SWAP_SERVER, OPT_IPV4_ADDRESS_TYPE, false, NO_RECORD_DEF, "" },
    { "root-path", DHO_ROOT_PATH, OPT_STRING_TYPE, false, NO_RECORD_DEF, "" },
115
    { "extensions-path", DHO_EXTENSIONS_PATH, OPT_STRING_TYPE,
116 117
      false, NO_RECORD_DEF, "" },
    { "ip-forwarding", DHO_IP_FORWARDING, OPT_BOOLEAN_TYPE, false, NO_RECORD_DEF, "" },
118
    { "non-local-source-routing", DHO_NON_LOCAL_SOURCE_ROUTING,
119 120
      OPT_BOOLEAN_TYPE, false, NO_RECORD_DEF, "" },
    { "policy-filter", DHO_POLICY_FILTER, OPT_IPV4_ADDRESS_TYPE, true, NO_RECORD_DEF, "" },
121
    { "max-dgram-reassembly", DHO_MAX_DGRAM_REASSEMBLY,
122 123
      OPT_UINT16_TYPE, false, NO_RECORD_DEF, "" },
    { "default-ip-ttl", DHO_DEFAULT_IP_TTL, OPT_UINT8_TYPE, false, NO_RECORD_DEF, "" },
124
    { "path-mtu-aging-timeout", DHO_PATH_MTU_AGING_TIMEOUT,
125
      OPT_UINT32_TYPE, false, NO_RECORD_DEF, "" },
126
    { "path-mtu-plateau-table", DHO_PATH_MTU_PLATEAU_TABLE,
127 128
      OPT_UINT16_TYPE, true, NO_RECORD_DEF, "" },
    { "interface-mtu", DHO_INTERFACE_MTU, OPT_UINT16_TYPE, false, NO_RECORD_DEF, "" },
129
    { "all-subnets-local", DHO_ALL_SUBNETS_LOCAL,
130
      OPT_BOOLEAN_TYPE, false, NO_RECORD_DEF, "" },
131
    { "broadcast-address", DHO_BROADCAST_ADDRESS,
132
      OPT_IPV4_ADDRESS_TYPE, false, NO_RECORD_DEF, "" },
133
    { "perform-mask-discovery", DHO_PERFORM_MASK_DISCOVERY,
134 135
      OPT_BOOLEAN_TYPE, false, NO_RECORD_DEF, "" },
    { "mask-supplier", DHO_MASK_SUPPLIER, OPT_BOOLEAN_TYPE, false, NO_RECORD_DEF, "" },
136
    { "router-discovery", DHO_ROUTER_DISCOVERY,
137
      OPT_BOOLEAN_TYPE, false, NO_RECORD_DEF, "" },
138
    { "router-solicitation-address", DHO_ROUTER_SOLICITATION_ADDRESS,
139
      OPT_IPV4_ADDRESS_TYPE, false, NO_RECORD_DEF, "" },
140
    { "static-routes", DHO_STATIC_ROUTES,
141
      OPT_IPV4_ADDRESS_TYPE, true, NO_RECORD_DEF, "" },
142
    { "trailer-encapsulation", DHO_TRAILER_ENCAPSULATION,
143
      OPT_BOOLEAN_TYPE, false, NO_RECORD_DEF, "" },
144
    { "arp-cache-timeout", DHO_ARP_CACHE_TIMEOUT,
145
      OPT_UINT32_TYPE, false, NO_RECORD_DEF, "" },
146
    { "ieee802-3-encapsulation", DHO_IEEE802_3_ENCAPSULATION,
147 148
      OPT_BOOLEAN_TYPE, false, NO_RECORD_DEF, "" },
    { "default-tcp-ttl", DHO_DEFAULT_TCP_TTL, OPT_UINT8_TYPE, false, NO_RECORD_DEF, "" },
149
    { "tcp-keepalive-interval", DHO_TCP_KEEPALIVE_INTERVAL,
150
      OPT_UINT32_TYPE, false, NO_RECORD_DEF, "" },
151
    { "tcp-keepalive-garbage", DHO_TCP_KEEPALIVE_GARBAGE,
152 153 154 155
      OPT_BOOLEAN_TYPE, false, NO_RECORD_DEF, "" },
    { "nis-domain", DHO_NIS_DOMAIN, OPT_STRING_TYPE, false, NO_RECORD_DEF, "" },
    { "nis-servers", DHO_NIS_SERVERS, OPT_IPV4_ADDRESS_TYPE, true, NO_RECORD_DEF, "" },
    { "ntp-servers", DHO_NTP_SERVERS, OPT_IPV4_ADDRESS_TYPE, true, NO_RECORD_DEF, "" },
156
    /// vendor-encapsulated-options (43) is deferred
157
    { "netbios-name-servers", DHO_NETBIOS_NAME_SERVERS,
158
      OPT_IPV4_ADDRESS_TYPE, true, NO_RECORD_DEF, "" },
159
    { "netbios-dd-server", DHO_NETBIOS_DD_SERVER,
160
      OPT_IPV4_ADDRESS_TYPE, true, NO_RECORD_DEF, "" },
161
    { "netbios-node-type", DHO_NETBIOS_NODE_TYPE,
162 163 164
      OPT_UINT8_TYPE, false, NO_RECORD_DEF, "" },
    { "netbios-scope", DHO_NETBIOS_SCOPE, OPT_STRING_TYPE, false, NO_RECORD_DEF, "" },
    { "font-servers", DHO_FONT_SERVERS, OPT_IPV4_ADDRESS_TYPE, true, NO_RECORD_DEF, "" },
165
    { "x-display-manager", DHO_X_DISPLAY_MANAGER,
166
      OPT_IPV4_ADDRESS_TYPE, true, NO_RECORD_DEF, "" },
167
    { "dhcp-requested-address", DHO_DHCP_REQUESTED_ADDRESS,
168 169
      OPT_IPV4_ADDRESS_TYPE, false, NO_RECORD_DEF, "" },
    { "dhcp-lease-time", DHO_DHCP_LEASE_TIME, OPT_UINT32_TYPE, false, NO_RECORD_DEF, "" },
170
    { "dhcp-option-overload", DHO_DHCP_OPTION_OVERLOAD,
171 172
      OPT_UINT8_TYPE, false, NO_RECORD_DEF, "" },
    { "dhcp-message-type", DHO_DHCP_MESSAGE_TYPE, OPT_UINT8_TYPE, false, NO_RECORD_DEF, "" },
173
    { "dhcp-server-identifier", DHO_DHCP_SERVER_IDENTIFIER,
174
      OPT_IPV4_ADDRESS_TYPE, false, NO_RECORD_DEF, "" },
175
    { "dhcp-parameter-request-list", DHO_DHCP_PARAMETER_REQUEST_LIST,
176 177
      OPT_UINT8_TYPE, true, NO_RECORD_DEF, "" },
    { "dhcp-message", DHO_DHCP_MESSAGE, OPT_STRING_TYPE, false, NO_RECORD_DEF, "" },
178
    { "dhcp-max-message-size", DHO_DHCP_MAX_MESSAGE_SIZE,
179 180
      OPT_UINT16_TYPE, false, NO_RECORD_DEF, "" },
    { "dhcp-renewal-time", DHO_DHCP_RENEWAL_TIME, OPT_UINT32_TYPE, false, NO_RECORD_DEF, "" },
181
    { "dhcp-rebinding-time", DHO_DHCP_REBINDING_TIME,
182
      OPT_UINT32_TYPE, false, NO_RECORD_DEF, "" },
183
    { "vendor-class-identifier", DHO_VENDOR_CLASS_IDENTIFIER,
184
      OPT_STRING_TYPE, false, NO_RECORD_DEF, "" },
185
    { "dhcp-client-identifier", DHO_DHCP_CLIENT_IDENTIFIER,
186 187 188
      OPT_BINARY_TYPE, false, NO_RECORD_DEF, "" },
    { "nwip-domain-name", DHO_NWIP_DOMAIN_NAME, OPT_STRING_TYPE, false, NO_RECORD_DEF, "" },
    { "nwip-suboptions", DHO_NWIP_SUBOPTIONS, OPT_BINARY_TYPE, false, NO_RECORD_DEF, "" },
189 190
    { "nisplus-domain-name", DHO_NISP_DOMAIN_NAME, OPT_STRING_TYPE, false, NO_RECORD_DEF, "" },
    { "nisplus-servers", DHO_NISP_SERVER_ADDR, OPT_IPV4_ADDRESS_TYPE, true, NO_RECORD_DEF, "" },
191 192 193 194
    { "tftp-server-name", DHO_TFTP_SERVER_NAME, OPT_STRING_TYPE, false,
      NO_RECORD_DEF, "" },
    { "boot-file-name", DHO_BOOT_FILE_NAME, OPT_STRING_TYPE, false,
      NO_RECORD_DEF, "" },
195 196 197 198 199 200 201 202 203
    { "mobile-ip-home-agent", DHO_HOME_AGENT_ADDRS, OPT_IPV4_ADDRESS_TYPE, true, NO_RECORD_DEF, "" },
    { "smtp-server", DHO_SMTP_SERVER, OPT_IPV4_ADDRESS_TYPE, true, NO_RECORD_DEF, "" },
    { "pop-server", DHO_POP3_SERVER, OPT_IPV4_ADDRESS_TYPE, true, NO_RECORD_DEF, "" },
    { "nntp-server", DHO_NNTP_SERVER, OPT_IPV4_ADDRESS_TYPE, true, NO_RECORD_DEF, "" },
    { "www-server", DHO_WWW_SERVER, OPT_IPV4_ADDRESS_TYPE, true, NO_RECORD_DEF, "" },
    { "finger-server", DHO_FINGER_SERVER, OPT_IPV4_ADDRESS_TYPE, true, NO_RECORD_DEF, "" },
    { "irc-server", DHO_IRC_SERVER, OPT_IPV4_ADDRESS_TYPE, true, NO_RECORD_DEF, "" },
    { "streettalk-server", DHO_STREETTALK_SERVER, OPT_IPV4_ADDRESS_TYPE, true, NO_RECORD_DEF, "" },
    { "streettalk-directory-assistance-server", DHO_STDASERVER, OPT_IPV4_ADDRESS_TYPE, true, NO_RECORD_DEF, "" },
204
    { "user-class", DHO_USER_CLASS, OPT_BINARY_TYPE, false, NO_RECORD_DEF, "" },
205 206
    { "slp-directory-agent", DHO_DIRECTORY_AGENT, OPT_RECORD_TYPE, true,
      RECORD_DEF(DIRECTORY_AGENT_RECORDS), "" },
207 208
    { "slp-service-scope", DHO_SERVICE_SCOPE, OPT_RECORD_TYPE, false,
      RECORD_DEF(SERVICE_SCOPE_RECORDS), "" },
209
    { "fqdn", DHO_FQDN, OPT_RECORD_TYPE, false, RECORD_DEF(FQDN_RECORDS), "" },
210
    { "dhcp-agent-options", DHO_DHCP_AGENT_OPTIONS,
211
      OPT_EMPTY_TYPE, false, NO_RECORD_DEF, DHCP_AGENT_OPTION_SPACE },
212 213 214 215 216
    { "nds-servers", DHO_NDS_SERVERS, OPT_IPV4_ADDRESS_TYPE, true, NO_RECORD_DEF, "" },
    { "nds-tree-name", DHO_NDS_TREE_NAME, OPT_STRING_TYPE, false, NO_RECORD_DEF, "" },
    { "nds-context", DHO_NDS_CONTEXT, OPT_STRING_TYPE, false, NO_RECORD_DEF, "" },
    { "bcms-controller-names", DHO_BCMCS_DOMAIN_NAME_LIST, OPT_FQDN_TYPE, true, NO_RECORD_DEF, "" },
    { "bcms-controller-address", DHO_BCMCS_IPV4_ADDR, OPT_IPV4_ADDRESS_TYPE, true, NO_RECORD_DEF, "" },
217 218 219 220 221 222
    // Unfortunatelly the AUTHENTICATE option contains a 64-bit
    // data field called 'replay-detection' that can't be added
    // as a record field to a custom option. Also, there is no
    // dedicated option class to handle it so we simply return
    // binary option type for now.
    // @todo implement a class to handle AUTH option.
223
    { "authenticate", DHO_AUTHENTICATE, OPT_BINARY_TYPE, false, NO_RECORD_DEF, "" },
224
    { "client-last-transaction-time", DHO_CLIENT_LAST_TRANSACTION_TIME,
225 226
      OPT_UINT32_TYPE, false, NO_RECORD_DEF, "" },
    { "associated-ip", DHO_ASSOCIATED_IP, OPT_IPV4_ADDRESS_TYPE, true, NO_RECORD_DEF, "" },
Shawn Routhier's avatar
Shawn Routhier committed
227 228 229
    { "client-system", DHO_SYSTEM, OPT_UINT16_TYPE, true, NO_RECORD_DEF, "" },
    { "client-ndi", DHO_NDI, OPT_RECORD_TYPE, false, RECORD_DEF(CLIENT_NDI_RECORDS), "" },
    { "uuid-guid", DHO_UUID_GUID, OPT_RECORD_TYPE, false, RECORD_DEF(UUID_GUID_RECORDS), "" },
230 231 232 233 234 235 236 237 238
    { "uap-servers", DHO_USER_AUTH, OPT_STRING_TYPE, false, NO_RECORD_DEF, "" },
    { "geoconf-civic", DHO_GEOCONF_CIVIC, OPT_BINARY_TYPE, false, NO_RECORD_DEF, "" },
    { "pcode", DHO_PCODE, OPT_STRING_TYPE, false, NO_RECORD_DEF, "" },
    { "tcode", DHO_TCODE, OPT_STRING_TYPE, false, NO_RECORD_DEF, "" },
    { "netinfo-server-address", DHO_NETINFO_ADDR, OPT_IPV4_ADDRESS_TYPE, true, NO_RECORD_DEF, "" },
    { "netinfo-server-tag", DHO_NETINFO_TAG, OPT_STRING_TYPE, false, NO_RECORD_DEF, "" },
    { "default-url", DHO_URL, OPT_STRING_TYPE, false, NO_RECORD_DEF, "" },
    { "auto-config", DHO_AUTO_CONFIG, OPT_UINT8_TYPE, false, NO_RECORD_DEF, "" },
    { "name-service-search", DHO_NAME_SERVICE_SEARCH, OPT_UINT16_TYPE, true, NO_RECORD_DEF, "" },
239
    { "subnet-selection", DHO_SUBNET_SELECTION,
240
      OPT_IPV4_ADDRESS_TYPE, false, NO_RECORD_DEF, "" },
241
    { "domain-search", DHO_DOMAIN_SEARCH, OPT_FQDN_TYPE, true, NO_RECORD_DEF, "" },
242 243
    { "vivco-suboptions", DHO_VIVCO_SUBOPTIONS, OPT_RECORD_TYPE,
      false, RECORD_DEF(VIVCO_RECORDS), "" },
244 245 246 247 248 249 250 251 252 253 254 255
    // Vendor-Identifying Vendor Specific Information option payload begins with a
    // 32-bit log enterprise number, followed by a tuple of data-len/option-data.
    // The format defined here includes 32-bit field holding enterprise number.
    // This allows for specifying option-data information where the enterprise-id
    // is represented by a uint32_t value. Previously we represented this option
    // as a binary, but that would imply that enterprise number would have to be
    // represented in binary format in the server configuration. That would be
    // inconvenient and non-intuitive.
    /// @todo We need to extend support for vendor options with ability to specify
    /// multiple enterprise numbers for a single option. Perhaps it would be
    /// ok to specify multiple instances of the "vivso-suboptions" which will be
    /// combined in a single option by the server before responding to a client.
256
    { "vivso-suboptions", DHO_VIVSO_SUBOPTIONS, OPT_UINT32_TYPE,
257 258 259 260 261
      false, NO_RECORD_DEF, "" },
    { "pana-agent", DHO_PANA_AGENT, OPT_IPV4_ADDRESS_TYPE, true, NO_RECORD_DEF, "" },
    { "v4-lost", DHO_V4_LOST, OPT_FQDN_TYPE, false, NO_RECORD_DEF, "" },
    { "capwap-ac-v4", DHO_CAPWAP_AC_V4, OPT_IPV4_ADDRESS_TYPE, true, NO_RECORD_DEF, "" },
    { "sip-ua-cs-domains", DHO_SIP_UA_CONF_SERVICE_DOMAINS, OPT_FQDN_TYPE, true, NO_RECORD_DEF, "" },
262 263
    { "rdnss-selection", DHO_RDNSS_SELECT, OPT_RECORD_TYPE, true,
      RECORD_DEF(V4_RDNSS_SELECT_RECORDS), "" },
264 265 266
    { "v4-portparams", DHO_V4_PORTPARAMS, OPT_RECORD_TYPE, false,
      RECORD_DEF(V4_PORTPARAMS_RECORDS), "" },
    { "v4-captive-portal", DHO_V4_CAPTIVE_PORTAL, OPT_STRING_TYPE, false, NO_RECORD_DEF, "" },
267
    { "option-6rd", DHO_6RD, OPT_RECORD_TYPE, true, RECORD_DEF(OPT_6RD_RECORDS), "" },
268
    { "v4-access-domain", DHO_V4_ACCESS_DOMAIN, OPT_FQDN_TYPE, false, NO_RECORD_DEF, "" }
269

Andrei Pavel's avatar
Andrei Pavel committed
270
        // @todo add definitions for all remaining options.
271 272 273
};

/// Number of option definitions defined.
274
const int STANDARD_V4_OPTION_DEFINITIONS_SIZE =
275 276
    sizeof(STANDARD_V4_OPTION_DEFINITIONS) /
    sizeof(STANDARD_V4_OPTION_DEFINITIONS[0]);
277

278 279
/// Last resort definitions (only option 43 for now, these definitions
/// are applied in deferred unpacking when none is found).
Francis Dupont's avatar
Francis Dupont committed
280 281
const OptionDefParams LAST_RESORT_V4_OPTION_DEFINITIONS[] = {
    { "vendor-encapsulated-options", DHO_VENDOR_ENCAPSULATED_OPTIONS,
282
      OPT_EMPTY_TYPE, false, NO_RECORD_DEF, VENDOR_ENCAPSULATED_OPTION_SPACE }
283 284
};

285 286 287
const int LAST_RESORT_V4_OPTION_DEFINITIONS_SIZE =
    sizeof(LAST_RESORT_V4_OPTION_DEFINITIONS) /
    sizeof(LAST_RESORT_V4_OPTION_DEFINITIONS[0]);
Francis Dupont's avatar
Francis Dupont committed
288

289 290
/// Start Definition of DHCPv6 options

291
// client-fqdn
292
RECORD_DECL(CLIENT_FQDN_RECORDS, OPT_UINT8_TYPE, OPT_FQDN_TYPE);
293
// geoconf-civic
294
RECORD_DECL(GEOCONF_CIVIC_RECORDS, OPT_UINT8_TYPE, OPT_UINT16_TYPE,
295 296
            OPT_BINARY_TYPE);
// iaddr
297
RECORD_DECL(IAADDR_RECORDS, OPT_IPV6_ADDRESS_TYPE, OPT_UINT32_TYPE,
298 299
            OPT_UINT32_TYPE);
// ia-na
300
RECORD_DECL(IA_NA_RECORDS, OPT_UINT32_TYPE, OPT_UINT32_TYPE, OPT_UINT32_TYPE);
301
// ia-pd
302
RECORD_DECL(IA_PD_RECORDS, OPT_UINT32_TYPE, OPT_UINT32_TYPE, OPT_UINT32_TYPE);
303
// ia-prefix
304
RECORD_DECL(IA_PREFIX_RECORDS, OPT_UINT32_TYPE, OPT_UINT32_TYPE,
305
            OPT_UINT8_TYPE, OPT_IPV6_ADDRESS_TYPE);
306
// lq-query
307
RECORD_DECL(LQ_QUERY_RECORDS, OPT_UINT8_TYPE, OPT_IPV6_ADDRESS_TYPE);
308
// lq-relay-data
309
RECORD_DECL(LQ_RELAY_DATA_RECORDS, OPT_IPV6_ADDRESS_TYPE, OPT_BINARY_TYPE);
310
// remote-id
311
RECORD_DECL(REMOTE_ID_RECORDS, OPT_UINT32_TYPE, OPT_BINARY_TYPE);
312 313 314 315 316 317 318
// s46-rule
RECORD_DECL(S46_RULE, OPT_UINT8_TYPE, OPT_UINT8_TYPE, OPT_UINT8_TYPE,
            OPT_IPV4_ADDRESS_TYPE, OPT_IPV6_PREFIX_TYPE);
// s46-v4v6bind
RECORD_DECL(S46_V4V6BIND, OPT_IPV4_ADDRESS_TYPE, OPT_IPV6_PREFIX_TYPE);
// s46-portparams
RECORD_DECL(S46_PORTPARAMS, OPT_UINT8_TYPE, OPT_PSID_TYPE);
319
// status-code
320
RECORD_DECL(STATUS_CODE_RECORDS, OPT_UINT16_TYPE, OPT_STRING_TYPE);
321
// vendor-class
322
RECORD_DECL(VENDOR_CLASS_RECORDS, OPT_UINT32_TYPE, OPT_BINARY_TYPE);
323 324 325
// rdnss-selection
RECORD_DECL(V6_RDNSS_SELECT_RECORDS, OPT_IPV6_ADDRESS_TYPE, OPT_UINT8_TYPE,
            OPT_FQDN_TYPE);
326 327 328
// sedhcpv6 signature
RECORD_DECL(SIGNATURE_RECORDS, OPT_UINT8_TYPE, OPT_UINT8_TYPE,
            OPT_BINARY_TYPE);
329

Shawn Routhier's avatar
Shawn Routhier committed
330 331 332 333 334
// RFC5970 (PXE) Class record fields
//
// Three 1 byte fileds to describe a network interface: type, major and minor
RECORD_DECL(CLIENT_NII_RECORDS, OPT_UINT8_TYPE, OPT_UINT8_TYPE, OPT_UINT8_TYPE);

335
/// Standard DHCPv6 option definitions.
336 337 338
///
/// @warning in this array, the initializers are provided for all
/// OptionDefParams struct's members despite initializers for
Andrei Pavel's avatar
Andrei Pavel committed
339
/// 'records' and 'record_size' could be omitted for entries for
340
/// which 'type' does not equal to OPT_RECORD_TYPE. If initializers
Andrei Pavel's avatar
Andrei Pavel committed
341
/// are omitted the corresponding values should default to 0.
342 343 344
/// This however does not work on Solaris (GCC) which issues a
/// warning about lack of initializers for some struct members
/// causing build to fail.
345
const OptionDefParams STANDARD_V6_OPTION_DEFINITIONS[] = {
346 347 348 349 350 351 352 353 354
    { "clientid", D6O_CLIENTID, OPT_BINARY_TYPE, false, NO_RECORD_DEF, "" },
    { "serverid", D6O_SERVERID, OPT_BINARY_TYPE, false, NO_RECORD_DEF, "" },
    { "ia-na", D6O_IA_NA, OPT_RECORD_TYPE, false, RECORD_DEF(IA_NA_RECORDS), "" },
    { "ia-ta", D6O_IA_TA, OPT_UINT32_TYPE, false, NO_RECORD_DEF, "" },
    { "iaaddr", D6O_IAADDR, OPT_RECORD_TYPE, false, RECORD_DEF(IAADDR_RECORDS), "" },
    { "oro", D6O_ORO, OPT_UINT16_TYPE, true, NO_RECORD_DEF, "" },
    { "preference", D6O_PREFERENCE, OPT_UINT8_TYPE, false, NO_RECORD_DEF, "" },
    { "elapsed-time", D6O_ELAPSED_TIME, OPT_UINT16_TYPE, false, NO_RECORD_DEF, "" },
    { "relay-msg", D6O_RELAY_MSG, OPT_BINARY_TYPE, false, NO_RECORD_DEF, "" },
Josh Soref's avatar
Josh Soref committed
355
    // Unfortunately the AUTH option contains a 64-bit data field
356 357 358 359 360
    // called 'replay-detection' that can't be added as a record
    // field to a custom option. Also, there is no dedicated
    // option class to handle it so we simply return binary
    // option type for now.
    // @todo implement a class to handle AUTH option.
361 362
    { "auth", D6O_AUTH, OPT_BINARY_TYPE, false, NO_RECORD_DEF, "" },
    { "unicast", D6O_UNICAST, OPT_IPV6_ADDRESS_TYPE, false, NO_RECORD_DEF, "" },
363
    { "status-code", D6O_STATUS_CODE, OPT_RECORD_TYPE, false,
364 365 366
      RECORD_DEF(STATUS_CODE_RECORDS), "" },
    { "rapid-commit", D6O_RAPID_COMMIT, OPT_EMPTY_TYPE, false, NO_RECORD_DEF, "" },
    { "user-class", D6O_USER_CLASS, OPT_BINARY_TYPE, false, NO_RECORD_DEF, "" },
367
    { "vendor-class", D6O_VENDOR_CLASS, OPT_RECORD_TYPE, false,
368 369
      RECORD_DEF(VENDOR_CLASS_RECORDS), "" },
    { "vendor-opts", D6O_VENDOR_OPTS, OPT_UINT32_TYPE, false,
370
      NO_RECORD_DEF, VENDOR_OPTION_SPACE },
371 372
    { "interface-id", D6O_INTERFACE_ID, OPT_BINARY_TYPE, false, NO_RECORD_DEF, "" },
    { "reconf-msg", D6O_RECONF_MSG, OPT_UINT8_TYPE, false, NO_RECORD_DEF, "" },
373
    { "reconf-accept", D6O_RECONF_ACCEPT, OPT_EMPTY_TYPE, false,
374
      NO_RECORD_DEF, "" },
375
    { "sip-server-dns", D6O_SIP_SERVERS_DNS, OPT_FQDN_TYPE, true,
376
      NO_RECORD_DEF, "" },
377
    { "sip-server-addr", D6O_SIP_SERVERS_ADDR, OPT_IPV6_ADDRESS_TYPE, true,
378
      NO_RECORD_DEF, "" },
379
    { "dns-servers", D6O_NAME_SERVERS, OPT_IPV6_ADDRESS_TYPE, true,
380 381 382
      NO_RECORD_DEF, "" },
    { "domain-search", D6O_DOMAIN_SEARCH, OPT_FQDN_TYPE, true, NO_RECORD_DEF, "" },
    { "ia-pd", D6O_IA_PD, OPT_RECORD_TYPE, false, RECORD_DEF(IA_PD_RECORDS), "" },
383
    { "iaprefix", D6O_IAPREFIX, OPT_RECORD_TYPE, false,
384
      RECORD_DEF(IA_PREFIX_RECORDS), "" },
385
    { "nis-servers", D6O_NIS_SERVERS, OPT_IPV6_ADDRESS_TYPE, true,
386
      NO_RECORD_DEF, "" },
387
    { "nisp-servers", D6O_NISP_SERVERS, OPT_IPV6_ADDRESS_TYPE, true,
388
      NO_RECORD_DEF, "" },
389
    { "nis-domain-name", D6O_NIS_DOMAIN_NAME, OPT_FQDN_TYPE, true,
390
      NO_RECORD_DEF, "" },
391
    { "nisp-domain-name", D6O_NISP_DOMAIN_NAME, OPT_FQDN_TYPE, true,
392
      NO_RECORD_DEF, "" },
393
    { "sntp-servers", D6O_SNTP_SERVERS, OPT_IPV6_ADDRESS_TYPE, true,
394
      NO_RECORD_DEF, "" },
395
    { "information-refresh-time", D6O_INFORMATION_REFRESH_TIME,
396
      OPT_UINT32_TYPE, false, NO_RECORD_DEF, "" },
397
    { "bcmcs-server-dns", D6O_BCMCS_SERVER_D, OPT_FQDN_TYPE, true,
398
      NO_RECORD_DEF, "" },
399
    { "bcmcs-server-addr", D6O_BCMCS_SERVER_A, OPT_IPV6_ADDRESS_TYPE, true,
400
      NO_RECORD_DEF, "" },
401
    { "geoconf-civic", D6O_GEOCONF_CIVIC, OPT_RECORD_TYPE, false,
402
      RECORD_DEF(GEOCONF_CIVIC_RECORDS), "" },
403
    { "remote-id", D6O_REMOTE_ID, OPT_RECORD_TYPE, false,
404
      RECORD_DEF(REMOTE_ID_RECORDS), "" },
405
    { "subscriber-id", D6O_SUBSCRIBER_ID, OPT_BINARY_TYPE, false,
406
      NO_RECORD_DEF, "" },
407
    { "client-fqdn", D6O_CLIENT_FQDN, OPT_RECORD_TYPE, false,
408
      RECORD_DEF(CLIENT_FQDN_RECORDS), "" },
409
    { "pana-agent", D6O_PANA_AGENT, OPT_IPV6_ADDRESS_TYPE, true,
410
      NO_RECORD_DEF, "" },
411
    { "new-posix-timezone", D6O_NEW_POSIX_TIMEZONE, OPT_STRING_TYPE, false,
412
      NO_RECORD_DEF, "" },
413
    { "new-tzdb-timezone", D6O_NEW_TZDB_TIMEZONE, OPT_STRING_TYPE, false,
414 415
      NO_RECORD_DEF, "" },
    { "ero", D6O_ERO, OPT_UINT16_TYPE, true, NO_RECORD_DEF, "" },
416
    { "lq-query", D6O_LQ_QUERY, OPT_RECORD_TYPE, false,
417 418 419
      RECORD_DEF(LQ_QUERY_RECORDS), "" },
    { "client-data", D6O_CLIENT_DATA, OPT_EMPTY_TYPE, false, NO_RECORD_DEF, "" },
    { "clt-time", D6O_CLT_TIME, OPT_UINT32_TYPE, false, NO_RECORD_DEF, "" },
420
    { "lq-relay-data", D6O_LQ_RELAY_DATA, OPT_RECORD_TYPE, false,
421
      RECORD_DEF(LQ_RELAY_DATA_RECORDS), "" },
422
    { "lq-client-link", D6O_LQ_CLIENT_LINK, OPT_IPV6_ADDRESS_TYPE, true,
423
      NO_RECORD_DEF, "" },
424 425 426 427 428 429 430
    { "v6-lost", D6O_V6_LOST, OPT_FQDN_TYPE, false, NO_RECORD_DEF, "" },
    { "capwap-ac-v6", D6O_CAPWAP_AC_V6, OPT_IPV6_ADDRESS_TYPE, true,
      NO_RECORD_DEF, "" },
    { "relay-id", D6O_RELAY_ID, OPT_BINARY_TYPE, false, NO_RECORD_DEF, "" },
    { "v6-access-domain", D6O_V6_ACCESS_DOMAIN, OPT_FQDN_TYPE, false,
      NO_RECORD_DEF, "" },
    { "sip-ua-cs-list", D6O_SIP_UA_CS_LIST, OPT_FQDN_TYPE, true,
431
      NO_RECORD_DEF, "" },
Shawn Routhier's avatar
Shawn Routhier committed
432
    { "bootfile-url", D6O_BOOTFILE_URL, OPT_STRING_TYPE, false, NO_RECORD_DEF, "" },
433
    { "bootfile-param", D6O_BOOTFILE_PARAM, OPT_TUPLE_TYPE, true, NO_RECORD_DEF, "" },
Shawn Routhier's avatar
Shawn Routhier committed
434 435
    { "client-arch-type", D6O_CLIENT_ARCH_TYPE, OPT_UINT16_TYPE, true, NO_RECORD_DEF, "" },
    { "nii", D6O_NII, OPT_RECORD_TYPE, false, RECORD_DEF(CLIENT_NII_RECORDS), "" },
436
    { "aftr-name", D6O_AFTR_NAME, OPT_FQDN_TYPE, false, NO_RECORD_DEF, "" },
437 438
    { "erp-local-domain-name", D6O_ERP_LOCAL_DOMAIN_NAME, OPT_FQDN_TYPE, false,
      NO_RECORD_DEF, "" },
439
    { "rsoo", D6O_RSOO, OPT_EMPTY_TYPE, false, NO_RECORD_DEF, "rsoo-opts" },
440
    { "pd-exclude", D6O_PD_EXCLUDE, OPT_IPV6_PREFIX_TYPE, false, NO_RECORD_DEF, "" },
441 442
    { "rdnss-selection", D6O_RDNSS_SELECTION, OPT_RECORD_TYPE, true,
      RECORD_DEF(V6_RDNSS_SELECT_RECORDS), "" },
443
    { "client-linklayer-addr", D6O_CLIENT_LINKLAYER_ADDR, OPT_BINARY_TYPE, false,
444
      NO_RECORD_DEF, "" },
445 446 447 448
    { "link-address", D6O_LINK_ADDRESS, OPT_IPV6_ADDRESS_TYPE, false,
      NO_RECORD_DEF, "" },
    { "solmax-rt", D6O_SOL_MAX_RT, OPT_UINT32_TYPE, false, NO_RECORD_DEF, "" },
    { "inf-max-rt", D6O_INF_MAX_RT, OPT_UINT32_TYPE, false, NO_RECORD_DEF, "" },
449 450 451
    { "dhcpv4-message", D6O_DHCPV4_MSG, OPT_BINARY_TYPE, false, NO_RECORD_DEF, "" },
    { "dhcp4o6-server-addr", D6O_DHCPV4_O_DHCPV6_SERVER, OPT_IPV6_ADDRESS_TYPE, true,
      NO_RECORD_DEF, "" },
452 453
    { "v6-captive-portal", D6O_V6_CAPTIVE_PORTAL, OPT_STRING_TYPE, false,
      NO_RECORD_DEF, "" },
454
    { "relay-source-port", D6O_RELAY_SOURCE_PORT, OPT_UINT16_TYPE, false, NO_RECORD_DEF, "" },
455 456
    { "ipv6-address-andsf", D6O_IPV6_ADDRESS_ANDSF, OPT_IPV6_ADDRESS_TYPE, true,
      NO_RECORD_DEF, "" },
457 458 459 460 461 462
    { "s46-cont-mape", D6O_S46_CONT_MAPE, OPT_EMPTY_TYPE, false, NO_RECORD_DEF,
        MAPE_V6_OPTION_SPACE },
    { "s46-cont-mapt", D6O_S46_CONT_MAPT, OPT_EMPTY_TYPE, false, NO_RECORD_DEF,
        MAPT_V6_OPTION_SPACE },
    { "s46-cont-lw", D6O_S46_CONT_LW, OPT_EMPTY_TYPE, false, NO_RECORD_DEF,
        LW_V6_OPTION_SPACE }
463 464 465 466 467 468

    // @todo There is still a bunch of options for which we have to provide
    // definitions but we don't do it because they are not really
    // critical right now.
};

469
/// Number of option definitions defined.
470 471 472 473
const int STANDARD_V6_OPTION_DEFINITIONS_SIZE =
    sizeof(STANDARD_V6_OPTION_DEFINITIONS) /
    sizeof(STANDARD_V6_OPTION_DEFINITIONS[0]);

474 475 476 477 478 479 480 481
// Option definitions that belong to two or more option spaces are defined here.
const OptionDefParams OPTION_DEF_PARAMS_S46_BR = { "s46-br", D6O_S46_BR,
    OPT_IPV6_ADDRESS_TYPE, false, NO_RECORD_DEF, "" };
const OptionDefParams OPTION_DEF_PARAMS_S46_RULE = { "s46-rule", D6O_S46_RULE,
    OPT_RECORD_TYPE, false, RECORD_DEF(S46_RULE), V4V6_RULE_OPTION_SPACE };
const OptionDefParams OPTION_DEF_PARAMS_S46_PORTPARAMS = { "s46-portparams",
    D6O_S46_PORTPARAMS, OPT_RECORD_TYPE, false, RECORD_DEF(S46_PORTPARAMS), "" };

482 483
/// @brief Definitions of vendor-specific DHCPv6 options, defined by ISC.
/// 4o6-* options are used for inter-process communication. For details, see
484
/// https://gitlab.isc.org/isc-projects/kea/wikis/designs/dhcpv4o6-design
485 486 487
///
/// @todo: As those options are defined by ISC, they do not belong in std_option_defs.h.
///        We need to move them to a separate file, e.g. isc_option_defs.h
488 489 490 491
const OptionDefParams ISC_V6_OPTION_DEFINITIONS[] = {
    { "4o6-interface", ISC_V6_4O6_INTERFACE, OPT_STRING_TYPE, false,
        NO_RECORD_DEF, "" },
    { "4o6-source-address", ISC_V6_4O6_SRC_ADDRESS, OPT_IPV6_ADDRESS_TYPE,
492 493 494
        false, NO_RECORD_DEF, "" },
    { "4o6-source-port", ISC_V6_4O6_SRC_PORT, OPT_UINT16_TYPE, false,
        NO_RECORD_DEF, "" }
495 496 497 498 499 500 501 502
};

const int ISC_V6_OPTION_DEFINITIONS_SIZE =
    sizeof(ISC_V6_OPTION_DEFINITIONS) /
    sizeof(ISC_V6_OPTION_DEFINITIONS[0]);

/// @brief MAPE option definitions
const OptionDefParams MAPE_V6_OPTION_DEFINITIONS[] = {
503 504
    OPTION_DEF_PARAMS_S46_BR,
    OPTION_DEF_PARAMS_S46_RULE
505 506 507 508
};

const int MAPE_V6_OPTION_DEFINITIONS_SIZE =
    sizeof(MAPE_V6_OPTION_DEFINITIONS) /
509
    sizeof(MAPE_V6_OPTION_DEFINITIONS[0]);
510 511 512

/// @brief MAPT option definitions
const OptionDefParams MAPT_V6_OPTION_DEFINITIONS[] = {
513 514
    OPTION_DEF_PARAMS_S46_RULE,
    { "s46-dmr", D6O_S46_DMR, OPT_IPV6_PREFIX_TYPE, false, NO_RECORD_DEF, "" }
515 516 517 518
};

const int MAPT_V6_OPTION_DEFINITIONS_SIZE =
    sizeof(MAPT_V6_OPTION_DEFINITIONS) /
519
    sizeof(MAPT_V6_OPTION_DEFINITIONS[0]);
520 521 522

/// @brief LW option definitions
const OptionDefParams LW_V6_OPTION_DEFINITIONS[] = {
523 524 525
    OPTION_DEF_PARAMS_S46_BR,
    { "s46-v4v6bind", D6O_S46_V4V6BIND, OPT_RECORD_TYPE, false,
        RECORD_DEF(S46_V4V6BIND), V4V6_BIND_OPTION_SPACE }
526 527 528 529
};

const int LW_V6_OPTION_DEFINITIONS_SIZE =
    sizeof(LW_V6_OPTION_DEFINITIONS) /
530
    sizeof(LW_V6_OPTION_DEFINITIONS[0]);
531 532 533

/// @brief Rule option definitions
const OptionDefParams V4V6_RULE_OPTION_DEFINITIONS[] = {
534
    OPTION_DEF_PARAMS_S46_PORTPARAMS
535 536 537 538
};

const int V4V6_RULE_OPTION_DEFINITIONS_SIZE =
    sizeof(V4V6_RULE_OPTION_DEFINITIONS) /
539
    sizeof(V4V6_RULE_OPTION_DEFINITIONS[0]);
540 541 542

/// @brief Bind option definitions
const OptionDefParams V4V6_BIND_OPTION_DEFINITIONS[] = {
543
    OPTION_DEF_PARAMS_S46_PORTPARAMS
544 545
};

546 547
const int V4V6_BIND_OPTION_DEFINITIONS_SIZE =
    sizeof(V4V6_BIND_OPTION_DEFINITIONS) /
548
    sizeof(V4V6_BIND_OPTION_DEFINITIONS[0]);
549

550
}  // namespace
551

552 553
}  // namespace dhcp
}  // namespace isc
554 555

#endif // STD_OPTION_DEFS_H