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