src/common/wpa_ctrl.h

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