gsupplicant/gsupplicant.h

   1 /*
   2  *
   3  *  WPA supplicant library with GLib integration
   4  *
   5  *  Copyright (C) 2012  Intel Corporation. All rights reserved.
   6  *
   7  *  This program is free software; you can redistribute it and/or modify
   8  *  it under the terms of the GNU General Public License version 2 as
   9  *  published by the Free Software Foundation.
  10  *
  11  *  This program is distributed in the hope that it will be useful,
  12  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14  *  GNU General Public License for more details.
  15  *
  16  *  You should have received a copy of the GNU General Public License
  17  *  along with this program; if not, write to the Free Software
  18  *  Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
  19  *
  20  */
  21 #ifndef __G_SUPPLICANT_H
  22 #define __G_SUPPLICANT_H
  23
  24 #ifdef __cplusplus
  25 extern "C" {
  26 #endif
  27
  28 #define G_SUPPLICANT_EAP_METHOD_MD5     (1 << 0)
  29 #define G_SUPPLICANT_EAP_METHOD_TLS     (1 << 1)
  30 #define G_SUPPLICANT_EAP_METHOD_MSCHAPV2        (1 << 2)
  31 #define G_SUPPLICANT_EAP_METHOD_PEAP    (1 << 3)
  32 #define G_SUPPLICANT_EAP_METHOD_TTLS    (1 << 4)
  33 #define G_SUPPLICANT_EAP_METHOD_GTC     (1 << 5)
  34 #define G_SUPPLICANT_EAP_METHOD_OTP     (1 << 6)
  35 #define G_SUPPLICANT_EAP_METHOD_LEAP    (1 << 7)
  36 #define G_SUPPLICANT_EAP_METHOD_WSC     (1 << 8)
  37
  38 #define G_SUPPLICANT_CAPABILITY_AUTHALG_OPEN    (1 << 0)
  39 #define G_SUPPLICANT_CAPABILITY_AUTHALG_SHARED  (1 << 1)
  40 #define G_SUPPLICANT_CAPABILITY_AUTHALG_LEAP    (1 << 2)
  41
  42 #define G_SUPPLICANT_CAPABILITY_PROTO_WPA               (1 << 0)
  43 #define G_SUPPLICANT_CAPABILITY_PROTO_RSN               (1 << 1)
  44
  45 #define G_SUPPLICANT_CAPABILITY_SCAN_ACTIVE     (1 << 0)
  46 #define G_SUPPLICANT_CAPABILITY_SCAN_PASSIVE    (1 << 1)
  47 #define G_SUPPLICANT_CAPABILITY_SCAN_SSID               (1 << 2)
  48
  49 #define G_SUPPLICANT_CAPABILITY_MODE_INFRA      (1 << 0)
  50 #define G_SUPPLICANT_CAPABILITY_MODE_IBSS               (1 << 1)
  51 #define G_SUPPLICANT_CAPABILITY_MODE_AP         (1 << 2)
  52
  53 #define G_SUPPLICANT_KEYMGMT_NONE               (1 << 0)
  54 #define G_SUPPLICANT_KEYMGMT_IEEE8021X  (1 << 1)
  55 #define G_SUPPLICANT_KEYMGMT_WPA_NONE   (1 << 2)
  56 #define G_SUPPLICANT_KEYMGMT_WPA_PSK    (1 << 3)
  57 #define G_SUPPLICANT_KEYMGMT_WPA_PSK_256        (1 << 4)
  58 #define G_SUPPLICANT_KEYMGMT_WPA_FT_PSK (1 << 5)
  59 #define G_SUPPLICANT_KEYMGMT_WPA_FT_EAP (1 << 6)
  60 #define G_SUPPLICANT_KEYMGMT_WPA_EAP    (1 << 7)
  61 #define G_SUPPLICANT_KEYMGMT_WPA_EAP_256        (1 << 8)
  62 #define G_SUPPLICANT_KEYMGMT_WPS                (1 << 9)
  63
  64 #define G_SUPPLICANT_PROTO_WPA          (1 << 0)
  65 #define G_SUPPLICANT_PROTO_RSN          (1 << 1)
  66
  67 #define G_SUPPLICANT_GROUP_WEP40                (1 << 0)
  68 #define G_SUPPLICANT_GROUP_WEP104               (1 << 1)
  69 #define G_SUPPLICANT_GROUP_TKIP         (1 << 2)
  70 #define G_SUPPLICANT_GROUP_CCMP         (1 << 3)
  71
  72 #define G_SUPPLICANT_PAIRWISE_NONE      (1 << 0)
  73 #define G_SUPPLICANT_PAIRWISE_TKIP      (1 << 1)
  74 #define G_SUPPLICANT_PAIRWISE_CCMP      (1 << 2)
  75
  76 #define G_SUPPLICANT_WPS_CONFIGURED     (1 << 0)
  77 #define G_SUPPLICANT_WPS_PBC            (1 << 1)
  78 #define G_SUPPLICANT_WPS_PIN            (1 << 2)
  79 #define G_SUPPLICANT_WPS_REGISTRAR      (1 << 3)
  80
  81 typedef enum {
  82         G_SUPPLICANT_MODE_UNKNOWN,
  83         G_SUPPLICANT_MODE_INFRA,
  84         G_SUPPLICANT_MODE_IBSS,
  85         G_SUPPLICANT_MODE_MASTER,
  86 } GSupplicantMode;
  87
  88 typedef enum {
  89         G_SUPPLICANT_SECURITY_UNKNOWN,
  90         G_SUPPLICANT_SECURITY_NONE,
  91         G_SUPPLICANT_SECURITY_WEP,
  92         G_SUPPLICANT_SECURITY_PSK,
  93         G_SUPPLICANT_SECURITY_IEEE8021X,
  94 } GSupplicantSecurity;
  95
  96 typedef enum {
  97         G_SUPPLICANT_STATE_UNKNOWN,
  98         G_SUPPLICANT_STATE_DISCONNECTED,
  99         G_SUPPLICANT_STATE_INACTIVE,
 100         G_SUPPLICANT_STATE_SCANNING,
 101         G_SUPPLICANT_STATE_AUTHENTICATING,
 102         G_SUPPLICANT_STATE_ASSOCIATING,
 103         G_SUPPLICANT_STATE_ASSOCIATED,
 104         G_SUPPLICANT_STATE_4WAY_HANDSHAKE,
 105         G_SUPPLICANT_STATE_GROUP_HANDSHAKE,
 106         G_SUPPLICANT_STATE_COMPLETED,
 107 } GSupplicantState;
 108
 109 typedef enum {
 110         G_SUPPLICANT_WPS_STATE_UNKNOWN,
 111         G_SUPPLICANT_WPS_STATE_SUCCESS,
 112         G_SUPPLICANT_WPS_STATE_FAIL,
 113 } GSupplicantWpsState;
 114
 115 struct _GSupplicantSSID {
 116         const void *ssid;
 117         unsigned int ssid_len;
 118         unsigned int scan_ssid;
 119         GSupplicantMode mode;
 120         GSupplicantSecurity security;
 121         unsigned int protocol;
 122         unsigned int pairwise_cipher;
 123         unsigned int group_cipher;
 124         unsigned int freq;
 125         const char *eap;
 126         const char *passphrase;
 127         const char *identity;
 128         const char *ca_cert_path;
 129         const char *client_cert_path;
 130         const char *private_key_path;
 131         const char *private_key_passphrase;
 132         const char *phase2_auth;
 133         dbus_bool_t use_wps;
 134         const char *pin_wps;
 135         const char *bgscan;
 136 };
 137
 138 typedef struct _GSupplicantSSID GSupplicantSSID;
 139
 140 /*
 141  * Max number of SSIDs that can be scanned.
 142  * In wpa_s 0.7x the limit is 4.
 143  * In wps_s 0.8 or later it is 16.
 144  * The value is only used if wpa_supplicant does not return any max limit
 145  * for number of scannable SSIDs.
 146  */
 147 #define WPAS_MAX_SCAN_SSIDS 4
 148
 149 struct scan_ssid {
 150         unsigned char ssid[32];
 151         uint8_t ssid_len;
 152 };
 153
 154 struct _GSupplicantScanParams {
 155         GSList *ssids;
 156
 157         uint8_t num_ssids;
 158
 159         uint16_t *freqs;
 160 };
 161
 162 typedef struct _GSupplicantScanParams GSupplicantScanParams;
 163
 164 /* global API */
 165 typedef void (*GSupplicantCountryCallback) (int result,
 166                                                 const char *alpha2,
 167                                                         void *user_data);
 168
 169 int g_supplicant_set_country(const char *alpha2,
 170                                 GSupplicantCountryCallback callback,
 171                                                 const void *user_data);
 172
 173 /* Interface API */
 174 struct _GSupplicantInterface;
 175
 176 typedef struct _GSupplicantInterface GSupplicantInterface;
 177
 178 typedef void (*GSupplicantInterfaceCallback) (int result,
 179                                         GSupplicantInterface *interface,
 180                                                         void *user_data);
 181
 182 int g_supplicant_interface_create(const char *ifname, const char *driver,
 183                                         const char *bridge,
 184                                         GSupplicantInterfaceCallback callback,
 185                                                         void *user_data);
 186 int g_supplicant_interface_remove(GSupplicantInterface *interface,
 187                                         GSupplicantInterfaceCallback callback,
 188                                                         void *user_data);
 189 int g_supplicant_interface_scan(GSupplicantInterface *interface,
 190                                         GSupplicantScanParams *scan_data,
 191                                         GSupplicantInterfaceCallback callback,
 192                                                         void *user_data);
 193
 194 int g_supplicant_interface_autoscan(GSupplicantInterface *interface,
 195                                         const char *autoscan_data,
 196                                         GSupplicantInterfaceCallback callback,
 197                                                         void *user_data);
 198
 199 int g_supplicant_interface_connect(GSupplicantInterface *interface,
 200                                         GSupplicantSSID *ssid,
 201                                         GSupplicantInterfaceCallback callback,
 202                                                         void *user_data);
 203
 204 int g_supplicant_interface_disconnect(GSupplicantInterface *interface,
 205                                         GSupplicantInterfaceCallback callback,
 206                                                         void *user_data);
 207
 208 int g_supplicant_interface_set_apscan(GSupplicantInterface *interface,
 209                                                         unsigned int ap_scan);
 210
 211 void g_supplicant_interface_set_data(GSupplicantInterface *interface,
 212                                                                 void *data);
 213 void *g_supplicant_interface_get_data(GSupplicantInterface *interface);
 214 const char *g_supplicant_interface_get_ifname(GSupplicantInterface *interface);
 215 const char *g_supplicant_interface_get_driver(GSupplicantInterface *interface);
 216 GSupplicantState g_supplicant_interface_get_state(GSupplicantInterface *interface);
 217 const char *g_supplicant_interface_get_wps_key(GSupplicantInterface *interface);
 218 const void *g_supplicant_interface_get_wps_ssid(GSupplicantInterface *interface,
 219                                                         unsigned int *ssid_len);
 220 GSupplicantWpsState g_supplicant_interface_get_wps_state(GSupplicantInterface *interface);
 221 unsigned int g_supplicant_interface_get_mode(GSupplicantInterface *interface);
 222 dbus_bool_t g_supplicant_interface_get_ready(GSupplicantInterface *interface);
 223 unsigned int g_supplicant_interface_get_max_scan_ssids(
 224                                         GSupplicantInterface *interface);
 225
 226 int g_supplicant_interface_enable_selected_network(GSupplicantInterface *interface,
 227                                                         dbus_bool_t enable);
 228 int g_supplicant_interface_set_country(GSupplicantInterface *interface,
 229                                         GSupplicantCountryCallback callback,
 230                                                         const char *alpha2,
 231                                                         void *user_data);
 232
 233 /* Network API */
 234 struct _GSupplicantNetwork;
 235
 236 typedef struct _GSupplicantNetwork GSupplicantNetwork;
 237
 238 GSupplicantInterface *g_supplicant_network_get_interface(GSupplicantNetwork *network);
 239 const char *g_supplicant_network_get_name(GSupplicantNetwork *network);
 240 const char *g_supplicant_network_get_identifier(GSupplicantNetwork *network);
 241 const char *g_supplicant_network_get_path(GSupplicantNetwork *network);
 242 const void *g_supplicant_network_get_ssid(GSupplicantNetwork *network,
 243                                                         unsigned int *ssid_len);
 244 const char *g_supplicant_network_get_mode(GSupplicantNetwork *network);
 245 const char *g_supplicant_network_get_security(GSupplicantNetwork *network);
 246 dbus_int16_t g_supplicant_network_get_signal(GSupplicantNetwork *network);
 247 dbus_uint16_t g_supplicant_network_get_frequency(GSupplicantNetwork *network);
 248 dbus_bool_t g_supplicant_network_get_wps(GSupplicantNetwork *network);
 249 dbus_bool_t g_supplicant_network_is_wps_active(GSupplicantNetwork *network);
 250 dbus_bool_t g_supplicant_network_is_wps_pbc(GSupplicantNetwork *network);
 251 dbus_bool_t g_supplicant_network_is_wps_advertizing(GSupplicantNetwork *network);
 252
 253 struct _GSupplicantCallbacks {
 254         void (*system_ready) (void);
 255         void (*system_killed) (void);
 256         void (*interface_added) (GSupplicantInterface *interface);
 257         void (*interface_state) (GSupplicantInterface *interface);
 258         void (*interface_removed) (GSupplicantInterface *interface);
 259         void (*scan_started) (GSupplicantInterface *interface);
 260         void (*scan_finished) (GSupplicantInterface *interface);
 261         void (*network_added) (GSupplicantNetwork *network);
 262         void (*network_removed) (GSupplicantNetwork *network);
 263         void (*network_changed) (GSupplicantNetwork *network,
 264                                         const char *property);
 265         void (*debug) (const char *str);
 266 };
 267
 268 typedef struct _GSupplicantCallbacks GSupplicantCallbacks;
 269
 270 int g_supplicant_register(const GSupplicantCallbacks *callbacks);
 271 void g_supplicant_unregister(const GSupplicantCallbacks *callbacks);
 272
 273 static inline
 274 void g_supplicant_free_scan_params(GSupplicantScanParams *scan_params)
 275 {
 276         g_slist_free_full(scan_params->ssids, g_free);
 277         g_free(scan_params->freqs);
 278         g_free(scan_params);
 279 }
 280
 281 #ifdef __cplusplus
 282 }
 283 #endif
 284
 285 #endif /* __G_SUPPLICANT_H */