wpa_supplicant / hostapd  2.5
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Pages
wpa_ctrl.h
Go to the documentation of this file.
1 
5 #ifndef WPA_CTRL_H
6 #define WPA_CTRL_H
7 
8 #ifdef __cplusplus
9 extern "C" {
10 #endif
11 
12 /* wpa_supplicant control interface - fixed message prefixes */
13 
15 #define WPA_CTRL_REQ "CTRL-REQ-"
16 
18 #define WPA_CTRL_RSP "CTRL-RSP-"
19 
20 /* Event messages with fixed prefix */
22 #define WPA_EVENT_CONNECTED "CTRL-EVENT-CONNECTED "
23 
24 #define WPA_EVENT_DISCONNECTED "CTRL-EVENT-DISCONNECTED "
25 
26 #define WPA_EVENT_ASSOC_REJECT "CTRL-EVENT-ASSOC-REJECT "
27 
28 #define WPA_EVENT_AUTH_REJECT "CTRL-EVENT-AUTH-REJECT "
29 
30 #define WPA_EVENT_TERMINATING "CTRL-EVENT-TERMINATING "
31 
32 #define WPA_EVENT_PASSWORD_CHANGED "CTRL-EVENT-PASSWORD-CHANGED "
33 
34 #define WPA_EVENT_EAP_NOTIFICATION "CTRL-EVENT-EAP-NOTIFICATION "
35 
36 #define WPA_EVENT_EAP_STARTED "CTRL-EVENT-EAP-STARTED "
37 
38 #define WPA_EVENT_EAP_PROPOSED_METHOD "CTRL-EVENT-EAP-PROPOSED-METHOD "
39 
40 #define WPA_EVENT_EAP_METHOD "CTRL-EVENT-EAP-METHOD "
41 
42 #define WPA_EVENT_EAP_PEER_CERT "CTRL-EVENT-EAP-PEER-CERT "
43 
44 #define WPA_EVENT_EAP_PEER_ALT "CTRL-EVENT-EAP-PEER-ALT "
45 
46 #define WPA_EVENT_EAP_TLS_CERT_ERROR "CTRL-EVENT-EAP-TLS-CERT-ERROR "
47 
48 #define WPA_EVENT_EAP_STATUS "CTRL-EVENT-EAP-STATUS "
49 
50 #define WPA_EVENT_EAP_SUCCESS "CTRL-EVENT-EAP-SUCCESS "
51 
52 #define WPA_EVENT_EAP_FAILURE "CTRL-EVENT-EAP-FAILURE "
53 
54 #define WPA_EVENT_TEMP_DISABLED "CTRL-EVENT-SSID-TEMP-DISABLED "
55 
56 #define WPA_EVENT_REENABLED "CTRL-EVENT-SSID-REENABLED "
57 
58 #define WPA_EVENT_SCAN_STARTED "CTRL-EVENT-SCAN-STARTED "
59 
60 #define WPA_EVENT_SCAN_RESULTS "CTRL-EVENT-SCAN-RESULTS "
61 
62 #define WPA_EVENT_SCAN_FAILED "CTRL-EVENT-SCAN-FAILED "
63 
64 #define WPA_EVENT_STATE_CHANGE "CTRL-EVENT-STATE-CHANGE "
65 
66 #define WPA_EVENT_BSS_ADDED "CTRL-EVENT-BSS-ADDED "
67 
68 #define WPA_EVENT_BSS_REMOVED "CTRL-EVENT-BSS-REMOVED "
69 
70 #define WPA_EVENT_NETWORK_NOT_FOUND "CTRL-EVENT-NETWORK-NOT-FOUND "
71 
72 #define WPA_EVENT_SIGNAL_CHANGE "CTRL-EVENT-SIGNAL-CHANGE "
73 
74 #define WPA_EVENT_REGDOM_CHANGE "CTRL-EVENT-REGDOM-CHANGE "
75 
77 #define IBSS_RSN_COMPLETED "IBSS-RSN-COMPLETED "
78 
84 #define WPA_EVENT_FREQ_CONFLICT "CTRL-EVENT-FREQ-CONFLICT "
85 
86 #define WPA_EVENT_AVOID_FREQ "CTRL-EVENT-AVOID-FREQ "
87 
88 #define WPS_EVENT_OVERLAP "WPS-OVERLAP-DETECTED "
89 
90 #define WPS_EVENT_AP_AVAILABLE_PBC "WPS-AP-AVAILABLE-PBC "
91 
92 #define WPS_EVENT_AP_AVAILABLE_AUTH "WPS-AP-AVAILABLE-AUTH "
93 
95 #define WPS_EVENT_AP_AVAILABLE_PIN "WPS-AP-AVAILABLE-PIN "
96 
97 #define WPS_EVENT_AP_AVAILABLE "WPS-AP-AVAILABLE "
98 
99 #define WPS_EVENT_CRED_RECEIVED "WPS-CRED-RECEIVED "
100 
101 #define WPS_EVENT_M2D "WPS-M2D "
102 
103 #define WPS_EVENT_FAIL "WPS-FAIL "
104 
105 #define WPS_EVENT_SUCCESS "WPS-SUCCESS "
106 
107 #define WPS_EVENT_TIMEOUT "WPS-TIMEOUT "
108 /* PBC mode was activated */
109 #define WPS_EVENT_ACTIVE "WPS-PBC-ACTIVE "
110 /* PBC mode was disabled */
111 #define WPS_EVENT_DISABLE "WPS-PBC-DISABLE "
112 
113 #define WPS_EVENT_ENROLLEE_SEEN "WPS-ENROLLEE-SEEN "
114 
115 #define WPS_EVENT_OPEN_NETWORK "WPS-OPEN-NETWORK "
116 
117 /* WPS ER events */
118 #define WPS_EVENT_ER_AP_ADD "WPS-ER-AP-ADD "
119 #define WPS_EVENT_ER_AP_REMOVE "WPS-ER-AP-REMOVE "
120 #define WPS_EVENT_ER_ENROLLEE_ADD "WPS-ER-ENROLLEE-ADD "
121 #define WPS_EVENT_ER_ENROLLEE_REMOVE "WPS-ER-ENROLLEE-REMOVE "
122 #define WPS_EVENT_ER_AP_SETTINGS "WPS-ER-AP-SETTINGS "
123 #define WPS_EVENT_ER_SET_SEL_REG "WPS-ER-AP-SET-SEL-REG "
124 
125 /* MESH events */
126 #define MESH_GROUP_STARTED "MESH-GROUP-STARTED "
127 #define MESH_GROUP_REMOVED "MESH-GROUP-REMOVED "
128 #define MESH_PEER_CONNECTED "MESH-PEER-CONNECTED "
129 #define MESH_PEER_DISCONNECTED "MESH-PEER-DISCONNECTED "
130 
131 #define MESH_SAE_AUTH_FAILURE "MESH-SAE-AUTH-FAILURE "
132 #define MESH_SAE_AUTH_BLOCKED "MESH-SAE-AUTH-BLOCKED "
133 
134 /* WMM AC events */
135 #define WMM_AC_EVENT_TSPEC_ADDED "TSPEC-ADDED "
136 #define WMM_AC_EVENT_TSPEC_REMOVED "TSPEC-REMOVED "
137 #define WMM_AC_EVENT_TSPEC_REQ_FAILED "TSPEC-REQ-FAILED "
138 
140 #define P2P_EVENT_DEVICE_FOUND "P2P-DEVICE-FOUND "
141 
143 #define P2P_EVENT_DEVICE_LOST "P2P-DEVICE-LOST "
144 
147 #define P2P_EVENT_GO_NEG_REQUEST "P2P-GO-NEG-REQUEST "
148 #define P2P_EVENT_GO_NEG_SUCCESS "P2P-GO-NEG-SUCCESS "
149 #define P2P_EVENT_GO_NEG_FAILURE "P2P-GO-NEG-FAILURE "
150 #define P2P_EVENT_GROUP_FORMATION_SUCCESS "P2P-GROUP-FORMATION-SUCCESS "
151 #define P2P_EVENT_GROUP_FORMATION_FAILURE "P2P-GROUP-FORMATION-FAILURE "
152 #define P2P_EVENT_GROUP_STARTED "P2P-GROUP-STARTED "
153 #define P2P_EVENT_GROUP_REMOVED "P2P-GROUP-REMOVED "
154 #define P2P_EVENT_CROSS_CONNECT_ENABLE "P2P-CROSS-CONNECT-ENABLE "
155 #define P2P_EVENT_CROSS_CONNECT_DISABLE "P2P-CROSS-CONNECT-DISABLE "
156 /* parameters: <peer address> <PIN> */
157 #define P2P_EVENT_PROV_DISC_SHOW_PIN "P2P-PROV-DISC-SHOW-PIN "
158 /* parameters: <peer address> */
159 #define P2P_EVENT_PROV_DISC_ENTER_PIN "P2P-PROV-DISC-ENTER-PIN "
160 /* parameters: <peer address> */
161 #define P2P_EVENT_PROV_DISC_PBC_REQ "P2P-PROV-DISC-PBC-REQ "
162 /* parameters: <peer address> */
163 #define P2P_EVENT_PROV_DISC_PBC_RESP "P2P-PROV-DISC-PBC-RESP "
164 /* parameters: <peer address> <status> */
165 #define P2P_EVENT_PROV_DISC_FAILURE "P2P-PROV-DISC-FAILURE"
166 /* parameters: <freq> <src addr> <dialog token> <update indicator> <TLVs> */
167 #define P2P_EVENT_SERV_DISC_REQ "P2P-SERV-DISC-REQ "
168 /* parameters: <src addr> <update indicator> <TLVs> */
169 #define P2P_EVENT_SERV_DISC_RESP "P2P-SERV-DISC-RESP "
170 #define P2P_EVENT_SERV_ASP_RESP "P2P-SERV-ASP-RESP "
171 #define P2P_EVENT_INVITATION_RECEIVED "P2P-INVITATION-RECEIVED "
172 #define P2P_EVENT_INVITATION_RESULT "P2P-INVITATION-RESULT "
173 #define P2P_EVENT_FIND_STOPPED "P2P-FIND-STOPPED "
174 #define P2P_EVENT_PERSISTENT_PSK_FAIL "P2P-PERSISTENT-PSK-FAIL id="
175 #define P2P_EVENT_PRESENCE_RESPONSE "P2P-PRESENCE-RESPONSE "
176 #define P2P_EVENT_NFC_BOTH_GO "P2P-NFC-BOTH-GO "
177 #define P2P_EVENT_NFC_PEER_CLIENT "P2P-NFC-PEER-CLIENT "
178 #define P2P_EVENT_NFC_WHILE_CLIENT "P2P-NFC-WHILE-CLIENT "
179 #define P2P_EVENT_FALLBACK_TO_GO_NEG "P2P-FALLBACK-TO-GO-NEG "
180 #define P2P_EVENT_FALLBACK_TO_GO_NEG_ENABLED "P2P-FALLBACK-TO-GO-NEG-ENABLED "
181 
182 /* parameters: <PMF enabled> <timeout in ms> <Session Information URL> */
183 #define ESS_DISASSOC_IMMINENT "ESS-DISASSOC-IMMINENT "
184 #define P2P_EVENT_REMOVE_AND_REFORM_GROUP "P2P-REMOVE-AND-REFORM-GROUP "
185 
186 #define P2P_EVENT_P2PS_PROVISION_START "P2PS-PROV-START "
187 #define P2P_EVENT_P2PS_PROVISION_DONE "P2PS-PROV-DONE "
188 
189 #define INTERWORKING_AP "INTERWORKING-AP "
190 #define INTERWORKING_BLACKLISTED "INTERWORKING-BLACKLISTED "
191 #define INTERWORKING_NO_MATCH "INTERWORKING-NO-MATCH "
192 #define INTERWORKING_ALREADY_CONNECTED "INTERWORKING-ALREADY-CONNECTED "
193 #define INTERWORKING_SELECTED "INTERWORKING-SELECTED "
194 
195 /* Credential block added; parameters: <id> */
196 #define CRED_ADDED "CRED-ADDED "
197 /* Credential block modified; parameters: <id> <field> */
198 #define CRED_MODIFIED "CRED-MODIFIED "
199 /* Credential block removed; parameters: <id> */
200 #define CRED_REMOVED "CRED-REMOVED "
201 
202 #define GAS_RESPONSE_INFO "GAS-RESPONSE-INFO "
203 /* parameters: <addr> <dialog_token> <freq> */
204 #define GAS_QUERY_START "GAS-QUERY-START "
205 /* parameters: <addr> <dialog_token> <freq> <status_code> <result> */
206 #define GAS_QUERY_DONE "GAS-QUERY-DONE "
207 
208 /* parameters: <addr> <result> */
209 #define ANQP_QUERY_DONE "ANQP-QUERY-DONE "
210 
211 #define HS20_SUBSCRIPTION_REMEDIATION "HS20-SUBSCRIPTION-REMEDIATION "
212 #define HS20_DEAUTH_IMMINENT_NOTICE "HS20-DEAUTH-IMMINENT-NOTICE "
213 
214 #define EXT_RADIO_WORK_START "EXT-RADIO-WORK-START "
215 #define EXT_RADIO_WORK_TIMEOUT "EXT-RADIO-WORK-TIMEOUT "
216 
217 #define RRM_EVENT_NEIGHBOR_REP_RXED "RRM-NEIGHBOR-REP-RECEIVED "
218 #define RRM_EVENT_NEIGHBOR_REP_FAILED "RRM-NEIGHBOR-REP-REQUEST-FAILED "
219 
220 /* hostapd control interface - fixed message prefixes */
221 #define WPS_EVENT_PIN_NEEDED "WPS-PIN-NEEDED "
222 #define WPS_EVENT_NEW_AP_SETTINGS "WPS-NEW-AP-SETTINGS "
223 #define WPS_EVENT_REG_SUCCESS "WPS-REG-SUCCESS "
224 #define WPS_EVENT_AP_SETUP_LOCKED "WPS-AP-SETUP-LOCKED "
225 #define WPS_EVENT_AP_SETUP_UNLOCKED "WPS-AP-SETUP-UNLOCKED "
226 #define WPS_EVENT_AP_PIN_ENABLED "WPS-AP-PIN-ENABLED "
227 #define WPS_EVENT_AP_PIN_DISABLED "WPS-AP-PIN-DISABLED "
228 #define AP_STA_CONNECTED "AP-STA-CONNECTED "
229 #define AP_STA_DISCONNECTED "AP-STA-DISCONNECTED "
230 #define AP_STA_POSSIBLE_PSK_MISMATCH "AP-STA-POSSIBLE-PSK-MISMATCH "
231 
232 #define AP_REJECTED_MAX_STA "AP-REJECTED-MAX-STA "
233 #define AP_REJECTED_BLOCKED_STA "AP-REJECTED-BLOCKED-STA "
234 
235 #define AP_EVENT_ENABLED "AP-ENABLED "
236 #define AP_EVENT_DISABLED "AP-DISABLED "
237 
238 #define INTERFACE_ENABLED "INTERFACE-ENABLED "
239 #define INTERFACE_DISABLED "INTERFACE-DISABLED "
240 
241 #define ACS_EVENT_STARTED "ACS-STARTED "
242 #define ACS_EVENT_COMPLETED "ACS-COMPLETED "
243 #define ACS_EVENT_FAILED "ACS-FAILED "
244 
245 #define DFS_EVENT_RADAR_DETECTED "DFS-RADAR-DETECTED "
246 #define DFS_EVENT_NEW_CHANNEL "DFS-NEW-CHANNEL "
247 #define DFS_EVENT_CAC_START "DFS-CAC-START "
248 #define DFS_EVENT_CAC_COMPLETED "DFS-CAC-COMPLETED "
249 #define DFS_EVENT_NOP_FINISHED "DFS-NOP-FINISHED "
250 
251 #define AP_CSA_FINISHED "AP-CSA-FINISHED "
252 
253 /* BSS Transition Management Response frame received */
254 #define BSS_TM_RESP "BSS-TM-RESP "
255 
256 /* BSS command information masks */
257 
258 #define WPA_BSS_MASK_ALL 0xFFFDFFFF
259 #define WPA_BSS_MASK_ID BIT(0)
260 #define WPA_BSS_MASK_BSSID BIT(1)
261 #define WPA_BSS_MASK_FREQ BIT(2)
262 #define WPA_BSS_MASK_BEACON_INT BIT(3)
263 #define WPA_BSS_MASK_CAPABILITIES BIT(4)
264 #define WPA_BSS_MASK_QUAL BIT(5)
265 #define WPA_BSS_MASK_NOISE BIT(6)
266 #define WPA_BSS_MASK_LEVEL BIT(7)
267 #define WPA_BSS_MASK_TSF BIT(8)
268 #define WPA_BSS_MASK_AGE BIT(9)
269 #define WPA_BSS_MASK_IE BIT(10)
270 #define WPA_BSS_MASK_FLAGS BIT(11)
271 #define WPA_BSS_MASK_SSID BIT(12)
272 #define WPA_BSS_MASK_WPS_SCAN BIT(13)
273 #define WPA_BSS_MASK_P2P_SCAN BIT(14)
274 #define WPA_BSS_MASK_INTERNETW BIT(15)
275 #define WPA_BSS_MASK_WIFI_DISPLAY BIT(16)
276 #define WPA_BSS_MASK_DELIM BIT(17)
277 #define WPA_BSS_MASK_MESH_SCAN BIT(18)
278 #define WPA_BSS_MASK_SNR BIT(19)
279 #define WPA_BSS_MASK_EST_THROUGHPUT BIT(20)
280 #define WPA_BSS_MASK_FST BIT(21)
281 
282 
283 /* VENDOR_ELEM_* frame id values */
284 enum wpa_vendor_elem_frame {
285  VENDOR_ELEM_PROBE_REQ_P2P = 0,
286  VENDOR_ELEM_PROBE_RESP_P2P = 1,
287  VENDOR_ELEM_PROBE_RESP_P2P_GO = 2,
288  VENDOR_ELEM_BEACON_P2P_GO = 3,
289  VENDOR_ELEM_P2P_PD_REQ = 4,
290  VENDOR_ELEM_P2P_PD_RESP = 5,
291  VENDOR_ELEM_P2P_GO_NEG_REQ = 6,
292  VENDOR_ELEM_P2P_GO_NEG_RESP = 7,
293  VENDOR_ELEM_P2P_GO_NEG_CONF = 8,
294  VENDOR_ELEM_P2P_INV_REQ = 9,
295  VENDOR_ELEM_P2P_INV_RESP = 10,
296  VENDOR_ELEM_P2P_ASSOC_REQ = 11,
297  VENDOR_ELEM_P2P_ASSOC_RESP = 12,
298  VENDOR_ELEM_ASSOC_REQ = 13,
299  NUM_VENDOR_ELEM_FRAMES
300 };
301 
302 
303 /* wpa_supplicant/hostapd control interface access */
304 
315 struct wpa_ctrl * wpa_ctrl_open(const char *ctrl_path);
316 
329 struct wpa_ctrl * wpa_ctrl_open2(const char *ctrl_path, const char *cli_path);
330 
331 
338 void wpa_ctrl_close(struct wpa_ctrl *ctrl);
339 
340 
367 int wpa_ctrl_request(struct wpa_ctrl *ctrl, const char *cmd, size_t cmd_len,
368  char *reply, size_t *reply_len,
369  void (*msg_cb)(char *msg, size_t len));
370 
371 
382 int wpa_ctrl_attach(struct wpa_ctrl *ctrl);
383 
384 
394 int wpa_ctrl_detach(struct wpa_ctrl *ctrl);
395 
396 
411 int wpa_ctrl_recv(struct wpa_ctrl *ctrl, char *reply, size_t *reply_len);
412 
413 
424 int wpa_ctrl_pending(struct wpa_ctrl *ctrl);
425 
426 
440 int wpa_ctrl_get_fd(struct wpa_ctrl *ctrl);
441 
442 #ifdef ANDROID
443 
450 void wpa_ctrl_cleanup(void);
451 #endif /* ANDROID */
452 
453 #ifdef CONFIG_CTRL_IFACE_UDP
454 /* Port range for multiple wpa_supplicant instances and multiple VIFs */
455 #define WPA_CTRL_IFACE_PORT 9877
456 #define WPA_CTRL_IFACE_PORT_LIMIT 50 /* decremented from start */
457 #define WPA_GLOBAL_CTRL_IFACE_PORT 9878
458 #define WPA_GLOBAL_CTRL_IFACE_PORT_LIMIT 20 /* incremented from start */
459 
460 char * wpa_ctrl_get_remote_ifname(struct wpa_ctrl *ctrl);
461 #endif /* CONFIG_CTRL_IFACE_UDP */
462 
463 
464 #ifdef __cplusplus
465 }
466 #endif
467 
468 #endif /* WPA_CTRL_H */
int wpa_ctrl_pending(struct wpa_ctrl *ctrl)
Check whether there are pending event messages.
int wpa_ctrl_request(struct wpa_ctrl *ctrl, const char *cmd, size_t cmd_len, char *reply, size_t *reply_len, void(*msg_cb)(char *msg, size_t len))
Send a command to wpa_supplicant/hostapd.
void wpa_ctrl_close(struct wpa_ctrl *ctrl)
Close a control interface to wpa_supplicant/hostapd.
int wpa_ctrl_attach(struct wpa_ctrl *ctrl)
Register as an event monitor for the control interface.
Definition: wpa_ctrl.c:580
struct wpa_ctrl * wpa_ctrl_open2(const char *ctrl_path, const char *cli_path)
Open a control interface to wpa_supplicant/hostapd.
struct wpa_ctrl * wpa_ctrl_open(const char *ctrl_path)
Open a control interface to wpa_supplicant/hostapd.
int wpa_ctrl_recv(struct wpa_ctrl *ctrl, char *reply, size_t *reply_len)
Receive a pending control interface message.
Internal structure for control interface library.
Definition: wpa_ctrl.c:48
int wpa_ctrl_detach(struct wpa_ctrl *ctrl)
Unregister event monitor from the control interface.
Definition: wpa_ctrl.c:586
int wpa_ctrl_get_fd(struct wpa_ctrl *ctrl)
Get file descriptor used by the control interface.