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