Fix a crash by clearing our reference to the menuwidget when it is deleted
[dhcpcd-ui] / src / libdhcpcd / dhcpcd.h
1 /*
2  * libdhcpcd
3  * Copyright 2009-2014 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 #define DHCPCD_RETRYOPEN        100     /* milliseconds */
51 #define DHCPCD_WPA_PING         500     /* milliseconds */
52 #define DHCPCD_WI_HIST_MAX      10      /* Recall 10 scans for averages */
53
54 /* Each non printable byte of the SSID is represented as \000 */
55 #define IF_SSIDSIZE             ((32 * 4) + 1)
56 #define IF_BSSIDSIZE            64
57 #define FLAGSIZE                64
58 #define TYPESIZE                8
59 #define REASONSIZE              16
60
61 typedef struct dhcpcd_wi_avs {
62         int value;
63         int average;
64 } DHCPCD_WI_AV;
65
66 typedef struct dhcpcd_wi_scan {
67         struct dhcpcd_wi_scan *next;
68         char bssid[IF_BSSIDSIZE];
69         int flags;
70 #define WSF_SECURE              0x01
71 #define WSF_PSK                 0x02
72 #define WSF_WEP                 0x10
73 #define WSF_WPA                 0x20
74         int frequency;
75         DHCPCD_WI_AV quality;
76         DHCPCD_WI_AV noise;
77         DHCPCD_WI_AV level;
78         DHCPCD_WI_AV strength;
79         char ssid[IF_SSIDSIZE];
80         char wpa_flags[FLAGSIZE];
81 } DHCPCD_WI_SCAN;
82
83 #ifdef IN_LIBDHCPCD
84 typedef struct dhcpcd_if {
85         struct dhcpcd_if *next;
86         const char *ifname;
87         const char *type;
88         const char *reason;
89
90         unsigned int flags;
91         bool up;
92         bool wireless;
93         const char *ssid;
94
95         char *data;
96         size_t data_len;
97
98         char *last_message;
99
100         struct dhcpcd_connection *con;
101 } DHCPCD_IF;
102 #else
103 typedef struct dhcpcd_if {
104         struct dhcpcd_if *next;
105         const char *ifname;
106         const char *type;
107         const char *reason;
108
109         int flags;
110         bool up;
111         bool wireless;
112         const char *ssid;
113 } DHCPCD_IF;
114 #endif
115
116 typedef struct dhcpcd_config {
117         struct dhcpcd_config *next;
118         char *option;
119         char *value;
120 } DHCPCD_OPTION;
121
122 #ifdef IN_LIBDHCPCD
123 typedef struct dhcpcd_wi_hist {
124         struct dhcpcd_wi_hist *next;
125         char ifname[IF_NAMESIZE];
126         char bssid[IF_BSSIDSIZE];
127         int quality;
128         int noise;
129         int level;
130         int strength;
131 } DHCPCD_WI_HIST;
132
133 typedef struct dhcpcd_wpa {
134         struct dhcpcd_wpa *next;
135         char ifname[IF_NAMESIZE];
136         bool open;
137         int command_fd;
138         char *command_path;
139         int listen_fd;
140         char *listen_path;
141         bool attached;
142         struct dhcpcd_connection *con;
143 } DHCPCD_WPA;
144
145 typedef struct dhcpcd_connection {
146         struct dhcpcd_connection *next;
147         bool open;
148         bool privileged;
149         int command_fd;
150         int listen_fd;
151         const char *progname;
152
153         DHCPCD_IF *interfaces;
154         DHCPCD_WPA *wpa;
155         DHCPCD_WI_HIST *wi_history;
156
157         void (*if_cb)(DHCPCD_IF *, void *);
158         void *if_context;
159         void (*status_cb)(struct dhcpcd_connection *, const char *, void *);
160         void *status_context;
161         bool wpa_started;
162         void (*wi_scanresults_cb)(DHCPCD_WPA *, void *);
163         void *wi_scanresults_context;
164         void (*wpa_status_cb)(DHCPCD_WPA *, const char *, void *);
165         void *wpa_status_context;
166
167         char *buf;
168         size_t buflen;
169
170         char *version;
171         bool terminate_commands;
172         char *error;
173         int err;
174         int errors;
175         const char *status;
176
177         char *cffile;
178 } DHCPCD_CONNECTION;
179
180 #else
181 typedef void *DHCPCD_CONFIG;
182 typedef void *DHCPCD_WPA;
183 typedef void *DHCPCD_CONNECTION;
184 #endif
185
186 DHCPCD_CONNECTION * dhcpcd_new(void);
187 const char * dhcpcd_version(DHCPCD_CONNECTION *);
188 void dhcpcd_set_progname(DHCPCD_CONNECTION *, const char *);
189 const char * dhcpcd_get_progname(const DHCPCD_CONNECTION *);
190 const char * dhcpcd_status(DHCPCD_CONNECTION *);
191 const char * dhcpcd_cffile(DHCPCD_CONNECTION *);
192 bool dhcpcd_realloc(DHCPCD_CONNECTION *, size_t);
193 int dhcpcd_open(DHCPCD_CONNECTION *, bool priv);
194 void dhcpcd_close(DHCPCD_CONNECTION *);
195 void dhcpcd_free(DHCPCD_CONNECTION *);
196 void dhcpcd_set_if_callback(DHCPCD_CONNECTION *,
197     void (*)(DHCPCD_IF *, void *), void *);
198 void dhcpcd_set_status_callback(DHCPCD_CONNECTION *,
199     void (*)(DHCPCD_CONNECTION *, const char *, void *), void *);
200 int dhcpcd_get_fd(DHCPCD_CONNECTION *);
201 bool dhcpcd_privileged(DHCPCD_CONNECTION *);
202 void dhcpcd_dispatch(DHCPCD_CONNECTION *);
203 DHCPCD_IF * dhcpcd_interfaces(DHCPCD_CONNECTION *);
204 char **dhcpcd_interface_names(DHCPCD_CONNECTION *, size_t *);
205 void dhcpcd_freev(char **);
206 char **dhcpcd_interface_names_sorted(DHCPCD_CONNECTION *);
207 DHCPCD_IF * dhcpcd_get_if(DHCPCD_CONNECTION *, const char *, const char *);
208 DHCPCD_CONNECTION * dhcpcd_if_connection(DHCPCD_IF *);
209 const char *dhcpcd_get_value(const DHCPCD_IF *, const char *);
210 const char *dhcpcd_get_prefix_value(const DHCPCD_IF *, const char *,
211     const char *);
212 ssize_t dhcpcd_encode_string_escape(char *, size_t, const char *, size_t);
213 ssize_t dhcpcd_decode_string_escape(char *, size_t, const char *);
214 ssize_t dhcpcd_decode_hex(char *, size_t, const char *);
215 char * dhcpcd_if_message(DHCPCD_IF *, bool *);
216
217 ssize_t dhcpcd_command(DHCPCD_CONNECTION *, const char *, char **);
218 ssize_t dhcpcd_command_arg(DHCPCD_CONNECTION *, const char *, const char *,
219     char **);
220 #define dhcpcd_rebind(c, i)     dhcpcd_command_arg((c), "-n", (i), NULL)
221 #define dhcpcd_release(c, i)    dhcpcd_command_arg((c), "-k", (i), NULL)
222
223 void dhcpcd_wpa_start(DHCPCD_CONNECTION *);
224 DHCPCD_WPA *dhcpcd_wpa_find(DHCPCD_CONNECTION *, const char *);
225 DHCPCD_WPA *dhcpcd_wpa_new(DHCPCD_CONNECTION *, const char *);
226 DHCPCD_CONNECTION *dhcpcd_wpa_connection(DHCPCD_WPA *);
227 int dhcpcd_wpa_open(DHCPCD_WPA *);
228 void dhcpcd_wpa_close(DHCPCD_WPA *);
229 void dhcpcd_wpa_dispatch(DHCPCD_WPA *);
230 int dhcpcd_wpa_get_fd(DHCPCD_WPA *);
231 DHCPCD_IF *dhcpcd_wpa_if(DHCPCD_WPA *);
232 void dhcpcd_wpa_if_event(DHCPCD_IF *);
233 void dhcpcd_wpa_set_scan_callback(DHCPCD_CONNECTION *,
234     void (*)(DHCPCD_WPA *, void *), void *);
235 void dhcpcd_wpa_set_status_callback(DHCPCD_CONNECTION *,
236     void (*)(DHCPCD_WPA *, const char *, void *), void *);
237 int dhcpcd_wi_scan_compare(DHCPCD_WI_SCAN *a, DHCPCD_WI_SCAN *b);
238 DHCPCD_WI_SCAN * dhcpcd_wi_scans(DHCPCD_IF *);
239 bool dhcpcd_wi_associated(DHCPCD_IF *i, DHCPCD_WI_SCAN *s);
240 void dhcpcd_wi_scans_free(DHCPCD_WI_SCAN *);
241 void dhcpcd_wi_history_clear(DHCPCD_CONNECTION *);
242 bool dhcpcd_wpa_set_network(DHCPCD_WPA *, int, const char *, const char *);
243 int dhcpcd_wpa_find_network_new(DHCPCD_WPA *, const char *);
244 bool dhcpcd_wpa_command(DHCPCD_WPA *, const char *);
245 bool dhcpcd_wpa_command_arg(DHCPCD_WPA *, const char *, const char *);
246
247 bool dhcpcd_wpa_ping(DHCPCD_WPA *);
248 bool dhcpcd_wpa_scan(DHCPCD_WPA *);
249 bool dhcpcd_wpa_reconfigure(DHCPCD_WPA *);
250 bool dhcpcd_wpa_reassociate(DHCPCD_WPA *);
251 bool dhcpcd_wpa_disconnect(DHCPCD_WPA *);
252 bool dhcpcd_wpa_config_write(DHCPCD_WPA *);
253 int dhcpcd_wpa_network_find_new(DHCPCD_WPA *, const char *);
254 bool dhcpcd_wpa_network_disable(DHCPCD_WPA *, int);
255 bool dhcpcd_wpa_network_enable(DHCPCD_WPA *, int);
256 bool dhcpcd_wpa_network_select(DHCPCD_WPA *, int);
257 bool dhcpcd_wpa_network_remove(DHCPCD_WPA *, int);
258 char * dhcpcd_wpa_network_get(DHCPCD_WPA *, int, const char *);
259 bool dhcpcd_wpa_network_set(DHCPCD_WPA *, int, const char *, const char *);
260
261 #define DHCPCD_WPA_SUCCESS       0
262 #define DHCPCD_WPA_ERR          -1
263 #define DHCPCD_WPA_ERR_SET      -2
264 #define DHCPCD_WPA_ERR_SET_PSK  -3
265 #define DHCPCD_WPA_ERR_ENABLE   -4
266 #define DHCPCD_WPA_ERR_WRITE    -5
267 #define DHCPCD_WPA_ERR_SELECT   -6
268 #define DHCPCD_WPA_ERR_ASSOC    -7
269 #define DHCPCD_WPA_ERR_DISCONN  -8
270 #define DHCPCD_WPA_ERR_RECONF   -9
271 int dhcpcd_wpa_configure(DHCPCD_WPA *w, DHCPCD_WI_SCAN *s, const char *p);
272 int dhcpcd_wpa_select(DHCPCD_WPA *w, DHCPCD_WI_SCAN *s);
273
274 char ** dhcpcd_config_blocks(DHCPCD_CONNECTION *, const char *);
275 DHCPCD_OPTION *dhcpcd_config_read(DHCPCD_CONNECTION *,
276     const char *, const char *);
277 void dhcpcd_config_free(DHCPCD_OPTION *);
278 const char * dhcpcd_config_get(DHCPCD_OPTION *, const char *);
279 const char * dhcpcd_config_get_static(DHCPCD_OPTION *, const char *);
280 bool dhcpcd_config_set(DHCPCD_OPTION **, const char *, const char *);
281 bool dhcpcd_config_set_static(DHCPCD_OPTION **, const char *, const char *);
282 bool dhcpcd_config_writeable(DHCPCD_CONNECTION *con);
283 bool dhcpcd_config_write(DHCPCD_CONNECTION *,
284     const char *, const char *, const DHCPCD_OPTION *);
285
286 #ifdef __cplusplus
287 }
288 #endif
289
290 #endif