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