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