wpa_ctrl.h revision a6163554e8e14a7f561b94f5743ae9df2424c969
1/* 2 * wpa_supplicant/hostapd control interface library 3 * Copyright (c) 2004-2006, Jouni Malinen <j@w1.fi> 4 * 5 * This software may be distributed under the terms of the BSD license. 6 * See README for more details. 7 */ 8 9#ifndef WPA_CTRL_H 10#define WPA_CTRL_H 11 12#ifdef __cplusplus 13extern "C" { 14#endif 15 16/* wpa_supplicant control interface - fixed message prefixes */ 17 18/** Interactive request for identity/password/pin */ 19#define WPA_CTRL_REQ "CTRL-REQ-" 20 21/** Response to identity/password/pin request */ 22#define WPA_CTRL_RSP "CTRL-RSP-" 23 24/* Event messages with fixed prefix */ 25/** Authentication completed successfully and data connection enabled */ 26#define WPA_EVENT_CONNECTED "CTRL-EVENT-CONNECTED " 27/** Disconnected, data connection is not available */ 28#define WPA_EVENT_DISCONNECTED "CTRL-EVENT-DISCONNECTED " 29/** Association rejected during connection attempt */ 30#define WPA_EVENT_ASSOC_REJECT "CTRL-EVENT-ASSOC-REJECT " 31/** wpa_supplicant is exiting */ 32#define WPA_EVENT_TERMINATING "CTRL-EVENT-TERMINATING " 33/** Password change was completed successfully */ 34#define WPA_EVENT_PASSWORD_CHANGED "CTRL-EVENT-PASSWORD-CHANGED " 35/** EAP-Request/Notification received */ 36#define WPA_EVENT_EAP_NOTIFICATION "CTRL-EVENT-EAP-NOTIFICATION " 37/** EAP authentication started (EAP-Request/Identity received) */ 38#define WPA_EVENT_EAP_STARTED "CTRL-EVENT-EAP-STARTED " 39/** EAP method proposed by the server */ 40#define WPA_EVENT_EAP_PROPOSED_METHOD "CTRL-EVENT-EAP-PROPOSED-METHOD " 41/** EAP method selected */ 42#define WPA_EVENT_EAP_METHOD "CTRL-EVENT-EAP-METHOD " 43/** EAP peer certificate from TLS */ 44#define WPA_EVENT_EAP_PEER_CERT "CTRL-EVENT-EAP-PEER-CERT " 45/** EAP TLS certificate chain validation error */ 46#define WPA_EVENT_EAP_TLS_CERT_ERROR "CTRL-EVENT-EAP-TLS-CERT-ERROR " 47/** EAP status */ 48#define WPA_EVENT_EAP_STATUS "CTRL-EVENT-EAP-STATUS " 49/** EAP authentication completed successfully */ 50#define WPA_EVENT_EAP_SUCCESS "CTRL-EVENT-EAP-SUCCESS " 51/** EAP authentication failed (EAP-Failure received) */ 52#define WPA_EVENT_EAP_FAILURE "CTRL-EVENT-EAP-FAILURE " 53/** Network block temporarily disabled (e.g., due to authentication failure) */ 54#define WPA_EVENT_TEMP_DISABLED "CTRL-EVENT-SSID-TEMP-DISABLED " 55/** Temporarily disabled network block re-enabled */ 56#define WPA_EVENT_REENABLED "CTRL-EVENT-SSID-REENABLED " 57/** New scan results available */ 58#define WPA_EVENT_SCAN_RESULTS "CTRL-EVENT-SCAN-RESULTS " 59/** wpa_supplicant state change */ 60#define WPA_EVENT_STATE_CHANGE "CTRL-EVENT-STATE-CHANGE " 61/** A new BSS entry was added (followed by BSS entry id and BSSID) */ 62#define WPA_EVENT_BSS_ADDED "CTRL-EVENT-BSS-ADDED " 63/** A BSS entry was removed (followed by BSS entry id and BSSID) */ 64#define WPA_EVENT_BSS_REMOVED "CTRL-EVENT-BSS-REMOVED " 65 66/** RSN IBSS 4-way handshakes completed with specified peer */ 67#define IBSS_RSN_COMPLETED "IBSS-RSN-COMPLETED " 68 69/** WPS overlap detected in PBC mode */ 70#define WPS_EVENT_OVERLAP "WPS-OVERLAP-DETECTED " 71/** Available WPS AP with active PBC found in scan results */ 72#define WPS_EVENT_AP_AVAILABLE_PBC "WPS-AP-AVAILABLE-PBC " 73/** Available WPS AP with our address as authorized in scan results */ 74#define WPS_EVENT_AP_AVAILABLE_AUTH "WPS-AP-AVAILABLE-AUTH " 75/** Available WPS AP with recently selected PIN registrar found in scan results 76 */ 77#define WPS_EVENT_AP_AVAILABLE_PIN "WPS-AP-AVAILABLE-PIN " 78/** Available WPS AP found in scan results */ 79#define WPS_EVENT_AP_AVAILABLE "WPS-AP-AVAILABLE " 80/** A new credential received */ 81#define WPS_EVENT_CRED_RECEIVED "WPS-CRED-RECEIVED " 82/** M2D received */ 83#define WPS_EVENT_M2D "WPS-M2D " 84/** WPS registration failed after M2/M2D */ 85#define WPS_EVENT_FAIL "WPS-FAIL " 86/** WPS registration completed successfully */ 87#define WPS_EVENT_SUCCESS "WPS-SUCCESS " 88/** WPS enrollment attempt timed out and was terminated */ 89#define WPS_EVENT_TIMEOUT "WPS-TIMEOUT " 90/* PBC mode was activated */ 91#define WPS_EVENT_ACTIVE "WPS-PBC-ACTIVE " 92/* PBC mode was disabled */ 93#define WPS_EVENT_DISABLE "WPS-PBC-DISABLE " 94 95#define WPS_EVENT_ENROLLEE_SEEN "WPS-ENROLLEE-SEEN " 96 97#define WPS_EVENT_OPEN_NETWORK "WPS-OPEN-NETWORK " 98 99/* WPS ER events */ 100#define WPS_EVENT_ER_AP_ADD "WPS-ER-AP-ADD " 101#define WPS_EVENT_ER_AP_REMOVE "WPS-ER-AP-REMOVE " 102#define WPS_EVENT_ER_ENROLLEE_ADD "WPS-ER-ENROLLEE-ADD " 103#define WPS_EVENT_ER_ENROLLEE_REMOVE "WPS-ER-ENROLLEE-REMOVE " 104#define WPS_EVENT_ER_AP_SETTINGS "WPS-ER-AP-SETTINGS " 105#define WPS_EVENT_ER_SET_SEL_REG "WPS-ER-AP-SET-SEL-REG " 106 107/** P2P device found */ 108#define P2P_EVENT_DEVICE_FOUND "P2P-DEVICE-FOUND " 109 110/** P2P device lost */ 111#define P2P_EVENT_DEVICE_LOST "P2P-DEVICE-LOST " 112 113/** A P2P device requested GO negotiation, but we were not ready to start the 114 * negotiation */ 115#define P2P_EVENT_GO_NEG_REQUEST "P2P-GO-NEG-REQUEST " 116#define P2P_EVENT_GO_NEG_SUCCESS "P2P-GO-NEG-SUCCESS " 117#define P2P_EVENT_GO_NEG_FAILURE "P2P-GO-NEG-FAILURE " 118#define P2P_EVENT_GROUP_FORMATION_SUCCESS "P2P-GROUP-FORMATION-SUCCESS " 119#define P2P_EVENT_GROUP_FORMATION_FAILURE "P2P-GROUP-FORMATION-FAILURE " 120#define P2P_EVENT_GROUP_STARTED "P2P-GROUP-STARTED " 121#define P2P_EVENT_GROUP_REMOVED "P2P-GROUP-REMOVED " 122#define P2P_EVENT_CROSS_CONNECT_ENABLE "P2P-CROSS-CONNECT-ENABLE " 123#define P2P_EVENT_CROSS_CONNECT_DISABLE "P2P-CROSS-CONNECT-DISABLE " 124/* parameters: <peer address> <PIN> */ 125#define P2P_EVENT_PROV_DISC_SHOW_PIN "P2P-PROV-DISC-SHOW-PIN " 126/* parameters: <peer address> */ 127#define P2P_EVENT_PROV_DISC_ENTER_PIN "P2P-PROV-DISC-ENTER-PIN " 128/* parameters: <peer address> */ 129#define P2P_EVENT_PROV_DISC_PBC_REQ "P2P-PROV-DISC-PBC-REQ " 130/* parameters: <peer address> */ 131#define P2P_EVENT_PROV_DISC_PBC_RESP "P2P-PROV-DISC-PBC-RESP " 132/* parameters: <peer address> <status> */ 133#define P2P_EVENT_PROV_DISC_FAILURE "P2P-PROV-DISC-FAILURE" 134/* parameters: <freq> <src addr> <dialog token> <update indicator> <TLVs> */ 135#define P2P_EVENT_SERV_DISC_REQ "P2P-SERV-DISC-REQ " 136/* parameters: <src addr> <update indicator> <TLVs> */ 137#define P2P_EVENT_SERV_DISC_RESP "P2P-SERV-DISC-RESP " 138#define P2P_EVENT_INVITATION_RECEIVED "P2P-INVITATION-RECEIVED " 139#define P2P_EVENT_INVITATION_RESULT "P2P-INVITATION-RESULT " 140#define P2P_EVENT_FIND_STOPPED "P2P-FIND-STOPPED " 141#define P2P_EVENT_PERSISTENT_PSK_FAIL "P2P-PERSISTENT-PSK-FAIL id=" 142 143/* parameters: <PMF enabled> <timeout in ms> <Session Information URL> */ 144#define ESS_DISASSOC_IMMINENT "ESS-DISASSOC-IMMINENT " 145 146#define INTERWORKING_AP "INTERWORKING-AP " 147#define INTERWORKING_NO_MATCH "INTERWORKING-NO-MATCH " 148#define INTERWORKING_ALREADY_CONNECTED "INTERWORKING-ALREADY-CONNECTED " 149 150#define GAS_RESPONSE_INFO "GAS-RESPONSE-INFO " 151 152/* hostapd control interface - fixed message prefixes */ 153#define WPS_EVENT_PIN_NEEDED "WPS-PIN-NEEDED " 154#define WPS_EVENT_NEW_AP_SETTINGS "WPS-NEW-AP-SETTINGS " 155#define WPS_EVENT_REG_SUCCESS "WPS-REG-SUCCESS " 156#define WPS_EVENT_AP_SETUP_LOCKED "WPS-AP-SETUP-LOCKED " 157#define WPS_EVENT_AP_SETUP_UNLOCKED "WPS-AP-SETUP-UNLOCKED " 158#define WPS_EVENT_AP_PIN_ENABLED "WPS-AP-PIN-ENABLED " 159#define WPS_EVENT_AP_PIN_DISABLED "WPS-AP-PIN-DISABLED " 160#define AP_STA_CONNECTED "AP-STA-CONNECTED " 161#define AP_STA_DISCONNECTED "AP-STA-DISCONNECTED " 162 163#define AP_REJECTED_MAX_STA "AP-REJECTED-MAX-STA " 164#define AP_REJECTED_BLOCKED_STA "AP-REJECTED-BLOCKED-STA " 165 166#define AP_EVENT_ENABLED "AP-ENABLED " 167#define AP_EVENT_DISABLED "AP-DISABLED " 168 169#define ACS_EVENT_STARTED "ACS-STARTED " 170#define ACS_EVENT_COMPLETED "ACS-COMPLETED " 171#define ACS_EVENT_FAILED "ACS-FAILED " 172 173#define DFS_EVENT_RADAR_DETECTED "DFS-RADAR-DETECTED " 174#define DFS_EVENT_NEW_CHANNEL "DFS-NEW-CHANNEL " 175#define DFS_EVENT_CAC_START "DFS-CAC-START " 176#define DFS_EVENT_CAC_COMPLETED "DFS-CAC-COMPLETED " 177#define DFS_EVENT_NOP_FINISHED "DFS-NOP-FINISHED " 178 179#define AP_CSA_FINISHED "AP-CSA-FINISHED " 180 181/* BSS command information masks */ 182 183#define WPA_BSS_MASK_ALL 0xFFFDFFFF 184#define WPA_BSS_MASK_ID BIT(0) 185#define WPA_BSS_MASK_BSSID BIT(1) 186#define WPA_BSS_MASK_FREQ BIT(2) 187#define WPA_BSS_MASK_BEACON_INT BIT(3) 188#define WPA_BSS_MASK_CAPABILITIES BIT(4) 189#define WPA_BSS_MASK_QUAL BIT(5) 190#define WPA_BSS_MASK_NOISE BIT(6) 191#define WPA_BSS_MASK_LEVEL BIT(7) 192#define WPA_BSS_MASK_TSF BIT(8) 193#define WPA_BSS_MASK_AGE BIT(9) 194#define WPA_BSS_MASK_IE BIT(10) 195#define WPA_BSS_MASK_FLAGS BIT(11) 196#define WPA_BSS_MASK_SSID BIT(12) 197#define WPA_BSS_MASK_WPS_SCAN BIT(13) 198#define WPA_BSS_MASK_P2P_SCAN BIT(14) 199#define WPA_BSS_MASK_INTERNETW BIT(15) 200#define WPA_BSS_MASK_WIFI_DISPLAY BIT(16) 201#define WPA_BSS_MASK_DELIM BIT(17) 202 203 204/* wpa_supplicant/hostapd control interface access */ 205 206/** 207 * wpa_ctrl_open - Open a control interface to wpa_supplicant/hostapd 208 * @ctrl_path: Path for UNIX domain sockets; ignored if UDP sockets are used. 209 * Returns: Pointer to abstract control interface data or %NULL on failure 210 * 211 * This function is used to open a control interface to wpa_supplicant/hostapd. 212 * ctrl_path is usually /var/run/wpa_supplicant or /var/run/hostapd. This path 213 * is configured in wpa_supplicant/hostapd and other programs using the control 214 * interface need to use matching path configuration. 215 */ 216struct wpa_ctrl * wpa_ctrl_open(const char *ctrl_path); 217 218 219/** 220 * wpa_ctrl_close - Close a control interface to wpa_supplicant/hostapd 221 * @ctrl: Control interface data from wpa_ctrl_open() 222 * 223 * This function is used to close a control interface. 224 */ 225void wpa_ctrl_close(struct wpa_ctrl *ctrl); 226 227 228/** 229 * wpa_ctrl_request - Send a command to wpa_supplicant/hostapd 230 * @ctrl: Control interface data from wpa_ctrl_open() 231 * @cmd: Command; usually, ASCII text, e.g., "PING" 232 * @cmd_len: Length of the cmd in bytes 233 * @reply: Buffer for the response 234 * @reply_len: Reply buffer length 235 * @msg_cb: Callback function for unsolicited messages or %NULL if not used 236 * Returns: 0 on success, -1 on error (send or receive failed), -2 on timeout 237 * 238 * This function is used to send commands to wpa_supplicant/hostapd. Received 239 * response will be written to reply and reply_len is set to the actual length 240 * of the reply. This function will block for up to two seconds while waiting 241 * for the reply. If unsolicited messages are received, the blocking time may 242 * be longer. 243 * 244 * msg_cb can be used to register a callback function that will be called for 245 * unsolicited messages received while waiting for the command response. These 246 * messages may be received if wpa_ctrl_request() is called at the same time as 247 * wpa_supplicant/hostapd is sending such a message. This can happen only if 248 * the program has used wpa_ctrl_attach() to register itself as a monitor for 249 * event messages. Alternatively to msg_cb, programs can register two control 250 * interface connections and use one of them for commands and the other one for 251 * receiving event messages, in other words, call wpa_ctrl_attach() only for 252 * the control interface connection that will be used for event messages. 253 */ 254int wpa_ctrl_request(struct wpa_ctrl *ctrl, const char *cmd, size_t cmd_len, 255 char *reply, size_t *reply_len, 256 void (*msg_cb)(char *msg, size_t len)); 257 258 259/** 260 * wpa_ctrl_attach - Register as an event monitor for the control interface 261 * @ctrl: Control interface data from wpa_ctrl_open() 262 * Returns: 0 on success, -1 on failure, -2 on timeout 263 * 264 * This function registers the control interface connection as a monitor for 265 * wpa_supplicant/hostapd events. After a success wpa_ctrl_attach() call, the 266 * control interface connection starts receiving event messages that can be 267 * read with wpa_ctrl_recv(). 268 */ 269int wpa_ctrl_attach(struct wpa_ctrl *ctrl); 270 271 272/** 273 * wpa_ctrl_detach - Unregister event monitor from the control interface 274 * @ctrl: Control interface data from wpa_ctrl_open() 275 * Returns: 0 on success, -1 on failure, -2 on timeout 276 * 277 * This function unregisters the control interface connection as a monitor for 278 * wpa_supplicant/hostapd events, i.e., cancels the registration done with 279 * wpa_ctrl_attach(). 280 */ 281int wpa_ctrl_detach(struct wpa_ctrl *ctrl); 282 283 284/** 285 * wpa_ctrl_recv - Receive a pending control interface message 286 * @ctrl: Control interface data from wpa_ctrl_open() 287 * @reply: Buffer for the message data 288 * @reply_len: Length of the reply buffer 289 * Returns: 0 on success, -1 on failure 290 * 291 * This function will receive a pending control interface message. This 292 * function will block if no messages are available. The received response will 293 * be written to reply and reply_len is set to the actual length of the reply. 294 * wpa_ctrl_recv() is only used for event messages, i.e., wpa_ctrl_attach() 295 * must have been used to register the control interface as an event monitor. 296 */ 297int wpa_ctrl_recv(struct wpa_ctrl *ctrl, char *reply, size_t *reply_len); 298 299 300/** 301 * wpa_ctrl_pending - Check whether there are pending event messages 302 * @ctrl: Control interface data from wpa_ctrl_open() 303 * Returns: 1 if there are pending messages, 0 if no, or -1 on error 304 * 305 * This function will check whether there are any pending control interface 306 * message available to be received with wpa_ctrl_recv(). wpa_ctrl_pending() is 307 * only used for event messages, i.e., wpa_ctrl_attach() must have been used to 308 * register the control interface as an event monitor. 309 */ 310int wpa_ctrl_pending(struct wpa_ctrl *ctrl); 311 312 313/** 314 * wpa_ctrl_get_fd - Get file descriptor used by the control interface 315 * @ctrl: Control interface data from wpa_ctrl_open() 316 * Returns: File descriptor used for the connection 317 * 318 * This function can be used to get the file descriptor that is used for the 319 * control interface connection. The returned value can be used, e.g., with 320 * select() while waiting for multiple events. 321 * 322 * The returned file descriptor must not be used directly for sending or 323 * receiving packets; instead, the library functions wpa_ctrl_request() and 324 * wpa_ctrl_recv() must be used for this. 325 */ 326int wpa_ctrl_get_fd(struct wpa_ctrl *ctrl); 327 328char * wpa_ctrl_get_remote_ifname(struct wpa_ctrl *ctrl); 329 330#ifdef ANDROID 331/** 332 * wpa_ctrl_cleanup() - Delete any local UNIX domain socket files that 333 * may be left over from clients that were previously connected to 334 * wpa_supplicant. This keeps these files from being orphaned in the 335 * event of crashes that prevented them from being removed as part 336 * of the normal orderly shutdown. 337 */ 338void wpa_ctrl_cleanup(void); 339#endif /* ANDROID */ 340 341#ifdef CONFIG_CTRL_IFACE_UDP 342/* Port range for multiple wpa_supplicant instances and multiple VIFs */ 343#define WPA_CTRL_IFACE_PORT 9877 344#define WPA_CTRL_IFACE_PORT_LIMIT 50 /* decremented from start */ 345#define WPA_GLOBAL_CTRL_IFACE_PORT 9878 346#define WPA_GLOBAL_CTRL_IFACE_PORT_LIMIT 20 /* incremented from start */ 347#endif /* CONFIG_CTRL_IFACE_UDP */ 348 349 350#ifdef __cplusplus 351} 352#endif 353 354#endif /* WPA_CTRL_H */ 355