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