2 * wpa_supplicant/hostapd control interface library
3 * Copyright (c) 2004-2006, Jouni Malinen <j@w1.fi>
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License version 2 as
7 * published by the Free Software Foundation.
9 * Alternatively, this software may be distributed under the terms of BSD
12 * See README and COPYING for more details.
22 /* wpa_supplicant control interface - fixed message prefixes */
24 /** Interactive request for identity/password/pin */
25 #define WPA_CTRL_REQ "CTRL-REQ-"
27 /** Response to identity/password/pin request */
28 #define WPA_CTRL_RSP "CTRL-RSP-"
30 /* Event messages with fixed prefix */
31 /** Authentication completed successfully and data connection enabled */
32 #define WPA_EVENT_CONNECTED "CTRL-EVENT-CONNECTED "
33 /** Disconnected, data connection is not available */
34 #define WPA_EVENT_DISCONNECTED "CTRL-EVENT-DISCONNECTED "
35 /** wpa_supplicant is exiting */
36 #define WPA_EVENT_TERMINATING "CTRL-EVENT-TERMINATING "
37 /** Password change was completed successfully */
38 #define WPA_EVENT_PASSWORD_CHANGED "CTRL-EVENT-PASSWORD-CHANGED "
39 /** EAP-Request/Notification received */
40 #define WPA_EVENT_EAP_NOTIFICATION "CTRL-EVENT-EAP-NOTIFICATION "
41 /** EAP authentication started (EAP-Request/Identity received) */
42 #define WPA_EVENT_EAP_STARTED "CTRL-EVENT-EAP-STARTED "
43 /** EAP method selected */
44 #define WPA_EVENT_EAP_METHOD "CTRL-EVENT-EAP-METHOD "
45 /** EAP authentication completed successfully */
46 #define WPA_EVENT_EAP_SUCCESS "CTRL-EVENT-EAP-SUCCESS "
47 /** EAP authentication failed (EAP-Failure received) */
48 #define WPA_EVENT_EAP_FAILURE "CTRL-EVENT-EAP-FAILURE "
49 /** Scan results are ready */
50 #define WPA_EVENT_SCAN_RESULTS "CTRL-EVENT-SCAN-RESULTS "
51 /** wpa_supplicant state change */
52 #define WPA_EVENT_STATE_CHANGE "CTRL-EVENT-STATE-CHANGE "
53 /** AP to STA speed */
54 #define WPA_EVENT_LINK_SPEED "CTRL-EVENT-LINK-SPEED "
55 /** Driver state change */
56 #define WPA_EVENT_DRIVER_STATE "CTRL-EVENT-DRIVER-STATE "
58 /* wpa_supplicant/hostapd control interface access */
61 * wpa_ctrl_open - Open a control interface to wpa_supplicant/hostapd
62 * @ctrl_path: Path for UNIX domain sockets; ignored if UDP sockets are used.
63 * Returns: Pointer to abstract control interface data or %NULL on failure
65 * This function is used to open a control interface to wpa_supplicant/hostapd.
66 * ctrl_path is usually /var/run/wpa_supplicant or /var/run/hostapd. This path
67 * is configured in wpa_supplicant/hostapd and other programs using the control
68 * interface need to use matching path configuration.
70 struct wpa_ctrl * wpa_ctrl_open(const char *ctrl_path);
74 * wpa_ctrl_close - Close a control interface to wpa_supplicant/hostapd
75 * @ctrl: Control interface data from wpa_ctrl_open()
77 * This function is used to close a control interface.
79 void wpa_ctrl_close(struct wpa_ctrl *ctrl);
83 * wpa_ctrl_request - Send a command to wpa_supplicant/hostapd
84 * @ctrl: Control interface data from wpa_ctrl_open()
85 * @cmd: Command; usually, ASCII text, e.g., "PING"
86 * @cmd_len: Length of the cmd in bytes
87 * @reply: Buffer for the response
88 * @reply_len: Reply buffer length
89 * @msg_cb: Callback function for unsolicited messages or %NULL if not used
90 * Returns: 0 on success, -1 on error (send or receive failed), -2 on timeout
92 * This function is used to send commands to wpa_supplicant/hostapd. Received
93 * response will be written to reply and reply_len is set to the actual length
94 * of the reply. This function will block for up to two seconds while waiting
95 * for the reply. If unsolicited messages are received, the blocking time may
98 * msg_cb can be used to register a callback function that will be called for
99 * unsolicited messages received while waiting for the command response. These
100 * messages may be received if wpa_ctrl_request() is called at the same time as
101 * wpa_supplicant/hostapd is sending such a message. This can happen only if
102 * the program has used wpa_ctrl_attach() to register itself as a monitor for
103 * event messages. Alternatively to msg_cb, programs can register two control
104 * interface connections and use one of them for commands and the other one for
105 * receiving event messages, in other words, call wpa_ctrl_attach() only for
106 * the control interface connection that will be used for event messages.
108 int wpa_ctrl_request(struct wpa_ctrl *ctrl, const char *cmd, size_t cmd_len,
109 char *reply, size_t *reply_len,
110 void (*msg_cb)(char *msg, size_t len));
114 * wpa_ctrl_attach - Register as an event monitor for the control interface
115 * @ctrl: Control interface data from wpa_ctrl_open()
116 * Returns: 0 on success, -1 on failure, -2 on timeout
118 * This function registers the control interface connection as a monitor for
119 * wpa_supplicant/hostapd events. After a success wpa_ctrl_attach() call, the
120 * control interface connection starts receiving event messages that can be
121 * read with wpa_ctrl_recv().
123 int wpa_ctrl_attach(struct wpa_ctrl *ctrl);
127 * wpa_ctrl_detach - Unregister event monitor from the control interface
128 * @ctrl: Control interface data from wpa_ctrl_open()
129 * Returns: 0 on success, -1 on failure, -2 on timeout
131 * This function unregisters the control interface connection as a monitor for
132 * wpa_supplicant/hostapd events, i.e., cancels the registration done with
135 int wpa_ctrl_detach(struct wpa_ctrl *ctrl);
139 * wpa_ctrl_recv - Receive a pending control interface message
140 * @ctrl: Control interface data from wpa_ctrl_open()
141 * @reply: Buffer for the message data
142 * @reply_len: Length of the reply buffer
143 * Returns: 0 on success, -1 on failure
145 * This function will receive a pending control interface message. This
146 * function will block if no messages are available. The received response will
147 * be written to reply and reply_len is set to the actual length of the reply.
148 * wpa_ctrl_recv() is only used for event messages, i.e., wpa_ctrl_attach()
149 * must have been used to register the control interface as an event monitor.
151 int wpa_ctrl_recv(struct wpa_ctrl *ctrl, char *reply, size_t *reply_len);
155 * wpa_ctrl_pending - Check whether there are pending event messages
156 * @ctrl: Control interface data from wpa_ctrl_open()
157 * Returns: 1 if there are pending messages, 0 if no, or -1 on error
159 * This function will check whether there are any pending control interface
160 * message available to be received with wpa_ctrl_recv(). wpa_ctrl_pending() is
161 * only used for event messages, i.e., wpa_ctrl_attach() must have been used to
162 * register the control interface as an event monitor.
164 int wpa_ctrl_pending(struct wpa_ctrl *ctrl);
168 * wpa_ctrl_get_fd - Get file descriptor used by the control interface
169 * @ctrl: Control interface data from wpa_ctrl_open()
170 * Returns: File descriptor used for the connection
172 * This function can be used to get the file descriptor that is used for the
173 * control interface connection. The returned value can be used, e.g., with
174 * select() while waiting for multiple events.
176 * The returned file descriptor must not be used directly for sending or
177 * receiving packets; instead, the library functions wpa_ctrl_request() and
178 * wpa_ctrl_recv() must be used for this.
180 int wpa_ctrl_get_fd(struct wpa_ctrl *ctrl);
184 * wpa_ctrl_cleanup() - Delete any local UNIX domain socket files that
185 * may be left over from clients that were previously connected to
186 * wpa_supplicant. This keeps these files from being orphaned in the
187 * event of crashes that prevented them from being removed as part
188 * of the normal orderly shutdown.
190 void wpa_ctrl_cleanup();
193 #ifdef CONFIG_CTRL_IFACE_UDP
194 #define WPA_CTRL_IFACE_PORT 9877
195 #define WPA_GLOBAL_CTRL_IFACE_PORT 9878
196 #endif /* CONFIG_CTRL_IFACE_UDP */
203 #endif /* WPA_CTRL_H */