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