summaryrefslogtreecommitdiff
path: root/src/core/dhcp/nm-dhcp-options.h
blob: fcc6f9cd08fcbb2e7c757b7402b9e43a6ef41179 (plain)
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
/* SPDX-License-Identifier: LGPL-2.1-or-later */
/*
 * Copyright (C) 2019 Red Hat, Inc.
 */

#ifndef __NM_DHCP_OPTIONS_H__
#define __NM_DHCP_OPTIONS_H__

typedef enum {
    NM_DHCP_OPTION_DHCP4_PAD                            = 0,
    NM_DHCP_OPTION_DHCP4_SUBNET_MASK                    = 1,
    NM_DHCP_OPTION_DHCP4_TIME_OFFSET                    = 2,
    NM_DHCP_OPTION_DHCP4_ROUTER                         = 3,
    NM_DHCP_OPTION_DHCP4_TIME_SERVERS                   = 4,
    NM_DHCP_OPTION_DHCP4_IEN116_NAME_SERVERS            = 5,
    NM_DHCP_OPTION_DHCP4_DOMAIN_NAME_SERVER             = 6,
    NM_DHCP_OPTION_DHCP4_LOG_SERVERS                    = 7,
    NM_DHCP_OPTION_DHCP4_COOKIE_SERVERS                 = 8,
    NM_DHCP_OPTION_DHCP4_LPR_SERVERS                    = 9,
    NM_DHCP_OPTION_DHCP4_IMPRESS_SERVERS                = 10,
    NM_DHCP_OPTION_DHCP4_RESOURCE_LOCATION_SERVERS      = 11,
    NM_DHCP_OPTION_DHCP4_HOST_NAME                      = 12,
    NM_DHCP_OPTION_DHCP4_BOOT_FILE_SIZE                 = 13,
    NM_DHCP_OPTION_DHCP4_MERIT_DUMP                     = 14,
    NM_DHCP_OPTION_DHCP4_DOMAIN_NAME                    = 15,
    NM_DHCP_OPTION_DHCP4_SWAP_SERVER                    = 16,
    NM_DHCP_OPTION_DHCP4_ROOT_PATH                      = 17,
    NM_DHCP_OPTION_DHCP4_EXTENSIONS_PATH                = 18,
    NM_DHCP_OPTION_DHCP4_ENABLE_IP_FORWARDING           = 19,
    NM_DHCP_OPTION_DHCP4_ENABLE_SRC_ROUTING             = 20,
    NM_DHCP_OPTION_DHCP4_POLICY_FILTER                  = 21,
    NM_DHCP_OPTION_DHCP4_INTERFACE_MDR                  = 22,
    NM_DHCP_OPTION_DHCP4_INTERFACE_TTL                  = 23,
    NM_DHCP_OPTION_DHCP4_INTERFACE_MTU_AGING_TIMEOUT    = 24,
    NM_DHCP_OPTION_DHCP4_PATH_MTU_PLATEAU_TABLE         = 25,
    NM_DHCP_OPTION_DHCP4_INTERFACE_MTU                  = 26,
    NM_DHCP_OPTION_DHCP4_ALL_SUBNETS_LOCAL              = 27,
    NM_DHCP_OPTION_DHCP4_BROADCAST                      = 28,
    NM_DHCP_OPTION_DHCP4_PERFORM_MASK_DISCOVERY         = 29,
    NM_DHCP_OPTION_DHCP4_MASK_SUPPLIER                  = 30,
    NM_DHCP_OPTION_DHCP4_ROUTER_DISCOVERY               = 31,
    NM_DHCP_OPTION_DHCP4_ROUTER_SOLICITATION_ADDR       = 32,
    NM_DHCP_OPTION_DHCP4_STATIC_ROUTE                   = 33,
    NM_DHCP_OPTION_DHCP4_TRAILER_ENCAPSULATION          = 34,
    NM_DHCP_OPTION_DHCP4_ARP_CACHE_TIMEOUT              = 35,
    NM_DHCP_OPTION_DHCP4_IEEE802_3_ENCAPSULATION        = 36,
    NM_DHCP_OPTION_DHCP4_DEFAULT_TCP_TTL                = 37,
    NM_DHCP_OPTION_DHCP4_TCP_KEEPALIVE_INTERVAL         = 38,
    NM_DHCP_OPTION_DHCP4_TCP_KEEPALIVE_GARBAGE          = 39,
    NM_DHCP_OPTION_DHCP4_NIS_DOMAIN                     = 40,
    NM_DHCP_OPTION_DHCP4_NIS_SERVERS                    = 41,
    NM_DHCP_OPTION_DHCP4_NTP_SERVER                     = 42,
    NM_DHCP_OPTION_DHCP4_VENDOR_SPECIFIC                = 43,
    NM_DHCP_OPTION_DHCP4_NETBIOS_NAMESERVER             = 44,
    NM_DHCP_OPTION_DHCP4_NETBIOS_DD_SERVER              = 45,
    NM_DHCP_OPTION_DHCP4_FONT_SERVERS                   = 48,
    NM_DHCP_OPTION_DHCP4_X_DISPLAY_MANAGER              = 49,
    NM_DHCP_OPTION_DHCP4_IP_ADDRESS_LEASE_TIME          = 51,
    NM_DHCP_OPTION_DHCP4_SERVER_ID                      = 54,
    NM_DHCP_OPTION_DHCP4_RENEWAL_T1_TIME                = 58,
    NM_DHCP_OPTION_DHCP4_REBINDING_T2_TIME              = 59,
    NM_DHCP_OPTION_DHCP4_VENDOR_CLASS_IDENTIFIER        = 60,
    NM_DHCP_OPTION_DHCP4_CLIENT_ID                      = 61,
    NM_DHCP_OPTION_DHCP4_NWIP_DOMAIN                    = 62,
    NM_DHCP_OPTION_DHCP4_NWIP_SUBOPTIONS                = 63,
    NM_DHCP_OPTION_DHCP4_NISPLUS_DOMAIN                 = 64,
    NM_DHCP_OPTION_DHCP4_NISPLUS_SERVERS                = 65,
    NM_DHCP_OPTION_DHCP4_TFTP_SERVER_NAME               = 66,
    NM_DHCP_OPTION_DHCP4_BOOTFILE_NAME                  = 67,
    NM_DHCP_OPTION_DHCP4_MOBILE_IP_HOME_AGENT           = 68,
    NM_DHCP_OPTION_DHCP4_SMTP_SERVER                    = 69,
    NM_DHCP_OPTION_DHCP4_POP_SERVER                     = 70,
    NM_DHCP_OPTION_DHCP4_NNTP_SERVER                    = 71,
    NM_DHCP_OPTION_DHCP4_WWW_SERVER                     = 72,
    NM_DHCP_OPTION_DHCP4_FINGER_SERVER                  = 73,
    NM_DHCP_OPTION_DHCP4_IRC_SERVER                     = 74,
    NM_DHCP_OPTION_DHCP4_STREETTALK_SERVER              = 75,
    NM_DHCP_OPTION_DHCP4_STREETTALK_DIR_ASSIST_SERVER   = 76,
    NM_DHCP_OPTION_DHCP4_SLP_DIRECTORY_AGENT            = 78,
    NM_DHCP_OPTION_DHCP4_SLP_SERVICE_SCOPE              = 79,
    NM_DHCP_OPTION_DHCP4_CLIENT_FQDN                    = 81,
    NM_DHCP_OPTION_DHCP4_RELAY_AGENT_INFORMATION        = 82,
    NM_DHCP_OPTION_DHCP4_NDS_SERVERS                    = 85,
    NM_DHCP_OPTION_DHCP4_NDS_TREE_NAME                  = 86,
    NM_DHCP_OPTION_DHCP4_NDS_CONTEXT                    = 87,
    NM_DHCP_OPTION_DHCP4_BCMS_CONTROLLER_NAMES          = 88,
    NM_DHCP_OPTION_DHCP4_BCMS_CONTROLLER_ADDRESS        = 89,
    NM_DHCP_OPTION_DHCP4_CLIENT_LAST_TRANSACTION        = 91,
    NM_DHCP_OPTION_DHCP4_ASSOCIATED_IP                  = 92,
    NM_DHCP_OPTION_DHCP4_PXE_SYSTEM_TYPE                = 93,
    NM_DHCP_OPTION_DHCP4_PXE_INTERFACE_ID               = 94,
    NM_DHCP_OPTION_DHCP4_PXE_CLIENT_ID                  = 97,
    NM_DHCP_OPTION_DHCP4_UAP_SERVERS                    = 98,
    NM_DHCP_OPTION_DHCP4_GEOCONF_CIVIC                  = 99,
    NM_DHCP_OPTION_DHCP4_NEW_TZDB_TIMEZONE              = 101,
    NM_DHCP_OPTION_DHCP4_NETINFO_SERVER_ADDRESS         = 112,
    NM_DHCP_OPTION_DHCP4_NETINFO_SERVER_TAG             = 113,
    NM_DHCP_OPTION_DHCP4_DEFAULT_URL                    = 114,
    NM_DHCP_OPTION_DHCP4_AUTO_CONFIG                    = 116,
    NM_DHCP_OPTION_DHCP4_NAME_SERVICE_SEARCH            = 117,
    NM_DHCP_OPTION_DHCP4_SUBNET_SELECTION               = 118,
    NM_DHCP_OPTION_DHCP4_DOMAIN_SEARCH_LIST             = 119,
    NM_DHCP_OPTION_DHCP4_CLASSLESS_STATIC_ROUTE         = 121,
    NM_DHCP_OPTION_DHCP4_VIVCO                          = 124,
    NM_DHCP_OPTION_DHCP4_VIVSO                          = 125,
    NM_DHCP_OPTION_DHCP4_PANA_AGENT                     = 136,
    NM_DHCP_OPTION_DHCP4_V4_LOST                        = 137,
    NM_DHCP_OPTION_DHCP4_SIP_UA_CS_DOMAINS              = 141,
    NM_DHCP_OPTION_DHCP4_IPV4_ADDRESS_ANDSF             = 142,
    NM_DHCP_OPTION_DHCP4_RDNSS_SELECTION                = 146,
    NM_DHCP_OPTION_DHCP4_TFTP_SERVER_ADDRESS            = 150,
    NM_DHCP_OPTION_DHCP4_V4_PORTPARAMS                  = 159,
    NM_DHCP_OPTION_DHCP4_V4_CAPTIVE_PORTAL              = 160,
    NM_DHCP_OPTION_DHCP4_MUD_URL                        = 161,
    NM_DHCP_OPTION_DHCP4_LOADER_CONFIGFILE              = 209,
    NM_DHCP_OPTION_DHCP4_LOADER_PATHPREFIX              = 210,
    NM_DHCP_OPTION_DHCP4_LOADER_REBOOTTIME              = 211,
    NM_DHCP_OPTION_DHCP4_OPTION_6RD                     = 212,
    NM_DHCP_OPTION_DHCP4_V4_ACCESS_DOMAIN               = 213,
    NM_DHCP_OPTION_DHCP4_PRIVATE_224                    = 224,
    NM_DHCP_OPTION_DHCP4_PRIVATE_225                    = 225,
    NM_DHCP_OPTION_DHCP4_PRIVATE_226                    = 226,
    NM_DHCP_OPTION_DHCP4_PRIVATE_227                    = 227,
    NM_DHCP_OPTION_DHCP4_PRIVATE_228                    = 228,
    NM_DHCP_OPTION_DHCP4_PRIVATE_229                    = 229,
    NM_DHCP_OPTION_DHCP4_PRIVATE_230                    = 230,
    NM_DHCP_OPTION_DHCP4_PRIVATE_231                    = 231,
    NM_DHCP_OPTION_DHCP4_PRIVATE_232                    = 232,
    NM_DHCP_OPTION_DHCP4_PRIVATE_233                    = 233,
    NM_DHCP_OPTION_DHCP4_PRIVATE_234                    = 234,
    NM_DHCP_OPTION_DHCP4_PRIVATE_235                    = 235,
    NM_DHCP_OPTION_DHCP4_PRIVATE_236                    = 236,
    NM_DHCP_OPTION_DHCP4_PRIVATE_237                    = 237,
    NM_DHCP_OPTION_DHCP4_PRIVATE_238                    = 238,
    NM_DHCP_OPTION_DHCP4_PRIVATE_239                    = 239,
    NM_DHCP_OPTION_DHCP4_PRIVATE_240                    = 240,
    NM_DHCP_OPTION_DHCP4_PRIVATE_241                    = 241,
    NM_DHCP_OPTION_DHCP4_PRIVATE_242                    = 242,
    NM_DHCP_OPTION_DHCP4_PRIVATE_243                    = 243,
    NM_DHCP_OPTION_DHCP4_PRIVATE_244                    = 244,
    NM_DHCP_OPTION_DHCP4_PRIVATE_245                    = 245,
    NM_DHCP_OPTION_DHCP4_PRIVATE_246                    = 246,
    NM_DHCP_OPTION_DHCP4_PRIVATE_247                    = 247,
    NM_DHCP_OPTION_DHCP4_PRIVATE_248                    = 248,
    NM_DHCP_OPTION_DHCP4_PRIVATE_CLASSLESS_STATIC_ROUTE = 249,
    NM_DHCP_OPTION_DHCP4_PRIVATE_250                    = 250,
    NM_DHCP_OPTION_DHCP4_PRIVATE_251                    = 251,
    NM_DHCP_OPTION_DHCP4_PRIVATE_PROXY_AUTODISCOVERY    = 252,
    NM_DHCP_OPTION_DHCP4_PRIVATE_253                    = 253,
    NM_DHCP_OPTION_DHCP4_PRIVATE_254                    = 254,
    NM_DHCP_OPTION_DHCP4_END                            = 255,
    /* Internal values */
    NM_DHCP_OPTION_DHCP4_NM_IP_ADDRESS  = 1024,
    NM_DHCP_OPTION_DHCP4_NM_EXPIRY      = 1025,
    NM_DHCP_OPTION_DHCP4_NM_NEXT_SERVER = 1026,
    NM_DHCP_OPTION_DHCP4_NM_FILENAME    = 1027, /* 'file' DHCP header */
} NMDhcpOptionDhcp4Options;

