3 * WPA supplicant library with GLib integration
5 * Copyright (C) 2012-2013 Intel Corporation. All rights reserved.
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.
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.
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
21 #ifndef __G_SUPPLICANT_H
22 #define __G_SUPPLICANT_H
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)
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)
42 #define G_SUPPLICANT_CAPABILITY_PROTO_WPA (1 << 0)
43 #define G_SUPPLICANT_CAPABILITY_PROTO_RSN (1 << 1)
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)
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 #if defined TIZEN_EXT_WIFI_MESH
54 #define G_SUPPLICANT_CAPABILITY_MODE_MESH (1 << 4)
57 #define G_SUPPLICANT_KEYMGMT_NONE (1 << 0)
58 #define G_SUPPLICANT_KEYMGMT_IEEE8021X (1 << 1)
59 #define G_SUPPLICANT_KEYMGMT_WPA_NONE (1 << 2)
60 #define G_SUPPLICANT_KEYMGMT_WPA_PSK (1 << 3)
61 #define G_SUPPLICANT_KEYMGMT_WPA_PSK_256 (1 << 4)
63 #define G_SUPPLICANT_KEYMGMT_WPA_FT_EAP (1 << 5)
64 #define G_SUPPLICANT_KEYMGMT_WPA_FT_PSK (1 << 6)
66 #define G_SUPPLICANT_KEYMGMT_WPA_FT_PSK (1 << 5)
67 #define G_SUPPLICANT_KEYMGMT_WPA_FT_EAP (1 << 6)
69 #define G_SUPPLICANT_KEYMGMT_WPA_EAP (1 << 7)
70 #define G_SUPPLICANT_KEYMGMT_WPA_EAP_256 (1 << 8)
71 #define G_SUPPLICANT_KEYMGMT_WPS (1 << 9)
73 #define G_SUPPLICANT_KEYMGMT_SAE (1 << 10)
74 #define G_SUPPLICANT_KEYMGMT_OWE (1 << 22)
77 #define G_SUPPLICANT_PROTO_WPA (1 << 0)
78 #define G_SUPPLICANT_PROTO_RSN (1 << 1)
80 #define G_SUPPLICANT_GROUP_WEP40 (1 << 0)
81 #define G_SUPPLICANT_GROUP_WEP104 (1 << 1)
82 #define G_SUPPLICANT_GROUP_TKIP (1 << 2)
83 #define G_SUPPLICANT_GROUP_CCMP (1 << 3)
85 #define G_SUPPLICANT_PAIRWISE_NONE (1 << 0)
86 #define G_SUPPLICANT_PAIRWISE_TKIP (1 << 1)
87 #define G_SUPPLICANT_PAIRWISE_CCMP (1 << 2)
89 #define G_SUPPLICANT_WPS_CONFIGURED (1 << 0)
90 #define G_SUPPLICANT_WPS_PBC (1 << 1)
91 #define G_SUPPLICANT_WPS_PIN (1 << 2)
92 #define G_SUPPLICANT_WPS_REGISTRAR (1 << 3)
94 #define G_SUPPLICANT_WPS_CONFIG_PBC 0x0080
96 #define G_SUPPLICANT_GROUP_ROLE_CLIENT (1 << 0)
97 #define G_SUPPLICANT_GROUP_ROLE_GO (1 << 1)
100 G_SUPPLICANT_MODE_UNKNOWN,
101 G_SUPPLICANT_MODE_INFRA,
102 G_SUPPLICANT_MODE_IBSS,
103 G_SUPPLICANT_MODE_MASTER,
104 #if defined TIZEN_EXT_WIFI_MESH
105 G_SUPPLICANT_MODE_MESH,
109 #if defined TIZEN_EXT_WIFI_MESH
111 G_SUPPLICANT_IEEE80211W_UNKNOWN,
112 G_SUPPLICANT_IEEE80211W_OPTIONAL,
113 G_SUPPLICANT_IEEE80211W_REQUIRED,
118 G_SUPPLICANT_SECURITY_UNKNOWN,
119 G_SUPPLICANT_SECURITY_NONE,
120 G_SUPPLICANT_SECURITY_WEP,
121 G_SUPPLICANT_SECURITY_PSK,
122 G_SUPPLICANT_SECURITY_IEEE8021X,
123 #if defined TIZEN_EXT
124 G_SUPPLICANT_SECURITY_FT_PSK,
125 G_SUPPLICANT_SECURITY_FT_IEEE8021X,
126 G_SUPPLICANT_SECURITY_SAE,
127 G_SUPPLICANT_SECURITY_OWE,
129 } GSupplicantSecurity;
131 #if defined TIZEN_EXT
133 G_SUPPLICANT_EAP_KEYMGMT_NONE,
134 G_SUPPLICANT_EAP_KEYMGMT_FT,
135 G_SUPPLICANT_EAP_KEYMGMT_CCKM,
136 G_SUPPLICANT_EAP_KEYMGMT_OKC,
137 } GSupplicantEapKeymgmt;
140 G_SUPPLICANT_MODE_IEEE80211_UNKNOWN,
141 G_SUPPLICANT_MODE_IEEE80211B,
142 G_SUPPLICANT_MODE_IEEE80211BG,
143 G_SUPPLICANT_MODE_IEEE80211BGN,
144 G_SUPPLICANT_MODE_IEEE80211A,
145 G_SUPPLICANT_MODE_IEEE80211AN,
146 G_SUPPLICANT_MODE_IEEE80211ANAC,
147 } GSupplicantPhy_mode;
151 G_SUPPLICANT_STATE_UNKNOWN,
152 G_SUPPLICANT_STATE_DISABLED,
153 G_SUPPLICANT_STATE_DISCONNECTED,
154 G_SUPPLICANT_STATE_INACTIVE,
155 G_SUPPLICANT_STATE_SCANNING,
156 G_SUPPLICANT_STATE_AUTHENTICATING,
157 G_SUPPLICANT_STATE_ASSOCIATING,
158 G_SUPPLICANT_STATE_ASSOCIATED,
159 G_SUPPLICANT_STATE_4WAY_HANDSHAKE,
160 G_SUPPLICANT_STATE_GROUP_HANDSHAKE,
161 G_SUPPLICANT_STATE_COMPLETED,
165 G_SUPPLICANT_WPS_STATE_UNKNOWN,
166 G_SUPPLICANT_WPS_STATE_SUCCESS,
167 G_SUPPLICANT_WPS_STATE_FAIL,
168 } GSupplicantWpsState;
171 G_SUPPLICANT_PEER_SERVICES_CHANGED,
172 G_SUPPLICANT_PEER_GROUP_CHANGED,
173 G_SUPPLICANT_PEER_GROUP_STARTED,
174 G_SUPPLICANT_PEER_GROUP_FINISHED,
175 G_SUPPLICANT_PEER_GROUP_JOINED,
176 G_SUPPLICANT_PEER_GROUP_DISCONNECTED,
177 G_SUPPLICANT_PEER_GROUP_FAILED,
178 } GSupplicantPeerState;
180 enum GSupplicantAPHiddenSSID {
181 G_SUPPLICANT_AP_NO_SSID_HIDING,
182 G_SUPPLICANT_AP_HIDDEN_SSID_ZERO_LEN,
183 G_SUPPLICANT_AP_HIDDEN_SSID_ZERO_CONTENTS,
186 struct _GSupplicantSSID {
187 #if defined TIZEN_EXT
192 unsigned int ssid_len;
193 unsigned int scan_ssid;
194 GSupplicantMode mode;
195 GSupplicantSecurity security;
196 unsigned int protocol;
197 unsigned int pairwise_cipher;
198 unsigned int group_cipher;
201 const char *passphrase;
202 const char *identity;
203 const char *anonymous_identity;
204 const char *ca_cert_path;
205 const char *subject_match;
206 const char *altsubject_match;
207 const char *domain_suffix_match;
208 const char *domain_match;
209 const char *client_cert_path;
210 const char *private_key_path;
211 const char *private_key_passphrase;
212 const char *phase2_auth;
216 int ignore_broadcast_ssid;
217 #if defined TIZEN_EXT
218 unsigned char *bssid;
219 unsigned int bssid_for_connect_len;
220 unsigned char bssid_for_connect[6];
221 GSupplicantEapKeymgmt eap_keymgmt;
223 const char *pac_file;
228 typedef struct _GSupplicantSSID GSupplicantSSID;
231 * Max number of SSIDs that can be scanned.
232 * In wpa_s 0.7x the limit is 4.
233 * In wps_s 0.8 or later it is 16.
234 * The value is only used if wpa_supplicant does not return any max limit
235 * for number of scannable SSIDs.
237 #define WPAS_MAX_SCAN_SSIDS 4
240 unsigned char ssid[32];
244 struct _GSupplicantScanParams {
253 typedef struct _GSupplicantScanParams GSupplicantScanParams;
255 struct _GSupplicantPeerParams {
261 typedef struct _GSupplicantPeerParams GSupplicantPeerParams;
263 struct _GSupplicantP2PServiceParams {
266 unsigned char *query;
268 unsigned char *response;
270 unsigned char *wfd_ies;
274 typedef struct _GSupplicantP2PServiceParams GSupplicantP2PServiceParams;
277 typedef void (*GSupplicantCountryCallback) (int result,
281 int g_supplicant_set_country(const char *alpha2,
282 GSupplicantCountryCallback callback,
283 const void *user_data);
286 struct _GSupplicantInterface;
287 struct _GSupplicantPeer;
289 typedef struct _GSupplicantInterface GSupplicantInterface;
290 typedef struct _GSupplicantPeer GSupplicantPeer;
291 #if defined TIZEN_EXT_WIFI_MESH
292 typedef struct _GSupplicantMeshPeer GSupplicantMeshPeer;
295 typedef void (*GSupplicantInterfaceCallback) (int result,
296 GSupplicantInterface *interface,
299 #if defined TIZEN_EXT
300 typedef void (*GSupplicantMaxSpeedCallback) (int result, int maxspeed,
301 uint8_t strength, void *user_data);
304 void g_supplicant_interface_cancel(GSupplicantInterface *interface);
306 int g_supplicant_interface_create(const char *ifname, const char *driver,
308 GSupplicantInterfaceCallback callback,
310 int g_supplicant_interface_remove(GSupplicantInterface *interface,
311 GSupplicantInterfaceCallback callback,
313 int g_supplicant_interface_scan(GSupplicantInterface *interface,
314 GSupplicantScanParams *scan_data,
315 GSupplicantInterfaceCallback callback,
318 #if defined TIZEN_EXT
319 int g_supplicant_interface_signalpoll(GSupplicantInterface *interface,
320 GSupplicantMaxSpeedCallback callback,
324 int g_supplicant_interface_p2p_find(GSupplicantInterface *interface,
325 GSupplicantInterfaceCallback callback,
328 int g_supplicant_interface_p2p_stop_find(GSupplicantInterface *interface);
330 int g_supplicant_interface_p2p_connect(GSupplicantInterface *interface,
331 GSupplicantPeerParams *peer_params,
332 GSupplicantInterfaceCallback callback,
335 int g_supplicant_interface_p2p_disconnect(GSupplicantInterface *interface,
336 GSupplicantPeerParams *peer_params);
338 int g_supplicant_interface_p2p_listen(GSupplicantInterface *interface,
339 int period, int interval);
341 int g_supplicant_interface_p2p_add_service(GSupplicantInterface *interface,
342 GSupplicantInterfaceCallback callback,
343 GSupplicantP2PServiceParams *p2p_service_params,
346 int g_supplicant_interface_p2p_del_service(GSupplicantInterface *interface,
347 GSupplicantP2PServiceParams *p2p_service_params);
349 int g_supplicant_set_widi_ies(GSupplicantP2PServiceParams *p2p_service_params,
350 GSupplicantInterfaceCallback callback,
353 int g_supplicant_interface_connect(GSupplicantInterface *interface,
354 GSupplicantSSID *ssid,
355 GSupplicantInterfaceCallback callback,
358 int g_supplicant_interface_disconnect(GSupplicantInterface *interface,
359 GSupplicantInterfaceCallback callback,
362 int g_supplicant_interface_set_apscan(GSupplicantInterface *interface,
363 unsigned int ap_scan);
365 void g_supplicant_interface_set_data(GSupplicantInterface *interface,
367 void *g_supplicant_interface_get_data(GSupplicantInterface *interface);
368 const char *g_supplicant_interface_get_ifname(GSupplicantInterface *interface);
369 #if defined TIZEN_EXT
370 bool g_supplicant_interface_get_is_5_0_ghz_supported(GSupplicantInterface *interface);
372 const char *g_supplicant_interface_get_driver(GSupplicantInterface *interface);
373 GSupplicantState g_supplicant_interface_get_state(GSupplicantInterface *interface);
374 const char *g_supplicant_interface_get_wps_key(GSupplicantInterface *interface);
375 const void *g_supplicant_interface_get_wps_ssid(GSupplicantInterface *interface,
376 unsigned int *ssid_len);
377 GSupplicantWpsState g_supplicant_interface_get_wps_state(GSupplicantInterface *interface);
378 unsigned int g_supplicant_interface_get_mode(GSupplicantInterface *interface);
379 dbus_bool_t g_supplicant_interface_get_ready(GSupplicantInterface *interface);
380 unsigned int g_supplicant_interface_get_max_scan_ssids(
381 GSupplicantInterface *interface);
383 int g_supplicant_interface_enable_selected_network(GSupplicantInterface *interface,
385 int g_supplicant_interface_set_country(GSupplicantInterface *interface,
386 GSupplicantCountryCallback callback,
389 bool g_supplicant_interface_has_p2p(GSupplicantInterface *interface);
390 int g_supplicant_interface_set_p2p_device_config(GSupplicantInterface *interface,
391 const char *device_name,
392 const char *primary_dev_type);
393 GSupplicantPeer *g_supplicant_interface_peer_lookup(GSupplicantInterface *interface,
394 const char *identifier);
395 bool g_supplicant_interface_is_p2p_finding(GSupplicantInterface *interface);
397 #if defined TIZEN_EXT_WIFI_MESH
398 bool g_supplicant_interface_has_mesh(GSupplicantInterface *interface);
399 int g_supplicant_mesh_interface_create(const char *ifname, const char *driver,
400 const char *bridge, const char *parent_ifname,
401 GSupplicantInterfaceCallback callback, void *user_data);
402 const void *g_supplicant_interface_get_mesh_group_ssid(
403 GSupplicantInterface *interface,
404 unsigned int *ssid_len);
405 int g_supplicant_mesh_get_disconnect_reason(GSupplicantInterface *interface);
406 const char *g_supplicant_mesh_peer_get_address(GSupplicantMeshPeer *mesh_peer);
407 int g_supplicant_mesh_peer_get_disconnect_reason(
408 GSupplicantMeshPeer *mesh_peer);
409 int g_supplicant_interface_abort_scan(GSupplicantInterface *interface,
410 GSupplicantInterfaceCallback callback, void *user_data);
411 int g_supplicant_interface_mesh_peer_change_status(
412 GSupplicantInterface *interface,
413 GSupplicantInterfaceCallback callback, const char *peer_address,
414 const char *method, void *user_data);
417 /* Network and Peer API */
418 struct _GSupplicantNetwork;
419 struct _GSupplicantGroup;
421 typedef struct _GSupplicantNetwork GSupplicantNetwork;
422 typedef struct _GSupplicantGroup GSupplicantGroup;
424 GSupplicantInterface *g_supplicant_network_get_interface(GSupplicantNetwork *network);
425 const char *g_supplicant_network_get_name(GSupplicantNetwork *network);
426 const char *g_supplicant_network_get_identifier(GSupplicantNetwork *network);
427 const char *g_supplicant_network_get_path(GSupplicantNetwork *network);
428 const void *g_supplicant_network_get_ssid(GSupplicantNetwork *network,
429 unsigned int *ssid_len);
430 const char *g_supplicant_network_get_mode(GSupplicantNetwork *network);
431 const char *g_supplicant_network_get_security(GSupplicantNetwork *network);
432 dbus_int16_t g_supplicant_network_get_signal(GSupplicantNetwork *network);
433 dbus_uint16_t g_supplicant_network_get_frequency(GSupplicantNetwork *network);
434 dbus_bool_t g_supplicant_network_get_wps(GSupplicantNetwork *network);
435 dbus_bool_t g_supplicant_network_is_wps_active(GSupplicantNetwork *network);
436 dbus_bool_t g_supplicant_network_is_wps_pbc(GSupplicantNetwork *network);
437 dbus_bool_t g_supplicant_network_is_wps_advertizing(GSupplicantNetwork *network);
439 GSupplicantInterface *g_supplicant_peer_get_interface(GSupplicantPeer *peer);
440 const char *g_supplicant_peer_get_path(GSupplicantPeer *peer);
441 const char *g_supplicant_peer_get_identifier(GSupplicantPeer *peer);
442 const void *g_supplicant_peer_get_device_address(GSupplicantPeer *peer);
443 const void *g_supplicant_peer_get_iface_address(GSupplicantPeer *peer);
444 const char *g_supplicant_peer_get_name(GSupplicantPeer *peer);
445 const unsigned char *g_supplicant_peer_get_widi_ies(GSupplicantPeer *peer,
447 bool g_supplicant_peer_is_wps_pbc(GSupplicantPeer *peer);
448 bool g_supplicant_peer_is_wps_pin(GSupplicantPeer *peer);
449 bool g_supplicant_peer_is_in_a_group(GSupplicantPeer *peer);
450 GSupplicantInterface *g_supplicant_peer_get_group_interface(GSupplicantPeer *peer);
451 bool g_supplicant_peer_is_client(GSupplicantPeer *peer);
452 bool g_supplicant_peer_has_requested_connection(GSupplicantPeer *peer);
454 #if defined TIZEN_EXT
456 * Description: Network client requires additional wifi specific info
458 const unsigned char *g_supplicant_network_get_bssid(
459 GSupplicantNetwork *network);
460 unsigned int g_supplicant_network_get_maxrate(GSupplicantNetwork *network);
461 const char *g_supplicant_network_get_enc_mode(GSupplicantNetwork *network);
462 bool g_supplicant_network_get_rsn_mode(GSupplicantNetwork *network);
463 bool g_supplicant_network_is_hs20AP(GSupplicantNetwork *network);
464 const char *g_supplicant_network_get_eap(GSupplicantNetwork *network);
465 const char *g_supplicant_network_get_identity(GSupplicantNetwork *network);
466 const char *g_supplicant_network_get_phase2(GSupplicantNetwork *network);
467 unsigned int g_supplicant_network_get_keymgmt(GSupplicantNetwork *network);
468 void *g_supplicant_network_get_wifi_vsie(GSupplicantNetwork *network);
469 const unsigned char *g_supplicant_network_get_countrycode(GSupplicantNetwork
471 void *g_supplicant_network_get_bssid_list(GSupplicantNetwork *network);
472 GSupplicantPhy_mode g_supplicant_network_get_phy_mode(GSupplicantNetwork *network);
475 struct _GSupplicantCallbacks {
476 void (*system_ready) (void);
477 void (*system_killed) (void);
478 void (*interface_added) (GSupplicantInterface *interface);
479 void (*interface_state) (GSupplicantInterface *interface);
480 void (*interface_removed) (GSupplicantInterface *interface);
481 void (*p2p_support) (GSupplicantInterface *interface);
482 void (*scan_started) (GSupplicantInterface *interface);
483 void (*scan_finished) (GSupplicantInterface *interface);
484 void (*ap_create_fail) (GSupplicantInterface *interface);
485 void (*network_added) (GSupplicantNetwork *network);
486 void (*network_removed) (GSupplicantNetwork *network);
487 #if defined TIZEN_EXT
488 void (*network_merged) (GSupplicantNetwork *network);
490 void (*network_changed) (GSupplicantNetwork *network,
491 const char *property);
492 void (*network_associated) (GSupplicantNetwork *network);
493 #if defined TIZEN_EXT
494 void (*system_power_off) (void);
495 void (*assoc_failed) (void *user_data);
497 void (*add_station) (const char *mac);
498 void (*remove_station) (const char *mac);
499 void (*peer_found) (GSupplicantPeer *peer);
500 void (*peer_lost) (GSupplicantPeer *peer);
501 void (*peer_changed) (GSupplicantPeer *peer,
502 GSupplicantPeerState state);
503 void (*peer_request) (GSupplicantPeer *peer);
504 void (*debug) (const char *str);
505 void (*disconnect_reasoncode)(GSupplicantInterface *interface,
507 void (*assoc_status_code)(GSupplicantInterface *interface,
509 #if defined TIZEN_EXT_WIFI_MESH
510 void (*mesh_support) (GSupplicantInterface *interface);
511 void (*mesh_group_started) (GSupplicantInterface *interface);
512 void (*mesh_group_removed) (GSupplicantInterface *interface);
513 void (*mesh_peer_connected) (GSupplicantMeshPeer *mesh_peer);
514 void (*mesh_peer_disconnected) (GSupplicantMeshPeer *mesh_peer);
518 typedef struct _GSupplicantCallbacks GSupplicantCallbacks;
520 int g_supplicant_register(const GSupplicantCallbacks *callbacks);
521 void g_supplicant_unregister(const GSupplicantCallbacks *callbacks);
524 void g_supplicant_free_scan_params(GSupplicantScanParams *scan_params)
526 g_slist_free_full(scan_params->ssids, g_free);
527 g_free(scan_params->freqs);
535 #endif /* __G_SUPPLICANT_H */