Add the IPv4LL type.
[dhcpcd-ui] / src / libdhcpcd / dhcpcd.h
1 /*
2  * libdhcpcd
3  * Copyright 2009-2015 Roy Marples <roy@marples.name>
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  * 1. Redistributions of source code must retain the above copyright
9  *    notice, this list of conditions and the following disclaimer.
10  * 2. Redistributions in binary form must reproduce the above copyright
11  *    notice, this list of conditions and the following disclaimer in the
12  *    documentation and/or other materials provided with the distribution.
13  *
14  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
15  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
18  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
24  * SUCH DAMAGE.
25  */
26
27 #ifndef DHCPCD_H
28 #define DHCPCD_H
29
30 #include <net/if.h>
31 #include <netinet/in.h>
32
33 #include <stdbool.h>
34
35 #ifdef __cplusplus
36 extern "C" {
37 #endif
38
39 #ifndef DHCPCD_SOCKET
40 #define DHCPCD_SOCKET           "/var/run/dhcpcd.sock"
41 #endif
42 #ifndef DHCPCD_UNPRIV_SOCKET
43 #define DHCPCD_UNPRIV_SOCKET    "/var/run/dhcpcd.unpriv.sock"
44 #endif
45
46 #ifndef WPA_CTRL_DIR
47 #define WPA_CTRL_DIR            "/var/run/wpa_supplicant"
48 #endif
49
50 #ifndef DHCPCD_TMP_DIR
51 #define DHCPCD_TMP_DIR          "/tmp/dhcpcd"
52 #endif
53 #ifndef DHCPCD_TMP_DIR_PERM
54 #define DHCPCD_TMP_DIR_PERM     0700
55 #endif
56
57 #define DHCPCD_RETRYOPEN        100     /* milliseconds */
58 #define DHCPCD_WPA_PING         500     /* milliseconds */
59 #define DHCPCD_WPA_SCAN_LONG    60000   /* milliseconds */
60 #define DHCPCD_WPA_SCAN_SHORT   5000    /* milliseconds */
61 #define DHCPCD_WI_HIST_MAX      10      /* Recall 10 scans for averages */
62
63 /* Each non printable byte of the SSID is represented as \000 */
64 #define IF_SSIDSIZE             ((32 * 4) + 1)
65 #define IF_BSSIDSIZE            64
66 #define FLAGSIZE                64
67 #define TYPESIZE                8
68 #define REASONSIZE              16
69
70 #define DHC_UNKNOWN              0
71 #define DHC_DOWN                 1
72 #define DHC_OPENED               2
73 #define DHC_INITIALISED          3
74 #define DHC_DISCONNECTED         4
75 #define DHC_CONNECTING           5
76 #define DHC_AF_WAITING           6
77 #define DHC_CONNECTED            7
78 #define DHC_MAX                  8
79 extern const char * const dhcpcd_cstates[];
80
81 #define DHT_UNKNOWN              0
82 #define DHT_LINK                 1
83 #define DHT_DHCP                 2
84 #define DHT_IPV4                 2
85 #define DHT_IPV4LL               3
86 #define DHT_RA                   4
87 #define DHT_DHCP6                5
88 #define DHT_MAX                  6
89
90 #define DHS_UNKNOWN              0
91 #define DHS_DUMP                 1
92 #define DHS_TEST                 2
93 #define DHS_STOPPED              3
94 #define DHS_FAIL                 4
95 #define DHS_STOP                 5
96 #define DHS_PREINIT              6
97 #define DHS_DEPARTED             7
98 #define DHS_NOCARRIER            8
99 #define DHS_NAK                  9
100 #define DHS_EXPIRE              10
101 #define DHS_RECONFIGURE         11
102 #define DHS_CARRIER             12
103 #define DHS_STATIC              13
104 #define DHS_3RDPARTY            14
105 #define DHS_IPV4LL              15
106 #define DHS_INFORM              16
107 #define DHS_BOUND               17
108 #define DHS_RENEW               18
109 #define DHS_REBIND              19
110 #define DHS_REBOOT              20
111 #define DHS_ROUTERADVERT        21
112 #define DHS_DELEGATED           22
113 #define DHR_MAX                 23
114
115 typedef struct dhcpcd_wi_avs {
116         int value;
117         int average;
118 } DHCPCD_WI_AV;
119
120 typedef struct dhcpcd_wi_scan {
121         struct dhcpcd_wi_scan *next;
122         char bssid[IF_BSSIDSIZE];
123         int flags;
124 #define WSF_SECURE              0x01
125 #define WSF_PSK                 0x02
126 #define WSF_WEP                 0x10
127 #define WSF_WPA                 0x20
128         int frequency;
129         DHCPCD_WI_AV quality;
130         DHCPCD_WI_AV noise;
131         DHCPCD_WI_AV level;
132         DHCPCD_WI_AV strength;
133         char ssid[IF_SSIDSIZE];
134         char wpa_flags[FLAGSIZE];
135 } DHCPCD_WI_SCAN;
136
137 #ifdef IN_LIBDHCPCD
138 typedef struct dhcpcd_if {
139         struct dhcpcd_if *next;
140         const char *ifname;
141         unsigned int type;
142         unsigned int state;
143         const char *reason;
144
145         unsigned int ifflags;
146         bool up;
147         bool wireless;
148         const char *ssid;
149
150         char *data;
151         size_t data_len;
152
153         char *last_message;
154
155         struct dhcpcd_connection *con;
156 } DHCPCD_IF;
157 #else
158 typedef struct dhcpcd_if {
159         struct dhcpcd_if *next;
160         const char *ifname;
161         unsigned int type;
162         unsigned int state;
163         const char *reason;
164
165         unsigned int ifflags;
166         bool up;
167         bool wireless;
168         const char *ssid;
169 } DHCPCD_IF;
170 #endif
171
172 typedef struct dhcpcd_config {
173         struct dhcpcd_config *next;
174         char *option;
175         char *value;
176 } DHCPCD_OPTION;
177
178 #ifdef IN_LIBDHCPCD
179 typedef struct dhcpcd_wi_hist {
180         struct dhcpcd_wi_hist *next;
181         char ifname[IF_NAMESIZE];
182         char bssid[IF_BSSIDSIZE];
183         int quality;
184         int noise;
185         int level;
186         int strength;
187 } DHCPCD_WI_HIST;
188
189 typedef struct dhcpcd_wpa {
190         struct dhcpcd_wpa *next;
191         char ifname[IF_NAMESIZE];
192         unsigned int status;
193         int command_fd;
194         char *command_path;
195         int listen_fd;
196         char *listen_path;
197         bool attached;
198         struct dhcpcd_connection *con;
199 } DHCPCD_WPA;
200
201 typedef struct dhcpcd_connection {
202         struct dhcpcd_connection *next;
203         bool open;
204         bool privileged;
205         int command_fd;
206         int listen_fd;
207         const char *progname;
208
209         DHCPCD_IF *interfaces;
210         DHCPCD_WPA *wpa;
211         DHCPCD_WI_HIST *wi_history;
212
213         void (*if_cb)(DHCPCD_IF *, void *);
214         void *if_context;
215         void (*status_cb)(struct dhcpcd_connection *,
216             unsigned int, const char *, void *);
217         void *status_context;
218         bool wpa_started;
219         void (*wi_scanresults_cb)(DHCPCD_WPA *, void *);
220         void *wi_scanresults_context;
221         void (*wpa_status_cb)(DHCPCD_WPA *, unsigned int, const char *, void *);
222         void *wpa_status_context;
223
224         char *buf;
225         size_t buflen;
226
227         char *version;
228         bool terminate_commands;
229         char *error;
230         int err;
231         int errors;
232         unsigned int status;
233         bool af_waiting;
234
235         char *cffile;
236 } DHCPCD_CONNECTION;
237
238 #else
239 typedef void *DHCPCD_CONFIG;
240 typedef void *DHCPCD_WPA;
241 typedef void *DHCPCD_CONNECTION;
242 #endif
243
244 DHCPCD_CONNECTION * dhcpcd_new(void);
245 const char * dhcpcd_version(DHCPCD_CONNECTION *);
246 void dhcpcd_set_progname(DHCPCD_CONNECTION *, const char *);
247 const char * dhcpcd_get_progname(const DHCPCD_CONNECTION *);
248 unsigned int dhcpcd_status(DHCPCD_CONNECTION *, const char **);
249 bool dhcpcd_af_waiting(const DHCPCD_CONNECTION *);
250 const char * dhcpcd_cffile(DHCPCD_CONNECTION *);
251 bool dhcpcd_realloc(DHCPCD_CONNECTION *, size_t);
252 int dhcpcd_open(DHCPCD_CONNECTION *, bool priv);
253 void dhcpcd_close(DHCPCD_CONNECTION *);
254 void dhcpcd_free(DHCPCD_CONNECTION *);
255 void dhcpcd_set_if_callback(DHCPCD_CONNECTION *,
256     void (*)(DHCPCD_IF *, void *), void *);
257 void dhcpcd_set_status_callback(DHCPCD_CONNECTION *,
258     void (*)(DHCPCD_CONNECTION *, unsigned int, const char *, void *), void *);
259 int dhcpcd_get_fd(DHCPCD_CONNECTION *);
260 bool dhcpcd_privileged(DHCPCD_CONNECTION *);
261 void dhcpcd_dispatch(DHCPCD_CONNECTION *);
262 DHCPCD_IF * dhcpcd_interfaces(DHCPCD_CONNECTION *);
263 char **dhcpcd_interface_names(DHCPCD_CONNECTION *, size_t *);
264 void dhcpcd_freev(char **);
265 char **dhcpcd_interface_names_sorted(DHCPCD_CONNECTION *);
266 DHCPCD_IF * dhcpcd_get_if(DHCPCD_CONNECTION *, const char *, unsigned int);
267 DHCPCD_CONNECTION * dhcpcd_if_connection(DHCPCD_IF *);
268 const char *dhcpcd_get_value(const DHCPCD_IF *, const char *);
269 const char *dhcpcd_get_prefix_value(const DHCPCD_IF *, const char *,
270     const char *);
271 ssize_t dhcpcd_encode_string_escape(char *, size_t, const char *, size_t);
272 ssize_t dhcpcd_decode_string_escape(char *, size_t, const char *);
273 ssize_t dhcpcd_decode_hex(char *, size_t, const char *);
274 char * dhcpcd_if_message(DHCPCD_IF *, bool *);
275
276 ssize_t dhcpcd_command(DHCPCD_CONNECTION *, const char *, char **);
277 ssize_t dhcpcd_command_arg(DHCPCD_CONNECTION *, const char *, const char *,
278     char **);
279 #define dhcpcd_rebind(c, i)     dhcpcd_command_arg((c), "-n", (i), NULL)
280 #define dhcpcd_release(c, i)    dhcpcd_command_arg((c), "-k", (i), NULL)
281
282 void dhcpcd_wpa_start(DHCPCD_CONNECTION *);
283 DHCPCD_WPA *dhcpcd_wpa_find(DHCPCD_CONNECTION *, const char *);
284 DHCPCD_WPA *dhcpcd_wpa_new(DHCPCD_CONNECTION *, const char *);
285 DHCPCD_CONNECTION *dhcpcd_wpa_connection(DHCPCD_WPA *);
286 int dhcpcd_wpa_open(DHCPCD_WPA *);
287 void dhcpcd_wpa_close(DHCPCD_WPA *);
288 void dhcpcd_wpa_dispatch(DHCPCD_WPA *);
289 int dhcpcd_wpa_get_fd(DHCPCD_WPA *);
290 DHCPCD_IF *dhcpcd_wpa_if(DHCPCD_WPA *);
291 void dhcpcd_wpa_if_event(DHCPCD_IF *);
292 void dhcpcd_wpa_set_scan_callback(DHCPCD_CONNECTION *,
293     void (*)(DHCPCD_WPA *, void *), void *);
294 void dhcpcd_wpa_set_status_callback(DHCPCD_CONNECTION *,
295     void (*)(DHCPCD_WPA *, unsigned int, const char *, void *), void *);
296 int dhcpcd_wi_scan_compare(DHCPCD_WI_SCAN *a, DHCPCD_WI_SCAN *b);
297 DHCPCD_WI_SCAN * dhcpcd_wi_scans(DHCPCD_IF *);
298 bool dhcpcd_wi_associated(DHCPCD_IF *i, DHCPCD_WI_SCAN *s);
299 void dhcpcd_wi_scans_free(DHCPCD_WI_SCAN *);
300 void dhcpcd_wi_history_clear(DHCPCD_CONNECTION *);
301 bool dhcpcd_wpa_set_network(DHCPCD_WPA *, int, const char *, const char *);
302 int dhcpcd_wpa_find_network_new(DHCPCD_WPA *, const char *);
303 bool dhcpcd_wpa_command(DHCPCD_WPA *, const char *);
304 bool dhcpcd_wpa_command_arg(DHCPCD_WPA *, const char *, const char *);
305 unsigned int dhcpcd_wpa_status(DHCPCD_WPA *, const char **);
306
307 bool dhcpcd_wpa_ping(DHCPCD_WPA *);
308 bool dhcpcd_wpa_can_background_scan(DHCPCD_WPA *);
309 bool dhcpcd_wpa_scan(DHCPCD_WPA *);
310 bool dhcpcd_wpa_reconfigure(DHCPCD_WPA *);
311 bool dhcpcd_wpa_reassociate(DHCPCD_WPA *);
312 bool dhcpcd_wpa_disconnect(DHCPCD_WPA *);
313 bool dhcpcd_wpa_config_write(DHCPCD_WPA *);
314 int dhcpcd_wpa_network_find_new(DHCPCD_WPA *, const char *);
315 bool dhcpcd_wpa_network_disable(DHCPCD_WPA *, int);
316 bool dhcpcd_wpa_network_enable(DHCPCD_WPA *, int);
317 bool dhcpcd_wpa_network_select(DHCPCD_WPA *, int);
318 bool dhcpcd_wpa_network_remove(DHCPCD_WPA *, int);
319 char * dhcpcd_wpa_network_get(DHCPCD_WPA *, int, const char *);
320 bool dhcpcd_wpa_network_set(DHCPCD_WPA *, int, const char *, const char *);
321
322 #define DHCPCD_WPA_SUCCESS       0
323 #define DHCPCD_WPA_ERR          -1
324 #define DHCPCD_WPA_ERR_SET      -2
325 #define DHCPCD_WPA_ERR_SET_PSK  -3
326 #define DHCPCD_WPA_ERR_ENABLE   -4
327 #define DHCPCD_WPA_ERR_WRITE    -5
328 #define DHCPCD_WPA_ERR_SELECT   -6
329 #define DHCPCD_WPA_ERR_ASSOC    -7
330 #define DHCPCD_WPA_ERR_DISCONN  -8
331 #define DHCPCD_WPA_ERR_RECONF   -9
332 int dhcpcd_wpa_configure(DHCPCD_WPA *w, DHCPCD_WI_SCAN *s, const char *p);
333 int dhcpcd_wpa_select(DHCPCD_WPA *w, DHCPCD_WI_SCAN *s);
334
335 char ** dhcpcd_config_blocks(DHCPCD_CONNECTION *, const char *);
336 DHCPCD_OPTION *dhcpcd_config_read(DHCPCD_CONNECTION *,
337     const char *, const char *);
338 void dhcpcd_config_free(DHCPCD_OPTION *);
339 const char * dhcpcd_config_get(DHCPCD_OPTION *, const char *);
340 const char * dhcpcd_config_get_static(DHCPCD_OPTION *, const char *);
341 bool dhcpcd_config_set(DHCPCD_OPTION **, const char *, const char *);
342 bool dhcpcd_config_set_static(DHCPCD_OPTION **, const char *, const char *);
343 bool dhcpcd_config_writeable(DHCPCD_CONNECTION *con);
344 bool dhcpcd_config_write(DHCPCD_CONNECTION *,
345     const char *, const char *, const DHCPCD_OPTION *);
346
347 #ifdef __cplusplus
348 }
349 #endif
350
351 #endif