typedef enum {
    NM_DHCP_OPTION_DHCP6_CLIENT_ID    = 1,
    NM_DHCP_OPTION_DHCP6_SERVER_ID    = 2,
    NM_DHCP_OPTION_DHCP6_DNS_SERVERS  = 23,
    NM_DHCP_OPTION_DHCP6_DOMAIN_LIST  = 24,
    NM_DHCP_OPTION_DHCP6_SNTP_SERVERS = 31,
    NM_DHCP_OPTION_DHCP6_FQDN         = 39,
    NM_DHCP_OPTION_DHCP6_NTP_SERVER   = 56, /* RFC 5908 */
    NM_DHCP_OPTION_DHCP6_MUD_URL      = 112,

    /* Internal values */
    NM_DHCP_OPTION_DHCP6_NM_IP_ADDRESS     = 1026,
    NM_DHCP_OPTION_DHCP6_NM_PREFIXLEN      = 1027,
    NM_DHCP_OPTION_DHCP6_NM_PREFERRED_LIFE = 1028,
    NM_DHCP_OPTION_DHCP6_NM_MAX_LIFE       = 1029,
    NM_DHCP_OPTION_DHCP6_NM_STARTS         = 1030,
    NM_DHCP_OPTION_DHCP6_NM_LIFE_STARTS    = 1031,
    NM_DHCP_OPTION_DHCP6_NM_RENEW          = 1032,
    NM_DHCP_OPTION_DHCP6_NM_REBIND         = 1033,
    NM_DHCP_OPTION_DHCP6_NM_IAID           = 1034,

} NMDhcpOptionDhcp6Options;

