2 * wpa_supplicant/hostapd control interface library
3 * Copyright (c) 2004-2006, Jouni Malinen <j@w1.fi>
5 * This software may be distributed under the terms of the BSD license.
6 * See README for more details.
16 /* wpa_supplicant control interface - fixed message prefixes */
18 /** Interactive request for identity/password/pin */
19 #define WPA_CTRL_REQ "CTRL-REQ-"
21 /** Response to identity/password/pin request */
22 #define WPA_CTRL_RSP "CTRL-RSP-"
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 /** 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 "
39 /** EAP method proposed by the server */
40 #define WPA_EVENT_EAP_PROPOSED_METHOD "CTRL-EVENT-EAP-PROPOSED-METHOD "
41 /** EAP method selected */
42 #define WPA_EVENT_EAP_METHOD "CTRL-EVENT-EAP-METHOD "
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 "
48 #define WPA_EVENT_EAP_STATUS "CTRL-EVENT-EAP-STATUS "
49 /** EAP authentication completed successfully */
50 #define WPA_EVENT_EAP_SUCCESS "CTRL-EVENT-EAP-SUCCESS "
51 /** EAP authentication failed (EAP-Failure received) */
52 #define WPA_EVENT_EAP_FAILURE "CTRL-EVENT-EAP-FAILURE "
53 /** Network block temporarily disabled (e.g., due to authentication failure) */
54 #define WPA_EVENT_TEMP_DISABLED "CTRL-EVENT-SSID-TEMP-DISABLED "
55 /** Temporarily disabled network block re-enabled */
56 #define WPA_EVENT_REENABLED "CTRL-EVENT-SSID-REENABLED "
57 /** New scan started */
58 #define WPA_EVENT_SCAN_STARTED "CTRL-EVENT-SCAN-STARTED "
59 /** New scan results available */
60 #define WPA_EVENT_SCAN_RESULTS "CTRL-EVENT-SCAN-RESULTS "
61 /** wpa_supplicant state change */
62 #define WPA_EVENT_STATE_CHANGE "CTRL-EVENT-STATE-CHANGE "
63 /** A new BSS entry was added (followed by BSS entry id and BSSID) */
64 #define WPA_EVENT_BSS_ADDED "CTRL-EVENT-BSS-ADDED "
65 /** A BSS entry was removed (followed by BSS entry id and BSSID) */
66 #define WPA_EVENT_BSS_REMOVED "CTRL-EVENT-BSS-REMOVED "
68 /** RSN IBSS 4-way handshakes completed with specified peer */
69 #define IBSS_RSN_COMPLETED "IBSS-RSN-COMPLETED "
71 /** Notification of frequency conflict due to a concurrent operation.
73 * The indicated network is disabled and needs to be re-enabled before it can
76 #define WPA_EVENT_FREQ_CONFLICT "CTRL-EVENT-FREQ-CONFLICT "
77 /** Frequency ranges that the driver recommends to avoid */
78 #define WPA_EVENT_AVOID_FREQ "CTRL-EVENT-AVOID-FREQ "
79 /** WPS overlap detected in PBC mode */
80 #define WPS_EVENT_OVERLAP "WPS-OVERLAP-DETECTED "
81 /** Available WPS AP with active PBC found in scan results */
82 #define WPS_EVENT_AP_AVAILABLE_PBC "WPS-AP-AVAILABLE-PBC "
83 /** Available WPS AP with our address as authorized in scan results */
84 #define WPS_EVENT_AP_AVAILABLE_AUTH "WPS-AP-AVAILABLE-AUTH "
85 /** Available WPS AP with recently selected PIN registrar found in scan results
87 #define WPS_EVENT_AP_AVAILABLE_PIN "WPS-AP-AVAILABLE-PIN "
88 /** Available WPS AP found in scan results */
89 #define WPS_EVENT_AP_AVAILABLE "WPS-AP-AVAILABLE "
90 /** A new credential received */
91 #define WPS_EVENT_CRED_RECEIVED "WPS-CRED-RECEIVED "
93 #define WPS_EVENT_M2D "WPS-M2D "
94 /** WPS registration failed after M2/M2D */
95 #define WPS_EVENT_FAIL "WPS-FAIL "
96 /** WPS registration completed successfully */
97 #define WPS_EVENT_SUCCESS "WPS-SUCCESS "
98 /** WPS enrollment attempt timed out and was terminated */
99 #define WPS_EVENT_TIMEOUT "WPS-TIMEOUT "
100 /* PBC mode was activated */
101 #define WPS_EVENT_ACTIVE "WPS-PBC-ACTIVE "
102 /* PBC mode was disabled */
103 #define WPS_EVENT_DISABLE "WPS-PBC-DISABLE "
105 #define WPS_EVENT_ENROLLEE_SEEN "WPS-ENROLLEE-SEEN "
107 #define WPS_EVENT_OPEN_NETWORK "WPS-OPEN-NETWORK "
110 #define WPS_EVENT_ER_AP_ADD "WPS-ER-AP-ADD "
111 #define WPS_EVENT_ER_AP_REMOVE "WPS-ER-AP-REMOVE "
112 #define WPS_EVENT_ER_ENROLLEE_ADD "WPS-ER-ENROLLEE-ADD "
113 #define WPS_EVENT_ER_ENROLLEE_REMOVE "WPS-ER-ENROLLEE-REMOVE "
114 #define WPS_EVENT_ER_AP_SETTINGS "WPS-ER-AP-SETTINGS "
115 #define WPS_EVENT_ER_SET_SEL_REG "WPS-ER-AP-SET-SEL-REG "
117 /** P2P device found */
118 #define P2P_EVENT_DEVICE_FOUND "P2P-DEVICE-FOUND "
120 /** P2P device lost */
121 #define P2P_EVENT_DEVICE_LOST "P2P-DEVICE-LOST "
123 /** A P2P device requested GO negotiation, but we were not ready to start the
125 #define P2P_EVENT_GO_NEG_REQUEST "P2P-GO-NEG-REQUEST "
126 #define P2P_EVENT_GO_NEG_SUCCESS "P2P-GO-NEG-SUCCESS "
127 #define P2P_EVENT_GO_NEG_FAILURE "P2P-GO-NEG-FAILURE "
128 #define P2P_EVENT_GROUP_FORMATION_SUCCESS "P2P-GROUP-FORMATION-SUCCESS "
129 #define P2P_EVENT_GROUP_FORMATION_FAILURE "P2P-GROUP-FORMATION-FAILURE "
130 #define P2P_EVENT_GROUP_STARTED "P2P-GROUP-STARTED "
131 #define P2P_EVENT_GROUP_REMOVED "P2P-GROUP-REMOVED "
132 #define P2P_EVENT_CROSS_CONNECT_ENABLE "P2P-CROSS-CONNECT-ENABLE "
133 #define P2P_EVENT_CROSS_CONNECT_DISABLE "P2P-CROSS-CONNECT-DISABLE "
134 /* parameters: <peer address> <PIN> */
135 #define P2P_EVENT_PROV_DISC_SHOW_PIN "P2P-PROV-DISC-SHOW-PIN "
136 /* parameters: <peer address> */
137 #define P2P_EVENT_PROV_DISC_ENTER_PIN "P2P-PROV-DISC-ENTER-PIN "
138 /* parameters: <peer address> */
139 #define P2P_EVENT_PROV_DISC_PBC_REQ "P2P-PROV-DISC-PBC-REQ "
140 /* parameters: <peer address> */
141 #define P2P_EVENT_PROV_DISC_PBC_RESP "P2P-PROV-DISC-PBC-RESP "
142 /* parameters: <peer address> <status> */
143 #define P2P_EVENT_PROV_DISC_FAILURE "P2P-PROV-DISC-FAILURE"
144 /* parameters: <freq> <src addr> <dialog token> <update indicator> <TLVs> */
145 #define P2P_EVENT_SERV_DISC_REQ "P2P-SERV-DISC-REQ "
146 /* parameters: <src addr> <update indicator> <TLVs> */
147 #define P2P_EVENT_SERV_DISC_RESP "P2P-SERV-DISC-RESP "
148 #define P2P_EVENT_INVITATION_RECEIVED "P2P-INVITATION-RECEIVED "
149 #define P2P_EVENT_INVITATION_RESULT "P2P-INVITATION-RESULT "
150 #define P2P_EVENT_FIND_STOPPED "P2P-FIND-STOPPED "
151 #define P2P_EVENT_PERSISTENT_PSK_FAIL "P2P-PERSISTENT-PSK-FAIL id="
152 #define P2P_EVENT_PRESENCE_RESPONSE "P2P-PRESENCE-RESPONSE "
153 #define P2P_EVENT_NFC_BOTH_GO "P2P-NFC-BOTH-GO "
154 #define P2P_EVENT_NFC_PEER_CLIENT "P2P-NFC-PEER-CLIENT "
155 #define P2P_EVENT_NFC_WHILE_CLIENT "P2P-NFC-WHILE-CLIENT "
157 /* parameters: <PMF enabled> <timeout in ms> <Session Information URL> */
158 #define ESS_DISASSOC_IMMINENT "ESS-DISASSOC-IMMINENT "
159 #define P2P_EVENT_REMOVE_AND_REFORM_GROUP "P2P-REMOVE-AND-REFORM-GROUP "
161 #define INTERWORKING_AP "INTERWORKING-AP "
162 #define INTERWORKING_NO_MATCH "INTERWORKING-NO-MATCH "
163 #define INTERWORKING_ALREADY_CONNECTED "INTERWORKING-ALREADY-CONNECTED "
165 #define GAS_RESPONSE_INFO "GAS-RESPONSE-INFO "
166 /* parameters: <addr> <dialog_token> <freq> */
167 #define GAS_QUERY_START "GAS-QUERY-START "
168 /* parameters: <addr> <dialog_token> <freq> <status_code> <result> */
169 #define GAS_QUERY_DONE "GAS-QUERY-DONE "
171 #define HS20_SUBSCRIPTION_REMEDIATION "HS20-SUBSCRIPTION-REMEDIATION "
172 #define HS20_DEAUTH_IMMINENT_NOTICE "HS20-DEAUTH-IMMINENT-NOTICE "
174 #define EXT_RADIO_WORK_START "EXT-RADIO-WORK-START "
175 #define EXT_RADIO_WORK_TIMEOUT "EXT-RADIO-WORK-TIMEOUT "
177 /* hostapd control interface - fixed message prefixes */
178 #define WPS_EVENT_PIN_NEEDED "WPS-PIN-NEEDED "
179 #define WPS_EVENT_NEW_AP_SETTINGS "WPS-NEW-AP-SETTINGS "
180 #define WPS_EVENT_REG_SUCCESS "WPS-REG-SUCCESS "
181 #define WPS_EVENT_AP_SETUP_LOCKED "WPS-AP-SETUP-LOCKED "
182 #define WPS_EVENT_AP_SETUP_UNLOCKED "WPS-AP-SETUP-UNLOCKED "
183 #define WPS_EVENT_AP_PIN_ENABLED "WPS-AP-PIN-ENABLED "
184 #define WPS_EVENT_AP_PIN_DISABLED "WPS-AP-PIN-DISABLED "
185 #define AP_STA_CONNECTED "AP-STA-CONNECTED "
186 #define AP_STA_DISCONNECTED "AP-STA-DISCONNECTED "
188 #define AP_REJECTED_MAX_STA "AP-REJECTED-MAX-STA "
189 #define AP_REJECTED_BLOCKED_STA "AP-REJECTED-BLOCKED-STA "
191 #define AP_EVENT_ENABLED "AP-ENABLED "
192 #define AP_EVENT_DISABLED "AP-DISABLED "
194 #define ACS_EVENT_STARTED "ACS-STARTED "
195 #define ACS_EVENT_COMPLETED "ACS-COMPLETED "
196 #define ACS_EVENT_FAILED "ACS-FAILED "
198 #define DFS_EVENT_RADAR_DETECTED "DFS-RADAR-DETECTED "
199 #define DFS_EVENT_NEW_CHANNEL "DFS-NEW-CHANNEL "
200 #define DFS_EVENT_CAC_START "DFS-CAC-START "
201 #define DFS_EVENT_CAC_COMPLETED "DFS-CAC-COMPLETED "
202 #define DFS_EVENT_NOP_FINISHED "DFS-NOP-FINISHED "
204 #define AP_CSA_FINISHED "AP-CSA-FINISHED "
206 /* BSS command information masks */
208 #define WPA_BSS_MASK_ALL 0xFFFDFFFF
209 #define WPA_BSS_MASK_ID BIT(0)
210 #define WPA_BSS_MASK_BSSID BIT(1)
211 #define WPA_BSS_MASK_FREQ BIT(2)
212 #define WPA_BSS_MASK_BEACON_INT BIT(3)
213 #define WPA_BSS_MASK_CAPABILITIES BIT(4)
214 #define WPA_BSS_MASK_QUAL BIT(5)
215 #define WPA_BSS_MASK_NOISE BIT(6)
216 #define WPA_BSS_MASK_LEVEL BIT(7)
217 #define WPA_BSS_MASK_TSF BIT(8)
218 #define WPA_BSS_MASK_AGE BIT(9)
219 #define WPA_BSS_MASK_IE BIT(10)
220 #define WPA_BSS_MASK_FLAGS BIT(11)
221 #define WPA_BSS_MASK_SSID BIT(12)
222 #define WPA_BSS_MASK_WPS_SCAN BIT(13)
223 #define WPA_BSS_MASK_P2P_SCAN BIT(14)
224 #define WPA_BSS_MASK_INTERNETW BIT(15)
225 #define WPA_BSS_MASK_WIFI_DISPLAY BIT(16)
226 #define WPA_BSS_MASK_DELIM BIT(17)
229 /* wpa_supplicant/hostapd control interface access */
232 * wpa_ctrl_open - Open a control interface to wpa_supplicant/hostapd
233 * @ctrl_path: Path for UNIX domain sockets; ignored if UDP sockets are used.
234 * Returns: Pointer to abstract control interface data or %NULL on failure
236 * This function is used to open a control interface to wpa_supplicant/hostapd.
237 * ctrl_path is usually /var/run/wpa_supplicant or /var/run/hostapd. This path
238 * is configured in wpa_supplicant/hostapd and other programs using the control
239 * interface need to use matching path configuration.
241 struct wpa_ctrl * wpa_ctrl_open(const char *ctrl_path);
245 * wpa_ctrl_close - Close a control interface to wpa_supplicant/hostapd
246 * @ctrl: Control interface data from wpa_ctrl_open()
248 * This function is used to close a control interface.
250 void wpa_ctrl_close(struct wpa_ctrl *ctrl);
254 * wpa_ctrl_request - Send a command to wpa_supplicant/hostapd
255 * @ctrl: Control interface data from wpa_ctrl_open()
256 * @cmd: Command; usually, ASCII text, e.g., "PING"
257 * @cmd_len: Length of the cmd in bytes
258 * @reply: Buffer for the response
259 * @reply_len: Reply buffer length
260 * @msg_cb: Callback function for unsolicited messages or %NULL if not used
261 * Returns: 0 on success, -1 on error (send or receive failed), -2 on timeout
263 * This function is used to send commands to wpa_supplicant/hostapd. Received
264 * response will be written to reply and reply_len is set to the actual length
265 * of the reply. This function will block for up to two seconds while waiting
266 * for the reply. If unsolicited messages are received, the blocking time may
269 * msg_cb can be used to register a callback function that will be called for
270 * unsolicited messages received while waiting for the command response. These
271 * messages may be received if wpa_ctrl_request() is called at the same time as
272 * wpa_supplicant/hostapd is sending such a message. This can happen only if
273 * the program has used wpa_ctrl_attach() to register itself as a monitor for
274 * event messages. Alternatively to msg_cb, programs can register two control
275 * interface connections and use one of them for commands and the other one for
276 * receiving event messages, in other words, call wpa_ctrl_attach() only for
277 * the control interface connection that will be used for event messages.
279 int wpa_ctrl_request(struct wpa_ctrl *ctrl, const char *cmd, size_t cmd_len,
280 char *reply, size_t *reply_len,
281 void (*msg_cb)(char *msg, size_t len));
285 * wpa_ctrl_attach - Register as an event monitor for the control interface
286 * @ctrl: Control interface data from wpa_ctrl_open()
287 * Returns: 0 on success, -1 on failure, -2 on timeout
289 * This function registers the control interface connection as a monitor for
290 * wpa_supplicant/hostapd events. After a success wpa_ctrl_attach() call, the
291 * control interface connection starts receiving event messages that can be
292 * read with wpa_ctrl_recv().
294 int wpa_ctrl_attach(struct wpa_ctrl *ctrl);
298 * wpa_ctrl_detach - Unregister event monitor from the control interface
299 * @ctrl: Control interface data from wpa_ctrl_open()
300 * Returns: 0 on success, -1 on failure, -2 on timeout
302 * This function unregisters the control interface connection as a monitor for
303 * wpa_supplicant/hostapd events, i.e., cancels the registration done with
306 int wpa_ctrl_detach(struct wpa_ctrl *ctrl);
310 * wpa_ctrl_recv - Receive a pending control interface message
311 * @ctrl: Control interface data from wpa_ctrl_open()
312 * @reply: Buffer for the message data
313 * @reply_len: Length of the reply buffer
314 * Returns: 0 on success, -1 on failure
316 * This function will receive a pending control interface message. This
317 * function will block if no messages are available. The received response will
318 * be written to reply and reply_len is set to the actual length of the reply.
319 * wpa_ctrl_recv() is only used for event messages, i.e., wpa_ctrl_attach()
320 * must have been used to register the control interface as an event monitor.
322 int wpa_ctrl_recv(struct wpa_ctrl *ctrl, char *reply, size_t *reply_len);
326 * wpa_ctrl_pending - Check whether there are pending event messages
327 * @ctrl: Control interface data from wpa_ctrl_open()
328 * Returns: 1 if there are pending messages, 0 if no, or -1 on error
330 * This function will check whether there are any pending control interface
331 * message available to be received with wpa_ctrl_recv(). wpa_ctrl_pending() is
332 * only used for event messages, i.e., wpa_ctrl_attach() must have been used to
333 * register the control interface as an event monitor.
335 int wpa_ctrl_pending(struct wpa_ctrl *ctrl);
339 * wpa_ctrl_get_fd - Get file descriptor used by the control interface
340 * @ctrl: Control interface data from wpa_ctrl_open()
341 * Returns: File descriptor used for the connection
343 * This function can be used to get the file descriptor that is used for the
344 * control interface connection. The returned value can be used, e.g., with
345 * select() while waiting for multiple events.
347 * The returned file descriptor must not be used directly for sending or
348 * receiving packets; instead, the library functions wpa_ctrl_request() and
349 * wpa_ctrl_recv() must be used for this.
351 int wpa_ctrl_get_fd(struct wpa_ctrl *ctrl);
353 char * wpa_ctrl_get_remote_ifname(struct wpa_ctrl *ctrl);
357 * wpa_ctrl_cleanup() - Delete any local UNIX domain socket files that
358 * may be left over from clients that were previously connected to
359 * wpa_supplicant. This keeps these files from being orphaned in the
360 * event of crashes that prevented them from being removed as part
361 * of the normal orderly shutdown.
363 void wpa_ctrl_cleanup(void);
366 #ifdef CONFIG_CTRL_IFACE_UDP
367 /* Port range for multiple wpa_supplicant instances and multiple VIFs */
368 #define WPA_CTRL_IFACE_PORT 9877
369 #define WPA_CTRL_IFACE_PORT_LIMIT 50 /* decremented from start */
370 #define WPA_GLOBAL_CTRL_IFACE_PORT 9878
371 #define WPA_GLOBAL_CTRL_IFACE_PORT_LIMIT 20 /* incremented from start */
372 #endif /* CONFIG_CTRL_IFACE_UDP */
379 #endif /* WPA_CTRL_H */