1 /* 2 * wpa_supplicant/hostapd control interface library 3 * Copyright (c) 2004-2017, 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 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 /** Retransmit the previous request packet */ 54 #define WPA_EVENT_EAP_RETRANSMIT "CTRL-EVENT-EAP-RETRANSMIT " 55 #define WPA_EVENT_EAP_RETRANSMIT2 "CTRL-EVENT-EAP-RETRANSMIT2 " 56 /** EAP authentication completed successfully */ 57 #define WPA_EVENT_EAP_SUCCESS "CTRL-EVENT-EAP-SUCCESS " 58 #define WPA_EVENT_EAP_SUCCESS2 "CTRL-EVENT-EAP-SUCCESS2 " 59 /** EAP authentication failed (EAP-Failure received) */ 60 #define WPA_EVENT_EAP_FAILURE "CTRL-EVENT-EAP-FAILURE " 61 #define WPA_EVENT_EAP_FAILURE2 "CTRL-EVENT-EAP-FAILURE2 " 62 /** EAP authentication failed due to no response received */ 63 #define WPA_EVENT_EAP_TIMEOUT_FAILURE "CTRL-EVENT-EAP-TIMEOUT-FAILURE " 64 #define WPA_EVENT_EAP_TIMEOUT_FAILURE2 "CTRL-EVENT-EAP-TIMEOUT-FAILURE2 " 65 #define WPA_EVENT_EAP_ERROR_CODE "EAP-ERROR-CODE " 66 /** Network block temporarily disabled (e.g., due to authentication failure) */ 67 #define WPA_EVENT_TEMP_DISABLED "CTRL-EVENT-SSID-TEMP-DISABLED " 68 /** Temporarily disabled network block re-enabled */ 69 #define WPA_EVENT_REENABLED "CTRL-EVENT-SSID-REENABLED " 70 /** New scan started */ 71 #define WPA_EVENT_SCAN_STARTED "CTRL-EVENT-SCAN-STARTED " 72 /** New scan results available */ 73 #define WPA_EVENT_SCAN_RESULTS "CTRL-EVENT-SCAN-RESULTS " 74 /** Scan command failed */ 75 #define WPA_EVENT_SCAN_FAILED "CTRL-EVENT-SCAN-FAILED " 76 /** wpa_supplicant state change */ 77 #define WPA_EVENT_STATE_CHANGE "CTRL-EVENT-STATE-CHANGE " 78 /** A new BSS entry was added (followed by BSS entry id and BSSID) */ 79 #define WPA_EVENT_BSS_ADDED "CTRL-EVENT-BSS-ADDED " 80 /** A BSS entry was removed (followed by BSS entry id and BSSID) */ 81 #define WPA_EVENT_BSS_REMOVED "CTRL-EVENT-BSS-REMOVED " 82 /** No suitable network was found */ 83 #define WPA_EVENT_NETWORK_NOT_FOUND "CTRL-EVENT-NETWORK-NOT-FOUND " 84 /** Change in the signal level was reported by the driver */ 85 #define WPA_EVENT_SIGNAL_CHANGE "CTRL-EVENT-SIGNAL-CHANGE " 86 /** Beacon loss reported by the driver */ 87 #define WPA_EVENT_BEACON_LOSS "CTRL-EVENT-BEACON-LOSS " 88 /** Regulatory domain channel */ 89 #define WPA_EVENT_REGDOM_CHANGE "CTRL-EVENT-REGDOM-CHANGE " 90 /** Channel switch started (followed by freq=<MHz> and other channel parameters) 91 */ 92 #define WPA_EVENT_CHANNEL_SWITCH_STARTED "CTRL-EVENT-STARTED-CHANNEL-SWITCH " 93 /** Channel switch (followed by freq=<MHz> and other channel parameters) */ 94 #define WPA_EVENT_CHANNEL_SWITCH "CTRL-EVENT-CHANNEL-SWITCH " 95 /** MLO link channel switch started (followed by freq=<MHz> and other channel 96 * parameters) 97 */ 98 #define WPA_EVENT_LINK_CHANNEL_SWITCH_STARTED \ 99 "CTRL-EVENT-STARTED-LINK-CHANNEL-SWITCH " 100 /** MLO link channel switch (followed by freq=<MHz> and other channel 101 * parameters) 102 */ 103 #define WPA_EVENT_LINK_CHANNEL_SWITCH "CTRL-EVENT-LINK-CHANNEL-SWITCH " 104 /** SAE authentication failed due to unknown password identifier */ 105 #define WPA_EVENT_SAE_UNKNOWN_PASSWORD_IDENTIFIER \ 106 "CTRL-EVENT-SAE-UNKNOWN-PASSWORD-IDENTIFIER " 107 /** Unprotected Beacon frame dropped */ 108 #define WPA_EVENT_UNPROT_BEACON "CTRL-EVENT-UNPROT-BEACON " 109 /** Decision made to do a within-ESS roam */ 110 #define WPA_EVENT_DO_ROAM "CTRL-EVENT-DO-ROAM " 111 /** Decision made to skip a within-ESS roam */ 112 #define WPA_EVENT_SKIP_ROAM "CTRL-EVENT-SKIP-ROAM " 113 /** TID-to-link mapping response event */ 114 #define WPA_EVENT_T2LM_UPDATE "CTRL-EVENT-T2LM-UPDATE " 115 /** MLO link reconfiguration event */ 116 #define WPA_EVENT_LINK_RECONFIG "CTRL-EVENT-LINK-RECONFIG " 117 118 /** IP subnet status change notification 119 * 120 * When using an offloaded roaming mechanism where driver/firmware takes care 121 * of roaming and IP subnet validation checks post-roaming, this event can 122 * indicate whether IP subnet has changed. 123 * 124 * The event has a status=<0/1/2> parameter where 125 * 0 = unknown 126 * 1 = IP subnet unchanged (can continue to use the old IP address) 127 * 2 = IP subnet changed (need to get a new IP address) 128 */ 129 #define WPA_EVENT_SUBNET_STATUS_UPDATE "CTRL-EVENT-SUBNET-STATUS-UPDATE " 130 131 /** RSN IBSS 4-way handshakes completed with specified peer */ 132 #define IBSS_RSN_COMPLETED "IBSS-RSN-COMPLETED " 133 134 /** Notification of frequency conflict due to a concurrent operation. 135 * 136 * The indicated network is disabled and needs to be re-enabled before it can 137 * be used again. 138 */ 139 #define WPA_EVENT_FREQ_CONFLICT "CTRL-EVENT-FREQ-CONFLICT " 140 /** Frequency ranges that the driver recommends to avoid */ 141 #define WPA_EVENT_AVOID_FREQ "CTRL-EVENT-AVOID-FREQ " 142 /** A new network profile was added (followed by network entry id) */ 143 #define WPA_EVENT_NETWORK_ADDED "CTRL-EVENT-NETWORK-ADDED " 144 /** A network profile was removed (followed by prior network entry id) */ 145 #define WPA_EVENT_NETWORK_REMOVED "CTRL-EVENT-NETWORK-REMOVED " 146 /** Result of MSCS setup */ 147 #define WPA_EVENT_MSCS_RESULT "CTRL-EVENT-MSCS-RESULT " 148 /** WPS overlap detected in PBC mode */ 149 #define WPS_EVENT_OVERLAP "WPS-OVERLAP-DETECTED " 150 /** Available WPS AP with active PBC found in scan results */ 151 #define WPS_EVENT_AP_AVAILABLE_PBC "WPS-AP-AVAILABLE-PBC " 152 /** Available WPS AP with our address as authorized in scan results */ 153 #define WPS_EVENT_AP_AVAILABLE_AUTH "WPS-AP-AVAILABLE-AUTH " 154 /** Available WPS AP with recently selected PIN registrar found in scan results 155 */ 156 #define WPS_EVENT_AP_AVAILABLE_PIN "WPS-AP-AVAILABLE-PIN " 157 /** Available WPS AP found in scan results */ 158 #define WPS_EVENT_AP_AVAILABLE "WPS-AP-AVAILABLE " 159 /** A new credential received */ 160 #define WPS_EVENT_CRED_RECEIVED "WPS-CRED-RECEIVED " 161 /** M2D received */ 162 #define WPS_EVENT_M2D "WPS-M2D " 163 /** WPS registration failed after M2/M2D */ 164 #define WPS_EVENT_FAIL "WPS-FAIL " 165 /** WPS registration completed successfully */ 166 #define WPS_EVENT_SUCCESS "WPS-SUCCESS " 167 /** WPS enrollment attempt timed out and was terminated */ 168 #define WPS_EVENT_TIMEOUT "WPS-TIMEOUT " 169 /* PBC mode was activated */ 170 #define WPS_EVENT_ACTIVE "WPS-PBC-ACTIVE " 171 /* PBC mode was disabled */ 172 #define WPS_EVENT_DISABLE "WPS-PBC-DISABLE " 173 174 #define WPS_EVENT_ENROLLEE_SEEN "WPS-ENROLLEE-SEEN " 175 176 #define WPS_EVENT_OPEN_NETWORK "WPS-OPEN-NETWORK " 177 /** Result of SCS setup */ 178 #define WPA_EVENT_SCS_RESULT "CTRL-EVENT-SCS-RESULT " 179 /* Event indicating DSCP policy */ 180 #define WPA_EVENT_DSCP_POLICY "CTRL-EVENT-DSCP-POLICY " 181 182 /* WPS ER events */ 183 #define WPS_EVENT_ER_AP_ADD "WPS-ER-AP-ADD " 184 #define WPS_EVENT_ER_AP_REMOVE "WPS-ER-AP-REMOVE " 185 #define WPS_EVENT_ER_ENROLLEE_ADD "WPS-ER-ENROLLEE-ADD " 186 #define WPS_EVENT_ER_ENROLLEE_REMOVE "WPS-ER-ENROLLEE-REMOVE " 187 #define WPS_EVENT_ER_AP_SETTINGS "WPS-ER-AP-SETTINGS " 188 #define WPS_EVENT_ER_SET_SEL_REG "WPS-ER-AP-SET-SEL-REG " 189 190 /* DPP events */ 191 #define DPP_EVENT_AUTH_SUCCESS "DPP-AUTH-SUCCESS " 192 #define DPP_EVENT_AUTH_INIT_FAILED "DPP-AUTH-INIT-FAILED " 193 #define DPP_EVENT_NOT_COMPATIBLE "DPP-NOT-COMPATIBLE " 194 #define DPP_EVENT_RESPONSE_PENDING "DPP-RESPONSE-PENDING " 195 #define DPP_EVENT_SCAN_PEER_QR_CODE "DPP-SCAN-PEER-QR-CODE " 196 #define DPP_EVENT_AUTH_DIRECTION "DPP-AUTH-DIRECTION " 197 #define DPP_EVENT_CONF_RECEIVED "DPP-CONF-RECEIVED " 198 #define DPP_EVENT_CONF_SENT "DPP-CONF-SENT " 199 #define DPP_EVENT_CONF_FAILED "DPP-CONF-FAILED " 200 #define DPP_EVENT_CONN_STATUS_RESULT "DPP-CONN-STATUS-RESULT " 201 #define DPP_EVENT_CONFOBJ_AKM "DPP-CONFOBJ-AKM " 202 #define DPP_EVENT_CONFOBJ_SSID "DPP-CONFOBJ-SSID " 203 #define DPP_EVENT_CONFOBJ_SSID_CHARSET "DPP-CONFOBJ-SSID-CHARSET " 204 #define DPP_EVENT_CONFOBJ_PASS "DPP-CONFOBJ-PASS " 205 #define DPP_EVENT_CONFOBJ_PSK "DPP-CONFOBJ-PSK " 206 #define DPP_EVENT_CONNECTOR "DPP-CONNECTOR " 207 #define DPP_EVENT_C_SIGN_KEY "DPP-C-SIGN-KEY " 208 #define DPP_EVENT_PP_KEY "DPP-PP-KEY " 209 #define DPP_EVENT_NET_ACCESS_KEY "DPP-NET-ACCESS-KEY " 210 #define DPP_EVENT_SERVER_NAME "DPP-SERVER-NAME " 211 #define DPP_EVENT_CERTBAG "DPP-CERTBAG " 212 #define DPP_EVENT_CACERT "DPP-CACERT " 213 #define DPP_EVENT_MISSING_CONNECTOR "DPP-MISSING-CONNECTOR " 214 #define DPP_EVENT_NETWORK_ID "DPP-NETWORK-ID " 215 #define DPP_EVENT_CONFIGURATOR_ID "DPP-CONFIGURATOR-ID " 216 #define DPP_EVENT_RX "DPP-RX " 217 #define DPP_EVENT_TX "DPP-TX " 218 #define DPP_EVENT_TX_STATUS "DPP-TX-STATUS " 219 #define DPP_EVENT_FAIL "DPP-FAIL " 220 #define DPP_EVENT_PKEX_T_LIMIT "DPP-PKEX-T-LIMIT " 221 #define DPP_EVENT_INTRO "DPP-INTRO " 222 #define DPP_EVENT_CONF_REQ_RX "DPP-CONF-REQ-RX " 223 #define DPP_EVENT_CHIRP_STOPPED "DPP-CHIRP-STOPPED " 224 #define DPP_EVENT_MUD_URL "DPP-MUD-URL " 225 #define DPP_EVENT_BAND_SUPPORT "DPP-BAND-SUPPORT " 226 #define DPP_EVENT_CSR "DPP-CSR " 227 #define DPP_EVENT_CHIRP_RX "DPP-CHIRP-RX " 228 #define DPP_EVENT_CONF_NEEDED "DPP-CONF-NEEDED " 229 #define DPP_EVENT_PB_STATUS "DPP-PB-STATUS " 230 #define DPP_EVENT_PB_RESULT "DPP-PB-RESULT " 231 #define DPP_EVENT_RELAY_NEEDS_CONTROLLER "DPP-RELAY-NEEDS-CONTROLLER " 232 233 /* MESH events */ 234 #define MESH_GROUP_STARTED "MESH-GROUP-STARTED " 235 #define MESH_GROUP_REMOVED "MESH-GROUP-REMOVED " 236 #define MESH_PEER_CONNECTED "MESH-PEER-CONNECTED " 237 #define MESH_PEER_DISCONNECTED "MESH-PEER-DISCONNECTED " 238 /** Mesh SAE authentication failure. Wrong password suspected. */ 239 #define MESH_SAE_AUTH_FAILURE "MESH-SAE-AUTH-FAILURE " 240 #define MESH_SAE_AUTH_BLOCKED "MESH-SAE-AUTH-BLOCKED " 241 242 /* WMM AC events */ 243 #define WMM_AC_EVENT_TSPEC_ADDED "TSPEC-ADDED " 244 #define WMM_AC_EVENT_TSPEC_REMOVED "TSPEC-REMOVED " 245 #define WMM_AC_EVENT_TSPEC_REQ_FAILED "TSPEC-REQ-FAILED " 246 247 /** P2P device found */ 248 #define P2P_EVENT_DEVICE_FOUND "P2P-DEVICE-FOUND " 249 250 /** P2P device lost */ 251 #define P2P_EVENT_DEVICE_LOST "P2P-DEVICE-LOST " 252 253 /** A P2P device requested GO negotiation, but we were not ready to start the 254 * negotiation */ 255 #define P2P_EVENT_GO_NEG_REQUEST "P2P-GO-NEG-REQUEST " 256 #define P2P_EVENT_GO_NEG_SUCCESS "P2P-GO-NEG-SUCCESS " 257 #define P2P_EVENT_GO_NEG_FAILURE "P2P-GO-NEG-FAILURE " 258 #define P2P_EVENT_GROUP_FORMATION_SUCCESS "P2P-GROUP-FORMATION-SUCCESS " 259 #define P2P_EVENT_GROUP_FORMATION_FAILURE "P2P-GROUP-FORMATION-FAILURE " 260 #define P2P_EVENT_GROUP_STARTED "P2P-GROUP-STARTED " 261 #define P2P_EVENT_GROUP_REMOVED "P2P-GROUP-REMOVED " 262 #define P2P_EVENT_CROSS_CONNECT_ENABLE "P2P-CROSS-CONNECT-ENABLE " 263 #define P2P_EVENT_CROSS_CONNECT_DISABLE "P2P-CROSS-CONNECT-DISABLE " 264 /* parameters: <peer address> <PIN> */ 265 #define P2P_EVENT_PROV_DISC_SHOW_PIN "P2P-PROV-DISC-SHOW-PIN " 266 /* parameters: <peer address> */ 267 #define P2P_EVENT_PROV_DISC_ENTER_PIN "P2P-PROV-DISC-ENTER-PIN " 268 /* parameters: <peer address> */ 269 #define P2P_EVENT_PROV_DISC_PBC_REQ "P2P-PROV-DISC-PBC-REQ " 270 /* parameters: <peer address> */ 271 #define P2P_EVENT_PROV_DISC_PBC_RESP "P2P-PROV-DISC-PBC-RESP " 272 /* parameters: <peer address> <status> */ 273 #define P2P_EVENT_PROV_DISC_FAILURE "P2P-PROV-DISC-FAILURE" 274 /* parameters: <freq> <src addr> <dialog token> <update indicator> <TLVs> */ 275 #define P2P_EVENT_SERV_DISC_REQ "P2P-SERV-DISC-REQ " 276 /* parameters: <src addr> <update indicator> <TLVs> */ 277 #define P2P_EVENT_SERV_DISC_RESP "P2P-SERV-DISC-RESP " 278 #define P2P_EVENT_SERV_ASP_RESP "P2P-SERV-ASP-RESP " 279 #define P2P_EVENT_INVITATION_RECEIVED "P2P-INVITATION-RECEIVED " 280 #define P2P_EVENT_INVITATION_RESULT "P2P-INVITATION-RESULT " 281 #define P2P_EVENT_INVITATION_ACCEPTED "P2P-INVITATION-ACCEPTED " 282 #define P2P_EVENT_FIND_STOPPED "P2P-FIND-STOPPED " 283 #define P2P_EVENT_PERSISTENT_PSK_FAIL "P2P-PERSISTENT-PSK-FAIL id=" 284 #define P2P_EVENT_PRESENCE_RESPONSE "P2P-PRESENCE-RESPONSE " 285 #define P2P_EVENT_NFC_BOTH_GO "P2P-NFC-BOTH-GO " 286 #define P2P_EVENT_NFC_PEER_CLIENT "P2P-NFC-PEER-CLIENT " 287 #define P2P_EVENT_NFC_WHILE_CLIENT "P2P-NFC-WHILE-CLIENT " 288 #define P2P_EVENT_FALLBACK_TO_GO_NEG "P2P-FALLBACK-TO-GO-NEG " 289 #define P2P_EVENT_FALLBACK_TO_GO_NEG_ENABLED "P2P-FALLBACK-TO-GO-NEG-ENABLED " 290 291 /* parameters: <PMF enabled> <timeout in ms> <Session Information URL> */ 292 #define ESS_DISASSOC_IMMINENT "ESS-DISASSOC-IMMINENT " 293 #define P2P_EVENT_REMOVE_AND_REFORM_GROUP "P2P-REMOVE-AND-REFORM-GROUP " 294 295 #define P2P_EVENT_P2PS_PROVISION_START "P2PS-PROV-START " 296 #define P2P_EVENT_P2PS_PROVISION_DONE "P2PS-PROV-DONE " 297 298 #define INTERWORKING_AP "INTERWORKING-AP " 299 #define INTERWORKING_EXCLUDED "INTERWORKING-BLACKLISTED " 300 #define INTERWORKING_NO_MATCH "INTERWORKING-NO-MATCH " 301 #define INTERWORKING_ALREADY_CONNECTED "INTERWORKING-ALREADY-CONNECTED " 302 #define INTERWORKING_SELECTED "INTERWORKING-SELECTED " 303 304 /* Credential block added; parameters: <id> */ 305 #define CRED_ADDED "CRED-ADDED " 306 /* Credential block modified; parameters: <id> <field> */ 307 #define CRED_MODIFIED "CRED-MODIFIED " 308 /* Credential block removed; parameters: <id> */ 309 #define CRED_REMOVED "CRED-REMOVED " 310 311 #define GAS_RESPONSE_INFO "GAS-RESPONSE-INFO " 312 /* parameters: <addr> <dialog_token> <freq> */ 313 #define GAS_QUERY_START "GAS-QUERY-START " 314 /* parameters: <addr> <dialog_token> <freq> <status_code> <result> */ 315 #define GAS_QUERY_DONE "GAS-QUERY-DONE " 316 317 /* parameters: <addr> <result> */ 318 #define ANQP_QUERY_DONE "ANQP-QUERY-DONE " 319 320 #define RX_ANQP "RX-ANQP " 321 #define RX_HS20_ANQP "RX-HS20-ANQP " 322 #define RX_HS20_ANQP_ICON "RX-HS20-ANQP-ICON " 323 #define RX_HS20_ICON "RX-HS20-ICON " 324 #define RX_MBO_ANQP "RX-MBO-ANQP " 325 326 /* parameters: <Venue Number> <Venue URL> */ 327 #define RX_VENUE_URL "RX-VENUE-URL " 328 329 #define HS20_SUBSCRIPTION_REMEDIATION "HS20-SUBSCRIPTION-REMEDIATION " 330 #define HS20_DEAUTH_IMMINENT_NOTICE "HS20-DEAUTH-IMMINENT-NOTICE " 331 #define HS20_T_C_ACCEPTANCE "HS20-T-C-ACCEPTANCE " 332 333 #define EXT_RADIO_WORK_START "EXT-RADIO-WORK-START " 334 #define EXT_RADIO_WORK_TIMEOUT "EXT-RADIO-WORK-TIMEOUT " 335 336 #define RRM_EVENT_NEIGHBOR_REP_RXED "RRM-NEIGHBOR-REP-RECEIVED " 337 #define RRM_EVENT_NEIGHBOR_REP_FAILED "RRM-NEIGHBOR-REP-REQUEST-FAILED " 338 339 /* hostapd control interface - fixed message prefixes */ 340 #define WPS_EVENT_PIN_NEEDED "WPS-PIN-NEEDED " 341 #define WPS_EVENT_NEW_AP_SETTINGS "WPS-NEW-AP-SETTINGS " 342 #define WPS_EVENT_REG_SUCCESS "WPS-REG-SUCCESS " 343 #define WPS_EVENT_AP_SETUP_LOCKED "WPS-AP-SETUP-LOCKED " 344 #define WPS_EVENT_AP_SETUP_UNLOCKED "WPS-AP-SETUP-UNLOCKED " 345 #define WPS_EVENT_AP_PIN_ENABLED "WPS-AP-PIN-ENABLED " 346 #define WPS_EVENT_AP_PIN_DISABLED "WPS-AP-PIN-DISABLED " 347 #define WPS_EVENT_PIN_ACTIVE "WPS-PIN-ACTIVE " 348 #define WPS_EVENT_CANCEL "WPS-CANCEL " 349 #define AP_STA_CONNECTED "AP-STA-CONNECTED " 350 #define AP_STA_DISCONNECTED "AP-STA-DISCONNECTED " 351 #define AP_STA_POSSIBLE_PSK_MISMATCH "AP-STA-POSSIBLE-PSK-MISMATCH " 352 #define AP_STA_POLL_OK "AP-STA-POLL-OK " 353 354 #define AP_REJECTED_MAX_STA "AP-REJECTED-MAX-STA " 355 #define AP_REJECTED_BLOCKED_STA "AP-REJECTED-BLOCKED-STA " 356 357 #define HS20_T_C_FILTERING_ADD "HS20-T-C-FILTERING-ADD " 358 #define HS20_T_C_FILTERING_REMOVE "HS20-T-C-FILTERING-REMOVE " 359 360 #define AP_EVENT_ENABLED "AP-ENABLED " 361 #define AP_EVENT_DISABLED "AP-DISABLED " 362 363 #define INTERFACE_ENABLED "INTERFACE-ENABLED " 364 #define INTERFACE_DISABLED "INTERFACE-DISABLED " 365 366 #define ACS_EVENT_STARTED "ACS-STARTED " 367 #define ACS_EVENT_COMPLETED "ACS-COMPLETED " 368 #define ACS_EVENT_FAILED "ACS-FAILED " 369 370 #define DFS_EVENT_RADAR_DETECTED "DFS-RADAR-DETECTED " 371 #define DFS_EVENT_NEW_CHANNEL "DFS-NEW-CHANNEL " 372 #define DFS_EVENT_CAC_START "DFS-CAC-START " 373 #define DFS_EVENT_CAC_COMPLETED "DFS-CAC-COMPLETED " 374 #define DFS_EVENT_NOP_FINISHED "DFS-NOP-FINISHED " 375 #define DFS_EVENT_PRE_CAC_EXPIRED "DFS-PRE-CAC-EXPIRED " 376 377 #define AP_CSA_FINISHED "AP-CSA-FINISHED " 378 379 #define P2P_EVENT_LISTEN_OFFLOAD_STOP "P2P-LISTEN-OFFLOAD-STOPPED " 380 #define P2P_LISTEN_OFFLOAD_STOP_REASON "P2P-LISTEN-OFFLOAD-STOP-REASON " 381 382 /* BSS Transition Management Query frame received */ 383 #define BSS_TM_QUERY "BSS-TM-QUERY " 384 385 /* BSS Transition Management Response frame received */ 386 #define BSS_TM_RESP "BSS-TM-RESP " 387 388 /* Collocated Interference Request frame received; 389 * parameters: <dialog token> <automatic report enabled> <report timeout> */ 390 #define COLOC_INTF_REQ "COLOC-INTF-REQ " 391 /* Collocated Interference Report frame received; 392 * parameters: <STA address> <dialog token> <hexdump of report elements> */ 393 #define COLOC_INTF_REPORT "COLOC-INTF-REPORT " 394 395 /* MBO IE with cellular data connection preference received */ 396 #define MBO_CELL_PREFERENCE "MBO-CELL-PREFERENCE " 397 398 /* BSS Transition Management Request received with MBO transition reason */ 399 #define MBO_TRANSITION_REASON "MBO-TRANSITION-REASON " 400 401 /* parameters: <STA address> <dialog token> <ack=0/1> */ 402 #define BEACON_REQ_TX_STATUS "BEACON-REQ-TX-STATUS " 403 /* parameters: <STA address> <dialog token> <report mode> <beacon report> */ 404 #define BEACON_RESP_RX "BEACON-RESP-RX " 405 406 /* PMKSA cache entry added; parameters: <BSSID> <network_id> */ 407 #define PMKSA_CACHE_ADDED "PMKSA-CACHE-ADDED " 408 /* PMKSA cache entry removed; parameters: <BSSID> <network_id> */ 409 #define PMKSA_CACHE_REMOVED "PMKSA-CACHE-REMOVED " 410 411 /* FILS HLP Container receive; parameters: dst=<addr> src=<addr> frame=<hexdump> 412 */ 413 #define FILS_HLP_RX "FILS-HLP-RX " 414 415 /* Event to indicate Probe Request frame; 416 * parameters: sa=<STA MAC address> signal=<signal> */ 417 #define RX_PROBE_REQUEST "RX-PROBE-REQUEST " 418 419 /* Event to indicate station's HT/VHT operation mode change information */ 420 #define STA_OPMODE_MAX_BW_CHANGED "STA-OPMODE-MAX-BW-CHANGED " 421 #define STA_OPMODE_SMPS_MODE_CHANGED "STA-OPMODE-SMPS-MODE-CHANGED " 422 #define STA_OPMODE_N_SS_CHANGED "STA-OPMODE-N_SS-CHANGED " 423 424 /* New interface addition or removal for 4addr WDS SDA */ 425 #define WDS_STA_INTERFACE_ADDED "WDS-STA-INTERFACE-ADDED " 426 #define WDS_STA_INTERFACE_REMOVED "WDS-STA-INTERFACE-REMOVED " 427 428 /* Transition mode disabled indication - followed by bitmap */ 429 #define TRANSITION_DISABLE "TRANSITION-DISABLE " 430 431 /* OCV validation failure; parameters: addr=<src addr> 432 * frame=<saqueryreq/saqueryresp> error=<error string> */ 433 #define OCV_FAILURE "OCV-FAILURE " 434 435 /* Event triggered for received management frame */ 436 #define AP_MGMT_FRAME_RECEIVED "AP-MGMT-FRAME-RECEIVED " 437 438 #ifndef BIT 439 #define BIT(x) (1U << (x)) 440 #endif 441 442 /* PASN authentication status */ 443 #define PASN_AUTH_STATUS "PASN-AUTH-STATUS " 444 445 /* BSS command information masks */ 446 447 #define WPA_BSS_MASK_ALL 0xFFFDFFFF 448 #define WPA_BSS_MASK_ID BIT(0) 449 #define WPA_BSS_MASK_BSSID BIT(1) 450 #define WPA_BSS_MASK_FREQ BIT(2) 451 #define WPA_BSS_MASK_BEACON_INT BIT(3) 452 #define WPA_BSS_MASK_CAPABILITIES BIT(4) 453 #define WPA_BSS_MASK_QUAL BIT(5) 454 #define WPA_BSS_MASK_NOISE BIT(6) 455 #define WPA_BSS_MASK_LEVEL BIT(7) 456 #define WPA_BSS_MASK_TSF BIT(8) 457 #define WPA_BSS_MASK_AGE BIT(9) 458 #define WPA_BSS_MASK_IE BIT(10) 459 #define WPA_BSS_MASK_FLAGS BIT(11) 460 #define WPA_BSS_MASK_SSID BIT(12) 461 #define WPA_BSS_MASK_WPS_SCAN BIT(13) 462 #define WPA_BSS_MASK_P2P_SCAN BIT(14) 463 #define WPA_BSS_MASK_INTERNETW BIT(15) 464 #define WPA_BSS_MASK_WIFI_DISPLAY BIT(16) 465 #define WPA_BSS_MASK_DELIM BIT(17) 466 #define WPA_BSS_MASK_MESH_SCAN BIT(18) 467 #define WPA_BSS_MASK_SNR BIT(19) 468 #define WPA_BSS_MASK_EST_THROUGHPUT BIT(20) 469 #define WPA_BSS_MASK_FST BIT(21) 470 #define WPA_BSS_MASK_UPDATE_IDX BIT(22) 471 #define WPA_BSS_MASK_BEACON_IE BIT(23) 472 #define WPA_BSS_MASK_FILS_INDICATION BIT(24) 473 #define WPA_BSS_MASK_RNR BIT(25) 474 #define WPA_BSS_MASK_ML BIT(26) 475 476 477 /* VENDOR_ELEM_* frame id values */ 478 enum wpa_vendor_elem_frame { 479 VENDOR_ELEM_PROBE_REQ_P2P = 0, 480 VENDOR_ELEM_PROBE_RESP_P2P = 1, 481 VENDOR_ELEM_PROBE_RESP_P2P_GO = 2, 482 VENDOR_ELEM_BEACON_P2P_GO = 3, 483 VENDOR_ELEM_P2P_PD_REQ = 4, 484 VENDOR_ELEM_P2P_PD_RESP = 5, 485 VENDOR_ELEM_P2P_GO_NEG_REQ = 6, 486 VENDOR_ELEM_P2P_GO_NEG_RESP = 7, 487 VENDOR_ELEM_P2P_GO_NEG_CONF = 8, 488 VENDOR_ELEM_P2P_INV_REQ = 9, 489 VENDOR_ELEM_P2P_INV_RESP = 10, 490 VENDOR_ELEM_P2P_ASSOC_REQ = 11, 491 VENDOR_ELEM_P2P_ASSOC_RESP = 12, 492 VENDOR_ELEM_ASSOC_REQ = 13, 493 VENDOR_ELEM_PROBE_REQ = 14, 494 NUM_VENDOR_ELEM_FRAMES 495 }; 496 497 498 /* wpa_supplicant/hostapd control interface access */ 499 500 /** 501 * wpa_ctrl_open - Open a control interface to wpa_supplicant/hostapd 502 * @ctrl_path: Path for UNIX domain sockets; ignored if UDP sockets are used. 503 * Returns: Pointer to abstract control interface data or %NULL on failure 504 * 505 * This function is used to open a control interface to wpa_supplicant/hostapd. 506 * ctrl_path is usually /var/run/wpa_supplicant or /var/run/hostapd. This path 507 * is configured in wpa_supplicant/hostapd and other programs using the control 508 * interface need to use matching path configuration. 509 */ 510 struct wpa_ctrl * wpa_ctrl_open(const char *ctrl_path); 511 512 /** 513 * wpa_ctrl_open2 - Open a control interface to wpa_supplicant/hostapd 514 * @ctrl_path: Path for UNIX domain sockets; ignored if UDP sockets are used. 515 * @cli_path: Path for client UNIX domain sockets; ignored if UDP socket 516 * is used. 517 * Returns: Pointer to abstract control interface data or %NULL on failure 518 * 519 * This function is used to open a control interface to wpa_supplicant/hostapd 520 * when the socket path for client need to be specified explicitly. Default 521 * ctrl_path is usually /var/run/wpa_supplicant or /var/run/hostapd and client 522 * socket path is /tmp. 523 */ 524 struct wpa_ctrl * wpa_ctrl_open2(const char *ctrl_path, const char *cli_path); 525 526 527 /** 528 * wpa_ctrl_close - Close a control interface to wpa_supplicant/hostapd 529 * @ctrl: Control interface data from wpa_ctrl_open() 530 * 531 * This function is used to close a control interface. 532 */ 533 void wpa_ctrl_close(struct wpa_ctrl *ctrl); 534 535 536 /** 537 * wpa_ctrl_request - Send a command to wpa_supplicant/hostapd 538 * @ctrl: Control interface data from wpa_ctrl_open() 539 * @cmd: Command; usually, ASCII text, e.g., "PING" 540 * @cmd_len: Length of the cmd in bytes 541 * @reply: Buffer for the response 542 * @reply_len: Reply buffer length 543 * @msg_cb: Callback function for unsolicited messages or %NULL if not used 544 * Returns: 0 on success, -1 on error (send or receive failed), -2 on timeout 545 * 546 * This function is used to send commands to wpa_supplicant/hostapd. Received 547 * response will be written to reply and reply_len is set to the actual length 548 * of the reply. This function will block for up to 10 seconds while waiting 549 * for the reply. If unsolicited messages are received, the blocking time may 550 * be longer. 551 * 552 * msg_cb can be used to register a callback function that will be called for 553 * unsolicited messages received while waiting for the command response. These 554 * messages may be received if wpa_ctrl_request() is called at the same time as 555 * wpa_supplicant/hostapd is sending such a message. This can happen only if 556 * the program has used wpa_ctrl_attach() to register itself as a monitor for 557 * event messages. Alternatively to msg_cb, programs can register two control 558 * interface connections and use one of them for commands and the other one for 559 * receiving event messages, in other words, call wpa_ctrl_attach() only for 560 * the control interface connection that will be used for event messages. 561 */ 562 int wpa_ctrl_request(struct wpa_ctrl *ctrl, const char *cmd, size_t cmd_len, 563 char *reply, size_t *reply_len, 564 void (*msg_cb)(char *msg, size_t len)); 565 566 567 /** 568 * wpa_ctrl_attach - Register as an event monitor for the control interface 569 * @ctrl: Control interface data from wpa_ctrl_open() 570 * Returns: 0 on success, -1 on failure, -2 on timeout 571 * 572 * This function registers the control interface connection as a monitor for 573 * wpa_supplicant/hostapd events. After a success wpa_ctrl_attach() call, the 574 * control interface connection starts receiving event messages that can be 575 * read with wpa_ctrl_recv(). 576 */ 577 int wpa_ctrl_attach(struct wpa_ctrl *ctrl); 578 579 580 /** 581 * wpa_ctrl_detach - Unregister event monitor from the control interface 582 * @ctrl: Control interface data from wpa_ctrl_open() 583 * Returns: 0 on success, -1 on failure, -2 on timeout 584 * 585 * This function unregisters the control interface connection as a monitor for 586 * wpa_supplicant/hostapd events, i.e., cancels the registration done with 587 * wpa_ctrl_attach(). 588 */ 589 int wpa_ctrl_detach(struct wpa_ctrl *ctrl); 590 591 592 /** 593 * wpa_ctrl_recv - Receive a pending control interface message 594 * @ctrl: Control interface data from wpa_ctrl_open() 595 * @reply: Buffer for the message data 596 * @reply_len: Length of the reply buffer 597 * Returns: 0 on success, -1 on failure 598 * 599 * This function will receive a pending control interface message. The received 600 * response will be written to reply and reply_len is set to the actual length 601 * of the reply. 602 603 * wpa_ctrl_recv() is only used for event messages, i.e., wpa_ctrl_attach() 604 * must have been used to register the control interface as an event monitor. 605 */ 606 int wpa_ctrl_recv(struct wpa_ctrl *ctrl, char *reply, size_t *reply_len); 607 608 609 /** 610 * wpa_ctrl_pending - Check whether there are pending event messages 611 * @ctrl: Control interface data from wpa_ctrl_open() 612 * Returns: 1 if there are pending messages, 0 if no, or -1 on error 613 * 614 * This function will check whether there are any pending control interface 615 * message available to be received with wpa_ctrl_recv(). wpa_ctrl_pending() is 616 * only used for event messages, i.e., wpa_ctrl_attach() must have been used to 617 * register the control interface as an event monitor. 618 */ 619 int wpa_ctrl_pending(struct wpa_ctrl *ctrl); 620 621 622 /** 623 * wpa_ctrl_get_fd - Get file descriptor used by the control interface 624 * @ctrl: Control interface data from wpa_ctrl_open() 625 * Returns: File descriptor used for the connection 626 * 627 * This function can be used to get the file descriptor that is used for the 628 * control interface connection. The returned value can be used, e.g., with 629 * select() while waiting for multiple events. 630 * 631 * The returned file descriptor must not be used directly for sending or 632 * receiving packets; instead, the library functions wpa_ctrl_request() and 633 * wpa_ctrl_recv() must be used for this. 634 */ 635 int wpa_ctrl_get_fd(struct wpa_ctrl *ctrl); 636 637 #ifdef ANDROID 638 /** 639 * wpa_ctrl_cleanup() - Delete any local UNIX domain socket files that 640 * may be left over from clients that were previously connected to 641 * wpa_supplicant. This keeps these files from being orphaned in the 642 * event of crashes that prevented them from being removed as part 643 * of the normal orderly shutdown. 644 */ 645 void wpa_ctrl_cleanup(void); 646 #endif /* ANDROID */ 647 648 #ifdef CONFIG_CTRL_IFACE_UDP 649 /* Port range for multiple wpa_supplicant instances and multiple VIFs */ 650 #define WPA_CTRL_IFACE_PORT 9877 651 #define WPA_CTRL_IFACE_PORT_LIMIT 50 /* decremented from start */ 652 #define WPA_GLOBAL_CTRL_IFACE_PORT 9878 653 #define WPA_GLOBAL_CTRL_IFACE_PORT_LIMIT 20 /* incremented from start */ 654 655 char * wpa_ctrl_get_remote_ifname(struct wpa_ctrl *ctrl); 656 #endif /* CONFIG_CTRL_IFACE_UDP */ 657 658 659 #ifdef __cplusplus 660 } 661 #endif 662 663 #endif /* WPA_CTRL_H */ 664