]> git.ipfire.org Git - thirdparty/hostap.git/blame - src/common/wpa_ctrl.h
tests: DPP PKEX retry after incorrect PKEX code
[thirdparty/hostap.git] / src / common / wpa_ctrl.h
CommitLineData
6fc6879b
JM
1/*
2 * wpa_supplicant/hostapd control interface library
f3383366 3 * Copyright (c) 2004-2017, Jouni Malinen <j@w1.fi>
6fc6879b 4 *
0f3d578e
JM
5 * This software may be distributed under the terms of the BSD license.
6 * See README for more details.
6fc6879b
JM
7 */
8
9#ifndef WPA_CTRL_H
10#define WPA_CTRL_H
11
12#ifdef __cplusplus
13extern "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 "
ea78c315
JM
29/** Association rejected during connection attempt */
30#define WPA_EVENT_ASSOC_REJECT "CTRL-EVENT-ASSOC-REJECT "
ec4387f9
JM
31/** Authentication rejected during connection attempt */
32#define WPA_EVENT_AUTH_REJECT "CTRL-EVENT-AUTH-REJECT "
6fc6879b
JM
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 "
7796f20e
JM
41/** EAP method proposed by the server */
42#define WPA_EVENT_EAP_PROPOSED_METHOD "CTRL-EVENT-EAP-PROPOSED-METHOD "
6fc6879b
JM
43/** EAP method selected */
44#define WPA_EVENT_EAP_METHOD "CTRL-EVENT-EAP-METHOD "
00468b46
JM
45/** EAP peer certificate from TLS */
46#define WPA_EVENT_EAP_PEER_CERT "CTRL-EVENT-EAP-PEER-CERT "
d07d3fbd
JM
47/** EAP peer certificate alternative subject name component from TLS */
48#define WPA_EVENT_EAP_PEER_ALT "CTRL-EVENT-EAP-PEER-ALT "
00468b46
JM
49/** EAP TLS certificate chain validation error */
50#define WPA_EVENT_EAP_TLS_CERT_ERROR "CTRL-EVENT-EAP-TLS-CERT-ERROR "
c7a39ba4
CH
51/** EAP status */
52#define WPA_EVENT_EAP_STATUS "CTRL-EVENT-EAP-STATUS "
5f7c9e50
MB
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 "
6fc6879b
JM
56/** EAP authentication completed successfully */
57#define WPA_EVENT_EAP_SUCCESS "CTRL-EVENT-EAP-SUCCESS "
5f7c9e50 58#define WPA_EVENT_EAP_SUCCESS2 "CTRL-EVENT-EAP-SUCCESS2 "
6fc6879b
JM
59/** EAP authentication failed (EAP-Failure received) */
60#define WPA_EVENT_EAP_FAILURE "CTRL-EVENT-EAP-FAILURE "
5f7c9e50
MB
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 "
00e5e3d5
JM
65/** Network block temporarily disabled (e.g., due to authentication failure) */
66#define WPA_EVENT_TEMP_DISABLED "CTRL-EVENT-SSID-TEMP-DISABLED "
67/** Temporarily disabled network block re-enabled */
68#define WPA_EVENT_REENABLED "CTRL-EVENT-SSID-REENABLED "
a5f40eff
JM
69/** New scan started */
70#define WPA_EVENT_SCAN_STARTED "CTRL-EVENT-SCAN-STARTED "
6fc6879b
JM
71/** New scan results available */
72#define WPA_EVENT_SCAN_RESULTS "CTRL-EVENT-SCAN-RESULTS "
d1079219
DS
73/** Scan command failed */
74#define WPA_EVENT_SCAN_FAILED "CTRL-EVENT-SCAN-FAILED "
4e2ead7a
DS
75/** wpa_supplicant state change */
76#define WPA_EVENT_STATE_CHANGE "CTRL-EVENT-STATE-CHANGE "
b590812e 77/** A new BSS entry was added (followed by BSS entry id and BSSID) */
f0d126d3 78#define WPA_EVENT_BSS_ADDED "CTRL-EVENT-BSS-ADDED "
b590812e 79/** A BSS entry was removed (followed by BSS entry id and BSSID) */
f0d126d3 80#define WPA_EVENT_BSS_REMOVED "CTRL-EVENT-BSS-REMOVED "
4f39908b
DS
81/** No suitable network was found */
82#define WPA_EVENT_NETWORK_NOT_FOUND "CTRL-EVENT-NETWORK-NOT-FOUND "
0cd86028
JM
83/** Change in the signal level was reported by the driver */
84#define WPA_EVENT_SIGNAL_CHANGE "CTRL-EVENT-SIGNAL-CHANGE "
0f9b4a0f
JM
85/** Beacon loss reported by the driver */
86#define WPA_EVENT_BEACON_LOSS "CTRL-EVENT-BEACON-LOSS "
142817b2
JM
87/** Regulatory domain channel */
88#define WPA_EVENT_REGDOM_CHANGE "CTRL-EVENT-REGDOM-CHANGE "
37fd0be2
JM
89/** Channel switch (followed by freq=<MHz> and other channel parameters) */
90#define WPA_EVENT_CHANNEL_SWITCH "CTRL-EVENT-CHANNEL-SWITCH "
6fc6879b 91
f32227ed
RJ
92/** IP subnet status change notification
93 *
94 * When using an offloaded roaming mechanism where driver/firmware takes care
95 * of roaming and IP subnet validation checks post-roaming, this event can
96 * indicate whether IP subnet has changed.
97 *
98 * The event has a status=<0/1/2> parameter where
99 * 0 = unknown
100 * 1 = IP subnet unchanged (can continue to use the old IP address)
101 * 2 = IP subnet changed (need to get a new IP address)
102 */
103#define WPA_EVENT_SUBNET_STATUS_UPDATE "CTRL-EVENT-SUBNET-STATUS-UPDATE "
104
e743db43
JM
105/** RSN IBSS 4-way handshakes completed with specified peer */
106#define IBSS_RSN_COMPLETED "IBSS-RSN-COMPLETED "
107
8567866d
JJ
108/** Notification of frequency conflict due to a concurrent operation.
109 *
110 * The indicated network is disabled and needs to be re-enabled before it can
111 * be used again.
112 */
113#define WPA_EVENT_FREQ_CONFLICT "CTRL-EVENT-FREQ-CONFLICT "
253f2e37
AH
114/** Frequency ranges that the driver recommends to avoid */
115#define WPA_EVENT_AVOID_FREQ "CTRL-EVENT-AVOID-FREQ "
a524f05e 116/** WPS overlap detected in PBC mode */
ad08c363 117#define WPS_EVENT_OVERLAP "WPS-OVERLAP-DETECTED "
a524f05e
JM
118/** Available WPS AP with active PBC found in scan results */
119#define WPS_EVENT_AP_AVAILABLE_PBC "WPS-AP-AVAILABLE-PBC "
31fcea93
JM
120/** Available WPS AP with our address as authorized in scan results */
121#define WPS_EVENT_AP_AVAILABLE_AUTH "WPS-AP-AVAILABLE-AUTH "
a524f05e
JM
122/** Available WPS AP with recently selected PIN registrar found in scan results
123 */
124#define WPS_EVENT_AP_AVAILABLE_PIN "WPS-AP-AVAILABLE-PIN "
125/** Available WPS AP found in scan results */
126#define WPS_EVENT_AP_AVAILABLE "WPS-AP-AVAILABLE "
ff8a53a8
JM
127/** A new credential received */
128#define WPS_EVENT_CRED_RECEIVED "WPS-CRED-RECEIVED "
4b68290e
JM
129/** M2D received */
130#define WPS_EVENT_M2D "WPS-M2D "
469fc3a4
JM
131/** WPS registration failed after M2/M2D */
132#define WPS_EVENT_FAIL "WPS-FAIL "
ad5302a1
JM
133/** WPS registration completed successfully */
134#define WPS_EVENT_SUCCESS "WPS-SUCCESS "
a6099152
JM
135/** WPS enrollment attempt timed out and was terminated */
136#define WPS_EVENT_TIMEOUT "WPS-TIMEOUT "
50396e29
JM
137/* PBC mode was activated */
138#define WPS_EVENT_ACTIVE "WPS-PBC-ACTIVE "
139/* PBC mode was disabled */
140#define WPS_EVENT_DISABLE "WPS-PBC-DISABLE "
ad08c363 141
c2f51269
JM
142#define WPS_EVENT_ENROLLEE_SEEN "WPS-ENROLLEE-SEEN "
143
f981eabc
JM
144#define WPS_EVENT_OPEN_NETWORK "WPS-OPEN-NETWORK "
145
b78bc3a3
JM
146/* WPS ER events */
147#define WPS_EVENT_ER_AP_ADD "WPS-ER-AP-ADD "
148#define WPS_EVENT_ER_AP_REMOVE "WPS-ER-AP-REMOVE "
149#define WPS_EVENT_ER_ENROLLEE_ADD "WPS-ER-ENROLLEE-ADD "
150#define WPS_EVENT_ER_ENROLLEE_REMOVE "WPS-ER-ENROLLEE-REMOVE "
15dbf129 151#define WPS_EVENT_ER_AP_SETTINGS "WPS-ER-AP-SETTINGS "
3e7533b3 152#define WPS_EVENT_ER_SET_SEL_REG "WPS-ER-AP-SET-SEL-REG "
b78bc3a3 153
30d27b04
JM
154/* DPP events */
155#define DPP_EVENT_AUTH_SUCCESS "DPP-AUTH-SUCCESS "
156#define DPP_EVENT_NOT_COMPATIBLE "DPP-NOT-COMPATIBLE "
157#define DPP_EVENT_RESPONSE_PENDING "DPP-RESPONSE-PENDING "
158#define DPP_EVENT_SCAN_PEER_QR_CODE "DPP-SCAN-PEER-QR-CODE "
461d39af
JM
159#define DPP_EVENT_CONF_RECEIVED "DPP-CONF-RECEIVED "
160#define DPP_EVENT_CONF_SENT "DPP-CONF-SENT "
161#define DPP_EVENT_CONF_FAILED "DPP-CONF-FAILED "
162#define DPP_EVENT_CONFOBJ_SSID "DPP-CONFOBJ-SSID "
039ab15f
JM
163#define DPP_EVENT_CONFOBJ_PASS "DPP-CONFOBJ-PASS "
164#define DPP_EVENT_CONFOBJ_PSK "DPP-CONFOBJ-PSK "
461d39af
JM
165#define DPP_EVENT_CONNECTOR "DPP-CONNECTOR "
166#define DPP_EVENT_C_SIGN_KEY "DPP-C-SIGN-KEY "
167#define DPP_EVENT_NET_ACCESS_KEY "DPP-NET-ACCESS-KEY "
a0d5c56f 168#define DPP_EVENT_MISSING_CONNECTOR "DPP-MISSING-CONNECTOR "
8528994e 169#define DPP_EVENT_NETWORK_ID "DPP-NETWORK-ID "
a7073934 170#define DPP_EVENT_RX "DPP-RX "
af48810b
JM
171#define DPP_EVENT_TX "DPP-TX "
172#define DPP_EVENT_TX_STATUS "DPP-TX-STATUS "
3749ad0e 173#define DPP_EVENT_FAIL "DPP-FAIL "
e85b6601 174#define DPP_EVENT_INTRO "DPP-INTRO "
30d27b04 175
5f92659d 176/* MESH events */
603a3f34
JL
177#define MESH_GROUP_STARTED "MESH-GROUP-STARTED "
178#define MESH_GROUP_REMOVED "MESH-GROUP-REMOVED "
5f92659d
BC
179#define MESH_PEER_CONNECTED "MESH-PEER-CONNECTED "
180#define MESH_PEER_DISCONNECTED "MESH-PEER-DISCONNECTED "
dd2cbafc
MH
181/** Mesh SAE authentication failure. Wrong password suspected. */
182#define MESH_SAE_AUTH_FAILURE "MESH-SAE-AUTH-FAILURE "
79ddb206 183#define MESH_SAE_AUTH_BLOCKED "MESH-SAE-AUTH-BLOCKED "
5f92659d 184
d1f88001
MB
185/* WMM AC events */
186#define WMM_AC_EVENT_TSPEC_ADDED "TSPEC-ADDED "
187#define WMM_AC_EVENT_TSPEC_REMOVED "TSPEC-REMOVED "
188#define WMM_AC_EVENT_TSPEC_REQ_FAILED "TSPEC-REQ-FAILED "
189
b22128ef
JM
190/** P2P device found */
191#define P2P_EVENT_DEVICE_FOUND "P2P-DEVICE-FOUND "
3074d8f1
JJ
192
193/** P2P device lost */
194#define P2P_EVENT_DEVICE_LOST "P2P-DEVICE-LOST "
195
b22128ef
JM
196/** A P2P device requested GO negotiation, but we were not ready to start the
197 * negotiation */
198#define P2P_EVENT_GO_NEG_REQUEST "P2P-GO-NEG-REQUEST "
199#define P2P_EVENT_GO_NEG_SUCCESS "P2P-GO-NEG-SUCCESS "
200#define P2P_EVENT_GO_NEG_FAILURE "P2P-GO-NEG-FAILURE "
201#define P2P_EVENT_GROUP_FORMATION_SUCCESS "P2P-GROUP-FORMATION-SUCCESS "
202#define P2P_EVENT_GROUP_FORMATION_FAILURE "P2P-GROUP-FORMATION-FAILURE "
203#define P2P_EVENT_GROUP_STARTED "P2P-GROUP-STARTED "
204#define P2P_EVENT_GROUP_REMOVED "P2P-GROUP-REMOVED "
72044390
JM
205#define P2P_EVENT_CROSS_CONNECT_ENABLE "P2P-CROSS-CONNECT-ENABLE "
206#define P2P_EVENT_CROSS_CONNECT_DISABLE "P2P-CROSS-CONNECT-DISABLE "
b22128ef
JM
207/* parameters: <peer address> <PIN> */
208#define P2P_EVENT_PROV_DISC_SHOW_PIN "P2P-PROV-DISC-SHOW-PIN "
209/* parameters: <peer address> */
210#define P2P_EVENT_PROV_DISC_ENTER_PIN "P2P-PROV-DISC-ENTER-PIN "
211/* parameters: <peer address> */
212#define P2P_EVENT_PROV_DISC_PBC_REQ "P2P-PROV-DISC-PBC-REQ "
213/* parameters: <peer address> */
214#define P2P_EVENT_PROV_DISC_PBC_RESP "P2P-PROV-DISC-PBC-RESP "
f65a239b
DG
215/* parameters: <peer address> <status> */
216#define P2P_EVENT_PROV_DISC_FAILURE "P2P-PROV-DISC-FAILURE"
b22128ef
JM
217/* parameters: <freq> <src addr> <dialog token> <update indicator> <TLVs> */
218#define P2P_EVENT_SERV_DISC_REQ "P2P-SERV-DISC-REQ "
219/* parameters: <src addr> <update indicator> <TLVs> */
220#define P2P_EVENT_SERV_DISC_RESP "P2P-SERV-DISC-RESP "
d4b43b58 221#define P2P_EVENT_SERV_ASP_RESP "P2P-SERV-ASP-RESP "
b22128ef
JM
222#define P2P_EVENT_INVITATION_RECEIVED "P2P-INVITATION-RECEIVED "
223#define P2P_EVENT_INVITATION_RESULT "P2P-INVITATION-RESULT "
0ee89250 224#define P2P_EVENT_INVITATION_ACCEPTED "P2P-INVITATION-ACCEPTED "
8aebb0e4 225#define P2P_EVENT_FIND_STOPPED "P2P-FIND-STOPPED "
5bf9a6c8 226#define P2P_EVENT_PERSISTENT_PSK_FAIL "P2P-PERSISTENT-PSK-FAIL id="
c64e3a08 227#define P2P_EVENT_PRESENCE_RESPONSE "P2P-PRESENCE-RESPONSE "
74df9ecd 228#define P2P_EVENT_NFC_BOTH_GO "P2P-NFC-BOTH-GO "
59b45d1a
JM
229#define P2P_EVENT_NFC_PEER_CLIENT "P2P-NFC-PEER-CLIENT "
230#define P2P_EVENT_NFC_WHILE_CLIENT "P2P-NFC-WHILE-CLIENT "
6b005121
JM
231#define P2P_EVENT_FALLBACK_TO_GO_NEG "P2P-FALLBACK-TO-GO-NEG "
232#define P2P_EVENT_FALLBACK_TO_GO_NEG_ENABLED "P2P-FALLBACK-TO-GO-NEG-ENABLED "
b22128ef 233
ae8535b6
JM
234/* parameters: <PMF enabled> <timeout in ms> <Session Information URL> */
235#define ESS_DISASSOC_IMMINENT "ESS-DISASSOC-IMMINENT "
253f2e37 236#define P2P_EVENT_REMOVE_AND_REFORM_GROUP "P2P-REMOVE-AND-REFORM-GROUP "
ae8535b6 237
5fefce27
KV
238#define P2P_EVENT_P2PS_PROVISION_START "P2PS-PROV-START "
239#define P2P_EVENT_P2PS_PROVISION_DONE "P2PS-PROV-DONE "
240
b02fe7ff 241#define INTERWORKING_AP "INTERWORKING-AP "
28f2a7c4 242#define INTERWORKING_BLACKLISTED "INTERWORKING-BLACKLISTED "
b02fe7ff 243#define INTERWORKING_NO_MATCH "INTERWORKING-NO-MATCH "
d28f4e44 244#define INTERWORKING_ALREADY_CONNECTED "INTERWORKING-ALREADY-CONNECTED "
76a55a8e 245#define INTERWORKING_SELECTED "INTERWORKING-SELECTED "
b02fe7ff 246
1619e9d5
JM
247/* Credential block added; parameters: <id> */
248#define CRED_ADDED "CRED-ADDED "
249/* Credential block modified; parameters: <id> <field> */
250#define CRED_MODIFIED "CRED-MODIFIED "
251/* Credential block removed; parameters: <id> */
252#define CRED_REMOVED "CRED-REMOVED "
253
b1f12296 254#define GAS_RESPONSE_INFO "GAS-RESPONSE-INFO "
6ffa1687
JM
255/* parameters: <addr> <dialog_token> <freq> */
256#define GAS_QUERY_START "GAS-QUERY-START "
257/* parameters: <addr> <dialog_token> <freq> <status_code> <result> */
258#define GAS_QUERY_DONE "GAS-QUERY-DONE "
b1f12296 259
fb09ed33
AN
260/* parameters: <addr> <result> */
261#define ANQP_QUERY_DONE "ANQP-QUERY-DONE "
262
f465c32d
JM
263#define RX_ANQP "RX-ANQP "
264#define RX_HS20_ANQP "RX-HS20-ANQP "
265#define RX_HS20_ANQP_ICON "RX-HS20-ANQP-ICON "
266#define RX_HS20_ICON "RX-HS20-ICON "
34f28519 267#define RX_MBO_ANQP "RX-MBO-ANQP "
f465c32d 268
95a3ea94 269#define HS20_SUBSCRIPTION_REMEDIATION "HS20-SUBSCRIPTION-REMEDIATION "
7ef69479 270#define HS20_DEAUTH_IMMINENT_NOTICE "HS20-DEAUTH-IMMINENT-NOTICE "
95a3ea94 271
1f965e62
JM
272#define EXT_RADIO_WORK_START "EXT-RADIO-WORK-START "
273#define EXT_RADIO_WORK_TIMEOUT "EXT-RADIO-WORK-TIMEOUT "
274
f4b8bfae
AK
275#define RRM_EVENT_NEIGHBOR_REP_RXED "RRM-NEIGHBOR-REP-RECEIVED "
276#define RRM_EVENT_NEIGHBOR_REP_FAILED "RRM-NEIGHBOR-REP-REQUEST-FAILED "
277
ad08c363
JM
278/* hostapd control interface - fixed message prefixes */
279#define WPS_EVENT_PIN_NEEDED "WPS-PIN-NEEDED "
280#define WPS_EVENT_NEW_AP_SETTINGS "WPS-NEW-AP-SETTINGS "
aabe26a1 281#define WPS_EVENT_REG_SUCCESS "WPS-REG-SUCCESS "
3b2cf800 282#define WPS_EVENT_AP_SETUP_LOCKED "WPS-AP-SETUP-LOCKED "
94481410 283#define WPS_EVENT_AP_SETUP_UNLOCKED "WPS-AP-SETUP-UNLOCKED "
5a1cc30f
JM
284#define WPS_EVENT_AP_PIN_ENABLED "WPS-AP-PIN-ENABLED "
285#define WPS_EVENT_AP_PIN_DISABLED "WPS-AP-PIN-DISABLED "
20bd9547
JM
286#define AP_STA_CONNECTED "AP-STA-CONNECTED "
287#define AP_STA_DISCONNECTED "AP-STA-DISCONNECTED "
2c502460 288#define AP_STA_POSSIBLE_PSK_MISMATCH "AP-STA-POSSIBLE-PSK-MISMATCH "
1854eeca 289#define AP_STA_POLL_OK "AP-STA-POLL-OK "
ad08c363 290
3140803b
RM
291#define AP_REJECTED_MAX_STA "AP-REJECTED-MAX-STA "
292#define AP_REJECTED_BLOCKED_STA "AP-REJECTED-BLOCKED-STA "
6fc6879b 293
7d6d7370
JM
294#define AP_EVENT_ENABLED "AP-ENABLED "
295#define AP_EVENT_DISABLED "AP-DISABLED "
296
ab93fdeb
JM
297#define INTERFACE_ENABLED "INTERFACE-ENABLED "
298#define INTERFACE_DISABLED "INTERFACE-DISABLED "
299
ae134e1d
JM
300#define ACS_EVENT_STARTED "ACS-STARTED "
301#define ACS_EVENT_COMPLETED "ACS-COMPLETED "
302#define ACS_EVENT_FAILED "ACS-FAILED "
303
186c9059
JM
304#define DFS_EVENT_RADAR_DETECTED "DFS-RADAR-DETECTED "
305#define DFS_EVENT_NEW_CHANNEL "DFS-NEW-CHANNEL "
306#define DFS_EVENT_CAC_START "DFS-CAC-START "
307#define DFS_EVENT_CAC_COMPLETED "DFS-CAC-COMPLETED "
308#define DFS_EVENT_NOP_FINISHED "DFS-NOP-FINISHED "
7cbb5f1a 309#define DFS_EVENT_PRE_CAC_EXPIRED "DFS-PRE-CAC-EXPIRED "
186c9059 310
bf281c12
AO
311#define AP_CSA_FINISHED "AP-CSA-FINISHED "
312
a6f5b193
PX
313#define P2P_EVENT_LISTEN_OFFLOAD_STOP "P2P-LISTEN-OFFLOAD-STOPPED "
314#define P2P_LISTEN_OFFLOAD_STOP_REASON "P2P-LISTEN-OFFLOAD-STOP-REASON "
315
53514800
JM
316/* BSS Transition Management Response frame received */
317#define BSS_TM_RESP "BSS-TM-RESP "
318
dd599908
AS
319/* MBO IE with cellular data connection preference received */
320#define MBO_CELL_PREFERENCE "MBO-CELL-PREFERENCE "
321
322/* BSS Transition Management Request received with MBO transition reason */
323#define MBO_TRANSITION_REASON "MBO-TRANSITION-REASON "
324
f3383366
JM
325/* parameters: <STA address> <dialog token> <ack=0/1> */
326#define BEACON_REQ_TX_STATUS "BEACON-REQ-TX-STATUS "
ec45927b
JM
327/* parameters: <STA address> <dialog token> <report mode> <beacon report> */
328#define BEACON_RESP_RX "BEACON-RESP-RX "
f3383366 329
c5793127
JM
330/* PMKSA cache entry added; parameters: <BSSID> <network_id> */
331#define PMKSA_CACHE_ADDED "PMKSA-CACHE-ADDED "
332/* PMKSA cache entry removed; parameters: <BSSID> <network_id> */
333#define PMKSA_CACHE_REMOVED "PMKSA-CACHE-REMOVED "
334
124ddfa1
JM
335/* FILS HLP Container receive; parameters: dst=<addr> src=<addr> frame=<hexdump>
336 */
337#define FILS_HLP_RX "FILS-HLP-RX "
338
5f97dd1c
DS
339/* BSS command information masks */
340
c6673429 341#define WPA_BSS_MASK_ALL 0xFFFDFFFF
5f97dd1c
DS
342#define WPA_BSS_MASK_ID BIT(0)
343#define WPA_BSS_MASK_BSSID BIT(1)
344#define WPA_BSS_MASK_FREQ BIT(2)
345#define WPA_BSS_MASK_BEACON_INT BIT(3)
346#define WPA_BSS_MASK_CAPABILITIES BIT(4)
347#define WPA_BSS_MASK_QUAL BIT(5)
348#define WPA_BSS_MASK_NOISE BIT(6)
349#define WPA_BSS_MASK_LEVEL BIT(7)
350#define WPA_BSS_MASK_TSF BIT(8)
351#define WPA_BSS_MASK_AGE BIT(9)
352#define WPA_BSS_MASK_IE BIT(10)
353#define WPA_BSS_MASK_FLAGS BIT(11)
354#define WPA_BSS_MASK_SSID BIT(12)
355#define WPA_BSS_MASK_WPS_SCAN BIT(13)
356#define WPA_BSS_MASK_P2P_SCAN BIT(14)
357#define WPA_BSS_MASK_INTERNETW BIT(15)
337c781f 358#define WPA_BSS_MASK_WIFI_DISPLAY BIT(16)
c6673429 359#define WPA_BSS_MASK_DELIM BIT(17)
79070906 360#define WPA_BSS_MASK_MESH_SCAN BIT(18)
1d747e2a
JM
361#define WPA_BSS_MASK_SNR BIT(19)
362#define WPA_BSS_MASK_EST_THROUGHPUT BIT(20)
3794af2d 363#define WPA_BSS_MASK_FST BIT(21)
71ac9345 364#define WPA_BSS_MASK_UPDATE_IDX BIT(22)
19810d29 365#define WPA_BSS_MASK_BEACON_IE BIT(23)
b54f4339 366#define WPA_BSS_MASK_FILS_INDICATION BIT(24)
5f97dd1c
DS
367
368
86bd36f0
JM
369/* VENDOR_ELEM_* frame id values */
370enum wpa_vendor_elem_frame {
371 VENDOR_ELEM_PROBE_REQ_P2P = 0,
372 VENDOR_ELEM_PROBE_RESP_P2P = 1,
373 VENDOR_ELEM_PROBE_RESP_P2P_GO = 2,
374 VENDOR_ELEM_BEACON_P2P_GO = 3,
375 VENDOR_ELEM_P2P_PD_REQ = 4,
376 VENDOR_ELEM_P2P_PD_RESP = 5,
377 VENDOR_ELEM_P2P_GO_NEG_REQ = 6,
378 VENDOR_ELEM_P2P_GO_NEG_RESP = 7,
379 VENDOR_ELEM_P2P_GO_NEG_CONF = 8,
380 VENDOR_ELEM_P2P_INV_REQ = 9,
381 VENDOR_ELEM_P2P_INV_RESP = 10,
382 VENDOR_ELEM_P2P_ASSOC_REQ = 11,
383 VENDOR_ELEM_P2P_ASSOC_RESP = 12,
d29fa3a7 384 VENDOR_ELEM_ASSOC_REQ = 13,
61c10118 385 VENDOR_ELEM_PROBE_REQ = 14,
86bd36f0
JM
386 NUM_VENDOR_ELEM_FRAMES
387};
388
389
6fc6879b
JM
390/* wpa_supplicant/hostapd control interface access */
391
392/**
393 * wpa_ctrl_open - Open a control interface to wpa_supplicant/hostapd
394 * @ctrl_path: Path for UNIX domain sockets; ignored if UDP sockets are used.
395 * Returns: Pointer to abstract control interface data or %NULL on failure
396 *
397 * This function is used to open a control interface to wpa_supplicant/hostapd.
398 * ctrl_path is usually /var/run/wpa_supplicant or /var/run/hostapd. This path
399 * is configured in wpa_supplicant/hostapd and other programs using the control
400 * interface need to use matching path configuration.
401 */
402struct wpa_ctrl * wpa_ctrl_open(const char *ctrl_path);
403
4ae71209
MM
404/**
405 * wpa_ctrl_open2 - Open a control interface to wpa_supplicant/hostapd
406 * @ctrl_path: Path for UNIX domain sockets; ignored if UDP sockets are used.
407 * @cli_path: Path for client UNIX domain sockets; ignored if UDP socket
408 * is used.
409 * Returns: Pointer to abstract control interface data or %NULL on failure
410 *
411 * This function is used to open a control interface to wpa_supplicant/hostapd
412 * when the socket path for client need to be specified explicitly. Default
413 * ctrl_path is usually /var/run/wpa_supplicant or /var/run/hostapd and client
414 * socket path is /tmp.
415 */
416struct wpa_ctrl * wpa_ctrl_open2(const char *ctrl_path, const char *cli_path);
417
6fc6879b
JM
418
419/**
420 * wpa_ctrl_close - Close a control interface to wpa_supplicant/hostapd
421 * @ctrl: Control interface data from wpa_ctrl_open()
422 *
423 * This function is used to close a control interface.
424 */
425void wpa_ctrl_close(struct wpa_ctrl *ctrl);
426
427
428/**
429 * wpa_ctrl_request - Send a command to wpa_supplicant/hostapd
430 * @ctrl: Control interface data from wpa_ctrl_open()
431 * @cmd: Command; usually, ASCII text, e.g., "PING"
432 * @cmd_len: Length of the cmd in bytes
433 * @reply: Buffer for the response
434 * @reply_len: Reply buffer length
435 * @msg_cb: Callback function for unsolicited messages or %NULL if not used
436 * Returns: 0 on success, -1 on error (send or receive failed), -2 on timeout
437 *
438 * This function is used to send commands to wpa_supplicant/hostapd. Received
439 * response will be written to reply and reply_len is set to the actual length
440 * of the reply. This function will block for up to two seconds while waiting
441 * for the reply. If unsolicited messages are received, the blocking time may
442 * be longer.
443 *
444 * msg_cb can be used to register a callback function that will be called for
445 * unsolicited messages received while waiting for the command response. These
446 * messages may be received if wpa_ctrl_request() is called at the same time as
447 * wpa_supplicant/hostapd is sending such a message. This can happen only if
448 * the program has used wpa_ctrl_attach() to register itself as a monitor for
449 * event messages. Alternatively to msg_cb, programs can register two control
450 * interface connections and use one of them for commands and the other one for
451 * receiving event messages, in other words, call wpa_ctrl_attach() only for
452 * the control interface connection that will be used for event messages.
453 */
454int wpa_ctrl_request(struct wpa_ctrl *ctrl, const char *cmd, size_t cmd_len,
455 char *reply, size_t *reply_len,
456 void (*msg_cb)(char *msg, size_t len));
457
458
459/**
460 * wpa_ctrl_attach - Register as an event monitor for the control interface
461 * @ctrl: Control interface data from wpa_ctrl_open()
462 * Returns: 0 on success, -1 on failure, -2 on timeout
463 *
464 * This function registers the control interface connection as a monitor for
465 * wpa_supplicant/hostapd events. After a success wpa_ctrl_attach() call, the
466 * control interface connection starts receiving event messages that can be
467 * read with wpa_ctrl_recv().
468 */
469int wpa_ctrl_attach(struct wpa_ctrl *ctrl);
470
471
472/**
473 * wpa_ctrl_detach - Unregister event monitor from the control interface
474 * @ctrl: Control interface data from wpa_ctrl_open()
475 * Returns: 0 on success, -1 on failure, -2 on timeout
476 *
477 * This function unregisters the control interface connection as a monitor for
478 * wpa_supplicant/hostapd events, i.e., cancels the registration done with
479 * wpa_ctrl_attach().
480 */
481int wpa_ctrl_detach(struct wpa_ctrl *ctrl);
482
483
484/**
485 * wpa_ctrl_recv - Receive a pending control interface message
486 * @ctrl: Control interface data from wpa_ctrl_open()
487 * @reply: Buffer for the message data
488 * @reply_len: Length of the reply buffer
489 * Returns: 0 on success, -1 on failure
490 *
43f02e6a
JM
491 * This function will receive a pending control interface message. The received
492 * response will be written to reply and reply_len is set to the actual length
493 * of the reply.
494
6fc6879b
JM
495 * wpa_ctrl_recv() is only used for event messages, i.e., wpa_ctrl_attach()
496 * must have been used to register the control interface as an event monitor.
497 */
498int wpa_ctrl_recv(struct wpa_ctrl *ctrl, char *reply, size_t *reply_len);
499
500
501/**
502 * wpa_ctrl_pending - Check whether there are pending event messages
503 * @ctrl: Control interface data from wpa_ctrl_open()
504 * Returns: 1 if there are pending messages, 0 if no, or -1 on error
505 *
506 * This function will check whether there are any pending control interface
507 * message available to be received with wpa_ctrl_recv(). wpa_ctrl_pending() is
508 * only used for event messages, i.e., wpa_ctrl_attach() must have been used to
509 * register the control interface as an event monitor.
510 */
511int wpa_ctrl_pending(struct wpa_ctrl *ctrl);
512
513
514/**
515 * wpa_ctrl_get_fd - Get file descriptor used by the control interface
516 * @ctrl: Control interface data from wpa_ctrl_open()
517 * Returns: File descriptor used for the connection
518 *
519 * This function can be used to get the file descriptor that is used for the
520 * control interface connection. The returned value can be used, e.g., with
521 * select() while waiting for multiple events.
522 *
523 * The returned file descriptor must not be used directly for sending or
524 * receiving packets; instead, the library functions wpa_ctrl_request() and
525 * wpa_ctrl_recv() must be used for this.
526 */
527int wpa_ctrl_get_fd(struct wpa_ctrl *ctrl);
528
ed3eecd7
DS
529#ifdef ANDROID
530/**
531 * wpa_ctrl_cleanup() - Delete any local UNIX domain socket files that
532 * may be left over from clients that were previously connected to
533 * wpa_supplicant. This keeps these files from being orphaned in the
534 * event of crashes that prevented them from being removed as part
535 * of the normal orderly shutdown.
536 */
537void wpa_ctrl_cleanup(void);
538#endif /* ANDROID */
539
6fc6879b 540#ifdef CONFIG_CTRL_IFACE_UDP
afadf423 541/* Port range for multiple wpa_supplicant instances and multiple VIFs */
6fc6879b 542#define WPA_CTRL_IFACE_PORT 9877
afadf423 543#define WPA_CTRL_IFACE_PORT_LIMIT 50 /* decremented from start */
6fc6879b 544#define WPA_GLOBAL_CTRL_IFACE_PORT 9878
afadf423 545#define WPA_GLOBAL_CTRL_IFACE_PORT_LIMIT 20 /* incremented from start */
3cea004d
TG
546
547char * wpa_ctrl_get_remote_ifname(struct wpa_ctrl *ctrl);
6fc6879b
JM
548#endif /* CONFIG_CTRL_IFACE_UDP */
549
550
551#ifdef __cplusplus
552}
553#endif
554
555#endif /* WPA_CTRL_H */