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