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