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 struct _GSupplicantSSID {
 133         const void *ssid;
 134         unsigned int ssid_len;
 135         unsigned int scan_ssid;
 136         GSupplicantMode mode;
 137         GSupplicantSecurity security;
 138         unsigned int protocol;
 139         unsigned int pairwise_cipher;
 140         unsigned int group_cipher;
 141         unsigned int freq;
 142         const char *eap;
 143         const char *passphrase;
 144         const char *identity;
 145         const char *ca_cert_path;
 146         const char *client_cert_path;
 147         const char *private_key_path;
 148         const char *private_key_passphrase;
 149         const char *phase2_auth;
 150         dbus_bool_t use_wps;
 151         const char *pin_wps;
 152         const char *bgscan;
 153 };
 154
 155 typedef struct _GSupplicantSSID GSupplicantSSID;
 156
 157 struct scan_ssid {
 158         unsigned char ssid[32];
 159         uint8_t ssid_len;
 160 };
 161
 162 struct _GSupplicantScanParams {
 163         GSList *ssids;
 164
 165         uint8_t num_ssids;
 166
 167         uint8_t num_freqs;
 168         uint16_t *freqs;
 169 };
 170
 171 typedef struct _GSupplicantScanParams GSupplicantScanParams;
 172
 173 struct _GSupplicantPeerParams {
 174         bool master;
 175         char *wps_pin;
 176         char *path;
 177 };
 178
 179 typedef struct _GSupplicantPeerParams GSupplicantPeerParams;
 180
 181 struct _GSupplicantP2PServiceParams {
 182         int version;
 183         char *service;
 184         unsigned char *query;
 185         int query_length;
 186         unsigned char *response;
 187         int response_length;
 188         unsigned char *wfd_ies;
 189         int wfd_ies_length;
 190 };
 191
 192 typedef struct _GSupplicantP2PServiceParams GSupplicantP2PServiceParams;
 193
 194 /* global API */
 195 typedef void (*GSupplicantCountryCallback) (int result,
 196                                                 const char *alpha2,
 197                                                         void *user_data);
 198
 199 int g_supplicant_set_country(const char *alpha2,
 200                                 GSupplicantCountryCallback callback,
 201                                                 const void *user_data);
 202
 203 /* Interface API */
 204 struct _GSupplicantInterface;
 205 struct _GSupplicantPeer;
 206
 207 typedef struct _GSupplicantInterface GSupplicantInterface;
 208 typedef struct _GSupplicantPeer GSupplicantPeer;
 209
 210 typedef void (*GSupplicantInterfaceCallback) (int result,
 211                                         GSupplicantInterface *interface,
 212                                                         void *user_data);
 213
 214 void g_supplicant_interface_cancel(GSupplicantInterface *interface);
 215
 216 int g_supplicant_interface_create(const char *ifname, const char *driver,
 217                                         const char *bridge,
 218                                         GSupplicantInterfaceCallback callback,
 219                                                         void *user_data);
 220 int g_supplicant_interface_remove(GSupplicantInterface *interface,
 221                                         GSupplicantInterfaceCallback callback,
 222                                                         void *user_data);
 223 int g_supplicant_interface_scan(GSupplicantInterface *interface,
 224                                         GSupplicantScanParams *scan_data,
 225                                         GSupplicantInterfaceCallback callback,
 226                                                         void *user_data);
 227
 228 int g_supplicant_interface_autoscan(GSupplicantInterface *interface,
 229                                         const char *autoscan_data,
 230                                         GSupplicantInterfaceCallback callback,
 231                                                         void *user_data);
 232
 233 int g_supplicant_interface_p2p_find(GSupplicantInterface *interface,
 234                                         GSupplicantInterfaceCallback callback,
 235                                                         void *user_data);
 236
 237 int g_supplicant_interface_p2p_stop_find(GSupplicantInterface *interface);
 238
 239 int g_supplicant_interface_p2p_connect(GSupplicantInterface *interface,
 240                                         GSupplicantPeerParams *peer_params,
 241                                         GSupplicantInterfaceCallback callback,
 242                                         void *user_data);
 243
 244 int g_supplicant_interface_p2p_disconnect(GSupplicantInterface *interface,
 245                                         GSupplicantPeerParams *peer_params);
 246
 247 int g_supplicant_interface_p2p_listen(GSupplicantInterface *interface,
 248                                                 int period, int interval);
 249
 250 int g_supplicant_interface_p2p_add_service(GSupplicantInterface *interface,
 251                                 GSupplicantInterfaceCallback callback,
 252                                 GSupplicantP2PServiceParams *p2p_service_params,
 253                                 void *user_data);
 254
 255 int g_supplicant_interface_p2p_del_service(GSupplicantInterface *interface,
 256                                 GSupplicantP2PServiceParams *p2p_service_params);
 257
 258 int g_supplicant_set_widi_ies(GSupplicantP2PServiceParams *p2p_service_params,
 259                                         GSupplicantInterfaceCallback callback,
 260                                         void *user_data);
 261
 262 int g_supplicant_interface_connect(GSupplicantInterface *interface,
 263                                         GSupplicantSSID *ssid,
 264                                         GSupplicantInterfaceCallback callback,
 265                                                         void *user_data);
 266
 267 int g_supplicant_interface_disconnect(GSupplicantInterface *interface,
 268                                         GSupplicantInterfaceCallback callback,
 269                                                         void *user_data);
 270
 271 int g_supplicant_interface_set_apscan(GSupplicantInterface *interface,
 272                                                         unsigned int ap_scan);
 273
 274 void g_supplicant_interface_set_data(GSupplicantInterface *interface,
 275                                                                 void *data);
 276 void *g_supplicant_interface_get_data(GSupplicantInterface *interface);
 277 const char *g_supplicant_interface_get_ifname(GSupplicantInterface *interface);
 278 const char *g_supplicant_interface_get_driver(GSupplicantInterface *interface);
 279 GSupplicantState g_supplicant_interface_get_state(GSupplicantInterface *interface);
 280 const char *g_supplicant_interface_get_wps_key(GSupplicantInterface *interface);
 281 const void *g_supplicant_interface_get_wps_ssid(GSupplicantInterface *interface,
 282                                                         unsigned int *ssid_len);
 283 GSupplicantWpsState g_supplicant_interface_get_wps_state(GSupplicantInterface *interface);
 284 unsigned int g_supplicant_interface_get_mode(GSupplicantInterface *interface);
 285 dbus_bool_t g_supplicant_interface_get_ready(GSupplicantInterface *interface);
 286 unsigned int g_supplicant_interface_get_max_scan_ssids(
 287                                         GSupplicantInterface *interface);
 288
 289 int g_supplicant_interface_enable_selected_network(GSupplicantInterface *interface,
 290                                                         dbus_bool_t enable);
 291 int g_supplicant_interface_set_country(GSupplicantInterface *interface,
 292                                         GSupplicantCountryCallback callback,
 293                                                         const char *alpha2,
 294                                                         void *user_data);
 295 bool g_supplicant_interface_has_p2p(GSupplicantInterface *interface);
 296 int g_supplicant_interface_set_p2p_device_config(GSupplicantInterface *interface,
 297                                                 const char *device_name,
 298                                                 const char *primary_dev_type);
 299 GSupplicantPeer *g_supplicant_interface_peer_lookup(GSupplicantInterface *interface,
 300                                                 const char *identifier);
 301 bool g_supplicant_interface_is_p2p_finding(GSupplicantInterface *interface);
 302
 303 /* Network and Peer API */
 304 struct _GSupplicantNetwork;
 305 struct _GSupplicantGroup;
 306
 307 typedef struct _GSupplicantNetwork GSupplicantNetwork;
 308 typedef struct _GSupplicantGroup GSupplicantGroup;
 309
 310 GSupplicantInterface *g_supplicant_network_get_interface(GSupplicantNetwork *network);
 311 const char *g_supplicant_network_get_name(GSupplicantNetwork *network);
 312 const char *g_supplicant_network_get_identifier(GSupplicantNetwork *network);
 313 const char *g_supplicant_network_get_path(GSupplicantNetwork *network);
 314 const void *g_supplicant_network_get_ssid(GSupplicantNetwork *network,
 315                                                         unsigned int *ssid_len);
 316 const char *g_supplicant_network_get_mode(GSupplicantNetwork *network);
 317 const char *g_supplicant_network_get_security(GSupplicantNetwork *network);
 318 dbus_int16_t g_supplicant_network_get_signal(GSupplicantNetwork *network);
 319 dbus_uint16_t g_supplicant_network_get_frequency(GSupplicantNetwork *network);
 320 dbus_bool_t g_supplicant_network_get_wps(GSupplicantNetwork *network);
 321 dbus_bool_t g_supplicant_network_is_wps_active(GSupplicantNetwork *network);
 322 dbus_bool_t g_supplicant_network_is_wps_pbc(GSupplicantNetwork *network);
 323 dbus_bool_t g_supplicant_network_is_wps_advertizing(GSupplicantNetwork *network);
 324
 325 GSupplicantInterface *g_supplicant_peer_get_interface(GSupplicantPeer *peer);
 326 const char *g_supplicant_peer_get_path(GSupplicantPeer *peer);
 327 const char *g_supplicant_peer_get_identifier(GSupplicantPeer *peer);
 328 const void *g_supplicant_peer_get_device_address(GSupplicantPeer *peer);
 329 const char *g_supplicant_peer_get_name(GSupplicantPeer *peer);
 330 const unsigned char *g_supplicant_peer_get_widi_ies(GSupplicantPeer *peer,
 331                                                                 int *length);
 332 bool g_supplicant_peer_is_wps_pbc(GSupplicantPeer *peer);
 333 bool g_supplicant_peer_is_wps_pin(GSupplicantPeer *peer);
 334 bool g_supplicant_peer_is_in_a_group(GSupplicantPeer *peer);
 335 GSupplicantInterface *g_supplicant_peer_get_group_interface(GSupplicantPeer *peer);
 336 bool g_supplicant_peer_is_client(GSupplicantPeer *peer);
 337 bool g_supplicant_peer_has_requested_connection(GSupplicantPeer *peer);
 338
 339 struct _GSupplicantCallbacks {
 340         void (*system_ready) (void);
 341         void (*system_killed) (void);
 342         void (*interface_added) (GSupplicantInterface *interface);
 343         void (*interface_state) (GSupplicantInterface *interface);
 344         void (*interface_removed) (GSupplicantInterface *interface);
 345         void (*p2p_support) (GSupplicantInterface *interface);
 346         void (*scan_started) (GSupplicantInterface *interface);
 347         void (*scan_finished) (GSupplicantInterface *interface);
 348         void (*network_added) (GSupplicantNetwork *network);
 349         void (*network_removed) (GSupplicantNetwork *network);
 350         void (*network_changed) (GSupplicantNetwork *network,
 351                                         const char *property);
 352         void (*peer_found) (GSupplicantPeer *peer);
 353         void (*peer_lost) (GSupplicantPeer *peer);
 354         void (*peer_changed) (GSupplicantPeer *peer,
 355                                         GSupplicantPeerState state);
 356         void (*peer_request) (GSupplicantPeer *peer);
 357         void (*debug) (const char *str);
 358 };
 359
 360 typedef struct _GSupplicantCallbacks GSupplicantCallbacks;
 361
 362 int g_supplicant_register(const GSupplicantCallbacks *callbacks);
 363 void g_supplicant_unregister(const GSupplicantCallbacks *callbacks);
 364
 365 static inline
 366 void g_supplicant_free_scan_params(GSupplicantScanParams *scan_params)
 367 {
 368         g_slist_free_full(scan_params->ssids, g_free);
 369         g_free(scan_params->freqs);
 370         g_free(scan_params);
 371 }
 372
 373 #ifdef __cplusplus
 374 }
 375 #endif
 376
 377 #endif /* __G_SUPPLICANT_H */