ed9eb5431ea3f79426e8e85562fd297ac5a782e7
[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 WPA_FREQ_IS_2G(f)       ((f) >= 2402 && (f) <= 2472)
71 #define WPA_FREQ_IS_5G(f)       ((f) >= 5170 && (f) <= 5835)
72
73 #define DHC_UNKNOWN              0
74 #define DHC_DOWN                 1
75 #define DHC_OPENED               2
76 #define DHC_INITIALISED          3
77 #define DHC_DISCONNECTED         4
78 #define DHC_CONNECTING           5
79 #define DHC_AF_WAITING           6
80 #define DHC_CONNECTED            7
81 #define DHC_MAX                  8
82 extern const char * const dhcpcd_cstates[];
83
84 #define DHT_UNKNOWN              0
85 #define DHT_LINK                 1
86 #define DHT_DHCP                 2
87 #define DHT_IPV4                 2
88 #define DHT_IPV4LL               3
89 #define DHT_IPV6                 4
90 #define DHT_RA                   5
91 #define DHT_DHCP6                6
92 #define DHT_MAX                  7
93
94 #define DHS_UNKNOWN              0
95 #define DHS_DUMP                 1
96 #define DHS_TEST                 2
97 #define DHS_STOPPED              3
98 #define DHS_FAIL                 4
99 #define DHS_STOP                 5
100 #define DHS_PREINIT              6
101 #define DHS_DEPARTED             7
102 #define DHS_NOCARRIER            8
103 #define DHS_NAK                  9
104 #define DHS_EXPIRE              10
105 #define DHS_RECONFIGURE         11
106 #define DHS_CARRIER             12
107 #define DHS_STATIC              13
108 #define DHS_3RDPARTY            14
109 #define DHS_IPV4LL              15
110 #define DHS_INFORM              16
111 #define DHS_BOUND               17
112 #define DHS_RENEW               18
113 #define DHS_REBIND              19
114 #define DHS_REBOOT              20
115 #define DHS_ROUTERADVERT        21
116 #define DHS_DELEGATED           22
117 #define DHR_MAX                 23
118
119 typedef struct dhcpcd_wi_avs {
120         int value;
121         int average;
122 } DHCPCD_WI_AV;
123
124 typedef struct dhcpcd_wi_scan {
125         struct dhcpcd_wi_scan *next;
126         char bssid[IF_BSSIDSIZE];
127         unsigned int flags;
128 #define WSF_SECURE              0x001
129 #define WSF_PSK                 0x002
130 #define WSF_WEP                 0x010
131 #define WSF_WPA                 0x020
132 #define WSF_2G                  0x100
133 #define WSF_5G                  0x200
134         int frequency;
135         DHCPCD_WI_AV quality;
136         DHCPCD_WI_AV noise;
137         DHCPCD_WI_AV level;
138         DHCPCD_WI_AV strength;
139         char ssid[IF_SSIDSIZE];
140         char wpa_flags[FLAGSIZE];
141 } DHCPCD_WI_SCAN;
142
143 #ifdef IN_LIBDHCPCD
144 typedef struct dhcpcd_if {
145         struct dhcpcd_if *next;
146         const char *ifname;
147         unsigned int type;
148         unsigned int state;
149         const char *reason;
150
151         unsigned int ifflags;
152         bool up;
153         bool wireless;
154         const char *ssid;
155         int freq;
156
157         char *data;
158         size_t data_len;
159
160         char *last_message;
161
162         struct dhcpcd_connection *con;
163 } DHCPCD_IF;
164 #else
165 typedef struct dhcpcd_if {
166         struct dhcpcd_if *next;
167         const char *ifname;
168         unsigned int type;
169         unsigned int state;
170         const char *reason;
171
172         unsigned int ifflags;
173         bool up;
174         bool wireless;
175         const char *ssid;
176         int freq;
177 } DHCPCD_IF;
178 #endif
179
180 typedef struct dhcpcd_config {
181         struct dhcpcd_config *next;
182         char *option;
183         char *value;
184 } DHCPCD_OPTION;
185
186 #ifdef IN_LIBDHCPCD
187 typedef struct dhcpcd_wi_hist {
188         struct dhcpcd_wi_hist *next;
189         char ifname[IF_NAMESIZE];
190         char bssid[IF_BSSIDSIZE];
191         int quality;
192         int noise;
193         int level;
194         int strength;
195 } DHCPCD_WI_HIST;
196
197 typedef struct dhcpcd_wpa {
198         struct dhcpcd_wpa *next;
199         char ifname[IF_NAMESIZE];
200         unsigned int status;
201         int command_fd;
202         char *command_path;
203         int listen_fd;
204         char *listen_path;
205         bool attached;
206         struct dhcpcd_connection *con;
207 } DHCPCD_WPA;
208
209 typedef struct dhcpcd_connection {
210         struct dhcpcd_connection *next;
211         bool open;
212         bool privileged;
213         int command_fd;
214         int listen_fd;
215         const char *progname;
216
217         DHCPCD_IF *interfaces;
218         DHCPCD_WPA *wpa;
219         DHCPCD_WI_HIST *wi_history;
220
221         void (*if_cb)(DHCPCD_IF *, void *);
222         void *if_context;
223         void (*status_cb)(struct dhcpcd_connection *,
224             unsigned int, const char *, void *);
225         void *status_context;
226         bool wpa_started;
227         void (*wi_scanresults_cb)(DHCPCD_WPA *, void *);
228         void *wi_scanresults_context;
229         void (*wpa_status_cb)(DHCPCD_WPA *, unsigned int, const char *, void *);
230         void *wpa_status_context;
231
232         char *buf;
233         size_t buflen;
234
235         char *version;
236         bool terminate_commands;
237         char *error;
238         int err;
239         int errors;
240         unsigned int status;
241         bool af_waiting;
242
243         char *cffile;
244 } DHCPCD_CONNECTION;
245
246 #else
247 typedef void *DHCPCD_CONFIG;
248 typedef void *DHCPCD_WPA;
249 typedef void *DHCPCD_CONNECTION;
250 #endif
251
252 DHCPCD_CONNECTION * dhcpcd_new(void);
253 const char * dhcpcd_version(DHCPCD_CONNECTION *);
254 void dhcpcd_set_progname(DHCPCD_CONNECTION *, const char *);
255 const char * dhcpcd_get_progname(const DHCPCD_CONNECTION *);
256 unsigned int dhcpcd_status(DHCPCD_CONNECTION *, const char **);
257 bool dhcpcd_af_waiting(const DHCPCD_CONNECTION *);
258 const char * dhcpcd_cffile(DHCPCD_CONNECTION *);
259 bool dhcpcd_realloc(DHCPCD_CONNECTION *, size_t);
260 int dhcpcd_open(DHCPCD_CONNECTION *, bool priv);
261 void dhcpcd_close(DHCPCD_CONNECTION *);
262 void dhcpcd_free(DHCPCD_CONNECTION *);
263 void dhcpcd_set_if_callback(DHCPCD_CONNECTION *,
264     void (*)(DHCPCD_IF *, void *), void *);
265 void dhcpcd_set_status_callback(DHCPCD_CONNECTION *,
266     void (*)(DHCPCD_CONNECTION *, unsigned int, const char *, void *), void *);
267 int dhcpcd_get_fd(DHCPCD_CONNECTION *);
268 bool dhcpcd_privileged(DHCPCD_CONNECTION *);
269 void dhcpcd_dispatch(DHCPCD_CONNECTION *);
270 DHCPCD_IF * dhcpcd_interfaces(DHCPCD_CONNECTION *);
271 char **dhcpcd_interface_names(DHCPCD_CONNECTION *, size_t *);
272 void dhcpcd_freev(char **);
273 char **dhcpcd_interface_names_sorted(DHCPCD_CONNECTION *);
274 DHCPCD_IF * dhcpcd_get_if(DHCPCD_CONNECTION *, const char *, unsigned int);
275 DHCPCD_CONNECTION * dhcpcd_if_connection(DHCPCD_IF *);
276 const char *dhcpcd_get_value(const DHCPCD_IF *, const char *);
277 const char *dhcpcd_get_prefix_value(const DHCPCD_IF *, const char *,
278     const char *);
279 ssize_t dhcpcd_encode_string_escape(char *, size_t, const char *, size_t);
280 ssize_t dhcpcd_decode_string_escape(char *, size_t, const char *);
281 ssize_t dhcpcd_decode_hex(char *, size_t, const char *);
282 char * dhcpcd_if_message(DHCPCD_IF *, bool *);
283
284 ssize_t dhcpcd_command(DHCPCD_CONNECTION *, const char *, char **);
285 ssize_t dhcpcd_command_arg(DHCPCD_CONNECTION *, const char *, const char *,
286     char **);
287 #define dhcpcd_rebind(c, i)     dhcpcd_command_arg((c), "-n", (i), NULL)
288 #define dhcpcd_release(c, i)    dhcpcd_command_arg((c), "-k", (i), NULL)
289
290 void dhcpcd_wpa_start(DHCPCD_CONNECTION *);
291 DHCPCD_WPA *dhcpcd_wpa_find(DHCPCD_CONNECTION *, const char *);
292 DHCPCD_WPA *dhcpcd_wpa_new(DHCPCD_CONNECTION *, const char *);
293 DHCPCD_CONNECTION *dhcpcd_wpa_connection(DHCPCD_WPA *);
294 int dhcpcd_wpa_open(DHCPCD_WPA *);
295 void dhcpcd_wpa_close(DHCPCD_WPA *);
296 void dhcpcd_wpa_dispatch(DHCPCD_WPA *);
297 int dhcpcd_wpa_get_fd(DHCPCD_WPA *);
298 DHCPCD_IF *dhcpcd_wpa_if(DHCPCD_WPA *);
299 void dhcpcd_wpa_if_event(DHCPCD_IF *);
300 void dhcpcd_wpa_set_scan_callback(DHCPCD_CONNECTION *,
301     void (*)(DHCPCD_WPA *, void *), void *);
302 void dhcpcd_wpa_set_status_callback(DHCPCD_CONNECTION *,
303     void (*)(DHCPCD_WPA *, unsigned int, const char *, void *), void *);
304 int dhcpcd_wi_scan_compare(DHCPCD_WI_SCAN *a, DHCPCD_WI_SCAN *b);
305 DHCPCD_WI_SCAN * dhcpcd_wi_scans(DHCPCD_IF *);
306 bool dhcpcd_wi_associated(DHCPCD_IF *i, DHCPCD_WI_SCAN *s);
307 void dhcpcd_wi_scans_free(DHCPCD_WI_SCAN *);
308 void dhcpcd_wi_history_clear(DHCPCD_CONNECTION *);
309 bool dhcpcd_wpa_set_network(DHCPCD_WPA *, int, const char *, const char *);
310 int dhcpcd_wpa_find_network_new(DHCPCD_WPA *, const char *);
311 bool dhcpcd_wpa_command(DHCPCD_WPA *, const char *);
312 bool dhcpcd_wpa_command_arg(DHCPCD_WPA *, const char *, const char *);
313 unsigned int dhcpcd_wpa_status(DHCPCD_WPA *, const char **);
314 int dhcpcd_wpa_freq(DHCPCD_WPA *);
315 #define WST_BSSID       0x01
316 #define WST_FLAGS       0x02
317 #define WST_FREQ        0x03
318 int dhcpcd_wi_print_tooltip(char *, size_t, DHCPCD_WI_SCAN *, unsigned int);
319
320 bool dhcpcd_wpa_ping(DHCPCD_WPA *);
321 bool dhcpcd_wpa_can_background_scan(DHCPCD_WPA *);
322 bool dhcpcd_wpa_scan(DHCPCD_WPA *);
323 bool dhcpcd_wpa_reconfigure(DHCPCD_WPA *);
324 bool dhcpcd_wpa_reassociate(DHCPCD_WPA *);
325 bool dhcpcd_wpa_disconnect(DHCPCD_WPA *);
326 bool dhcpcd_wpa_config_write(DHCPCD_WPA *);
327 int dhcpcd_wpa_network_find_new(DHCPCD_WPA *, const char *);
328 bool dhcpcd_wpa_network_disable(DHCPCD_WPA *, int);
329 bool dhcpcd_wpa_network_enable(DHCPCD_WPA *, int);
330 bool dhcpcd_wpa_network_select(DHCPCD_WPA *, int);
331 bool dhcpcd_wpa_network_remove(DHCPCD_WPA *, int);
332 char * dhcpcd_wpa_network_get(DHCPCD_WPA *, int, const char *);
333 bool dhcpcd_wpa_network_set(DHCPCD_WPA *, int, const char *, const char *);
334
335 #define DHCPCD_WPA_SUCCESS       0
336 #define DHCPCD_WPA_ERR          -1
337 #define DHCPCD_WPA_ERR_SET      -2
338 #define DHCPCD_WPA_ERR_SET_PSK  -3
339 #define DHCPCD_WPA_ERR_ENABLE   -4
340 #define DHCPCD_WPA_ERR_WRITE    -5
341 #define DHCPCD_WPA_ERR_SELECT   -6
342 #define DHCPCD_WPA_ERR_ASSOC    -7
343 #define DHCPCD_WPA_ERR_DISCONN  -8
344 #define DHCPCD_WPA_ERR_RECONF   -9
345 int dhcpcd_wpa_configure(DHCPCD_WPA *w, DHCPCD_WI_SCAN *s, const char *p);
346 int dhcpcd_wpa_select(DHCPCD_WPA *w, DHCPCD_WI_SCAN *s);
347
348 char ** dhcpcd_config_blocks(DHCPCD_CONNECTION *, const char *);
349 DHCPCD_OPTION *dhcpcd_config_read(DHCPCD_CONNECTION *,
350     const char *, const char *);
351 void dhcpcd_config_free(DHCPCD_OPTION *);
352 const char * dhcpcd_config_get(DHCPCD_OPTION *, const char *);
353 const char * dhcpcd_config_get_static(DHCPCD_OPTION *, const char *);
354 bool dhcpcd_config_set(DHCPCD_OPTION **, const char *, const char *);
355 bool dhcpcd_config_set_static(DHCPCD_OPTION **, const char *, const char *);
356 bool dhcpcd_config_writeable(DHCPCD_CONNECTION *con);
357 bool dhcpcd_config_write(DHCPCD_CONNECTION *,
358     const char *, const char *, const DHCPCD_OPTION *);
359
360 #ifdef __cplusplus
361 }
362 #endif
363
364 #endif