treewide: update copyrights to 2018
[project/odhcp6c.git] / src / odhcp6c.h
1 /**
2 * Copyright (C) 2012-2014 Steven Barth <steven@midlink.org>
3 * Copyright (C) 2018 Hans Dedecker <dedeckeh@gmail.com>
4 *
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License v2 as published by
7 * the Free Software Foundation.
8 *
9 * This program is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 * GNU General Public License for more details.
13 *
14 */
15 #pragma once
16 #include <stdint.h>
17 #include <stdbool.h>
18 #include <netinet/in.h>
19
20 #define _unused __attribute__((unused))
21 #define _packed __attribute__((packed))
22 #define _aligned(n) __attribute__((aligned(n)))
23
24 #define ARRAY_SIZE(arr) (sizeof(arr) / sizeof((arr)[0]))
25
26 #define ND_OPT_RECURSIVE_DNS 25
27 #define ND_OPT_DNSSL 31
28
29 #define DHCPV6_SOL_MAX_RT 120
30 #define DHCPV6_REQ_MAX_RT 30
31 #define DHCPV6_CNF_MAX_RT 4
32 #define DHCPV6_REN_MAX_RT 600
33 #define DHCPV6_REB_MAX_RT 600
34 #define DHCPV6_INF_MAX_RT 120
35
36 #define RA_MIN_ADV_INTERVAL 3 /* RFC 4861 paragraph 6.2.1 */
37
38 enum dhcvp6_opt {
39 DHCPV6_OPT_CLIENTID = 1,
40 DHCPV6_OPT_SERVERID = 2,
41 DHCPV6_OPT_IA_NA = 3,
42 DHCPV6_OPT_IA_TA = 4,
43 DHCPV6_OPT_IA_ADDR = 5,
44 DHCPV6_OPT_ORO = 6,
45 DHCPV6_OPT_PREF = 7,
46 DHCPV6_OPT_ELAPSED = 8,
47 DHCPV6_OPT_RELAY_MSG = 9,
48 DHCPV6_OPT_AUTH = 11,
49 DHCPV6_OPT_UNICAST = 12,
50 DHCPV6_OPT_STATUS = 13,
51 DHCPV6_OPT_RAPID_COMMIT = 14,
52 DHCPV6_OPT_USER_CLASS = 15,
53 DHCPV6_OPT_VENDOR_CLASS = 16,
54 DHCPV6_OPT_RECONF_MESSAGE = 19,
55 DHCPV6_OPT_RECONF_ACCEPT = 20,
56 DHCPV6_OPT_DNS_SERVERS = 23,
57 DHCPV6_OPT_DNS_DOMAIN = 24,
58 DHCPV6_OPT_IA_PD = 25,
59 DHCPV6_OPT_IA_PREFIX = 26,
60 DHCPV6_OPT_SNTP_SERVERS = 31,
61 DHCPV6_OPT_INFO_REFRESH = 32,
62 DHCPV6_OPT_FQDN = 39,
63 DHCPV6_OPT_NTP_SERVER = 56,
64 DHCPV6_OPT_SIP_SERVER_D = 21,
65 DHCPV6_OPT_SIP_SERVER_A = 22,
66 DHCPV6_OPT_AFTR_NAME = 64,
67 DHCPV6_OPT_PD_EXCLUDE = 67,
68 DHCPV6_OPT_SOL_MAX_RT = 82,
69 DHCPV6_OPT_INF_MAX_RT = 83,
70 #ifdef EXT_CER_ID
71 /* draft-donley-dhc-cer-id-option-03 */
72 DHCPV6_OPT_CER_ID = EXT_CER_ID,
73 #endif
74 /* draft-ietf-softwire-map-dhcp-08 */
75 DHCPV6_OPT_S46_RULE = 89,
76 DHCPV6_OPT_S46_BR = 90,
77 DHCPV6_OPT_S46_DMR = 91,
78 DHCPV6_OPT_S46_V4V6BIND = 92,
79 DHCPV6_OPT_S46_PORTPARAMS = 93,
80 DHCPV6_OPT_S46_CONT_MAPE = 94,
81 DHCPV6_OPT_S46_CONT_MAPT = 95,
82 DHCPV6_OPT_S46_CONT_LW = 96,
83 };
84
85 enum dhcpv6_opt_npt {
86 NTP_SRV_ADDR = 1,
87 NTP_MC_ADDR = 2,
88 NTP_SRV_FQDN = 3
89 };
90
91 enum dhcpv6_msg {
92 DHCPV6_MSG_UNKNOWN = 0,
93 DHCPV6_MSG_SOLICIT = 1,
94 DHCPV6_MSG_ADVERT = 2,
95 DHCPV6_MSG_REQUEST = 3,
96 DHCPV6_MSG_RENEW = 5,
97 DHCPV6_MSG_REBIND = 6,
98 DHCPV6_MSG_REPLY = 7,
99 DHCPV6_MSG_RELEASE = 8,
100 DHCPV6_MSG_DECLINE = 9,
101 DHCPV6_MSG_RECONF = 10,
102 DHCPV6_MSG_INFO_REQ = 11,
103 _DHCPV6_MSG_MAX
104 };
105
106 enum dhcpv6_status {
107 DHCPV6_Success = 0,
108 DHCPV6_UnspecFail = 1,
109 DHCPV6_NoAddrsAvail = 2,
110 DHCPV6_NoBinding = 3,
111 DHCPV6_NotOnLink = 4,
112 DHCPV6_UseMulticast = 5,
113 DHCPV6_NoPrefixAvail = 6,
114 _DHCPV6_Status_Max
115 };
116
117 enum dhcpv6_config {
118 DHCPV6_STRICT_OPTIONS = 1,
119 DHCPV6_CLIENT_FQDN = 2,
120 DHCPV6_ACCEPT_RECONFIGURE = 4,
121 };
122
123 typedef int(reply_handler)(enum dhcpv6_msg orig, const int rc,
124 const void *opt, const void *end, const struct sockaddr_in6 *from);
125
126 // retransmission strategy
127 struct dhcpv6_retx {
128 bool delay;
129 uint8_t init_timeo;
130 uint16_t max_timeo;
131 uint8_t max_rc;
132 char name[8];
133 reply_handler *handler_reply;
134 int(*handler_finish)(void);
135 };
136
137 // DHCPv6 Protocol Headers
138 struct dhcpv6_header {
139 uint8_t msg_type;
140 uint8_t tr_id[3];
141 } __attribute__((packed));
142
143 struct dhcpv6_ia_hdr {
144 uint16_t type;
145 uint16_t len;
146 uint32_t iaid;
147 uint32_t t1;
148 uint32_t t2;
149 } _packed;
150
151 struct dhcpv6_ia_addr {
152 uint16_t type;
153 uint16_t len;
154 struct in6_addr addr;
155 uint32_t preferred;
156 uint32_t valid;
157 } _packed;
158
159 struct dhcpv6_ia_prefix {
160 uint16_t type;
161 uint16_t len;
162 uint32_t preferred;
163 uint32_t valid;
164 uint8_t prefix;
165 struct in6_addr addr;
166 } _packed;
167
168 struct dhcpv6_duid {
169 uint16_t type;
170 uint16_t len;
171 uint16_t duid_type;
172 uint8_t data[128];
173 } _packed;
174
175 struct dhcpv6_auth_reconfigure {
176 uint16_t type;
177 uint16_t len;
178 uint8_t protocol;
179 uint8_t algorithm;
180 uint8_t rdm;
181 uint64_t replay;
182 uint8_t reconf_type;
183 uint8_t key[16];
184 } _packed;
185
186 struct dhcpv6_cer_id {
187 uint16_t type;
188 uint16_t len;
189 struct in6_addr addr;
190 } _packed;
191
192 struct dhcpv6_s46_portparams {
193 uint8_t offset;
194 uint8_t psid_len;
195 uint16_t psid;
196 } _packed;
197
198 struct dhcpv6_s46_v4v6bind {
199 struct in_addr ipv4_address;
200 uint8_t bindprefix6_len;
201 uint8_t bind_ipv6_prefix[];
202 } _packed;
203
204 struct dhcpv6_s46_dmr {
205 uint8_t dmr_prefix6_len;
206 uint8_t dmr_ipv6_prefix[];
207 } _packed;
208
209 struct dhcpv6_s46_rule {
210 uint8_t flags;
211 uint8_t ea_len;
212 uint8_t prefix4_len;
213 struct in_addr ipv4_prefix;
214 uint8_t prefix6_len;
215 uint8_t ipv6_prefix[];
216 } _packed;
217
218 #define dhcpv6_for_each_option(start, end, otype, olen, odata)\
219 for (uint8_t *_o = (uint8_t*)(start); _o + 4 <= (uint8_t*)(end) &&\
220 ((otype) = _o[0] << 8 | _o[1]) && ((odata) = (void*)&_o[4]) &&\
221 ((olen) = _o[2] << 8 | _o[3]) + (odata) <= (uint8_t*)(end); \
222 _o += 4 + (_o[2] << 8 | _o[3]))
223
224
225 struct dhcpv6_server_cand {
226 bool has_noaddravail;
227 bool wants_reconfigure;
228 int16_t preference;
229 uint8_t duid_len;
230 uint8_t duid[130];
231 struct in6_addr server_addr;
232 uint32_t sol_max_rt;
233 uint32_t inf_max_rt;
234 void *ia_na;
235 void *ia_pd;
236 size_t ia_na_len;
237 size_t ia_pd_len;
238 };
239
240
241 enum odhcp6c_state {
242 STATE_CLIENT_ID,
243 STATE_SERVER_ID,
244 STATE_SERVER_CAND,
245 STATE_SERVER_ADDR,
246 STATE_ORO,
247 STATE_DNS,
248 STATE_SEARCH,
249 STATE_IA_NA,
250 STATE_IA_PD,
251 STATE_IA_PD_INIT,
252 STATE_CUSTOM_OPTS,
253 STATE_SNTP_IP,
254 STATE_NTP_IP,
255 STATE_NTP_FQDN,
256 STATE_SIP_IP,
257 STATE_SIP_FQDN,
258 STATE_RA_ROUTE,
259 STATE_RA_PREFIX,
260 STATE_RA_DNS,
261 STATE_RA_SEARCH,
262 STATE_AFTR_NAME,
263 STATE_VENDORCLASS,
264 STATE_USERCLASS,
265 STATE_CER,
266 STATE_S46_MAPT,
267 STATE_S46_MAPE,
268 STATE_S46_LW,
269 STATE_PASSTHRU,
270 _STATE_MAX
271 };
272
273
274 struct icmp6_opt {
275 uint8_t type;
276 uint8_t len;
277 uint8_t data[6];
278 };
279
280
281 enum dhcpv6_mode {
282 DHCPV6_UNKNOWN = -1,
283 DHCPV6_STATELESS,
284 DHCPV6_STATEFUL
285 };
286
287 enum ra_config {
288 RA_RDNSS_DEFAULT_LIFETIME = 1,
289 };
290
291 enum odhcp6c_ia_mode {
292 IA_MODE_NONE,
293 IA_MODE_TRY,
294 IA_MODE_FORCE,
295 };
296
297
298 struct odhcp6c_entry {
299 struct in6_addr router;
300 uint8_t auxlen;
301 uint8_t length;
302 int16_t priority;
303 struct in6_addr target;
304 uint32_t valid;
305 uint32_t preferred;
306 uint32_t t1;
307 uint32_t t2;
308 uint32_t iaid;
309 uint8_t auxtarget[];
310 };
311
312 // Include padding after auxtarget to align the next entry
313 #define odhcp6c_entry_size(entry) \
314 (sizeof(struct odhcp6c_entry) + (((entry)->auxlen + 3) & ~3))
315
316 #define odhcp6c_next_entry(entry) \
317 ((struct odhcp6c_entry *)((uint8_t *)(entry) + odhcp6c_entry_size(entry)))
318
319
320 struct odhcp6c_request_prefix {
321 uint32_t iaid;
322 uint16_t length;
323 };
324
325 int init_dhcpv6(const char *ifname, unsigned int client_options, int sol_timeout);
326 int dhcpv6_set_ia_mode(enum odhcp6c_ia_mode na, enum odhcp6c_ia_mode pd);
327 int dhcpv6_request(enum dhcpv6_msg type);
328 int dhcpv6_poll_reconfigure(void);
329 int dhcpv6_promote_server_cand(void);
330
331 int init_rtnetlink(void);
332 int set_rtnetlink_addr(int ifindex, const struct in6_addr *addr,
333 uint32_t pref, uint32_t valid);
334
335 int ra_conf_hoplimit(int newvalue);
336 int ra_conf_mtu(int newvalue);
337 int ra_conf_reachable(int newvalue);
338 int ra_conf_retransmit(int newvalue);
339
340 int script_init(const char *path, const char *ifname);
341 ssize_t script_unhexlify(uint8_t *dst, size_t len, const char *src);
342 void script_call(const char *status, int delay, bool resume);
343
344 bool odhcp6c_signal_process(void);
345 uint64_t odhcp6c_get_milli_time(void);
346 int odhcp6c_random(void *buf, size_t len);
347 bool odhcp6c_is_bound(void);
348 bool odhcp6c_addr_in_scope(const struct in6_addr *addr);
349
350 // State manipulation
351 void odhcp6c_clear_state(enum odhcp6c_state state);
352 int odhcp6c_add_state(enum odhcp6c_state state, const void *data, size_t len);
353 void odhcp6c_append_state(enum odhcp6c_state state, const void *data, size_t len);
354 int odhcp6c_insert_state(enum odhcp6c_state state, size_t offset, const void *data, size_t len);
355 size_t odhcp6c_remove_state(enum odhcp6c_state state, size_t offset, size_t len);
356 void* odhcp6c_move_state(enum odhcp6c_state state, size_t *len);
357 void* odhcp6c_get_state(enum odhcp6c_state state, size_t *len);
358
359 // Entry manipulation
360 bool odhcp6c_update_entry(enum odhcp6c_state state, struct odhcp6c_entry *new,
361 uint32_t safe, unsigned int holdoff_interval);
362
363 void odhcp6c_expire(void);
364 uint32_t odhcp6c_elapsed(void);