1 /* 2 * wpa_supplicant/hostapd control interface library 3 * Copyright (c) 2004-2006, Jouni Malinen <j (at) w1.fi> 4 * 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. 8 * 9 * Alternatively, this software may be distributed under the terms of BSD 10 * license. 11 * 12 * See README and COPYING for more details. 13 */ 14 15 #ifndef WPA_CTRL_H 16 #define WPA_CTRL_H 17 18 #ifdef __cplusplus 19 extern "C" { 20 #endif 21 22 /* wpa_supplicant control interface - fixed message prefixes */ 23 24 /** Interactive request for identity/password/pin */ 25 #define WPA_CTRL_REQ "CTRL-REQ-" 26 27 /** Response to identity/password/pin request */ 28 #define WPA_CTRL_RSP "CTRL-RSP-" 29 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 /** New scan results available */ 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 " 57 58 /** WPS overlap detected in PBC mode */ 59 #define WPS_EVENT_OVERLAP "WPS-OVERLAP-DETECTED " 60 /** Available WPS AP with active PBC found in scan results */ 61 #define WPS_EVENT_AP_AVAILABLE_PBC "WPS-AP-AVAILABLE-PBC " 62 /** Available WPS AP with recently selected PIN registrar found in scan results 63 */ 64 #define WPS_EVENT_AP_AVAILABLE_PIN "WPS-AP-AVAILABLE-PIN " 65 /** Available WPS AP found in scan results */ 66 #define WPS_EVENT_AP_AVAILABLE "WPS-AP-AVAILABLE " 67 /** A new credential received */ 68 #define WPS_EVENT_CRED_RECEIVED "WPS-CRED-RECEIVED " 69 /** M2D received */ 70 #define WPS_EVENT_M2D "WPS-M2D " 71 /** WPS registration failed after M2/M2D */ 72 #define WPS_EVENT_FAIL "WPS-FAIL " 73 /** WPS registration completed successfully */ 74 #define WPS_EVENT_SUCCESS "WPS-SUCCESS " 75 /** WPS enrollment attempt timed out and was terminated */ 76 #define WPS_EVENT_TIMEOUT "WPS-TIMEOUT " 77 78 /* hostapd control interface - fixed message prefixes */ 79 #define WPS_EVENT_PIN_NEEDED "WPS-PIN-NEEDED " 80 #define WPS_EVENT_NEW_AP_SETTINGS "WPS-NEW-AP-SETTINGS " 81 #define WPS_EVENT_REG_SUCCESS "WPS-REG-SUCCESS " 82 #define WPS_EVENT_AP_SETUP_LOCKED "WPS-AP-SETUP-LOCKED " 83 84 85 /* wpa_supplicant/hostapd control interface access */ 86 87 /** 88 * wpa_ctrl_open - Open a control interface to wpa_supplicant/hostapd 89 * @ctrl_path: Path for UNIX domain sockets; ignored if UDP sockets are used. 90 * Returns: Pointer to abstract control interface data or %NULL on failure 91 * 92 * This function is used to open a control interface to wpa_supplicant/hostapd. 93 * ctrl_path is usually /var/run/wpa_supplicant or /var/run/hostapd. This path 94 * is configured in wpa_supplicant/hostapd and other programs using the control 95 * interface need to use matching path configuration. 96 */ 97 struct wpa_ctrl * wpa_ctrl_open(const char *ctrl_path); 98 99 100 /** 101 * wpa_ctrl_close - Close a control interface to wpa_supplicant/hostapd 102 * @ctrl: Control interface data from wpa_ctrl_open() 103 * 104 * This function is used to close a control interface. 105 */ 106 void wpa_ctrl_close(struct wpa_ctrl *ctrl); 107 108 109 /** 110 * wpa_ctrl_request - Send a command to wpa_supplicant/hostapd 111 * @ctrl: Control interface data from wpa_ctrl_open() 112 * @cmd: Command; usually, ASCII text, e.g., "PING" 113 * @cmd_len: Length of the cmd in bytes 114 * @reply: Buffer for the response 115 * @reply_len: Reply buffer length 116 * @msg_cb: Callback function for unsolicited messages or %NULL if not used 117 * Returns: 0 on success, -1 on error (send or receive failed), -2 on timeout 118 * 119 * This function is used to send commands to wpa_supplicant/hostapd. Received 120 * response will be written to reply and reply_len is set to the actual length 121 * of the reply. This function will block for up to two seconds while waiting 122 * for the reply. If unsolicited messages are received, the blocking time may 123 * be longer. 124 * 125 * msg_cb can be used to register a callback function that will be called for 126 * unsolicited messages received while waiting for the command response. These 127 * messages may be received if wpa_ctrl_request() is called at the same time as 128 * wpa_supplicant/hostapd is sending such a message. This can happen only if 129 * the program has used wpa_ctrl_attach() to register itself as a monitor for 130 * event messages. Alternatively to msg_cb, programs can register two control 131 * interface connections and use one of them for commands and the other one for 132 * receiving event messages, in other words, call wpa_ctrl_attach() only for 133 * the control interface connection that will be used for event messages. 134 */ 135 int wpa_ctrl_request(struct wpa_ctrl *ctrl, const char *cmd, size_t cmd_len, 136 char *reply, size_t *reply_len, 137 void (*msg_cb)(char *msg, size_t len)); 138 139 140 /** 141 * wpa_ctrl_attach - Register as an event monitor for the control interface 142 * @ctrl: Control interface data from wpa_ctrl_open() 143 * Returns: 0 on success, -1 on failure, -2 on timeout 144 * 145 * This function registers the control interface connection as a monitor for 146 * wpa_supplicant/hostapd events. After a success wpa_ctrl_attach() call, the 147 * control interface connection starts receiving event messages that can be 148 * read with wpa_ctrl_recv(). 149 */ 150 int wpa_ctrl_attach(struct wpa_ctrl *ctrl); 151 152 153 /** 154 * wpa_ctrl_detach - Unregister event monitor from the control interface 155 * @ctrl: Control interface data from wpa_ctrl_open() 156 * Returns: 0 on success, -1 on failure, -2 on timeout 157 * 158 * This function unregisters the control interface connection as a monitor for 159 * wpa_supplicant/hostapd events, i.e., cancels the registration done with 160 * wpa_ctrl_attach(). 161 */ 162 int wpa_ctrl_detach(struct wpa_ctrl *ctrl); 163 164 165 /** 166 * wpa_ctrl_recv - Receive a pending control interface message 167 * @ctrl: Control interface data from wpa_ctrl_open() 168 * @reply: Buffer for the message data 169 * @reply_len: Length of the reply buffer 170 * Returns: 0 on success, -1 on failure 171 * 172 * This function will receive a pending control interface message. This 173 * function will block if no messages are available. The received response will 174 * be written to reply and reply_len is set to the actual length of the reply. 175 * wpa_ctrl_recv() is only used for event messages, i.e., wpa_ctrl_attach() 176 * must have been used to register the control interface as an event monitor. 177 */ 178 int wpa_ctrl_recv(struct wpa_ctrl *ctrl, char *reply, size_t *reply_len); 179 180 181 /** 182 * wpa_ctrl_pending - Check whether there are pending event messages 183 * @ctrl: Control interface data from wpa_ctrl_open() 184 * Returns: 1 if there are pending messages, 0 if no, or -1 on error 185 * 186 * This function will check whether there are any pending control interface 187 * message available to be received with wpa_ctrl_recv(). wpa_ctrl_pending() is 188 * only used for event messages, i.e., wpa_ctrl_attach() must have been used to 189 * register the control interface as an event monitor. 190 */ 191 int wpa_ctrl_pending(struct wpa_ctrl *ctrl); 192 193 194 /** 195 * wpa_ctrl_get_fd - Get file descriptor used by the control interface 196 * @ctrl: Control interface data from wpa_ctrl_open() 197 * Returns: File descriptor used for the connection 198 * 199 * This function can be used to get the file descriptor that is used for the 200 * control interface connection. The returned value can be used, e.g., with 201 * select() while waiting for multiple events. 202 * 203 * The returned file descriptor must not be used directly for sending or 204 * receiving packets; instead, the library functions wpa_ctrl_request() and 205 * wpa_ctrl_recv() must be used for this. 206 */ 207 int wpa_ctrl_get_fd(struct wpa_ctrl *ctrl); 208 209 #ifdef ANDROID 210 /** 211 * wpa_ctrl_cleanup() - Delete any local UNIX domain socket files that 212 * may be left over from clients that were previously connected to 213 * wpa_supplicant. This keeps these files from being orphaned in the 214 * event of crashes that prevented them from being removed as part 215 * of the normal orderly shutdown. 216 */ 217 void wpa_ctrl_cleanup(void); 218 #endif /* ANDROID */ 219 220 #ifdef CONFIG_CTRL_IFACE_UDP 221 #define WPA_CTRL_IFACE_PORT 9877 222 #define WPA_GLOBAL_CTRL_IFACE_PORT 9878 223 #endif /* CONFIG_CTRL_IFACE_UDP */ 224 225 226 #ifdef __cplusplus 227 } 228 #endif 229 230 #endif /* WPA_CTRL_H */ 231
