1 | /* |
---|
2 | * wpa_supplicant/hostapd control interface library |
---|
3 | * Copyright (c) 2004-2006, 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 | /** EAP authentication completed successfully */ |
---|
54 | #define WPA_EVENT_EAP_SUCCESS "CTRL-EVENT-EAP-SUCCESS " |
---|
55 | /** EAP authentication failed (EAP-Failure received) */ |
---|
56 | #define WPA_EVENT_EAP_FAILURE "CTRL-EVENT-EAP-FAILURE " |
---|
57 | /** Network block temporarily disabled (e.g., due to authentication failure) */ |
---|
58 | #define WPA_EVENT_TEMP_DISABLED "CTRL-EVENT-SSID-TEMP-DISABLED " |
---|
59 | /** Temporarily disabled network block re-enabled */ |
---|
60 | #define WPA_EVENT_REENABLED "CTRL-EVENT-SSID-REENABLED " |
---|
61 | /** New scan started */ |
---|
62 | #define WPA_EVENT_SCAN_STARTED "CTRL-EVENT-SCAN-STARTED " |
---|
63 | /** New scan results available */ |
---|
64 | #define WPA_EVENT_SCAN_RESULTS "CTRL-EVENT-SCAN-RESULTS " |
---|
65 | /** Scan command failed */ |
---|
66 | #define WPA_EVENT_SCAN_FAILED "CTRL-EVENT-SCAN-FAILED " |
---|
67 | /** wpa_supplicant state change */ |
---|
68 | #define WPA_EVENT_STATE_CHANGE "CTRL-EVENT-STATE-CHANGE " |
---|
69 | /** A new BSS entry was added (followed by BSS entry id and BSSID) */ |
---|
70 | #define WPA_EVENT_BSS_ADDED "CTRL-EVENT-BSS-ADDED " |
---|
71 | /** A BSS entry was removed (followed by BSS entry id and BSSID) */ |
---|
72 | #define WPA_EVENT_BSS_REMOVED "CTRL-EVENT-BSS-REMOVED " |
---|
73 | /** No suitable network was found */ |
---|
74 | #define WPA_EVENT_NETWORK_NOT_FOUND "CTRL-EVENT-NETWORK-NOT-FOUND " |
---|
75 | /** Change in the signal level was reported by the driver */ |
---|
76 | #define WPA_EVENT_SIGNAL_CHANGE "CTRL-EVENT-SIGNAL-CHANGE " |
---|
77 | /** Regulatory domain channel */ |
---|
78 | #define WPA_EVENT_REGDOM_CHANGE "CTRL-EVENT-REGDOM-CHANGE " |
---|
79 | |
---|
80 | /** RSN IBSS 4-way handshakes completed with specified peer */ |
---|
81 | #define IBSS_RSN_COMPLETED "IBSS-RSN-COMPLETED " |
---|
82 | |
---|
83 | /** Notification of frequency conflict due to a concurrent operation. |
---|
84 | * |
---|
85 | * The indicated network is disabled and needs to be re-enabled before it can |
---|
86 | * be used again. |
---|
87 | */ |
---|
88 | #define WPA_EVENT_FREQ_CONFLICT "CTRL-EVENT-FREQ-CONFLICT " |
---|
89 | /** Frequency ranges that the driver recommends to avoid */ |
---|
90 | #define WPA_EVENT_AVOID_FREQ "CTRL-EVENT-AVOID-FREQ " |
---|
91 | /** WPS overlap detected in PBC mode */ |
---|
92 | #define WPS_EVENT_OVERLAP "WPS-OVERLAP-DETECTED " |
---|
93 | /** Available WPS AP with active PBC found in scan results */ |
---|
94 | #define WPS_EVENT_AP_AVAILABLE_PBC "WPS-AP-AVAILABLE-PBC " |
---|
95 | /** Available WPS AP with our address as authorized in scan results */ |
---|
96 | #define WPS_EVENT_AP_AVAILABLE_AUTH "WPS-AP-AVAILABLE-AUTH " |
---|
97 | /** Available WPS AP with recently selected PIN registrar found in scan results |
---|
98 | */ |
---|
99 | #define WPS_EVENT_AP_AVAILABLE_PIN "WPS-AP-AVAILABLE-PIN " |
---|
100 | /** Available WPS AP found in scan results */ |
---|
101 | #define WPS_EVENT_AP_AVAILABLE "WPS-AP-AVAILABLE " |
---|
102 | /** A new credential received */ |
---|
103 | #define WPS_EVENT_CRED_RECEIVED "WPS-CRED-RECEIVED " |
---|
104 | /** M2D received */ |
---|
105 | #define WPS_EVENT_M2D "WPS-M2D " |
---|
106 | /** WPS registration failed after M2/M2D */ |
---|
107 | #define WPS_EVENT_FAIL "WPS-FAIL " |
---|
108 | /** WPS registration completed successfully */ |
---|
109 | #define WPS_EVENT_SUCCESS "WPS-SUCCESS " |
---|
110 | /** WPS enrollment attempt timed out and was terminated */ |
---|
111 | #define WPS_EVENT_TIMEOUT "WPS-TIMEOUT " |
---|
112 | /* PBC mode was activated */ |
---|
113 | #define WPS_EVENT_ACTIVE "WPS-PBC-ACTIVE " |
---|
114 | /* PBC mode was disabled */ |
---|
115 | #define WPS_EVENT_DISABLE "WPS-PBC-DISABLE " |
---|
116 | |
---|
117 | #define WPS_EVENT_ENROLLEE_SEEN "WPS-ENROLLEE-SEEN " |
---|
118 | |
---|
119 | #define WPS_EVENT_OPEN_NETWORK "WPS-OPEN-NETWORK " |
---|
120 | |
---|
121 | /* WPS ER events */ |
---|
122 | #define WPS_EVENT_ER_AP_ADD "WPS-ER-AP-ADD " |
---|
123 | #define WPS_EVENT_ER_AP_REMOVE "WPS-ER-AP-REMOVE " |
---|
124 | #define WPS_EVENT_ER_ENROLLEE_ADD "WPS-ER-ENROLLEE-ADD " |
---|
125 | #define WPS_EVENT_ER_ENROLLEE_REMOVE "WPS-ER-ENROLLEE-REMOVE " |
---|
126 | #define WPS_EVENT_ER_AP_SETTINGS "WPS-ER-AP-SETTINGS " |
---|
127 | #define WPS_EVENT_ER_SET_SEL_REG "WPS-ER-AP-SET-SEL-REG " |
---|
128 | |
---|
129 | /* MESH events */ |
---|
130 | #define MESH_GROUP_STARTED "MESH-GROUP-STARTED " |
---|
131 | #define MESH_GROUP_REMOVED "MESH-GROUP-REMOVED " |
---|
132 | #define MESH_PEER_CONNECTED "MESH-PEER-CONNECTED " |
---|
133 | #define MESH_PEER_DISCONNECTED "MESH-PEER-DISCONNECTED " |
---|
134 | /** Mesh SAE authentication failure. Wrong password suspected. */ |
---|
135 | #define MESH_SAE_AUTH_FAILURE "MESH-SAE-AUTH-FAILURE " |
---|
136 | #define MESH_SAE_AUTH_BLOCKED "MESH-SAE-AUTH-BLOCKED " |
---|
137 | |
---|
138 | /* WMM AC events */ |
---|
139 | #define WMM_AC_EVENT_TSPEC_ADDED "TSPEC-ADDED " |
---|
140 | #define WMM_AC_EVENT_TSPEC_REMOVED "TSPEC-REMOVED " |
---|
141 | #define WMM_AC_EVENT_TSPEC_REQ_FAILED "TSPEC-REQ-FAILED " |
---|
142 | |
---|
143 | /** P2P device found */ |
---|
144 | #define P2P_EVENT_DEVICE_FOUND "P2P-DEVICE-FOUND " |
---|
145 | |
---|
146 | /** P2P device lost */ |
---|
147 | #define P2P_EVENT_DEVICE_LOST "P2P-DEVICE-LOST " |
---|
148 | |
---|
149 | /** A P2P device requested GO negotiation, but we were not ready to start the |
---|
150 | * negotiation */ |
---|
151 | #define P2P_EVENT_GO_NEG_REQUEST "P2P-GO-NEG-REQUEST " |
---|
152 | #define P2P_EVENT_GO_NEG_SUCCESS "P2P-GO-NEG-SUCCESS " |
---|
153 | #define P2P_EVENT_GO_NEG_FAILURE "P2P-GO-NEG-FAILURE " |
---|
154 | #define P2P_EVENT_GROUP_FORMATION_SUCCESS "P2P-GROUP-FORMATION-SUCCESS " |
---|
155 | #define P2P_EVENT_GROUP_FORMATION_FAILURE "P2P-GROUP-FORMATION-FAILURE " |
---|
156 | #define P2P_EVENT_GROUP_STARTED "P2P-GROUP-STARTED " |
---|
157 | #define P2P_EVENT_GROUP_REMOVED "P2P-GROUP-REMOVED " |
---|
158 | #define P2P_EVENT_CROSS_CONNECT_ENABLE "P2P-CROSS-CONNECT-ENABLE " |
---|
159 | #define P2P_EVENT_CROSS_CONNECT_DISABLE "P2P-CROSS-CONNECT-DISABLE " |
---|
160 | /* parameters: <peer address> <PIN> */ |
---|
161 | #define P2P_EVENT_PROV_DISC_SHOW_PIN "P2P-PROV-DISC-SHOW-PIN " |
---|
162 | /* parameters: <peer address> */ |
---|
163 | #define P2P_EVENT_PROV_DISC_ENTER_PIN "P2P-PROV-DISC-ENTER-PIN " |
---|
164 | /* parameters: <peer address> */ |
---|
165 | #define P2P_EVENT_PROV_DISC_PBC_REQ "P2P-PROV-DISC-PBC-REQ " |
---|
166 | /* parameters: <peer address> */ |
---|
167 | #define P2P_EVENT_PROV_DISC_PBC_RESP "P2P-PROV-DISC-PBC-RESP " |
---|
168 | /* parameters: <peer address> <status> */ |
---|
169 | #define P2P_EVENT_PROV_DISC_FAILURE "P2P-PROV-DISC-FAILURE" |
---|
170 | /* parameters: <freq> <src addr> <dialog token> <update indicator> <TLVs> */ |
---|
171 | #define P2P_EVENT_SERV_DISC_REQ "P2P-SERV-DISC-REQ " |
---|
172 | /* parameters: <src addr> <update indicator> <TLVs> */ |
---|
173 | #define P2P_EVENT_SERV_DISC_RESP "P2P-SERV-DISC-RESP " |
---|
174 | #define P2P_EVENT_SERV_ASP_RESP "P2P-SERV-ASP-RESP " |
---|
175 | #define P2P_EVENT_INVITATION_RECEIVED "P2P-INVITATION-RECEIVED " |
---|
176 | #define P2P_EVENT_INVITATION_RESULT "P2P-INVITATION-RESULT " |
---|
177 | #define P2P_EVENT_FIND_STOPPED "P2P-FIND-STOPPED " |
---|
178 | #define P2P_EVENT_PERSISTENT_PSK_FAIL "P2P-PERSISTENT-PSK-FAIL id=" |
---|
179 | #define P2P_EVENT_PRESENCE_RESPONSE "P2P-PRESENCE-RESPONSE " |
---|
180 | #define P2P_EVENT_NFC_BOTH_GO "P2P-NFC-BOTH-GO " |
---|
181 | #define P2P_EVENT_NFC_PEER_CLIENT "P2P-NFC-PEER-CLIENT " |
---|
182 | #define P2P_EVENT_NFC_WHILE_CLIENT "P2P-NFC-WHILE-CLIENT " |
---|
183 | #define P2P_EVENT_FALLBACK_TO_GO_NEG "P2P-FALLBACK-TO-GO-NEG " |
---|
184 | #define P2P_EVENT_FALLBACK_TO_GO_NEG_ENABLED "P2P-FALLBACK-TO-GO-NEG-ENABLED " |
---|
185 | |
---|
186 | /* parameters: <PMF enabled> <timeout in ms> <Session Information URL> */ |
---|
187 | #define ESS_DISASSOC_IMMINENT "ESS-DISASSOC-IMMINENT " |
---|
188 | #define P2P_EVENT_REMOVE_AND_REFORM_GROUP "P2P-REMOVE-AND-REFORM-GROUP " |
---|
189 | |
---|
190 | #define P2P_EVENT_P2PS_PROVISION_START "P2PS-PROV-START " |
---|
191 | #define P2P_EVENT_P2PS_PROVISION_DONE "P2PS-PROV-DONE " |
---|
192 | |
---|
193 | #define INTERWORKING_AP "INTERWORKING-AP " |
---|
194 | #define INTERWORKING_BLACKLISTED "INTERWORKING-BLACKLISTED " |
---|
195 | #define INTERWORKING_NO_MATCH "INTERWORKING-NO-MATCH " |
---|
196 | #define INTERWORKING_ALREADY_CONNECTED "INTERWORKING-ALREADY-CONNECTED " |
---|
197 | #define INTERWORKING_SELECTED "INTERWORKING-SELECTED " |
---|
198 | |
---|
199 | /* Credential block added; parameters: <id> */ |
---|
200 | #define CRED_ADDED "CRED-ADDED " |
---|
201 | /* Credential block modified; parameters: <id> <field> */ |
---|
202 | #define CRED_MODIFIED "CRED-MODIFIED " |
---|
203 | /* Credential block removed; parameters: <id> */ |
---|
204 | #define CRED_REMOVED "CRED-REMOVED " |
---|
205 | |
---|
206 | #define GAS_RESPONSE_INFO "GAS-RESPONSE-INFO " |
---|
207 | /* parameters: <addr> <dialog_token> <freq> */ |
---|
208 | #define GAS_QUERY_START "GAS-QUERY-START " |
---|
209 | /* parameters: <addr> <dialog_token> <freq> <status_code> <result> */ |
---|
210 | #define GAS_QUERY_DONE "GAS-QUERY-DONE " |
---|
211 | |
---|
212 | /* parameters: <addr> <result> */ |
---|
213 | #define ANQP_QUERY_DONE "ANQP-QUERY-DONE " |
---|
214 | |
---|
215 | #define HS20_SUBSCRIPTION_REMEDIATION "HS20-SUBSCRIPTION-REMEDIATION " |
---|
216 | #define HS20_DEAUTH_IMMINENT_NOTICE "HS20-DEAUTH-IMMINENT-NOTICE " |
---|
217 | |
---|
218 | #define EXT_RADIO_WORK_START "EXT-RADIO-WORK-START " |
---|
219 | #define EXT_RADIO_WORK_TIMEOUT "EXT-RADIO-WORK-TIMEOUT " |
---|
220 | |
---|
221 | #define RRM_EVENT_NEIGHBOR_REP_RXED "RRM-NEIGHBOR-REP-RECEIVED " |
---|
222 | #define RRM_EVENT_NEIGHBOR_REP_FAILED "RRM-NEIGHBOR-REP-REQUEST-FAILED " |
---|
223 | |
---|
224 | /* hostapd control interface - fixed message prefixes */ |
---|
225 | #define WPS_EVENT_PIN_NEEDED "WPS-PIN-NEEDED " |
---|
226 | #define WPS_EVENT_NEW_AP_SETTINGS "WPS-NEW-AP-SETTINGS " |
---|
227 | #define WPS_EVENT_REG_SUCCESS "WPS-REG-SUCCESS " |
---|
228 | #define WPS_EVENT_AP_SETUP_LOCKED "WPS-AP-SETUP-LOCKED " |
---|
229 | #define WPS_EVENT_AP_SETUP_UNLOCKED "WPS-AP-SETUP-UNLOCKED " |
---|
230 | #define WPS_EVENT_AP_PIN_ENABLED "WPS-AP-PIN-ENABLED " |
---|
231 | #define WPS_EVENT_AP_PIN_DISABLED "WPS-AP-PIN-DISABLED " |
---|
232 | #define AP_STA_CONNECTED "AP-STA-CONNECTED " |
---|
233 | #define AP_STA_DISCONNECTED "AP-STA-DISCONNECTED " |
---|
234 | #define AP_STA_POSSIBLE_PSK_MISMATCH "AP-STA-POSSIBLE-PSK-MISMATCH " |
---|
235 | |
---|
236 | #define AP_REJECTED_MAX_STA "AP-REJECTED-MAX-STA " |
---|
237 | #define AP_REJECTED_BLOCKED_STA "AP-REJECTED-BLOCKED-STA " |
---|
238 | |
---|
239 | #define AP_EVENT_ENABLED "AP-ENABLED " |
---|
240 | #define AP_EVENT_DISABLED "AP-DISABLED " |
---|
241 | |
---|
242 | #define INTERFACE_ENABLED "INTERFACE-ENABLED " |
---|
243 | #define INTERFACE_DISABLED "INTERFACE-DISABLED " |
---|
244 | |
---|
245 | #define ACS_EVENT_STARTED "ACS-STARTED " |
---|
246 | #define ACS_EVENT_COMPLETED "ACS-COMPLETED " |
---|
247 | #define ACS_EVENT_FAILED "ACS-FAILED " |
---|
248 | |
---|
249 | #define DFS_EVENT_RADAR_DETECTED "DFS-RADAR-DETECTED " |
---|
250 | #define DFS_EVENT_NEW_CHANNEL "DFS-NEW-CHANNEL " |
---|
251 | #define DFS_EVENT_CAC_START "DFS-CAC-START " |
---|
252 | #define DFS_EVENT_CAC_COMPLETED "DFS-CAC-COMPLETED " |
---|
253 | #define DFS_EVENT_NOP_FINISHED "DFS-NOP-FINISHED " |
---|
254 | |
---|
255 | #define AP_CSA_FINISHED "AP-CSA-FINISHED " |
---|
256 | |
---|
257 | /* BSS Transition Management Response frame received */ |
---|
258 | #define BSS_TM_RESP "BSS-TM-RESP " |
---|
259 | |
---|
260 | /* BSS command information masks */ |
---|
261 | |
---|
262 | #define WPA_BSS_MASK_ALL 0xFFFDFFFF |
---|
263 | #define WPA_BSS_MASK_ID BIT(0) |
---|
264 | #define WPA_BSS_MASK_BSSID BIT(1) |
---|
265 | #define WPA_BSS_MASK_FREQ BIT(2) |
---|
266 | #define WPA_BSS_MASK_BEACON_INT BIT(3) |
---|
267 | #define WPA_BSS_MASK_CAPABILITIES BIT(4) |
---|
268 | #define WPA_BSS_MASK_QUAL BIT(5) |
---|
269 | #define WPA_BSS_MASK_NOISE BIT(6) |
---|
270 | #define WPA_BSS_MASK_LEVEL BIT(7) |
---|
271 | #define WPA_BSS_MASK_TSF BIT(8) |
---|
272 | #define WPA_BSS_MASK_AGE BIT(9) |
---|
273 | #define WPA_BSS_MASK_IE BIT(10) |
---|
274 | #define WPA_BSS_MASK_FLAGS BIT(11) |
---|
275 | #define WPA_BSS_MASK_SSID BIT(12) |
---|
276 | #define WPA_BSS_MASK_WPS_SCAN BIT(13) |
---|
277 | #define WPA_BSS_MASK_P2P_SCAN BIT(14) |
---|
278 | #define WPA_BSS_MASK_INTERNETW BIT(15) |
---|
279 | #define WPA_BSS_MASK_WIFI_DISPLAY BIT(16) |
---|
280 | #define WPA_BSS_MASK_DELIM BIT(17) |
---|
281 | #define WPA_BSS_MASK_MESH_SCAN BIT(18) |
---|
282 | #define WPA_BSS_MASK_SNR BIT(19) |
---|
283 | #define WPA_BSS_MASK_EST_THROUGHPUT BIT(20) |
---|
284 | #define WPA_BSS_MASK_FST BIT(21) |
---|
285 | |
---|
286 | |
---|
287 | /* VENDOR_ELEM_* frame id values */ |
---|
288 | enum wpa_vendor_elem_frame { |
---|
289 | VENDOR_ELEM_PROBE_REQ_P2P = 0, |
---|
290 | VENDOR_ELEM_PROBE_RESP_P2P = 1, |
---|
291 | VENDOR_ELEM_PROBE_RESP_P2P_GO = 2, |
---|
292 | VENDOR_ELEM_BEACON_P2P_GO = 3, |
---|
293 | VENDOR_ELEM_P2P_PD_REQ = 4, |
---|
294 | VENDOR_ELEM_P2P_PD_RESP = 5, |
---|
295 | VENDOR_ELEM_P2P_GO_NEG_REQ = 6, |
---|
296 | VENDOR_ELEM_P2P_GO_NEG_RESP = 7, |
---|
297 | VENDOR_ELEM_P2P_GO_NEG_CONF = 8, |
---|
298 | VENDOR_ELEM_P2P_INV_REQ = 9, |
---|
299 | VENDOR_ELEM_P2P_INV_RESP = 10, |
---|
300 | VENDOR_ELEM_P2P_ASSOC_REQ = 11, |
---|
301 | VENDOR_ELEM_P2P_ASSOC_RESP = 12, |
---|
302 | VENDOR_ELEM_ASSOC_REQ = 13, |
---|
303 | NUM_VENDOR_ELEM_FRAMES |
---|
304 | }; |
---|
305 | |
---|
306 | |
---|
307 | /* wpa_supplicant/hostapd control interface access */ |
---|
308 | |
---|
309 | /** |
---|
310 | * wpa_ctrl_open - Open a control interface to wpa_supplicant/hostapd |
---|
311 | * @ctrl_path: Path for UNIX domain sockets; ignored if UDP sockets are used. |
---|
312 | * Returns: Pointer to abstract control interface data or %NULL on failure |
---|
313 | * |
---|
314 | * This function is used to open a control interface to wpa_supplicant/hostapd. |
---|
315 | * ctrl_path is usually /var/run/wpa_supplicant or /var/run/hostapd. This path |
---|
316 | * is configured in wpa_supplicant/hostapd and other programs using the control |
---|
317 | * interface need to use matching path configuration. |
---|
318 | */ |
---|
319 | struct wpa_ctrl * wpa_ctrl_open(const char *ctrl_path); |
---|
320 | |
---|
321 | /** |
---|
322 | * wpa_ctrl_open2 - Open a control interface to wpa_supplicant/hostapd |
---|
323 | * @ctrl_path: Path for UNIX domain sockets; ignored if UDP sockets are used. |
---|
324 | * @cli_path: Path for client UNIX domain sockets; ignored if UDP socket |
---|
325 | * is used. |
---|
326 | * Returns: Pointer to abstract control interface data or %NULL on failure |
---|
327 | * |
---|
328 | * This function is used to open a control interface to wpa_supplicant/hostapd |
---|
329 | * when the socket path for client need to be specified explicitly. Default |
---|
330 | * ctrl_path is usually /var/run/wpa_supplicant or /var/run/hostapd and client |
---|
331 | * socket path is /tmp. |
---|
332 | */ |
---|
333 | struct wpa_ctrl * wpa_ctrl_open2(const char *ctrl_path, const char *cli_path); |
---|
334 | |
---|
335 | |
---|
336 | /** |
---|
337 | * wpa_ctrl_close - Close a control interface to wpa_supplicant/hostapd |
---|
338 | * @ctrl: Control interface data from wpa_ctrl_open() |
---|
339 | * |
---|
340 | * This function is used to close a control interface. |
---|
341 | */ |
---|
342 | void wpa_ctrl_close(struct wpa_ctrl *ctrl); |
---|
343 | |
---|
344 | |
---|
345 | /** |
---|
346 | * wpa_ctrl_request - Send a command to wpa_supplicant/hostapd |
---|
347 | * @ctrl: Control interface data from wpa_ctrl_open() |
---|
348 | * @cmd: Command; usually, ASCII text, e.g., "PING" |
---|
349 | * @cmd_len: Length of the cmd in bytes |
---|
350 | * @reply: Buffer for the response |
---|
351 | * @reply_len: Reply buffer length |
---|
352 | * @msg_cb: Callback function for unsolicited messages or %NULL if not used |
---|
353 | * Returns: 0 on success, -1 on error (send or receive failed), -2 on timeout |
---|
354 | * |
---|
355 | * This function is used to send commands to wpa_supplicant/hostapd. Received |
---|
356 | * response will be written to reply and reply_len is set to the actual length |
---|
357 | * of the reply. This function will block for up to two seconds while waiting |
---|
358 | * for the reply. If unsolicited messages are received, the blocking time may |
---|
359 | * be longer. |
---|
360 | * |
---|
361 | * msg_cb can be used to register a callback function that will be called for |
---|
362 | * unsolicited messages received while waiting for the command response. These |
---|
363 | * messages may be received if wpa_ctrl_request() is called at the same time as |
---|
364 | * wpa_supplicant/hostapd is sending such a message. This can happen only if |
---|
365 | * the program has used wpa_ctrl_attach() to register itself as a monitor for |
---|
366 | * event messages. Alternatively to msg_cb, programs can register two control |
---|
367 | * interface connections and use one of them for commands and the other one for |
---|
368 | * receiving event messages, in other words, call wpa_ctrl_attach() only for |
---|
369 | * the control interface connection that will be used for event messages. |
---|
370 | */ |
---|
371 | int wpa_ctrl_request(struct wpa_ctrl *ctrl, const char *cmd, size_t cmd_len, |
---|
372 | char *reply, size_t *reply_len, |
---|
373 | void (*msg_cb)(char *msg, size_t len)); |
---|
374 | |
---|
375 | |
---|
376 | /** |
---|
377 | * wpa_ctrl_attach - Register as an event monitor for the control interface |
---|
378 | * @ctrl: Control interface data from wpa_ctrl_open() |
---|
379 | * Returns: 0 on success, -1 on failure, -2 on timeout |
---|
380 | * |
---|
381 | * This function registers the control interface connection as a monitor for |
---|
382 | * wpa_supplicant/hostapd events. After a success wpa_ctrl_attach() call, the |
---|
383 | * control interface connection starts receiving event messages that can be |
---|
384 | * read with wpa_ctrl_recv(). |
---|
385 | */ |
---|
386 | int wpa_ctrl_attach(struct wpa_ctrl *ctrl); |
---|
387 | |
---|
388 | |
---|
389 | /** |
---|
390 | * wpa_ctrl_detach - Unregister event monitor from the control interface |
---|
391 | * @ctrl: Control interface data from wpa_ctrl_open() |
---|
392 | * Returns: 0 on success, -1 on failure, -2 on timeout |
---|
393 | * |
---|
394 | * This function unregisters the control interface connection as a monitor for |
---|
395 | * wpa_supplicant/hostapd events, i.e., cancels the registration done with |
---|
396 | * wpa_ctrl_attach(). |
---|
397 | */ |
---|
398 | int wpa_ctrl_detach(struct wpa_ctrl *ctrl); |
---|
399 | |
---|
400 | |
---|
401 | /** |
---|
402 | * wpa_ctrl_recv - Receive a pending control interface message |
---|
403 | * @ctrl: Control interface data from wpa_ctrl_open() |
---|
404 | * @reply: Buffer for the message data |
---|
405 | * @reply_len: Length of the reply buffer |
---|
406 | * Returns: 0 on success, -1 on failure |
---|
407 | * |
---|
408 | * This function will receive a pending control interface message. The received |
---|
409 | * response will be written to reply and reply_len is set to the actual length |
---|
410 | * of the reply. |
---|
411 | |
---|
412 | * wpa_ctrl_recv() is only used for event messages, i.e., wpa_ctrl_attach() |
---|
413 | * must have been used to register the control interface as an event monitor. |
---|
414 | */ |
---|
415 | int wpa_ctrl_recv(struct wpa_ctrl *ctrl, char *reply, size_t *reply_len); |
---|
416 | |
---|
417 | |
---|
418 | /** |
---|
419 | * wpa_ctrl_pending - Check whether there are pending event messages |
---|
420 | * @ctrl: Control interface data from wpa_ctrl_open() |
---|
421 | * Returns: 1 if there are pending messages, 0 if no, or -1 on error |
---|
422 | * |
---|
423 | * This function will check whether there are any pending control interface |
---|
424 | * message available to be received with wpa_ctrl_recv(). wpa_ctrl_pending() is |
---|
425 | * only used for event messages, i.e., wpa_ctrl_attach() must have been used to |
---|
426 | * register the control interface as an event monitor. |
---|
427 | */ |
---|
428 | int wpa_ctrl_pending(struct wpa_ctrl *ctrl); |
---|
429 | |
---|
430 | |
---|
431 | /** |
---|
432 | * wpa_ctrl_get_fd - Get file descriptor used by the control interface |
---|
433 | * @ctrl: Control interface data from wpa_ctrl_open() |
---|
434 | * Returns: File descriptor used for the connection |
---|
435 | * |
---|
436 | * This function can be used to get the file descriptor that is used for the |
---|
437 | * control interface connection. The returned value can be used, e.g., with |
---|
438 | * select() while waiting for multiple events. |
---|
439 | * |
---|
440 | * The returned file descriptor must not be used directly for sending or |
---|
441 | * receiving packets; instead, the library functions wpa_ctrl_request() and |
---|
442 | * wpa_ctrl_recv() must be used for this. |
---|
443 | */ |
---|
444 | int wpa_ctrl_get_fd(struct wpa_ctrl *ctrl); |
---|
445 | |
---|
446 | #ifdef ANDROID |
---|
447 | /** |
---|
448 | * wpa_ctrl_cleanup() - Delete any local UNIX domain socket files that |
---|
449 | * may be left over from clients that were previously connected to |
---|
450 | * wpa_supplicant. This keeps these files from being orphaned in the |
---|
451 | * event of crashes that prevented them from being removed as part |
---|
452 | * of the normal orderly shutdown. |
---|
453 | */ |
---|
454 | void wpa_ctrl_cleanup(void); |
---|
455 | #endif /* ANDROID */ |
---|
456 | |
---|
457 | #ifdef CONFIG_CTRL_IFACE_UDP |
---|
458 | /* Port range for multiple wpa_supplicant instances and multiple VIFs */ |
---|
459 | #define WPA_CTRL_IFACE_PORT 9877 |
---|
460 | #define WPA_CTRL_IFACE_PORT_LIMIT 50 /* decremented from start */ |
---|
461 | #define WPA_GLOBAL_CTRL_IFACE_PORT 9878 |
---|
462 | #define WPA_GLOBAL_CTRL_IFACE_PORT_LIMIT 20 /* incremented from start */ |
---|
463 | |
---|
464 | char * wpa_ctrl_get_remote_ifname(struct wpa_ctrl *ctrl); |
---|
465 | #endif /* CONFIG_CTRL_IFACE_UDP */ |
---|
466 | |
---|
467 | |
---|
468 | #ifdef __cplusplus |
---|
469 | } |
---|
470 | #endif |
---|
471 | |
---|
472 | #endif /* WPA_CTRL_H */ |
---|