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