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