#define NM_DHCP_OPTION_REQPREFIX "requested_"

typedef struct {
    const char *name;
    uint16_t    option_num;
    bool        include;
} NMDhcpOption;

extern const NMDhcpOption _nm_dhcp_option_dhcp4_options[143];
extern const NMDhcpOption _nm_dhcp_option_dhcp6_options[17];

static inline const char *
nm_dhcp_option_get_name(const NMDhcpOption *option)
{
    nm_assert(option);
    nm_assert(option->name);
    nm_assert(NM_STR_HAS_PREFIX(option->name, NM_DHCP_OPTION_REQPREFIX));

    return &option->name[NM_STRLEN(NM_DHCP_OPTION_REQPREFIX)];
}

const NMDhcpOption *nm_dhcp_option_find(int addr_family, guint option);

static inline const char *
nm_dhcp_option_request_string(int addr_family, guint option)
{
    return nm_dhcp_option_get_name(nm_dhcp_option_find(addr_family, option));
}

void nm_dhcp_option_take_option(GHashTable *options, int addr_family, guint option, char *value);
void
nm_dhcp_option_add_option(GHashTable *options, int addr_family, guint option, const char *value);
void nm_dhcp_option_add_option_utf8safe_escape(GHashTable   *options,
                                               int           addr_family,
                                               guint         option,
                                               const guint8 *data,
                                               gsize         n_data);
void nm_dhcp_option_add_option_in_addr(GHashTable *options,
                                       int         addr_family,
                                       guint       option,
                                       in_addr_t   value);
void
nm_dhcp_option_add_option_u64(GHashTable *options, int addr_family, guint option, guint64 value);
void nm_dhcp_option_add_requests_to_options(GHashTable *options, int addr_family);

GHashTable *nm_dhcp_option_create_options_dict(gboolean static_keys);

#endif /* __NM_DHCP_OPTIONS_H__ */