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