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