1/* 2 * wpa_supplicant/hostapd control interface library 3 * Copyright (c) 2004-2006, Jouni Malinen <j@w1.fi> 4 * 5 * This software may be distributed under the terms of the BSD license. 6 * See README for more details. 7 */ 8 9#ifndef WPA_CTRL_H 10#define WPA_CTRL_H 11 12#ifdef __cplusplus 13extern "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 " 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 " 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 " 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 " 55/** New scan results available */ 56#define WPA_EVENT_SCAN_RESULTS "CTRL-EVENT-SCAN-RESULTS " 57/** wpa_supplicant state change */ 58#define WPA_EVENT_STATE_CHANGE "CTRL-EVENT-STATE-CHANGE " 59/** A new BSS entry was added (followed by BSS entry id and BSSID) */ 60#define WPA_EVENT_BSS_ADDED "CTRL-EVENT-BSS-ADDED " 61/** A BSS entry was removed (followed by BSS entry id and BSSID) */ 62#define WPA_EVENT_BSS_REMOVED "CTRL-EVENT-BSS-REMOVED " 63 64/** WPS overlap detected in PBC mode */ 65#define WPS_EVENT_OVERLAP "WPS-OVERLAP-DETECTED " 66/** Available WPS AP with active PBC found in scan results */ 67#define WPS_EVENT_AP_AVAILABLE_PBC "WPS-AP-AVAILABLE-PBC " 68/** Available WPS AP with our address as authorized in scan results */ 69#define WPS_EVENT_AP_AVAILABLE_AUTH "WPS-AP-AVAILABLE-AUTH " 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 " 75/** A new credential received */ 76#define WPS_EVENT_CRED_RECEIVED "WPS-CRED-RECEIVED " 77/** M2D received */ 78#define WPS_EVENT_M2D "WPS-M2D " 79/** WPS registration failed after M2/M2D */ 80#define WPS_EVENT_FAIL "WPS-FAIL " 81/** WPS registration completed successfully */ 82#define WPS_EVENT_SUCCESS "WPS-SUCCESS " 83/** WPS enrollment attempt timed out and was terminated */ 84#define WPS_EVENT_TIMEOUT "WPS-TIMEOUT " 85 86#define WPS_EVENT_ENROLLEE_SEEN "WPS-ENROLLEE-SEEN " 87 88#define WPS_EVENT_OPEN_NETWORK "WPS-OPEN-NETWORK " 89 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 " 95#define WPS_EVENT_ER_AP_SETTINGS "WPS-ER-AP-SETTINGS " 96#define WPS_EVENT_ER_SET_SEL_REG "WPS-ER-AP-SET-SEL-REG " 97 98/** P2P device found */ 99#define P2P_EVENT_DEVICE_FOUND "P2P-DEVICE-FOUND " 100 101/** P2P device lost */ 102#define P2P_EVENT_DEVICE_LOST "P2P-DEVICE-LOST " 103 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 " 113#define P2P_EVENT_CROSS_CONNECT_ENABLE "P2P-CROSS-CONNECT-ENABLE " 114#define P2P_EVENT_CROSS_CONNECT_DISABLE "P2P-CROSS-CONNECT-DISABLE " 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 " 123/* parameters: <peer address> <status> */ 124#define P2P_EVENT_PROV_DISC_FAILURE "P2P-PROV-DISC-FAILURE" 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 " 131#define P2P_EVENT_FIND_STOPPED "P2P-FIND-STOPPED " 132 133#define INTERWORKING_AP "INTERWORKING-AP " 134#define INTERWORKING_NO_MATCH "INTERWORKING-NO-MATCH " 135 136#define GAS_RESPONSE_INFO "GAS-RESPONSE-INFO " 137 138/* hostapd control interface - fixed message prefixes */ 139#define WPS_EVENT_PIN_NEEDED "WPS-PIN-NEEDED " 140#define WPS_EVENT_NEW_AP_SETTINGS "WPS-NEW-AP-SETTINGS " 141#define WPS_EVENT_REG_SUCCESS "WPS-REG-SUCCESS " 142#define WPS_EVENT_AP_SETUP_LOCKED "WPS-AP-SETUP-LOCKED " 143#define WPS_EVENT_AP_SETUP_UNLOCKED "WPS-AP-SETUP-UNLOCKED " 144#define WPS_EVENT_AP_PIN_ENABLED "WPS-AP-PIN-ENABLED " 145#define WPS_EVENT_AP_PIN_DISABLED "WPS-AP-PIN-DISABLED " 146#define AP_STA_CONNECTED "AP-STA-CONNECTED " 147#define AP_STA_DISCONNECTED "AP-STA-DISCONNECTED " 148 149 150/* BSS command information masks */ 151 152#define WPA_BSS_MASK_ALL 0xFFFFFFFF 153#define WPA_BSS_MASK_ID BIT(0) 154#define WPA_BSS_MASK_BSSID BIT(1) 155#define WPA_BSS_MASK_FREQ BIT(2) 156#define WPA_BSS_MASK_BEACON_INT BIT(3) 157#define WPA_BSS_MASK_CAPABILITIES BIT(4) 158#define WPA_BSS_MASK_QUAL BIT(5) 159#define WPA_BSS_MASK_NOISE BIT(6) 160#define WPA_BSS_MASK_LEVEL BIT(7) 161#define WPA_BSS_MASK_TSF BIT(8) 162#define WPA_BSS_MASK_AGE BIT(9) 163#define WPA_BSS_MASK_IE BIT(10) 164#define WPA_BSS_MASK_FLAGS BIT(11) 165#define WPA_BSS_MASK_SSID BIT(12) 166#define WPA_BSS_MASK_WPS_SCAN BIT(13) 167#define WPA_BSS_MASK_P2P_SCAN BIT(14) 168#define WPA_BSS_MASK_INTERNETW BIT(15) 169#define WPA_BSS_MASK_WIFI_DISPLAY BIT(16) 170 171 172/* wpa_supplicant/hostapd control interface access */ 173 174/** 175 * wpa_ctrl_open - Open a control interface to wpa_supplicant/hostapd 176 * @ctrl_path: Path for UNIX domain sockets; ignored if UDP sockets are used. 177 * Returns: Pointer to abstract control interface data or %NULL on failure 178 * 179 * This function is used to open a control interface to wpa_supplicant/hostapd. 180 * ctrl_path is usually /var/run/wpa_supplicant or /var/run/hostapd. This path 181 * is configured in wpa_supplicant/hostapd and other programs using the control 182 * interface need to use matching path configuration. 183 */ 184struct wpa_ctrl * wpa_ctrl_open(const char *ctrl_path); 185 186 187/** 188 * wpa_ctrl_close - Close a control interface to wpa_supplicant/hostapd 189 * @ctrl: Control interface data from wpa_ctrl_open() 190 * 191 * This function is used to close a control interface. 192 */ 193void wpa_ctrl_close(struct wpa_ctrl *ctrl); 194 195 196/** 197 * wpa_ctrl_request - Send a command to wpa_supplicant/hostapd 198 * @ctrl: Control interface data from wpa_ctrl_open() 199 * @cmd: Command; usually, ASCII text, e.g., "PING" 200 * @cmd_len: Length of the cmd in bytes 201 * @reply: Buffer for the response 202 * @reply_len: Reply buffer length 203 * @msg_cb: Callback function for unsolicited messages or %NULL if not used 204 * Returns: 0 on success, -1 on error (send or receive failed), -2 on timeout 205 * 206 * This function is used to send commands to wpa_supplicant/hostapd. Received 207 * response will be written to reply and reply_len is set to the actual length 208 * of the reply. This function will block for up to two seconds while waiting 209 * for the reply. If unsolicited messages are received, the blocking time may 210 * be longer. 211 * 212 * msg_cb can be used to register a callback function that will be called for 213 * unsolicited messages received while waiting for the command response. These 214 * messages may be received if wpa_ctrl_request() is called at the same time as 215 * wpa_supplicant/hostapd is sending such a message. This can happen only if 216 * the program has used wpa_ctrl_attach() to register itself as a monitor for 217 * event messages. Alternatively to msg_cb, programs can register two control 218 * interface connections and use one of them for commands and the other one for 219 * receiving event messages, in other words, call wpa_ctrl_attach() only for 220 * the control interface connection that will be used for event messages. 221 */ 222int wpa_ctrl_request(struct wpa_ctrl *ctrl, const char *cmd, size_t cmd_len, 223 char *reply, size_t *reply_len, 224 void (*msg_cb)(char *msg, size_t len)); 225 226 227/** 228 * wpa_ctrl_attach - Register as an event monitor for the control interface 229 * @ctrl: Control interface data from wpa_ctrl_open() 230 * Returns: 0 on success, -1 on failure, -2 on timeout 231 * 232 * This function registers the control interface connection as a monitor for 233 * wpa_supplicant/hostapd events. After a success wpa_ctrl_attach() call, the 234 * control interface connection starts receiving event messages that can be 235 * read with wpa_ctrl_recv(). 236 */ 237int wpa_ctrl_attach(struct wpa_ctrl *ctrl); 238 239 240/** 241 * wpa_ctrl_detach - Unregister event monitor from the control interface 242 * @ctrl: Control interface data from wpa_ctrl_open() 243 * Returns: 0 on success, -1 on failure, -2 on timeout 244 * 245 * This function unregisters the control interface connection as a monitor for 246 * wpa_supplicant/hostapd events, i.e., cancels the registration done with 247 * wpa_ctrl_attach(). 248 */ 249int wpa_ctrl_detach(struct wpa_ctrl *ctrl); 250 251 252/** 253 * wpa_ctrl_recv - Receive a pending control interface message 254 * @ctrl: Control interface data from wpa_ctrl_open() 255 * @reply: Buffer for the message data 256 * @reply_len: Length of the reply buffer 257 * Returns: 0 on success, -1 on failure 258 * 259 * This function will receive a pending control interface message. This 260 * function will block if no messages are available. The received response will 261 * be written to reply and reply_len is set to the actual length of the reply. 262 * wpa_ctrl_recv() is only used for event messages, i.e., wpa_ctrl_attach() 263 * must have been used to register the control interface as an event monitor. 264 */ 265int wpa_ctrl_recv(struct wpa_ctrl *ctrl, char *reply, size_t *reply_len); 266 267 268/** 269 * wpa_ctrl_pending - Check whether there are pending event messages 270 * @ctrl: Control interface data from wpa_ctrl_open() 271 * Returns: 1 if there are pending messages, 0 if no, or -1 on error 272 * 273 * This function will check whether there are any pending control interface 274 * message available to be received with wpa_ctrl_recv(). wpa_ctrl_pending() is 275 * only used for event messages, i.e., wpa_ctrl_attach() must have been used to 276 * register the control interface as an event monitor. 277 */ 278int wpa_ctrl_pending(struct wpa_ctrl *ctrl); 279 280 281/** 282 * wpa_ctrl_get_fd - Get file descriptor used by the control interface 283 * @ctrl: Control interface data from wpa_ctrl_open() 284 * Returns: File descriptor used for the connection 285 * 286 * This function can be used to get the file descriptor that is used for the 287 * control interface connection. The returned value can be used, e.g., with 288 * select() while waiting for multiple events. 289 * 290 * The returned file descriptor must not be used directly for sending or 291 * receiving packets; instead, the library functions wpa_ctrl_request() and 292 * wpa_ctrl_recv() must be used for this. 293 */ 294int wpa_ctrl_get_fd(struct wpa_ctrl *ctrl); 295 296char * wpa_ctrl_get_remote_ifname(struct wpa_ctrl *ctrl); 297 298#ifdef ANDROID 299/** 300 * wpa_ctrl_cleanup() - Delete any local UNIX domain socket files that 301 * may be left over from clients that were previously connected to 302 * wpa_supplicant. This keeps these files from being orphaned in the 303 * event of crashes that prevented them from being removed as part 304 * of the normal orderly shutdown. 305 */ 306void wpa_ctrl_cleanup(void); 307#endif /* ANDROID */ 308 309#ifdef CONFIG_CTRL_IFACE_UDP 310/* Port range for multiple wpa_supplicant instances and multiple VIFs */ 311#define WPA_CTRL_IFACE_PORT 9877 312#define WPA_CTRL_IFACE_PORT_LIMIT 50 /* decremented from start */ 313#define WPA_GLOBAL_CTRL_IFACE_PORT 9878 314#define WPA_GLOBAL_CTRL_IFACE_PORT_LIMIT 20 /* incremented from start */ 315#endif /* CONFIG_CTRL_IFACE_UDP */ 316 317 318#ifdef __cplusplus 319} 320#endif 321 322#endif /* WPA_CTRL_H */ 323