Improved message validation checks and socket error hardening
[project/odhcp6c.git] / src / odhcp6c.h
1 /**
2 * Copyright (C) 2012-2013 Steven Barth <steven@midlink.org>
3 *
4 * This program is free software; you can redistribute it and/or modify
5 * it under the terms of the GNU General Public License v2 as published by
6 * the Free Software Foundation.
7 *
8 * This program is distributed in the hope that it will be useful,
9 * but WITHOUT ANY WARRANTY; without even the implied warranty of
10 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11 * GNU General Public License for more details.
12 *
13 */
14 #pragma once
15 #include <stdint.h>
16 #include <stdbool.h>
17 #include <netinet/in.h>
18
19 #define _unused __attribute__((unused))
20 #define _packed __attribute__((packed))
21
22 #define ARRAY_SIZE(arr) (sizeof(arr) / sizeof((arr)[0]))
23
24 #define ND_OPT_RECURSIVE_DNS 25
25 #define ND_OPT_DNSSL 31
26
27 enum dhcvp6_opt {
28 DHCPV6_OPT_CLIENTID = 1,
29 DHCPV6_OPT_SERVERID = 2,
30 DHCPV6_OPT_IA_NA = 3,
31 DHCPV6_OPT_IA_ADDR = 5,
32 DHCPV6_OPT_ORO = 6,
33 DHCPV6_OPT_PREF = 7,
34 DHCPV6_OPT_ELAPSED = 8,
35 DHCPV6_OPT_RELAY_MSG = 9,
36 DHCPV6_OPT_AUTH = 11,
37 DHCPV6_OPT_STATUS = 13,
38 DHCPV6_OPT_RAPID_COMMIT = 14,
39 DHCPV6_OPT_RECONF_MESSAGE = 19,
40 DHCPV6_OPT_RECONF_ACCEPT = 20,
41 DHCPV6_OPT_DNS_SERVERS = 23,
42 DHCPV6_OPT_DNS_DOMAIN = 24,
43 DHCPV6_OPT_IA_PD = 25,
44 DHCPV6_OPT_IA_PREFIX = 26,
45 DHCPV6_OPT_INFO_REFRESH = 32,
46 DHCPV6_OPT_FQDN = 39,
47 DHCPV6_OPT_NTP_SERVER = 56,
48 DHCPV6_OPT_SIP_SERVER_D = 21,
49 DHCPV6_OPT_SIP_SERVER_A = 22,
50 DHCPV6_OPT_AFTR_NAME = 64,
51 DHCPV6_OPT_PD_EXCLUDE = 67,
52 #ifdef EXT_PREFIX_CLASS
53 /* draft-bhandari-dhc-class-based-prefix, not yet standardized */
54 DHCPV6_OPT_PREFIX_CLASS = EXT_PREFIX_CLASS,
55 #endif
56 };
57
58 enum dhcpv6_opt_npt {
59 NTP_SRV_ADDR = 1,
60 NTP_MC_ADDR = 2,
61 NTP_SRV_FQDN = 3
62 };
63
64 enum dhcpv6_msg {
65 DHCPV6_MSG_UNKNOWN = 0,
66 DHCPV6_MSG_SOLICIT = 1,
67 DHCPV6_MSG_ADVERT = 2,
68 DHCPV6_MSG_REQUEST = 3,
69 DHCPV6_MSG_RENEW = 5,
70 DHCPV6_MSG_REBIND = 6,
71 DHCPV6_MSG_REPLY = 7,
72 DHCPV6_MSG_RELEASE = 8,
73 DHCPV6_MSG_DECLINE = 9,
74 DHCPV6_MSG_RECONF = 10,
75 DHCPV6_MSG_INFO_REQ = 11,
76 _DHCPV6_MSG_MAX
77 };
78
79 enum dhcpv6_status {
80 DHCPV6_Success = 0,
81 DHCPV6_UnspecFail = 1,
82 DHCPV6_NoAddrsAvail = 2,
83 DHCPV6_NoBinding = 3,
84 DHCPV6_NotOnLink = 4,
85 DHCPV6_UseMulticast = 5,
86 DHCPV6_NoPrefixAvail = 6,
87 _DHCPV6_Status_Max
88 };
89
90 typedef int(reply_handler)(enum dhcpv6_msg orig, const int rc,
91 const void *opt, const void *end);
92
93 // retransmission strategy
94 struct dhcpv6_retx {
95 bool delay;
96 uint8_t init_timeo;
97 uint16_t max_timeo;
98 uint8_t max_rc;
99 char name[8];
100 reply_handler *handler_reply;
101 int(*handler_finish)(void);
102 };
103
104 // DHCPv6 Protocol Headers
105 struct dhcpv6_header {
106 uint8_t msg_type;
107 uint8_t tr_id[3];
108 } __attribute__((packed));
109
110 struct dhcpv6_ia_hdr {
111 uint16_t type;
112 uint16_t len;
113 uint32_t iaid;
114 uint32_t t1;
115 uint32_t t2;
116 } _packed;
117
118 struct dhcpv6_ia_addr {
119 uint16_t type;
120 uint16_t len;
121 struct in6_addr addr;
122 uint32_t preferred;
123 uint32_t valid;
124 } _packed;
125
126 struct dhcpv6_ia_prefix {
127 uint16_t type;
128 uint16_t len;
129 uint32_t preferred;
130 uint32_t valid;
131 uint8_t prefix;
132 struct in6_addr addr;
133 } _packed;
134
135 struct dhcpv6_duid {
136 uint16_t type;
137 uint16_t len;
138 uint16_t duid_type;
139 uint8_t data[128];
140 } _packed;
141
142 struct dhcpv6_auth_reconfigure {
143 uint16_t type;
144 uint16_t len;
145 uint8_t protocol;
146 uint8_t algorithm;
147 uint8_t rdm;
148 uint64_t replay;
149 uint8_t reconf_type;
150 uint8_t key[16];
151 } _packed;
152
153
154 #define dhcpv6_for_each_option(start, end, otype, olen, odata)\
155 for (uint8_t *_o = (uint8_t*)(start); _o + 4 <= (uint8_t*)(end) &&\
156 ((otype) = _o[0] << 8 | _o[1]) && ((odata) = (void*)&_o[4]) &&\
157 ((olen) = _o[2] << 8 | _o[3]) + (odata) <= (uint8_t*)(end); \
158 _o += 4 + (_o[2] << 8 | _o[3]))
159
160
161 struct dhcpv6_server_cand {
162 bool has_noaddravail;
163 bool wants_reconfigure;
164 int16_t preference;
165 uint8_t duid_len;
166 uint8_t duid[130];
167 void *ia_na;
168 void *ia_pd;
169 size_t ia_na_len;
170 size_t ia_pd_len;
171 };
172
173
174 enum odhcp6c_state {
175 STATE_CLIENT_ID,
176 STATE_SERVER_ID,
177 STATE_SERVER_CAND,
178 STATE_ORO,
179 STATE_DNS,
180 STATE_SEARCH,
181 STATE_IA_NA,
182 STATE_IA_PD,
183 STATE_CUSTOM_OPTS,
184 STATE_SNTP_IP,
185 STATE_SNTP_FQDN,
186 STATE_SIP_IP,
187 STATE_SIP_FQDN,
188 STATE_RA_ROUTE,
189 STATE_RA_PREFIX,
190 STATE_RA_DNS,
191 STATE_AFTR_NAME,
192 _STATE_MAX
193 };
194
195
196 struct icmp6_opt {
197 uint8_t type;
198 uint8_t len;
199 uint8_t data[6];
200 };
201
202
203 enum dhcpv6_mode {
204 DHCPV6_UNKNOWN,
205 DHCPV6_STATELESS,
206 DHCPV6_STATEFUL
207 };
208
209
210 enum odhcp6c_ia_mode {
211 IA_MODE_NONE,
212 IA_MODE_TRY,
213 IA_MODE_FORCE,
214 };
215
216
217 struct odhcp6c_entry {
218 struct in6_addr router;
219 uint16_t length;
220 int16_t priority;
221 struct in6_addr target;
222 uint32_t valid;
223 uint32_t preferred;
224 uint32_t t1;
225 uint32_t t2;
226 uint16_t class;
227 };
228
229
230 int init_dhcpv6(const char *ifname, int request_pd, int sol_timeout);
231 void dhcpv6_set_ia_mode(enum odhcp6c_ia_mode na, enum odhcp6c_ia_mode pd);
232 int dhcpv6_request(enum dhcpv6_msg type);
233 int dhcpv6_poll_reconfigure(void);
234
235 int init_rtnetlink(void);
236 int set_rtnetlink_addr(int ifindex, const struct in6_addr *addr,
237 uint32_t pref, uint32_t valid);
238
239 int script_init(const char *path, const char *ifname);
240 ssize_t script_unhexlify(uint8_t *dst, size_t len, const char *src);
241 void script_call(const char *status);
242 void script_delay_call(const char *status, int timeout);
243
244 bool odhcp6c_signal_process(void);
245 uint64_t odhcp6c_get_milli_time(void);
246 void odhcp6c_random(void *buf, size_t len);
247 bool odhcp6c_is_bound(void);
248
249 // State manipulation
250 void odhcp6c_clear_state(enum odhcp6c_state state);
251 void odhcp6c_add_state(enum odhcp6c_state state, const void *data, size_t len);
252 size_t odhcp6c_remove_state(enum odhcp6c_state state, size_t offset, size_t len);
253 void* odhcp6c_move_state(enum odhcp6c_state state, size_t *len);
254 void* odhcp6c_get_state(enum odhcp6c_state state, size_t *len);
255
256 // Entry manipulation
257 struct odhcp6c_entry* odhcp6c_find_entry(enum odhcp6c_state state, const struct odhcp6c_entry *new);
258 bool odhcp6c_update_entry(enum odhcp6c_state state, struct odhcp6c_entry *new);
259 bool odhcp6c_update_entry_safe(enum odhcp6c_state state, struct odhcp6c_entry *new, uint32_t safe);
260
261 void odhcp6c_expire(void);
262 uint32_t odhcp6c_elapsed(void);