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