gsupplicant/gsupplicant.h

   1 /*
   2  *
   3  *  WPA supplicant library with GLib integration
   4  *
   5  *  Copyright (C) 2012-2013  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 #define G_SUPPLICANT_CAPABILITY_MODE_P2P        (1 << 3)
  53
  54 #define G_SUPPLICANT_KEYMGMT_NONE               (1 << 0)
  55 #define G_SUPPLICANT_KEYMGMT_IEEE8021X  (1 << 1)
  56 #define G_SUPPLICANT_KEYMGMT_WPA_NONE   (1 << 2)
  57 #define G_SUPPLICANT_KEYMGMT_WPA_PSK    (1 << 3)
  58 #define G_SUPPLICANT_KEYMGMT_WPA_PSK_256        (1 << 4)
  59 #define G_SUPPLICANT_KEYMGMT_WPA_FT_PSK (1 << 5)
  60 #define G_SUPPLICANT_KEYMGMT_WPA_FT_EAP (1 << 6)
  61 #define G_SUPPLICANT_KEYMGMT_WPA_EAP    (1 << 7)
  62 #define G_SUPPLICANT_KEYMGMT_WPA_EAP_256        (1 << 8)
  63 #define G_SUPPLICANT_KEYMGMT_WPS                (1 << 9)
  64
  65 #define G_SUPPLICANT_PROTO_WPA          (1 << 0)
  66 #define G_SUPPLICANT_PROTO_RSN          (1 << 1)
  67
  68 #define G_SUPPLICANT_GROUP_WEP40                (1 << 0)
  69 #define G_SUPPLICANT_GROUP_WEP104               (1 << 1)
  70 #define G_SUPPLICANT_GROUP_TKIP         (1 << 2)
  71 #define G_SUPPLICANT_GROUP_CCMP         (1 << 3)
  72
  73 #define G_SUPPLICANT_PAIRWISE_NONE      (1 << 0)
  74 #define G_SUPPLICANT_PAIRWISE_TKIP      (1 << 1)
  75 #define G_SUPPLICANT_PAIRWISE_CCMP      (1 << 2)
  76
  77 #define G_SUPPLICANT_WPS_CONFIGURED     (1 << 0)
  78 #define G_SUPPLICANT_WPS_PBC            (1 << 1)
  79 #define G_SUPPLICANT_WPS_PIN            (1 << 2)
  80 #define G_SUPPLICANT_WPS_REGISTRAR      (1 << 3)
  81
  82 #define G_SUPPLICANT_WPS_CONFIG_PBC     0x0080
  83
  84 #define G_SUPPLICANT_GROUP_ROLE_CLIENT  (1 << 0)
  85 #define G_SUPPLICANT_GROUP_ROLE_GO      (1 << 1)
  86
  87 typedef enum {
  88         G_SUPPLICANT_MODE_UNKNOWN,
  89         G_SUPPLICANT_MODE_INFRA,
  90         G_SUPPLICANT_MODE_IBSS,
  91         G_SUPPLICANT_MODE_MASTER,
  92 } GSupplicantMode;
  93
  94 typedef enum {
  95         G_SUPPLICANT_SECURITY_UNKNOWN,
  96         G_SUPPLICANT_SECURITY_NONE,
  97         G_SUPPLICANT_SECURITY_WEP,
  98         G_SUPPLICANT_SECURITY_PSK,
  99         G_SUPPLICANT_SECURITY_IEEE8021X,
 100 } GSupplicantSecurity;
 101
 102 typedef enum {
 103         G_SUPPLICANT_STATE_UNKNOWN,
 104         G_SUPPLICANT_STATE_DISABLED,
 105         G_SUPPLICANT_STATE_DISCONNECTED,
 106         G_SUPPLICANT_STATE_INACTIVE,
 107         G_SUPPLICANT_STATE_SCANNING,
 108         G_SUPPLICANT_STATE_AUTHENTICATING,
 109         G_SUPPLICANT_STATE_ASSOCIATING,
 110         G_SUPPLICANT_STATE_ASSOCIATED,
 111         G_SUPPLICANT_STATE_4WAY_HANDSHAKE,
 112         G_SUPPLICANT_STATE_GROUP_HANDSHAKE,
 113         G_SUPPLICANT_STATE_COMPLETED,
 114 } GSupplicantState;
 115
 116 typedef enum {
 117         G_SUPPLICANT_WPS_STATE_UNKNOWN,
 118         G_SUPPLICANT_WPS_STATE_SUCCESS,
 119         G_SUPPLICANT_WPS_STATE_FAIL,
 120 } GSupplicantWpsState;
 121
 122 typedef enum {
 123         G_SUPPLICANT_PEER_SERVICES_CHANGED,
 124         G_SUPPLICANT_PEER_GROUP_CHANGED,
 125         G_SUPPLICANT_PEER_GROUP_STARTED,
 126         G_SUPPLICANT_PEER_GROUP_FINISHED,
 127         G_SUPPLICANT_PEER_GROUP_JOINED,
 128         G_SUPPLICANT_PEER_GROUP_DISCONNECTED,
 129         G_SUPPLICANT_PEER_GROUP_FAILED,
 130 } GSupplicantPeerState;
 131
 132 enum GSupplicantAPHiddenSSID {
 133         G_SUPPLICANT_AP_NO_SSID_HIDING,
 134         G_SUPPLICANT_AP_HIDDEN_SSID_ZERO_LEN,
 135         G_SUPPLICANT_AP_HIDDEN_SSID_ZERO_CONTENTS,
 136 };
 137
 138 struct _GSupplicantSSID {
 139         const void *ssid;
 140         unsigned int ssid_len;
 141         unsigned int scan_ssid;
 142         GSupplicantMode mode;
 143         GSupplicantSecurity security;
 144         unsigned int protocol;
 145         unsigned int pairwise_cipher;
 146         unsigned int group_cipher;
 147         unsigned int freq;
 148         const char *eap;
 149         const char *passphrase;
 150         const char *identity;
 151         const char *ca_cert_path;
 152         const char *client_cert_path;
 153         const char *private_key_path;
 154         const char *private_key_passphrase;
 155         const char *phase2_auth;
 156         dbus_bool_t use_wps;
 157         const char *pin_wps;
 158         const char *bgscan;
 159         int ignore_broadcast_ssid;
 160 #if defined TIZEN_EXT
 161         unsigned char *bssid;
 162 #endif
 163 };
 164
 165 typedef struct _GSupplicantSSID GSupplicantSSID;
 166
 167 /*
 168  * Max number of SSIDs that can be scanned.
 169  * In wpa_s 0.7x the limit is 4.
 170  * In wps_s 0.8 or later it is 16.
 171  * The value is only used if wpa_supplicant does not return any max limit
 172  * for number of scannable SSIDs.
 173  */
 174 #define WPAS_MAX_SCAN_SSIDS 4
 175
 176 struct scan_ssid {
 177         unsigned char ssid[32];
 178         uint8_t ssid_len;
 179 };
 180
 181 struct _GSupplicantScanParams {
 182         GSList *ssids;
 183
 184         uint8_t num_ssids;
 185
 186         uint8_t num_freqs;
 187         uint16_t *freqs;
 188 };
 189
 190 typedef struct _GSupplicantScanParams GSupplicantScanParams;
 191
 192 struct _GSupplicantPeerParams {
 193         bool master;
 194         char *wps_pin;
 195         char *path;
 196 };
 197
 198 typedef struct _GSupplicantPeerParams GSupplicantPeerParams;
 199
 200 struct _GSupplicantP2PServiceParams {
 201         int version;
 202         char *service;
 203         unsigned char *query;
 204         int query_length;
 205         unsigned char *response;
 206         int response_length;
 207         unsigned char *wfd_ies;
 208         int wfd_ies_length;
 209 };
 210
 211 typedef struct _GSupplicantP2PServiceParams GSupplicantP2PServiceParams;
 212
 213 /* global API */
 214 typedef void (*GSupplicantCountryCallback) (int result,
 215                                                 const char *alpha2,
 216                                                         void *user_data);
 217
 218 int g_supplicant_set_country(const char *alpha2,
 219                                 GSupplicantCountryCallback callback,
 220                                                 const void *user_data);
 221
 222 /* Interface API */
 223 struct _GSupplicantInterface;
 224 struct _GSupplicantPeer;
 225
 226 typedef struct _GSupplicantInterface GSupplicantInterface;
 227 typedef struct _GSupplicantPeer GSupplicantPeer;
 228
 229 typedef void (*GSupplicantInterfaceCallback) (int result,
 230                                         GSupplicantInterface *interface,
 231                                                         void *user_data);
 232
 233 void g_supplicant_interface_cancel(GSupplicantInterface *interface);
 234
 235 int g_supplicant_interface_create(const char *ifname, const char *driver,
 236                                         const char *bridge,
 237                                         GSupplicantInterfaceCallback callback,
 238                                                         void *user_data);
 239 int g_supplicant_interface_remove(GSupplicantInterface *interface,
 240                                         GSupplicantInterfaceCallback callback,
 241                                                         void *user_data);
 242 int g_supplicant_interface_scan(GSupplicantInterface *interface,
 243                                         GSupplicantScanParams *scan_data,
 244                                         GSupplicantInterfaceCallback callback,
 245                                                         void *user_data);
 246
 247 int g_supplicant_interface_p2p_find(GSupplicantInterface *interface,
 248                                         GSupplicantInterfaceCallback callback,
 249                                                         void *user_data);
 250
 251 int g_supplicant_interface_p2p_stop_find(GSupplicantInterface *interface);
 252
 253 int g_supplicant_interface_p2p_connect(GSupplicantInterface *interface,
 254                                         GSupplicantPeerParams *peer_params,
 255                                         GSupplicantInterfaceCallback callback,
 256                                         void *user_data);
 257
 258 int g_supplicant_interface_p2p_disconnect(GSupplicantInterface *interface,
 259                                         GSupplicantPeerParams *peer_params);
 260
 261 int g_supplicant_interface_p2p_listen(GSupplicantInterface *interface,
 262                                                 int period, int interval);
 263
 264 int g_supplicant_interface_p2p_add_service(GSupplicantInterface *interface,
 265                                 GSupplicantInterfaceCallback callback,
 266                                 GSupplicantP2PServiceParams *p2p_service_params,
 267                                 void *user_data);
 268
 269 int g_supplicant_interface_p2p_del_service(GSupplicantInterface *interface,
 270                                 GSupplicantP2PServiceParams *p2p_service_params);
 271
 272 int g_supplicant_set_widi_ies(GSupplicantP2PServiceParams *p2p_service_params,
 273                                         GSupplicantInterfaceCallback callback,
 274                                         void *user_data);
 275
 276 int g_supplicant_interface_connect(GSupplicantInterface *interface,
 277                                         GSupplicantSSID *ssid,
 278                                         GSupplicantInterfaceCallback callback,
 279                                                         void *user_data);
 280
 281 int g_supplicant_interface_disconnect(GSupplicantInterface *interface,
 282                                         GSupplicantInterfaceCallback callback,
 283                                                         void *user_data);
 284
 285 int g_supplicant_interface_set_apscan(GSupplicantInterface *interface,
 286                                                         unsigned int ap_scan);
 287
 288 void g_supplicant_interface_set_data(GSupplicantInterface *interface,
 289                                                                 void *data);
 290 void *g_supplicant_interface_get_data(GSupplicantInterface *interface);
 291 const char *g_supplicant_interface_get_ifname(GSupplicantInterface *interface);
 292 const char *g_supplicant_interface_get_driver(GSupplicantInterface *interface);
 293 GSupplicantState g_supplicant_interface_get_state(GSupplicantInterface *interface);
 294 const char *g_supplicant_interface_get_wps_key(GSupplicantInterface *interface);
 295 const void *g_supplicant_interface_get_wps_ssid(GSupplicantInterface *interface,
 296                                                         unsigned int *ssid_len);
 297 GSupplicantWpsState g_supplicant_interface_get_wps_state(GSupplicantInterface *interface);
 298 unsigned int g_supplicant_interface_get_mode(GSupplicantInterface *interface);
 299 dbus_bool_t g_supplicant_interface_get_ready(GSupplicantInterface *interface);
 300 unsigned int g_supplicant_interface_get_max_scan_ssids(
 301                                         GSupplicantInterface *interface);
 302
 303 int g_supplicant_interface_enable_selected_network(GSupplicantInterface *interface,
 304                                                         dbus_bool_t enable);
 305 int g_supplicant_interface_set_country(GSupplicantInterface *interface,
 306                                         GSupplicantCountryCallback callback,
 307                                                         const char *alpha2,
 308                                                         void *user_data);
 309 bool g_supplicant_interface_has_p2p(GSupplicantInterface *interface);
 310 int g_supplicant_interface_set_p2p_device_config(GSupplicantInterface *interface,
 311                                                 const char *device_name,
 312                                                 const char *primary_dev_type);
 313 GSupplicantPeer *g_supplicant_interface_peer_lookup(GSupplicantInterface *interface,
 314                                                 const char *identifier);
 315 bool g_supplicant_interface_is_p2p_finding(GSupplicantInterface *interface);
 316
 317 /* Network and Peer API */
 318 struct _GSupplicantNetwork;
 319 struct _GSupplicantGroup;
 320
 321 typedef struct _GSupplicantNetwork GSupplicantNetwork;
 322 typedef struct _GSupplicantGroup GSupplicantGroup;
 323
 324 GSupplicantInterface *g_supplicant_network_get_interface(GSupplicantNetwork *network);
 325 const char *g_supplicant_network_get_name(GSupplicantNetwork *network);
 326 const char *g_supplicant_network_get_identifier(GSupplicantNetwork *network);
 327 const char *g_supplicant_network_get_path(GSupplicantNetwork *network);
 328 const void *g_supplicant_network_get_ssid(GSupplicantNetwork *network,
 329                                                         unsigned int *ssid_len);
 330 const char *g_supplicant_network_get_mode(GSupplicantNetwork *network);
 331 const char *g_supplicant_network_get_security(GSupplicantNetwork *network);
 332 dbus_int16_t g_supplicant_network_get_signal(GSupplicantNetwork *network);
 333 dbus_uint16_t g_supplicant_network_get_frequency(GSupplicantNetwork *network);
 334 dbus_bool_t g_supplicant_network_get_wps(GSupplicantNetwork *network);
 335 dbus_bool_t g_supplicant_network_is_wps_active(GSupplicantNetwork *network);
 336 dbus_bool_t g_supplicant_network_is_wps_pbc(GSupplicantNetwork *network);
 337 dbus_bool_t g_supplicant_network_is_wps_advertizing(GSupplicantNetwork *network);
 338
 339 GSupplicantInterface *g_supplicant_peer_get_interface(GSupplicantPeer *peer);
 340 const char *g_supplicant_peer_get_path(GSupplicantPeer *peer);
 341 const char *g_supplicant_peer_get_identifier(GSupplicantPeer *peer);
 342 const void *g_supplicant_peer_get_device_address(GSupplicantPeer *peer);
 343 const void *g_supplicant_peer_get_iface_address(GSupplicantPeer *peer);
 344 const char *g_supplicant_peer_get_name(GSupplicantPeer *peer);
 345 const unsigned char *g_supplicant_peer_get_widi_ies(GSupplicantPeer *peer,
 346                                                                 int *length);
 347 bool g_supplicant_peer_is_wps_pbc(GSupplicantPeer *peer);
 348 bool g_supplicant_peer_is_wps_pin(GSupplicantPeer *peer);
 349 bool g_supplicant_peer_is_in_a_group(GSupplicantPeer *peer);
 350 GSupplicantInterface *g_supplicant_peer_get_group_interface(GSupplicantPeer *peer);
 351 bool g_supplicant_peer_is_client(GSupplicantPeer *peer);
 352 bool g_supplicant_peer_has_requested_connection(GSupplicantPeer *peer);
 353
 354 #if defined TIZEN_EXT
 355 /*
 356 * Description: Network client requires additional wifi specific info
 357 */
 358 const unsigned char *g_supplicant_network_get_bssid(
 359                                                 GSupplicantNetwork *network);
 360 unsigned int g_supplicant_network_get_maxrate(GSupplicantNetwork *network);
 361 const char *g_supplicant_network_get_enc_mode(GSupplicantNetwork *network);
 362 unsigned int g_supplicant_network_is_hs20AP(GSupplicantNetwork *network);
 363 const char *g_supplicant_network_get_eap(GSupplicantNetwork *network);
 364 const char *g_supplicant_network_get_identity(GSupplicantNetwork *network);
 365 const char *g_supplicant_network_get_phase2(GSupplicantNetwork *network);
 366 #endif
 367
 368 struct _GSupplicantCallbacks {
 369         void (*system_ready) (void);
 370         void (*system_killed) (void);
 371         void (*interface_added) (GSupplicantInterface *interface);
 372         void (*interface_state) (GSupplicantInterface *interface);
 373         void (*interface_removed) (GSupplicantInterface *interface);
 374         void (*p2p_support) (GSupplicantInterface *interface);
 375         void (*scan_started) (GSupplicantInterface *interface);
 376         void (*scan_finished) (GSupplicantInterface *interface);
 377         void (*network_added) (GSupplicantNetwork *network);
 378         void (*network_removed) (GSupplicantNetwork *network);
 379 #if defined TIZEN_EXT
 380         void (*network_merged) (GSupplicantNetwork *network);
 381 #endif
 382         void (*network_changed) (GSupplicantNetwork *network,
 383                                         const char *property);
 384 #if defined TIZEN_EXT
 385         void (*system_power_off) (void);
 386 #endif
 387         void (*add_station) (const char *mac);
 388         void (*remove_station) (const char *mac);
 389         void (*peer_found) (GSupplicantPeer *peer);
 390         void (*peer_lost) (GSupplicantPeer *peer);
 391         void (*peer_changed) (GSupplicantPeer *peer,
 392                                         GSupplicantPeerState state);
 393         void (*peer_request) (GSupplicantPeer *peer);
 394         void (*debug) (const char *str);
 395 };
 396
 397 typedef struct _GSupplicantCallbacks GSupplicantCallbacks;
 398
 399 int g_supplicant_register(const GSupplicantCallbacks *callbacks);
 400 void g_supplicant_unregister(const GSupplicantCallbacks *callbacks);
 401
 402 static inline
 403 void g_supplicant_free_scan_params(GSupplicantScanParams *scan_params)
 404 {
 405         g_slist_free_full(scan_params->ssids, g_free);
 406         g_free(scan_params->freqs);
 407         g_free(scan_params);
 408 }
 409
 410 #ifdef __cplusplus
 411 }
 412 #endif
 413
 414 #endif /* __G_SUPPLICANT_H */