]>
Commit | Line | Data |
---|---|---|
6fc6879b JM |
1 | /* |
2 | * wpa_supplicant/hostapd control interface library | |
3 | * Copyright (c) 2004-2006, Jouni Malinen <j@w1.fi> | |
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 | |
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 " | |
ea78c315 JM |
29 | /** Association rejected during connection attempt */ |
30 | #define WPA_EVENT_ASSOC_REJECT "CTRL-EVENT-ASSOC-REJECT " | |
6fc6879b JM |
31 | /** wpa_supplicant is exiting */ |
32 | #define WPA_EVENT_TERMINATING "CTRL-EVENT-TERMINATING " | |
33 | /** Password change was completed successfully */ | |
34 | #define WPA_EVENT_PASSWORD_CHANGED "CTRL-EVENT-PASSWORD-CHANGED " | |
35 | /** EAP-Request/Notification received */ | |
36 | #define WPA_EVENT_EAP_NOTIFICATION "CTRL-EVENT-EAP-NOTIFICATION " | |
37 | /** EAP authentication started (EAP-Request/Identity received) */ | |
38 | #define WPA_EVENT_EAP_STARTED "CTRL-EVENT-EAP-STARTED " | |
7796f20e JM |
39 | /** EAP method proposed by the server */ |
40 | #define WPA_EVENT_EAP_PROPOSED_METHOD "CTRL-EVENT-EAP-PROPOSED-METHOD " | |
6fc6879b JM |
41 | /** EAP method selected */ |
42 | #define WPA_EVENT_EAP_METHOD "CTRL-EVENT-EAP-METHOD " | |
00468b46 JM |
43 | /** EAP peer certificate from TLS */ |
44 | #define WPA_EVENT_EAP_PEER_CERT "CTRL-EVENT-EAP-PEER-CERT " | |
45 | /** EAP TLS certificate chain validation error */ | |
46 | #define WPA_EVENT_EAP_TLS_CERT_ERROR "CTRL-EVENT-EAP-TLS-CERT-ERROR " | |
6fc6879b JM |
47 | /** EAP authentication completed successfully */ |
48 | #define WPA_EVENT_EAP_SUCCESS "CTRL-EVENT-EAP-SUCCESS " | |
49 | /** EAP authentication failed (EAP-Failure received) */ | |
50 | #define WPA_EVENT_EAP_FAILURE "CTRL-EVENT-EAP-FAILURE " | |
00e5e3d5 JM |
51 | /** Network block temporarily disabled (e.g., due to authentication failure) */ |
52 | #define WPA_EVENT_TEMP_DISABLED "CTRL-EVENT-SSID-TEMP-DISABLED " | |
53 | /** Temporarily disabled network block re-enabled */ | |
54 | #define WPA_EVENT_REENABLED "CTRL-EVENT-SSID-REENABLED " | |
6fc6879b JM |
55 | /** New scan results available */ |
56 | #define WPA_EVENT_SCAN_RESULTS "CTRL-EVENT-SCAN-RESULTS " | |
4e2ead7a DS |
57 | /** wpa_supplicant state change */ |
58 | #define WPA_EVENT_STATE_CHANGE "CTRL-EVENT-STATE-CHANGE " | |
b590812e | 59 | /** A new BSS entry was added (followed by BSS entry id and BSSID) */ |
f0d126d3 | 60 | #define WPA_EVENT_BSS_ADDED "CTRL-EVENT-BSS-ADDED " |
b590812e | 61 | /** A BSS entry was removed (followed by BSS entry id and BSSID) */ |
f0d126d3 | 62 | #define WPA_EVENT_BSS_REMOVED "CTRL-EVENT-BSS-REMOVED " |
6fc6879b | 63 | |
a524f05e | 64 | /** WPS overlap detected in PBC mode */ |
ad08c363 | 65 | #define WPS_EVENT_OVERLAP "WPS-OVERLAP-DETECTED " |
a524f05e JM |
66 | /** Available WPS AP with active PBC found in scan results */ |
67 | #define WPS_EVENT_AP_AVAILABLE_PBC "WPS-AP-AVAILABLE-PBC " | |
31fcea93 JM |
68 | /** Available WPS AP with our address as authorized in scan results */ |
69 | #define WPS_EVENT_AP_AVAILABLE_AUTH "WPS-AP-AVAILABLE-AUTH " | |
a524f05e JM |
70 | /** Available WPS AP with recently selected PIN registrar found in scan results |
71 | */ | |
72 | #define WPS_EVENT_AP_AVAILABLE_PIN "WPS-AP-AVAILABLE-PIN " | |
73 | /** Available WPS AP found in scan results */ | |
74 | #define WPS_EVENT_AP_AVAILABLE "WPS-AP-AVAILABLE " | |
ff8a53a8 JM |
75 | /** A new credential received */ |
76 | #define WPS_EVENT_CRED_RECEIVED "WPS-CRED-RECEIVED " | |
4b68290e JM |
77 | /** M2D received */ |
78 | #define WPS_EVENT_M2D "WPS-M2D " | |
469fc3a4 JM |
79 | /** WPS registration failed after M2/M2D */ |
80 | #define WPS_EVENT_FAIL "WPS-FAIL " | |
ad5302a1 JM |
81 | /** WPS registration completed successfully */ |
82 | #define WPS_EVENT_SUCCESS "WPS-SUCCESS " | |
a6099152 JM |
83 | /** WPS enrollment attempt timed out and was terminated */ |
84 | #define WPS_EVENT_TIMEOUT "WPS-TIMEOUT " | |
ad08c363 | 85 | |
c2f51269 JM |
86 | #define WPS_EVENT_ENROLLEE_SEEN "WPS-ENROLLEE-SEEN " |
87 | ||
f981eabc JM |
88 | #define WPS_EVENT_OPEN_NETWORK "WPS-OPEN-NETWORK " |
89 | ||
b78bc3a3 JM |
90 | /* WPS ER events */ |
91 | #define WPS_EVENT_ER_AP_ADD "WPS-ER-AP-ADD " | |
92 | #define WPS_EVENT_ER_AP_REMOVE "WPS-ER-AP-REMOVE " | |
93 | #define WPS_EVENT_ER_ENROLLEE_ADD "WPS-ER-ENROLLEE-ADD " | |
94 | #define WPS_EVENT_ER_ENROLLEE_REMOVE "WPS-ER-ENROLLEE-REMOVE " | |
15dbf129 | 95 | #define WPS_EVENT_ER_AP_SETTINGS "WPS-ER-AP-SETTINGS " |
3e7533b3 | 96 | #define WPS_EVENT_ER_SET_SEL_REG "WPS-ER-AP-SET-SEL-REG " |
b78bc3a3 | 97 | |
b22128ef JM |
98 | /** P2P device found */ |
99 | #define P2P_EVENT_DEVICE_FOUND "P2P-DEVICE-FOUND " | |
3074d8f1 JJ |
100 | |
101 | /** P2P device lost */ | |
102 | #define P2P_EVENT_DEVICE_LOST "P2P-DEVICE-LOST " | |
103 | ||
b22128ef JM |
104 | /** A P2P device requested GO negotiation, but we were not ready to start the |
105 | * negotiation */ | |
106 | #define P2P_EVENT_GO_NEG_REQUEST "P2P-GO-NEG-REQUEST " | |
107 | #define P2P_EVENT_GO_NEG_SUCCESS "P2P-GO-NEG-SUCCESS " | |
108 | #define P2P_EVENT_GO_NEG_FAILURE "P2P-GO-NEG-FAILURE " | |
109 | #define P2P_EVENT_GROUP_FORMATION_SUCCESS "P2P-GROUP-FORMATION-SUCCESS " | |
110 | #define P2P_EVENT_GROUP_FORMATION_FAILURE "P2P-GROUP-FORMATION-FAILURE " | |
111 | #define P2P_EVENT_GROUP_STARTED "P2P-GROUP-STARTED " | |
112 | #define P2P_EVENT_GROUP_REMOVED "P2P-GROUP-REMOVED " | |
72044390 JM |
113 | #define P2P_EVENT_CROSS_CONNECT_ENABLE "P2P-CROSS-CONNECT-ENABLE " |
114 | #define P2P_EVENT_CROSS_CONNECT_DISABLE "P2P-CROSS-CONNECT-DISABLE " | |
b22128ef JM |
115 | /* parameters: <peer address> <PIN> */ |
116 | #define P2P_EVENT_PROV_DISC_SHOW_PIN "P2P-PROV-DISC-SHOW-PIN " | |
117 | /* parameters: <peer address> */ | |
118 | #define P2P_EVENT_PROV_DISC_ENTER_PIN "P2P-PROV-DISC-ENTER-PIN " | |
119 | /* parameters: <peer address> */ | |
120 | #define P2P_EVENT_PROV_DISC_PBC_REQ "P2P-PROV-DISC-PBC-REQ " | |
121 | /* parameters: <peer address> */ | |
122 | #define P2P_EVENT_PROV_DISC_PBC_RESP "P2P-PROV-DISC-PBC-RESP " | |
f65a239b DG |
123 | /* parameters: <peer address> <status> */ |
124 | #define P2P_EVENT_PROV_DISC_FAILURE "P2P-PROV-DISC-FAILURE" | |
b22128ef JM |
125 | /* parameters: <freq> <src addr> <dialog token> <update indicator> <TLVs> */ |
126 | #define P2P_EVENT_SERV_DISC_REQ "P2P-SERV-DISC-REQ " | |
127 | /* parameters: <src addr> <update indicator> <TLVs> */ | |
128 | #define P2P_EVENT_SERV_DISC_RESP "P2P-SERV-DISC-RESP " | |
129 | #define P2P_EVENT_INVITATION_RECEIVED "P2P-INVITATION-RECEIVED " | |
130 | #define P2P_EVENT_INVITATION_RESULT "P2P-INVITATION-RESULT " | |
8aebb0e4 | 131 | #define P2P_EVENT_FIND_STOPPED "P2P-FIND-STOPPED " |
b22128ef | 132 | |
b02fe7ff JM |
133 | #define INTERWORKING_AP "INTERWORKING-AP " |
134 | #define INTERWORKING_NO_MATCH "INTERWORKING-NO-MATCH " | |
135 | ||
ad08c363 JM |
136 | /* hostapd control interface - fixed message prefixes */ |
137 | #define WPS_EVENT_PIN_NEEDED "WPS-PIN-NEEDED " | |
138 | #define WPS_EVENT_NEW_AP_SETTINGS "WPS-NEW-AP-SETTINGS " | |
aabe26a1 | 139 | #define WPS_EVENT_REG_SUCCESS "WPS-REG-SUCCESS " |
3b2cf800 | 140 | #define WPS_EVENT_AP_SETUP_LOCKED "WPS-AP-SETUP-LOCKED " |
94481410 | 141 | #define WPS_EVENT_AP_SETUP_UNLOCKED "WPS-AP-SETUP-UNLOCKED " |
5a1cc30f JM |
142 | #define WPS_EVENT_AP_PIN_ENABLED "WPS-AP-PIN-ENABLED " |
143 | #define WPS_EVENT_AP_PIN_DISABLED "WPS-AP-PIN-DISABLED " | |
20bd9547 JM |
144 | #define AP_STA_CONNECTED "AP-STA-CONNECTED " |
145 | #define AP_STA_DISCONNECTED "AP-STA-DISCONNECTED " | |
ad08c363 | 146 | |
6fc6879b | 147 | |
5f97dd1c DS |
148 | /* BSS command information masks */ |
149 | ||
150 | #define WPA_BSS_MASK_ALL 0xFFFFFFFF | |
151 | #define WPA_BSS_MASK_ID BIT(0) | |
152 | #define WPA_BSS_MASK_BSSID BIT(1) | |
153 | #define WPA_BSS_MASK_FREQ BIT(2) | |
154 | #define WPA_BSS_MASK_BEACON_INT BIT(3) | |
155 | #define WPA_BSS_MASK_CAPABILITIES BIT(4) | |
156 | #define WPA_BSS_MASK_QUAL BIT(5) | |
157 | #define WPA_BSS_MASK_NOISE BIT(6) | |
158 | #define WPA_BSS_MASK_LEVEL BIT(7) | |
159 | #define WPA_BSS_MASK_TSF BIT(8) | |
160 | #define WPA_BSS_MASK_AGE BIT(9) | |
161 | #define WPA_BSS_MASK_IE BIT(10) | |
162 | #define WPA_BSS_MASK_FLAGS BIT(11) | |
163 | #define WPA_BSS_MASK_SSID BIT(12) | |
164 | #define WPA_BSS_MASK_WPS_SCAN BIT(13) | |
165 | #define WPA_BSS_MASK_P2P_SCAN BIT(14) | |
166 | #define WPA_BSS_MASK_INTERNETW BIT(15) | |
167 | ||
168 | ||
6fc6879b JM |
169 | /* wpa_supplicant/hostapd control interface access */ |
170 | ||
171 | /** | |
172 | * wpa_ctrl_open - Open a control interface to wpa_supplicant/hostapd | |
173 | * @ctrl_path: Path for UNIX domain sockets; ignored if UDP sockets are used. | |
174 | * Returns: Pointer to abstract control interface data or %NULL on failure | |
175 | * | |
176 | * This function is used to open a control interface to wpa_supplicant/hostapd. | |
177 | * ctrl_path is usually /var/run/wpa_supplicant or /var/run/hostapd. This path | |
178 | * is configured in wpa_supplicant/hostapd and other programs using the control | |
179 | * interface need to use matching path configuration. | |
180 | */ | |
181 | struct wpa_ctrl * wpa_ctrl_open(const char *ctrl_path); | |
182 | ||
183 | ||
184 | /** | |
185 | * wpa_ctrl_close - Close a control interface to wpa_supplicant/hostapd | |
186 | * @ctrl: Control interface data from wpa_ctrl_open() | |
187 | * | |
188 | * This function is used to close a control interface. | |
189 | */ | |
190 | void wpa_ctrl_close(struct wpa_ctrl *ctrl); | |
191 | ||
192 | ||
193 | /** | |
194 | * wpa_ctrl_request - Send a command to wpa_supplicant/hostapd | |
195 | * @ctrl: Control interface data from wpa_ctrl_open() | |
196 | * @cmd: Command; usually, ASCII text, e.g., "PING" | |
197 | * @cmd_len: Length of the cmd in bytes | |
198 | * @reply: Buffer for the response | |
199 | * @reply_len: Reply buffer length | |
200 | * @msg_cb: Callback function for unsolicited messages or %NULL if not used | |
201 | * Returns: 0 on success, -1 on error (send or receive failed), -2 on timeout | |
202 | * | |
203 | * This function is used to send commands to wpa_supplicant/hostapd. Received | |
204 | * response will be written to reply and reply_len is set to the actual length | |
205 | * of the reply. This function will block for up to two seconds while waiting | |
206 | * for the reply. If unsolicited messages are received, the blocking time may | |
207 | * be longer. | |
208 | * | |
209 | * msg_cb can be used to register a callback function that will be called for | |
210 | * unsolicited messages received while waiting for the command response. These | |
211 | * messages may be received if wpa_ctrl_request() is called at the same time as | |
212 | * wpa_supplicant/hostapd is sending such a message. This can happen only if | |
213 | * the program has used wpa_ctrl_attach() to register itself as a monitor for | |
214 | * event messages. Alternatively to msg_cb, programs can register two control | |
215 | * interface connections and use one of them for commands and the other one for | |
216 | * receiving event messages, in other words, call wpa_ctrl_attach() only for | |
217 | * the control interface connection that will be used for event messages. | |
218 | */ | |
219 | int wpa_ctrl_request(struct wpa_ctrl *ctrl, const char *cmd, size_t cmd_len, | |
220 | char *reply, size_t *reply_len, | |
221 | void (*msg_cb)(char *msg, size_t len)); | |
222 | ||
223 | ||
224 | /** | |
225 | * wpa_ctrl_attach - Register as an event monitor for the control interface | |
226 | * @ctrl: Control interface data from wpa_ctrl_open() | |
227 | * Returns: 0 on success, -1 on failure, -2 on timeout | |
228 | * | |
229 | * This function registers the control interface connection as a monitor for | |
230 | * wpa_supplicant/hostapd events. After a success wpa_ctrl_attach() call, the | |
231 | * control interface connection starts receiving event messages that can be | |
232 | * read with wpa_ctrl_recv(). | |
233 | */ | |
234 | int wpa_ctrl_attach(struct wpa_ctrl *ctrl); | |
235 | ||
236 | ||
237 | /** | |
238 | * wpa_ctrl_detach - Unregister event monitor from the control interface | |
239 | * @ctrl: Control interface data from wpa_ctrl_open() | |
240 | * Returns: 0 on success, -1 on failure, -2 on timeout | |
241 | * | |
242 | * This function unregisters the control interface connection as a monitor for | |
243 | * wpa_supplicant/hostapd events, i.e., cancels the registration done with | |
244 | * wpa_ctrl_attach(). | |
245 | */ | |
246 | int wpa_ctrl_detach(struct wpa_ctrl *ctrl); | |
247 | ||
248 | ||
249 | /** | |
250 | * wpa_ctrl_recv - Receive a pending control interface message | |
251 | * @ctrl: Control interface data from wpa_ctrl_open() | |
252 | * @reply: Buffer for the message data | |
253 | * @reply_len: Length of the reply buffer | |
254 | * Returns: 0 on success, -1 on failure | |
255 | * | |
256 | * This function will receive a pending control interface message. This | |
257 | * function will block if no messages are available. The received response will | |
258 | * be written to reply and reply_len is set to the actual length of the reply. | |
259 | * wpa_ctrl_recv() is only used for event messages, i.e., wpa_ctrl_attach() | |
260 | * must have been used to register the control interface as an event monitor. | |
261 | */ | |
262 | int wpa_ctrl_recv(struct wpa_ctrl *ctrl, char *reply, size_t *reply_len); | |
263 | ||
264 | ||
265 | /** | |
266 | * wpa_ctrl_pending - Check whether there are pending event messages | |
267 | * @ctrl: Control interface data from wpa_ctrl_open() | |
268 | * Returns: 1 if there are pending messages, 0 if no, or -1 on error | |
269 | * | |
270 | * This function will check whether there are any pending control interface | |
271 | * message available to be received with wpa_ctrl_recv(). wpa_ctrl_pending() is | |
272 | * only used for event messages, i.e., wpa_ctrl_attach() must have been used to | |
273 | * register the control interface as an event monitor. | |
274 | */ | |
275 | int wpa_ctrl_pending(struct wpa_ctrl *ctrl); | |
276 | ||
277 | ||
278 | /** | |
279 | * wpa_ctrl_get_fd - Get file descriptor used by the control interface | |
280 | * @ctrl: Control interface data from wpa_ctrl_open() | |
281 | * Returns: File descriptor used for the connection | |
282 | * | |
283 | * This function can be used to get the file descriptor that is used for the | |
284 | * control interface connection. The returned value can be used, e.g., with | |
285 | * select() while waiting for multiple events. | |
286 | * | |
287 | * The returned file descriptor must not be used directly for sending or | |
288 | * receiving packets; instead, the library functions wpa_ctrl_request() and | |
289 | * wpa_ctrl_recv() must be used for this. | |
290 | */ | |
291 | int wpa_ctrl_get_fd(struct wpa_ctrl *ctrl); | |
292 | ||
4307bb8c JD |
293 | char * wpa_ctrl_get_remote_ifname(struct wpa_ctrl *ctrl); |
294 | ||
ed3eecd7 DS |
295 | #ifdef ANDROID |
296 | /** | |
297 | * wpa_ctrl_cleanup() - Delete any local UNIX domain socket files that | |
298 | * may be left over from clients that were previously connected to | |
299 | * wpa_supplicant. This keeps these files from being orphaned in the | |
300 | * event of crashes that prevented them from being removed as part | |
301 | * of the normal orderly shutdown. | |
302 | */ | |
303 | void wpa_ctrl_cleanup(void); | |
304 | #endif /* ANDROID */ | |
305 | ||
6fc6879b | 306 | #ifdef CONFIG_CTRL_IFACE_UDP |
afadf423 | 307 | /* Port range for multiple wpa_supplicant instances and multiple VIFs */ |
6fc6879b | 308 | #define WPA_CTRL_IFACE_PORT 9877 |
afadf423 | 309 | #define WPA_CTRL_IFACE_PORT_LIMIT 50 /* decremented from start */ |
6fc6879b | 310 | #define WPA_GLOBAL_CTRL_IFACE_PORT 9878 |
afadf423 | 311 | #define WPA_GLOBAL_CTRL_IFACE_PORT_LIMIT 20 /* incremented from start */ |
6fc6879b JM |
312 | #endif /* CONFIG_CTRL_IFACE_UDP */ |
313 | ||
314 | ||
315 | #ifdef __cplusplus | |
316 | } | |
317 | #endif | |
318 | ||
319 | #endif /* WPA_CTRL_H */ |