1 /* 2 * wpa_supplicant/hostapd control interface library 3 * Copyright (c) 2004-2006, Jouni Malinen <j (at) 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 13 extern "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 /** Authentication rejected during connection attempt */ 32 #define WPA_EVENT_AUTH_REJECT "CTRL-EVENT-AUTH-REJECT " 33 /** wpa_supplicant is exiting */ 34 #define WPA_EVENT_TERMINATING "CTRL-EVENT-TERMINATING " 35 /** Password change was completed successfully */ 36 #define WPA_EVENT_PASSWORD_CHANGED "CTRL-EVENT-PASSWORD-CHANGED " 37 /** EAP-Request/Notification received */ 38 #define WPA_EVENT_EAP_NOTIFICATION "CTRL-EVENT-EAP-NOTIFICATION " 39 /** EAP authentication started (EAP-Request/Identity received) */ 40 #define WPA_EVENT_EAP_STARTED "CTRL-EVENT-EAP-STARTED " 41 /** EAP method proposed by the server */ 42 #define WPA_EVENT_EAP_PROPOSED_METHOD "CTRL-EVENT-EAP-PROPOSED-METHOD " 43 /** EAP method selected */ 44 #define WPA_EVENT_EAP_METHOD "CTRL-EVENT-EAP-METHOD " 45 /** EAP peer certificate from TLS */ 46 #define WPA_EVENT_EAP_PEER_CERT "CTRL-EVENT-EAP-PEER-CERT " 47 /** EAP peer certificate alternative subject name component from TLS */ 48 #define WPA_EVENT_EAP_PEER_ALT "CTRL-EVENT-EAP-PEER-ALT " 49 /** EAP TLS certificate chain validation error */ 50 #define WPA_EVENT_EAP_TLS_CERT_ERROR "CTRL-EVENT-EAP-TLS-CERT-ERROR " 51 /** EAP status */ 52 #define WPA_EVENT_EAP_STATUS "CTRL-EVENT-EAP-STATUS " 53 /** EAP authentication completed successfully */ 54 #define WPA_EVENT_EAP_SUCCESS "CTRL-EVENT-EAP-SUCCESS " 55 /** EAP authentication failed (EAP-Failure received) */ 56 #define WPA_EVENT_EAP_FAILURE "CTRL-EVENT-EAP-FAILURE " 57 /** Network block temporarily disabled (e.g., due to authentication failure) */ 58 #define WPA_EVENT_TEMP_DISABLED "CTRL-EVENT-SSID-TEMP-DISABLED " 59 /** Temporarily disabled network block re-enabled */ 60 #define WPA_EVENT_REENABLED "CTRL-EVENT-SSID-REENABLED " 61 /** New scan started */ 62 #define WPA_EVENT_SCAN_STARTED "CTRL-EVENT-SCAN-STARTED " 63 /** New scan results available */ 64 #define WPA_EVENT_SCAN_RESULTS "CTRL-EVENT-SCAN-RESULTS " 65 /** Scan command failed */ 66 #define WPA_EVENT_SCAN_FAILED "CTRL-EVENT-SCAN-FAILED " 67 /** wpa_supplicant state change */ 68 #define WPA_EVENT_STATE_CHANGE "CTRL-EVENT-STATE-CHANGE " 69 /** A new BSS entry was added (followed by BSS entry id and BSSID) */ 70 #define WPA_EVENT_BSS_ADDED "CTRL-EVENT-BSS-ADDED " 71 /** A BSS entry was removed (followed by BSS entry id and BSSID) */ 72 #define WPA_EVENT_BSS_REMOVED "CTRL-EVENT-BSS-REMOVED " 73 /** No suitable network was found */ 74 #define WPA_EVENT_NETWORK_NOT_FOUND "CTRL-EVENT-NETWORK-NOT-FOUND " 75 /** Change in the signal level was reported by the driver */ 76 #define WPA_EVENT_SIGNAL_CHANGE "CTRL-EVENT-SIGNAL-CHANGE " 77 /** Regulatory domain channel */ 78 #define WPA_EVENT_REGDOM_CHANGE "CTRL-EVENT-REGDOM-CHANGE " 79 80 /** IP subnet status change notification 81 * 82 * When using an offloaded roaming mechanism where driver/firmware takes care 83 * of roaming and IP subnet validation checks post-roaming, this event can 84 * indicate whether IP subnet has changed. 85 * 86 * The event has a status=<0/1/2> parameter where 87 * 0 = unknown 88 * 1 = IP subnet unchanged (can continue to use the old IP address) 89 * 2 = IP subnet changed (need to get a new IP address) 90 */ 91 #define WPA_EVENT_SUBNET_STATUS_UPDATE "CTRL-EVENT-SUBNET-STATUS-UPDATE " 92 93 /** RSN IBSS 4-way handshakes completed with specified peer */ 94 #define IBSS_RSN_COMPLETED "IBSS-RSN-COMPLETED " 95 96 /** Notification of frequency conflict due to a concurrent operation. 97 * 98 * The indicated network is disabled and needs to be re-enabled before it can 99 * be used again. 100 */ 101 #define WPA_EVENT_FREQ_CONFLICT "CTRL-EVENT-FREQ-CONFLICT " 102 /** Frequency ranges that the driver recommends to avoid */ 103 #define WPA_EVENT_AVOID_FREQ "CTRL-EVENT-AVOID-FREQ " 104 /** WPS overlap detected in PBC mode */ 105 #define WPS_EVENT_OVERLAP "WPS-OVERLAP-DETECTED " 106 /** Available WPS AP with active PBC found in scan results */ 107 #define WPS_EVENT_AP_AVAILABLE_PBC "WPS-AP-AVAILABLE-PBC " 108 /** Available WPS AP with our address as authorized in scan results */ 109 #define WPS_EVENT_AP_AVAILABLE_AUTH "WPS-AP-AVAILABLE-AUTH " 110 /** Available WPS AP with recently selected PIN registrar found in scan results 111 */ 112 #define WPS_EVENT_AP_AVAILABLE_PIN "WPS-AP-AVAILABLE-PIN " 113 /** Available WPS AP found in scan results */ 114 #define WPS_EVENT_AP_AVAILABLE "WPS-AP-AVAILABLE " 115 /** A new credential received */ 116 #define WPS_EVENT_CRED_RECEIVED "WPS-CRED-RECEIVED " 117 /** M2D received */ 118 #define WPS_EVENT_M2D "WPS-M2D " 119 /** WPS registration failed after M2/M2D */ 120 #define WPS_EVENT_FAIL "WPS-FAIL " 121 /** WPS registration completed successfully */ 122 #define WPS_EVENT_SUCCESS "WPS-SUCCESS " 123 /** WPS enrollment attempt timed out and was terminated */ 124 #define WPS_EVENT_TIMEOUT "WPS-TIMEOUT " 125 /* PBC mode was activated */ 126 #define WPS_EVENT_ACTIVE "WPS-PBC-ACTIVE " 127 /* PBC mode was disabled */ 128 #define WPS_EVENT_DISABLE "WPS-PBC-DISABLE " 129 130 #define WPS_EVENT_ENROLLEE_SEEN "WPS-ENROLLEE-SEEN " 131 132 #define WPS_EVENT_OPEN_NETWORK "WPS-OPEN-NETWORK " 133 134 /* WPS ER events */ 135 #define WPS_EVENT_ER_AP_ADD "WPS-ER-AP-ADD " 136 #define WPS_EVENT_ER_AP_REMOVE "WPS-ER-AP-REMOVE " 137 #define WPS_EVENT_ER_ENROLLEE_ADD "WPS-ER-ENROLLEE-ADD " 138 #define WPS_EVENT_ER_ENROLLEE_REMOVE "WPS-ER-ENROLLEE-REMOVE " 139 #define WPS_EVENT_ER_AP_SETTINGS "WPS-ER-AP-SETTINGS " 140 #define WPS_EVENT_ER_SET_SEL_REG "WPS-ER-AP-SET-SEL-REG " 141 142 /* MESH events */ 143 #define MESH_GROUP_STARTED "MESH-GROUP-STARTED " 144 #define MESH_GROUP_REMOVED "MESH-GROUP-REMOVED " 145 #define MESH_PEER_CONNECTED "MESH-PEER-CONNECTED " 146 #define MESH_PEER_DISCONNECTED "MESH-PEER-DISCONNECTED " 147 /** Mesh SAE authentication failure. Wrong password suspected. */ 148 #define MESH_SAE_AUTH_FAILURE "MESH-SAE-AUTH-FAILURE " 149 #define MESH_SAE_AUTH_BLOCKED "MESH-SAE-AUTH-BLOCKED " 150 151 /* WMM AC events */ 152 #define WMM_AC_EVENT_TSPEC_ADDED "TSPEC-ADDED " 153 #define WMM_AC_EVENT_TSPEC_REMOVED "TSPEC-REMOVED " 154 #define WMM_AC_EVENT_TSPEC_REQ_FAILED "TSPEC-REQ-FAILED " 155 156 /** P2P device found */ 157 #define P2P_EVENT_DEVICE_FOUND "P2P-DEVICE-FOUND " 158 159 /** P2P device lost */ 160 #define P2P_EVENT_DEVICE_LOST "P2P-DEVICE-LOST " 161 162 /** A P2P device requested GO negotiation, but we were not ready to start the 163 * negotiation */ 164 #define P2P_EVENT_GO_NEG_REQUEST "P2P-GO-NEG-REQUEST " 165 #define P2P_EVENT_GO_NEG_SUCCESS "P2P-GO-NEG-SUCCESS " 166 #define P2P_EVENT_GO_NEG_FAILURE "P2P-GO-NEG-FAILURE " 167 #define P2P_EVENT_GROUP_FORMATION_SUCCESS "P2P-GROUP-FORMATION-SUCCESS " 168 #define P2P_EVENT_GROUP_FORMATION_FAILURE "P2P-GROUP-FORMATION-FAILURE " 169 #define P2P_EVENT_GROUP_STARTED "P2P-GROUP-STARTED " 170 #define P2P_EVENT_GROUP_REMOVED "P2P-GROUP-REMOVED " 171 #define P2P_EVENT_CROSS_CONNECT_ENABLE "P2P-CROSS-CONNECT-ENABLE " 172 #define P2P_EVENT_CROSS_CONNECT_DISABLE "P2P-CROSS-CONNECT-DISABLE " 173 /* parameters: <peer address> <PIN> */ 174 #define P2P_EVENT_PROV_DISC_SHOW_PIN "P2P-PROV-DISC-SHOW-PIN " 175 /* parameters: <peer address> */ 176 #define P2P_EVENT_PROV_DISC_ENTER_PIN "P2P-PROV-DISC-ENTER-PIN " 177 /* parameters: <peer address> */ 178 #define P2P_EVENT_PROV_DISC_PBC_REQ "P2P-PROV-DISC-PBC-REQ " 179 /* parameters: <peer address> */ 180 #define P2P_EVENT_PROV_DISC_PBC_RESP "P2P-PROV-DISC-PBC-RESP " 181 /* parameters: <peer address> <status> */ 182 #define P2P_EVENT_PROV_DISC_FAILURE "P2P-PROV-DISC-FAILURE" 183 /* parameters: <freq> <src addr> <dialog token> <update indicator> <TLVs> */ 184 #define P2P_EVENT_SERV_DISC_REQ "P2P-SERV-DISC-REQ " 185 /* parameters: <src addr> <update indicator> <TLVs> */ 186 #define P2P_EVENT_SERV_DISC_RESP "P2P-SERV-DISC-RESP " 187 #define P2P_EVENT_SERV_ASP_RESP "P2P-SERV-ASP-RESP " 188 #define P2P_EVENT_INVITATION_RECEIVED "P2P-INVITATION-RECEIVED " 189 #define P2P_EVENT_INVITATION_RESULT "P2P-INVITATION-RESULT " 190 #define P2P_EVENT_FIND_STOPPED "P2P-FIND-STOPPED " 191 #define P2P_EVENT_PERSISTENT_PSK_FAIL "P2P-PERSISTENT-PSK-FAIL id=" 192 #define P2P_EVENT_PRESENCE_RESPONSE "P2P-PRESENCE-RESPONSE " 193 #define P2P_EVENT_NFC_BOTH_GO "P2P-NFC-BOTH-GO " 194 #define P2P_EVENT_NFC_PEER_CLIENT "P2P-NFC-PEER-CLIENT " 195 #define P2P_EVENT_NFC_WHILE_CLIENT "P2P-NFC-WHILE-CLIENT " 196 #define P2P_EVENT_FALLBACK_TO_GO_NEG "P2P-FALLBACK-TO-GO-NEG " 197 #define P2P_EVENT_FALLBACK_TO_GO_NEG_ENABLED "P2P-FALLBACK-TO-GO-NEG-ENABLED " 198 199 /* parameters: <PMF enabled> <timeout in ms> <Session Information URL> */ 200 #define ESS_DISASSOC_IMMINENT "ESS-DISASSOC-IMMINENT " 201 #define P2P_EVENT_REMOVE_AND_REFORM_GROUP "P2P-REMOVE-AND-REFORM-GROUP " 202 203 #define P2P_EVENT_P2PS_PROVISION_START "P2PS-PROV-START " 204 #define P2P_EVENT_P2PS_PROVISION_DONE "P2PS-PROV-DONE " 205 206 #define INTERWORKING_AP "INTERWORKING-AP " 207 #define INTERWORKING_BLACKLISTED "INTERWORKING-BLACKLISTED " 208 #define INTERWORKING_NO_MATCH "INTERWORKING-NO-MATCH " 209 #define INTERWORKING_ALREADY_CONNECTED "INTERWORKING-ALREADY-CONNECTED " 210 #define INTERWORKING_SELECTED "INTERWORKING-SELECTED " 211 212 /* Credential block added; parameters: <id> */ 213 #define CRED_ADDED "CRED-ADDED " 214 /* Credential block modified; parameters: <id> <field> */ 215 #define CRED_MODIFIED "CRED-MODIFIED " 216 /* Credential block removed; parameters: <id> */ 217 #define CRED_REMOVED "CRED-REMOVED " 218 219 #define GAS_RESPONSE_INFO "GAS-RESPONSE-INFO " 220 /* parameters: <addr> <dialog_token> <freq> */ 221 #define GAS_QUERY_START "GAS-QUERY-START " 222 /* parameters: <addr> <dialog_token> <freq> <status_code> <result> */ 223 #define GAS_QUERY_DONE "GAS-QUERY-DONE " 224 225 /* parameters: <addr> <result> */ 226 #define ANQP_QUERY_DONE "ANQP-QUERY-DONE " 227 228 #define HS20_SUBSCRIPTION_REMEDIATION "HS20-SUBSCRIPTION-REMEDIATION " 229 #define HS20_DEAUTH_IMMINENT_NOTICE "HS20-DEAUTH-IMMINENT-NOTICE " 230 231 #define EXT_RADIO_WORK_START "EXT-RADIO-WORK-START " 232 #define EXT_RADIO_WORK_TIMEOUT "EXT-RADIO-WORK-TIMEOUT " 233 234 #define RRM_EVENT_NEIGHBOR_REP_RXED "RRM-NEIGHBOR-REP-RECEIVED " 235 #define RRM_EVENT_NEIGHBOR_REP_FAILED "RRM-NEIGHBOR-REP-REQUEST-FAILED " 236 237 /* hostapd control interface - fixed message prefixes */ 238 #define WPS_EVENT_PIN_NEEDED "WPS-PIN-NEEDED " 239 #define WPS_EVENT_NEW_AP_SETTINGS "WPS-NEW-AP-SETTINGS " 240 #define WPS_EVENT_REG_SUCCESS "WPS-REG-SUCCESS " 241 #define WPS_EVENT_AP_SETUP_LOCKED "WPS-AP-SETUP-LOCKED " 242 #define WPS_EVENT_AP_SETUP_UNLOCKED "WPS-AP-SETUP-UNLOCKED " 243 #define WPS_EVENT_AP_PIN_ENABLED "WPS-AP-PIN-ENABLED " 244 #define WPS_EVENT_AP_PIN_DISABLED "WPS-AP-PIN-DISABLED " 245 #define AP_STA_CONNECTED "AP-STA-CONNECTED " 246 #define AP_STA_DISCONNECTED "AP-STA-DISCONNECTED " 247 #define AP_STA_POSSIBLE_PSK_MISMATCH "AP-STA-POSSIBLE-PSK-MISMATCH " 248 249 #define AP_REJECTED_MAX_STA "AP-REJECTED-MAX-STA " 250 #define AP_REJECTED_BLOCKED_STA "AP-REJECTED-BLOCKED-STA " 251 252 #define AP_EVENT_ENABLED "AP-ENABLED " 253 #define AP_EVENT_DISABLED "AP-DISABLED " 254 255 #define INTERFACE_ENABLED "INTERFACE-ENABLED " 256 #define INTERFACE_DISABLED "INTERFACE-DISABLED " 257 258 #define ACS_EVENT_STARTED "ACS-STARTED " 259 #define ACS_EVENT_COMPLETED "ACS-COMPLETED " 260 #define ACS_EVENT_FAILED "ACS-FAILED " 261 262 #define DFS_EVENT_RADAR_DETECTED "DFS-RADAR-DETECTED " 263 #define DFS_EVENT_NEW_CHANNEL "DFS-NEW-CHANNEL " 264 #define DFS_EVENT_CAC_START "DFS-CAC-START " 265 #define DFS_EVENT_CAC_COMPLETED "DFS-CAC-COMPLETED " 266 #define DFS_EVENT_NOP_FINISHED "DFS-NOP-FINISHED " 267 268 #define AP_CSA_FINISHED "AP-CSA-FINISHED " 269 270 /* BSS Transition Management Response frame received */ 271 #define BSS_TM_RESP "BSS-TM-RESP " 272 273 /* MBO IE with cellular data connection preference received */ 274 #define MBO_CELL_PREFERENCE "MBO-CELL-PREFERENCE " 275 276 /* BSS Transition Management Request received with MBO transition reason */ 277 #define MBO_TRANSITION_REASON "MBO-TRANSITION-REASON " 278 279 /* BSS command information masks */ 280 281 #define WPA_BSS_MASK_ALL 0xFFFDFFFF 282 #define WPA_BSS_MASK_ID BIT(0) 283 #define WPA_BSS_MASK_BSSID BIT(1) 284 #define WPA_BSS_MASK_FREQ BIT(2) 285 #define WPA_BSS_MASK_BEACON_INT BIT(3) 286 #define WPA_BSS_MASK_CAPABILITIES BIT(4) 287 #define WPA_BSS_MASK_QUAL BIT(5) 288 #define WPA_BSS_MASK_NOISE BIT(6) 289 #define WPA_BSS_MASK_LEVEL BIT(7) 290 #define WPA_BSS_MASK_TSF BIT(8) 291 #define WPA_BSS_MASK_AGE BIT(9) 292 #define WPA_BSS_MASK_IE BIT(10) 293 #define WPA_BSS_MASK_FLAGS BIT(11) 294 #define WPA_BSS_MASK_SSID BIT(12) 295 #define WPA_BSS_MASK_WPS_SCAN BIT(13) 296 #define WPA_BSS_MASK_P2P_SCAN BIT(14) 297 #define WPA_BSS_MASK_INTERNETW BIT(15) 298 #define WPA_BSS_MASK_WIFI_DISPLAY BIT(16) 299 #define WPA_BSS_MASK_DELIM BIT(17) 300 #define WPA_BSS_MASK_MESH_SCAN BIT(18) 301 #define WPA_BSS_MASK_SNR BIT(19) 302 #define WPA_BSS_MASK_EST_THROUGHPUT BIT(20) 303 #define WPA_BSS_MASK_FST BIT(21) 304 305 306 /* VENDOR_ELEM_* frame id values */ 307 enum wpa_vendor_elem_frame { 308 VENDOR_ELEM_PROBE_REQ_P2P = 0, 309 VENDOR_ELEM_PROBE_RESP_P2P = 1, 310 VENDOR_ELEM_PROBE_RESP_P2P_GO = 2, 311 VENDOR_ELEM_BEACON_P2P_GO = 3, 312 VENDOR_ELEM_P2P_PD_REQ = 4, 313 VENDOR_ELEM_P2P_PD_RESP = 5, 314 VENDOR_ELEM_P2P_GO_NEG_REQ = 6, 315 VENDOR_ELEM_P2P_GO_NEG_RESP = 7, 316 VENDOR_ELEM_P2P_GO_NEG_CONF = 8, 317 VENDOR_ELEM_P2P_INV_REQ = 9, 318 VENDOR_ELEM_P2P_INV_RESP = 10, 319 VENDOR_ELEM_P2P_ASSOC_REQ = 11, 320 VENDOR_ELEM_P2P_ASSOC_RESP = 12, 321 VENDOR_ELEM_ASSOC_REQ = 13, 322 NUM_VENDOR_ELEM_FRAMES 323 }; 324 325 326 /* wpa_supplicant/hostapd control interface access */ 327 328 /** 329 * wpa_ctrl_open - Open a control interface to wpa_supplicant/hostapd 330 * @ctrl_path: Path for UNIX domain sockets; ignored if UDP sockets are used. 331 * Returns: Pointer to abstract control interface data or %NULL on failure 332 * 333 * This function is used to open a control interface to wpa_supplicant/hostapd. 334 * ctrl_path is usually /var/run/wpa_supplicant or /var/run/hostapd. This path 335 * is configured in wpa_supplicant/hostapd and other programs using the control 336 * interface need to use matching path configuration. 337 */ 338 struct wpa_ctrl * wpa_ctrl_open(const char *ctrl_path); 339 340 /** 341 * wpa_ctrl_open2 - Open a control interface to wpa_supplicant/hostapd 342 * @ctrl_path: Path for UNIX domain sockets; ignored if UDP sockets are used. 343 * @cli_path: Path for client UNIX domain sockets; ignored if UDP socket 344 * is used. 345 * Returns: Pointer to abstract control interface data or %NULL on failure 346 * 347 * This function is used to open a control interface to wpa_supplicant/hostapd 348 * when the socket path for client need to be specified explicitly. Default 349 * ctrl_path is usually /var/run/wpa_supplicant or /var/run/hostapd and client 350 * socket path is /tmp. 351 */ 352 struct wpa_ctrl * wpa_ctrl_open2(const char *ctrl_path, const char *cli_path); 353 354 355 /** 356 * wpa_ctrl_close - Close a control interface to wpa_supplicant/hostapd 357 * @ctrl: Control interface data from wpa_ctrl_open() 358 * 359 * This function is used to close a control interface. 360 */ 361 void wpa_ctrl_close(struct wpa_ctrl *ctrl); 362 363 364 /** 365 * wpa_ctrl_request - Send a command to wpa_supplicant/hostapd 366 * @ctrl: Control interface data from wpa_ctrl_open() 367 * @cmd: Command; usually, ASCII text, e.g., "PING" 368 * @cmd_len: Length of the cmd in bytes 369 * @reply: Buffer for the response 370 * @reply_len: Reply buffer length 371 * @msg_cb: Callback function for unsolicited messages or %NULL if not used 372 * Returns: 0 on success, -1 on error (send or receive failed), -2 on timeout 373 * 374 * This function is used to send commands to wpa_supplicant/hostapd. Received 375 * response will be written to reply and reply_len is set to the actual length 376 * of the reply. This function will block for up to two seconds while waiting 377 * for the reply. If unsolicited messages are received, the blocking time may 378 * be longer. 379 * 380 * msg_cb can be used to register a callback function that will be called for 381 * unsolicited messages received while waiting for the command response. These 382 * messages may be received if wpa_ctrl_request() is called at the same time as 383 * wpa_supplicant/hostapd is sending such a message. This can happen only if 384 * the program has used wpa_ctrl_attach() to register itself as a monitor for 385 * event messages. Alternatively to msg_cb, programs can register two control 386 * interface connections and use one of them for commands and the other one for 387 * receiving event messages, in other words, call wpa_ctrl_attach() only for 388 * the control interface connection that will be used for event messages. 389 */ 390 int wpa_ctrl_request(struct wpa_ctrl *ctrl, const char *cmd, size_t cmd_len, 391 char *reply, size_t *reply_len, 392 void (*msg_cb)(char *msg, size_t len)); 393 394 395 /** 396 * wpa_ctrl_attach - Register as an event monitor for the control interface 397 * @ctrl: Control interface data from wpa_ctrl_open() 398 * Returns: 0 on success, -1 on failure, -2 on timeout 399 * 400 * This function registers the control interface connection as a monitor for 401 * wpa_supplicant/hostapd events. After a success wpa_ctrl_attach() call, the 402 * control interface connection starts receiving event messages that can be 403 * read with wpa_ctrl_recv(). 404 */ 405 int wpa_ctrl_attach(struct wpa_ctrl *ctrl); 406 407 408 /** 409 * wpa_ctrl_detach - Unregister event monitor from the control interface 410 * @ctrl: Control interface data from wpa_ctrl_open() 411 * Returns: 0 on success, -1 on failure, -2 on timeout 412 * 413 * This function unregisters the control interface connection as a monitor for 414 * wpa_supplicant/hostapd events, i.e., cancels the registration done with 415 * wpa_ctrl_attach(). 416 */ 417 int wpa_ctrl_detach(struct wpa_ctrl *ctrl); 418 419 420 /** 421 * wpa_ctrl_recv - Receive a pending control interface message 422 * @ctrl: Control interface data from wpa_ctrl_open() 423 * @reply: Buffer for the message data 424 * @reply_len: Length of the reply buffer 425 * Returns: 0 on success, -1 on failure 426 * 427 * This function will receive a pending control interface message. The received 428 * response will be written to reply and reply_len is set to the actual length 429 * of the reply. 430 431 * wpa_ctrl_recv() is only used for event messages, i.e., wpa_ctrl_attach() 432 * must have been used to register the control interface as an event monitor. 433 */ 434 int wpa_ctrl_recv(struct wpa_ctrl *ctrl, char *reply, size_t *reply_len); 435 436 437 /** 438 * wpa_ctrl_pending - Check whether there are pending event messages 439 * @ctrl: Control interface data from wpa_ctrl_open() 440 * Returns: 1 if there are pending messages, 0 if no, or -1 on error 441 * 442 * This function will check whether there are any pending control interface 443 * message available to be received with wpa_ctrl_recv(). wpa_ctrl_pending() is 444 * only used for event messages, i.e., wpa_ctrl_attach() must have been used to 445 * register the control interface as an event monitor. 446 */ 447 int wpa_ctrl_pending(struct wpa_ctrl *ctrl); 448 449 450 /** 451 * wpa_ctrl_get_fd - Get file descriptor used by the control interface 452 * @ctrl: Control interface data from wpa_ctrl_open() 453 * Returns: File descriptor used for the connection 454 * 455 * This function can be used to get the file descriptor that is used for the 456 * control interface connection. The returned value can be used, e.g., with 457 * select() while waiting for multiple events. 458 * 459 * The returned file descriptor must not be used directly for sending or 460 * receiving packets; instead, the library functions wpa_ctrl_request() and 461 * wpa_ctrl_recv() must be used for this. 462 */ 463 int wpa_ctrl_get_fd(struct wpa_ctrl *ctrl); 464 465 #ifdef ANDROID 466 /** 467 * wpa_ctrl_cleanup() - Delete any local UNIX domain socket files that 468 * may be left over from clients that were previously connected to 469 * wpa_supplicant. This keeps these files from being orphaned in the 470 * event of crashes that prevented them from being removed as part 471 * of the normal orderly shutdown. 472 */ 473 void wpa_ctrl_cleanup(void); 474 #endif /* ANDROID */ 475 476 #ifdef CONFIG_CTRL_IFACE_UDP 477 /* Port range for multiple wpa_supplicant instances and multiple VIFs */ 478 #define WPA_CTRL_IFACE_PORT 9877 479 #define WPA_CTRL_IFACE_PORT_LIMIT 50 /* decremented from start */ 480 #define WPA_GLOBAL_CTRL_IFACE_PORT 9878 481 #define WPA_GLOBAL_CTRL_IFACE_PORT_LIMIT 20 /* incremented from start */ 482 483 char * wpa_ctrl_get_remote_ifname(struct wpa_ctrl *ctrl); 484 #endif /* CONFIG_CTRL_IFACE_UDP */ 485 486 487 #ifdef __cplusplus 488 } 489 #endif 490 491 #endif /* WPA_CTRL_H */ 492
